Push Inventory to Faire
POST/api/faire/inventory/push
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
Push current inventory levels from the linked warehouse to Faire.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request Body:
instance_id(required) - The ID of the integration instance to push inventory for
Behavior:
- Dispatches a background job immediately
- The job reads inventory quantities from the linked warehouse and updates each Faire product variant via the Faire API
- Useful for an immediate manual push when automatic sync is not running
- 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
- 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.
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.