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.

Path Parameters

orderId

string

required

shipToId

string

required

Body

application/json

Details of the person who picks up the order

email

string

name

object

Name for order details

Show child attributes

name.first

string

name.last

string

name.middle

string

phone

object

Contact details of customer for the order

Show child attributes

phone.number

string

phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

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.

attributes

object

Show child attributes

attributes.{key}

object

estimatedDeliveryDate

string

estimatedShipDate

string

locationNum

string

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

pickup

object[]

Show child attributes

pickup.email

string

pickup.name

object

Name for order details

Show child attributes

pickup.name.first

string

pickup.name.last

string

pickup.name.middle

string

pickup.phone

object

Contact details of customer for the order

Show child attributes

pickup.phone.number

string

pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

shipmentInstructions

string

Additional user instructions

shipMethod

string

shipToAddress

object

Order billing or shipping address

Show child attributes

shipToAddress.address1

string

required

shipToAddress.address2

string

shipToAddress.address3

string

shipToAddress.address4

string

shipToAddress.city

string

shipToAddress.country

string

shipToAddress.email

string

shipToAddress.latitude

number

Latitude of the address

shipToAddress.longitude

number

Longitude of the address

shipToAddress.name

object

Name for order details

Show child attributes

shipToAddress.name.first

string

shipToAddress.name.last

string

shipToAddress.name.middle

string

shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

shipToAddress.phone.number

string

shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

shipToAddress.postalCode

string

shipToAddress.state

string

shipToAddress.type

string

shipToDiscount

number

Discount amount applied for shipping the item to the address

shipToPrice

number

Amount applicable for shipping the item to the address

shipToTaxTotal

number

Total tax applicable to ship the item to the address

shipToType

string

taxCode

string

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

taxDetail

object[]

Show child attributes

taxDetail.type

string

taxDetail.value

number