Sync Info

GET 
/api/shipstation/integration-instances/:integration_instance/orders/sync-info

Header data for the orders refresh modal: the most recently dated order (number + ISO-8601 order date), the total cached order count, and the effective order start date the "Fetch from Start Date" sync option will use.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

order_start_date_source explains where the start date came from, falling back in order:

1. ShipStation Order Start Date — set on the integration instance
2. Inventory Start Date — the general inventory settings start date
3. Default sync window (last 30 days) — a fixed 30-day window used when neither start date is configured

Authentication: Requires Bearer token.

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.

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.