Update pickup information of an order

Updates pickup information of a specific order by order ID.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

orderId

string

required

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

shipToId

string

required

Example:

"5349b4ddd2781d08c09890f4"

Body

application/json

Details of the person who picks up the order

name

object

Name for order details

Show child attributes

name.first

string

Example:

"John"

name.middle

string

Example:

"Middle"

name.last

string

Example:

"Doe"

email

string

Example:

"[e-mail]"

phone

object

Contact details of customer for the order

Show child attributes

phone.number

string

Example:

"55555555555"

phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

pickupType

enum<string>

Available options:

Primary,

Alternate

Example:

"Primary"

Response

200

application/json

Pickup information updated

Order shipping info

shipToId

string

required

Unique ID to link item with its shipping address. If all items of an order are shipped to single address, then all items will have same shipTo id. If multiple items of an order are shipped to multiple shipping address, then corresponding shipTo id is linked to each item.

Example:

"5349b4ddd2781d08c09890f4"

taxCode

string

Code for the tax applied for shiping of items to the adress

Example:

"FR01"

locationNum

string

Location number to be used for BOPIS (Buy Online Purchase In Store) to identify the pickup store

Example:

"123"

pickup

object[]

Details of the person who picks up the order

Show child attributes

pickup.name

object

Name for order details

Show child attributes

pickup.name.first

string

Example:

"John"

pickup.name.middle

string

Example:

"Middle"

pickup.name.last

string

Example:

"Doe"

pickup.email

string

Example:

"[e-mail]"

pickup.phone

object

Contact details of customer for the order

Show child attributes

pickup.phone.number

string

Example:

"55555555555"

pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

Example:

"Primary"

shipToAddress

object

Order billing or shipping address

Show child attributes

shipToAddress.address1

string

required

Example:

"First line of address"

shipToAddress.name

object

Name for order details

Show child attributes

shipToAddress.name.first

string

Example:

"John"

shipToAddress.name.middle

string

Example:

"Middle"

shipToAddress.name.last

string

Example:

"Doe"

shipToAddress.email

string

Example:

"[e-mail]"

shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

shipToAddress.phone.number

string

Example:

"55555555555"

shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

shipToAddress.address2

string

Example:

"123 Parking Lot"

shipToAddress.address3

string

Example:

"Third line of address"

shipToAddress.address4

string

Example:

"Fourth line of address"

shipToAddress.city

string

Example:

"Beaumont"

shipToAddress.state

string

Example:

"TX"

shipToAddress.country

string

Example:

"USA"

shipToAddress.postalCode

string

Example:

"77705"

shipToAddress.type

string

Example:

"residence"

shipToAddress.latitude

number

Latitude of the address

Example:

35.294952

shipToAddress.longitude

number

Longitude of the address

Example:

32.294952

taxDetail

object[]

Show child attributes

taxDetail.type

string

Example:

"tax"

taxDetail.value

number

Example:

34.56

shipMethod

string

Example:

"Express Delivery"

shipToType

string

Example:

"SHIP_TO_ADDRESS"

estimatedShipDate

string

Example:

"2022-05-12T09:30:31.198Z"

estimatedDeliveryDate

string

Example:

"2022-05-12T09:30:31.198Z"

shipToPrice

number

Amount applicable for shipping the item to the address

Example:

20

shipToDiscount

number

Discount amount applied for shipping the item to the address

Example:

12.6

shipToTaxTotal

number

Total tax applicable to ship the item to the address

Example:

12.6

shipmentInstructions

string

Additional user instructions

Example:

"User instructions"

attributes

object

Show child attributes

attributes.{key}

object

Example:

{ "isOpenBox": false, "isOTPDElivery": true }

Example:

{ "isOpenBox": false, "isOTPDElivery": true }