Getting started
Learn the platform, its roles and how to track a parcel.
7 articlesDocumentation
Guides, tutorials, API references and troubleshooting for merchants, delivery companies, couriers and developers.
Merchants
Registration, shipments, wallet and store connections.
19 articlesDelivery companies
Hubs, couriers, dispatch, pricing and settlements.
27 articlesCouriers
How couriers work with the platform.
3 articlesWarehouses
The optional warehouse service.
4 articlesIntegrations
Connecting online stores to the platform.
5 articlesDevelopers
APIs and webhooks.
13 articlesTroubleshooting
Real errors and stuck situations, and how to resolve them.
13 articlesAPI reference
OpenAPI 3.1 reference of the merchant and delivery company APIs: endpoints, schemas, errors, webhooks and code samples.
Popular articles
- Delivery areas on the map and the coverage checkHow to draw delivery areas and attach couriers for assignment suggestions and auto distribution, what happens when no area matches, and how the coverage check limits accepted countries and governorates.
- Create your first shipment in the merchant panelHow to create a parcel in the merchant panel: pickup location, delivery company and recipient details, the fee preview and required balance, and the validation and coverage messages.
- Merchant API v1 referenceEvery merchant API v1 endpoint under /api/v1: method, path, parameters with validation rules and response shape, with curl, JavaScript, PHP and Python samples for creating, listing and tracking parcels.
- API overview: the merchant and company APIsThe platform's two public APIs: the merchant API at /api/v1 (sk_ key) and the company API at /api/company/v1 (ck_ key), who can use them, how versions work and the JSON envelope every response uses.
- Branches (hubs), in-charge accounts, staff users and rolesHow a delivery company adds a branch (hub), appoints an in-charge, creates roles, adds staff users and sets their permissions, including what happens to permissions when a hub is chosen.
- Notifications: the bell, e-mail and mobile devicesWhat the notification bell shows and how read state works, which events send e-mail, and how mobile devices are registered to receive push messages.