Get orders by query

Retrieves orders based on query model passed in the request body.

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.

Body

application/json

Query object to retrieve matched orders

filters

object

required

JSON to do filtration of records. to filter records json structure should be similar to target entity structure i.e order, shipment etc

Show child attributes

filters.{key}

object

JSON to filter records. JSON structure should be similar to target entity structure i.e order, shipment etc.

limit

integer

default:

10

Numbers of records to be returned

offset

integer

default:

0

Number of records to skipped

sortBy

string

default:

updatedAt

Item property on which data needed to be sorted on

sortDirection

enum<string>

default:

desc

Direction of sorting- ascending or descending

Available options:

asc,

desc

Response

200

application/json

Matched orders

Response object based on query model

count

integer

Total number of order records

limit

integer

Number of records returned on a single page

offset

integer

Number of records skipped before selecting matched records

orders

object[]

Show child attributes

orders.orderNumber

string

required

Unique order number

orders.channelId

string

required

Sales channel ID

orders.statusCode

string

required

orders.items

object[]

required

Show child attributes

orders.items.lineItemId

string

required

orders.items.lineItemNumber

integer

required

orders.items.itemId

string

required

orders.items.sku

string

required

orders.items.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.

orders.items.channelId

string

orders.items.segment

string

orders.items.vendorId

string

orders.items.title

string

orders.items.type

string

Identify order type whether it's pickup item, or web ship, or international order

orders.items.subType

string

orders.items.backorder

boolean

Identify whether this item has been ordered as backorder

orders.items.orderedQuantity

integer

orders.items.backOrderedQuantity

integer

orders.items.pendingShippedQuantity

integer

orders.items.pendingShippedBackOrderQuantity

integer

orders.items.shippedQuantity

integer

orders.items.deliveredQuantity

integer

orders.items.invoiceQuantity

integer

orders.items.cancelledQuantity

integer

orders.items.pendingReturnQuantity

integer

orders.items.processingReturnQuantity

integer

orders.items.rejectedReturnQuantity

integer

orders.items.returnedQuantity

integer

orders.items.reshippedQuantity

integer

orders.items.uom

string

orders.items.itemUnitPrice

number

orders.items.itemSubTotal

number

orders.items.originalItemSubTotal

number

orders.items.itemFeeTotal

number

orders.items.originalFeeTotal

number

orders.items.itemShippingTotal

number

orders.items.originalShippingTotal

number

orders.items.appeasementTotal

number

orders.items.itemDiscountsTotal

number

orders.items.originalDiscounts

number

orders.items.itemTaxTotal

number

orders.items.originalTaxTotal

number

orders.items.itemTotal

number

orders.items.originalItemTotal

number

orders.items.outstandingItemTotal

number

orders.items.originalOutstandingItemTotal

number

orders.items.invoiceTotal

number

orders.items.currency

string

orders.items.employeeId

string

orders.items.associateId

string

orders.items.fees

object[]

Show child attributes

orders.items.fees.type

string

orders.items.fees.value

number

orders.items.fees.invoiceQuantity

integer

orders.items.fees.refundAmount

number

orders.items.fees.quantity

integer

orders.items.appeasements

object[]

Show child attributes

orders.items.appeasements.appeasementCounter

integer

Counter number where appeasement is processed. It is used for retail transactions

orders.items.appeasements.reasonCode

string

orders.items.appeasements.subReasonCode

string

orders.items.appeasements.value

number

Appeasement amount

orders.items.appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

orders.items.appeasements.payments

object[]

Array of appeasement payments

Show child attributes

orders.items.appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

orders.items.appeasements.payments.refundAmount

number

orders.items.returns

object[]

Show child attributes

orders.items.returns.shipmentId

string

orders.items.returns.shipmentLineItemId

string

orders.items.returns.shipmentQuantity

integer

orders.items.returns.refundAmount

number

orders.items.returns.invoicedAmount

number

orders.items.returns.returnsCreatedAt

string

orders.items.taxCode

string

orders.items.taxDetail

object[]

Show child attributes

orders.items.taxDetail.type

string

orders.items.taxDetail.value

number

orders.items.discounts

