Create bulk product import job

Create a new bulk job to import products from a CSV file.

Access Control:

• Requires admin permissions with ManageProducts flag

Important Notes:

• CSV file must be uploaded first using the file upload API
• Job will be created in ‘pending’ status
• Use the start endpoint to begin processing
• Job expires in 3 days if not started
• Product feature must be enabled in network settings

POST /api/v1/products/bulk/jobs

Create bulk product import job

cURL

curl --request POST \
  --url https://apix.us.amity.co/api/v1/products/bulk/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileId": "file-abc123xyz"
}
'

200

{
  "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.

Body

application/json

fileId · string · required

ID of the uploaded CSV file containing product data

Maximum string length: 100

Example:

"file-abc123xyz"

Response

200

application/json

Successful response after creating a bulk job

status · string

Example:

"success"

data · object

Show child attributes