Skip to main content
GET
Export Orders Csv
Stream the orders you can see as a CSV file. This is the download behind the dashboard’s Orders table, and it takes the same filters as List Orders — so an export contains exactly the rows you were looking at. The response is text/csv with Content-Disposition: attachment; filename="zinc-orders.csv", not JSON.
There is no limit/offset. The export always covers the whole filtered set, paged internally, so a large account gets every matching order in one file.

Columns

To export just one teammate’s orders, filter with user_email — a case-insensitive substring match on the address in created_by. See Filtering by teammate.
Under a zn_test_ key (or X-Test-Mode) this exports the sandbox orders.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Query Parameters

order_id
string | null

Filter by order ID (partial match)

search
string | null

Partial match on order ID OR tracking number

status_filter
string | null

Filter by order status

merchant_order_id
string | null

Filter by the retailer's own order number (exact match)

Maximum string length: 200
shipping_name
string | null

Shipping recipient's name (case-insensitive partial match)

Maximum string length: 200
tracking_status
string | null

Filter to orders having at least one tracking number with this status

has_tracking
boolean | null

Only orders with (true) or without (false) tracking

return_status
string | null

open or closed return requests; omit for no filter

created_after
string<date-time> | null

Only orders created at/after this instant (inclusive)

created_before
string<date-time> | null

Only orders created before this instant (exclusive)

metadata_key
string | null

Top-level metadata key to match; send with metadata_value

Maximum string length: 200
metadata_value
string | null

Exact value metadata_key must equal; send with metadata_key

Maximum string length: 500
user_email
string | null

Filter to orders placed by one org teammate, matched as a case-insensitive substring of their email. Only ever narrows within the caller's organization; a solo user can only match their own address.

Maximum string length: 320

Response

CSV file of the filtered orders.

The response is of type string.