CreateItineraryDirections.graphql

# Creates itinerary directions for between locations in an itinerary manually.
# Can be used to create directions instead of using the Itinerary autoRoute
# method or for where the itinerary is to contain multiple ways to move between
# locations (alternative modes of transport between locations) or to provide
# optional route options that may bypass specific locations in a sequence.

mutation createItineraryDirections(
  $itineraryId: ID!
  $originItineraryLocationId: ID!
  $destinationItineraryLocationId: ID!
  $mode: RouteMode
  $useRouteSearching: Boolean
  $positions: [PositionInput!]
) {
  # use createItineraryDirections to create directions in an itinerary
  createItineraryDirections(
    # Supply the itinerary ID
    itineraryId: $itineraryId
    # Provide the model for directions
    directions: {
      # Provide the route for the directions
      route: {
        segments: [
          # Create segments for each mode. Add additional segments sequentially
          # here as we support modal, e.g. Foot -> Car -> Foot etc. depending on
          # the fidelity of the directions
          {
            # Indicate the mode of transport for this route segment
            mode: $mode
            # Indicate whether we should search for this route
            useRouteSearching: $useRouteSearching
            # Add in positions, such as [{ lon, lat }]
            positions: $positions
          }
        ]
      }
      # Contextualise the directions from origin/destination
      # Origin itinerary location
      originId: $originItineraryLocationId
      # Position under the destination itinerary location
      positionAtEnd: {
        # Destination itinerary location
        parentId: $destinationItineraryLocationId
      }
    }
  ) {
    # Query what was affected as a response
    cascaded {
      created {
        id
        __typename
      }
    }
  }
}