Skip to main content

Refresh Orders

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

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

Body params:

  • mode (required) — one of since_latest, from_start_date, date_range, all.
    • since_latest resumes from the cursor stored on the local orders table (falls back to since_at then to the integration's configured start_date).
    • from_start_date walks from the integration's configured start date (Settings → Orders → Start date).
    • date_range walks a bounded [date_from, date_to] window.
    • all — Full Re-sync. Walks every order Magento returns, ignoring start_date entirely. Mirrors the option BigCommerce / eBay / WooCommerce already expose.
  • since_at (optional, ISO datetime) — fallback cursor used by since_latest when our local orders table is empty.
  • date_from / date_to (required when mode=date_range, ISO date) — inclusive bounds of the date window.

Request​

Responses​

OK

Response Headers
    Content-Type