Allow MENA Delivery
Delivery API documentation
Create and track deliveries from your own storefront, warehouse or order-management system, and run the operations behind them — drivers, suppliers, cash reconciliation and reporting.
Start here
Quick start
Send your first order in four steps, from API key to webhook callback.
Authentication
Three credential types: partner x-api-key, service API key, and driver bearer tokens.
Base URL & versions
Which host to call, and how v1, v2 and v3 differ.
Errors
The two error envelopes in use, and what each status code means.
API surfaces
Partner Orders
The public integration API. Create, cancel and track deliveries with your x-api-key.
Webhooks
Callbacks the platform sends you when a driver is assigned and as the order progresses.
Operations
Internal portal endpoints: suppliers, issued items, cash collection, reports and reference data.
Driver App
Session-backed login, device switching and token refresh for the driver mobile app.
What this API is
Allow MENA Delivery is a last-mile delivery platform. This documentation covers every HTTP endpoint the platform exposes, grouped by who calls it:
| Surface | Who calls it | Credential | Base path |
|---|---|---|---|
| Partner Orders | Merchants and their order-management systems | x-api-key | /api/v{1,2,3}/external |
| Webhooks | The platform calls you | Configured per branch | Your URL |
| Service API | Other Allow MENA services | X-API-Key | /api/v1/internal |
| Operations | The Allow MENA operations portal | Bearer JWT | /api/v1/web-app |
| Driver App | The driver mobile app | Bearer JWT | /api/v1/driver |
If you are integrating a shop, a warehouse or an ERP with Allow MENA, Partner Orders and Webhooks are the only two surfaces you need. The rest are internal and documented here for the teams that build against them.
Who it is for
- Integration partners — send orders to Allow MENA and receive status callbacks.
- Platform engineers — build and maintain the operations portal and the driver app.
- Support and operations — look up what a given endpoint does and what its errors mean.
How the documentation is organised
- Getting Started — base URLs, credentials, the shared request and response shapes, and a working first request.
- API Reference — one page per endpoint, with parameters, request and response examples, and the errors that endpoint can actually return.
- Concepts — behaviour that spans many endpoints: pagination, filtering, date handling, permissions, and the enumerations used throughout.
- Coverage audit — every endpoint in the backend and in the Postman collection, with its documentation status and any discrepancy found between the two.
Every page here was written against the backend implementation — routers, serializers, Pydantic schemas and tests — not from a collection export. Where the published Postman collection and the backend disagree, this documentation follows the backend and records the difference on the coverage audit page.