Get List of Promotions

Enables you to retrieve all the active promotions, in a paginated response.

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.

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

200 - application/json

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.

Show child attributes

promos

object[]

The details of the promotions.

Show child attributes