Skip to main content
POST
shipping.shipment.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
ref
string
required

The ref returned by shipping.shipment.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
includeAddresses
boolean
default:false

Return sender and recipient names, postal addresses and contacts only when requested.

Response

The result

state
enum<string>
required

Shipment processing state; creating does not buy postage.

Available options:
created,
ready,
failed,
purchased
rates
object[]
required

Up to 50 quotes, with owned handles where supported.

Maximum array length: 50
parcel
object
sender
object
recipient
object
trackingNumber
string

Carrier tracking number, if already bought.

Required string length: 1 - 100