Get order cancellation eligibility by order number
Either customer may initiate cancellation due to an incorrect order placement or as a merchant, you may initiate cancellation due to product unavailability, pricing errors, payment failure, or shipping restrictions. Before processing cancellation, it’s crucial to determine the eligibility of the cancellation request.
This endpoint gets the eligibility of the cancellation request by order number. You can additionally specify lineItemIds to get the eligibility of specific line items.
Note: If you do not have order number, use the corresponding order ID-based endpoint - /orders/{orderId}/actions/check-cancel-eligibility.
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
The merchant-defined order identifier.
Query Parameters
The merchant-defined cancellation policy. When omitted, the default policy is used.
The line item IDs. If specified, you'll get cancellation eligibility of the given line items. If omitted, you'll get cancellation eligibility of each item in the order.
Response
Eligibility details
Reason codes for returns
Fee details
Item's eligibility for return, cancellation, or exchange
24-character system-generated order ID
Return, exchange or cancellation window as per merchant policy
Policy type that determines eligibility of exchange, return, or cancellation. If omitted, the default policy is considered.
Was this page helpful?