Get order exchange eligibility by order ID
Customers may want exchange an item because of size, color, or style preferences. Before processing exchange, it’s crucial to verify whether the item is eligible for exchange as per your policy.
This endpoint gets the eligibility of exchange request by order number. You can additionally specify lineItemId to get eligibility of a specific item.
Note: If you do not have the order ID, but have the order number, use the order number-based endpoint - POST /orders/order-number/{orderNumber}/actions/check-exchange-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
24-character system-generated order ID returned in the response of Create Order - POST /orders endpoint.
Query Parameters
Merchant-defined exchange policy. When omitted, the default policy is considered.
Line item ID. If specified, gets exchange eligibility of the given line item ID. If omitted, gets exchange 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?