Refresh Products

POST 
/api/magento2/integration-instances/:magento2IntegrationInstance/products/refresh

Dispatch the tracked job that refreshes Magento 2 products. Returns the tracked_job_log_id so the frontend can pivot the global JobProgressTray to it. Job name prefix is Refresh Magento 2 Products: — the page's lastCompletedJob watcher matches on this prefix.

Body params (all optional):

• mode — one of since_latest (default), full_catalog, from_start_date, date_range. Drives the cursor the job resolves.
• updated_at — ISO datetime string used when mode=since_latest to override the auto-detected high-water mark.
• date_from / date_to — ISO datetime strings used when mode=from_start_date (uses date_from only) or mode=date_range (uses both).

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

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.

429

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.