Developers
An API built around the shipment
Platforms connect their stores to Corridant through its partner API today. A public API for merchants and their developers is planned.
The partner API today
A platform installs Corridant for its stores, then books, cancels and finds shipments by its own order reference, over HTTPS with JSON.
- Installations and store configuration
- Shipments booked and found by your own reference
- Cancellation where the carrier allows it
- Locations to collect from
Events
Every change to a shipment becomes an event in an ordered feed. The platform leases events, applies them and acknowledges each one. Acknowledged events can be replayed for 14 days.
Carrier pushes
Carriers that push updates reach Corridant's own hooks address. A push is only a hint: Corridant reads the shipment again from the carrier before it records any change.
The state model
Every shipment follows the same states, whichever carrier it travels with.
The usual way
- BookedThe carrier accepted the booking, and the label can be printed.
- In transitThe carrier has the parcel.
- Out for deliveryThe parcel is with the courier on its way to the recipient.
- DeliveredThe parcel was delivered. A final state.
Or it ends
- ReturnedThe parcel went back to the sender. A final state.
- FailedThe booking or the delivery did not succeed. A final state.
- CancelledCancelled before the carrier collected it, where the carrier allows. A final state.
Request early access
A public API and webhooks for merchants are planned. Leave your details, and we will contact you when early access opens.
Request early access