Skip to main content

Refresh Inventory Snapshot

POST 
/api/faire/inventory/refresh

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

Request Body:

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

Behavior:

  • Dispatches a background job (RefreshFaireInventorySnapshotJob) 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​

Successful response