Bulk Import Coupon
Bulk-imports coupons from an uploaded asset file. Submit the asset path to validate each row and enqueue a background job that processes the import
Bulk-imports coupons from an uploaded asset file. Submit the asset path to validate each row and enqueue a background job that processes the import.
POST
https://example.thoughtindustries.com/incoming/v2/coupons/bulkImportExample request
curl -X POST "https://example.thoughtindustries.com/incoming/v2/coupons/bulkImport" \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"bulkImportAssetPath": "string"
}'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
bulkImportAssetPath | string | Yes | body | The storage path of the uploaded asset file containing the coupon rows to import. |
Example response
{
"backgroundJob": {
"id": "00000000-0000-0000-0000-000000000000",
"description": "string",
"errorMessage": "string",
"status": "string"
}
}Response fields
| Field | Type | Description |
|---|---|---|
backgroundJob | object | The background job processing the coupon import. |
backgroundJob.id | uuid | Identifier of the background job. |
backgroundJob.description | string | Human-readable description of the job. |
backgroundJob.errorMessage | string | Error message if the job failed to start or run. |
backgroundJob.status | string | Current status of the background job. |