Get Faire Inventory Summary
GET/api/faire/instances/:integrationInstance/inventory/summary
Get aggregate inventory sync statistics for a Faire integration instance, computed from the same cached snapshot as the inventory list.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Path Parameters:
integrationInstance- The ID of the integration instance
Response:
total_items- Total listings tracked for this instancein_sync- Listings whose SKU.io and Faire quantities matchwith_variance- Listings whose quantities differ (would be included in the next push)needs_recalculation- Listings whose SKU.io quantity is flagged as stalein_stock- Listings with a positive quantity on Faire (relevant for FBF instances)out_of_stock- Listings with zero quantity on Faire (relevant for FBF instances)last_fetch_at- Most recent time a quantity was fetched from Faire (null if never)last_sync_at- Most recent time a quantity was pushed to Faire (null if never)needs_update- Legacy alias ofwith_variancenever_fetched- Listings whose Faire quantity has never been fetched
If the instance has no sales channel yet, all counts return 0 and the timestamps return null.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.