Download Substitution Import Template
GET/api/product-substitutions/import/template
Download the Excel (XLSX) import template. The workbook has three sheets: 'Import Here' (headers + sample rows; green headers are required), 'Field Guide' (per-column description, valid values, and an example), and 'Reference Data' (the valid mode values, accepted yes/no tokens, and your existing rules).
Rows match on the (product_sku, substitute_sku) pair — an unknown pair creates a rule, an existing pair updates it, so re-importing a corrected file is safe.
Authentication: Requires Bearer token.
Response is an .xlsx file download (Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
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.