Skip to main content
POST
Cancel order

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json

Order cancellation request object

orderId
string
required
Example:

"62f3982438bcab1951be0a19"

reasonCode
string
required

Set to all line items and header audits logs

Example:

"wrong item"

subReasonCode
string

Set to all line items and header audits logs

Example:

"Ordered item doesn't match"

source
string

Determine where the request is initialize

employeeId
number

Determine who initiate the request

Example:

"AD5069"

note
string

Use to add notes

Example:

"Wrong item is sent to customer"

policyCode
string

Set policy code

Example:

"Cancel"

attributes
object

Set attributes to header level audit log's attribute object

Example:
items
object[]

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

Response

Order cancelled

Order response body

orderNumber
string
required

Unique order number

Example:

"309019176"

channelId
string
required

Sales channel ID

Example:

"12"

statusCode
string
required
Example:

"ORDER_CREATED"

items
object[]
required
Required array length: 1 - 2147483647 elements
shipInfo
object[]
required
Required array length: 1 - 2147483647 elements
version
integer<int64>

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

Example:

"5349b4ddd2781d08c09890f4"

orderDate
string<date-time>

Actual order creation date

Example:

"2022-05-12T09:30:31.198Z"

cancellationDate
string<date-time>

Order cancellation date if any

Example:

"2022-05-12T09:30:31.198Z"

allocationDate
string<date-time>

Order allocation date after order is created

Example:

"2022-05-12T09:30:31.198Z"

cartId
string

ID of the cart where order is placed

Example:

"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569"

type
enum<string>

Platfrom using which order is created

Available options:
WEB,
CSC,
MOBILE_APP,
POS
Example:

"WEB"

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
Example:

"International"

processName
string

Order process name

Example:

"CANCEL"

employeeId
string

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

Example:

"43278"

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

Example:

123.45

originalSubTotal
number

Original order total value

Example:

113.45

orderDiscount
number

Final discount value on order amount

Example:

1.23

originalDiscounts
number

Original discount on order value

Example:

1.45

feeTotal
number

Total fees, if any, applicable on order amount

Example:

12.34

originalFeeTotal
number

Original fees appliable on shipping of items

Example:

12.34

taxTotal
number

Total tax amount appliable on shipping of items

Example:

12.34

appeasementTotal
number

Appeasement amount, if any, processed on the order

Example:

12.34

originalTaxTotal
number

Original tax amount on order during fist time order creation

Example:

12.34

returnTotal
number

Return amount incase of order return

Example:

12.34

cancelTotal
number

Cancel amount incase of order cancellation

Example:

12.34

invoiceTotal
number

Invoice value on order

Example:

12.34

orderTotal
number

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

Example:

146.9

originalOrderTotal
number

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

Example:

146.9

currency
string
Example:

"USD"

statusDescription
string
Example:

"Order Created"

attributes
object
Example:
fees
object[]
appeasements
object[]

Array of appeasements, if any

discounts
object[]
customer
object

Order customer model

payments
object[]
auditLogs
object[]
notes
object[]
orderReleaseTimestamp
string<date-time>

Order dispatched date and time

createdAt
string<date-time>

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

updatedAt
string<date-time>

Date and time when the exisiting order is updated