Push Inventory to Faire
POST/api/faire/instances/:integrationInstance/inventory/push
Push SKU.io inventory quantities to Faire 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 push runs asynchronously
- Only listings with a variance between the SKU.io and Faire quantities are pushed; rows flagged as needing recalculation are excluded until they are recached
- Quantities are clamped at a minimum of 0 before being sent to Faire
- Each successfully pushed listing is marked synced with a fresh synced-at timestamp
- Outbound inventory sync must be enabled on the instance — when it is disabled, the job pushes nothing
- Progress can be monitored via the returned
tracked_job_log_id
Not available for FBF instances — returns 422, since Faire manages inventory in FBF (Fulfilled by Faire) mode.
Response: Returns immediately with a tracked job log ID:
data.tracked_job_log_id- ID for monitoring the background pushmessage- Confirmation that the push 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.
Unprocessable Entity
Response Headers
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.