Skip to main content

Refresh Products from Faire (Tracked)

POST 
/api/faire/instances/:integrationInstance/products/refresh-tracked

Dispatches a background job background job that walks the Faire catalog and persists faire_products + faire_product_options. Returns immediately with a tracked job log ID — progress is visible via the tracked job log endpoints.

Authorization

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

Path Parameters:

  • integrationInstance - The ID of the integration instance

Body:

  • mode (required) - One of:
    • incremental - Resume from the persisted sync_cursors.products.cursor_at (skip products already imported since the last sync). Recommended for routine refreshes.
    • full - Reset the cursor and walk the entire catalog (slow). Use to rebuild from scratch.
    • date_range - Fetch only products whose updated_at falls between date_from and date_to (inclusive). Cursor is NOT persisted in this mode.
  • date_from (required when mode=date_range) - ISO date string (YYYY-MM-DD). Sent to Faire as updated_at_min (start-of-day UTC).
  • date_to (required when mode=date_range) - ISO date string (YYYY-MM-DD). Sent to Faire as updated_at_max (end-of-day UTC). Must be >= date_from.

Response:

  • data.tracked_job_log_id - The ID of the dispatched tracked job. Pass to /api/tracked-job-logs/:id to poll progress.
  • message - Human-readable status string.

Validation Errors (422):

  • mode must be one of incremental, full, date_range
  • date_from and date_to are required when mode=date_range
  • date_to must be on or after date_from

Request​

Responses​

OK

Response Headers
    Content-Type