Export Low Stock Items

GET 
/api/low-stock-items/export

Exports low-stock items as a downloadable CSV or XLSX file.

Required scope: inventory:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Filename pattern: low-stock-items-{Y-m-d_His}.{ext}

Supports the same filters as GET /api/low-stock-items (search, severity, brand_id, warehouse_id, archived_status). The columns query parameter accepts a comma-separated list of columns to include in the export — defaults to all available columns.

Response Content-Type:

• CSV → text/csv
• XLSX → application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Authentication: Requires Bearer token.

Request

Responses

200

OK

Response Headers

Content-Type
Content-Disposition

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.