Download Import Template
GET/api/sales-orders/import/template
Downloads an XLSX import template with headers, sample data, a field guide, and reference data from the tenant's account.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The template's Import Here sheet and Field Guide sheet both include the hold_until_date column — the earliest date an order is allowed to ship (held until this date, e.g. for preorders). Format: YYYY-MM-DD.
Response: a binary XLSX file download — not JSON.
Authentication: Requires Bearer token. Scope: orders (read/write).
Requires permission: sales_orders.import
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.