Sync Shipments
POST/api/shiprush/instances/:integration_instance/shipments/sync
Kick off the token-gated tracking/scan refresh as a tracked background job. Requires a Shipping API token on the instance — without one the job no-ops server-side (the pull model already records tracking at shipnotify). 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.
No request body is required.
Authenticate with 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.