Refresh Inventory from Faire
POST/api/faire/instances/:integrationInstance/inventory/fetch
Pull current inventory quantities from Faire into the local snapshot for a Faire integration instance.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Path Parameters:
integrationInstance- The ID of the integration instance
Behavior:
- Dispatches a background job immediately and returns — the refresh runs asynchronously
- The job walks Faire's paginated products feed and reads each variant's available quantity, updating the cached Faire quantity and its fetched-at timestamp per listing
- Works for both FBM and FBF instances
- Progress can be monitored via the returned
tracked_job_log_id
Response: Returns immediately with a tracked job log ID:
data.tracked_job_log_id- ID for monitoring the background refreshmessage- Confirmation that the refresh started
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.