Download Lines Import Template

GET 
/api/warehouses/transfers/import-lines/template

Downloads a multi-sheet XLSX template for the warehouse transfer lines bulk import.

Required scope: warehouses:read

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

Response: A binary .xlsx file (zip-based Office Open XML).

• Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
• Content-Disposition: attachment; filename="warehouse-transfer-lines-import-template-YYYY-MM-DD.xlsx"

Sheets:

1. Import Here — the row-data sheet with two required columns (sku, quantity) plus 3 example rows. Header row is frozen; columns are autofiltered; the SKU column has a comment explaining required fields.
2. Field Guide — reference sheet describing each column (Required, Description, Valid Values, Example).

No query parameters or request body. Used by the "Import Lines from CSV" workflow on the warehouse transfer detail page (the resulting filled-out file is then POSTed to /api/warehouses/transfers/import-lines).

Requires permission: warehouse_transfers.import

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.