Skip to main content
POST
/
offers-exports
/
actions
/
download-export-file
Download exported CSV file
curl --request POST \
  --url https://api.fabric.inc/v3/offers-exports/actions/download-export-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "fileId": "redemption/tenantId/1687472972-redemption-export.csv"
}
'
{
  "url": "https://bucket-name.s3.amazonaws.com/redemption/tenantId/1687472972-redemption-export.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA26KLJWUAPER5A",
  "fileId": "redemption/tenantId/1687472972-redemption-export.csv"
}

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 downloadable URL of the file.

​
fileId
string
required

The fileId value retrieved from the get export request by ID endpoint. This is used to download the exported CSV.

Example:

"redemption/tenantId/1687472972-redemption-export.csv"

Response

OK

The URL of the downloadable CSV.

​
url
string
required

The AWS S3 URL to download the exported CSV.

Example:

"https://bucket-name.s3.amazonaws.com/redemption/tenantId/1687472972-redemption-export.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA26KLJWUAPER5A"

​
fileId
string
required

The S3 fileId value to generate a downloadable CSV.

Example:

"redemption/tenantId/1687472972-redemption-export.csv"