Skip to main content

Map Single Variant to SKU.io Product

POST 
/api/faire/instances/:integrationInstance/products/:option/map

Maps a single Faire product variant (option) to an existing SKU.io product. Used by the per-row Map button on the Faire products page.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

If the variant is already mapped, the existing product_listings row is updated in place (no duplicate is created) — this powers the Remap flow as well.

Path Parameters:

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

Body:

  • product_id (required, integer, exists:products,id) - The SKU.io product ID to map this Faire variant to.

Response: Returns the updated FaireProductOptionDetail resource (same shape as GET .../products/:option), with product populated to the newly-linked SKU.io product.

Errors:

  • 404 - The variant does not belong to the given integration instance.
  • 422 - product_id is missing or does not exist in products.
  • 500 - The Faire integration instance has no associated sales_channel row (configuration issue).

Note: faire_product_id is the Faire-issued product ID (e.g. p_3bz2tdhtkq), sourced from the parent FaireProduct. It is NOT the internal faire_product_options.faire_product_id foreign key.

Request​

Responses​

OK

Response Headers
    Content-Type