Skip to main content
GET
/
api
/
v1
/
products
/
bulk
/
jobs
Query bulk product import jobs
curl --request GET \
  --url https://apix.us.amity.co/api/v1/products/bulk/jobs \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": [
    {
      "_id": "64a1b2c3d4e5f6g7h8i9j0k1",
      "jobId": "64a1b2c3d4e5f6g7h8i9j0k1",
      "networkId": "network-abc123",
      "userId": "user-xyz789",
      "fileId": "file-123456",
      "status": "pending",
      "entityType": "product",
      "operation": "insert",
      "summary": {
        "totalRows": 100,
        "processedRows": 100,
        "successfulRows": 95,
        "failedRows": 5,
        "errorReportFileId": "file-error-report-123",
        "metadata": {},
        "processingStartedAt": "2024-01-15T10:30:30.000Z",
        "processingCompletedAt": "2024-01-15T10:35:30.000Z",
        "processingDurationMs": 300000
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:35:00.000Z",
      "expiredAt": "2024-01-18T10:30:00.000Z"
    }
  ],
  "paging": {
    "next": "<string>",
    "previous": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
status
enum<string>[]

Filter bulk jobs by status (can specify multiple)

Required array length: 1 - 3 elements
Available options:
pending,
running,
done
​
sortBy
enum<string>

Field to sort by

Available options:
createdAt,
updatedAt,
productName
​
sortOrder
enum<string>

Sort order

Available options:
asc,
desc
​
options[limit]
integer
default:20

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100
​
options[token]
string

Pagination token for fetching next page

Maximum string length: 1000

Response

Successful response with list of bulk jobs

​
status
string
Example:

"success"

​
data
object[]
​
paging
object