Search for coupons

Use this endpoint to search for coupons based on filter conditions.

Authorizations

Authorization

string

headerrequired

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.

Body

application/json

A sample request to search for promotions or coupons.

offset

number

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.

Required range: x > 0

limit

number

default: 10

The maximum number of records per page.

Required range: 1 < x < 100

sort

enum<string>

The criteria to sort the results. Use the format {sort order}{field name}, where - refers to a descending order and + refers to an ascending order.

Available options:

+updatedAt,

+title,

+startDate,

+endDate,

+level,

-updatedAt,

-title,

-startDate,

-endDate,

-level

filters

object[]

Show child attributes

Response

200 - application/json

The pagination data.

query

object

Show child attributes

data

object[]

The promotion details.

Show child attributes