Skip to main content

List Faire Inventory

GET 
/api/faire/inventory

Legacy — prefer the per-instance route GET /api/faire/instances/{integrationInstance}/inventory.

List Faire product variant inventory levels (product options) 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.

List Faire product variant inventory levels (product options) for a specific integration instance.

This endpoint returns inventory data at the variant/SKU level (FaireProductOption records).

Query Parameters:

  • instance_id (optional) - Filter 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 Variant:

  • id - Internal product option ID
  • faire_product_id - Faire product ID
  • faire_variant_id - Faire variant ID
  • sku - SKU code
  • name - Variant name
  • inventory_quantity - Current inventory quantity in the linked warehouse
  • faire_inventory_quantity - Last-pushed inventory quantity on Faire
  • wholesale_price - Wholesale price in cents
  • product_name - Parent product name (when loaded)

Request​

Responses​

Successful response