Sync Shipments
POST/api/shippit/instances/:integration_instance/shipments/sync
Queue a background (tracked) job that reconciles despatch and delivery timestamps for the instance's undelivered shipments against the provider's current tracking state. Poll the returned tracked_job_log_id for progress.
Body parameters (all optional — send an empty body to sweep every undelivered shipment):
- since (date) — only reconcile shipments observed on/after this date.
- date_from (date) — lower bound on the reconcile window.
- date_to (date) — upper bound on the reconcile window; must be on or after date_from.
- tracking_number (string, max 255) — restrict the sweep to a single consignment.
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.