Skip to main content
GET
/
api-price
/
promo
Get List of Promotions
curl --request GET \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-price/promo \
  --header 'x-site-context: <x-site-context>'
{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 66
  },
  "promos": [
    {
      "_id": "abcdefg1ee7ce20123456789",
      "promoId": 100013,
      "promoCodes": [],
      "promoCount": 0,
      "state": "SCHEDULED",
      "isImplicit": true,
      "title": "CREATE PROMO",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-25T14:15:22Z",
      "isExclusive": true,
      "eligiblePriceList": [
        10000056
      ],
      "updatedAt": "2019-08-20T14:15:22Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.fabric.inc/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-site-context
string
required

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

​
offset
number

Number of records you wish to skip before selecting records. Default is 0 if not specified

​
limit
number

limits the number of records returned by the api. Default is 10 if limit is not specified

​
keyword
string

Retrive records by SKU name

Response

Successfully gets list of all active promotions.

​
query
object

The query details such as how many promotions must be displayed in a page, the offset value, and the total number of applicable promotions.

​
promos
object[]

The details of the promotions.