Create an order
Creates an order. After an order is created, Notification APIs of fabric OMS send order notification to customers.
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.
Body
Order object
Unique order number to be provided by merchant
Sales channel ID
Order status code
Array of items for which order is processed
Actual order creation date when the order was created for the first time.
ID of the cart for which order is created
Platform of order creation, for example, website, mobile application, point of sale, and so on.
WEB, CSC, MOBILE_APP, POS Operating system of the platform mentioned in the type field.
IOS, Android, International ID of the employee who created the order or who helped creating the order.
Order retail object for reatil transactions. For non-retail transactions, only location number is provided.
Base price of the ordered items before discounts. It does not include tax amount.
Discounted amount
Order value after discount. Discount value is subtracted from order sub total.
Total tax amount applicable on the order subtotal value.
Total order value after calculating discount and tax values.
Currecy code used for order amount
Order status description
Array of discount objects
Order customer model
Notes section to be used for CSR only
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?