Skip to main content

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.

Required scope: integrations:read

Grant 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​

OK

Response Headers
    Content-Type