Skip to main content
GET
/
orders
List Orders
curl --request GET \
  --url https://api.zinc.com/orders \
  --header 'Authorization: <api-key>'
{
  "orders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "max_price": 123,
      "attempts": 123,
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "quantity": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "variant": [
            {
              "label": "<string>",
              "value": "<string>"
            }
          ],
          "cancellation_reason": "<string>"
        }
      ],
      "shipping_address": {},
      "retailer_credentials_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "po_number": "<string>",
      "tracking_numbers": [],
      "created_by": "<string>",
      "user_id": 123,
      "returns": []
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Documentation Index

Fetch the complete documentation index at: https://www.zinc.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a list of all orders associated with your account. Orders are returned in reverse chronological order (most recent first).

Response

Returns an array of order objects, each containing:
  • id - Order UUID
  • status - Current order status
  • items - Products in the order
  • shipping_address - Delivery address
  • job_result - Processing results (for completed/failed orders)
  • created_at - Order creation timestamp
  • updated_at - Last update timestamp

Order Statuses

StatusDescription
pendingOrder queued, not yet processing
in_progressOrder is being placed
orderedSuccessfully placed with retailer
shippedOrder shipped (tracking available)
deliveredOrder delivered to address
cancelledOrder was cancelled
failedOrder processing failed

Pagination

Currently, all orders are returned in a single response. Pagination will be added in a future update.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Query Parameters

limit
integer
default:50

Number of orders to return

Required range: 1 <= x <= 500
offset
integer
default:0

Number of orders to skip

Required range: x >= 0
order_id
string | null

Filter by order ID (partial match)

status_filter
string | null

Filter by order status

return_status
string | null

Filter by return-request status. open → orders with at least one open return. closed → orders with at least one approved or denied return. Omit for no filter.

Response

Successful Response

List of orders for a particular user_id

orders
OrderResponse · object[]
required
total
integer
required
limit
integer
required
offset
integer
required