Shipments Sync Info
GET/api/shipstation/integration-instances/:integrationInstance/shipments/sync-info
Header data for the shipments refresh modal: the most recently created shipment (by ShipStation createDate), the total shipment count, and the effective sync start date for this instance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
shipment_start_date is the date the "Fetch from Start Date" sync option will use, and shipment_start_date_source is a human-readable label for where it came from. The date resolves in priority order: the instance's ShipStation Order Start Date (source: "ShipStation Order Start Date"), then the general Inventory Start Date (source: "Inventory Start Date"), then a 30-day fallback window (source: "Default sync window (last 30 days)").
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.