Skip to main content
POST
shipping.tracking.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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

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

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

Delivery carrier code; omit to request detection where supported.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9_-]+$
shipDate
string<date>

Shipping date when required by the carrier.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
destinationPostalCode
string

Destination postal code when required by the carrier.

Required string length: 1 - 20

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

Reference to what this call created. Pass it as ref to shipping.tracking.get.