Get order by email

Get order by email

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.

Query Parameters

orderEmail

string

required

User email that we want to get orders for.

Response

200 - application/json

__v

number

_id

string

attributes

object[]

Show child attributes

attributes._id

string

attributes.attributeId

string

attributes.id

string

attributes.name

string

attributes.price

number

attributes.type

string

attributes.value

string

cartId

string

channel

number

createdAt

string

customerEmail

string

events

any[]

items

object[]

Show child attributes

items._id

string

items.attributes

object[]

Show child attributes

items.attributes._id

string

items.attributes.attributeId

string

items.attributes.id

string

items.attributes.name

string

items.attributes.price

number

items.attributes.type

string

items.attributes.value

string

items.attributeTotalPrice

number

items.currency

string

items.discount

number

items.estimatedTax

number

items.group

string[]

items.id

string

items.itemId

number

items.lineItemId

number

items.price

number

items.priceListId

number

items.promosApplied

object[]

Show child attributes

items.promosApplied.id

string

items.promosApplied.ON

object

Show child attributes

items.promosApplied.ON.kind

string

items.promosApplied.ON.value

string

items.promosApplied.promoId

string

items.promosApplied.unit

string

items.promosApplied.value

number

items.quantity

number

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.name

object

Show child attributes

payments.billToAddress.name.first

string

payments.billToAddress.name.last

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.conversion

number

payments.currency

string

payments.id

string

payments.paymentIdentifier

object

Show child attributes

payments.paymentIdentifier.cardIdentifier

string

payments.paymentKind

string

payments.paymentMethod

string

payments.paymentToken

object

Show child attributes

payments.paymentToken.token

string

payments.paymentToken.type

string

payments.shipToId

number[]

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.zipCode

string

shipTo.currency

string

shipTo.estimatedTax

number

shipTo.id

string

shipTo.price

number

shipTo.promosApplied

any[]

shipTo.shipmentCarrier

string

shipTo.shipmentMethod

string

shipTo.shipmentMethodId

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