Sync Products
POST/api/faire/instances/:integrationInstance/sync-products
Trigger a product catalog sync from Faire for a specific 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
- The job pulls the full product catalog from the Faire API, including product options (variants) and current inventory levels
- Multi-tenant safety: Products and variants are upserted on the composite
(integration_instance_id, faire_product_id)/(faire_product_id, faire_variant_id)keys, so two sibling instances on the same brand cannot stomp each other's rows. - Progress can be tracked via the returned
tracked_job_log_id
Response: Returns immediately with a tracked job log ID.
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.