API Reference
Base URL: https://api.quickliapp.com/v1/open. Authenticate with Authorization: Bearer qk_live_…. All amounts are NGN. Timestamps are ISO-8601 UTC.
Conventions
Cursor pagination on all list endpoints (limit ≤ 100, cursor from the previous response):
pagination
GET /v1/open/products?limit=25&cursor=cur_8fa2…
{
"data": [ … ],
"pagination": { "nextCursor": "cur_91b3…", "hasMore": true }
}Common filters: status, created_from, created_to, externalId. All POSTs accept Idempotency-Key. Metered responses include X-Token-Cost and X-Token-Balance.
Account
GET
Organization profile, plan & consent state1/accountGET
Token usage series & breakdowns (?from,&to,&group)1/account/usageGET
Token balance + naira wallet balance1/account/walletDeliveries
POST
Price & service-area check1/deliveries/estimatePOST
Dispatch a delivery5/deliveriesPOST
Batch dispatch (≤50)5+2/item/deliveries/batchGET
List & filter1/deliveriesGET
Fetch one1/deliveries/:idGET
Live status, rider & location1/deliveries/:id/trackingPOST
Cancel (pre-pickup)2/deliveries/:id/cancelLocations
POST
Register an outlet2/locationsGET
List1/locationsGET
Fetch one1/locations/:idPATCH
Update details / hours2/locations/:idPATCH
Marketplace visibility per location2/locations/:id/visibilityGET
Rider service-area check1/locations/:id/coverageDELETE
Deactivate2/locations/:idProducts
GET
Browse categories1/categoriesPOST
Create2/productsGET
List & filter1/productsGET
Fetch one1/products/:idPATCH
Update2/products/:idPATCH
Stock sync2/products/:id/stockPOST
Publish to marketplace2/products/:id/publishPOST
Hide2/products/:id/unpublishPOST
Upsert by externalId (≤500)1/item/products/bulkDELETE
Soft-delete2/products/:idOrders (marketplace)
GET
Incoming Quickli App orders1/ordersGET
Order detail1/orders/:idPOST
Accept for fulfilment2/orders/:id/acceptPOST
Reject with reason (auto-refund)2/orders/:id/rejectPOST
Mark ready → rider dispatch2/orders/:id/readyGET
Commission & payout breakdown1/orders/:id/settlementRecipients
POST
Save to address book2/recipientsGET
List1/recipientsPATCH
Update2/recipients/:idDELETE
Remove2/recipients/:idMessaging
POST
Send SMS (≤100 recipients)2 + carrier/notifications/smsPOST
Send email (template or custom)1/notifications/emailGET
Delivery status of a message1/notifications/deliveries/:idMachine-readable spec
The full OpenAPI 3.1 document is available at
https://api.quickliapp.com/docs and as a Postman collection from Portal → API Keys → Downloads.