PATCH
/
order
/
{orderId}
/
shipto
/
{shipToId}
/
pickup

Authorizations

Authorization
string
headerrequired

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.

Path Parameters

orderId
string
required
shipToId
string
required

Body

application/json

Details of the person who picks up the order

name
object

Name for order details

email
string
phone
object

Contact details of customer for the order

pickupType
enum<string>
Available options:
Primary,
Alternate

Response

200 - application/json

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.

taxCode
string

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

locationNum
string

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

pickup
object[]
shipToAddress
object

Order billing or shipping address

taxDetail
object[]
shipMethod
string
shipToType
string
estimatedShipDate
string
estimatedDeliveryDate
string
shipToPrice
number

Amount applicable for shipping the item to the address

shipToDiscount
number

Discount amount applied for shipping the item to the address

shipToTaxTotal
number

Total tax applicable to ship the item to the address

shipmentInstructions
string

Additional user instructions

attributes
object

Was this page helpful?

Get orders by queryUpdate customer information for an order