Get Product Match Suggestions
POST/api/storefront/instances/:id/products/:id2/smart-match
Suggest a SKU.io product for an unmapped store product. Send an empty JSON object as the body.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The store's SKU is the product's identity, so an exact SKU hit is the only confident answer and comes back as exact_match (match_type: "sku"). Everything else is offered as similar_matches (up to 10, match_type: "fuzzy") for a person to confirm — matched on the product name when the store product has one, otherwise on the SKU, and never including the exact-SKU product itself.
barcode_match is always null on this channel: the store does not send barcodes.
This endpoint only suggests. Nothing is mapped until you call POST /{product}/map.
Authentication: Bearer token (session or PAT).
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.