DeliveryQuoteRequest
Bulk only. Your reference, echoed back.
pickup objectrequired
One end of a route — supply exactly one of hex, plus_code, gps_code, point, or profile_slug.
A GhanaPostGPS digital address, with or without dashes. It is
looked up in the GhanaPostGPS registry and the route uses the
centre of its cell. An unknown or malformed code returns
400 VALIDATION_ERROR.
GA-183-8164A full Plus Code (Open Location Code), case-insensitive. The route
uses the centre of its cell (about 14 m across for a 10-digit
code). Short codes are rejected as ambiguous; expand them first
with GET /v2/pluscode/{code}?ref=lat,lng.
6CQXJR37+F6Physical location selector, mutually exclusive with hex/point/profile_slug. Private locations require a profile grant.
Canonical gate ID; requires profile_slug or location_id and excludes entrance_type.
Reject if the approved revision changed.
Possible values: >= 1
Address-profile handle; access is checked before resolving coordinates/entrances
Optional explicit entrance for profile_slug. Otherwise defaults to truck/main gate selection, then profile point.
Possible values: [main, truck_gate, loading_dock, visitor, staff, pedestrian, compound]
AfriHex code at resolution 7
AF-GH-7-0GXTJJB0ZZZZZpoint object
Raw coordinate
-0.18675.604Device compass bearing in degrees (0 = north). On dual-carriageway roads it disambiguates which carriageway the endpoint snaps to, so routes don't begin with a phantom U-turn. Omit when unknown.
Possible values: >= 0 and <= 359
270dropoff objectrequired
One end of a route — supply exactly one of hex, plus_code, gps_code, point, or profile_slug.
A GhanaPostGPS digital address, with or without dashes. It is
looked up in the GhanaPostGPS registry and the route uses the
centre of its cell. An unknown or malformed code returns
400 VALIDATION_ERROR.
GA-183-8164A full Plus Code (Open Location Code), case-insensitive. The route
uses the centre of its cell (about 14 m across for a 10-digit
code). Short codes are rejected as ambiguous; expand them first
with GET /v2/pluscode/{code}?ref=lat,lng.
6CQXJR37+F6Physical location selector, mutually exclusive with hex/point/profile_slug. Private locations require a profile grant.
Canonical gate ID; requires profile_slug or location_id and excludes entrance_type.
Reject if the approved revision changed.
Possible values: >= 1
Address-profile handle; access is checked before resolving coordinates/entrances
Optional explicit entrance for profile_slug. Otherwise defaults to truck/main gate selection, then profile point.
Possible values: [main, truck_gate, loading_dock, visitor, staff, pedestrian, compound]
AfriHex code at resolution 7
AF-GH-7-0GXTJJB0ZZZZZpoint object
Raw coordinate
-0.18675.604Device compass bearing in degrees (0 = north). On dual-carriageway roads it disambiguates which carriageway the endpoint snaps to, so routes don't begin with a phantom U-turn. Omit when unknown.
Possible values: >= 0 and <= 359
270Possible values: [motor_scooter, driving, bicycle, foot, truck]
motor_scooterWhen the delivery leaves (default now, up to 7 days ahead). Sets traffic and time_window surcharges.
parcel object
rules object
Your delivery fee rulebook. Set at least one of base_fee, per_km or per_min.
GHSPer minute of traffic-adjusted travel time.
0 or absent = no cap.
Round the final price up to a multiple of this, e.g. 0.5.
mode_multipliers object
zones object[]
Possible values: <= 20
surcharges object[]
Possible values: <= 20
Possible values: [unpaved, flood_risk, rain, toll, time_window, weight]
unpaved only, 0-1.
time_window only, HH:MM Ghana time.
20:0006:00weight only.
{
"id": "string",
"pickup": {
"gps_code": "GA-183-8164",
"plus_code": "6CQXJR37+F6",
"location_id": "string",
"entrance_id": "string",
"entrance_revision": 0,
"profile_slug": "string",
"entrance_type": "main",
"hex": "AF-GH-7-0GXTJJB0ZZZZZ",
"point": {
"lng": -0.1867,
"lat": 5.604
},
"heading": 270
},
"dropoff": {
"gps_code": "GA-183-8164",
"plus_code": "6CQXJR37+F6",
"location_id": "string",
"entrance_id": "string",
"entrance_revision": 0,
"profile_slug": "string",
"entrance_type": "main",
"hex": "AF-GH-7-0GXTJJB0ZZZZZ",
"point": {
"lng": -0.1867,
"lat": 5.604
},
"heading": 270
},
"mode": "motor_scooter",
"depart_at": "2024-07-29T15:51:28.071Z",
"parcel": {
"weight_kg": 0
},
"rules": {
"currency": "GHS",
"base_fee": 0,
"per_km": 0,
"per_min": 0,
"minimum": 0,
"maximum": 0,
"round_to": 0,
"mode_multipliers": {
"driving": 1.5,
"truck": 2
},
"zones": [
{
"service_area_id": "string",
"label": "string",
"add": 0,
"multiply": 0
}
],
"surcharges": [
{
"type": "unpaved",
"label": "string",
"add": 0,
"multiply": 0,
"min_share": 0,
"start": "20:00",
"end": "06:00",
"min_kg": 0,
"max_kg": 0
}
]
}
}