Update ship-to (v1)

Update ship-to (v1)

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

cartId · string · required

Required string length: 24

Example:

"5e5818a84d030c206b2ffb02"

shipToId · string · required

Required string length: 24

Example:

"5e5818a84d030c206b2ffb02"

Body

application/json

isPickup · boolean · required

Example:

true

shipToType · enum<string>

Available options:

BOPIS,

SHIP_TO_STORE,

SHIP_TO_ADDRESS,

STORE_PICKUP

Example:

"SHIP_TO_ADDRESS"

warehouseId · string

Required string length: 24

Example:

"123456abcdef123456abcdef"

shipMethod · number

taxCode · string

Example:

"FR1000"

storeId · string

Required string length: 5 - 50

Example:

"TBD"

pickupPerson · object

Show child attributes

pickupPerson. name · object

Show child attributes

pickupPerson.name. first · string

Required string length: 2 - 50

Example:

"John"

pickupPerson.name. last · string

Required string length: 2 - 50

Example:

"Smith"

pickupPerson. phone · object

Show child attributes

pickupPerson.phone. number · string · required

Required string length: 5 - 25

Example:

"123-456-7890"

pickupPerson.phone. kind · string · required

Required string length: 3 - 25

Example:

"Mobile"

pickupPerson. email · string

Required string length: 5 - 100

Example:

"[e-mail]"

altPickupPerson · object

Show child attributes

altPickupPerson. name · object

Show child attributes

altPickupPerson.name. first · string

Required string length: 2 - 50

Example:

"John"

altPickupPerson.name. last · string

Required string length: 2 - 50

Example:

"Smith"

altPickupPerson. phone · object

Show child attributes

altPickupPerson.phone. number · string · required

Required string length: 5 - 25

Example:

"123-456-7890"

altPickupPerson.phone. kind · string · required

Required string length: 3 - 25

Example:

"Mobile"

altPickupPerson. email · string

Required string length: 5 - 100

Example:

"[e-mail]"

address · any

Response

200

application/json

Ship To Updated

shipToType · enum<string>

Available options:

BOPIS,

SHIP_TO_STORE,

SHIP_TO_ADDRESS,

STORE_PICKUP

Example:

"SHIP_TO_ADDRESS"

warehouseId · string

Required string length: 24

Example:

"123456abcdef123456abcdef"

isPickup · boolean

Example:

true

shipMethod · object

Show child attributes

shipMethod. shipMethodId · string · required

Minimum length: 3

Example:

"1a2b3c4d5e6f7g8h9i0j"

shipMethod. cost · object · required

Show child attributes

shipMethod.cost. currency · string · required

Minimum length: 3

Example:

"USD"

shipMethod.cost. amount · number · required

Required range: x >= 0

Example:

5.99

shipMethod. shipmentCarrier · string

Example:

"Fedex"

shipMethod. shipmentMethod · string

Example:

"Next Day"

taxCode · string

Example:

"FR1000"

storeId · string

Required string length: 5 - 50

Example:

"TBD"

pickupPerson · object

Show child attributes

pickupPerson. name · object

Show child attributes

pickupPerson.name. first · string

Required string length: 2 - 50

Example:

"John"

pickupPerson.name. last · string

Required string length: 2 - 50

Example:

"Smith"

pickupPerson. phone · object

Show child attributes

pickupPerson.phone. number · string · required

Required string length: 5 - 25

Example:

"123-456-7890"

pickupPerson.phone. kind · string · required

Required string length: 3 - 25

Example:

"Mobile"

pickupPerson. email · string

Required string length: 5 - 100

Example:

"[e-mail]"

altPickupPerson · object

Show child attributes

altPickupPerson. name · object

Show child attributes

altPickupPerson.name. first · string

Required string length: 2 - 50

Example:

"John"

altPickupPerson.name. last · string

Required string length: 2 - 50

Example:

"Smith"

altPickupPerson. phone · object

Show child attributes

altPickupPerson.phone. number · string · required

Required string length: 5 - 25

Example:

"123-456-7890"

altPickupPerson.phone. kind · string · required

Required string length: 3 - 25

Example:

"Mobile"

altPickupPerson. email · string

Required string length: 5 - 100

Example:

"[e-mail]"

address · any

cartId · string

Required string length: 24

Example:

"5e5818a84d030c206b2ffb02"

shipToId · number

Example:

13812

_id · string

Example:

"5fee9d59f2f08a1b3cbdea08"

createdAt · string

Example:

"2020-12-31T02:09:53.914Z"

updatedAt · string

Example:

"2020-12-31T02:09:53.914Z"

__v · number

Example:

0