Developers
API referenceBusiness sign in

API reference

API reference

Every operation of the Qoene Delivery API v1.0.0, generated from the OpenAPI 3.1 document.

Base URLs

Base URLs
EnvironmentBase URL
Production (TEST and LIVE keys use the same host)https://api.qoenedelivery.com/v1
Staginghttps://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/json on POST.
  • 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 /markets lists the live markets.
  • Lists page with an opaque cursor and return nextCursor (null on 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.

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.

Shipments

Book, read, list and cancel parcels; read the prohibited-items declaration.

Tracking

Event timeline and buyer-friendly milestones.

Payments

Approval requests for prepaid parcels. Never a charge by API.

Labels

Issue and download parcel labels (LIVE keys).

Manifests

Batch manifests for collections (LIVE keys).

Orders

Store orders in the Business order inbox, and ship runs.

Claims

Returns

Reserved until e-commerce returns launch.

Analytics

Webhooks

Endpoints that receive signed events (LIVE keys).

Meta

The OpenAPI document itself.

Schemas

Every request and response object is described in Schemas.