Integrator readiness
Use this page as a single map of what external engineering teams expect from a logistics API. Each item links to the canonical doc or behaviour.
| Topic | Where |
|---|---|
| Same API host; sandbox vs live keys | API Reference (callout), Authentication |
Idempotency-Key + (source, external_order_id) | Orders & Deliveries |
Required scheduling fields on POST /v1/orders | Orders, Quick Start |
Optional lat/lng, COD (cod_amount_minor) | Orders |
Rate limits & 429 | Errors & Rate Limits |
customer_tracking_url on order responses | Orders, Reference |
Webhook HMAC (X-Ideliver-Signature), X-Ideliver-Delivery, retries (12s timeout, backoff, max attempts) | Webhooks |
Outbound rider summary on deliveries | Webhooks |
Merchant cancel POST /v1/orders/:id/cancel | Orders, Order lifecycle |
Coverage preflight (GET /v1/public/pricing/rate-card-preview) & zone GeoJSON (GET /v1/me/dispatch/zones + JWT) | Dispatch & Zones |
Simulator (POST /v1/test/simulator/...) | Testing & Sandbox, Simulator |
Environment variables (platform operators)
Integrators do not set these — but behaviour depends on them:
TRACKING_PUBLIC_BASE_URL— togglescustomer_tracking_urlon REST order payloads.OUTBOUND_WEBHOOK_MAX_ATTEMPTS,OUTBOUND_WEBHOOKS_ENABLED,OUTBOUND_WEBHOOK_SIGNATURE_V2.ADMIN_ORDER_CANCEL_PRE_PICKUP_ONLY— tightens merchant + admin cancel.
Next steps
- Errors & Rate Limits — Machine-readable
errorcodes - API Playground — Live
POST /v1/orders