Skip to main content
POST
shipping.tracking.lookup

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
trackingNumber
string

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

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

Record ID in your connected shipping account.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9._-]+$
orderNumber
string

Your store order number.

Required string length: 1 - 50
channelId
string

Record ID in your connected shipping account.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9._-]+$

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