Skip to main content

Travefy API Definitions

When building with the Travefy API, use this glossary of terms and explanations to help with some terminology!

Douglas Brandstetter avatar
Written by Douglas Brandstetter
Updated over 2 weeks ago

Below are some of the terms that will appear in the Travefy Developer Documentation, and an explanation of what those terms are.

  • TripDays: A TripDay represents a day on the itinerary. It may have a date (e.g. 2017/01/24) or may not (e.g. Day 2).

  • TripEvent: A TripEvent is an item on the TripDay

  • TripIdeas: TripIdeas are a collection on a TripEvent and are often establishments or other info that is associated with the TripEvent. For example, the event may be "Beachside Dinner" with a time and reservation info and the idea may be "Shorebird Resturant" with the location, hours, etc. Currently these are completely stand-alone and will not connect with any existing items from the Travefy database or an agent's Content Library. See the Create Full Trip request for an example usage.

    • A trip has TripDays as children. A TripDay has TripEvents as children. A TripEvent has TripIdeas as children

  • "IsProposal": Our Trips have 2 formats: Itinerary and Proposal. Mark IsProposal as True to create a trip with an approval process, mainly for sales or quoting purposes.

  • "IsSupplemental": The Info & Documents section is parameter isSupplemental either true or false. If you set "isSupplemental": false the events you created are placed on a "normal" day. If you set this to true, the events you created are placed in the Info & Documents section.

  • PartnerIdentifier: The PartnerIdentifier field on a Trip can be used to store your identifier on the Trip. For example, if you have a different identifier for the Trip in your database, you can store that here.

  • "IsArchived": To place a trip into the Archive and not in the main view of trips in the Travefy Trips page.

If you're not finding a definition or explanation for something in the developer documentation listed here, please reach out to APIsupport@Travefy.com and we can get that added in.

Did this answer your question?