POST
/
offers-exports

Authorizations

Authorization
string
headerrequired

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

Headers

x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Required string length: 24
x-fabric-channel-id
string

The sales channel ID.

x-client-id
string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

x-fabric-request-id
string

A unique request ID.

Body

application/json

The sample request to initiate data export.

type
enum<string>
required

The type of data to export.

Available options:
REDEMPTION,
CALCULATED_PRICE
filters
object[]

Filters to apply when exporting the data.

Response

201 - application/json

The sample response of the create export request.

exportId
string
required

A unique ID for the export request.

startedAt
string
required

The start time of the export process.

status
enum<string>
required

The status of the export process.

Available options:
IN_PROGRESS,
COMPLETED,
ERROR
type
string
required

The type of data to export.

endedAt
string | null

The end time of the export process.

totalDataExported
number

The total number of exported data in the CSV file. Each row in the CSV file represents one record of exported data.

errors
object[]

Errors during export process

filters
object[]

Was this page helpful?

Retrieve the download URL for an error fileGet export request by ID