Smart Match
POST/api/shopify/:integrationInstance/products/:product/smart-match
Find SKU products that match a Shopify product, by SKU, barcode and name.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Returns exact_match (same SKU), barcode_match (same barcode) and up to 5 similar_matches. Similar matches are ranked: a product whose name equals the Shopify product title comes first, then products containing the full title, then products sharing the most title words. Shopify's placeholder variant title "Default Title" is ignored when matching.
Authentication: Requires Bearer token.
Returns 403 when the product belongs to a different integration instance than the one in the URL.
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
Response Headers
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.