object[]

Show child attributes

orders.items.discounts.quantity

integer

orders.items.discounts.amount

number

orders.items.discounts.unit

string

orders.items.discounts.value

integer

orders.items.discounts.promoId

string

orders.items.discounts.promoCode

string

orders.items.discounts.promoTitle

string

orders.items.discounts.type

string

orders.items.discounts.invoiceQuantity

integer

orders.items.discounts.returnQuantity

integer

orders.items.discounts.cancelQuantity

integer

orders.items.attributes

object

Show child attributes

orders.items.attributes.{key}

object

orders.items.exchangeItem

boolean

orders.items.parentLineItemNumber

integer

orders.items.pendingExchangeQuantity

integer

orders.items.exchangeQuantity

integer

orders.items.refundAmount

number

orders.items.lineOrderStatus

string

orders.items.infiniteConsent

boolean

orders.items.notes

object[]

Notes section to be used for CSR only

Show child attributes

orders.items.notes.timestamp

string

orders.items.notes.user

string

orders.items.notes.notes

string

orders.items.gifting

boolean

orders.shipInfo

object[]

required

Show child attributes

orders.shipInfo.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.

orders.shipInfo.taxCode

string

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

orders.shipInfo.locationNum

string

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

orders.shipInfo.pickup

object[]

Show child attributes

orders.shipInfo.pickup.name

object

Name for order details

Show child attributes

orders.shipInfo.pickup.name.first

string

orders.shipInfo.pickup.name.middle

string

orders.shipInfo.pickup.name.last

string

orders.shipInfo.pickup.email

string

orders.shipInfo.pickup.phone

object

Contact details of customer for the order

Show child attributes

orders.shipInfo.pickup.phone.number

string

orders.shipInfo.pickup.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

orders.shipInfo.pickup.pickupType

enum<string>

Available options:

Primary,

Alternate

orders.shipInfo.shipToAddress

object

Order billing or shipping address

Show child attributes

orders.shipInfo.shipToAddress.address1

string

required

orders.shipInfo.shipToAddress.name

object

Name for order details

Show child attributes

orders.shipInfo.shipToAddress.name.first

string

orders.shipInfo.shipToAddress.name.middle

string

orders.shipInfo.shipToAddress.name.last

string

orders.shipInfo.shipToAddress.email

string

orders.shipInfo.shipToAddress.phone

object

Contact details of customer for the order

Show child attributes

orders.shipInfo.shipToAddress.phone.number

string

orders.shipInfo.shipToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

orders.shipInfo.shipToAddress.address2

string

orders.shipInfo.shipToAddress.address3

string

orders.shipInfo.shipToAddress.address4

string

orders.shipInfo.shipToAddress.city

string

orders.shipInfo.shipToAddress.state

string

orders.shipInfo.shipToAddress.country

string

orders.shipInfo.shipToAddress.postalCode

string

orders.shipInfo.shipToAddress.type

string

orders.shipInfo.shipToAddress.latitude

number

Latitude of the address

orders.shipInfo.shipToAddress.longitude

number

Longitude of the address

orders.shipInfo.taxDetail

object[]

Show child attributes

orders.shipInfo.taxDetail.type

string

orders.shipInfo.taxDetail.value

number

orders.shipInfo.shipMethod

string

orders.shipInfo.shipToType

string

orders.shipInfo.estimatedShipDate

string

orders.shipInfo.estimatedDeliveryDate

string

orders.shipInfo.shipToPrice

number

Amount applicable for shipping the item to the address

orders.shipInfo.shipToDiscount

number

Discount amount applied for shipping the item to the address

orders.shipInfo.shipToTaxTotal

number

Total tax applicable to ship the item to the address

orders.shipInfo.shipmentInstructions

string

Additional user instructions

orders.shipInfo.attributes

object

Show child attributes

orders.shipInfo.attributes.{key}

object

orders.version

integer

Number of updates happened to the order. Order-update refers to replacement, appeasement added, address change or any other order related update to the particular order.

orders.orderId

string

Auto generated ID once the order created successfully

orders.orderDate

string

Actual order creation date

orders.cancellationDate

string

