Skip to main content
POST
shipping.shipment.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
sender
object
required

Sender address and contact details.

recipient
object
required

Recipient address and contact details.

parcel
object
required

One parcel.

returnAddress
object

Return address; omitted means sender.

shipDate
string<date-time>

ISO 8601 date and time with a timezone.

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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
currency
string
default:USD

Quote currency; first version supports USD.

Allowed value: "USD"
customs
object

Inline international customs facts, including certifier personal data.

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

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