FAfabric
Coupon

Get list of all coupons

Retrieves a paginated list of all coupons.

post/api-offers/coupon/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

offsetnumber

The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.

limitnumber

The maximum number of records per page.

keywordstring

Keyword to filter the matched promotion titles or promotional codes or coupon codes

sortBy'updatedAt' | 'title' | 'startDate' | 'endDate'

Field by which you want to sort the records

sortOrder'desc' | 'asc'

Sorting order of the records<br />desc: Descending order<br />asc: Ascending order

Example request

{
  "limit": 10,
  "keyword": "PROMO",
  "sortBy": "updatedAt",
  "sortOrder": "desc"
}

Response

OK

Example response

{
  "query": {
    "limit": 10,
    "count": 50
  },
  "promos": [
    {
      "_id": "abcdefg1ee7ce20123456789",
      "promoId": 100013,
      "promoCodes": [
        "SUMMER100",
        "SUMMER20"
      ],
      "promoCount": 1,
      "state": "SCHEDULED",
      "title": "CREATE PROMO",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-25T14:15:22Z",
      "isExclusive": true,
      "eligiblePriceList": [
        10000056
      ],
      "level": 1,
      "stackingType": "STACKABLE",
      "updatedAt": "2019-08-20T14:15:22Z"
    }
  ]
}

Changes

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