Order cancellation date if any

orders.allocationDate

string

Order allocation date after order is created

orders.cartId

string

ID of the cart where order is placed

orders.type

enum<string>

Platfrom using which order is created

Available options:

WEB,

CSC,

MOBILE_APP,

POS

orders.subType

enum<string>

Operating system of the platfom as mentioned in the type field. If you want to configure any custom valuefor this field, contact fabric.

Available options:

IOS,

Android,

International

orders.processName

string

Order process name

orders.employeeId

string

Employee ID used when an employee places an order on behave of the customer.

orders.retail

object

Order retail object for reatil transactions. For non-retail transactions, only location number is provided.

Show child attributes

orders.retail.locationNum

integer

Store number of line item's fulfillment origin.

orders.retail.cashierId

string

Cashier ID in case of retail transaction.

orders.retail.registerId

string

Registered user ID of the cashier who helps in creating the order. It is applicable for retail transactions.

orders.retail.transactionId

string

Transaction ID incase of retail transaction.

orders.orderSubTotal

number

Order value after calculating discounts and any applicable fees

orders.originalSubTotal

number

Original order total value

orders.orderDiscount

number

Final discount value on order amount

orders.originalDiscounts

number

Original discount on order value

orders.feeTotal

number

Total fees, if any, applicable on order amount

orders.originalFeeTotal

number

Original fees appliable on shipping of items

orders.taxTotal

number

Total tax amount appliable on shipping of items

orders.appeasementTotal

number

Appeasement amount, if any, processed on the order

orders.originalTaxTotal

number

Original tax amount on order during fist time order creation

orders.returnTotal

number

Return amount incase of order return

orders.cancelTotal

number

Cancel amount incase of order cancellation

orders.invoiceTotal

number

Invoice value on order

orders.orderTotal

number

Total order amount after calculating fees, discounts, retrurn and cancellation if any

orders.originalOrderTotal

number

Order amount during first time order creation after calculating all fees, taxes, and discounts

orders.currency

string

orders.statusDescription

string

orders.attributes

object

Show child attributes

orders.attributes.{key}

object

orders.fees

object[]

Show child attributes

orders.fees.type

string

orders.fees.value

number

orders.fees.invoiceValue

number

orders.appeasements

object[]

Array of appeasements, if any

Show child attributes

orders.appeasements.appeasementCounter

integer

Counter number where appeasement is processed. It is used for retail transactions

orders.appeasements.reasonCode

string

orders.appeasements.subReasonCode

string

orders.appeasements.value

number

Appeasement amount

orders.appeasements.invoiceValue

number

Appeasement invoice value; should be equal to appeasement value

orders.appeasements.payments

object[]

Array of appeasement payments

Show child attributes

orders.appeasements.payments.paymentCounter

integer

Counter number where appeasement payment is processed

orders.appeasements.payments.refundAmount

number

orders.discounts

object[]

Show child attributes

orders.discounts.quantity

integer

orders.discounts.amount

number

orders.discounts.unit

string

orders.discounts.value

integer

orders.discounts.promoId

string

orders.discounts.promoCode

string

orders.discounts.promoTitle

string

orders.discounts.type

string

orders.discounts.invoiceQuantity

integer

orders.discounts.returnQuantity

integer

orders.discounts.cancelQuantity

integer

orders.customer

object

Order customer model

Show child attributes

orders.customer.name

object

Name for order details

Show child attributes

orders.customer.name.first

string

orders.customer.name.middle

string

orders.customer.name.last

string

orders.customer.email

string

orders.customer.phone

object

Contact details of customer for the order

Show child attributes

orders.customer.phone.number

string

orders.customer.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

orders.customer.userId

string

It is shopper's ID who visits company website to purchase products.

orders.customer.accountId

string

Account ID such as loyalty account ID or memebr account ID. Refers to any external system or fabric's loyalty service that the user has account with.

orders.customer.employeeId

string

ID of the employee (sales person) who creates an order for shopper.

orders.customer.company

string

orders.payments

object[]

Show child attributes

orders.payments.paymentCounter

integer

orders.payments.paymentDate

string

orders.payments.billToId

string

