Update pickup information of an order
Updates pickup information of a specific order by order ID.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
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.
"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"
Path Parameters
"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"
"5349b4ddd2781d08c09890f4"
Body
Details of the person who picks up the order
Name for order details
"john123@gmail.com"
Contact details of customer for the order
Primary
, Alternate
"Primary"
Response
Order shipping info
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.
"5349b4ddd2781d08c09890f4"
Code for the tax applied for shiping of items to the adress
"FR01"
Location number to be used for BOPIS (Buy Online Purchase In Store) to identify the pickup store
"123"
Details of the person who picks up the order
Order billing or shipping address
"Express Delivery"
"SHIP_TO_ADDRESS"
"2022-05-12T09:30:31.198Z"
"2022-05-12T09:30:31.198Z"
Amount applicable for shipping the item to the address
20
Discount amount applied for shipping the item to the address
12.6
Total tax applicable to ship the item to the address
12.6
Additional user instructions
"User instructions"
{ "isOpenBox": false, "isOTPDElivery": true }
Was this page helpful?