Developers
API referenceBusiness sign in

Services

Products this Business can use

GET/services

Scope services.read

The NB02 product catalog, filtered by the Business's contract in force (NB10): each usable product with its parcel limits and promise rule (including the promise if booked now). Products that are switched off or outside the contract are listed in unavailable with a reason.

Request

No parameters.

Response

Success responses
StatusMeaning
200Usable and unavailable products

The body is { "status": "success", "data": … }. Fields of data (ServicesResult):

Response data
FieldTypeDescription
marketOptionalMarketCodeTwo-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network.
servicesRequiredarray of Service
unavailableRequiredarray of ServiceUnavailable
contractRequiredContractSummary or null
generatedAtOptionalstring (date-time)

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.