GET
/
product-exclusion-lists

Authorizations

​
Authorization
string
headerrequired

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.

​
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.

Query Parameters

​
size
integer
default: 10

The maximum number of records per page.

Required range: 1 < x < 100
​
offset
integer
default: 0

The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.

Required range: x > 0
​
listType
enum<string>

Type of the product exclusion list to filter records

Available options:
GLOBAL_EXCLUSION
​
scopes
enum<string>

Scope of the product exclusion list to filter records. It's used to identify whether to exclude discounts on the SKU price or associated shipping price.

Available options:
PRODUCT_PRICE,
SHIPPING_PRICE
​
date
string

Date that lies between startAt and endAt of product exclusion list

Response

200 - application/json

List of product exclusion list

​
query
object

Provides pagination data.

​
data
object[]

Response data

Was this page helpful?

Delete a specific product exclusion listOverview