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"
}
'{
"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"
}
}Create a new bulk job to import products from a CSV file.
Access Control:
Important Notes:
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"
}
'{
"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"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ID of the uploaded CSV file containing product data
100"file-abc123xyz"