GET
/
api-offers
/
offers-exports

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.

Query Parameters

​
size
integer
default: 10

The maximum number of records per page.

Required range: 1 < x < 100
​
offset
integer
default: 0

The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.

Required range: x > 0
​
sort
string

Field to sort export requests.

​
type
enum<string>

Type of data to export.

Available options:
REDEMPTION,
CALCULATED_PRICE

Response

200 - application/json

A paginated response of export requests.

​
query
object

Provides pagination data.

​
data
object[]

The response data.

Was this page helpful?

Initiate export requestOffers