Skip to main content
POST
/
orders
/
{orderIdType}
/
{orderIdValue}
/
actions
/
check-credits-eligibility
Check credits eligibility by order identifier
curl --request POST \
  --url https://api.fabric.inc/v3/orders/{orderIdType}/{orderIdValue}/actions/check-credits-eligibility \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "description": "Policy used to add credits",
  "eligibleReasonCodes": [
    {
      "code": "1DMG",
      "description": "Damaged"
    }
  ],
  "orderId": "62f3982438bcab1951be0a19",
  "policyName": "Credits policy",
  "policyType": "credits"
}

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.

Response

OK

Credits eligibility model

​
description
string

Description provided while requesting credits (for reference)

Example:

"Policy used to add credits"

​
eligibleReasonCodes
object[]

Reason codes to support credits request

​
orderId
string

24-character system-generated order ID

Example:

"62f3982438bcab1951be0a19"

​
policyName
string

Merchant-given policy name.

Example:

"Credits policy"

​
policyType
string

Policy type used to check credits eligibility

Example:

"credits"