Get order cancellation eligibility by order ID

Determines whether an order is eligible for cancellation.

• Customers may initiate cancellation due to incorrect order placement.
• Merchants may initiate cancellation due to product unavailability, pricing errors, payment failures, or shipping restrictions.

This endpoint checks cancellation eligibility using the order ID.
You can also specify lineItemIds to check eligibility for specific line items.
If omitted, eligibility is checked for each item in the order.

Note:

• Use this endpoint only if you have the order ID.
• If you have an order number instead, use the order number–based endpoint:
  POST /orders/order-number/{orderNumber}/actions/check-cancel-eligibility.

POST /orders/{orderId}/actions/check-cancel-eligibility

Try it

Get order cancellation eligibility by order ID

cURL

curl --request POST \
  --url https://api.fabric.inc/v3/orders/{orderId}/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>'

200

{
  "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

orderId · string · required

24-character system-generated order ID returned in the response of Create Order - POST /orders endpoint.

Query Parameters

policyName · string

Merchant-defined cancellation policy. When omitted, the default policy is considered.

lineItemIds · string[]

Line item IDs. If specified, gets eligibility of exchange for the given line items. If omitted, gets eligibility of exchange for each item in the order.

Response

200

application/json

OK

Eligibility details object.

eligibleReasonCodes · object[]

Reason codes for returns

Show child attributes

eligibleReasonCodes. code · string

Reason code for return, cancellation, or exchange. Values are configurable as per requirement.

Example:

"1DMG"

eligibleReasonCodes. description · string

Brief description for the return code

Example:

"Damaged"

fees · object[]

Fee details

Show child attributes

fees. amount · number<double>

Fee applicable for the policy

Example:

33.9

fees. amountInCurrencies · object[]

Show child attributes

fees.amountInCurrencies. currency · string · required

Currency in ISO-4217

Example:

"USD"

fees.amountInCurrencies. group · string · required

A unique identifier for currencies. All calculations and invoicing are based on this identifier. For example, the Shopper group uses USD, while the Retailer group uses EUR.

Example:

"SHOPPER"

fees.amountInCurrencies. amount · number<double>

The amount displayed in the primary currency.

Example:

123.45

fees. currency · string

Three-letter currency code as defined by ISO-4217

Example:

"USD"

fees. platinumFee · number<double>

Fees applicable for return, cancellation, or exchange of an item as per the policy

Example:

33.9

items · object[]

Item's eligibility for return, cancellation, or exchange

Show child attributes

items. eligibleQuantity · integer<int32>

Quantity of the given item eligible for return, cancellation, or exchange

Example:

10

items. isEligible · boolean

true: Item is eligible for return or exchange false: Item is not eligible for return or exchange

Example:

true

items. lineItemId · string

Merchant-defined unique identifier for each item in an order. When omitted, fabric will generate it during order creation, in UUID format.

Example:

"62f3dfc438bcab1951be0a19"

items. sku · string

Stock keeping unit (SKU), unique identifier of item

Example:

"P1234"

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"