Validate Substitution Import Rows
POST/api/product-substitutions/import/validate
Validate mapped import rows and return a per-row annotated preview — no side effects, safe to call repeatedly.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Each row is marked create (new pair), update (pair exists — fields will be updated), or error (with a reason). The mode column accepts friendly synonyms case-insensitively: "manual", "manual only", "out of stock", "if out of stock", "always".
The optional substitution_type column accepts "direct", "direct equivalent", "equivalent", "identical", "replacement", "functional replacement", "functional", "alternative" (case-insensitive); an unrecognised value fails the row. Left blank it defaults a NEW rule to direct and leaves an existing rule's classification untouched, so re-uploading a file that predates the column never silently reclassifies a replacement as a direct equivalent.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
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.