Get return eligibility by order number
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 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 number, use the corresponding order ID-based endpoint - POST /orders/{orderId}/actions/check-return-eligibility.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Merchant's 24-character tenant ID
Sales channel ID
Unique request ID
Path Parameters
Merchant-defined order identifier
Query Parameters
Merchant-defined return policy. When omitted, the default policy is considered.
Line item ID. If specified, you'll get the return eligibility of the given line item ID. If omitted, you'll get 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?