Update Checkout Consignment
Updates an existing consignment. The address, line item IDs, and shipping option ID can be updated using this endpoint.
Use a separate `PUT` request to update the shipping option IDs if you also want to update the address and line item IDs.
To add new shipping options, complete the following steps:
* Use the [Add Consignment to Checkout](/developer/api-reference/rest/admin/management/checkouts/consignments#add-consignment-to-checkout) endpoint to add a new [consignment] to a checkout.
* Assign a shipping option to the new consignment by sending a `PUT` request to update the consignment's `shipping_option_id` with a returned value from `data.consignments[N].available_shipping_option[N].id` obtained in the [Add Consignment to Checkout](/developer/api-reference/rest/admin/management/checkouts/consignments#add-consignment-to-checkout) endpoint.
To update an existing address and line item IDs, assign a new address and line item IDs by sending a `PUT` request.
To prevent lost updates due to concurrent requests overriding changes made by others, it is recommended to enable optimistic concurrency control by including the `version` field in the request payload. If the provided version does not match the version on the server, a conflict error will be returned, which the client can handle accordingly.
2. Assign a shipping option to the new consignment by sending a `PUT` request to update the consignment's `shipping_option_id` with a returned value from `data.consignments[N].available_shipping_option[N].id` obtained in Step One.
Authentication
X-Auth-Tokenstring
### OAuth scopes
| UI Name | Permission | Parameter |
|:--------|:-----------|:----------|
| Checkouts | modify | `store_checkouts` |
| Checkouts | read-only | `store_checkouts_read_only` |
| Checkout Content | modify | `store_checkout_content` |
| Checkout Content | read-only | `store_checkout_content_read_only` |
### Authentication header
| Header | Argument | Description |
|:-------|:---------|:------------|
| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |
### Further reading
For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).
For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).
For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
Path parameters
checkoutId
consignmentId
Query parameters
include
Include the shipping options available to this checkout.
Allowed values:
Request
This endpoint expects an object.
address
line_items
shipping_option_id
pickup_option
custom_shipping
version
The cart version that you expect to apply the updates. If the provided version doesn’t match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.
Response
data
meta
Response metadata.
Errors
409
Conflict Error
