Search Jobs

curl --request POST \
  --url https://api.fabric.inc/v3/product-jobs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "match": {
    "id": {
      "op": "IN",
      "value": [
        "5fc100f1dd0c5900750c04b1"
      ]
    },
    "inputFileId": {
      "op": "IN",
      "value": [
        "5fc100f1dd0c5900750c04b1"
      ]
    },
    "name": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "keyword": {
      "op": "CONTAINS",
      "value": "blue"
    },
    "type": {
      "op": "IN",
      "value": [
        "ITEM_VARIANT_EXPORT"
      ]
    },
    "status": {
      "op": "IN",
      "value": [
        "COMPLETED"
      ]
    },
    "createdAt": {
      "op": "RANGE",
      "fromValue": "2022-04-20T10:24:36.162Z",
      "toValue": "2023-04-20T10:24:36.162Z"
    },
    "completedAt": {
      "op": "RANGE",
      "fromValue": "2022-04-20T10:24:36.162Z",
      "toValue": "2023-04-20T10:24:36.162Z"
    }
  },
  "sort": "+id,-type",
  "offset": 2,
  "limit": 10
}
'

{
  "data": [
    {
      "id": "877f1f77bcf86cd799439087",
      "type": "ITEM_VARIANT_EXPORT",
      "inputFileId": "327f1f77bcf86cd799439045",
      "outputFiles": [
        "507f1f77bcf86cd7994390163, 967f1f77bcf86cd799439058"
      ],
      "errorFiles": [
        "887f1f77bcf86cd799439011, 997f1f77bcf86cd799439074"
      ],
      "progressTracker": {
        "updatedAt": "2023-02-14T22:10:30.618Z",
        "totalCount": 100000,
        "processedCount": 40000,
        "errorCount": 10
      },
      "status": "COMPLETED",
      "statusMessage": "100% completed",
      "additionalDetails": {
        "itemsCreated": 10,
        "itemsUpdated": 10,
        "variantsCreated": 10,
        "variantsUpdated": 10,
        "bundlesCreated": 10,
        "bundlesUpdated": 10,
        "attributeCreated": 10,
        "attributeUpdated": 10,
        "categoriesCreated": 10,
        "categoriesUpdated": 10,
        "collectionCreated": 5,
        "collectionUpdated": 10
      },
      "createdAt": "2021-09-14T22:10:30.618Z",
      "completedAt": "2021-09-14T22:10:30.618Z",
      "updatedBy": "[email protected]",
      "updatedAt": "2021-09-14T22:10:30.618Z"
    }
  ],
  "offset": 5,
  "limit": 10,
  "count": 100
}

POST

product-jobs

Search Jobs

curl --request POST \
  --url https://api.fabric.inc/v3/product-jobs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "match": {
    "id": {
      "op": "IN",
      "value": [
        "5fc100f1dd0c5900750c04b1"
      ]
    },
    "inputFileId": {
      "op": "IN",
      "value": [
        "5fc100f1dd0c5900750c04b1"
      ]
    },
    "name": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "keyword": {
      "op": "CONTAINS",
      "value": "blue"
    },
    "type": {
      "op": "IN",
      "value": [
        "ITEM_VARIANT_EXPORT"
      ]
    },
    "status": {
      "op": "IN",
      "value": [
        "COMPLETED"
      ]
    },
    "createdAt": {
      "op": "RANGE",
      "fromValue": "2022-04-20T10:24:36.162Z",
      "toValue": "2023-04-20T10:24:36.162Z"
    },
    "completedAt": {
      "op": "RANGE",
      "fromValue": "2022-04-20T10:24:36.162Z",
      "toValue": "2023-04-20T10:24:36.162Z"
    }
  },
  "sort": "+id,-type",
  "offset": 2,
  "limit": 10
}
'

