API Overview
Use the API to list lanes and commodities, get a rate, confirm a booking, and track a package.
A booking stays a quote until SEND receives the cargo and creates the parcel. The full sequence is in Operating Process.
Base URL
Authentication
Send your API key on every request:
A test key only sees test records. A live key only sees live records. Do not send a mode header.
Endpoints
Request and response fields are in the API Reference. A worked example is in the Quickstart.
Get a rate
POST /v1/parcel_quotes takes one cargo measurement. Do not send a sender, recipient, or package dimensions.
Also send lane_code and commodity_code. Lanes are GET /v1/parcel_lanes. Commodities are GET /v1/parcel_commodities.
The response includes rate, charges, and total. Use rate.id as rate_id when you book. charges are extra fees and are not bookable rate ids.
Book
POST /v1/parcel_bookings takes quote_id, rate_id, and sender.customer_id.
Send recipient, or set customer_as_recipient: true and omit recipient to use the sender’s saved details. Do not send both.
SEND creates the parcel later, at warehouse receipt.
Errors
Path ids are tokens, not database ids.