Overview
The FleetZip API is REST, token-authenticated and documented in OpenAPI 3.1. Everything the platform does through the interface is also possible through the API.
- Orders — create, update and query orders to be routed.
- Routes — trigger optimization, query sequences and follow progress.
- Events — receive webhooks for dispatch, stop, incident, delivery and return.
Imagem a inserir
Integration diagram: on the left the customer's systems (ERP, TMS, e-commerce); in the center FleetZip (REST API + webhook queue); on the right the driver app and the control tower.
Webhooks per event
Configure endpoints to receive real-time notifications. Every event carries the full payload and is automatically redelivered on failure:
| Event | When it fires |
|---|---|
route.dispatched | Route dispatched to the driver app |
stop.arrived | Driver arrived at the stop |
delivery.completed | Delivery completed with proof |
occurrence.created | Incident logged (refusal, absent…) |
return.created | Return collected |
Official SDKs
Libraries to speed up integration, with authentication, retries and webhook validation built in:
- Node, Python and Java — typed wrappers over the REST API.
Imagem a inserir
Code snippet showing an order being created via the Node SDK and a delivery-completed webhook being received.
For a step-by-step guide, see the documentation.