GET
/
product-exclusion-lists
/
{id}
curl --request GET \
  --url https://api.fabric.inc/v3/product-exclusion-lists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "id": "614b58924e92f6861ac9d43b",
  "name": "Gucci handbags",
  "startAt": "2022-05-04T09:23:51.459Z",
  "endAt": "2099-12-31T00:00:00.000Z",
  "scopes": [
    "PRODUCT_PRICE"
  ],
  "listType": "GLOBAL_EXCLUSION",
  "createdAt": "2019-08-20T14:15:22.000Z",
  "updatedAt": "2019-08-20T14:15:22.000Z",
  "isDeleted": false,
  "targetProducts": [
    {
      "type": "SKU",
      "values": [
        "1000000123"
      ]
    }
  ]
}

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.

Required string length: 24
​
x-fabric-channel-id
string

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.

Example:

"12"

​
x-client-id
string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

​
x-fabric-request-id
string

A unique request ID.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

Path Parameters

​
id
string
required

Product exclusion list ID

Example:

"614b58924e92f6861ac9d43b"

Response

200
application/json
OK

Product exclusion list details

​
id
string
required

Product exclusion list ID

Example:

"614b58924e92f6861ac9d43b"

​
name
string
required

Product exclusion list name

Example:

"Gucci handbags"

​
startAt
string
required

Start date of the product exclusion list. The value must be in the future.

Example:

"2022-05-04T09:23:51.459Z"

​
endAt
string
required

End date of product exclusion list. The value must be greater than the start date.

Example:

"2099-12-31T00:00:00.000Z"

​
scopes
enum<string>[]
required

Applicable scope of product exclusion list. It's used to identify whether to exclude discounts on the SKU price or associated shipping price or both.

Scope to exclude discounts for the product exclusion list

Available options:
PRODUCT_PRICE,
SHIPPING_PRICE
​
listType
enum<string>
required

Product exclusion list type

Available options:
GLOBAL_EXCLUSION
Example:

"GLOBAL_EXCLUSION"

​
createdAt
string
required

Record's creation time

Example:

"2019-08-20T14:15:22.000Z"

​
updatedAt
string
required

Record's last updated time

Example:

"2019-08-20T14:15:22.000Z"

​
isDeleted
boolean

true: Record is deleted<br>false: Record isn't deleted

Example:

false

​
targetProducts
object[]

Products to exclude

Target products of the exclusion list that will be exempted from being discounted

Was this page helpful?