Cancel order by order number
When customer’s order cancellation request is determined to be eligible, this endpoint processes the cancellation by order number.
Note: If you do not have order number, use the corresponding order ID-based endpoint - POST /orders/{orderId}/actions/cancel.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Path Parameters
Merchant-defined order identifier
Body
Order cancellation request
Reason code for cancellation, varies from merchant to merchant
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Employee (ID or name) who initiated the order cancellation request
Cancellation request
Additional notes, if any
Merchant-defined policy code, varies from merchant to merchant. If omitted, the default policy is used.
Merchant-defined source from where the cancellation request was initiated. There are no pre-defined values; possible values could be Customer Service Representative (CSR), point-of-sale (POS), etc.
Subreason code for order cancellation, for another layer of classification
Response
Order details
Sales channel ID
Item details
Merchant-defined order identifier. If omitted, this is generated by fabric's sequence generator using Configuration service
Status code. There are no pre-defined values; possible values are - ORDER_ALLOCATED ("Order Allocated"), ORDER_SHIPPED ("Order Shipped"), ORDER_PARTIALLY_SHIPPED ("Order Partially Shipped"), ORDER_PICKED_UP ("Order Picked Up"), ORDER_PARTIALLY_PICKED_UP ("Order Partially Picked Up"), ORDER_DELIVERED ("Order Delivered"), ORDER_PARTIALLY_DELIVERED ("Order Partially Delivered"), ORDER_RETURNED ("Order Returned"), etc.
Current version of order document. Indicates the number of times the order is updated by any operation.
The total amount of price adjustments for all items of the order.
Price adjustments refer to changes or modifications made to the listed price of a product. A Customer Sales Representative (CSR) makes the price adjustments to provide discounts, promotional offers, or coupons that the shopper used.
System-generated order allocation time (UTC) once the order is allocated using Allocation service
Final appeasement amount
Merchant-defined custom attributes. This is a placeholder for additional info (in key: value pairs).
Amount to be returned after order cancellation, calculated as cancelledQuantity / orderedQuantity * itemTotal
System-generated order cancellation time (UTC). This is returned in the response of Cancel order by ID - POST /orders/{orderId}/actions/cancel or Cancel order by order number - POST /orders/order-number/{orderNumber}/actions/cancel once the order is successfully cancelled.
Unique cart identifier, either from fabric Cart service or an external Cart service. It is used for linking an order to a specific cart. If available, it is also used for inventory reservation from cart workflow.
Order creation time (UTC)
Three-letter currency code as defined by ISO-4217
Invoice customer
Employee (ID or name) who initiated the request
Recalculated total fee, calculated as orderedQuantity* itemFeeTotal
Total payment captured by fabric Invoice service. If merchant is using third-party service, then this amount will be null. For partial payment scenarios, this value will be different from orderTotal.
Recalculated order discount
24-character system-generated order ID
Order released time (UTC). When an order is placed, its status is On Hold by default and the duration of hold may vary from merchant to merchant (~1 min). After the hold period, the order is released from hold.
Recalculated orderSubtotal - summationOfAll(itemSubTotal)
Total amount to be charged for the order = orderSubTotal - orderDiscountTotal + orderFeeTotal + orderTaxTotal
Merchant-defined order creation time (UTC). It is mandatory in the request body of Create Order endpoint - POST /orders.
System-generated total discount, auto-filled by Orders service when the order is placed. This is saved for reference in case the value changes later.
System-generated total fees, auto-filled by Orders service when the order is placed
System-generated order total, auto-filled by Orders service when the order is placed. This is saved for reference in case the orderTotal changes later.
System-generated order subtotal, auto-filled by Orders service when the order is placed. This is saved for reference in case the value changes later.
System-generated total tax, auto-filled by Orders service when the order is placed
Optionally used as reference, for orders created from Point-of-Sale systems
Return total of order, for return scenarios, calculated as summationOfAll(itemReturnTotal)
Human-readable brief description based on statusCode
Order subtype, for further classification
IOS, ANDROID, INTERNATIONAL Recalculated total tax on order summationOfAll(itemTaxTotal)+summationOf(tax[].value)
Order type. It is critical for order life cycle as it indicates the workflow that varies with the type. For example, Storefront orders have a different workflow than Call Center orders. fabric Orders service offers standard configurations for Storefront, Call Center, Point of Sale, iOS, Android, and International.
WEB, CSC, MOBILE_APP, POS Time of last update to order (UTC)
Was this page helpful?