API Documentation
The platform offers two integration paths — pick the one that fits your scenario. Each has its own dedicated documentation.
Full API
Broad access (orders, couriers, financials) with a token granted by one specific delivery company that hired you. Use it when building a system dedicated to a single customer — e.g., an ERP or internal dashboard integrated with their operation.
- Model M — reproduces that platform's contract and usually only requires swapping the base URL and the credential
Which one should you choose?
| Ask yourself… | Full API | OpenDelivery |
|---|---|---|
| Who gave you the token? | The delivery company itself (our customer). | Each merchant generates its own client_id/secret in its panel and sends it to you. |
| How many of the platform's customers do you serve? | Usually one (the company that hired you). | Several at the same time — any merchant can enable you. |
| Integration standard? | Entregas Expressas proprietary REST API. | The open Open Delivery spec (ABRASEL). |
| Data scope? | Orders, customers, couriers, financials, settings. | Orders and the delivery lifecycle only (create, simulate, cancel, status). |
| Can I become an official partner? | No — it is a two-way relationship with the delivery company. | Yes — request a review of your app to be listed among the integrations in our panel. |
Sandbox environment
Both integration types come with an isolated test environment, provisioned automatically when you create an app in the portal:
- Full → you get a new hub (sandbox) with an admin test token and an "Access the app's sandbox platform" button, so you can test everything on a copy of the real operation.
- OpenDelivery → you get a test
client_id+client_secretand a dashboard to simulate the order lifecycle (accept, assign a courier, pick up, deliver).
Every request shows up in the app's Inspection tab, with headers, body, status and latency — so you can debug without instrumenting your own server.