Skip to main content
POST
/
offers-exports
Initiate export request
curl --request POST \
  --url https://api.fabric.inc/v3/offers-exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "type": "REDEMPTION",
  "filters": [
    {
      "field": "storeId",
      "value": "store001",
      "operator": "EQUAL"
    }
  ]
}
'
{
  "exportId": "ab50fe48-5da0-4e77-92d1-bb629eedf19e",
  "startedAt": "2023-05-17T21:24:52.398Z",
  "status": "IN_PROGRESS",
  "type": "REDEMPTION",
  "endedAt": "null",
  "totalDataExported": 0,
  "errors": [],
  "filters": [
    {
      "field": "storeId",
      "value": "store001",
      "operator": "EQUAL"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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.

Example:

"12"

​
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.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

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
Example:

"REDEMPTION"

​
filters
object[]

Filters to apply when exporting the data. You can include multiple filter values in the request. If you do not include any filters parameter, all export data of the specified data type is returned. For more information on using filters to refine your data, see the export parameters section.

Maximum array length: 20

Response

Created

The sample response of the create export request.

​
exportId
string
required

The unique ID for the export request that is used to retrieve the export details.

Example:

"ab50fe48-5da0-4e77-92d1-bb629eedf19e"

​
startedAt
string
required

The start time of the export process.

Example:

"2023-05-17T21:24:52.398Z"

​
status
string
required

The status of the export process. The download exported CSV file endpoint can generate a download URL only if the export status is COMPLETED. The following are possible statuses:

  • IN_PROGRESS
  • COMPLETED
  • ERROR
Example:

"IN_PROGRESS"

​
type
string
required

The type of data to export.

Example:

"REDEMPTION"

​
endedAt
string | null

The end time of the export process.

Example:

null

​
totalDataExported
number

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

Example:

0

​
errors
object[]

Errors during the export process. For more information about the error messages, see the exporting CSV section.

Example:
[]
​
filters
object[]