Get jobs related to products

Get a paginated list of jobs related to products by specifying the query parameters such as job ids, type. You can refine the results by specifying offset and limit. Note:
1. Query parameter ids can’t be combined with the rest of the query parameters and when it’s specified, pagination isn’t supported.
2. Query parameter inputFileIds supports up to 15 comma-separated file IDs and it can be combined only with the query parameter lastJobOnly. Pagination isn’t supported when this parameter is used.

GET

product-jobs

Copy
curl --request GET \
  --url https://api.fabric.inc/v3/product-jobs \
  --header 'Authorization: Bearer <token>'

Copy
{
  "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": "test@email.com",
      "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"

Query Parameters

ids

string

Supports up to 15 comma-separated job IDs. Note: 1. This parameter can't be combined with any other query parameter. 2. Pagination isn't supported when this parameter is used.

type

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"

inputFileIds

string

Supports up to 15 comma-separated file IDs. Note: 1. This can only be combined with the query parameter lastJobOnly. 2. Pagination isn't supported when this parameter is used.

lastJobOnly

boolean

true: The last job that meets the query parameters false: Not necessarily the last job Note: Only applicable with type and inputFileIds.

offset

integer

default:0

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

Example:

2

limit

integer

default:10

Maximum number of records per page

Example:

20

Response

200

application/json

Details of jobs

data

object[]

Job details

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

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

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:

"test@email.com"

data.updatedAt

string

Time of last update to job (UTC)

Example:

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

offset

integer

default:0

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

Example:

5

limit

integer

default:10

Maximum number of records per page

Example:

10

count

integer

Total number of records

Example:

100

Was this page helpful?

Copy
curl --request GET \
  --url https://api.fabric.inc/v3/product-jobs \
  --header 'Authorization: Bearer <token>'

Copy
{
  "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": "test@email.com",
      "updatedAt": "2021-09-14T22:10:30.618Z"
    }
  ],
  "offset": 5,
  "limit": 10,
  "count": 100
}

Release Notes

Authorizations

Headers

Query Parameters

Response