Something went wrong?
Successful requests return HTTP code 200. In other cases, we will return an error code with a helpful message.
| 200 | Successful request |
| 400 | Input error, see the error message for details |
| 401 | Are you sending your API token in the request header? |
| 408 | Request timeout. Your request was too large. Consider using Long-running tasks. |
| 412 | No solution could be found. Please check your input? Usually due to incorrect time-windows. |
| 429 | Exceeding daily request limits? Is your problem size larger than your current account limits? You can request an increase by writing to [email protected] |
| 500 | Sorry, our bad. Let us know what happened! We're at [email protected] |
Below is a list of non-HTTP error codes that can be returned by Routific when certain validations fail. Please note that this is not an exhaustive list.
| Error Code | Error Message |
|---|---|
| ERR_DRIVER_NOT_SAME_REGION | Please make sure your drivers are in the same region as your visits. |
| ERR_ALL_VISITS_INCOMPATIBLE | Sorry, none of the stops can be scheduled. Please check your inputs and constraints. |
| ERR_BREAKS_NOT_SUPPORTED_PDP | Breaks are not supported in pdp requests. |
| ERR_UNABLE_TO_SQUEEZE_STOPS | Sorry - we aren’t able to squeeze these stops in. Please adjust your parameters and try again. |
| ERR_BAD_TRAFFIC_OPTIONS | options.traffic must be either a number between {{MIN_TRAFFIC}} and {{MAX_TRAFFIC}} or one of the values: 'faster'(default), 'fast', 'normal', 'slow', 'very slow' |
| ERR_VRP_TIMEOUT | Request timed out. Please consider /vrp-long for large requests |
| ERR_PDP_TIMEOUT | Request timed out. Please consider /pdp-long for large requests |
| ERR_LT_ZERO_SQUASH_DURATION | Expecting a number > 0 for squash_durations parameter |
| ERR_REACHED_STOP_LIMIT | Too many stops: maximum {{maxVisits}} stops - please contact [email protected] to request an increase. |
| ERR_REACHED_DAILY_QUOTA | Exceeded daily limit of {{dailyLimit}} - please contact [email protected] |
| ERR_VISIT_DURATION_NOT_NUMBER | Visit '{{id}}': Duration must be a number |
| ERR_VISIT_PRIORITY_OUT_OF_RANGE | Visit '{{id}}': Priority must be a number between {{minValue}} and {{maxValue}} |
| ERR_VISIT_PRIORITY_INVALID_OPTION | Visit '{{id}}': Priority must be one of the following options ({{priorityList}}) |
| ERR_NO_INCOMPATIBLE_TYPES | You don't have any compatible Types. Make sure you've set Types for both stops and drivers. |
| ERR_INCONSISTENT_CAPACITY | Expecting consistent capacity types. They must be either all numbers or all objects. |
| ERR_NO_SINGLE_ROUTE_CAPACITY | Sorry, we cannot find a route for this problem! All visits' are unserved because of their load requirements. |
| ERR_END_EARLIER_THAN_START | Shift-end time cannot be earlier than start time! |
| ERR_UNSERVED_UNKNOWN_VISIT | Unknown visit '{{id}}' in unserved list |
| ERR_PREDICTED_TIMESTAMP_FORMAT | Predicted traffic is not supported with UNIX timestamp input. Please use 'hh:mm' input for times. |
| ERR_DROPOFF_EARLIER_PICKUP | Visit '{{name}}': Dropoff end time cannot be earlier than pickup start time |
| ERR_VISIT_LOAD_NOT_NUMBER | Visit '{{id}}': Load must be a number |
| ERR_VEHICLE_CAPACITY_NOT_NUMBER | Vehicle '{{id}}': Capacity must be a number |
| ERR_VISIT_LOAD_IMPROPER_TYPE | Visit '{{id}}': Load must be a number or a number valued object |
| ERR_VEHICLE_CAPACITY_IMPROPER_TYPE | Vehicle '{{id}}': Capacity must be a number or a number valued object |
| ERR_INVALID_TYPE | Type must be a string, number or an array of strings and numbers |
| ERR_JOB_NOT_FOUND | Job {{jobId}} not found! |
| ERR_VISIT_DURATION_GT_ZERO | All visits' duration must be greater than zero. |
| ERR_FIELD_NOT_BOOLEAN | {{field}}' must be boolean (true or false) |
| ERR_LT_ZERO_MAX_VISIT_LATENESS | max_visit_lateness must be a number and cannot be less than 0 |
| ERR_LT_ZERO_MAX_VEHICLE_OVERTIME | max_vehicle_overtime must be a number and cannot be less than 0 |
| ERR_UNSUPPORTED_GEOCODER_OPTION | Unsupported geocoder option, valid options are: 'google' or 'here' |
| ERR_MIN_VISITS_PER_VEHICLE | We expect a positive integer in options.min_visits_per_vehicle. |
| ERR_BALANCE_AND_MIN_VISITS_PER_VEHICLE_INCOMPATIBLE | options 'visit_balance_coefficient' and 'min_visits_per_vehicle' are not compatible |
| ERR_BALANCE_AND_MIN_VISITS_INCOMPATIBLE | options 'visit_balance_coefficient' and 'min_visits' are not compatible |
| ERR_BALANCE_AND_BALANCE_VISIT_COEFFICIENT_INCOMPATIBLE | options 'balance' and 'visit_balance_coefficient' are not compatible |
| ERR_BALANCE_NOT_A_NUMBER | options: 'visit_balance_coefficient' should be a number |
| ERR_BALANCE_NOT_IN_RANGE | options: 'visit_balance_coefficient' should be in range [0,1] |
| ERR_TIME_BALANCE_NOT_A_BOOLEAN | options: 'time_balance' should be a boolean |
| ERR_UNSUPPORTED_VERSION | feature {{ name }} is only supported on version v1.{{ minVersion }} and higher |