Create ship-to

Create ship-to

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

Body

application/json

shipToType

enum<string>

required

Available options:

BOPIS,

SHIP_TO_STORE,

SHIP_TO_ADDRESS,

STORE_PICKUP

shipMethod

object

required

Show child attributes

address

object

required

Show child attributes

warehouseId

string

Required string length: 24

isPickup

boolean

taxCode

string

storeId

string

Required string length: 5 - 50

pickupPerson

object

Show child attributes

altPickupPerson

object

Show child attributes

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

Show child attributes

taxCode

string

storeId

string

Required string length: 5 - 50

pickupPerson

object

Show child attributes

altPickupPerson

object

Show child attributes

address

object

Show child attributes

cartId

string

Required string length: 24

shipToId

number

_id

string

createdAt

string

updatedAt

string