Skip to main content

List Faire Products

GET 
/api/faire/products

List Faire products synced for a specific integration instance.

Tenant resolution (multi-instance safety): Both shapes are accepted, in priority order:

  • filter[integration_instance_ids] (preferred, Amazon-unified plural form; comma-separated CSV — first ID wins)
  • filter[instance_id] (legacy singular)
  • ?instance_id= query string fallback
  • body instance_id (POST/PUT only)

If none resolve to an existing FaireIntegrationInstance the endpoint returns an empty/zeroed payload — it does NOT silently fall back to the first tenant's data.

Empty-paginator response when no instance resolves: { data: [], total: 0, per_page, ... }.

List Faire products synced for a specific integration instance.

Query Parameters:

  • instance_id (optional) - Filter products to a specific integration instance. Defaults to the first instance.
  • page (optional) - Page number (default: 1)
  • per_page (optional) - Items per page (default: 10)

Response Fields per Product:

  • id - Internal product ID
  • integration_instance_id - Integration instance ID
  • faire_product_id - Faire's product ID (e.g. p_abc123)
  • name - Product name
  • status - Product status (ACTIVE, INACTIVE, DELETED)
  • wholesale_price_minimum - Minimum wholesale price in cents
  • currency_code - ISO 4217 currency code
  • options - Loaded when explicitly eager-loaded (variants/SKUs)
  • created_at - ISO timestamp

Request​

Responses​

Successful response