Sync Shipments
POST/api/shiphero/integration-instances/:integration_instance/shipments/sync
Queue a tracked job that syncs shipments from ShipHero's GraphQL shipments query (cursor-paginated). Job name: Sync Shiphero Shipments: {instance}.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Request body (all optional):
mode(string) — sync mode. One of:since_latest,date_range,all.since_latest— passdate_fromset to the latest synced shipment's created date (bounded window through now).date_range— pass an explicitdate_from/date_towindow.all— FULL re-sync: leaves the window unbounded so ShipHero returns the entire shipment history.date_from/date_toare ignored.
date_from(ISO 8601 datetime) — lower bound. Ignored whenmode=all.date_to(ISO 8601 datetime) — upper bound. Ignored whenmode=all.
When mode is omitted, a missing date window defaults to the last 30 days.
Returns 409 if a shipments sync is already in progress for this integration.
Authentication: Requires 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.