API Documentation

Welcome to the API Documentation for the Alpaca Travel GraphQL JavaScript SDK for use with Apollo and React.

• See Installation and Getting Started

Collection

• useCreateCollectionLocationMutation Creates an collection location within the provided collection
• useDeleteCollectionLocationMutation Removes a collection location from a collection
• useFindCollectionLocationIdsByExternalQuery Find collection location IDs by external identifiers
• useFindCollectionLocationIdsByTagQuery Find collection location IDs by a specific tag
• useFindCollectionLocationsByExternalQuery Find collection location IDs by an external ID
• useFindCollectionLocationsByTagQuery Find collection locations by a specific tag
• useGetCollectionLocationQuery Obtain informationa bout a collection location
• useGetCollectionQuery Obtains information about a collection
• useListCollectionsQuery Obtain a listing of the collections for a profile
• useUpdateCollectionLocationMutation Update the collection location

Itinerary

• useCreateItineraryDirectionsMutation Creates itinerary directions for between locations in an itinerary manually
• useCreateItineraryLocationMutation Creates a new Itinerary Location, which can contain place information
• useCreateItineraryMutation Creates a new Itinerary data structure for organising an itinerary
• useDeleteItineraryLocationMutation Removes an itinerary location from an itinerary
• useDeleteItineraryMutation Removes an itinerary
• useDisableItineraryAutoRouteMutation Modifies an itinerary to disable the automatic routing feature, which will turn off determining the directions between the sequence of locations that the itinerary contains
• useEnableItineraryAutoRouteMutation Modifies an itinerary to enable a feature that will automatically determine directions between a sequence of itinerary locations at the top level
• useFindItineraryLocationIdsByPlaceIdQuery Checks whether a place has been added to an itinerary, for creating a button state on an "Add to Itinerary" button
• useFindItineraryLocationsByPlaceIdQuery Checks whether a place has been added to an itinerary, for creating a button state on an "Add to Itinerary" button
• useGetItineraryDirectionsQuery Obtains an itinerary directions item
• useGetItineraryLocationQuery Loads information about an itinerary location
• useGetItineraryQuery Loads information about an individual itinerary
• useListItinerariesQuery Query a list of itineraries from an associated profile
• useListItineraryLocationsQuery Lists in itinerary locations for a provided Itinerary
• useMoveItineraryLocationAfterMutation Moves an itinerary location after another itinerary location
• useMoveItineraryLocationToStartMutation Moves an itinerary location ahead of other itinerary locations
• useUpdateItineraryLocationIsOptionalMutation Marks an itinerary location whether it is an optional stop
• useUpdateItineraryLocationMutation Updates the itinerary location
• useUpdateItineraryMutation Updates an itinerary

Media

• useGetMediaImageQuery Loads information about a media

Place

• useAutocompleteSearchPlaceQuery Searches for places using Autocomplete search term
• useGetPlaceQuery Gets a place based on the provided place ID
• useReverseSearchPlaceByPositionQuery Queries a position and returns with matching places

Profile

• useGetProfileQuery Obtains the profile by the provided ID
• useListAuthorizedProfilesQuery Obtains a list of the authorized profiles for the current access token

Route

• useSearchRoutesBetweenPositionsQuery Searches for routes between provided positions