Skip to main content
POST
/
api
/
v1
/
products
/
bulk
/
jobs
/
{jobId}
Start bulk product import job
curl --request POST \
  --url https://apix.us.amity.co/api/v1/products/bulk/jobs/{jobId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operation": "insert"
}
'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
jobId
string
required

The unique identifier of the bulk job

Required string length: 24
Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
​
operation
enum<string>
required

Operation to perform on the products in the CSV file

Available options:
insert,
update
Example:

"insert"

Response

Successful response with bulk job details

​
status
string
Example:

"success"

​
data
object