Create POS order

Create POS order

Headers

x-api-key

string

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.

Body

application/json

orderReference

string

required

locationId

string

required

status

string

required

channel

number

orderTotal

number

taxTotal

number

orderCurrency

string

statusLog

string

customerUserId

string

customerAccountId

string

customerEmail

string

customerPhone

object

Show child attributes

shipTo

object[]

Show child attributes

Response

200 - application/json

tags

any[]

_id

string

channel

number

orderReference

string

orderTotal

number

taxTotal

number

orderCurrency

string

status

string

statusLog

string

customerUserId

string

customerAccountId

string

customerEmail

string

customerPhone

object

Show child attributes

orderId

string

shipTo

object[]

Show child attributes

items

object[]

Show child attributes

shipments

any[]

payments

object[]

Show child attributes

revision

number

totalQuantity

number

statusDescriptions

any[]

events

any[]

pickups

any[]

attributes

any[]

createdAt

string

updatedAt

string