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-cancellation eligibility

Checks if a specific order is eligible for cancellation.

Request
query Parameters
orderId
required
string

Oder ID

Example: orderId=62f3982438bcab1951be0a19
lineItemIds
Array of strings

Array of line item IDs to check if the line items are eligible for cancellation

Example: lineItemIds=12345
header Parameters
required
object

x-site-context value

Responses
200

OK

400

Bad request

404

Not found

500

Internal server error

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