Initiate job to export items and variants

Use this endpoint to trigger a job to export items and variants based on the specified filter conditions.

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.

x-fabric-request-id

string

Unique request ID

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.

match

object

required

Filter conditions to export attributes

Show child attributes

match.createdAt

object

Date-time search

• Option 1
• Option 2
• Option 3

Show child attributes

match.createdAt.fromValue

string

required

Starting range (UTC)

match.createdAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

match.createdAt.toValue

string

required

Ending range (UTC)

match.description

object

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

match.description.value

string[]

required

match.id

object

Simple 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

match.id.value

string[]

required

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

match.isCustomFormulaSet.value

boolean

required

Sample boolean schema

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

match.isFormulaSet.value

boolean

required

Sample boolean 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

match.isLocalizable.value

boolean

required

Sample boolean schema

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

match.isMandatory.value

boolean

required

Sample boolean schema

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

match.isManualOverwrite.value

boolean

required

Sample boolean schema

match.name

object

Search criteria to find attributes. Append locale and name with a # as a value.

• 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

match.name.value

string[]

required

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.

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

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

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

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

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

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

match.updatedAt

object

Date-time search

• Option 1
• Option 2
• Option 3

Show child attributes

match.updatedAt.fromValue

string

required

Starting range (UTC)

match.updatedAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

match.updatedAt.toValue

string

required

Ending range (UTC)

type

enum<string>

required

Type of entity to be exported.

Available options:

ATTRIBUTE

Response

200 - application/json

Job ID for the exported job

jobId

string

24-character system-generated job ID