Get Latest Order Sync Info
GET/api/storefront/instances/:id/orders/latest-sync-info
Everything about the state of order importing for this connection: the newest order held, how many orders are waiting on a SKU sales order, how the last import run ended, and when the next automatic run is due.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
pending_sku_orders— active, importable orders with no SKU sales order yet.failed_sku_orders— orders whose last creation attempt recorded an error.held_sku_orders— importable orders an automatic run is holding because a line's SKU has no mapped product. Always 0 while the connection's "require mapped products" setting is off.mapped_line_items/unmapped_line_items— order LINES that did and did not resolve to a product.cursor_at— the store-side watermark the next incremental run reads from.last_sync_completed_at,last_sync_failed_at,last_sync_error— how the previous run ended.order_import_start_date— the earliest order date this connection will ever import.auto_sync— derived from the schedule itself, never a fixed label:is_enabled(automatic sync on, schedule not paused, inbound order import enabled),cadencein words,interval_seconds, andseconds_until_next(null when disabled).
Authentication: Bearer token (session or PAT).
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.