Sync Progress
GET/api/shipstation/integration-instances/:integration_instance/orders/sync-progress/:trackedJobLogId
Poll the progress of a queued orders sync by its tracked job log id (returned by POST /orders/sync).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The job must be a ShipStation sync (job_name starting with Sync ShipStation) belonging to this integration instance — matched either by the job name suffix (: {instance name}) or by the log's related model (ShipstationIntegrationInstance + instance id). Anything else returns 404 Job not found (also returned when the id does not exist).
status is the TrackedJobLog status enum value (e.g. pending, processing, completed, failed, cancelled).
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
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.