{
  "data": [
    {
      "id": "877f1f77bcf86cd799439087",
      "type": "ITEM_VARIANT_EXPORT",
      "inputFileId": "327f1f77bcf86cd799439045",
      "outputFiles": [
        "507f1f77bcf86cd7994390163, 967f1f77bcf86cd799439058"
      ],
      "errorFiles": [
        "887f1f77bcf86cd799439011, 997f1f77bcf86cd799439074"
      ],
      "progressTracker": {
        "updatedAt": "2023-02-14T22:10:30.618Z",
        "totalCount": 100000,
        "processedCount": 40000,
        "errorCount": 10
      },
      "status": "COMPLETED",
      "statusMessage": "100% completed",
      "additionalDetails": {
        "itemsCreated": 10,
        "itemsUpdated": 10,
        "variantsCreated": 10,
        "variantsUpdated": 10,
        "bundlesCreated": 10,
        "bundlesUpdated": 10,
        "attributeCreated": 10,
        "attributeUpdated": 10,
        "categoriesCreated": 10,
        "categoriesUpdated": 10,
        "collectionCreated": 5,
        "collectionUpdated": 10
      },
      "createdAt": "2021-09-14T22:10:30.618Z",
      "completedAt": "2021-09-14T22:10:30.618Z",
      "updatedBy": "[email protected]",
      "updatedAt": "2021-09-14T22:10:30.618Z"
    }
  ],
  "offset": 5,
  "limit": 10,
  "count": 100
}

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 a job search.

match

object

required

Search criteria to match jobs.

Show child attributes

match.id

object

job id search

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

The schema id.

match.inputFileId

object

Search based on input file ID

Show child attributes

match.inputFileId.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.inputFileId.value

string[]

required

The schema id.

match.name

object

Search based on job name 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.keyword

object

Search based on either job name or job ID

Option 1
Option 2

Show child attributes

match.keyword.op

enum<string>

required

Search operation that can be performed on a string type

Available options:

CONTAINS

Example:

"CONTAINS"

match.keyword.value

string

required

Sample string schema

Example:

"blue"

match.type

object

Search based on job type

Show child attributes

match.type.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.type.value

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,

ATTRIBUTE_JOB,

PRODUCT_JOB,

CATEGORY_JOB,

COLLECTION_JOB,

PRODUCT_BULK_CATEGORY_UPDATE,

PRODUCT_DENORM_JOB

Example:

"ITEM_VARIANT_EXPORT"

match.status

object

Search based on job status

Show child attributes

match.status.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.status.value

enum<string>[]

required

Job status

Available options:

SCHEDULED,

COMPLETED_PARTIALLY,

IN_PROGRESS,

COMPLETED,

FAILED,

UPDATING_SEARCH_INDEX,

CANCELLATION_IN_PROGRESS,

CANCELLED

match.createdAt

object

Search based on job creation time 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.completedAt

object

Search based on job completion Time Date range search

Option 1
Option 2
Option 3

Show child attributes

match.completedAt.op

enum<string>

required

Search operation performed on a date range

Available options:

RANGE

Example:

"RANGE"

match.completedAt.fromValue

string

required

Starting range (UTC)

Example:

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

match.completedAt.toValue

string

required

Ending range (UTC)

Example:

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

sort

string

Sorting criteria. Sorting is supported on id, type, status, completedAt and createdAt. - refers to descending while + refers to ascending order.

Example:

"+id,-type"

offset

integer<int32>

default:0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

Example:

2

limit

integer<int32>

default:10

Maximum number of records per page

Example:

10

Response

Details of jobs

data

object[]

Show child attributes

data.id

string

24-character system-generated job ID

Example:

"877f1f77bcf86cd799439087"

data.type

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,

ATTRIBUTE_JOB,

PRODUCT_JOB,

CATEGORY_JOB,

COLLECTION_JOB,

PRODUCT_BULK_CATEGORY_UPDATE,

PRODUCT_DENORM_JOB

Example:

"ITEM_VARIANT_EXPORT"

