FAfabric
Global exclusion

End specific sku-list

This endpoint lets you end the exclusion of a sku-list from discount, there by allowing the products under the sku-list to be applicable for discount.

post/api-offers/sku-list/{skuListId}/end-now

Request

Path parameters

skuListIdnumber required

ID of the list to end

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.

Response

OK

_idstring

A 24-character system-generated ID of the record.

titlestring

SkuList name/title

listType'GLOBAL_EXCLUSION'

Type of skulist

applicableOnstring[]

Applicable scope of skulist

startDatestring date-time

Start date of the sku-list. This is the date from which the products under the sku-list were excluded from being discounted.

endDatestring date-time

End date of sku-list. This is the date from which the products under the sku-list will again be applicable for being discounted. The value must be greater than the start date.

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": "2021-05-04T09:23:51.459Z",
  "endDate": "2021-05-04T09:23:51.459Z",
  "deleted": true,
  "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.