6.3 Stop Object

Each stop object in the stops field of a route has the following fields:

1. Field: stop_id
   Type: Number (integer).
   Description: A number given to the stop by the optimiser. Matches the stop’s location in the stops array.
2. Field: stop_type
   Type: String (a stop type code).
   Description: The type of stop.
3. Field: order
   Type: String.
   Description: For stop_type PICKUP or DELIVERY the identifier of the order being picked up or delivered. This matches the id of an order. For other types of stop this will be null.
4. Field: location
   Type: String.
   Description: The identifier of the location at which the stop occurs. This matches the id of a location.
5. Field: arrival_time
   Type: String (HH:MM).
   Description: The time at which the vehicle is planned to arrive at the stop location.
6. Field: departure_time
   Type: String (HH:MM).
   Description: The time at which the vehicle is planned to depart the stop location.
7. Field: weight
   Type: Number.
   Description: The total weight loaded on the vehicle at the departure from the stop.
8. Field: volume
   Type: Number.
   Description: The total volume loaded on the vehicle at the departure from the stop.
9. Field: transit_time
   Type: String (HH:MM).
   Description: The time spent in transit between the previous stop and this one.
   Note: If the stop has stop_type START or BREAK, then this will be 00:00.

10. Field: transit_distance
    Type: Number.
    Description: The transit distance between the previous stop and this one.
    Note: If the stop has stop_type START or BREAK, then this will be 0.

    11.Field: compartment
    Type: String.
    Description: For stop_type PICKUP or DELIVERY where the compartment scheme (compartments field) for the vehicle is not null, this will be the identifier of the compartment that the order is assigned to. For other stop types, or where the vehicle lacks a compartment scheme, this will be null.
    12.Field: soft_time_window_start
    Type: String (HH:MM).
    Description: For PICKUP stops where the order has pickup soft time windows, this field is the start time of the pickup soft time window closest to the stop’s arrival_time. For DELIVERY stops where the order has delivery soft time windows, this field is the start time of the delivery soft time window closest to the stop’s arrival_time. For other stop types, for PICKUP stops for orders with no pickup soft time windows or for DELIVERY stops for orders with no delivery soft time windows this field is null.
    13.Field: soft_time_window_end
    Type: String (HH:MM).
    Description: For PICKUP stops where the order has pickup soft time windows, this field is the end time of the pickup soft time window closest to the stop’s arrival_time. For DELIVERY stops where the order has delivery soft time windows, this field is the end time of the delivery soft time window closest to the stop’s arrival_time. For other stop types, for PICKUP stops for orders with no pickup soft time windows or for DELIVERY stops for orders with no delivery soft time windows this field is null.
11. Field: soft_time_window_delta
    Type: String (HH:MM).
    Description: For PICKUP stops where arrival_time falls outside of the closest pickup soft time window, this field is either the amount of time from the arrival time to the start of the of the closest pickup soft time window (for early arrivals) or the amount of time from the end of the closest pickup soft time window (for late arrivals). This field is 00:00 if the arrival time is within a pickup soft time window. For DELIVERY stops, the value of this field is similarly defined except that it is with respect to delivery soft time windows. For other stop types, PICKUP stops with no pickup soft time windows, or DELIVERY stops with no delivery soft time windows this field is null.