Node model for stateful API
If there are already some nodes assigned to a vehicle, this flagg allows for the nodes to be reassigned to other vehicles during consequent optimizations
Timestamp of vehicle arrival to a location. This timestamp is reset for a node if a relevant event has happened to it - fail_to_board or fail_to_pickup depending on the node type.
Reference to a vehicle that has been assigned to this node
Reference to a booking object this nodes belongs to
Booking UID of the booking object this node belongs to
Availability of this node; represents close time
data object
Contains optional information describing this node
order_identity object
raw_order_record object
Original information about the booking that has been used to generate this node
demand_types object
vehicle_labels object
demand object
Demand object for this node
Deprecated. Should not be used and is set to null in node data.
Human readable name of this node
Flag indicating if this node is the last node along the assigned vehicle trip
Deprecated. Should not be used and is set to null in node data.
Represents a less accurate, optimistic estimation of the arrival time to a node.
Represents the most realistic expected arrival time to a node.
If a delivery failed event occurs at the node, this timestamp represents when the event happened. Updated if state of the booking is fail_to_deliver.
Enables or disables the LIFO order logic for this booking, LIFO logic is a soft constraint forcing the pickups and drop offs to happen in LIFO sequence related to the vehicles (last picked up order is prioritized for the drop off)
If lifo_order_check is enabled, controls cost of the constraint.
Longitude of the node
Timestamp of time\distance matrix that will be usaed during optimization cycle. Default value is node.open_time_ts
Supported types of nodes for optimization.
Possible values: [dropoff, point, pickup, vehicle_position, depot]
Represents the initially planned arrival time to a node during route optimization. This can be used for comparing the actual arrival time with the planned one to assess the quality of planning.
Time to service the node in seconds. This time is normally populated from a related booking model when the node is created.
Reference to a simulation object this node belongs to
Slack assigned to the node
started_service_at_ts: Deprecated. Should not be used and is set tonullin node data. The field is used in Optimization API for a node and must be set for completed nodes.
Current status of the node.
Possible values: [new, assigned, in_service, completed, cancelled_by_user, dropped_by_algo, fail_to_board, fail_to_deliver]
vehicle_characteristics object
Vehicle characteristics required to perform the booking.
property name* object
- number
- Ranged characteristic
- boolean
Value of the characteristic, for example:
{
"manpower": 3
}
Minimum value of the characteristic
Maximum value of the characteristic
Vehicle labels contain constraints, represented as dictionaries, that may contain string labels or sub-constraints. A constraint is a dictionary containing only one entry with keys: "and", "or", or "not". The keys "and" and "or" define the AND or OR logic functions, and their values should be a list of either string labels or dictionaries containing sub-constraints. The key "not" defines the NOT logic function, and its value can be a single string or a single sub-constraint.
Example of vehicle labels constraints:
'1' AND ('2' OR '3') AND NOT ('4' AND '5') as:
{"and": [{"or": ["2", "3"]}, {"not": {"and": ["4", "5"]}}]}
Flag indicating if the node has been soft-deleted.
This flag is set to true when an upstream booking model is invalidated using the invalidate bookings in batch API.
It is also set to true if, upon uploading bookings using the logistics API, the upload_strategy is set to clear_all.
Creation timestamp of an object
id object
Identifier of the object
- integer
- uuid
Can be integer
Can be UUID
Last modification timestampo of the object
URI of the object instance
{
"allow_jump": true,
"arrived_to_location_ts": "2024-07-29T15:51:28.071Z",
"assigned_vehicle": "string",
"assignment_order": 0,
"boarding_pass": "string",
"booking": "string",
"booking_group_uid": "string",
"booking_uid": "string",
"cancelled_at_ts": "2024-07-29T15:51:28.071Z",
"close_time_ts": "2024-07-29T15:51:28.071Z",
"close_time_ts_dynamic": "string",
"completed_service_at": "2024-07-29T15:51:28.071Z",
"customer_id": 0,
"data": {
"customer_name": "string",
"customer_name2": "string",
"customer_phone": "string",
"dropoff_address": "string",
"dropoff_city": "string",
"dropoff_country": "string",
"dropoff_customer_name": "string",
"dropoff_customer_name2": "string",
"dropoff_customer_phone": "string",
"dropoff_region": "string",
"external_id": "string",
"is_dropoff_end_of_trip": true,
"is_pickup_end_of_trip": true,
"order_identity": {
"external_id": "string",
"simulation_id": 0
},
"phone": "string",
"pickup_address": "string",
"pickup_city": "string",
"pickup_country": "string",
"pickup_customer_name": "string",
"pickup_location_lat": "string",
"pickup_location_lon": "string",
"pickup_location_name": "string",
"pickup_region": "string",
"raw_order_record": {
"date": "string",
"demand_types": {
"parcel": "string"
},
"dropoff_address": "string",
"dropoff_address2": "string",
"dropoff_close_date_ts": "string",
"dropoff_close_time_ts": "string",
"dropoff_location_lat": "string",
"dropoff_location_lon": "string",
"dropoff_max_weight": "string",
"dropoff_open_date_ts": "string",
"dropoff_open_time_ts": "string",
"dropoff_service_time": "string",
"dropoff_unit_number": "string",
"dropoff_zip_code": "string",
"external_id": "string",
"name": "string",
"name2": "string",
"phone_number": "string",
"pickup_address": "string",
"pickup_address2": "string",
"pickup_close_date_ts": "string",
"pickup_close_time_ts": "string",
"pickup_customer_name": "string",
"pickup_customer_name2": "string",
"pickup_customer_phone": "string",
"pickup_location_lat": "string",
"pickup_location_lon": "string",
"pickup_open_date_ts": "string",
"pickup_open_time_ts": "string",
"pickup_scheduled_ts": "string",
"pickup_service_time": "string",
"pickup_unit_number": "string",
"pickup_zip_code": "string",
"remarks": "string",
"vehicle_characteristics": {},
"vehicle_labels": {
"or": [
"string"
]
}
},
"remarks": "string",
"username": "string"
},
"demand": {},
"departed_at_ts": "2024-07-29T15:51:28.071Z",
"display_name": "string",
"dynamic_break": true,
"end_of_trip": true,
"estimated_arrival_time": "2024-07-29T15:51:28.071Z",
"estimated_earliest_arrival_ts": "2024-07-29T15:51:28.071Z",
"estimated_scheduled_ts": "2024-07-29T15:51:28.071Z",
"external_id": "string",
"failed_to_deliver_at_ts": "2024-07-29T15:51:28.071Z",
"finalization_type": "string",
"fixed_route_is_unreachable": true,
"fixed_route_journey_time": "null",
"fixed_route_ride_time": "null",
"fixed_route_wait_time": "null",
"fixed_route_walk_time": "null",
"geofence_id": 0,
"geofence_ids": [
0
],
"groups": [
{}
],
"h3": "string",
"initial_close_time_ts": "2024-07-29T15:51:28.071Z",
"initial_close_time_ts_dynamic": "2024-07-29T15:51:28.071Z",
"initial_max_trip_duration": "2024-07-29T15:51:28.071Z",
"initial_open_time_ts": "2024-07-29T15:51:28.071Z",
"lat": 0,
"lifo_order_check": true,
"lifo_order_penalty": 0,
"location_code": "string",
"location_name": "string",
"lon": 0,
"matrix_timestamp": "2024-07-29T15:51:28.071Z",
"max_slack": 0,
"max_trip_duration": 0,
"min_trip_duration": 0,
"node_type": "dropoff",
"offer_should_be_auto_accepted": true,
"open_time_ts": "2024-07-29T15:51:28.071Z",
"open_time_ts_dynamic": "2024-07-29T15:51:28.071Z",
"partial_route_index": 0,
"passenger_count": 0,
"processing_order_timestamp": "2024-07-29T15:51:28.071Z",
"ready_to_board_at": "2024-07-29T15:51:28.071Z",
"scheduled_ts": "2024-07-29T15:51:28.071Z",
"service_time": 0,
"simulation": "string",
"slack": 0,
"started_service_at_ts": "2024-07-29T15:51:28.071Z",
"status": "new",
"time_windows": "null",
"transfer_type": "string",
"transit_stop": "null",
"trip_cost": 0,
"uid": "string",
"user_accepted_offer_at": "2024-07-29T15:51:28.071Z",
"vehicle_characteristics": {},
"vehicle_labels": "Unknown Type: object,null",
"visited_at_ts": "2024-07-29T15:51:28.071Z",
"walking_distance_to_node": 0,
"walking_time_to_node": 0,
"weight": 0,
"is_invalidated": true,
"created_at": "2024-07-29T15:51:28.071Z",
"id": 0,
"modified_at": "2024-07-29T15:51:28.071Z",
"resource_uri": "string"
}