Skip to main content

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.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

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​

OK

Response Headers
    Content-Type