Get Shipment
GET/api/shippit/instances/:integration_instance/shipments/:shipment
Retrieve a single shipment scoped to the instance. Returns 404 if the shipment does not exist or belongs to another instance. Pass include_json=1 to include the stored provider tracking payload.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authenticate with 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.