Refresh Shipment
POST/api/shipbob/:instance/shipments/:shipment/refresh
Live-fetch one shipment from ShipBob and upsert the stored copy, then return the refreshed record. Use it to bring a single shipment up to date without running a full shipment sync.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
The path id accepts EITHER the local record id (as returned by the list endpoint) OR the external ShipBob id.
ShipBob nests shipments under their order, so the refresh reads the parent order and re-ingests its shipments. Tracking passback and fulfillment linking run exactly as they do during a sync.
The response omits the raw provider payload; call Get Shipment with include_json=true for that.
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
Response Headers
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.