Skip to main content

Find Smart-Match Candidates

POST 
/api/faire/instances/:integrationInstance/products/:option/smart-match

Suggests SKU.io products to map a Faire variant to. Used by the per-row mapping modal to power the Smart Match section.

Algorithm:

  1. Exact match — looks up a SKU.io product whose sku exactly matches the Faire variant SKU.
  2. Similar matches — fuzzy text search using the parent Faire product name (preferred) or the variant name/SKU as the search term. Returns up to ~10 candidate products by name/SKU similarity.

Path Parameters:

  • integrationInstance — Faire integration instance ID. Returns 404 if the variant doesn't belong to this instance.
  • option — Faire product option (variant) ID.

Response shape:

{
    "data": {
        "exact_match": { id, sku, name, barcode, type, match_type: "sku", price } | null,
        "similar_matches": [ { id, sku, name, barcode, type, match_type: "fuzzy", price } ]
    }
}

price is the SKU.io product's selling price (nullable). Surfaced in the mapping modal so users can compare against the Faire wholesale price.

Note: Faire variants do not carry a barcode column, so barcode_match is intentionally absent (see FaireProductRepository::findSmartMatches).

Errors:

  • 404 — The variant does not belong to the given integration instance.

Request​

Responses​

Successful response