We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.
Take me there

Check order-exchange eligibility

This endpoint checks if a specific item or an entire order, for a merchant, is eligible for exchange or not.

Request
query Parameters
orderId
required
string
Example: orderId=62f3982438bcab1951be0a19
lineItemId
string
Example: lineItemId=12345
header Parameters
tenant-key
required
string
Example:
required
object

x-site-context value

Responses
200

Exchange eligibility per item

400

Bad request

404

Order not exists!

500

Internal server error

get/order/exchange
Response samples
application/json
{
  • "orderId": "62f3982438bcab1951be0a19",
  • "eligibleReasonCodes": [
    ],
  • "policyType": "Exchange or return or cancellation",
  • "period": "30D00H00M",
  • "items": [
    ],
  • "fees": [
    ]
}