Mutation
Deprecated
New route
Create a new route by using the legacy newRoute mutation. It remains available while you migrate to the createRoute mutation, which calculates charging stops, energy consumption, and drive time with a reorganized schema and per-country operator preferences.
Arguments
input· RequestInputFields
ID· ID· createRoute.Operations can fail. Account for the following error scenarios to handle them correctly. More on errors here.
consumption_exceeded- Provided consumption value for $LOCATION is not valid. The value must be between 0 and $MAXVALUE kwh, or the equivalent in another unit, for this vehicle.
empty_array_not_allowed- Array $NAME should have at least one value.
error_forbidden_message- You are forbidden to execute this operation.
invalid_coordinates- Coordinates provided for $LOCATION are not valid.
invalid_unit- Provided unit type $TYPE for $LOCATION is not valid.
invalid_value- Provided value $VALUE for $LOCATION is not valid. Expected value of type $EXPECTEDTYPE.
negative_value_not_allowed- Negative value for $LOCATION is not allowed.
occupants_above_allowed- Provided number of occupants for $LOCATION is not valid. The value must be less than or equal to $OCCUPANTSCOUNT for this vehicle.
occupants_below_allowed- Provided number of occupants for $LOCATION is not valid. The value must be at least 1.
operation_not_allowed- You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.
operator_both_excluded_and_ranking- Operator $OPERATORID is both in the ranking and excluded lists.
operator_duplicated_in_exclude- Operator $OPERATORID is multiple times in the exclude lists.
operator_duplicated_in_ranking- Operator $OPERATORID is multiple times in the ranking lists.
operator_invalid_ranking- Operator ranking must be between 1 and 10.
operator_not_found- No operator was found with the $OPERATORID ID.
operator_ranking_none_given- The route operator type was set to $ROUTEOPTYPE, but no ranking was provided. Please add an operator to your client or route request.
rate_limit_exceeded- Rate limit exceeded.
route_battery_capacity_above_allowed- The provided battery capacity is too high. The value must be less than or equal to $MAX kwh or the equivalent in another unit.
route_battery_capacity_below_allowed- The provided battery capacity is too small. The value must be greater than or equal to $MIN kwh or the equivalent in another unit.
route_cargo_below_allowed- Provided amount of cargo weight is not valid. The value cannot be negative.
route_consumption_invalid_worst- Provided consumption value for $NAME is not valid. The worst value must be greater than or equal to best value.
route_consumption_total_exceeded- Provided consumption values are not valid. The total must be between 0 and $MAXVALUE for this vehicle.
route_destination_station_and_external_station_not_matching- The destination station for the route requested was not matched with the external station.
route_destination_station_invalid_speed- The provided destination station $STATIONID cannot be used as charging stop. The station does not support DC charging (> 43kW).
route_destination_station_not_found- The destination station for the route requested was not found with the provided ID.
route_destination_station_out_of_service- The provided destination station $STATIONID cannot be used as charging stop. All compatible connectors at this station are out of service.
route_duplicate_amenities- Amenities $DUPLICATEDAMENITIES are duplicated.
route_final_soc_exceeding_battery_capacity- The provided final state of charge is too high. The value must be less than or equal to 80% of the vehicle battery capacity.
route_invalid_amenities- Amenities $INVALIDAMENITIES are not valid. Allowed: $ALLOWEDAMENITIES.
route_invalid_destination_coordinates- The destination coordinates provided are not valid.
route_invalid_origin_coordinates- The origin coordinates provided are not valid.
route_invalid_scheduled_charge_stop_duration- The scheduled charge stop duration is invalid. The value must be between 900 and 86400 seconds.
route_invalid_scheduled_charge_stop_max_distance_from_station- The scheduled charge stop max_distance_from_station is invalid. The value must be between 0 and 1000 meters.
route_invalid_via_coordinates- The via coordinates provided are not valid.
route_max_number_of_passengers_exceeded- Provided number of passengers is not valid. The value must be between 1 and $PASSENGERCOUNT for this vehicle.
route_min_power_below_allowed- The provided minimum power is too small. The value must be greater than 0.
route_origin_station_and_external_station_not_matching- The origin station for the route requested was not matched with the external station.
route_origin_station_not_found- The origin station for the route requested was not found with the provided ID.
route_radius_above_allowed- The radius value is above allowed, the maximum value is 5000 meters.
route_radius_below_allowed- The radius value is below allowed, the minimum value is 500 meters.
route_station_invalid_charger- The provided via station $STATIONID cannot be used as charging stop. The charger standard of the vehicle is not supported.
route_station_invalid_min_power- The minimum power requested is higher than the station could support.
route_station_invalid_speed- The provided via station $STATIONID cannot be used as charging stop. The station does not support DC charging (> 43kW).
route_station_out_of_service- The provided via station $STATIONID cannot be used as charging stop. All compatible connectors at this station are out of service.
route_via_cargo_below_allowed- Provided amount of cargo is not valid. The value must be greater than 0.
route_via_station_and_external_station_not_matching- The via station for the route requested was not matched with the external station.
route_via_station_not_found- The station ID used as a via for the requested route was not found.
soc_exceeding_battery_capacity- The provided state of charge for $LOCATION is too high. The value must be less than or equal to the vehicle battery capacity.
station_destination_coordinates_not_matching- Coordinates [$DESTINATIONCOORDINATES] of destination don't match with station coordinates [$STATIONCOORDINATES].
station_origin_coordinates_not_matching- Coordinates [$ORIGINCOORDINATES] of origin don't match with station coordinates [$STATIONCOORDINATES].
station_via_coordinates_not_matching- Coordinates [$VIACOORDINATES] of via don't match with station coordinates [$STATIONCOORDINATES].
tire_pressure_below_allowed- Provided tire pressure is not valid. The value must be at least 1.
vehicle_freemium_not_allowed- You do not have access to this vehicle. Please upgrade to access this vehicle.
vehicle_type_not_allowed- Vehicle of type $TYPE is not allowed for this operation.
zero_or_negative_value_not_allowed- Zero or negative value for $LOCATION is not allowed.
Was this content helpful?