Sync Orders
POST/api/shippit/instances/:integration_instance/orders/sync
Queue a background job that reconciles the current state of existing Shippit orders for this instance (Shippit has no bulk order list, so the sweep refreshes each non-terminal order individually via its tracking number). The response returns the tracked job log id, which you can poll for progress.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
All body fields are optional — send an empty body {} to sweep every non-terminal order.
- since — only refresh orders last updated before this date/time (ISO 8601 or Y-m-d). Targets stale rows.
- date_from — only include orders created on or after this date (Y-m-d).
- date_to — only include orders created on or before this date (Y-m-d); must be on or after date_from.
- tracking_number — refresh only the single order carrying this tracking number (max 255 chars).
Authentication: requires a 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.