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/account
Organization profile, plan & consent state1
GET/account/usage
Token usage series & breakdowns (?from,&to,&group)1
GET/account/wallet
Token balance + naira wallet balance1

Deliveries

POST/deliveries/estimate
Price & service-area check1
POST/deliveries
Dispatch a delivery5
POST/deliveries/batch
Batch dispatch (≤50)5+2/item
GET/deliveries
List & filter1
GET/deliveries/:id
Fetch one1
GET/deliveries/:id/tracking
Live status, rider & location1
POST/deliveries/:id/cancel
Cancel (pre-pickup)2

Locations

POST/locations
Register an outlet2
GET/locations
List1
GET/locations/:id
Fetch one1
PATCH/locations/:id
Update details / hours2
PATCH/locations/:id/visibility
Marketplace visibility per location2
GET/locations/:id/coverage
Rider service-area check1
DELETE/locations/:id
Deactivate2

Products

GET/categories
Browse categories1
POST/products
Create2
GET/products
List & filter1
GET/products/:id
Fetch one1
PATCH/products/:id
Update2
PATCH/products/:id/stock
Stock sync2
POST/products/:id/publish
Publish to marketplace2
POST/products/:id/unpublish
Hide2
POST/products/bulk
Upsert by externalId (≤500)1/item
DELETE/products/:id
Soft-delete2

Orders (marketplace)

GET/orders
Incoming Quickli App orders1
GET/orders/:id
Order detail1
POST/orders/:id/accept
Accept for fulfilment2
POST/orders/:id/reject
Reject with reason (auto-refund)2
POST/orders/:id/ready
Mark ready → rider dispatch2
GET/orders/:id/settlement
Commission & payout breakdown1

Recipients

POST/recipients
Save to address book2
GET/recipients
List1
PATCH/recipients/:id
Update2
DELETE/recipients/:id
Remove2

Messaging

POST/notifications/sms
Send SMS (≤100 recipients)2 + carrier
POST/notifications/email
Send email (template or custom)1
GET/notifications/deliveries/:id
Delivery status of a message1

Machine-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.