POST
/
catalog-connector-files

Authorizations

Authorization
string
headerrequired

This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.

Headers

x-fabric-tenant-id
string
required

A header retrieved from your Copilot Account Details that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints.

x-fabric-request-id
string

Unique request ID

Body

application/json

A sample request to create a file object and retrieve the upload URL to import products to the Catalog Connector.

type
enum<string>
required

Specify the type of operation or job performed by uploading the file.

Available options:
CATALOG_CONN_ITEM_VARIANT_IMPORT,
CATALOG_CONN_ITEM_VARIANT_EXPORT,
CATALOG_CONN_BUNDLE_IMPORT,
CATALOG_CONN_BUNDLE_EXPORT
name
string
required

The name of the file to be imported.

locale
string
required

The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format).

The default value is en-US.

formatType
enum<string>
required

Specify the file format used to upload to Catalog Connector.

Available options:
csv,
jsonl

Response

200 - application/json

The details of the file.

id
string

A 24-character system-generated file ID.

type
enum<string>

Specify the type of operation or job performed by uploading the file.

Available options:
CATALOG_CONN_ITEM_VARIANT_IMPORT,
CATALOG_CONN_ITEM_VARIANT_EXPORT,
CATALOG_CONN_BUNDLE_IMPORT,
CATALOG_CONN_BUNDLE_EXPORT
name
string

The name of the file name to be uploaded to the AWS S3 location.

locale
string

The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format).

The default value is en-US.

formatType
enum<string>

Specify the file format used to upload to Catalog Connector.

Available options:
csv,
jsonl
createdAt
string

The time of file creation, in UTC format.

updatedBy
string

The email of the user who last updated the file.

updatedAt
string

The time of last update to the file, in UTC format.

location
string

The AWS S3 file location of the imported file is provided as a URL.