Skip to main content

Bulk Operation Progress

GET 

/api/faire/instances/:integrationInstance/products/bulk-progress/:trackedJobLogId

Returns the live progress of a background job. Returns the standard tracked job log object shape — same as the tracked job log endpoints polls. Poll this endpoint while the job runs; progress_percentage and results update as the job processes batches.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Path Parameters:

  • integrationInstance (required) - The ID of the Faire integration instance.
  • trackedJobLogId (required) - The tracked job log ID returned by the bulk-tracked dispatch.

Response (200): A standard tracked job log object. Key fields for a Faire bulk job:

  • data.id - Tracked job log ID.
  • data.status - One of pending, processing, completed, failed, cancelled.
  • data.progress_percentage - 0-100 (or null until the job starts).
  • data.message - Latest status message from the job.
  • data.results - When completed, contains { action, total, processed, failed, skipped, started_at, completed_at }. Errors populate results.error.

Errors:

  • 404 when the tracked job log ID does not exist.

Request

Responses

OK

Response Headers
    Content-Type