POST
/
offers-imports
/
actions
/
generate-upload-url
Generate URL to import a CSV file
curl --request POST \
  --url https://api.fabric.inc/v3/offers-imports/actions/generate-upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "fileName": "file1.csv",
  "type": "PRICE",
  "additionalAttributes": {
    "key": "coupon_id",
    "value": "1234"
  }
}'
{
  "url": "https://example.s3.amazonaws.com/pricelist/123/dev02/123-priceList1.csv?X-Amz-Algorithm...x-amz-meta-stage=dev02",
  "fileName": "prices/1646680518524-file1.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

A sample request containing file details be uploaded to the generated URL.

​
fileName
string
required

The name of the file to be uploaded.

Example:

"file1.csv"

​
type
enum<string>
required

Type of data in the file. The data provided in the file must match with type for successful processing of the file.

Available options:
PRICE,
PROMOTION,
COUPON,
COUPON_CODE,
REDEMPTION,
PRICE_RANGE,
PRICELIST
Example:

"PRICE"

​
additionalAttributes
object

A placeholder for additional information.

Response

OK

A sample response containing a generated URL and the file name to be processed.

​
url
string
required

The AWS S3 URL used to download the data, in a CSV format, of a previous import. The URL is valid for five minutes.

Example:

"https://example.s3.amazonaws.com/pricelist/123/dev02/123-priceList1.csv?X-Amz-Algorithm...x-amz-meta-stage=dev02"

​
fileName
string
required

The name of the error file.

Example:

"prices/1646680518524-file1.csv"