orders.payments.paymentIdentifier

object

OrderPaymentIdentifier Model

Show child attributes

orders.payments.paymentIdentifier.cardIdentifier

string

Last 4 digits from cart number

orders.payments.paymentIdentifier.expirationYear

string

Card expiration year

orders.payments.paymentIdentifier.expirationMonth

string

Card expiration month

orders.payments.paymentIdentifier.paymentId

string

orders.payments.paymentIdentifier.fabricPaymentReference

string

orders.payments.paymentProvider

string

orders.payments.paymentToken

object

Payment token details

Show child attributes

orders.payments.paymentToken.token

string

Payment token generated by checkout service

orders.payments.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

orders.payments.paymentMethod

string

orders.payments.authAmount

number

orders.payments.chargedAmount

number

orders.payments.refundAmount

number

orders.payments.currency

string

orders.payments.conversion

number

orders.payments.paymentStatus

string

orders.payments.partialCapture

string

orders.payments.finalCapture

string

orders.payments.paymentLog

object[]

Show child attributes

orders.payments.paymentLog.paymentId

string

orders.payments.paymentLog.status

string

orders.payments.paymentLog.data

object

PaymentDetails Model

Show child attributes

orders.payments.paymentLog.data.status

string

orders.payments.paymentLog.data.body

object

PaymentDetailsResponseBody Model

Show child attributes

orders.payments.billToAddress

object

Order billing or shipping address

Show child attributes

orders.payments.billToAddress.address1

string

required

orders.payments.billToAddress.name

object

Name for order details

Show child attributes

orders.payments.billToAddress.name.first

string

orders.payments.billToAddress.name.middle

string

orders.payments.billToAddress.name.last

string

orders.payments.billToAddress.email

string

orders.payments.billToAddress.phone

object

Contact details of customer for the order

Show child attributes

orders.payments.billToAddress.phone.number

string

orders.payments.billToAddress.phone.type

enum<string>

Available options:

MOBILE,

HOME,

BUSINESS

orders.payments.billToAddress.address2

string

orders.payments.billToAddress.address3

string

orders.payments.billToAddress.address4

string

orders.payments.billToAddress.city

string

orders.payments.billToAddress.state

string

orders.payments.billToAddress.country

string

orders.payments.billToAddress.postalCode

string

orders.payments.billToAddress.type

string

orders.payments.billToAddress.latitude

number

Latitude of the address

orders.payments.billToAddress.longitude

number

Longitude of the address

orders.payments.attributes

object

Show child attributes

orders.payments.attributes.{key}

object

orders.auditLogs

object[]

Show child attributes

orders.auditLogs.auditId

string

orders.auditLogs.auditType

string

orders.auditLogs.employeeId

string

orders.auditLogs.auditTimestamp

string

orders.auditLogs.source

string

orders.auditLogs.reasonCode

string

orders.auditLogs.subReasonCode

string

orders.auditLogs.policyCode

string

orders.auditLogs.note

string

orders.auditLogs.lineItemId

string

orders.auditLogs.lineItemNumber

integer

orders.auditLogs.sku

string

orders.auditLogs.quantity

integer

orders.auditLogs.amount

number

orders.auditLogs.paymentToken

object

Payment token details

Show child attributes

orders.auditLogs.paymentToken.token

string

Payment token generated by checkout service

orders.auditLogs.paymentToken.paymentType

string

Used to identify payment type in case of credit cards

orders.auditLogs.success

boolean

orders.auditLogs.paymentResponse

object

orders.auditLogs.updatedFields

object[]

Show child attributes

orders.auditLogs.updatedFields.fieldName

string

orders.auditLogs.updatedFields.fieldOriginalValue

string

orders.auditLogs.attributes

object

Show child attributes

orders.auditLogs.attributes.{key}

object

orders.notes

object[]

Show child attributes

orders.notes.timestamp

string

orders.notes.user

string

orders.notes.notes

string

orders.orderReleaseTimestamp

string

Order dispatched date and time

orders.createdAt

string

Date and time when the original order is modified for the first time, for example for return, cancellation or replacement

orders.updatedAt

string

Date and time when the exisiting order is updated