POST
/
order
/
cancel

Authorizations

Authorization
string
headerrequired

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

Order cancellation request object

orderId
string
required
reasonCode
string
required

Set to all line items and header audits logs

subReasonCode
string

Set to all line items and header audits logs

source
string

Determine where the request is initialize

employeeId
number

Determine who initiate the request

note
string

Use to add notes

policyCode
string

Set policy code

attributes
object

Set attributes to header level audit log's attribute object

items
object[]

Set when doing line item level cancellation other set to null or empty

Response

200 - application/json

Order response body

orderNumber
string
required

Unique order number

channelId
string
required

Sales channel ID

statusCode
string
required
items
object[]
required
shipInfo
object[]
required
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.

orderId
string

Auto generated ID once the order created successfully

orderDate
string

Actual order creation date

cancellationDate
string

Order cancellation date if any

allocationDate
string

Order allocation date after order is created

cartId
string

ID of the cart where order is placed

type
enum<string>

Platfrom using which order is created

Available options:
WEB,
CSC,
MOBILE_APP,
POS
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
processName
string

Order process name

employeeId
string

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

retail
object

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

orderSubTotal
number

Order value after calculating discounts and any applicable fees

originalSubTotal
number

Original order total value

orderDiscount
number

Final discount value on order amount

originalDiscounts
number

Original discount on order value

feeTotal
number

Total fees, if any, applicable on order amount

originalFeeTotal
number

Original fees appliable on shipping of items

taxTotal
number

Total tax amount appliable on shipping of items

appeasementTotal
number

Appeasement amount, if any, processed on the order

originalTaxTotal
number

Original tax amount on order during fist time order creation

returnTotal
number

Return amount incase of order return

cancelTotal
number

Cancel amount incase of order cancellation

invoiceTotal
number

Invoice value on order

orderTotal
number

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

originalOrderTotal
number

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

currency
string
statusDescription
string
attributes
object
fees
object[]
appeasements
object[]

Array of appeasements, if any

discounts
object[]
customer
object

Order customer model

payments
object[]
auditLogs
object[]
notes
object[]
orderReleaseTimestamp
string

Order dispatched date and time

createdAt
string

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

updatedAt
string

Date and time when the exisiting order is updated

Was this page helpful?

Check order-cancellation eligibilityOverview