Sync Orders
POST/api/shipbob/:instance/orders/sync
Queue a background order sync and return the tracked job id so progress can be followed.
Authentication: Requires Bearer token.
Request Body (all optional):
- mode (string) — Sync mode (e.g. 'recent', 'date_range', 'single').
- date_from (date) — Lower bound for the sync window (Y-m-d).
- date_to (date) — Upper bound for the sync window (Y-m-d).
- order_number (string) — Restrict the sync to a single order number.
- reference_ids (string) — Comma-separated reference ids to sync.
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.