Lynq Partner API overview
The Lynq Partner API lets e-commerce platforms, OMS/WMS systems, and marketplaces integrate last-mile delivery across Saudi Arabia. You can:
- Request quotes before checkout or dispatch
- Submit orders (single pickup or multi-leg)
- Receive signed webhooks for lifecycle updates
- Subscribe to live courier tracking batches
Who this is for
This portal is for engineering teams building server-to-server integrations. Business onboarding (commercial registration, contracts, banking) still flows through the Lynq partner dashboard after your integration is approved.
Integration flow
- Request sandbox access — receive UAT
X-API-KeyandX-Client-ID. - Explore the API reference against
https://uat-api.lynq-sa.com/partner. - Implement quotes → orders → webhooks using the guides in this documentation.
- Pass go-live review before production credentials are issued.
Core concepts
| Concept | Description |
|---|---|
| Quote | Time-bound price for a route; bind quote_id on order create to lock fees. |
| Order | Accepted asynchronously (202); identified by Lynq ULID and your partner_order_number. |
| Webhook | HTTPS callback with HMAC-signed JSON envelope (X-Lynq-Signature). |
| Event ID | Stable id on each webhook — retries reuse the same ID (design for idempotency). |
Next steps
- Environments — UAT vs production base URLs
- Authentication — required headers and IP allowlists
- Quickstart — first quote and order in minutes