API reference
Schemas
The objects the API accepts and returns. Each page lists the fields, where the object is used and an example.
MinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.EnvironmentThe key environment. TEST never touches live custody, payments, dispatch or notifications.ServiceCodeStable product code (NB02).ErrorEvery error response.DeliveryPromiseThe delivery promise, worked out with the Ghana working calendar (public holidays and network closures), cut-offs and region lanes.PromiseCheckpointPromiseRevisionShipmentPromiseThe promise frozen at booking (original) and the one in force (current). Changes are revisions with a reason; the booked promise never changes.WebhookPromiseOnly on shipment.promise_revised and shipment.promise_missed.ServiceReasonServiceUnavailableContractSummaryAddressFree-form address object as published by the point (for example line1, area, city).OpenStateSpaceSpace as a level; raw counts are never published.ClosureMarketCodeTwo-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network.MarketA live market. Cross-border shipping is not offered: origin, destination and Business are always in one market.LocationLocationDetailRankedPointExcludedPointPointSearchContactMeasurementsQuoteRequestSame fields as the signed-in quote. Unknown or expired promotion codes return 422.QuoteQuoteOptionsRequestEvery product that can serve this parcel and route is priced; the others come back inexcludedwith a reason.QuoteResultQuoteOptionsResultDeclarationBookingRequestSendquoteId(a quote from POST /quotes or /quotes/options) orcheckoutSelection(a checkout widget token).BookedShipmentBookingResultReceiverChangeOverstayReceivers pay overstay by Mobile Money at pickup; a contract that covers overstay pays from the Business wallet up to its limit.ShipmentShipmentListItemMilestoneStepTrackingCancelResultPaymentIntentPaymentIntentResultLabelResultManifestOrderItemOrderInputOrderCreateRequestOrderOrderCreateResultOrderListShipRequestShipJobsRequestShipJobShipJobResultWebhookEventNameWebhookEndpointWebhookEndpointListWebhookEndpointCreateRequestWebhookEndpointCreatedWebhookTestDeliveryWebhookShipmentWebhookShipmentEventBody for shipment.*, payment.*, refund.processed and locker.overage_due. No names, phones, addresses, codes or proof.WebhookOrderEventBody for order.* events. No buyer or receiver details. Orders created with a TEST key send no events.WebhookTestEventCheckoutSessionRequestCheckoutSessionCheckoutSessionResultCheckoutPointCheckoutSelectionWhat the buyer chose. Point and price come from Qoene, never from the browser.CheckoutSelectionVerifyRequestCheckoutSelectionVerificationCheckoutJwksCheckoutConfigCheckoutOptionsRequestCheckoutOfferCheckoutOptionsCheckoutPointsCheckoutPlacesCheckoutSelectionRequestCheckoutSelectionIssuedMarketListServicesResultLocationListLocationDetailResultShipmentListShipmentResultTrackingResultCancelRequestPaymentIntentStatusManifestRequestManifestResultManifestStatusOrderResultShipJobStatusWebhookEndpointDisabledWebhookTestResultDeclarationResultClaimReasonLOSS, DAMAGE, MISSING_ITEMS, DELAY (the delivery promise was missed) or WRONG_DELIVERY.ClaimStatusAWAITING_APPROVAL: approved above the threshold and waiting for a second supervisor. PAID: the compensation was sent.ClaimEvidenceClaimPayoutClaimA parcel claim. Internal liability findings and staff names are never returned.ClaimCreateRequestClaimResultClaimCreateResultClaimListClaimEvidenceRequestClaimEvidenceResultWebhookClaimEventBody for claim.* events, for claims on your parcels (filed in the Business workspace or with a LIVE key). No description, evidence or contact details.ReturnReasonWhy the goods come back.ReturnStatusREQUESTED: waiting for your review. AWAITING_PAYMENT: approved; the customer pays before the code works. AWAITING_DROPOFF: the paperless code is active. DROPPED_OFF, IN_TRANSIT, ARRIVED (ready for you), RECEIVED (handed to you), INSPECTED. Closed: REJECTED, CANCELLED, EXPIRED.ReturnProductRELAY_POINT: dropped off at a Qoene Point. RELAY_LOCKER: locker drop-off (not live until lockers are deployed). EXPRESS_STANDARD: a rider collects it inside an Express area.ReturnPayerMERCHANT: billed to your Business wallet or invoice. CUSTOMER: the customer pays by Mobile Money before the code works. DEDUCT_FROM_REFUND: billed to you; deductFromRefundMinor tells your refund system what to keep back.ReturnItemReturnAn e-commerce return: a reverse parcel linked to the original. The customer's phone and the drop-off code are never returned.ReturnCreateRequestReturnQuoteRequestReturnQuoteReturnQuoteResultReturnDecisionRequestReturnResultReturnCreateResultReturnListReturnPolicyThe return policy in force (store, else Business, else default), after any contract terms.ReturnPolicyResultWebhookReturnEventBody for return.* events. No customer contact, notes or drop-off codes. Refund your customer from your own system on return.received or return.inspected.AnalyticsTotalsTotals for the period. Each figure counts on the business day its own event happened.AnalyticsTrendDayAnalyticsBreakdownAnalyticsSummaryDelivery performance of your own parcels. Only your Business; no receiver names, phones or addresses. TEST and LIVE keys read the same LIVE figures (read-only aggregates).