POST
/
product-jobs
/
search
curl --request POST \
  --url https://api.fabric.inc/v3/product-jobs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sort": "+id,-type",
  "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"
    }
  },
  "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": "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"

Body

application/json

Request for a job search.

​
match
object
required

Search criteria to match jobs.

​
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
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:

10

Response

200
application/json
OK

Details of jobs

​
data
object[]

Job details

​
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?