Query
Route amenity stop
Search for charging stations with amenities at a certain point along a route by using the getRouteStationsWithAmenities query. This is useful when you want to plan a charging stop near restaurants, shops, or other amenities.
Query
A route_id, route_details_id, time_window, and amenity_types are required to search for stations along a route. Both ids can be obtained through the getRoute query. Use the filter argument to narrow the results down based on specific criteria, and the first and after arguments to paginate through them.
Arguments
route_id· ID· requiredroute_details_id· ID· requiredtime_window· RouteTimeWindow· requiredamenity_types· AmenityType· requiredAmenityType enum values
parkrestaurantmuseumcoffeehotelshoppingbathroomsupermarketplaygroundpharmacybakeryconvenience_storefilter· RouteStationsWithAmenityFilterfirst· Intafter· StringFields
total_count· Intpage_info· PageInfonodes· RouteStationWithAmenitiesOperations can fail. Account for the following error scenarios to handle them correctly. More on errors here.
maximum_distance_from_path_above_allowed- Provided maximum distance from path is not valid. The value must be less than or equal to 10 000 meters or an equivalent unit.
maximum_distance_from_station_above_allowed- Provided maximum distance from station is not valid. The value must be less than or equal to 1000 meters or an equivalent unit.
pagination_invalid_after- The cursor provided in $LOCATION is invalid.
pagination_invalid_first- The page size indicated in $LOCATION must value between 1 and $SIZE.
route_amenities_expired- This route has expired for this type of search. To ensure data accuracy, routes older than 24 hours cannot be used. Please create a new route and try again.
route_amenities_invalid_status- Cannot search stations and amenities in a route with status [object Object].
route_not_found- No route was found with the provided ID.
time_window_exceeds_route_duration- The specified time window center takes place after the estimated arrival time. All center times must take place between the estimated departure and arrival time.
time_window_margin_above_allowed- Provided time window margin is not valid. The value must be less than or equal to 45 minutes or an equivalent unit.
zero_or_negative_value_not_allowed- Zero or negative value for $LOCATION is not allowed.
Was this content helpful?