Get an order
Retrieves an order by orderId or orderNumber. If orderId or orderNumber is not provided, this endpoint retrieves all orders for a merchant.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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
Response
Order response body
Unique order number
Sales channel ID
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.
Auto generated ID once the order created successfully
Actual order creation date
Order cancellation date if any
Order allocation date after order is created
ID of the cart where order is placed
Platfrom using which order is created
WEB, CSC, MOBILE_APP, POS Operating system of the platfom as mentioned in the type field. If you want to configure any custom valuefor this field, contact fabric.
IOS, Android, International Order process name
Employee ID used when an employee places an order on behave of the customer.
Order retail object for reatil transactions. For non-retail transactions, only location number is provided.
Order value after calculating discounts and any applicable fees
Original order total value
Final discount value on order amount
Original discount on order value
Total fees, if any, applicable on order amount
Original fees appliable on shipping of items
Total tax amount appliable on shipping of items
Appeasement amount, if any, processed on the order
Original tax amount on order during fist time order creation
Return amount incase of order return
Cancel amount incase of order cancellation
Invoice value on order
Total order amount after calculating fees, discounts, retrurn and cancellation if any
Order amount during first time order creation after calculating all fees, taxes, and discounts
Array of appeasements, if any
Order customer model
Order dispatched date and time
Date and time when the original order is modified for the first time, for example for return, cancellation or replacement
Date and time when the exisiting order is updated
Was this page helpful?