Developers
API referenceBusiness sign in

Schema

QuoteOptionsRequest

Every product that can serve this parcel and route is priced; the others come back in excluded with a reason.

Fields

QuoteOptionsRequest fields
FieldTypeDescription
marketOptionalMarketCodeTwo-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network.
serviceCodesOptionalarray of ServiceCodeNarrow the products to price (default: all). Do not send service, serviceVariant or serviceCode here.1–∞ items
measurementsRequiredMeasurements
originLocationCodeOptionalstringRelay drop-off point.
destinationLocationCodeOptionalstringRelay pickup point or locker.
fallbackLocationCodeOptionalstringRelay Home fallback point (default: the nearest suitable Qoene Point, returned as homeFallbackSuggestion).
originAddressTextOptionalstringExpress pickup address.
destinationAddressTextOptionalstringExpress or Relay Home delivery address. For Relay Home from a drop-off point, send it with originLocationCode and no origin address.
originPlaceIdOptionalstring
destinationPlaceIdOptionalstring
requestedPickupAtOptionalstring (date-time)Express pickup time; for Relay the planned drop-off time. 30 minutes to 14 days ahead; default now.
payOnPickupOptionalboolean
pickupInstructionsOptionalstring0–500 characters
deliveryInstructionsOptionalstring0–500 characters
promotionCodeOptionalstringPattern ^[A-Za-z0-9_-]{3,32}$

Used by