GET
/
api-offers
/
coupon-codes
curl --request GET \
  --url https://live.copilot.fabric.inc/api-offers/coupon-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 50
  },
  "promos": [
    {
      "_id": "abcdefg1ee7ce20123456789",
      "promoId": 100013,
      "promoCodes": {
        "0": "SUMMER100",
        "1": "SUMMER20"
      },
      "promoCount": 1,
      "state": "SCHEDULED",
      "isImplicit": false,
      "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

​
size
integer
default:10

Records the number returned by the endpoint.

Required range: 1 <= x <= 100
Example:

10

​
startCursor
string | null

Record pointer to get items after that record

Example:

"641cf986ca5b2c3180787e09"

​
userId
string

Filter records by the user ID.

Example:

"user0001"

​
promotionId
string

Filter records by the promotion ID.

Example:

"641cf986ca5b2c3180787e09"

​
promoCode
string

Filter records by coupon code.

Example:

"SUMMER"

​
status
enum<string>

Filter records by status.

Available options:
ACTIVE,
INACTIVE,
REDEEMED
Example:

"ACTIVE"

​
startFrom
string

Filter records from a specific start date.

Example:

"2023-03-24T01:14:50.967Z"

​
startTo
string

Filter records until a specific start date.

Example:

"2023-03-24T01:14:50.967Z"

​
endFrom
string

Filter the records since a specific end date

Example:

"2023-03-24T01:14:50.967Z"

​
endTo
string

Filter records until a specific end date.

Example:

"2023-03-24T01:14:50.967Z"

​
additionalAttributes
string

Filter by the coupon code's additional attributes. This filter needs to be a valid JSON array to be able to make the search.

Example:

"[{key:'type',value:'My Birthday'}]"

​
promoAdditionalAttributes
string

Filter by the related promotion or coupon's additional attributes. This filter needs to be a valid JSON array to be able to make the search.

Example:

"[{key:'type',value:'Holiday'}]"

​
title
string

Filter coupon codes by the related promotion title.

Example:

"Summer promotion"

Response

200
application/json
OK
​
query
object
​
promos
object[]

Represents the conditions based on which the promotions apply. For example, consider the type is USER_SEGMENT with multiple values. To target all the specified segments, use the AND operator and to target any one of the segments, use the OR operator.

Was this page helpful?

Generate coupon codesOverview