Skip to main content
POST
Create a shipment

Authorizations

Authorization
string
header
required

API key as a bearer token. Secret keys (sk_) allow writes; publishable keys (pk_) are read-only. live = production, test = sandbox.

Headers

Idempotency-Key
string

A unique key (UUID) that makes a write request safely retryable.

Body

application/json
rate_quote_id
string
required
Example:

"quote_abc123"

recipient
object
required
sender
object
parcel
object
payment
object
options
object
metadata
object

Response

Idempotent replay — existing shipment returned.

shipment
object