Skip to main content
POST
shipping.tracking.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-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by shipping.tracking.create.

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

Response

The result

trackingNumber
string
required

Carrier tracking number, 4 to 100 letters, digits or . _ / -.

Required string length: 4 - 100
Pattern: ^[A-Za-z0-9._/-]+$
carrier
string
required

Delivery carrier.

Required string length: 1 - 100
status
enum<string>
required

Normalised carrier status.

Available options:
unknown,
pending,
in_transit,
out_for_delivery,
delivered,
available_for_pickup,
returned,
failed,
expired
checkpoints
object[]
required

Most recent 100 checkpoints. No signer, recipient or notification details.

Maximum array length: 100
estimatedDelivery
string

Carrier estimated delivery date; local times remain local.

Maximum string length: 40