Bulk Download Sales Invoice PDFs
POST/api/sales-invoices/bulk/pdf
Download the PDFs of several invoices at once: send ids[] (up to 5,000), or all: true with filters (the list query, e.g. {"filter": {"status": "draft"}}) to act on every matching invoice.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Up to 50 invoices: the response is one zip file (application/zip) of their PDFs. More than 50: the zip is built in the background and the response is {"data": {"tracked_job_log_id": …, "queued": true}}; poll the tracked job, then download the finished zip with Download Sales Invoice Export (its file is the zip's file name).
Requires orders:write and sales_invoices.print.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.