Export Fulfillment Orders
GET/api/fulfillment-orders/export
Export the Fulfillment Orders list view as an XLSX or CSV file (sibling of the Fulfillments export). Requires a Bearer token.
The response is a binary file download (not JSON): Content-Type is application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for xlsx or text/csv for csv. The filename is fulfillment-orders-<timestamp>.<ext> (or fulfillment-orders-detail-<timestamp>.<ext> in line_items mode).
Scope (scope): all exports every FO ignoring the table's filters; filtered honours the table's active filters/sort (pass the same filter[...] / sort / filter[lifecycle] / filter[merged] query params as the list endpoint); current_page exports just the current page; selected exports the ids passed in ids.
Content (content_mode): summary = one row per fulfillment order; line_items = one row per FO line with the fulfillment-order columns repeated (item SKU / name / qty / remaining appended).
Columns (columns): comma-separated visible list view column keys — only those columns are exported, in the given order. Omit to export all columns.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request
Responses
- 200
- 401
- 403
- 429
Successful response
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.