PlanJob
A single stop, such as a delivery, a collection or a visit.
order-1001location 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
270Time spent at the stop.
Possible values: >= 0
Load dropped here, carried from the vehicle's start.
Possible values: >= 0
Load collected here, carried to the vehicle's end.
Possible values: >= 0
When not everything fits, higher-priority stops are kept first.
Possible values: >= 0 and <= 100
time_windows object[]
When the vehicle may arrive. It waits if early.
{
"id": "order-1001",
"location": {
"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
},
"service_s": 0,
"delivery": [
0
],
"pickup": [
0
],
"skills": [
"string"
],
"priority": 0,
"time_windows": [
{
"start": "2024-07-29T15:51:28.071Z",
"end": "2024-07-29T15:51:28.071Z"
}
]
}