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

Returns Checkout Object.

1 Example
Schema
object
id
string
1 validation
cart
object
billing_address
object
consignments
array[object]
taxes
array[object]
coupons
array[object]

Coupons applied at checkout level.

order_id
string
shipping_cost_total_inc_tax
number

Shipping cost before any discounts are applied including tax.

1 validation
shipping_cost_total_ex_tax
number

Shipping cost before any discounts are applied excluding tax.

1 validation
handling_cost_total_inc_tax
number

Handling cost for all consignments including tax.

1 validation
handling_cost_total_ex_tax
number

Handling cost for all consignments excluding tax.

1 validation
tax_total
number
1 validation
subtotal_inc_tax
number

Subtotal of the checkout before applying item level discounts including tax.

1 validation
subtotal_ex_tax
number

Subtotal of the checkout before applying item level discounts excluding tax.

1 validation
grand_total
number

The total payable amount, before applying any store credit or gift certificate.

1 validation
created_time
string

Time when the cart was created.

updated_time
string

Time when the cart was last updated.

customer_message
string

Shopper’s message provided as details for the order to be created from this checkout

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.