Create product exclusion list

Create a product exclusion list with target products that will be exempted from being discounted.

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.

Body

application/json

Product exclusion list record detail

name

string

required

Product exclusion list name

startAt

string

required

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

endAt

string

required

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

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.

Available options:

PRODUCT_PRICE,

SHIPPING_PRICE

targetProducts

object[]

required

Products to exclude from being discounted

Show child attributes

listType

enum<string>

Product exclusion list type

Available options:

GLOBAL_EXCLUSION

Response

201 - application/json

Product exclusion list details

id

string

required

Product exclusion list ID

name

string

required

Product exclusion list name

startAt

string

required

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

endAt

string

required

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

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.

Available options:

PRODUCT_PRICE,

SHIPPING_PRICE

listType

enum<string>

required

Product exclusion list type

Available options:

GLOBAL_EXCLUSION

createdAt

string

required

Record's creation time

updatedAt

string

required

Record's last updated time

isDeleted

boolean

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