put

/checkouts/{checkoutId}/consignments/{consignmentId}

Updates an existing consignment. Shipping address, line item IDs or the shipping option ID can be updated using this endpoint.

There are two steps to add a new shipping address and shipping options with line items.

  1. Add a new Consignment to Checkout.
  2. Update the Consignment with Shipping Options.
    1. Update each Consignment shipping_option_id (shipping address and line items) with the available_shipping_option > id from Step One.

Required Fields

  • shipping_option_id

Request Parameters

2 Path Parameters
1 Query Parameter
2 Headers

Request Body

1 Example
Schema
object

One or more of these three fields are mandatory. Shipping address and line items can be updated in one request. Shipping option ID has to be updated in a separate request, since changing the address or line items can invalidate the previously available shipping options.

shipping_address
object
line_items
array[object]
shipping_option_id
string

Responses

3 Examples
Schema
object
data
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
3 path params not set
store_hash
checkoutId
consignmentId
$$.env
No $$.env variables are being used in this request.