Skip to main content

Get Shiptheory Shipment Raw JSON

GET 

/api/shiptheory/:integration_instance/shipments/:shipment/raw

Fetches the live provider payload for the shipment on demand, resolved through its parent order's reference (Shiptheory has no shipment-level endpoint), and returns it wrapped as { data: { product: {...} }, fetched_at }.

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.

Returns 404 on a shipment / instance mismatch, 429 when Shiptheory rate-limits, or 422 when the provider call fails.

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type