Skip to content

Logistic

Port: REST :3120 · gRPC :5120

Tracks physical assets and movements — geographic locations, drivers, vehicles, cargoes, and travel routes. Integrates with OpenStreetMap for geocoding and the Valhalla engine for routing.

Collections

CollectionPathPurpose
Locations/logistic/locationsGeoJSON places and areas
Drivers/logistic/driversDriver records
Vehicles/logistic/vehiclesFleet vehicle records
Travels/logistic/travelsOrdered trip records linking locations, drivers, vehicles, and cargoes
Cargoes/logistic/cargoesShipment dimension and handling data

logistic/locations

GeoJSON-based physical places or areas (warehouses, depots, customer sites, checkpoints).

Required Create Fields

FieldRequiredTypeDescription
geometryobjectGeoJSON geometry

Geometry Fields

FieldRequiredTypeDescription
typeLocationGeometryTypePoint, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon
coordinatesarrayGeoJSON coordinates — [longitude, latitude] order

GeoJSON uses [longitude, latitude] — not [latitude, longitude]. This order is safety-critical.

Special Operations (platform REST only)

OperationHTTPScopeDescription
Reverse geocodePOST /logistic/locations/resolve/addressresolve:logistic:locationsCoordinates → address
Forward geocodePOST /logistic/locations/resolve/geocoderesolve:logistic:locationsText query → coordinates

logistic/drivers

Driver identity and operational status.

Required Create Fields

FieldRequiredTypeDescription
typeDriverTypeCLASS_A, CLASS_B, CLASS_C, CLASS_M, CLASS_E
genderGenderMALE, FEMALE, UNKNOWN
stateStatePENDING, APPROVED, REJECTED, VERIFIED, UNKNOWN
statusStatusACTIVE, INACTIVE
licensestringLicense number
expiration_datedateLicense expiration date

logistic/vehicles

Fleet vehicle registry with assigned driver linkage.

Required Create Fields

FieldRequiredTypeDescription
typeVehicleTypeCAR, TRUCK, MOTORCYCLE
statusStatusACTIVE, INACTIVE
platesstring[]Plate numbers

Population

PathCollection
driverslogistic/drivers

logistic/travels

Ordered trip record linking route locations, cargoes, drivers, and vehicles.

Required Create Fields

FieldRequiredTypeDescription
locationsMongoId[]Ordered location IDs — first is origin, last is destination

Optional Fields

FieldTypeDescription
cargoesMongoId[]Assigned cargo IDs
driversMongoId[]Assigned driver IDs
vehiclesMongoId[]Assigned vehicle IDs

Population

PathCollection
locationslogistic/locations
cargoeslogistic/cargoes
driverslogistic/drivers
vehicleslogistic/vehicles

Special Operation (platform REST only)

OperationHTTPScopeDescription
RoutingPOST /logistic/travels/resolve/routingresolve:logistic:travelsRoute planning via Valhalla

Routing requires service (route, isochrone, sources_to_targets, optimized_route) and options (raw Valhalla payload).

logistic/cargoes

Physical shipment metadata, dimensions, and handling flags.

Required Create Fields

FieldRequiredTypeDescription
weightnumberCargo weight
widthnumberCargo width
heightnumberCargo height
lengthnumberCargo length

Optional Fields

FieldTypeDescription
titlestringHuman-readable label
fragilebooleanFragile handling flag
perishablebooleanPerishable handling flag
travelsMongoId[]Linked travel IDs

Population

PathCollection
travelslogistic/travels