Export Product Substitutions
GET/api/product-substitutions/export
Export substitution rules as XLSX (default) or CSV. Columns: product_sku, substitute_sku, mode, allow_backorder_swap, include_in_alias_availability, priority, notes, active — the same columns the import accepts, so an export can be edited and re-imported.
Scopes: all (default) exports every rule; filtered honours the same filter query parameters as List Product Substitutions; selected exports only the rules named in ids.
Authentication: Requires Bearer token.
Response is a file download.
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.