GET
/
order
/
exchange
curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/order/exchange \
  --header 'Authorization: Bearer <token>' \
  --header 'tenant-key: <tenant-key>' \
  --header 'x-site-context: <x-site-context>'
{
  "orderId": "62f3982438bcab1951be0a19",
  "eligibleReasonCodes": [
    "wrong item"
  ],
  "policyType": "Exchange or return or cancellation",
  "period": "30D00H00M",
  "items": [
    {
      "lineItemId": "62f3dfc438bcab1951be0a19",
      "eligibleQuantity": 10,
      "eligible": true
    }
  ],
  "fees": [
    {
      "platinumFee": 33.9,
      "currency": "USD"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
tenant-key
string
required
Example:

null

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

​
orderId
string
required
Example:

"62f3982438bcab1951be0a19"

​
lineItemId
string
Example:

12345

Response

200
application/json
Exchange eligibility per item

Order eligibility object