Bulk upload
Start a bulk upload
Queue a previously uploaded bulk file for processing.
| Field | Type | Required | Notes |
|---|---|---|---|
channel_id |
integer | yes | The API channel your token belongs to. It is the channel_id in every order webhook, and support can give it to you before your first order. |
url |
string | yes | The URL from Get a bulk upload URL that you uploaded the file to. |
One bulk upload runs at a time per channel. Poll Check bulk upload status until
is_running is false before starting another. Starting a run resets the
counters and the error list.
Failures
| Status | Body | Meaning |
|---|---|---|
400 |
invalid channel_id |
channel_id missing or not positive. |
400 |
invalid url |
url was empty. |
400 |
a bulk upload is already running |
A run is already in progress for this channel. |
400 |
could not get channel |
The channel could not be found. |
400 |
could not queue bulk upload |
The run could not be queued on our side. Call Cancel a bulk upload, then retry. Without the cancel, a retry gets a bulk upload is already running for up to an hour. |
403 |
user 123 does not have access to channel 456 |
The channel does not belong to you. |
Response
200 with the run's status record, is_running set to true.
See the example response.