Main operations
The Logistics API is built around a small number of operations. This page is the map; each one has its own page with the request, the response and the failure modes.
A typical integration calls them in this order:
| # | Operation | What it does |
|---|---|---|
| 1 | Available shipping types | Find out which delivery modalities you can use at a pickup location. |
| 2 | Estimate | Get the price and the ETAs of a shipment before committing to it. |
| 3 | Create a parcel | Register the package, its locations and its contacts. |
| 4 | Request shipment of parcels | Ask us to actually collect and deliver them. |
| 5 | Track parcels | Follow the parcel through its states until it is delivered. |
| 6 | Get a parcel's label | Download the label to stick on the package. |
Steps 1 and 2 are optional but recommended: they are the only way to know what a delivery will cost and whether it can be served at all before you create anything.
Creating is not shippingCreating a parcel only registers it. Nothing is collected until you request its shipment. This split is deliberate: it lets you prepare parcels in advance and ship them when you are ready.
Alongside these, you will probably want Notifications so you are told about state changes instead of polling, and Proofs if you need evidence of delivery.
All of them need an access token — see Getting started — and all of them behave identically in Sandbox and in production.
Updated 2 days ago
