Skip to main content

Get Faire Inventory Summary

GET 
/api/faire/inventory/summary
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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

Authorization

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

Aggregate inventory comparison metrics for a Faire integration instance (total tracked items, count in-sync with Faire, count needing an update, count never fetched).

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.

Zeroed response when no instance resolves:

{
  "data": {
    "total_items": 0,
    "in_sync": 0,
    "needs_update": 0,
    "never_fetched": 0
  }
}

Request​

Responses​

OK

Response Headers
    Content-Type