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

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

The merchant-defined order identifier provided during the Create Order - POST /orders endpoint.

Response

200 - application/json

A response object that contains properties and information on an item's eligibility for appeasement.

eligibleItems
object[]

An array of containing an item's eligibility for returns, cancellations, or exchanges.

eligibleReasonCodes
object[]

An array containing the reason codes for the returns.

orderId
string

The fabric system generated 24-character order ID.

orderNumber
string

A unique order number.

period
string

The return, exchange, or cancellation time window set in your policy.

policyType
string

The policy type that determines the eligibility of an exchange, return, appeasement or cancellation. If omitted, the default policy is used.

remainingRefundableAmount
number

The orders remaining refundable amount excluding items refunds.

totalRefundableAmount
number

The orders total refundable amount including items, fees, etc.