Skip to main content
POST
/
product-files
Create File Object and Get File Upload Location
curl --request POST \
  --url https://api.fabric.inc/v3/product-files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "ITEM_VARIANT_EXPORT",
  "name": "bulk_import_123345677788999.csv",
  "locale": "en-US"
}
'
{
  "id": "337f1f77bcf86cd799439011",
  "type": "ITEM_VARIANT_EXPORT",
  "name": "bulk_import_123345677788999.csv",
  "locale": "en-US",
  "location": "https://s3.console.aws.amazon.com/s3/buckets/greatwall-stg01-bulk-import-pim/bulk_import_123345677788999.csv",
  "createdAt": "2021-09-14T22:10:30.618Z",
  "updatedBy": "[email protected]",
  "updatedAt": "2021-09-14T22:10:30.618Z"
}

Authorizations

​
Authorization
string
header
required

S2S access token (JWT) from fabric Identity service (during login)

Headers

​
x-fabric-tenant-id
string

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.

Example:

"517fa9dfd42d8b00g1o3k312"

​
x-fabric-request-id
string

Unique request ID

Example:

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

Body

application/json

Request for file creation

​
type
enum<string>
required

Supported job types

Available options:
ITEM_VARIANT_EXPORT,
ITEM_VARIANT_IMPORT,
BUNDLE_EXPORT,
BUNDLE_IMPORT,
ATTRIBUTE_IMPORT,
ATTRIBUTE_EXPORT,
CATEGORY_IMPORT,
CATEGORY_EXPORT,
COLLECTION_IMPORT,
COLLECTION_EXPORT
Example:

"ITEM_VARIANT_EXPORT"

​
name
string
required

File name

Example:

"bulk_import_123345677788999.csv"

​
locale
string

If isLocalizable is true, the search is based on the localized name in specified locales. If isLocalizable is false, the search is only based on the non-localized names.

Example:

"en-US"

Response

Create file success response

​
id
string

24-character system-generated file ID

Example:

"337f1f77bcf86cd799439011"

​
type
enum<string>

Supported job types

Available options:
ITEM_VARIANT_EXPORT,
ITEM_VARIANT_IMPORT,
BUNDLE_EXPORT,
BUNDLE_IMPORT,
ATTRIBUTE_IMPORT,
ATTRIBUTE_EXPORT,
CATEGORY_IMPORT,
CATEGORY_EXPORT,
COLLECTION_IMPORT,
COLLECTION_EXPORT
Example:

"ITEM_VARIANT_EXPORT"

​
name
string

File name to be uploaded to the generated URL

Example:

"bulk_import_123345677788999.csv"

​
locale
string

If isLocalizable is true, the search is based on the localized name in specified locales. If isLocalizable is false, the search is only based on the non-localized names.

Example:

"en-US"

​
location
string

S3 file location of the uploaded file.

Example:

"https://s3.console.aws.amazon.com/s3/buckets/greatwall-stg01-bulk-import-pim/bulk_import_123345677788999.csv"

​
createdAt
string

File creation time (UTC)

Example:

"2021-09-14T22:10:30.618Z"

​
updatedBy
string

Email of user who last updated the file

Example:

"[email protected]"

​
updatedAt
string

Time of last update to file (UTC)

Example:

"2021-09-14T22:10:30.618Z"