Bulk Operation (Tracked)
POST/api/faire/instances/:integrationInstance/products/bulk-tracked
Dispatches a background job background job that performs the bulk action across the resolved selection. Returns immediately with a tracked job log ID — progress is visible via the tracked job log endpoints and pollable via the bulk-progress endpoint.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Use this variant for All Filtered requests where the count may be large enough to exceed an HTTP timeout. For Selected Only with small counts, the synchronous variant is faster.
Path Parameters:
integrationInstance(required) - The ID of the Faire integration instance.
Body: Same shape as the synchronous bulk endpoint. See its description for full field-by-field documentation. The selection is resolved server-side BEFORE the job is dispatched, so the response includes the tracked-job ID only when at least one record matched.
Response (200):
data.tracked_job_log_id- The ID of the dispatched tracked job. Pass tobulk-progress/:trackedJobLogId(or the global/api/tracked-job-logs/:id) to poll progress.message- Human-readable status string.
Errors:
422when no records resolve from the selection.422when validation fails on the body shape.
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.