Skip to main content

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.

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).

Request​

Responses​

Successful response