Skip to main content

Sync Products

POST 
/api/faire/instances/:integrationInstance/sync-products

Trigger a product catalog sync from Faire for a specific integration instance.

Path Parameters:

  • integrationInstance - The ID of the integration instance

Behavior:

  • Dispatches a background job (SyncFaireProductsJob) immediately
  • The job pulls the full product catalog from the Faire API, including product options (variants) and current inventory levels
  • Multi-tenant safety (SKU-8024): Products and variants are upserted on the composite (integration_instance_id, faire_product_id) / (faire_product_id, faire_variant_id) keys, so two sibling instances on the same brand cannot stomp each other's rows.
  • Progress can be tracked via the returned tracked_job_log_id

Response: Returns immediately with a tracked job log ID.

Request​

Responses​

Successful response