PATCH

https://prod01-apigw.{customer_name}.fabric.zone

/
api-cart
/
v1
/
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
isPickup
boolean
required
shipToType
enum<string>
Available options:
BOPIS,
SHIP_TO_STORE,
SHIP_TO_ADDRESS,
STORE_PICKUP
warehouseId
string
Required string length: 24
shipMethod
number
taxCode
string
storeId
string
Required string length: 5 - 50
pickupPerson
object
altPickupPerson
object
address
any

Response

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

Was this page helpful?

Get Cart data for the given shipTo IDOverview