Get Shiptheory Shipment
GET/api/shiptheory/:integration_instance/shipments/:shipment
Returns the full details for a single Shiptheory shipment scoped to the integration instance. Includes carrier, service, tracking, carrier cost, parcel count, booked_at, the parent order context and portal deep link, and the cross-link to the sales order fulfillment. When include_json=1 is supplied, the stored provider payload is included as json_object.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Path parameter:
- integration_instance: the numeric id of the Shiptheory integration instance.
- shipment: the internal Shiptheory shipment id.
A shipment / instance mismatch returns 404.
Authentication: requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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
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.