Cancel order
Cancels order
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 cancellation request object
Set to all line items and header audits logs
Set attributes to header level audit log's attribute object
Determine who initiate the request
Set when doing line item level cancellation other set to null or empty
Use to add notes
Set policy code
Determine where the request is initialize
Set to all line items and header audits logs
Response
Order response body
Sales channel ID
Unique order number
Order allocation date after order is created
Array of appeasements, if any
Appeasement amount, if any, processed on the order
Order cancellation date if any
Cancel amount incase of order cancellation
ID of the cart where order is placed
Date and time when the original order is modified for the first time, for example for return, cancellation or replacement
Order customer model
Employee ID used when an employee places an order on behave of the customer.
Total fees, if any, applicable on order amount
Invoice value on order
Actual order creation date
Final discount value on order amount
Auto generated ID once the order created successfully
Order dispatched date and time
Order value after calculating discounts and any applicable fees
Total order amount after calculating fees, discounts, retrurn and cancellation if any
Original discount on order value
Original fees appliable on shipping of items
Order amount during first time order creation after calculating all fees, taxes, and discounts
Original order total value
Original tax amount on order during fist time order creation
Order process name
Order retail object for reatil transactions. For non-retail transactions, only location number is provided.
Return amount incase of order return
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 Total tax amount appliable on shipping of items
Platfrom using which order is created
WEB, CSC, MOBILE_APP, POS Date and time when the exisiting order is updated
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.
Was this page helpful?