Get Order Sync Info
GET/api/starshipit/integration-instances/:integration_instance/orders/sync-info
Header data for the orders refresh modal: the most recently dated order (latest_order_number + latest_order_date, keyed on order_date), the total order count, and the effective order start date the "Fetch from Start Date" mode will use.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
order_start_date (YYYY-MM-DD) is always returned and resolves through a fallback chain, with order_start_date_source naming where it came from:
StarShipIt Order Start Date— the instance's configured Order Start Date (StarShipIt settings)Inventory Start Date— the general inventory start date, when no StarShipIt start date is setDefault sync window (last N days)— anow − sync_days_backwindow, when neither start date is configured
The frontend uses this to seed the "since latest" and "from start date" sync modes (always showing the resolved date and its source) and to show how many orders are currently stored.
Authentication: Requires Bearer token.
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.