FAfabric
Global exclusion

Create sku-list

Creates a sku-list with the target products that are exempted from discounts to be applied.

post/api-offers/sku-list

Request

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Request body

titlestring required

SkuList name or title

listType'GLOBAL_EXCLUSION'

Type of skulist

applicableOnstring[] required

Applicable scope of skulist

startDatestring date-time required

Start date of sku-list. From this date, the products provided in the SKU list will be exempted from being discounted. The value must be in the future.

endDatestring date-time required

End date of sku-list. The value must be greater than the start date. From this date the products mentioned in the SKU list will again be applicable for discount to be applied.

deletedboolean

true: sku-list is deleted<br /> false: sku-list is not deleted

createdAtstring date-time

Creation date of the record

updatedAtstring date-time

Last updated date of the record

Example request

{
  "title": "GlobalExc_1",
  "listType": "GLOBAL_EXCLUSION",
  "applicableOn": [
    "PRODUCT_PRICE"
  ],
  "targetProducts": [
    {
      "kind": "SKU"
    }
  ],
  "startDate": "2022-05-04T09:23:51.459Z",
  "endDate": "2099-12-31T00:00:00.000Z",
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

Response

OK

_idstring

fabric database objectId of the record

titlestring

SkuList name or title

listType'GLOBAL_EXCLUSION'

Type of skulist

applicableOnstring[]

Applicable scope of skulist

startDatestring date-time

Start date of sku-list. The value must be in the future. It indicates the date from when the discount will not be applicable to the products mentioned in the sku-list.

endDatestring date-time

End date of sku-list. The value must be greater than the start date. It indicates the date from when discount be applicable to the products mentioned in the sku-list.

deletedboolean

true: sku-list is deleted<br /> false: sku-list is not deleted

createdAtstring date-time

Creation date of the record

updatedAtstring date-time

Last updated date of the record

Example response

{
  "_id": "614b58924e92f6861ac9d43b",
  "title": "GlobalExc_1",
  "listType": "GLOBAL_EXCLUSION",
  "applicableOn": [
    "PRODUCT_PRICE"
  ],
  "targetProducts": [
    {
      "kind": "SKU"
    }
  ],
  "startDate": "2022-05-04T09:23:51.459Z",
  "endDate": "2099-12-31T00:00:00.000Z",
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.