Initiate Job to Export Items and Variants

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

Option 1
Option 2
Option 3
Option 4

Export job request based on the filter conditions applied for attributes, category, collections, items or bundles.

type

enum<string>

required

Type of entity to be exported.

Available options:

ATTRIBUTE

Example:

"ATTRIBUTE"

match

object

required

Filter conditions to export attributes

Show child attributes

match.id

object

Simple string search Simple multi-string search

Option 1
Option 2

Show child attributes

match.id.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.id.value

string[]

required

Sample string schema

match.name

object

Search criteria to find attributes. Append locale and name with a # as a value. String search Simple multi-string search

Option 1
Option 2

Show child attributes

match.name.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.name.value

string[]

required

Sample string schema

match.name.locale

string[]

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

Locale

match.description

object

String search Simple multi-string search

Option 1
Option 2

Show child attributes

match.description.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.description.value

string[]

required

Sample string schema

match.isLocalizable

object

Boolean search

Show child attributes

match.isLocalizable.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.isLocalizable.value

boolean

required

Sample boolean schema

Example:

true

match.isMandatory

object

Boolean search

Show child attributes

match.isMandatory.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.isMandatory.value

boolean

required

Sample boolean schema

Example:

true

match.isManualOverwrite

object

Boolean search

Show child attributes

match.isManualOverwrite.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.isManualOverwrite.value

boolean

required

Sample boolean schema

Example:

true

match.isFormulaSet

object

Boolean search

Show child attributes

match.isFormulaSet.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.isFormulaSet.value

boolean

required

Sample boolean schema

Example:

true

match.isCustomFormulaSet

object

Boolean search

Show child attributes

match.isCustomFormulaSet.op

enum<string>

required

Operations that can be performed on a boolean type

Available options:

EQUALS

Example:

"EQUALS"

match.isCustomFormulaSet.value

boolean

required

Sample boolean schema

Example:

true

match.target

object

Export criteria - single target

Option 1
Option 2

Show child attributes

match.target.op

enum<string>

required

Operations supported on a string type.

Available options:

EQUALS

Example:

"EQUALS"

match.target.value

enum<string>

required

A string in case of EQUALS operation and a comma-separated string in case of an IN operation

Available options:

PRODUCT,

CATEGORY

Example:

"PRODUCT"

match.type

object

Export criteria - single type

Option 1
Option 2

Show child attributes

match.type.op

enum<string>

required

Operations supported on a string type

Available options:

EQUALS

Example:

"EQUALS"

match.type.value

enum<string>

required

A string in case of EQUALS operation and a comma- separated string in case of an IN operation

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

Example:

"TEXT"

match.subType

object

Searches for attribute of the specified subType

Option 1
Option 2

Show child attributes

match.subType.op

enum<string>

required

Operations that can be performed on a string type

Available options:

EQUALS

Example:

"EQUALS"

match.subType.value

enum<string>

required

A string in case of a EQUALS operation and a comma-separated string in case of an IN operation

Available options:

SINGLE,

MULTIPLE,

SMALL_TEXT,

TEXT_AREA,

HTML

Example:

"SINGLE"

match.createdAt

object

Date-time search Date range search

Option 1
Option 2
Option 3

Show child attributes

match.createdAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

Example:

"RANGE"

match.createdAt.fromValue

string

required

Starting range (UTC)

Example:

"2022-04-20T10:24:36.162Z"

match.createdAt.toValue

string

required

Ending range (UTC)

Example:

"2023-04-20T10:24:36.162Z"

match.updatedAt

object

Date-time search Date range search

Option 1
Option 2
Option 3

Show child attributes

match.updatedAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

Example:

"RANGE"

match.updatedAt.fromValue

string

required

Starting range (UTC)

Example:

"2022-04-20T10:24:36.162Z"

match.updatedAt.toValue

string

required

Ending range (UTC)

Example:

"2023-04-20T10:24:36.162Z"

Response

Job ID for the exported job

jobId

string

24-character system-generated job ID

Example:

"877f1f77bcf86cd799439087"

Product Catalog

Product Catalog User Guides

Product Catalog API

Developer Guide

Catalog Connector User Guides

Catalog Connector API

Initiate Job to Export Items and Variants

Authorizations

Headers

Body

Response