Pre-Start-Date Orders — Import
POST/api/magento2/integration-instances/:magento2IntegrationInstance/orders/import-pre-start-date
Dispatches the tracked job that back-fills Magento 2 orders pre-dating the integration's normal sync start date. Returns tracked_job_log_id so the frontend can pivot the global JobProgressTray to it. Job name prefix is Import Pre-Start-Date Magento 2 Orders: .
Two modes — supply exactly one:
- Date-range mode (Browse-by-date tab) — walks every Magento order in [
created_at>=date_from,created_at<date_to].date_from(required, date) — inclusive lower bound.date_to(required, date, >= date_from) — inclusive upper bound.
- Entity-ids mode (Search-specific-order tab) — imports only the explicit entity ids the user picked from the live Magento search.
magento_entity_ids[](required, array of positive integers) — Magento order entity ids to import. Each is fetched live viasyncManager->syncOrder()and upserted intomagento2_orders.
When magento_entity_ids is present, date_from / date_to are not required and are ignored if supplied.
Also accessible via the alias route POST /api/magento2/integration-instances/{instance}/pre-start-date-orders/import.
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.