Download Import Template (XLSX)

GET 
/api/v2/products/import/template

Downloads the multi-sheet XLSX import template, prefilled with sample rows and tenant reference data (brands, categories).

Required scope: products:read

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

Route: v2.products.import.template

update: the data sheet now includes nine new purple-headed image URL columns:

• image_url_1 — Primary Image URL
• image_url_2 .. image_url_9 — Additional gallery image URLs

The guide sheet documents these columns. Sample rows include picsum.photos placeholder URLs for image_url_1, image_url_2, and image_url_3.

Response: binary XLSX file (Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet).

Stock UoM (added 2026-05-30): stock_uom_code is now a supported field. Provide a value matching an existing UoM code (e.g. EACH, KG, BOX). On create, it sets the product's initial stock UoM; on update, it flips the stock UoM to the matching uom_id.

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.