API reference
API reference
Every operation of the Qoene Delivery API v1.0.0, generated from the OpenAPI 3.1 document.
Base URLs
| Environment | Base URL |
|---|---|
| Production (TEST and LIVE keys use the same host) | https://api.qoenedelivery.com/v1 |
| Staging | https://api-staging.qoenedelivery.com/v1 |
TEST and LIVE keys use the same host. The older path <API origin>/api/v1 keeps working with the same routes.
Conventions
- JSON request and response bodies; send
Content-Type: application/jsononPOST. - Success:
{ "status": "success", "data": … }. Error: see Errors. - Money is integer pesewas. Some large amounts are returned as a decimal string; treat both as integers.
- Times are ISO 8601 in UTC; promises are calculated in the market time zone (Africa/Accra for Ghana).
GET /marketslists the live markets. - Lists page with an opaque
cursorand returnnextCursor(nullon the last page). - Fields may be added to responses at any time; ignore fields you do not know.
Markets
Services
The products your Business can book, with limits and delivery promises.
Locations
Qoene Points (and lockers once live): list, ranked search and detail.
- GET
/locationsActive points (and live lockers) - GET
/locations/searchRanked point search near a position - GET
/locations/{code}One point or locker
Quotes
Prices for a parcel and route. Book a quote before it expires.
Checkout
The embeddable checkout widget: sessions from your server, browser calls with a publishable key, signed selections.
- POST
/checkout/sessionsStart a checkout session for the widget - POST
/checkout/selections/verifyCheck a selection token from the widget - GET
/checkout/keysPublic keys for selection tokens - GET
/checkout/configWidget start-up details - POST
/checkout/optionsDelivery options for a buyer address - GET
/checkout/pointsRanked Qoene Points for the picker - GET
/checkout/placesAddress suggestions - POST
/checkout/selectionsConfirm the buyer's choice
Shipments
Book, read, list and cancel parcels; read the prohibited-items declaration.
- GET
/shipmentsList shipments - POST
/shipmentsBook a shipment from a quote - GET
/shipments/{shipmentId}One shipment - POST
/shipments/{shipmentId}/cancelCancel before handoff - GET
/declarations/prohibited-itemsCurrent prohibited-items declaration
Tracking
Event timeline and buyer-friendly milestones.
Payments
Approval requests for prepaid parcels. Never a charge by API.
- POST
/shipments/{shipmentId}/payment-intentsRequest prepaid payment approval - GET
/payment-intents/{intentId}Payment intent status
Labels
Issue and download parcel labels (LIVE keys).
- POST
/shipments/{shipmentId}/labelsIssue the first label - GET
/shipments/{shipmentId}/labels/{labelId}.pdfDownload a label PDF
Manifests
Batch manifests for collections (LIVE keys).
Orders
Store orders in the Business order inbox, and ship runs.
- POST
/ordersAdd a store order to the inbox - GET
/ordersList orders - GET
/orders/{orderId}One order with ship attempts - POST
/orders/{orderId}/shipShip one order - POST
/ship-jobsShip several orders - GET
/ship-jobs/{jobId}Ship run with per-order results
Claims
- GET
/claimsList claims - POST
/claimsFile a claim for a parcel - GET
/claims/{claimId}One claim with evidence, payouts and timeline - POST
/claims/{claimId}/evidenceAttach a photo or document
Returns
Reserved until e-commerce returns launch.
- GET
/returnsList returns - POST
/returnsStart a return for your customer - GET
/returns/policyThe return policy in force - POST
/returns/quotePrice and promise of a return option - GET
/returns/{returnId}One return - POST
/returns/{returnId}/approveApprove a customer's return - POST
/returns/{returnId}/rejectReject a customer's return - POST
/returns/{returnId}/cancelCancel a return before drop-off
Analytics
Webhooks
Endpoints that receive signed events (LIVE keys).
- GET
/webhook-endpointsWebhook endpoints of this API client - POST
/webhook-endpointsCreate a webhook endpoint - POST
/webhook-endpoints/{endpointId}/disableDisable an endpoint - POST
/webhook-endpoints/{endpointId}/testQueue a signed webhook.test event
Meta
The OpenAPI document itself.
Schemas
Every request and response object is described in Schemas.