Schema
QuoteOptionsRequest
Every product that can serve this parcel and route is priced; the others come back in excluded with a reason.
Fields
| Field | Type | Description |
|---|---|---|
marketOptional | MarketCode | Two-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network. |
serviceCodesOptional | array of ServiceCode | Narrow the products to price (default: all). Do not send service, serviceVariant or serviceCode here.1–∞ items |
measurementsRequired | Measurements | |
originLocationCodeOptional | string | Relay drop-off point. |
destinationLocationCodeOptional | string | Relay pickup point or locker. |
fallbackLocationCodeOptional | string | Relay Home fallback point (default: the nearest suitable Qoene Point, returned as homeFallbackSuggestion). |
originAddressTextOptional | string | Express pickup address. |
destinationAddressTextOptional | string | Express or Relay Home delivery address. For Relay Home from a drop-off point, send it with originLocationCode and no origin address. |
originPlaceIdOptional | string | |
destinationPlaceIdOptional | string | |
requestedPickupAtOptional | string (date-time) | Express pickup time; for Relay the planned drop-off time. 30 minutes to 14 days ahead; default now. |
payOnPickupOptional | boolean | |
pickupInstructionsOptional | string | 0–500 characters |
deliveryInstructionsOptional | string | 0–500 characters |
promotionCodeOptional | string | Pattern ^[A-Za-z0-9_-]{3,32}$ |