Sync Shipments
POST/api/shipstation/integration-instances/:integrationInstance/shipments/sync
Queue a tracked background sync that pages ShipStation's GET /shipments endpoint into the shipstation_shipments table (and applies tracking to linked orders/fulfillments, including a second pass over GET /fulfillments for externally fulfilled orders).
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Body fields (all optional):
- mode: 'all' (full history), 'date_range' (bounded by date_from/date_to), 'since_latest' (bounded by date_from). Default: falls back to date_from, else the configured order start date.
- date_from / since_date: ISO datetime lower bound
- date_to: ISO datetime upper bound
Track progress via the tracked job log endpoints (job name: 'Sync ShipStation Shipments: {instance name}').
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.