Import Product Substitutions
POST/api/product-substitutions/import
Execute the import. Files up to 500 rows run inline and return the summary directly; larger files run as a background job (202 response with a job ID to track).
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
The import is idempotent on the (product_sku, substitute_sku) pair, so re-uploading a corrected file is safe. Set evaluate_open_orders to immediately re-evaluate open orders against the imported rules and release any that a swap resolves.
The optional substitution_type column (direct | replacement, plus the synonyms listed on Validate) is only applied when supplied — a blank value defaults a NEW rule to direct and leaves an existing rule's classification untouched.
Request
Responses
- 200
- 202
- 401
- 403
- 422
- 429
OK
Response Headers
Accepted
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.