Download Import Template

GET 
/api/sales-credits/import/template

Download a multi-sheet XLSX import template pre-filled with sample rows, a field guide, and reference data (stores, currencies, warehouses, tax rates, nominal codes) from your account.

Required scope: orders:read

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

Authentication: Requires Bearer token (scope.rw:orders).

Response: a binary XLSX file download, NOT JSON. Fill the 'Import Here' sheet, then upload it in the import wizard.

Request

Responses

200

Successful response

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.