Skip to main content
POST
/
orders
/
{orderIdType}
/
{orderIdValue}
/
actions
/
check-cancel-eligibility
Check order cancellation eligibility by order identifier
curl --request POST \
  --url https://api.fabric.inc/v3/orders/{orderIdType}/{orderIdValue}/actions/check-cancel-eligibility \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "eligibleReasonCodes": [
    {
      "code": "1DMG",
      "description": "Damaged"
    }
  ],
  "fees": [
    {
      "amount": 33.9,
      "amountInCurrencies": [
        {
          "currency": "USD",
          "group": "SHOPPER",
          "amount": 123.45
        }
      ],
      "currency": "USD",
      "platinumFee": 33.9
    }
  ],
  "items": [
    {
      "eligibleQuantity": 10,
      "isEligible": true,
      "lineItemId": "62f3dfc438bcab1951be0a19",
      "sku": "P1234"
    }
  ],
  "orderId": "62f3982438bcab1951be0a19",
  "period": "30D00H00M",
  "policyType": "Company Policy 2023"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

​
x-fabric-channel-id
string
required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

​
x-fabric-request-id
string

Unique request ID

Path Parameters

​
orderIdType
enum<string>
required

The type of order identifier used to locate the order.
Supported values:

  • order-id
  • order-number
  • order-external-id
Available options:
order-id,
order-number,
order-external-id
​
orderIdValue
string
required

The value of the specified order identifier.

Query Parameters

​
policyName
string

The merchant-defined cancellation policy to use when evaluating eligibility.
If omitted, the default policy is applied.

​
lineItemIds
string[]

One or more line item IDs.

  • If specified, eligibility is checked only for the given line items.
  • If omitted, eligibility is checked for each item in the order.

Response

OK

Eligibility details object.

​
eligibleReasonCodes
object[]

Reason codes for returns

​
fees
object[]

Fee details

​
items
object[]

Item's eligibility for return, cancellation, or exchange

​
orderId
string

24-character system-generated order ID

Example:

"62f3982438bcab1951be0a19"

​
period
string

Return, exchange or cancellation window as per merchant policy

Example:

"30D00H00M"

​
policyType
string

Policy type that determines eligibility of exchange, return, or cancellation. If omitted, the default policy is considered.

Example:

"Company Policy 2023"