unscheduledStops

The unscheduledStops field is an array that lists all of your orders that could not be scheduled due to either constraint violations, geographically infeasible locations, or due to errors is geocoding the address of the order.

{
    "routeSchedule": {
        "unscheduledStops": [
          {unscheduledStop 1},
          {unscheduledStop 2},
          ...
          {unscheduledStop n}
        ],
        ...
    },
    ...
}

An unscheduledStop object looks like this:

{
    "name": "stop_5",
    "load": 600000,
    "duration": 4,
    "eventUuid": "6ec53b3c-02d9-4283-9ac1-af574abd5b49",
    "isScheduled": false,
    "locations": [
        {
            "address": "dundas square, toronto, ontario, canada",
            "latitude": 43.655976,
            "longitude": -79.380373,
            "active": true,
            "status": "Validated"
        }
    ],
    "unscheduledReason": {
        "reason": "Cannot be scheduled due to constraints."
    },
    "timeWindows": [
        {
            "startTime": "16:00",
            "endTime": "22:00"
        }
    ]
}

Fields	Type	Description
name	String	Name of the order assigned within the orders object
load	Int	Load assigned to the order
duration	Int	Service time for the order (in seconds)
eventUuid	String Uuid	A unique Id used to identify the order with Routific's ecosystem. This eventUuid can be used to cross-reference the orders in the routeScenario.stops array
isScheduled	boolean	Indicates whether an order has been scheduled to a route
locations	Array of location objects	Provides additional details related to the service location of the order
unscheduledReason	object	Provides information or reason as to why the order couldn't be scheduled to a route
timeWindows	Array of time-window objects	Provides information on service time windows for the current order