data.inputFileId

string

File ID that needs to be processed through the job

Example:

"327f1f77bcf86cd799439045"

data.outputFiles

string[]

Output file IDs. For import and export jobs, the output files show the exported products (items, variant and/or bundle) based on the job type.

data.errorFiles

string[]

File IDs that show error details of the products that couldn't be imported or exported.

data.progressTracker

object

Show child attributes

data.progressTracker.updatedAt

string

Time of last update to tracker (UTC)

Example:

"2023-02-14T22:10:30.618Z"

data.progressTracker.totalCount

integer<int32>

Total number of records to be processed through the job

Example:

100000

data.progressTracker.processedCount

integer<int32>

Total number of records to be processed

Example:

40000

data.progressTracker.errorCount

integer<int32>

Total number of errors

Example:

10

data.status

enum<string>

Job status

Available options:

SCHEDULED,

COMPLETED_PARTIALLY,

IN_PROGRESS,

COMPLETED,

FAILED,

UPDATING_SEARCH_INDEX,

CANCELLATION_IN_PROGRESS,

CANCELLED

Example:

"COMPLETED"

data.statusMessage

string

User-friendly message corresponding to the current job status

Example:

"100% completed"

data.additionalDetails

object

Show child attributes

data.additionalDetails.itemsCreated

integer<int32>

Number of items created. Only applicable when the job type is ITEM_VARIANT_IMPORT.

Example:

10

data.additionalDetails.itemsUpdated

integer<int32>

Number of items updated. Only applicable when the job type is ITEM_VARIANT_IMPORT.

Example:

10

data.additionalDetails.variantsCreated

integer<int32>

Number of variants created. Only applicable when the job type is ITEM_VARIANT_IMPORT.

Example:

10

data.additionalDetails.variantsUpdated

integer<int32>

Number of variants updated. Only applicable when the job type is ITEM_VARIANT_IMPORT.

Example:

10

data.additionalDetails.bundlesCreated

integer<int32>

Number of bundles created. Only applicable when the job type is BUNDLE_IMPORT.

Example:

10

data.additionalDetails.bundlesUpdated

integer<int32>

Number of bundles updated. Only applicable when the job type is BUNDLE_IMPORT.

Example:

10

data.additionalDetails.attributeCreated

integer<int32>

Number of attributes created. Only applicable when the job type is ATTRIBUTE_IMPORT.

Example:

10

data.additionalDetails.attributeUpdated

integer<int32>

Number of attributes updated. Only applicable when the job type is ATTRIBUTE_IMPORT.

Example:

10

data.additionalDetails.categoriesCreated

integer<int32>

Number of categories created. Only applicable when the job type - CATEGORY_IMPORT.

Example:

10

data.additionalDetails.categoriesUpdated

integer<int32>

Number of categories updated. Only applicable when the job type is CATEGORY_IMPORT.

Example:

10

data.additionalDetails.collectionCreated

integer<int32>

Number of collections created. Only applicable when the job type is COLLECTION_IMPORT.

Example:

5

data.additionalDetails.collectionUpdated

integer<int32>

Number of collections updated. Only applicable when the job type is COLLECTION_IMPORT.

Example:

10

data.createdAt

string

Time of job creation (UTC)

Example:

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

data.completedAt

string

Time of job completion (UTC)

Example:

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

data.updatedBy

string

Email of the user who last updated the job

Example:

"[email protected]"

data.updatedAt

string

Time of last update to job (UTC)

Example:

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

offset

integer<int32>

default:0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

Example:

5

limit

integer<int32>

default:10

Maximum number of records per page

Example:

10

count

integer<int32>

Total number of records

Example:

100

Syncing Collections Using Delta Files Get Jobs Related to Products

⌘I

Product Catalog

Product Catalog User Guides

Product Catalog API

Developer Guide

Catalog Connector User Guides

Catalog Connector API

Search Jobs

Authorizations

Headers

Body

Response