List Orders
List and filter all orders placed through your Zinc account.
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)
- merchant_order_ids - The retailer’s own order number(s), once placed — see Merchant Order IDs
- created_at - Order creation timestamp
- updated_at - Last update timestamp
Order Statuses
Expanding tracking events
By default, list responses keep tracking payloads small: each tracking number includes itsstatus but not the full carrier checkpoint timeline. Pass include=tracking_events to embed the per-scan checkpoints array on every tracking number.
GET /orders/{order_id}) always includes the full checkpoint timeline — include only affects the list endpoint. See Order Tracking for the checkpoint fields.Pagination
Authorizations
Zinc API key (Bearer zn_...)
Headers
Query Parameters
Number of orders to return
1 <= x <= 500Number of orders to skip
x >= 0Filter by order ID (partial match)
Partial match on order ID OR tracking number
Filter by the retailer's own order number (e.g. an Amazon 113-… ID), matched exactly against any of the order's order-placing jobs. Exact, not partial — dashes in the term are matched both as typed and stripped.
200Filter by order status
Filter to orders having at least one tracking number with this status
If true, only orders with at least one tracking number; if false, only orders with none
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.
Only orders created at/after this instant (inclusive)
Only orders created before this instant (exclusive)
Top-level metadata key to match, e.g. po_number. Must be sent together with metadata_value. Nested paths are not supported.
200Exact value metadata_key must equal. Matching is exact, not partial, and case-sensitive. Must be sent together with metadata_key.
500Optional expansions. tracking_events embeds the full carrier checkpoint timeline (and latest status) on each tracking number; omitted by default to keep list payloads small.

