FAfabric
Catalog Connector Jobs

Export products

Use this endpoint to start an internal job to export products from Catalog Connector. Specify the formatType query parameter to export data in either CSV or JSONL format. In the request body, provide the ids of all products to be exported, the product type, and the locale.

post/catalog-connector-jobs/actions/export

Request

Headers

x-fabric-tenant-idstring 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-idstring

Unique request ID

Request body

idsstring[] required

The product type IDs that must be exported.

formatType'csv' | 'jsonl'

Specify the file format used to upload to Catalog Connector.

localestring required

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

The default value is en-US.

type'CATALOG_CONN_ITEM_VARIANT_EXPORT' | 'CATALOG_CONN_BUNDLE_EXPORT' required

The supported job types.

Example request

{
  "ids": [
    "5f328bf0b5f328bf0b5f328b",
    "22328bf0b5f328bf0b5f3287"
  ],
  "formatType": "jsonl",
  "locale": "en-US",
  "type": "CATALOG_CONN_ITEM_VARIANT_EXPORT"
}

Response

OK

jobIdstring

A 24-character system-generated job ID.

Example response

{
  "jobId": "877f1f77bcf86cd799439087"
}

Changes

No recorded changes to this operation across all 1 revision of this API.