Refresh Inventory Snapshot

POST 
/api/faire/inventory/refresh

Refresh the local inventory snapshot by pulling current inventory levels from the Faire API.

Authorization

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

Request Body:

• instance_id (required) - The ID of the integration instance to refresh inventory for

Behavior:

• Dispatches a background job immediately
• The job pulls inventory levels from Faire and updates the local faire_inventory_quantity field on each product option
• Use this to reconcile local data against Faire when discrepancies are suspected
• Progress can be tracked via the returned tracked_job_log_id

Response: Returns immediately with a tracked job log ID.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

422

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.

429

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.