Skip to main content
GET
/
orders
/
bulk
/
{batch_id}
Get Bulk Upload
curl --request GET \
  --url https://api.zinc.com/orders/bulk/{batch_id} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "row_count": 123,
  "placed_count": 123,
  "failed_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "filename": "<string>",
  "rows": [
    {
      "index": 123,
      "status": "<string>",
      "order_id": "<string>",
      "order_status": "<string>",
      "error": "<string>",
      "recipient": "<string>",
      "product_urls": [
        "<string>"
      ],
      "passthrough": {}
    }
  ]
}
Retrieve a batch with per-row results and live order statuses.

Batch Statuses

StatusDescription
pendingAccepted, rows not yet processed
processingRows are being placed
completedEvery row has been processed
failedThe batch could not be processed

Per-Row Results

Each entry in rows reports the outcome for one CSV row:
  • statuspending, placed, or failed.
  • order_id / order_status — Set once the row is placed; use Get Order for full order details.
  • error — Failure reason for failed rows.
  • passthrough — Your unrecognized CSV columns, echoed back for reconciliation.
Poll this endpoint while the batch is pending or processing. Once it’s completed, download the full results with Download Bulk Results.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Path Parameters

batch_id
string<uuid>
required

Response

Successful Response

A bulk-upload batch and (on the detail endpoint) its per-row results.

id
string<uuid>
required
status
enum<string>
required

Lifecycle of a CSV bulk-upload batch.

Available options:
pending,
processing,
completed,
failed
row_count
integer
required
placed_count
integer
required
failed_count
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
filename
string | null
rows
BulkRowResult · object[]