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

locationId

string

required

orderReference

string

required

status

string

required

channel

number

customerAccountId

string

customerEmail

string

customerPhone

object

Show child attributes

customerPhone.kind

string

customerPhone.number

string

customerUserId

string

orderCurrency

string

orderTotal

number

shipTo

object[]

Show child attributes

shipTo.address

object

Show child attributes

shipTo.address.city

string

shipTo.address.country

string

shipTo.address.email

string

shipTo.address.kind

string

shipTo.address.name

object

Show child attributes

shipTo.address.name.first

string

shipTo.address.name.last

string

shipTo.address.name.middle

string

shipTo.address.phone

object

Show child attributes

shipTo.address.phone.kind

string

shipTo.address.phone.number

string

shipTo.address.state

string

shipTo.address.street1

string

shipTo.address.street2

string

shipTo.address.zipCode

string

shipTo.committedTax

number

shipTo.currency

string

shipTo.estimatedTax

number

shipTo.items

object[]

Show child attributes

shipTo.items.committedTax

number

shipTo.items.currency

string

shipTo.items.discount

number

shipTo.items.estimatedTax

number

shipTo.items.group

string[]

shipTo.items.itemId

number

shipTo.items.lineItemId

number

shipTo.items.price

number

shipTo.items.promosApplied

object[]

Show child attributes

shipTo.items.promosApplied.name

string

shipTo.items.quantity

number

shipTo.items.shipToId

number

shipTo.items.sku

string

shipTo.items.taxCode

string

shipTo.items.title

string

shipTo.items.total

string

shipTo.items.weight

number

shipTo.items.weightUnit

string

shipTo.payments

object[]

Show child attributes

shipTo.payments.amount

number

shipTo.payments.billToAddress

object

Show child attributes

shipTo.payments.billToAddress.city

string

shipTo.payments.billToAddress.country

string

shipTo.payments.billToAddress.email

string

shipTo.payments.billToAddress.kind

string

shipTo.payments.billToAddress.name

object

Show child attributes

shipTo.payments.billToAddress.name.first

string

shipTo.payments.billToAddress.name.last

string

shipTo.payments.billToAddress.name.middle

string

shipTo.payments.billToAddress.phone

object

Show child attributes

shipTo.payments.billToAddress.phone.kind

string

shipTo.payments.billToAddress.phone.number

string

shipTo.payments.billToAddress.state

string

shipTo.payments.billToAddress.street1

string

shipTo.payments.billToAddress.street2

string

shipTo.payments.billToAddress.zipCode

string

shipTo.payments.billToId

number

shipTo.payments.conversion

number

shipTo.payments.currency

string

shipTo.payments.paymentIdentifier

object

Show child attributes

shipTo.payments.paymentIdentifier.cardIdentifier

number

shipTo.payments.paymentKind

string

shipTo.payments.paymentMethod

string

shipTo.payments.paymentStatus

string

shipTo.payments.paymentToken

object

Show child attributes

shipTo.payments.paymentToken.token

number

shipTo.payments.shipToId

number[]

shipTo.price

number

shipTo.promisedDeliveryDate

string

shipTo.promosApplied

object[]

Show child attributes

shipTo.promosApplied.name

string

shipTo.shipmentCarrier

string

shipTo.shipmentInstructions

string

shipTo.shipmentMethod

string

shipTo.shipmentMethodId

number

shipTo.shipments

any[]

shipTo.shipmentStatus

string

shipTo.shipToId

number

shipTo.shipToType

string

shipTo.taxCode

string

shipTo.total

number

statusLog

string

taxTotal

number

Response

200 - application/json

_id

string

attributes

any[]

channel

number

createdAt

string

customerAccountId

string

customerEmail

string

customerPhone

object

Show child attributes

customerPhone.kind

string

customerPhone.number

string

customerUserId

string

events

any[]

items

object[]

Show child attributes

items._id

string

items.attributes

any[]

items.committedTax

number

items.currency

string

items.discount

number

items.estimatedTax

number

items.group

string[]

items.itemId

number

items.lineItemId

number

items.price

number

items.priceListId

number

items.promosApplied

object[]

Show child attributes

items.promosApplied.name

string

items.quantity

number

items.reservedLocation

any[]

items.shipToId

number

items.sku

string

items.taxCode

string

items.title

string

items.total

number

items.weight

number

items.weightUnit

string

orderCurrency

string

orderId

string

orderReference

string

orderTotal

number

payments

object[]

Show child attributes

payments._id

string

payments.amount

number

payments.billToAddress

object

Show child attributes

payments.billToAddress.city

string

payments.billToAddress.country

string

payments.billToAddress.email

string

payments.billToAddress.kind

string

payments.billToAddress.name

object

Show child attributes

payments.billToAddress.name.first

string

payments.billToAddress.name.last

string

payments.billToAddress.name.middle

string

payments.billToAddress.phone

object

Show child attributes

payments.billToAddress.phone.kind

string

payments.billToAddress.phone.number

string

payments.billToAddress.state

string

payments.billToAddress.street1

string

payments.billToAddress.street2

string

payments.billToAddress.zipCode

string

payments.billToId

number

payments.conversion

number

payments.currency

string

payments.paymentIdentifier

object

Show child attributes

payments.paymentIdentifier.cardIdentifier

number

payments.paymentKind

string

payments.paymentMethod

string

payments.paymentStatus

string

payments.paymentToken

object

Show child attributes

payments.paymentToken.token

number

payments.shipToId

number[]

pickups

any[]

revision

number

shipments

any[]

shipTo

object[]

Show child attributes

shipTo._id

string

shipTo.address

object

Show child attributes

shipTo.address.city

string

shipTo.address.country

string

shipTo.address.email

string

shipTo.address.kind

string

shipTo.address.name

object

Show child attributes

shipTo.address.name.first

string

shipTo.address.name.last

string

shipTo.address.name.middle

string

shipTo.address.phone

object

Show child attributes

shipTo.address.phone.kind

string

shipTo.address.phone.number

string

shipTo.address.state

string

shipTo.address.street1

string

shipTo.address.street2

string

shipTo.address.zipCode

string

shipTo.committedTax

number

shipTo.currency

string

shipTo.estimatedTax

number

shipTo.price

number

shipTo.promisedDeliveryDate

string

shipTo.promosApplied

object[]

Show child attributes

shipTo.promosApplied.name

string

shipTo.shipmentCarrier

string

shipTo.shipmentInstructions

string

shipTo.shipmentMethod

string

shipTo.shipmentMethodId

string

shipTo.shipmentStatus

string

shipTo.shipToId

number

shipTo.shipToType

string

shipTo.taxCode

string

shipTo.total

number

status

string

statusDescriptions

any[]

statusLog

string

tags

any[]

taxTotal

number

totalQuantity

number

updatedAt

string