post

/checkouts/{checkoutId}/consignments

Adds a new Consignment to Checkout.

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

  1. Add a new Consignment to Checkout.
    1. Send a POST to Consignments with each shipping address and line items IDs. Each address can have its own line item IDs.
    2. As part of the request URL make sure to add include=consignments.available_shipping_options to return the available shipping options based on line items and shipping locations. This will return available_shipping_options in the response.
  2. Update the Consignment with Shipping Options.

Required Query

  • consignments.available_shipping_options

Required Fields

  • shipping_address
  • line_items

Request Parameters

1 Path Parameter
1 Query Parameter
2 Headers

Request Body

1 Example
Schema
array[object]
shipping_address
object
line_items
array[object]

Responses

3 Examples
Schema
object
data
object

Send a Test Request

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