Download Import Template

GET 
/api/supplier-inventories/:id/import/template

Downloads an XLSX import template for a specific supplier, pre-populated with headers, sample data, field guide, and reference data (products, warehouses) for the tenant's account.

Required scope: suppliers:read

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

Authentication: Requires Bearer token.

Path params:

• supplier: Supplier ID

Response: XLSX file download

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

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.