Sync Orders
POST/api/shiphero/integration-instances/:integration_instance/orders/sync
Queue a tracked background job that re-syncs every open order for the integration instance and applies any new tracking. Returns the tracked job log id so the frontend can poll progress.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
If a sync is already pending/processing for this instance, responds 409 SyncInProgress.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 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.
Conflict
Response Headers
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.