PATCH
/
api-cart
/
cart
/
{cartId}
/
ship-to
/
{shipToId}

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.

Path Parameters

​
cartId
string
required
Required string length: 24
​
shipToId
string
required
Required string length: 24

Body

application/json
​
address
any
​
altPickupPerson
object
​
isPickup
boolean
​
pickupPerson
object
​
shipMethod
object
​
shipToType
enum<string>
Available options:
BOPIS,
SHIP_TO_STORE,
SHIP_TO_ADDRESS,
STORE_PICKUP
​
storeId
string
Required string length: 5 - 50
​
taxCode
string
​
warehouseId
string
Required string length: 24

Response

200 - application/json
​
__v
number
​
_id
string
​
address
any
​
altPickupPerson
object
​
cartId
string
Required string length: 24
​
createdAt
string
​
isPickup
boolean
​
pickupPerson
object
​
shipMethod
object
​
shipToId
number
​
shipToType
enum<string>
Available options:
BOPIS,
SHIP_TO_STORE,
SHIP_TO_ADDRESS,
STORE_PICKUP
​
storeId
string
Required string length: 5 - 50
​
taxCode
string
​
updatedAt
string
​
warehouseId
string
Required string length: 24

Was this page helpful?

Get ShipTo by IDGet Cart data for the given shipTo ID