Get eligibility of returns for items in an order by order ID
Customers may want to return one or more items because they do not meet the expectations or customer has changed their mind. Before processing return, it’s crucial to verify whether the items are eligible for return as per your policy
This endpoint gets the eligibility of your return by order number. You can additionally specify lineItemId to get the eligibility of a single line item.
Note: If you do not have the order ID, use the corresponding order number-based endpoint - POST /orders/order-number/{orderNumber}/actions/check-return-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
24-character system-generated order ID returned in the response of Create Order - POST /orders endpoint.
Query Parameters
Merchant-defined return policy. When omitted, the default policy is considered.
Line item ID. If specified, gets the return eligibility of the given line item ID. If omitted, gets the return 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?