POST
/
v2
/
carts
/
{cartId}
/
shipping-details

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

x-api-key
string

API Key for Gateway

Authorization
string
required

Authorization token for the user

Path Parameters

cartId
string
required

ID of cart for which shipping data is being created

Body

application/json

Request body used to create shipping details for a cart

shipToType
string
required

Shipping type

shipMethod
object

Shipping method

address
object

Shipping address

taxCode
string | null

Shipping tax code

isPickup
boolean

true: Item is set for pickup<br />false: Item is set for delivery

altPickupPerson
object

Alternative pickup person

pickupPerson
object

Designated pickup person

warehouseId
string | null

Warehouse ID

storeId
string | null

Store ID

estimatedShipDate
string | null

Estimated date for shipping

estimatedDeliveryDate
string | null

Estimated date for delivery

shipmentInstructions
string | null

Store ID

Response

200 - application/json

Shipping response body

shipToId
string | null

Shipping details ID

cartId
string | null

Cart ID

createdAt
string | null

Shipping details creation time

updatedAt
string | null

Last time shipping details were updated

shipMethod
object

Shipping method and details

address
object

Shipping address

shipToType
string | null

Shipping type

taxCode
string | null

Shipping tax code

isPickup
boolean

true: Item is set for pickup<br />false: Item is set for delivery

altPickupPerson
object

Alternative pickup person

pickupPerson
object

Designated pickup person

warehouseId
string | null

Warehouse ID

storeId
string | null

Store ID

estimatedShipDate
string | null

Estimated date for shipping

estimatedDeliveryDate
string | null

Estimated date for delivery

shipmentInstructions
string | null

Store ID

Was this page helpful?

Get specific shipping details for a specific cartRemove `shippingDetailsId` from cart items