--- title: "Starts a pricing and extras check using the criteria provided." method: POST path: "/pricingextras/{searchId}/{searchKey}" tags: ["BookingFlow"] --- # Starts a pricing and extras check using the criteria provided. `POST /pricingextras/{searchId}/{searchKey}` ## Path parameters - `searchId` integer, required - `searchKey` string, required ## Query parameters - `interactSession` string - `accommodation` string ## Request body - SelectionCriteria — Selection criteria class. - `previousStage` 1 | 2 | 3 | 4 | 5 | 6 | 7 — Enumerator defining booking stages:
1=Search, 2=GetInformation, 3=PricingAndExtras, 4=Reserve, 5=Pay, 6=Book, 7=Cancel - `previousStepId` integer, nullable — Optional previous step identifier (only for multi-city package searches) - `previousSID` string, nullable — Optional previous step identifier (only for multi-city package searches) - `returnUpsells` ProductTypes[], nullable — Flag to trigger product upsells in the response - `isUpsell` boolean — Flags that the selection is an upsell product - `orderRef` string, nullable — Optional order reference for maintaining an existing basket (ADVANCED USE ONLY - DO NOT USE WITHOUT PERMISSION FROM TRAVELGENIX) - `flight` FlightSelectionItem — Flight selection item. - `rid` string, required — Result ID (RID) from search stage. - `riDs` string[], nullable — Array of Route IDs. - `routes` FlightRouteSelectionItem[], nullable — Array of route selections (required for PricingAndExtras and Reserve). - `rid` string, required — Route ID (RID). - `extras` ExtraSelectionItem[], nullable — Array of optional route extras required - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `extras` ExtraSelectionItem[], nullable — Array of optional extras required - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `travellers` TravellerData[], nullable — Array of travellers for the flight booking (required for Reserve). - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `accommodation` AccommodationSelectionItem — Accommodation selection item class. - `rid` string, required — Result ID (RID) from search stage. - `sessionRef` string, nullable — Optional search session for linking searches - `selectionDate` string, date-time, nullable — Alternative selection date used for flexible dynamic packaging (only pass in for DP searches) - `flightArrival` string, date-time, nullable — Flight arrival date time (only pass in for DP searches) - `units` AccommodationUnitSelection[], nullable — Array of units (required for PricingAndExtras and Reserve). - `uid` string, required — Unit ID (UID). - `rid` string, required — Rate ID (RID). - `qty` integer, required — Quantity of unit required. - `extras` ExtraSelectionItem[], nullable — Array of optional extras required - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `questionAnswers` QuestionAnswer[], nullable — Array of question answers (required for Reserve if accommodation has required questions). - `qid` integer — Question Identifier. - `answer` string, nullable — Answer to question. - `guests` TravellerData[], nullable — Array of guests for the accommodation booking (required for Reserve). - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `package` PackageSelectionItem — Package selection item class. - `rid` string, required — Result ID (RID) from search stage. - `fltRID` string, nullable — Optional flight option RID (if selecting a different flight from getinfo stage). - `selectionDate` string, date-time, nullable — Alternative selection date used for flexible dynamic packaging - `units` AccommodationUnitSelection[], nullable — Array of units (required for PricingAndExtras and Reserve). - `uid` string, required — Unit ID (UID). - `rid` string, required — Rate ID (RID). - `qty` integer, required — Quantity of unit required. - `extras` ExtraSelectionItem[], nullable — Array of optional extras required - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `guests` TravellerData[], nullable — Array of guests for the accommodation booking (required for Reserve). - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `promoCode` string, nullable — Optional supplier promo code (if supported by supplier) - `tour` TourSelectionItem — Tour selection item class. - `rid` string, required — Result ID (RID) from search stage. - `did` string, required — Date Option ID (DID) from search stage. - `travellers` TravellerData[], nullable — Array of travellers for the tour booking. - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `ticket` TicketSelectionItem — Ticket selection item class. - `rid` string, required — Result ID (RID) from search stage. - `pickupPointID` integer, nullable — Optional pickup point identifier - `options` TicketOptionSelection[], nullable — Array of options. - `oid` string, required — Option ID. - `qty` integer, required — Quantity required. - `dateOption` string, date-time, nullable — Optional date selection. - `subOptions` TicketOptionSelection[], nullable — Optional SubOption selections. - `extras` ExtraSelectionItem[], nullable — Optional Extras selections. - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `questionAnswers` QuestionAnswer[], nullable — Array of question answers (required for Reserve if ticket has required questions). - `qid` integer — Question Identifier. - `answer` string, nullable — Answer to question. - `travellers` TravellerData[], nullable — Array of travellers for the ticket booking. - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `transfer` TransferSelectionItem — Transfer selection item - `rid` string, required — Result ID (RID) from search stage - `extras` ExtraSelectionItem[], nullable — Array of optional extras required - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `questionAnswers` QuestionAnswer[], nullable — Array of question answers (required for Reserve if transfer has required questions). - `qid` integer — Question Identifier. - `answer` string, nullable — Answer to question. - `travellers` TravellerData[], nullable — Array of travellers for the transfer booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `carRental` CarRentalSelectionItem — Car rental selection item - `rid` string, required — Result ID (RID) from search stage. - `pid` string, nullable — Package ID (PID) from search stage (required for PricingAndExtras and Reserve). - `extras` ExtraSelectionItem[], nullable — Array of optional extras required - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `questionAnswers` QuestionAnswer[], nullable — Array of question answers (required for Reserve if car rental has required questions). - `qid` integer — Question Identifier. - `answer` string, nullable — Answer to question. - `driver` TravellerData — Data about a specific traveller/passenger/guest. - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `additionalDriver` TravellerData — Data about a specific traveller/passenger/guest. - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `insurance` InsuranceSelectionItem — Insurance selection item - `rid` string, required — Result ID (RID) from search stage - `extras` ExtraSelectionItem[], nullable — Array of optional extras required - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `questionAnswers` QuestionAnswer[], nullable — Array of question answers (required for Reserve if insurance has required questions). - `qid` integer — Question Identifier. - `answer` string, nullable — Answer to question. - `travellers` TravellerData[], nullable — Array of travellers for the insurance booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `airportExtras` AirportExtrasSelectionItem[], nullable — Array of airport extras selection items (you may select more than one airport extra, for example airport parking and lounges). - `rid` string, required — Result ID (RID) from search stage. - `pid` string, nullable — Package ID (PID) from search stage. - `questionAnswers` QuestionAnswer[], nullable — Array of question answers (required for Reserve if airport extra has required questions). - `qid` integer — Question Identifier. - `answer` string, nullable — Answer to question. - `travellers` TravellerData[], nullable — Array of travellers for the airport extras booking (required for Reserve). - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `extras` ExtraSelectionItem[], nullable — Array of extras selection items (you may select more than one extra). - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `multiCity` MultiCitySelectionItem — Multi-city selection item - `stepExtras` object, nullable — List of extras selections for each step - `travellers` TravellerData[], nullable — Array of participants for the booking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `contactInfo` ContactInformation — Contact details for the booking - `internalRef` string, nullable — Internal CRM reference - `emailAddress` string, nullable — Email address - `acceptMarketing` boolean — Accept or sign up for marketing - `acceptTerms` boolean — Accept terms and conditions - `telephone` PhoneNumber — Phone number details - `type` 1 | 2 | 3 | 4 — Enumerator defining phone types:
1=Generic, 2=Mobile, 3=Home, 4=Office - `countryPrefix` string, nullable — Country prefix (e.g. 44) - `number` string, nullable — Phone number - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, nullable — Billing firstname - `surname` string, nullable — Billing surname - `company` string, nullable — Billing company name - `address1` string, nullable — Billing address 1 - `address2` string, nullable — Billing address 2 - `city` string, nullable — Billing city or town - `state` string, nullable — Billing county or state - `postalCode` string, nullable — Billing postal or zip code - `countryCode` string, nullable — Billing 2-letter country code - `specialRequests` string, nullable — Optional special requests that may be sent to the supplier but cannot be guaranteed - `depositOptionID` integer, nullable — Selected deposit option identifier ## Response `200` OK - APIResponse — Model defining the standard API response. - `success` boolean — Indicator as to whether API request was successful. - `version` integer, nullable — API method version (for information only) - `errors` string[], nullable — Returns a list of errors if success is returned as false. - `info` string, nullable — Generic information (should not be dislayed to end user or used - informational purposes only). - `interactSession` string, nullable — Customer interaction session. This should be cookied for 365-days for an individual customerand is used for personalisation features. - `searchSession` string, nullable — Search session identifier which is used throughout a booking journey (e.g. id/guid). - `humanReadableSearchRef` string, nullable — A human-readable search identifier and can be shown to the end user for telephone enquiries about the current search (can be used by agents to look up the search in admin console) - `shareUrl` string, nullable — A sharing URL for this search - `deeplinkUrl` string, nullable — A deeplink URL for this search normally used for abandoned basket email tracking - `orderRefDisplay` string, nullable — Order reference for displaying to customer. - `orderRef` string, nullable — Order reference for maintaining a basket (e.g. id/guid). - `orderCanAmend` boolean, nullable — Defines if an order can be amended - `hasPreConfirmUrl` boolean, nullable — Defines if an order has a pre-confirmation URL (eg. Ryanair) - `dedupe` boolean, nullable — Flag to inform front end that it needs to deduplicate results - `total` integer, nullable — Total number of suppliers/threads initiated on the booking flow step. - `completed` integer, nullable — Number of completed suppliers/threads initiated on the booking flow step. - `data` unknown - `trackingCode` string, nullable — Tracking code (if present) - `specialRequests` string, nullable — Special requests - `member` MemberAccount — Model defining a member account - `id` integer — Client id - `scope` 1 | 2 — Enumerator defining member types:
1=AppUser, 2=Customer - `passwordHash` string, nullable — Password hash - `passwordSalt` string, nullable — Password salt - `email` string, nullable — Email address - `emailConfirmed` boolean — Email address is confirmed - `whatsAppNumber` string, nullable — Email address - `whatsAppConfirmed` boolean — Email address is confirmed - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, nullable — Firstname - `surname` string, nullable — Surname - `permissions` string[], nullable — Array of permissions - `acceptMarketing` boolean, nullable — Accept or sign up for marketing - `currencyCode` string, nullable — Currency code - `language` string, nullable — Language code - `boRef` string, nullable — Backoffice reference - `bio` string, nullable — Optional profile bio - `created` string, date-time — Created date time - `telephones` AccountPhoneNumber[], nullable — Array of telephone numbers - `id` integer — Record identifier (set to 0 to add new phone number) - `type` 1 | 2 | 3 | 4 — Enumerator defining phone types:
1=Generic, 2=Mobile, 3=Home, 4=Office - `countryPrefix` string, nullable — Country prefix - `number` string, nullable — Phone number - `isPrimary` boolean — Primary phone number flag - `addresses` AccountAddress[], nullable — Array of addresses - `id` integer — Record identifier (set to 0 to add new address) - `name` string, nullable — Friendly name of address (eg. Home) - `company` string, nullable — Company name - `line1` string, nullable — Address line 1 - `line2` string, nullable — Address line 2 - `city` string, nullable — Address town or city - `state` string, nullable — Address county or state - `postalCode` string, nullable — Address postal code - `countryCode` string, nullable — Address country code - `isPrimary` boolean — Primary phone number flag - `giftVouchers` GiftVoucher[], nullable — Array of gift vouchers - `id` integer — Internal identifier - `code` string, nullable — Voucher code - `name` string, nullable — Name - `startDate` string, date-time, nullable — Optional start date - `expiryDate` string, date-time, nullable — Optional expiry date - `currency` string, nullable — Currency code - `balance` number, double — Remaining balance - `additionalData` object, nullable — Additional data such as custom questions and answers - `numOrders` integer — Number of orders placed - `ordersTotalSpend` number, double — Total order spend - `companyId` integer, nullable — Company identifier for B2B customers - `companyName` string, nullable — Company name for B2B customers - `companyABTA` string, nullable — Company ABTA number for B2B customers - `companyIATA` string, nullable — Company IATA number for B2B customers - `companyCommissionInfo` string, nullable — Company commission information for B2B customers - `companyLogoUrl` string, nullable — Company logo url for B2B customers - `membershipId` integer, nullable — Membership level of customer - `membershipPrice` number, double, nullable — Membership level price - `membershipName` string, nullable — Name of membership level - `rewardMemberPrice` boolean — Setting to give member pricing to customer - `subscriptionID` string, nullable — Membership level subscription identifier - `companyCreditLimit` AccountCreditLimit — Account credit limit model - `creditAmount` number, double — Amount of credit available - `remainingAmount` number, double — Amount of credit remaining - `currency` string, nullable — Currency of credit limit - `isNewAccount` boolean — Is a newly-created account - `searchCriteria` SearchCriteria — Search criteria class. - `environment` 0 | 1 | 2 | 3 | 4 — Enumerator defining sales environment used for booking:
0=Website, 1=MobileWebsite, 2=AgentTool, 3=MobileApp, 4=MetaChannel - `searchType` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15, required — Enumerator defining type of search:
1=Flights, 2=Accommodation, 3=Packages, 4=TicketsAttractions, 5=Transfers, 6=AirportExtras, 7=Insurance, 8=CarRental, 9=Visas, 10=Tours, 11=DynamicPackaging, 12=CustomExtra, 13=Cruise, 14=TicketAccommodation, 15=TicketAccommodationFlight - `language` string, required — ISO639-1 2-letter language code (e.g. en). - `locale` string, nullable — Locale for formatting based on the language (optional, will be set internally if not set) - `currency` string, required — ISO4217 3-letter currency code (e.g. GBP). - `distanceUnit` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `nationality` string, required — ISO3166 2-letter nationality country code (e.g. GB). - `customerIP` string, required — IPv4 or IPv6 of the end customer browser. - `customerUserAgent` string, required — User agent string of the end customer browser, or if server-to-server provide your application name and version (e.g. MyAppName/v1.0). - `customerCountry` string, nullable — ISO3166 2-letter country code of where the customer is located (optional, will be set internally if not set) - `source` object, nullable — Source data can be used to track any source data for linking to a booking - `originListId` integer, nullable — Origin list identifier - `destinationListId` integer, nullable — Destination list identifier - `tripType` 0 | 1 | 2 — Enumerator defining type of trip customer is taking:
0=Unspecified, 1=Personal, 2=Business - `flightSearchCriteria` FlightSearchCriteria — Flight search criteria. - `preferredCabinClass` 0 | 1 | 2 | 3 | 4 — Enumerator defining airline cabin classes:
0=Any, 1=Economy, 2=PremiumEconomy, 3=Business, 4=First - `directPreferred` boolean — Indicates whether the customer prefers direct flight results over those that may stop on route (indirect flights are normally cheaper in price). Customer may still get indirect results back, but direct will be prioritised. - `freeBaggageOnly` boolean — Indicates whether the customer wants only flights with free checked-in baggage allowance included (may exclude some cheaper fares) - `flexibleDates` boolean — Indicates whether the travel dates are flexible (normally +/-3 days) - `carrier` string, nullable — Optional 2-letter airline carrier to return. - `legs` FlightLeg[], nullable — Array of flight legs (minimum 1 leg, maximum of 6). - `originCode` string, required — 3-letter IATA airport or city code - `originName` string, nullable — Optional origin name to show on results pages. If not specified, the platform will assign this based on the origin code specified in the search. - `destinationCode` string, required — 3-letter IATA airport or city code - `destinationName` string, nullable — Optional destination name to show on results pages. If not specified, the platform will assign this based on the destination code specified in the search. - `departDate` string, date-time — Departure date of flight leg (YYYY-MM-DD) - `timePreference` 0 | 1 | 2 | 3 | 4 — Enumerator defining a time preference:
0=Any, 1=Early, 2=Morning, 3=Afternoon, 4=Evening - `passengers` TravellerCriteria[], nullable — Array of flight passengers (minimum 1 passenger, maximum of 40). - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `supplierIDs` integer[], nullable — Optional array of supplier ids to search (speak to account manager for a list of valid ids) - `railSearchCriteria` RailSearchCriteria — Rail search criteria. - `originCode` string, required — Origin rail station CRS code - `originName` string, nullable — Optional origin name to show on results pages. If not specified, the platform will assign this based on the origin code specified in the search. - `destinationCode` string, required — Destination rail station CRS code - `destinationName` string, nullable — Optional destination name to show on results pages. If not specified, the platform will assign this based on the destination code specified in the search. - `departDateTime` string, date-time — Departure date and time (YYYY-MM-DDTHH:mm) - `returnDateTime` string, date-time, nullable — Optional return date and time (YYYY-MM-DDTHH:mm) - `passengers` TravellerCriteria[], nullable — Array of rail passengers (minimum 1 passenger, maximum of 40). - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `preferredCabinClass` 0 | 1 | 2 | 3 | 4 — Enumerator defining airline cabin classes:
0=Any, 1=Economy, 2=PremiumEconomy, 3=Business, 4=First - `accommodationSearchCriteria` AccommodationSearchCriteria — Accommodation search criteria. - `locations` AccommodationSearchLocation[], nullable — Optional array of accommodation search locations (THIS FEATURE IS NOT ENABLED BY DEFAULT - SPEAK TO TRAVELGENIX) - `latitude` number, double, required — Latitude of the accommodation search area. - `longitude` number, double, required — Longitude of the accommodation search area. - `radius` integer, required — Accommodation search radius around the latitude/longitude. - `locationType` 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of a geographical place:
1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port - `locationName` string, nullable — Optional location name to show on results pages. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `locationCountry` string, nullable — Optional location country code. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `latitude` number, double, nullable — Latitude of the accommodation search area. - `longitude` number, double, nullable — Longitude of the accommodation search area. - `radius` integer, nullable — Accommodation search radius around the latitude/longitude. - `locationID` string, nullable — Optional Travelify Location ID for the accommodation search (required if you want to use polygon searching). - `locationType` 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of a geographical place:
1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port - `locationName` string, nullable — Optional location name to show on results pages. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `locationCountry` string, nullable — Optional location country code. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `ref` string, nullable — Optional property reference for searching an individual property - `feature` string, nullable — Optional property feature - `checkinDate` string, date-time, required — Checkin date of accommodation stay (YYYY-MM-DD). - `checkoutDate` string, date-time, required — Checkout date of accommodation stay (YYYY-MM-DD). - `boardBasis` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 — Enumerator defining accommodation board basis:
0=Any, 1=RoomOnly, 2=SelfCatering, 3=BedAndBreakfast, 4=DinnerBedBreakfast, 5=HalfBoard, 6=FullBoard, 7=AllInclusive, 8=AllInclusivePlus, 9=CateredChalet, 10=AssistedChalet, 11=ManagedChalet, 12=FullBoardPlus, 13=CateredLodge, 14=Mixed, 15=BedAndDinner, 16=BedAndLunch, 17=BedAndMeal, 18=MealPlan, 19=MealPlanPlus - `propertyType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 — Enumerator defining type of property:
0=Any, 1=Unknown, 2=Hotel, 3=Apartment, 4=Villa, 5=House, 6=Boat, 7=Yacht, 8=Bungalow, 9=Chalet, 10=Farmhouse, 11=Guesthouse, 12=CastleMansion, 13=Camping, 14=Hostel, 15=ApartHotel, 16=Resort, 17=Cottage, 18=VacationHome - `minStarRating` number, double — Minimum star rating for properties (default is 0). - `refundableOnly` boolean — Only return refundable rates, where available from supplier (default is false). - `propertyName` string, nullable — Optional property name match (matches partial) - `rooms` RoomOccupancy[], nullable — Array of room occupancies. - `typePreference` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — Enumerator defining type of room:
0=Any, 1=Unknown, 2=Single, 3=Twin, 4=Double, 5=Triple, 6=Family, 7=Shared, 8=Apartment, 9=Villa, 10=Suite, 11=Queen, 12=King - `guests` TravellerCriteria[], nullable — Array of guests in room. - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `supplierIDs` integer[], nullable — Optional array of supplier ids to search (speak to support for a list of valid ids) - `tourSearchCriteria` TourSearchCriteria — Tour search criteria. - `latitude` number, double, required — Latitude of the tour search area - `longitude` number, double, required — Longitude of the tour search area - `radius` integer, required — Tour search radius around the latitude/longitude - `startDateMin` string, date-time, required — Minimum start date of the tour search - `startDateMax` string, date-time, required — Maximum start date of the tour search - `durationMin` integer, required — Minimum tour duration in days - `durationMax` integer, required — Maximum tour duration in days - `ticketSearchCriteria` TicketSearchCriteria — Ticket search criteria. - `ticketType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 — Enumerator defining ticket or event types:
0=Any, 1=Attraction, 2=Event, 3=Theatre, 4=Exhibition, 5=Classes, 6=Sports, 7=CityPass, 8=Tours, 9=Music, 10=Conference, 11=Experience, 12=Museum, 13=Activity, 14=Culinary, 15=Cruise, 16=ArtAndHistory, 17=ThemePark, 18=Combination, 19=Transport - `latitude` number, double, required — Latitude of the ticket search area - `longitude` number, double, required — Longitude of the ticket search area - `radius` integer, required — Ticket search radius around the latitude/longitude - `locationName` string, nullable — Optional location name to show on results pages. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `startDate` string, date-time, required — Start date of the ticket search - results will be returned for tickets/events between the date range - `endDate` string, date-time, required — End date of the ticket search - results will be returned for tickets/events between the date range - `ref` string, nullable — Optional event reference for searching an individual event - `participants` TravellerCriteria[], nullable — Array of participants - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `isUpsell` boolean — Defines if search criteria is an upsell request - `supplierIDs` integer[], nullable — Optional array of supplier ids to search (speak to support for a list of valid ids) - `carRentalSearchCriteria` CarRentalSearchCriteria — Car rental search criteria. - `pickupLatitude` number, double, required — Latitude of the pickup location - `pickupLongitude` number, double, required — Longitude of the pickup location - `pickupOnAirportPreferred` boolean — Option to prefer the pickup location to be on airport (e.g. if packaging with a flight) - `pickupAirportTerminal` string, nullable — Optional pickup terminal (if on airport) - `outboundFlightNo` string, nullable — Optional outbound flight number - `pickupLocationName` string, nullable — Optional pickup location name to show on results pages. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `dropoffLatitude` number, double, required — Latitude of the dropoff location - may be the same as the pickup location - `dropoffLongitude` number, double, required — Longitude of the dropoff location - may be the same as the pickup location - `dropoffOnAirportPreferred` boolean — Option to prefer the dropoff location to be on airport (e.g. if packaging with a flight) - `dropoffAirportTerminal` string, nullable — Optional dropoff terminal (if on airport) - `returnFlightNo` string, nullable — Optional return flight number - `dropoffLocationName` string, nullable — Optional dropoff location name to show on results pages. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `startDateTime` string, date-time, required — Date and time to pick up the vehicle - `endDateTime` string, date-time, required — Date and time to dropoff/return the vehicle - `driverAge` integer, required — Age of driver at time of pickup (some rental companies may charge a young driver surcharge) - `sippCode` string, nullable — Optional SIPP code (not recommended as different suppliers have different fleets) - `promos` PromoData[], nullable — Optional array of car rental promo codes the customer may possess to obtain discounts - `companyCode` string, nullable — IATA/Industry-recognised company code for this promo (e.g. airline IATA code). - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 — Enumerator defining type of promotion:
0=Unknown, 1=Coupon, 2=Discount, 3=IATA, 4=FrequentFlyer, 5=Membership, 6=Supplier, 7=Rate - `reference` string, nullable — Promo reference/id/code as provided by the company. - `surname` string, nullable — Optional surname of the promotion owner - must match the membership company database or it could be rejected. - `isUpsell` boolean — Defines if search criteria is an upsell request - `supplierIDs` integer[], nullable — Optional array of supplier ids to search (speak to support for a list of valid ids) - `transferSearchCriteria` TransferSearchCriteria — Transfer search criteria. - `point1Latitude` number, double, required — Point 1 (origin) latitude - `point1Longitude` number, double, required — Point 1 (origin) longitude - `point1Name` string, required — Point 1 (origin) name (e.g. pickup address/hotel name) - `point1CountryCode` string, required — Point 1 (origin) country code - `point2Latitude` number, double, required — Point 2 (destination) latitude - `point2Longitude` number, double, required — Point 2 (destination) longitude - `point2Name` string, required — Point 2 (destination) name (e.g. dropoff address/hotel name) - `point2CountryCode` string, required — Point 2 (destination) country code - `outPickupDateTime` string, date-time, required — Outbound journey pickup date/time (YYYY-MM-DDTHH:MM) - `returnPickupDateTime` string, date-time, nullable — Optional return journey pickup date/time - leave blank for one-way transfers (YYYY-MM-DDTHH:MM) - `isUpsell` boolean — Defines if search criteria is an upsell request - `isCoach` boolean — ADVANCED USE ONLY - Search for coaches only (set to false or not at all for normal transfer searches) - `passengers` TravellerCriteria[], nullable — Array of travelling passengers - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `additionalCriteria` TransferAdditionalCriteria — Transfer additional search criteria. - `originAirport` string, nullable — Origin airport code (optional, only if flying) - `destinationAirport` string, nullable — Destination airport code (optional, only if flying) - `outTerminal` string, nullable — Outbound flight terminal (optional, only if flying) - `outCarrier` string, nullable — Outbound flight carrier (optional, only if flying) - `outFlightNo` string, nullable — Outbound flight number (optional, only if flying) - `outArrivalDateTime` string, date-time, nullable — Outbound flight arrival date/time (optional, only if flying) - `retTerminal` string, nullable — Return flight terminal (optional, only if flying) - `retCarrier` string, nullable — Return flight carrier (optional, only if flying) - `retFlightNo` string, nullable — Return flight number (optional, only if flying) - `retDepartureDateTime` string, date-time, nullable — Return flight departure date/time (optional, only if flying) - `propertyName` string, nullable — Property name (optional) - `propertyAddress` string, nullable — Property address (optional) - `propertyCity` string, nullable — Property city (optional) - `propertyCity2` string, nullable — Property alternative city (optional) - `propertyPostalCode` string, nullable — Property postal code (optional) - `interRouteOriginAirport` string, nullable — ADVANCED USE ONLY: For inter-route transfers origin airport code - `interRouteDestAirport` string, nullable — ADVANCED USE ONLY: For inter-route transfers destination airport code - `supplierIDs` integer[], nullable — Optional array of supplier ids to search (speak to support for a list of valid ids) - `airportExtrasSearchCriteria` AirportExtrasSearchCriteria — Airport extras search criteria. - `extraType` 0 | 1 | 2 | 3 | 4 | 5 — Enumerator defining type of airport extra:
0=Any, 1=Lounge, 2=Parking, 3=Hotel, 4=HotelWithParking, 5=FastTrack - `extraTypes` AirportExtraTypes[], nullable — Optional array of extra types to search (only used if ExtraType set to Any) - `originCode` string, required — 3-letter IATA airport code of departure point - `originName` string, nullable — Optional origin airport name to show on results pages. If not specified, the platform will assign this based on the origin code specified in the search. - `originTerminal` string, nullable — Optional origin terminal - `destinationCode` string, required — 3-letter IATA airport code of destination point - `destinationName` string, nullable — Optional destination airport name to show on results pages. If not specified, the platform will assign this based on the destination code specified in the search. - `destinationTerminal` string, nullable — Optional destination terminal - `outboundFlightDateTime` string, date-time, required — Outbound flight departure date/time (YYYY-MM-DDTHH:MM) - `outboundFlightNo` string, nullable — Optional outbound flight number - if specified it may be used to establish which terminal the customer is flying from and return products specific to that terminal - `returnFlightDepartDateTime` string, date-time, nullable — Optional return flight departure date/time - required for lounges on return journey (at destination airport) (YYYY-MM-DDTHH:MM) - `returnFlightArrivalDateTime` string, date-time, nullable — Optional return flight arrival date/time - required for parking and hotels with parking included (YYYY-MM-DDTHH:MM) - `returnFlightNo` string, nullable — Optional return flight number - if specified it may be used to establish which terminal the customer is flying from and return products specific to that terminal - `isUpsell` boolean — Defines if search criteria is an upsell request - `passengers` TravellerCriteria[], nullable — Array of travelling passengers - required for lounges, hotels and fasttrack, not required for parking - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `supplierIDs` integer[], nullable — Optional array of supplier ids to search (speak to support for a list of valid ids) - `packageHolidaySearchCriteria` PackageHolidaySearchCriteria — Package holiday search criteria. - `originCode` string, required — 3-letter IATA airport code of departure point - `originName` string, nullable — Optional origin name to show on results pages. If not specified, the platform will assign this based on the origin code specified in the search. - `latitude` number, double, required — Latitude of the package holiday search area. - `longitude` number, double, required — Longitude of the package holiday search area. - `radius` integer, required — Package holiday search radius around the latitude/longitude. - `locationType` 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of a geographical place:
1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port - `locationName` string, nullable — Optional location name to show on results pages. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `propertyName` string, nullable — Optional property name - `ref` string, nullable — Optional property reference for searching an individual property - `destinationCode` string, required — 3-letter IATA airport code of destination point - `departDate` string, date-time, required — Departure date/time (YYYY-MM-DD) - `flexibility` integer — Flexibility days (plus/minus departure date) - `nights` integer, nullable — Number of nights for holiday - `boardBasis` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 — Enumerator defining accommodation board basis:
0=Any, 1=RoomOnly, 2=SelfCatering, 3=BedAndBreakfast, 4=DinnerBedBreakfast, 5=HalfBoard, 6=FullBoard, 7=AllInclusive, 8=AllInclusivePlus, 9=CateredChalet, 10=AssistedChalet, 11=ManagedChalet, 12=FullBoardPlus, 13=CateredLodge, 14=Mixed, 15=BedAndDinner, 16=BedAndLunch, 17=BedAndMeal, 18=MealPlan, 19=MealPlanPlus - `minStarRating` number, double — Minimum star rating for properties (default is 0). - `cabinClass` 0 | 1 | 2 | 3 | 4 — Enumerator defining airline cabin classes:
0=Any, 1=Economy, 2=PremiumEconomy, 3=Business, 4=First - `rooms` RoomOccupancy[], nullable — Array of room occupancies. - `typePreference` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — Enumerator defining type of room:
0=Any, 1=Unknown, 2=Single, 3=Twin, 4=Double, 5=Triple, 6=Family, 7=Shared, 8=Apartment, 9=Villa, 10=Suite, 11=Queen, 12=King - `guests` TravellerCriteria[], nullable — Array of guests in room. - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `supplierIDs` integer[], nullable — Optional array of supplier ids to search (speak to support for a list of valid ids) - `visaSearchCriteria` VisaSearchCriteria — Visa search criteria. - `residency` string, required — ISO 3166 2-letter country code of residency of customer (e.g. GB) - `country` string, required — ISO 3166 2-letter country code of destination (e.g. US) - `insuranceSearchCriteria` InsuranceSearchCriteria — Insurance search criteria. - `residency` string, required — ISO 3166 2-letter country code of residency of customer (e.g. GB) - `quoteType` 1 | 2 | 3 | 4, required — Enumerator defining insurance types:
1=SingleTrip, 2=Backpacker, 3=AnnualMultiTrip, 4=Cancellation - `coverType` 1 | 2 | 3 | 4, required — Enumerator defining insurance cover types:
1=Individual, 2=Couple, 3=Family, 4=SingleParent - `region` string, required — ISO 3166 2-letter country code for cover (for annual or multitrip policies this defines the region of cover) - `startDate` string, date-time, required — Date for the start of insurance cover - `endDate` string, date-time, nullable — Date for the end of insurance cover (only set for single trip cover) - `travellers` TravellerCriteria[], nullable — Array of travelling passengers - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `inclusions` InsuranceInclusionTypes[], nullable — Array of any optional inclusions required - `isUpsell` boolean — Defines if search criteria is an upsell request - `additionalCriteria` ExtrasAdditionalCriteria — Extras additional search criteria. - `flightSupplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `originAirport` string, nullable — Origin airport code (optional, only if flying) - `originCountryCode` string, nullable — Origin airport country code (optional, only if flying) - `destinationAirport` string, nullable — Destination airport code (optional, only if flying) - `operatingCarrier` string, nullable — Airline operating carrier code (optional, only if flying) - `marketingCarrier` string, nullable — Airline marketing carrier code (optional, only if flying) - `cabinClass` 0 | 1 | 2 | 3 | 4 — Enumerator defining airline cabin classes:
0=Any, 1=Economy, 2=PremiumEconomy, 3=Business, 4=First - `tourOperator` string, nullable — Tour operator (optional, only if package holiday) - `accommSupplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `propertyName` string, nullable — Property name (optional) - `propertyType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 — Enumerator defining type of property:
0=Any, 1=Unknown, 2=Hotel, 3=Apartment, 4=Villa, 5=House, 6=Boat, 7=Yacht, 8=Bungalow, 9=Chalet, 10=Farmhouse, 11=Guesthouse, 12=CastleMansion, 13=Camping, 14=Hostel, 15=ApartHotel, 16=Resort, 17=Cottage, 18=VacationHome - `propertyRating` number, double, nullable — Property star rating (optional) - `propertyChain` string, nullable — Property chain (optional) - `propertyBoard` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 — Enumerator defining accommodation board basis:
0=Any, 1=RoomOnly, 2=SelfCatering, 3=BedAndBreakfast, 4=DinnerBedBreakfast, 5=HalfBoard, 6=FullBoard, 7=AllInclusive, 8=AllInclusivePlus, 9=CateredChalet, 10=AssistedChalet, 11=ManagedChalet, 12=FullBoardPlus, 13=CateredLodge, 14=Mixed, 15=BedAndDinner, 16=BedAndLunch, 17=BedAndMeal, 18=MealPlan, 19=MealPlanPlus - `propertyCheckout` string, date-time, nullable — Property checkout date/time - `carRentalSupplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `transferSupplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `searchLocation` string, nullable — Original search location (optional) - `countryCode` string, nullable — Country code - `price` number, double — Total selling price - `extrasSearchCriteria` ExtrasSearchCriteria — Extras search criteria. - `latitude` number, double, required — Latitude of the extras search area - `longitude` number, double, required — Longitude of the extras search area - `radius` integer, required — Extras search radius around the latitude/longitude - `locationName` string, nullable — Optional location name to show on results pages. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `startDate` string, date-time, required — Start date of the extras search - results will be returned for extras between the date range - `endDate` string, date-time, required — End date of the extras search - results will be returned for extras between the date range - `participants` TravellerCriteria[], nullable — Array of participants - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `isUpsell` boolean — Defines if search criteria is an upsell request - `additionalCriteria` ExtrasAdditionalCriteria — Extras additional search criteria. - `flightSupplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `originAirport` string, nullable — Origin airport code (optional, only if flying) - `originCountryCode` string, nullable — Origin airport country code (optional, only if flying) - `destinationAirport` string, nullable — Destination airport code (optional, only if flying) - `operatingCarrier` string, nullable — Airline operating carrier code (optional, only if flying) - `marketingCarrier` string, nullable — Airline marketing carrier code (optional, only if flying) - `cabinClass` 0 | 1 | 2 | 3 | 4 — Enumerator defining airline cabin classes:
0=Any, 1=Economy, 2=PremiumEconomy, 3=Business, 4=First - `tourOperator` string, nullable — Tour operator (optional, only if package holiday) - `accommSupplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `propertyName` string, nullable — Property name (optional) - `propertyType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 — Enumerator defining type of property:
0=Any, 1=Unknown, 2=Hotel, 3=Apartment, 4=Villa, 5=House, 6=Boat, 7=Yacht, 8=Bungalow, 9=Chalet, 10=Farmhouse, 11=Guesthouse, 12=CastleMansion, 13=Camping, 14=Hostel, 15=ApartHotel, 16=Resort, 17=Cottage, 18=VacationHome - `propertyRating` number, double, nullable — Property star rating (optional) - `propertyChain` string, nullable — Property chain (optional) - `propertyBoard` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 — Enumerator defining accommodation board basis:
0=Any, 1=RoomOnly, 2=SelfCatering, 3=BedAndBreakfast, 4=DinnerBedBreakfast, 5=HalfBoard, 6=FullBoard, 7=AllInclusive, 8=AllInclusivePlus, 9=CateredChalet, 10=AssistedChalet, 11=ManagedChalet, 12=FullBoardPlus, 13=CateredLodge, 14=Mixed, 15=BedAndDinner, 16=BedAndLunch, 17=BedAndMeal, 18=MealPlan, 19=MealPlanPlus - `propertyCheckout` string, date-time, nullable — Property checkout date/time - `carRentalSupplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `transferSupplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `searchLocation` string, nullable — Original search location (optional) - `countryCode` string, nullable — Country code - `price` number, double — Total selling price - `cruiseSearchCriteria` CruiseSearchCriteria — Cruise search criteria. - `cruiseType` 0 | 1 | 2 — Enumerator defining type of cruise types:
0=Any, 1=Ocean, 2=River - `departurePort` string, nullable — Departure port code (optional) - `destination` string, nullable — Destination code (optional) - `operator` string, nullable — Cruise operator code (optional) - `ship` string, nullable — Cruise ship code (optional) - `startDate` string, date-time, nullable — Start date of the cruise search - results will be returned for cruises between the date range (optional) - `endDate` string, date-time, nullable — End date of the cruise search - results will be returned for cruises between the date range (optional) - `durationMin` integer, nullable — Minimum duration of cruise (optional) - `durationMax` integer, nullable — Maximum duration of cruise (optional) - `priceMin` integer, nullable — Minimum price of cruise (optional) - `priceMax` integer, nullable — Maximum price of cruise (optional) - `options` CruiseOptions[], nullable — List of cruise options (optional) - `travellers` TravellerCriteria[], nullable — Array of travellers (optional for non-booking search) - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `multiCitySearchCriteria` MultiCitySearchCriteria — Multi-city search criteria. - `originCode` string, required — 3-letter IATA airport or city code (up to 3 comma-delimited airport codes are allowed) - `originName` string, nullable — Optional origin name to show on results pages. If not specified, the platform will assign this based on the origin code specified in the search. - `departureDate` string, date-time, required — Departure date of multi-city search (YYYY-MM-DD). - `preferredCabinClass` 0 | 1 | 2 | 3 | 4 — Enumerator defining airline cabin classes:
0=Any, 1=Economy, 2=PremiumEconomy, 3=Business, 4=First - `boardBasis` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 — Enumerator defining accommodation board basis:
0=Any, 1=RoomOnly, 2=SelfCatering, 3=BedAndBreakfast, 4=DinnerBedBreakfast, 5=HalfBoard, 6=FullBoard, 7=AllInclusive, 8=AllInclusivePlus, 9=CateredChalet, 10=AssistedChalet, 11=ManagedChalet, 12=FullBoardPlus, 13=CateredLodge, 14=Mixed, 15=BedAndDinner, 16=BedAndLunch, 17=BedAndMeal, 18=MealPlan, 19=MealPlanPlus - `directPreferred` boolean — Indicates whether the customer prefers direct flight results over those that may stop on route (indirect flights are normally cheaper in price). Customer may still get indirect results back, but direct will be prioritised. - `freeBaggageOnly` boolean — Indicates whether the customer wants only flights with free checked-in baggage allowance included (may exclude some cheaper fares) - `carrier` string, nullable — Optional 2-letter airline carrier to return. - `steps` MultiCityStep[], nullable — Array of multi-city steps (minimum 1 leg, maximum of 6). - `latitude` number, double, required — Latitude of the package holiday search area. - `longitude` number, double, required — Longitude of the package holiday search area. - `radius` integer, required — Package holiday search radius around the latitude/longitude. - `locationType` 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of a geographical place:
1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port - `locationName` string, nullable — Optional location name to show on results pages. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `locationCountry` string, nullable — Optional location country code. If not specified, the platform will assign this based on the latitude/longitude specified in the search. - `locationCode` string, required — 3-letter IATA airport or city code (up to 3 comma-delimited airport codes are allowed) - `duration` integer, required — Duration in location step (in nights) - `boardBasis` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 — Enumerator defining accommodation board basis:
0=Any, 1=RoomOnly, 2=SelfCatering, 3=BedAndBreakfast, 4=DinnerBedBreakfast, 5=HalfBoard, 6=FullBoard, 7=AllInclusive, 8=AllInclusivePlus, 9=CateredChalet, 10=AssistedChalet, 11=ManagedChalet, 12=FullBoardPlus, 13=CateredLodge, 14=Mixed, 15=BedAndDinner, 16=BedAndLunch, 17=BedAndMeal, 18=MealPlan, 19=MealPlanPlus - `minStarRating` number, double — Minimum star rating for properties (default is 0). - `rooms` RoomOccupancy[], nullable — Array of room occupancies. - `typePreference` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — Enumerator defining type of room:
0=Any, 1=Unknown, 2=Single, 3=Twin, 4=Double, 5=Triple, 6=Family, 7=Shared, 8=Apartment, 9=Villa, 10=Suite, 11=Queen, 12=King - `guests` TravellerCriteria[], nullable — Array of guests in room. - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `subType` 1 | 2 | 3 | 4 — Enumerator defining sub type of traveller:
1=Standard, 2=Senior, 3=Student, 4=Military - `age` integer, nullable — Age of traveller at time of return travel (required for children and infants) - `typeCode` string, nullable — Optional passenger type code - some suppliers support searching by traveller type codes (e.g. GDS) - `discountCode` string, nullable — Optional discount code - some suppliers support special discount codes for certain traveller types - `isSessionTimeout` boolean — Flag to inform front end of session timeout - `sessionExpiry` string, date-time, nullable — Session expiry date time - `itinerary` Itinerary — Model for location data - `steps` ItineraryStep[], nullable — List of TravelAppAPI.Models.Itinerary.ItineraryStep - `step` integer — Step identifier - `productType` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 — Enumerator defining product types:
1=Flights, 2=Accommodation, 3=Packages, 4=TicketsAttractions, 5=Transfers, 6=AirportExtras, 7=Insurance, 8=CarRental, 9=Visas, 10=Tours, 11=Tracking, 12=Itinerary, 13=PaymentService, 14=CRM, 15=Extras, 16=DynamicPackage, 17=Rail, 18=Generic, 19=Cruise, 20=TicketPackage - `startDateTime` string, date-time, nullable — Start date and time of step - `startDateUseTime` boolean, nullable — Whether TravelAppAPI.Models.Itinerary.ItineraryStep.StartDateTime should use the time element (true for flights, false for most others) - `startLocation` Location — Location information about the itinerary step - `id` integer — Travelify internal identifier of location - `type` 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of a geographical place:
1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port - `name` string, nullable — Name of location - `summary` string, nullable — Short/summary description of location - `iataCode` string, nullable — 3-letter IATA code (e.g. nearest airport or city code) - `latitude` number, double, nullable — Latitude of location - `longitude` number, double, nullable — Longitude of location - `timezone` string, nullable — Timezone of location (e.g. Europe/London) - `gmtOffset` integer — GMT offset of location (e.g. -5) - `geonameId` string, nullable — Geonames.org identifier for location - `imageUrl` string, nullable — Image URL of location - `flagImgUrl` string, nullable — Flag image url - `countryIso2Code` string, nullable — ISO-2 letter country code - `countryIso3Code` string, nullable — ISO-3 letter country code - `countryName` string, nullable — Name of the country - `currencyCode` string, nullable — 3-letter local currency code - `continentCode` string, nullable — 2-letter continent code of location - `weather` WeatherAverages — Model for weather averages for a location - `id` integer — Location identifier - `name` string, nullable — Location name - `latitude` number, double — Latitude - `longitude` number, double — Longitude - `distance` number, double, nullable — Distance - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `month` MonthData — Model for monthly weather averages - `month` integer — Month identifier - `monthName` string, nullable — Month name - `tempF` integer, nullable — Average temperature in F - `tempC` integer, nullable — Average temperature in C - `maxTempF` integer, nullable — Average max temperature in F - `maxTempC` integer, nullable — Average max temperature in C - `rainMM` number, double, nullable — Average daily rainfall in mm - `rainInch` number, double, nullable — Average daily rainfall in inches - `dryDays` integer, nullable — Average number of dry days - `rainDays` integer, nullable — Average number of rainy days - `snowDays` integer, nullable — Average number of snow days - `uvIndex` integer, nullable — Average UV index - `sunHours` number, double, nullable — Average sun hours - `months` MonthData[], nullable — Array of monthly averages (returned when all months requested or no travel date) - `month` integer — Month identifier - `monthName` string, nullable — Month name - `tempF` integer, nullable — Average temperature in F - `tempC` integer, nullable — Average temperature in C - `maxTempF` integer, nullable — Average max temperature in F - `maxTempC` integer, nullable — Average max temperature in C - `rainMM` number, double, nullable — Average daily rainfall in mm - `rainInch` number, double, nullable — Average daily rainfall in inches - `dryDays` integer, nullable — Average number of dry days - `rainDays` integer, nullable — Average number of rainy days - `snowDays` integer, nullable — Average number of snow days - `uvIndex` integer, nullable — Average UV index - `sunHours` number, double, nullable — Average sun hours - `walkscore` WalkScore — Location walk/transit/bike scores from Walkscore.com - `score` integer — Walk score for location out of 100 - `description` string, nullable — Walk score description (e.g. Walker's Paradise) - `url` string, nullable — Url on the walkscore.com site to view more information - `transitScore` integer, nullable — Transit score for location out of 100 (not returned for all locations) - `transitDescription` string, nullable — Transit description, if available (e.g. Excellent Transit) - `transitSummary` string, nullable — Summary of transit links in area, if available (e.g. 115 nearby routes: 103 bus, 6 rail, 6 other) - `bikeScore` integer, nullable — Bike score for location out of 100 (not returned for all locations) - `bikeDescription` string, nullable — Bike description, if available (e.g. Biker's Paradise) - `pois` PointOfInterest[], nullable — List of TravelAppAPI.Models.Itinerary.PointOfInterest - `id` string, nullable — Unique identifier of location - `name` string, nullable — Name of location - `location` string, nullable — Location/address of point - `summary` string, nullable — Short summary of location - `description` string, nullable — Longer description of location - `openingTimes` string, nullable — Opening times - `pricingInfo` string, nullable — Pricing information - `gettingThere` string, nullable — Information on travel to the location - `websiteUrl` string, nullable — Website URL for the location - `categories` string[], nullable — List of categories for location - `latitude` number, double, nullable — Latitude of location - `longitude` number, double, nullable — Longitude of location - `durationEstimate` integer, nullable — Estimated duration to visit the location (seconds) - `markerUrl` string, nullable — Map marker url - `thumbnailUrl` string, nullable — Thumbnail image url - `imageUrl` string, nullable — Image url - `imageCaption` string, nullable — Image caption - `endDateTime` string, date-time, nullable — End date and time of step - `endDateUseTime` boolean, nullable — Whether TravelAppAPI.Models.Itinerary.ItineraryStep.EndDateTime should use the time element (true for flights, false for most others) - `endLocation` Location — Location information about the itinerary step - `id` integer — Travelify internal identifier of location - `type` 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of a geographical place:
1=Country, 2=City, 3=Airport, 4=PointOfInterest, 5=Property, 6=Port - `name` string, nullable — Name of location - `summary` string, nullable — Short/summary description of location - `iataCode` string, nullable — 3-letter IATA code (e.g. nearest airport or city code) - `latitude` number, double, nullable — Latitude of location - `longitude` number, double, nullable — Longitude of location - `timezone` string, nullable — Timezone of location (e.g. Europe/London) - `gmtOffset` integer — GMT offset of location (e.g. -5) - `geonameId` string, nullable — Geonames.org identifier for location - `imageUrl` string, nullable — Image URL of location - `flagImgUrl` string, nullable — Flag image url - `countryIso2Code` string, nullable — ISO-2 letter country code - `countryIso3Code` string, nullable — ISO-3 letter country code - `countryName` string, nullable — Name of the country - `currencyCode` string, nullable — 3-letter local currency code - `continentCode` string, nullable — 2-letter continent code of location - `weather` WeatherAverages — Model for weather averages for a location - `id` integer — Location identifier - `name` string, nullable — Location name - `latitude` number, double — Latitude - `longitude` number, double — Longitude - `distance` number, double, nullable — Distance - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `month` MonthData — Model for monthly weather averages - `month` integer — Month identifier - `monthName` string, nullable — Month name - `tempF` integer, nullable — Average temperature in F - `tempC` integer, nullable — Average temperature in C - `maxTempF` integer, nullable — Average max temperature in F - `maxTempC` integer, nullable — Average max temperature in C - `rainMM` number, double, nullable — Average daily rainfall in mm - `rainInch` number, double, nullable — Average daily rainfall in inches - `dryDays` integer, nullable — Average number of dry days - `rainDays` integer, nullable — Average number of rainy days - `snowDays` integer, nullable — Average number of snow days - `uvIndex` integer, nullable — Average UV index - `sunHours` number, double, nullable — Average sun hours - `months` MonthData[], nullable — Array of monthly averages (returned when all months requested or no travel date) - `month` integer — Month identifier - `monthName` string, nullable — Month name - `tempF` integer, nullable — Average temperature in F - `tempC` integer, nullable — Average temperature in C - `maxTempF` integer, nullable — Average max temperature in F - `maxTempC` integer, nullable — Average max temperature in C - `rainMM` number, double, nullable — Average daily rainfall in mm - `rainInch` number, double, nullable — Average daily rainfall in inches - `dryDays` integer, nullable — Average number of dry days - `rainDays` integer, nullable — Average number of rainy days - `snowDays` integer, nullable — Average number of snow days - `uvIndex` integer, nullable — Average UV index - `sunHours` number, double, nullable — Average sun hours - `walkscore` WalkScore — Location walk/transit/bike scores from Walkscore.com - `score` integer — Walk score for location out of 100 - `description` string, nullable — Walk score description (e.g. Walker's Paradise) - `url` string, nullable — Url on the walkscore.com site to view more information - `transitScore` integer, nullable — Transit score for location out of 100 (not returned for all locations) - `transitDescription` string, nullable — Transit description, if available (e.g. Excellent Transit) - `transitSummary` string, nullable — Summary of transit links in area, if available (e.g. 115 nearby routes: 103 bus, 6 rail, 6 other) - `bikeScore` integer, nullable — Bike score for location out of 100 (not returned for all locations) - `bikeDescription` string, nullable — Bike description, if available (e.g. Biker's Paradise) - `pois` PointOfInterest[], nullable — List of TravelAppAPI.Models.Itinerary.PointOfInterest - `id` string, nullable — Unique identifier of location - `name` string, nullable — Name of location - `location` string, nullable — Location/address of point - `summary` string, nullable — Short summary of location - `description` string, nullable — Longer description of location - `openingTimes` string, nullable — Opening times - `pricingInfo` string, nullable — Pricing information - `gettingThere` string, nullable — Information on travel to the location - `websiteUrl` string, nullable — Website URL for the location - `categories` string[], nullable — List of categories for location - `latitude` number, double, nullable — Latitude of location - `longitude` number, double, nullable — Longitude of location - `durationEstimate` integer, nullable — Estimated duration to visit the location (seconds) - `markerUrl` string, nullable — Map marker url - `thumbnailUrl` string, nullable — Thumbnail image url - `imageUrl` string, nullable — Image url - `imageCaption` string, nullable — Image caption - `advisories` TravelAdvisory[], nullable — Array of TravelAppAPI.Models.Itinerary.TravelAdvisory (if available) - `type` 1 | 2 | 3 — Enumerator defining types of travel advisory:
1=General, 2=Covid, 3=NaturalDisaster - `destination` string, nullable — Name of destination advisory relates to - `data` unknown - `updated` string, date-time — Date time of last update - `flightResults` FlightResult[], nullable — Returns a list of TravelAppAPI.Models.BookingFlowResponse.FlightResult. - `rid` string, nullable — Unique result identifier - `resultType` 1 | 2 | 3 — Enumerator defining type of a result:
1=Bookable, 2=Affiliate, 3=EnquiryOnly - `supplier` SupplierInfo — Supplier information object - `supplierType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `subSupplier` string, nullable — Internal sub supplier (if a consolidator) - `gds` string, nullable — Internal GDS supplier (when applicable) - `name` string, nullable — Supplier name - `currency` string, nullable — Currency code of supplier pricing - `supplierPrice` number, double — Supplier purchase price - `commission` number, double — Commission level (percentage) - `supplierResultRef` string, nullable — Supplier reference for result (eg. property reference) - `bookingData` object, nullable — Booking data store for any private data required during booking process - `isAvailable` boolean — Returns if the result is available for purchase after a pricing and/or availability check - `availabilityError` string, nullable — Returns a pricing and/or availability error message if the result is no longer available (not normally for display to a customer) - `pricing` Pricing — Pricing information object - `originalCurrency` string, nullable — Currency code of original source price - `originalPrice` number, double, nullable — Original source price (in original currency) - `exchangeRate` number, double — Exchange rate from original source currency - `currency` string, nullable — Currency code of selling and nett price - `nettPrice` number, double, nullable — Source price (before discounts or markups) - `trueNettPrice` number, double, nullable — True source price (before discounts or markups calculated from supplier commission) - `price` number, double — Selling price (after discounts or markups) - `inResortFees` number, double, nullable — In-resort fees (additional fees payable at the resort, if available) - `memberPrice` number, double, nullable — Member selling price - `priceBeforeMod` number, double, nullable — Selling price before modification (internal use only) - `priceChanged` boolean — Indicator that the price has changed between booking stages - `priceBeforeChange` number, double, nullable — Selling price before change (only returned if PriceChanged is true) - `priceMinSell` boolean, nullable — Indicator that this has a minimum selling price from the supplier (only returned if true) - `ruleIds` integer[], nullable — List of rules identifiers applied to pricing - `memberRuleIds` integer[], nullable — List of rules identifiers applied to member pricing - `isRefundable` boolean, nullable — States if rate is refundable (see policies for more information and cancellation costs) - `refundability` 1 | 2 | 3 — Enumerator defining refundability of price:
1=NonRefundable, 2=Refundable, 3=PartialRefundable - `payNowPrice` number, double, nullable — Pay now price (can be used for refundable results where a small or no payment is needed up front) - `payDeadline` string, date-time, nullable — Payment deadline (normally used in conjunction with PayNowPrice) - `isLeadIn` boolean — States if rate is a lead-in/from price or a confirmed price - `breakdown` PriceItem[], nullable — Price breakdown - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `payAtLocation` PriceItem[], nullable — Price breakdown of items payable at location - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `depositOptions` DepositOption[], nullable — Array of deposit options available (if no options then no deposit available) - `id` integer — Option identifier - `ruleId` integer, nullable — Rule identifier - `dedupeId` integer, nullable — Option deduplication identifier - `amount` number, double — Amount to pay now - `installments` integer, nullable — Optional number of installments - `installmentsAmount` number, double, nullable — Optional amount to pay per installment - `dueDate` string, date-time, nullable — Optional balance due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `balance` number, double, nullable — Optional balance amount - `minDaysBefore` integer, nullable — Optional minimum days before departure - `name` string, nullable — Short name of option - `message` string, nullable — Promo message to show in information popup - `breakdown` DepositBreakdown[], nullable — Array of deposit breakdowns - `num` integer — Installment number - `amount` number, double — Installment amount - `dueDate` string, date-time — Installment due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `reward` RewardInfo — Reward object - `id` integer — Reward identifier - `title` string, nullable — Reward title - `description` string, nullable — Reward description - `terms` string, nullable — Reward terms - `imageUrl` string, nullable — Reward image url - `amount` number, double — Reward amount - `affiliate` AffiliateInfo — Affiliate information object - `name` string, nullable — Affiliate name - `logoUrl` string, nullable — Logo URL - `webUrl` string, nullable — Website URL - `deeplinkUrl` string, nullable — Deeplink URL to book this result (only applicable to affiliate results) - `priority` integer — Priority setting for front end sort (higher number first, default 0 deprioritised) - `priorityTag` string, nullable — Optional priority tag to explain reason for priority (eg. "Cheapest", "Fastest", "Best Value") - `uniqueID` string, nullable — Unique identifier of result (normally used for removing duplicates) - `orderItemID` integer, nullable — Order item identifier (can be used for removing item from order) - `booking` BookingInfo — Booking information - `success` boolean — Booking success - `supplierBookingRef` string, nullable — Supplier booking reference (if success) - `errorMessage` string, nullable — Booking error message (if failure) - `stepIdx` integer, nullable — Multicity step index (only returned for multicity results) - `stepTitle` string, nullable — Multicity step title (only returned for multicity results) - `seatsAvailable` integer, nullable — Number of seats available (if available) - `requiresAddress` boolean — Flag to indicate if address is required for reserve stage - `confirmationUrl` string, nullable — Confirmation URL which must be presented to the customer after payment is made (required for Ryanair bookings) - `tandCs` object, nullable — List of terms and conditions links (text and URL) that must be presented to the customer and accepted before booking - `fareType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining flight fare types:
0=Private, 1=Published, 2=Negotiated, 3=Nett, 4=Cat35, 5=LowCost, 6=Charter, 7=Corporate, 8=Web, 9=ITX, 10=ITXCat35, 11=SeatOnly, 12=NDC, 13=VFR - `openJaw` boolean — Flags a result as an open jaw return flight - `earliestCancellation` string, date-time, nullable — Earliest cancellation date (internal use only) - `fareInformation` Information[], nullable — Array of information such as fare rules - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining types of information content:
1=Generic, 2=ImportantInfo, 3=BookingConditions, 4=CancelAndAmendments, 5=Inclusions, 6=Exclusions, 7=OpeningTimes, 8=SafetyInformation, 9=Contact, 10=DateInfo, 11=Disclaimer, 12=Notes, 13=Menu - `title` string, nullable — Title of information object - `text` string, nullable — Text content of information object - `features` FlightFeature[], nullable — Array of flight features - `feature` 1 | 2 | 3 | 4 — Enumerator defining flight features:
1=IATA, 2=SeatChoice, 3=Refundable, 4=Changes - `inclusion` 1 | 2 | 3 — Enumerator defining flight features:
1=Excluded, 2=Included, 3=Charge - `info` string, nullable — Optional information text about the feature - `routes` FlightRoute[], nullable — List of flight routes available in result - `rid` string, nullable — Unique route identifier - `legID` integer — Leg identifier - if multiple routes have the same leg id, the customer needs to select which option they want for that leg - `supplierData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `direction` 0 | 1 | 2 | 3 — Enumerator defining direction of travel:
0=OneWay, 1=Outbound, 2=Inbound, 3=MultiCity - `duration` integer, nullable — Route duration in minutes - `segments` FlightSegment[], nullable — List of segments within route - `supplierData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `origin` GeoPoint — Geographical point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `value` number, double — Distance value - `imageUrl` string, nullable — Image url of geographical point (if available) - `destination` GeoPoint — Geographical point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `value` number, double — Distance value - `imageUrl` string, nullable — Image url of geographical point (if available) - `depart` string, date-time — Departure date and time - `arrive` string, date-time — Arrival date and time - `duration` integer, nullable — Segment duration in minutes - `cabinClass` 0 | 1 | 2 | 3 | 4 — Enumerator defining airline cabin classes:
0=Any, 1=Economy, 2=PremiumEconomy, 3=Business, 4=First - `fareName` string, nullable — Airline fare name (branded fare) - `fareCode` string, nullable — Airline fare code (branded fare) - `fareBasis` string, nullable — Airline fare basis - `seatClass` string, nullable — Seat class code - `baggage` FlightBaggage — Flight baggage allowance object - `allowance` string, nullable — Baggage allowance (e.g. readable weight or quantity information) - `handOnly` boolean, nullable — Defines if allowance is hand baggage only - `weight` string, nullable — Weight (e.g. 25KG) - `pieces` string, nullable — Number of pieces (e.g. 1PC) - `operatingCarrier` FlightCarrier — Flight carrier object - `code` string, nullable — Airline code (IATA) - `name` string, nullable — Airline name - `alliance` string, nullable — Airline alliance (eg. Skyteam, Oneworld) - `groundProvider` boolean, nullable — Defines if carrier is a ground-transporation provider - `img` string, nullable — Optional image URL for carrier logo (only provided if non-standard) - `marketingCarrier` FlightCarrier — Flight carrier object - `code` string, nullable — Airline code (IATA) - `name` string, nullable — Airline name - `alliance` string, nullable — Airline alliance (eg. Skyteam, Oneworld) - `groundProvider` boolean, nullable — Defines if carrier is a ground-transporation provider - `img` string, nullable — Optional image URL for carrier logo (only provided if non-standard) - `flightNo` string, nullable — Flight number - `touchdowns` integer — Number of touchdowns/stops - `aircraft` string, nullable — Aircraft name/type - `extraGroups` OptionalExtraGroup[], nullable — Array of optional extra groups available for route - `gid` string, nullable — Unique group identifier - `sid` string, nullable — Multicity step id (only returned for multicity results) - `stepIdx` integer, nullable — Multicity step index (only returned for multicity results) - `stepSubIdx` integer, nullable — Multicity step sub index (only returned for multicity results) - `stepTitle` string, nullable — Multicity step title (only returned for multicity results) - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `orderRef` string, nullable — Existing order reference link (INTERNAL USE ONLY) - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 — Enumerator defining the type of an extra:
1=Generic, 2=Insurance, 3=Service, 4=FoodDrink, 5=Activity, 6=Luggage, 7=Pet, 8=Ticket, 9=Seat, 10=Transport, 11=Mandatory, 12=Room, 13=GiftVoucher, 14=ForeignExchange, 15=SportsEquipment, 16=OrderPayment - `travellerTypes` TravellerTypes[], nullable — Array of traveller types this group applies to (if null then applies to all travellers, otherwise should be linked to each passenger) - `name` string, nullable — Name of group - `description` string, nullable — Description of group - `maxSelectable` integer — Maximum number of extras selectable from the group - `orderItemID` integer, nullable — Order item identifier (can be used for removing item from order) - `isAvailable` boolean — Returns if the result is available for purchase after a pricing and/or availability check. - `availabilityError` string, nullable — Availability error message - `location` PickupPoint — Pickup point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `value` number, double — Distance value - `imageUrl` string, nullable — Image url of geographical point (if available) - `id` integer, nullable — Identifier if this is an option - `supplierData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `onAirport` boolean, nullable — Defines if the pickup point is on airport grounds - `contactDetails` string, nullable — Contact details of the pickup point (if available) - `hours` string, nullable — Opening hours of the pickup point (if available) - `dateTime` string, date-time, nullable — Pickup date/time at the point - `cabin` CabinLayout — Flight cabin layout object - `cols` object, nullable — List of columns - `startRow` integer — Starting row number - `endRow` integer — Ending row number - `media` Media[], nullable — Optional array of media - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of media:
0=GenericImage, 1=Logo, 2=SquareImage, 3=LandscapeImage, 4=SeatingPlanImage, 5=Video, 6=Map - `url` string, nullable — URL of media - `thumbnailUrl` string, nullable — Thumbnail URL of media (only returned for Video media to allow showing a thumbnail) - `caption` string, nullable — Caption text for media (if available) - `width` integer, nullable — Width of media in pixels (if available) - `height` integer, nullable — Height of media in pixels (if available) - `extras` OptionalExtra[], nullable — List of optional extras - `eid` string, nullable — Unique extra identifier - `supplier` SupplierInfo — Supplier information object - `supplierType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `subSupplier` string, nullable — Internal sub supplier (if a consolidator) - `gds` string, nullable — Internal GDS supplier (when applicable) - `name` string, nullable — Supplier name - `currency` string, nullable — Currency code of supplier pricing - `supplierPrice` number, double — Supplier purchase price - `commission` number, double — Commission level (percentage) - `supplierResultRef` string, nullable — Supplier reference for result (eg. property reference) - `bookingData` object, nullable — Booking data store for any private data required during booking process - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 — Enumerator defining the type of an extra:
1=Generic, 2=Insurance, 3=Service, 4=FoodDrink, 5=Activity, 6=Luggage, 7=Pet, 8=Ticket, 9=Seat, 10=Transport, 11=Mandatory, 12=Room, 13=GiftVoucher, 14=ForeignExchange, 15=SportsEquipment, 16=OrderPayment - `name` string, nullable — Name of extra - `description` string, nullable — Description of extra - `information` Information[], nullable — Array of extra information - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining types of information content:
1=Generic, 2=ImportantInfo, 3=BookingConditions, 4=CancelAndAmendments, 5=Inclusions, 6=Exclusions, 7=OpeningTimes, 8=SafetyInformation, 9=Contact, 10=DateInfo, 11=Disclaimer, 12=Notes, 13=Menu - `title` string, nullable — Title of information object - `text` string, nullable — Text content of information object - `seat` SeatData — Seat data object - `col` string, nullable — Column - `row` integer — Row - `ftr` string, nullable — Features - `isPayAtPickup` boolean — Whether the extra charge is payable at reservation or at pickup - `maxQty` integer — Maximum quantity available for selection of this extra - `qtySelected` integer, nullable — Quantity selected - `pricing` Pricing — Pricing information object - `originalCurrency` string, nullable — Currency code of original source price - `originalPrice` number, double, nullable — Original source price (in original currency) - `exchangeRate` number, double — Exchange rate from original source currency - `currency` string, nullable — Currency code of selling and nett price - `nettPrice` number, double, nullable — Source price (before discounts or markups) - `trueNettPrice` number, double, nullable — True source price (before discounts or markups calculated from supplier commission) - `price` number, double — Selling price (after discounts or markups) - `inResortFees` number, double, nullable — In-resort fees (additional fees payable at the resort, if available) - `memberPrice` number, double, nullable — Member selling price - `priceBeforeMod` number, double, nullable — Selling price before modification (internal use only) - `priceChanged` boolean — Indicator that the price has changed between booking stages - `priceBeforeChange` number, double, nullable — Selling price before change (only returned if PriceChanged is true) - `priceMinSell` boolean, nullable — Indicator that this has a minimum selling price from the supplier (only returned if true) - `ruleIds` integer[], nullable — List of rules identifiers applied to pricing - `memberRuleIds` integer[], nullable — List of rules identifiers applied to member pricing - `isRefundable` boolean, nullable — States if rate is refundable (see policies for more information and cancellation costs) - `refundability` 1 | 2 | 3 — Enumerator defining refundability of price:
1=NonRefundable, 2=Refundable, 3=PartialRefundable - `payNowPrice` number, double, nullable — Pay now price (can be used for refundable results where a small or no payment is needed up front) - `payDeadline` string, date-time, nullable — Payment deadline (normally used in conjunction with PayNowPrice) - `isLeadIn` boolean — States if rate is a lead-in/from price or a confirmed price - `breakdown` PriceItem[], nullable — Price breakdown - … - `payAtLocation` PriceItem[], nullable — Price breakdown of items payable at location - … - `depositOptions` DepositOption[], nullable — Array of deposit options available (if no options then no deposit available) - … - `reward` RewardInfo — Reward object - … - `location` PickupPoint — Pickup point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - … - `imageUrl` string, nullable — Image url of geographical point (if available) - `id` integer, nullable — Identifier if this is an option - `supplierData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `onAirport` boolean, nullable — Defines if the pickup point is on airport grounds - `contactDetails` string, nullable — Contact details of the pickup point (if available) - `hours` string, nullable — Opening hours of the pickup point (if available) - `dateTime` string, date-time, nullable — Pickup date/time at the point - `media` Media[], nullable — Optional array of media - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of media:
0=GenericImage, 1=Logo, 2=SquareImage, 3=LandscapeImage, 4=SeatingPlanImage, 5=Video, 6=Map - `url` string, nullable — URL of media - `thumbnailUrl` string, nullable — Thumbnail URL of media (only returned for Video media to allow showing a thumbnail) - `caption` string, nullable — Caption text for media (if available) - `width` integer, nullable — Width of media in pixels (if available) - `height` integer, nullable — Height of media in pixels (if available) - `participants` TravellerData[], nullable — Array of participants - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - … - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `foidMandatory` boolean — Forms of identification is mandatory - `formsOfIdentification` FOID[], nullable — List of accepted forms of identification - `extraGroups` OptionalExtraGroup[], nullable — Array of optional extra groups available for overall flight - `gid` string, nullable — Unique group identifier - `sid` string, nullable — Multicity step id (only returned for multicity results) - `stepIdx` integer, nullable — Multicity step index (only returned for multicity results) - `stepSubIdx` integer, nullable — Multicity step sub index (only returned for multicity results) - `stepTitle` string, nullable — Multicity step title (only returned for multicity results) - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `orderRef` string, nullable — Existing order reference link (INTERNAL USE ONLY) - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 — Enumerator defining the type of an extra:
1=Generic, 2=Insurance, 3=Service, 4=FoodDrink, 5=Activity, 6=Luggage, 7=Pet, 8=Ticket, 9=Seat, 10=Transport, 11=Mandatory, 12=Room, 13=GiftVoucher, 14=ForeignExchange, 15=SportsEquipment, 16=OrderPayment - `travellerTypes` TravellerTypes[], nullable — Array of traveller types this group applies to (if null then applies to all travellers, otherwise should be linked to each passenger) - `name` string, nullable — Name of group - `description` string, nullable — Description of group - `maxSelectable` integer — Maximum number of extras selectable from the group - `orderItemID` integer, nullable — Order item identifier (can be used for removing item from order) - `isAvailable` boolean — Returns if the result is available for purchase after a pricing and/or availability check. - `availabilityError` string, nullable — Availability error message - `location` PickupPoint — Pickup point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `value` number, double — Distance value - `imageUrl` string, nullable — Image url of geographical point (if available) - `id` integer, nullable — Identifier if this is an option - `supplierData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `onAirport` boolean, nullable — Defines if the pickup point is on airport grounds - `contactDetails` string, nullable — Contact details of the pickup point (if available) - `hours` string, nullable — Opening hours of the pickup point (if available) - `dateTime` string, date-time, nullable — Pickup date/time at the point - `cabin` CabinLayout — Flight cabin layout object - `cols` object, nullable — List of columns - `startRow` integer — Starting row number - `endRow` integer — Ending row number - `media` Media[], nullable — Optional array of media - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of media:
0=GenericImage, 1=Logo, 2=SquareImage, 3=LandscapeImage, 4=SeatingPlanImage, 5=Video, 6=Map - `url` string, nullable — URL of media - `thumbnailUrl` string, nullable — Thumbnail URL of media (only returned for Video media to allow showing a thumbnail) - `caption` string, nullable — Caption text for media (if available) - `width` integer, nullable — Width of media in pixels (if available) - `height` integer, nullable — Height of media in pixels (if available) - `extras` OptionalExtra[], nullable — List of optional extras - `eid` string, nullable — Unique extra identifier - `supplier` SupplierInfo — Supplier information object - `supplierType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `subSupplier` string, nullable — Internal sub supplier (if a consolidator) - `gds` string, nullable — Internal GDS supplier (when applicable) - `name` string, nullable — Supplier name - `currency` string, nullable — Currency code of supplier pricing - `supplierPrice` number, double — Supplier purchase price - `commission` number, double — Commission level (percentage) - `supplierResultRef` string, nullable — Supplier reference for result (eg. property reference) - `bookingData` object, nullable — Booking data store for any private data required during booking process - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 — Enumerator defining the type of an extra:
1=Generic, 2=Insurance, 3=Service, 4=FoodDrink, 5=Activity, 6=Luggage, 7=Pet, 8=Ticket, 9=Seat, 10=Transport, 11=Mandatory, 12=Room, 13=GiftVoucher, 14=ForeignExchange, 15=SportsEquipment, 16=OrderPayment - `name` string, nullable — Name of extra - `description` string, nullable — Description of extra - `information` Information[], nullable — Array of extra information - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining types of information content:
1=Generic, 2=ImportantInfo, 3=BookingConditions, 4=CancelAndAmendments, 5=Inclusions, 6=Exclusions, 7=OpeningTimes, 8=SafetyInformation, 9=Contact, 10=DateInfo, 11=Disclaimer, 12=Notes, 13=Menu - `title` string, nullable — Title of information object - `text` string, nullable — Text content of information object - `seat` SeatData — Seat data object - `col` string, nullable — Column - `row` integer — Row - `ftr` string, nullable — Features - `isPayAtPickup` boolean — Whether the extra charge is payable at reservation or at pickup - `maxQty` integer — Maximum quantity available for selection of this extra - `qtySelected` integer, nullable — Quantity selected - `pricing` Pricing — Pricing information object - `originalCurrency` string, nullable — Currency code of original source price - `originalPrice` number, double, nullable — Original source price (in original currency) - `exchangeRate` number, double — Exchange rate from original source currency - `currency` string, nullable — Currency code of selling and nett price - `nettPrice` number, double, nullable — Source price (before discounts or markups) - `trueNettPrice` number, double, nullable — True source price (before discounts or markups calculated from supplier commission) - `price` number, double — Selling price (after discounts or markups) - `inResortFees` number, double, nullable — In-resort fees (additional fees payable at the resort, if available) - `memberPrice` number, double, nullable — Member selling price - `priceBeforeMod` number, double, nullable — Selling price before modification (internal use only) - `priceChanged` boolean — Indicator that the price has changed between booking stages - `priceBeforeChange` number, double, nullable — Selling price before change (only returned if PriceChanged is true) - `priceMinSell` boolean, nullable — Indicator that this has a minimum selling price from the supplier (only returned if true) - `ruleIds` integer[], nullable — List of rules identifiers applied to pricing - `memberRuleIds` integer[], nullable — List of rules identifiers applied to member pricing - `isRefundable` boolean, nullable — States if rate is refundable (see policies for more information and cancellation costs) - `refundability` 1 | 2 | 3 — Enumerator defining refundability of price:
1=NonRefundable, 2=Refundable, 3=PartialRefundable - `payNowPrice` number, double, nullable — Pay now price (can be used for refundable results where a small or no payment is needed up front) - `payDeadline` string, date-time, nullable — Payment deadline (normally used in conjunction with PayNowPrice) - `isLeadIn` boolean — States if rate is a lead-in/from price or a confirmed price - `breakdown` PriceItem[], nullable — Price breakdown - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `payAtLocation` PriceItem[], nullable — Price breakdown of items payable at location - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `depositOptions` DepositOption[], nullable — Array of deposit options available (if no options then no deposit available) - `id` integer — Option identifier - `ruleId` integer, nullable — Rule identifier - `dedupeId` integer, nullable — Option deduplication identifier - `amount` number, double — Amount to pay now - `installments` integer, nullable — Optional number of installments - `installmentsAmount` number, double, nullable — Optional amount to pay per installment - `dueDate` string, date-time, nullable — Optional balance due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `balance` number, double, nullable — Optional balance amount - `minDaysBefore` integer, nullable — Optional minimum days before departure - `name` string, nullable — Short name of option - `message` string, nullable — Promo message to show in information popup - `breakdown` DepositBreakdown[], nullable — Array of deposit breakdowns - … - `reward` RewardInfo — Reward object - `id` integer — Reward identifier - `title` string, nullable — Reward title - `description` string, nullable — Reward description - `terms` string, nullable — Reward terms - `imageUrl` string, nullable — Reward image url - `amount` number, double — Reward amount - `location` PickupPoint — Pickup point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `value` number, double — Distance value - `imageUrl` string, nullable — Image url of geographical point (if available) - `id` integer, nullable — Identifier if this is an option - `supplierData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `onAirport` boolean, nullable — Defines if the pickup point is on airport grounds - `contactDetails` string, nullable — Contact details of the pickup point (if available) - `hours` string, nullable — Opening hours of the pickup point (if available) - `dateTime` string, date-time, nullable — Pickup date/time at the point - `media` Media[], nullable — Optional array of media - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of media:
0=GenericImage, 1=Logo, 2=SquareImage, 3=LandscapeImage, 4=SeatingPlanImage, 5=Video, 6=Map - `url` string, nullable — URL of media - `thumbnailUrl` string, nullable — Thumbnail URL of media (only returned for Video media to allow showing a thumbnail) - `caption` string, nullable — Caption text for media (if available) - `width` integer, nullable — Width of media in pixels (if available) - `height` integer, nullable — Height of media in pixels (if available) - `participants` TravellerData[], nullable — Array of participants - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `travellers` TravellerData[], nullable — Array of travellers - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `flightExtendedData` FlightExtendedData — Flight extended data object - `calendar` FlightCalendarData[], nullable — Array of calendar dates - `supplier` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `supplierData` object, nullable — Supplier data store for any private data (INTERNAL USE ONLY) - `fareType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining flight fare types:
0=Private, 1=Published, 2=Negotiated, 3=Nett, 4=Cat35, 5=LowCost, 6=Charter, 7=Corporate, 8=Web, 9=ITX, 10=ITXCat35, 11=SeatOnly, 12=NDC, 13=VFR - `outDate` string, date-time, nullable — Calendar outbound date - `retDate` string, date-time, nullable — Calendar return date (optional) - `carrier` FlightCarrier — Flight carrier object - `code` string, nullable — Airline code (IATA) - `name` string, nullable — Airline name - `alliance` string, nullable — Airline alliance (eg. Skyteam, Oneworld) - `groundProvider` boolean, nullable — Defines if carrier is a ground-transporation provider - `img` string, nullable — Optional image URL for carrier logo (only provided if non-standard) - `price` Pricing — Pricing information object - `originalCurrency` string, nullable — Currency code of original source price - `originalPrice` number, double, nullable — Original source price (in original currency) - `exchangeRate` number, double — Exchange rate from original source currency - `currency` string, nullable — Currency code of selling and nett price - `nettPrice` number, double, nullable — Source price (before discounts or markups) - `trueNettPrice` number, double, nullable — True source price (before discounts or markups calculated from supplier commission) - `price` number, double — Selling price (after discounts or markups) - `inResortFees` number, double, nullable — In-resort fees (additional fees payable at the resort, if available) - `memberPrice` number, double, nullable — Member selling price - `priceBeforeMod` number, double, nullable — Selling price before modification (internal use only) - `priceChanged` boolean — Indicator that the price has changed between booking stages - `priceBeforeChange` number, double, nullable — Selling price before change (only returned if PriceChanged is true) - `priceMinSell` boolean, nullable — Indicator that this has a minimum selling price from the supplier (only returned if true) - `ruleIds` integer[], nullable — List of rules identifiers applied to pricing - `memberRuleIds` integer[], nullable — List of rules identifiers applied to member pricing - `isRefundable` boolean, nullable — States if rate is refundable (see policies for more information and cancellation costs) - `refundability` 1 | 2 | 3 — Enumerator defining refundability of price:
1=NonRefundable, 2=Refundable, 3=PartialRefundable - `payNowPrice` number, double, nullable — Pay now price (can be used for refundable results where a small or no payment is needed up front) - `payDeadline` string, date-time, nullable — Payment deadline (normally used in conjunction with PayNowPrice) - `isLeadIn` boolean — States if rate is a lead-in/from price or a confirmed price - `breakdown` PriceItem[], nullable — Price breakdown - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `payAtLocation` PriceItem[], nullable — Price breakdown of items payable at location - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `depositOptions` DepositOption[], nullable — Array of deposit options available (if no options then no deposit available) - `id` integer — Option identifier - `ruleId` integer, nullable — Rule identifier - `dedupeId` integer, nullable — Option deduplication identifier - `amount` number, double — Amount to pay now - `installments` integer, nullable — Optional number of installments - `installmentsAmount` number, double, nullable — Optional amount to pay per installment - `dueDate` string, date-time, nullable — Optional balance due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `balance` number, double, nullable — Optional balance amount - `minDaysBefore` integer, nullable — Optional minimum days before departure - `name` string, nullable — Short name of option - `message` string, nullable — Promo message to show in information popup - `breakdown` DepositBreakdown[], nullable — Array of deposit breakdowns - `num` integer — Installment number - `amount` number, double — Installment amount - `dueDate` string, date-time — Installment due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `reward` RewardInfo — Reward object - `id` integer — Reward identifier - `title` string, nullable — Reward title - `description` string, nullable — Reward description - `terms` string, nullable — Reward terms - `imageUrl` string, nullable — Reward image url - `amount` number, double — Reward amount - `brandedFares` FlightBrandedFareData[], nullable — Array of branded fare data - `carrier` string, nullable — Carrier code - `programID` string, nullable — Program id - `code` string, nullable — Branded fare code - `name` string, nullable — Branded fare name - `inclusions` FlightFareItem[], nullable — Array of items to display - `inclusion` 1 | 2 | 3 — Enumerator defining flight features:
1=Excluded, 2=Included, 3=Charge - `name` string, nullable — Name of item - `accommodationResults` AccommodationResult[], nullable — Returns a list of TravelAppAPI.Models.BookingFlowResponse.AccommodationResult. - `rid` string, nullable — Unique result identifier - `resultType` 1 | 2 | 3 — Enumerator defining type of a result:
1=Bookable, 2=Affiliate, 3=EnquiryOnly - `supplier` SupplierInfo — Supplier information object - `supplierType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `subSupplier` string, nullable — Internal sub supplier (if a consolidator) - `gds` string, nullable — Internal GDS supplier (when applicable) - `name` string, nullable — Supplier name - `currency` string, nullable — Currency code of supplier pricing - `supplierPrice` number, double — Supplier purchase price - `commission` number, double — Commission level (percentage) - `supplierResultRef` string, nullable — Supplier reference for result (eg. property reference) - `bookingData` object, nullable — Booking data store for any private data required during booking process - `isAvailable` boolean — Returns if the result is available for purchase after a pricing and/or availability check - `availabilityError` string, nullable — Returns a pricing and/or availability error message if the result is no longer available (not normally for display to a customer) - `pricing` Pricing — Pricing information object - `originalCurrency` string, nullable — Currency code of original source price - `originalPrice` number, double, nullable — Original source price (in original currency) - `exchangeRate` number, double — Exchange rate from original source currency - `currency` string, nullable — Currency code of selling and nett price - `nettPrice` number, double, nullable — Source price (before discounts or markups) - `trueNettPrice` number, double, nullable — True source price (before discounts or markups calculated from supplier commission) - `price` number, double — Selling price (after discounts or markups) - `inResortFees` number, double, nullable — In-resort fees (additional fees payable at the resort, if available) - `memberPrice` number, double, nullable — Member selling price - `priceBeforeMod` number, double, nullable — Selling price before modification (internal use only) - `priceChanged` boolean — Indicator that the price has changed between booking stages - `priceBeforeChange` number, double, nullable — Selling price before change (only returned if PriceChanged is true) - `priceMinSell` boolean, nullable — Indicator that this has a minimum selling price from the supplier (only returned if true) - `ruleIds` integer[], nullable — List of rules identifiers applied to pricing - `memberRuleIds` integer[], nullable — List of rules identifiers applied to member pricing - `isRefundable` boolean, nullable — States if rate is refundable (see policies for more information and cancellation costs) - `refundability` 1 | 2 | 3 — Enumerator defining refundability of price:
1=NonRefundable, 2=Refundable, 3=PartialRefundable - `payNowPrice` number, double, nullable — Pay now price (can be used for refundable results where a small or no payment is needed up front) - `payDeadline` string, date-time, nullable — Payment deadline (normally used in conjunction with PayNowPrice) - `isLeadIn` boolean — States if rate is a lead-in/from price or a confirmed price - `breakdown` PriceItem[], nullable — Price breakdown - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `payAtLocation` PriceItem[], nullable — Price breakdown of items payable at location - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `depositOptions` DepositOption[], nullable — Array of deposit options available (if no options then no deposit available) - `id` integer — Option identifier - `ruleId` integer, nullable — Rule identifier - `dedupeId` integer, nullable — Option deduplication identifier - `amount` number, double — Amount to pay now - `installments` integer, nullable — Optional number of installments - `installmentsAmount` number, double, nullable — Optional amount to pay per installment - `dueDate` string, date-time, nullable — Optional balance due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `balance` number, double, nullable — Optional balance amount - `minDaysBefore` integer, nullable — Optional minimum days before departure - `name` string, nullable — Short name of option - `message` string, nullable — Promo message to show in information popup - `breakdown` DepositBreakdown[], nullable — Array of deposit breakdowns - `num` integer — Installment number - `amount` number, double — Installment amount - `dueDate` string, date-time — Installment due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `reward` RewardInfo — Reward object - `id` integer — Reward identifier - `title` string, nullable — Reward title - `description` string, nullable — Reward description - `terms` string, nullable — Reward terms - `imageUrl` string, nullable — Reward image url - `amount` number, double — Reward amount - `affiliate` AffiliateInfo — Affiliate information object - `name` string, nullable — Affiliate name - `logoUrl` string, nullable — Logo URL - `webUrl` string, nullable — Website URL - `deeplinkUrl` string, nullable — Deeplink URL to book this result (only applicable to affiliate results) - `priority` integer — Priority setting for front end sort (higher number first, default 0 deprioritised) - `priorityTag` string, nullable — Optional priority tag to explain reason for priority (eg. "Cheapest", "Fastest", "Best Value") - `uniqueID` string, nullable — Unique identifier of result (normally used for removing duplicates) - `orderItemID` integer, nullable — Order item identifier (can be used for removing item from order) - `booking` BookingInfo — Booking information - `success` boolean — Booking success - `supplierBookingRef` string, nullable — Supplier booking reference (if success) - `errorMessage` string, nullable — Booking error message (if failure) - `stepIdx` integer, nullable — Multicity step index (only returned for multicity results) - `stepTitle` string, nullable — Multicity step title (only returned for multicity results) - `uniqueRef` string, nullable — Unique reference of result from a third-party service (normally used for removing duplicates) - `propertyType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 — Enumerator defining type of property:
0=Any, 1=Unknown, 2=Hotel, 3=Apartment, 4=Villa, 5=House, 6=Boat, 7=Yacht, 8=Bungalow, 9=Chalet, 10=Farmhouse, 11=Guesthouse, 12=CastleMansion, 13=Camping, 14=Hostel, 15=ApartHotel, 16=Resort, 17=Cottage, 18=VacationHome - `supplierPropertyType` string, nullable — Optional supplier property type - `name` string, nullable — Name of accommodation - `chain` string, nullable — Name of the accommodation chain - `rating` number, double — Rating of accommodation (normally star rating) - `location` GeoPoint — Geographical point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `value` number, double — Distance value - `imageUrl` string, nullable — Image url of geographical point (if available) - `review` ReviewInfo — Review object - `platform` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `ref` string, nullable — Review platform reference - `reviews` integer, nullable — Number of reviews - `rating` number, double — Average review rating - `imageUrl` string, nullable — Review badge image url - `url` string, nullable — Review url (takes offsite so not recommended) - `descriptions` Information[], nullable — Array of accommodation descriptions - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining types of information content:
1=Generic, 2=ImportantInfo, 3=BookingConditions, 4=CancelAndAmendments, 5=Inclusions, 6=Exclusions, 7=OpeningTimes, 8=SafetyInformation, 9=Contact, 10=DateInfo, 11=Disclaimer, 12=Notes, 13=Menu - `title` string, nullable — Title of information object - `text` string, nullable — Text content of information object - `goodFor` GoodFor[], nullable — Array of good for flags - `amenities` PropertyAmenities[], nullable — Array of amenities/features of accommodation - `features` string[], nullable — Array of property features - `media` Media[], nullable — Array of accommodation media - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of media:
0=GenericImage, 1=Logo, 2=SquareImage, 3=LandscapeImage, 4=SeatingPlanImage, 5=Video, 6=Map - `url` string, nullable — URL of media - `thumbnailUrl` string, nullable — Thumbnail URL of media (only returned for Video media to allow showing a thumbnail) - `caption` string, nullable — Caption text for media (if available) - `width` integer, nullable — Width of media in pixels (if available) - `height` integer, nullable — Height of media in pixels (if available) - `isRoomAlloc` boolean — Defines if units are assigned to room allocations (if true each unit is allocated to a single room in the search criteria) - `isGroupedUnits` boolean — Defines if units are grouped (multiple rooms in a single unit option that must be booked together) - `units` AccommodationUnit[], nullable — Array of units/rooms available for accommodation - `uid` string, nullable — Unique unit identifier - `supplier` string, nullable — Internal supplier - `supplierRef` string, nullable — Internal supplier reference for unit to match against static data - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `name` string, nullable — Name of accommodation unit - `groupRoomQty` integer, nullable — Grouped rooms quantity - `roomAllocIdx` integer, nullable — Optional room allocation index if IsRoomAlloc is true - `roomType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 — Enumerator defining type of room:
0=Any, 1=Unknown, 2=Single, 3=Twin, 4=Double, 5=Triple, 6=Family, 7=Shared, 8=Apartment, 9=Villa, 10=Suite, 11=Queen, 12=King - `checkin` string, date-time — Check-in date - `nights` integer — Number of nights - `beds` string, nullable — Information about beds configuration within unit - `sleeps` string, nullable — Information about occupancy of the unit - `sleepsAdults` integer — Adult occupancy of unit - `sleepsChildren` integer — Child occupancy of unit - `sleepsInfants` integer — infant occupancy of unit - `descriptions` Information[], nullable — Array of unit descriptions - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining types of information content:
1=Generic, 2=ImportantInfo, 3=BookingConditions, 4=CancelAndAmendments, 5=Inclusions, 6=Exclusions, 7=OpeningTimes, 8=SafetyInformation, 9=Contact, 10=DateInfo, 11=Disclaimer, 12=Notes, 13=Menu - `title` string, nullable — Title of information object - `text` string, nullable — Text content of information object - `amenities` RoomAmenities[], nullable — Array of amenities/features of this unit - `available` integer — Number of this unit available - `media` Media[], nullable — Array of unit media - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of media:
0=GenericImage, 1=Logo, 2=SquareImage, 3=LandscapeImage, 4=SeatingPlanImage, 5=Video, 6=Map - `url` string, nullable — URL of media - `thumbnailUrl` string, nullable — Thumbnail URL of media (only returned for Video media to allow showing a thumbnail) - `caption` string, nullable — Caption text for media (if available) - `width` integer, nullable — Width of media in pixels (if available) - `height` integer, nullable — Height of media in pixels (if available) - `rates` AccommodationRate[], nullable — Array of rates available for unit - `rid` string, nullable — Unique rate identifier - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `deeplinkUrl` string, nullable — Deeplink URL to book this result (only applicable to affiliate results) - `name` string, nullable — Name of accommodation rate - `descriptions` Information[], nullable — Array of rate descriptions - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining types of information content:
1=Generic, 2=ImportantInfo, 3=BookingConditions, 4=CancelAndAmendments, 5=Inclusions, 6=Exclusions, 7=OpeningTimes, 8=SafetyInformation, 9=Contact, 10=DateInfo, 11=Disclaimer, 12=Notes, 13=Menu - `title` string, nullable — Title of information object - `text` string, nullable — Text content of information object - `amenities` string[], nullable — Array of amenities/features of this rate - `board` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 — Enumerator defining accommodation board basis:
0=Any, 1=RoomOnly, 2=SelfCatering, 3=BedAndBreakfast, 4=DinnerBedBreakfast, 5=HalfBoard, 6=FullBoard, 7=AllInclusive, 8=AllInclusivePlus, 9=CateredChalet, 10=AssistedChalet, 11=ManagedChalet, 12=FullBoardPlus, 13=CateredLodge, 14=Mixed, 15=BedAndDinner, 16=BedAndLunch, 17=BedAndMeal, 18=MealPlan, 19=MealPlanPlus - `isPackage` boolean, nullable — Rate is for packaging - `isOnRequest` boolean, nullable — Rate is on request - `supplierBoardType` string, nullable — Optional supplier board type - `available` integer — Number of this rate available - `selected` integer, nullable — Number of this rate selected - `pricing` Pricing — Pricing information object - `originalCurrency` string, nullable — Currency code of original source price - `originalPrice` number, double, nullable — Original source price (in original currency) - `exchangeRate` number, double — Exchange rate from original source currency - `currency` string, nullable — Currency code of selling and nett price - `nettPrice` number, double, nullable — Source price (before discounts or markups) - `trueNettPrice` number, double, nullable — True source price (before discounts or markups calculated from supplier commission) - `price` number, double — Selling price (after discounts or markups) - `inResortFees` number, double, nullable — In-resort fees (additional fees payable at the resort, if available) - `memberPrice` number, double, nullable — Member selling price - `priceBeforeMod` number, double, nullable — Selling price before modification (internal use only) - `priceChanged` boolean — Indicator that the price has changed between booking stages - `priceBeforeChange` number, double, nullable — Selling price before change (only returned if PriceChanged is true) - `priceMinSell` boolean, nullable — Indicator that this has a minimum selling price from the supplier (only returned if true) - `ruleIds` integer[], nullable — List of rules identifiers applied to pricing - `memberRuleIds` integer[], nullable — List of rules identifiers applied to member pricing - `isRefundable` boolean, nullable — States if rate is refundable (see policies for more information and cancellation costs) - `refundability` 1 | 2 | 3 — Enumerator defining refundability of price:
1=NonRefundable, 2=Refundable, 3=PartialRefundable - `payNowPrice` number, double, nullable — Pay now price (can be used for refundable results where a small or no payment is needed up front) - `payDeadline` string, date-time, nullable — Payment deadline (normally used in conjunction with PayNowPrice) - `isLeadIn` boolean — States if rate is a lead-in/from price or a confirmed price - `breakdown` PriceItem[], nullable — Price breakdown - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `payAtLocation` PriceItem[], nullable — Price breakdown of items payable at location - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `depositOptions` DepositOption[], nullable — Array of deposit options available (if no options then no deposit available) - `id` integer — Option identifier - `ruleId` integer, nullable — Rule identifier - `dedupeId` integer, nullable — Option deduplication identifier - `amount` number, double — Amount to pay now - `installments` integer, nullable — Optional number of installments - `installmentsAmount` number, double, nullable — Optional amount to pay per installment - `dueDate` string, date-time, nullable — Optional balance due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `balance` number, double, nullable — Optional balance amount - `minDaysBefore` integer, nullable — Optional minimum days before departure - `name` string, nullable — Short name of option - `message` string, nullable — Promo message to show in information popup - `breakdown` DepositBreakdown[], nullable — Array of deposit breakdowns - … - `reward` RewardInfo — Reward object - `id` integer — Reward identifier - `title` string, nullable — Reward title - `description` string, nullable — Reward description - `terms` string, nullable — Reward terms - `imageUrl` string, nullable — Reward image url - `amount` number, double — Reward amount - `earliestCancellation` string, date-time, nullable — Earliest cancellation date (internal use only) - `optionalExtras` OptionalExtra[], nullable — Array of optional extras available for accommodation (no longer used, use OptionalExtraGroups instead) - `eid` string, nullable — Unique extra identifier - `supplier` SupplierInfo — Supplier information object - `supplierType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `subSupplier` string, nullable — Internal sub supplier (if a consolidator) - `gds` string, nullable — Internal GDS supplier (when applicable) - `name` string, nullable — Supplier name - `currency` string, nullable — Currency code of supplier pricing - `supplierPrice` number, double — Supplier purchase price - `commission` number, double — Commission level (percentage) - `supplierResultRef` string, nullable — Supplier reference for result (eg. property reference) - `bookingData` object, nullable — Booking data store for any private data required during booking process - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 — Enumerator defining the type of an extra:
1=Generic, 2=Insurance, 3=Service, 4=FoodDrink, 5=Activity, 6=Luggage, 7=Pet, 8=Ticket, 9=Seat, 10=Transport, 11=Mandatory, 12=Room, 13=GiftVoucher, 14=ForeignExchange, 15=SportsEquipment, 16=OrderPayment - `name` string, nullable — Name of extra - `description` string, nullable — Description of extra - `information` Information[], nullable — Array of extra information - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining types of information content:
1=Generic, 2=ImportantInfo, 3=BookingConditions, 4=CancelAndAmendments, 5=Inclusions, 6=Exclusions, 7=OpeningTimes, 8=SafetyInformation, 9=Contact, 10=DateInfo, 11=Disclaimer, 12=Notes, 13=Menu - `title` string, nullable — Title of information object - `text` string, nullable — Text content of information object - `seat` SeatData — Seat data object - `col` string, nullable — Column - `row` integer — Row - `ftr` string, nullable — Features - `isPayAtPickup` boolean — Whether the extra charge is payable at reservation or at pickup - `maxQty` integer — Maximum quantity available for selection of this extra - `qtySelected` integer, nullable — Quantity selected - `pricing` Pricing — Pricing information object - `originalCurrency` string, nullable — Currency code of original source price - `originalPrice` number, double, nullable — Original source price (in original currency) - `exchangeRate` number, double — Exchange rate from original source currency - `currency` string, nullable — Currency code of selling and nett price - `nettPrice` number, double, nullable — Source price (before discounts or markups) - `trueNettPrice` number, double, nullable — True source price (before discounts or markups calculated from supplier commission) - `price` number, double — Selling price (after discounts or markups) - `inResortFees` number, double, nullable — In-resort fees (additional fees payable at the resort, if available) - `memberPrice` number, double, nullable — Member selling price - `priceBeforeMod` number, double, nullable — Selling price before modification (internal use only) - `priceChanged` boolean — Indicator that the price has changed between booking stages - `priceBeforeChange` number, double, nullable — Selling price before change (only returned if PriceChanged is true) - `priceMinSell` boolean, nullable — Indicator that this has a minimum selling price from the supplier (only returned if true) - `ruleIds` integer[], nullable — List of rules identifiers applied to pricing - `memberRuleIds` integer[], nullable — List of rules identifiers applied to member pricing - `isRefundable` boolean, nullable — States if rate is refundable (see policies for more information and cancellation costs) - `refundability` 1 | 2 | 3 — Enumerator defining refundability of price:
1=NonRefundable, 2=Refundable, 3=PartialRefundable - `payNowPrice` number, double, nullable — Pay now price (can be used for refundable results where a small or no payment is needed up front) - `payDeadline` string, date-time, nullable — Payment deadline (normally used in conjunction with PayNowPrice) - `isLeadIn` boolean — States if rate is a lead-in/from price or a confirmed price - `breakdown` PriceItem[], nullable — Price breakdown - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `payAtLocation` PriceItem[], nullable — Price breakdown of items payable at location - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `depositOptions` DepositOption[], nullable — Array of deposit options available (if no options then no deposit available) - `id` integer — Option identifier - `ruleId` integer, nullable — Rule identifier - `dedupeId` integer, nullable — Option deduplication identifier - `amount` number, double — Amount to pay now - `installments` integer, nullable — Optional number of installments - `installmentsAmount` number, double, nullable — Optional amount to pay per installment - `dueDate` string, date-time, nullable — Optional balance due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `balance` number, double, nullable — Optional balance amount - `minDaysBefore` integer, nullable — Optional minimum days before departure - `name` string, nullable — Short name of option - `message` string, nullable — Promo message to show in information popup - `breakdown` DepositBreakdown[], nullable — Array of deposit breakdowns - `num` integer — Installment number - `amount` number, double — Installment amount - `dueDate` string, date-time — Installment due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `reward` RewardInfo — Reward object - `id` integer — Reward identifier - `title` string, nullable — Reward title - `description` string, nullable — Reward description - `terms` string, nullable — Reward terms - `imageUrl` string, nullable — Reward image url - `amount` number, double — Reward amount - `location` PickupPoint — Pickup point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `value` number, double — Distance value - `imageUrl` string, nullable — Image url of geographical point (if available) - `id` integer, nullable — Identifier if this is an option - `supplierData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `onAirport` boolean, nullable — Defines if the pickup point is on airport grounds - `contactDetails` string, nullable — Contact details of the pickup point (if available) - `hours` string, nullable — Opening hours of the pickup point (if available) - `dateTime` string, date-time, nullable — Pickup date/time at the point - `media` Media[], nullable — Optional array of media - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of media:
0=GenericImage, 1=Logo, 2=SquareImage, 3=LandscapeImage, 4=SeatingPlanImage, 5=Video, 6=Map - `url` string, nullable — URL of media - `thumbnailUrl` string, nullable — Thumbnail URL of media (only returned for Video media to allow showing a thumbnail) - `caption` string, nullable — Caption text for media (if available) - `width` integer, nullable — Width of media in pixels (if available) - `height` integer, nullable — Height of media in pixels (if available) - `participants` TravellerData[], nullable — Array of participants - `type` 1 | 2 | 3, required — Enumerator defining main type of traveller:
1=Adult, 2=Child, 3=Infant - `title` 0 | 1 | 2 | 3 | 4 | 5 | 6, required — Enumerator defining traveller name titles:
0=Unspecified, 1=Mr, 2=Miss, 3=Mrs, 4=Ms, 5=Master, 6=Dr - `firstname` string, required — Firstname of traveller - `middleNames` string, nullable — Optional middle names or initials of traveller - `surname` string, required — Surname of traveller - `dateOfBirth` string, date-time — Date of birth of traveller (YYYY-MM-DD) - `age` integer, nullable — DISPLAY USE ONLY: Automatically calculated by date of birth on end of trip - `gender` 0 | 1 | 2 — Enumerator defining gender:
0=Unspecified, 1=Male, 2=Female - `nationality` string, nullable — Traveller nationality - `foidType` 1 | 2 | 3 — Enumerator defining forms of identification:
1=Passport, 2=NationalIDCard, 3=DrivingLicense - `foidNumber` string, nullable — Form of identification number - `foidStartDate` string, date-time, nullable — Form of identification start date (YYYY-MM-DD) - `foidExpiryDate` string, date-time, nullable — Form of identification expiry date (YYYY-MM-DD) - `foidIssuingCountry` string, nullable — Form of identification issuing country - `emailAddress` string, nullable — Optional traveller email address - `extras` ExtraSelectionItem[], nullable — Array of optional extras for this passenger - `eid` string, required — Extra ID - `gid` string, nullable — Optional Extra Group ID (if in extra group) - `tid` integer, nullable — Optional Traveller ID (if related to a traveller) - `qty` integer, required — Quantity required - `participants` TravellerData[], nullable — Array of participants for the extras booking - `roomAllocIdx` integer, nullable — Optional room allocation index (for accommodation bookings, only supported by some suppliers) - `optionalExtraGroups` OptionalExtraGroup[], nullable — Array of optional extra groups available for accommodation - `gid` string, nullable — Unique group identifier - `sid` string, nullable — Multicity step id (only returned for multicity results) - `stepIdx` integer, nullable — Multicity step index (only returned for multicity results) - `stepSubIdx` integer, nullable — Multicity step sub index (only returned for multicity results) - `stepTitle` string, nullable — Multicity step title (only returned for multicity results) - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `orderRef` string, nullable — Existing order reference link (INTERNAL USE ONLY) - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 — Enumerator defining the type of an extra:
1=Generic, 2=Insurance, 3=Service, 4=FoodDrink, 5=Activity, 6=Luggage, 7=Pet, 8=Ticket, 9=Seat, 10=Transport, 11=Mandatory, 12=Room, 13=GiftVoucher, 14=ForeignExchange, 15=SportsEquipment, 16=OrderPayment - `travellerTypes` TravellerTypes[], nullable — Array of traveller types this group applies to (if null then applies to all travellers, otherwise should be linked to each passenger) - `name` string, nullable — Name of group - `description` string, nullable — Description of group - `maxSelectable` integer — Maximum number of extras selectable from the group - `orderItemID` integer, nullable — Order item identifier (can be used for removing item from order) - `isAvailable` boolean — Returns if the result is available for purchase after a pricing and/or availability check. - `availabilityError` string, nullable — Availability error message - `location` PickupPoint — Pickup point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - `gmtOffset` integer, nullable — GMT offset (if available) - `latitude` number, double, nullable — Latitude of the geographical point (if available) - `longitude` number, double, nullable — Longitude of the geographical point (if available) - `what3Words` string, nullable — What3Words location description (if available) - `distance` Distance — Distance object - `units` 1 | 2 | 3 — Enumerator defining unit of distance:
1=KM, 2=Miles, 3=NauticalMiles - `value` number, double — Distance value - `imageUrl` string, nullable — Image url of geographical point (if available) - `id` integer, nullable — Identifier if this is an option - `supplierData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `onAirport` boolean, nullable — Defines if the pickup point is on airport grounds - `contactDetails` string, nullable — Contact details of the pickup point (if available) - `hours` string, nullable — Opening hours of the pickup point (if available) - `dateTime` string, date-time, nullable — Pickup date/time at the point - `cabin` CabinLayout — Flight cabin layout object - `cols` object, nullable — List of columns - `startRow` integer — Starting row number - `endRow` integer — Ending row number - `media` Media[], nullable — Optional array of media - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 — Enumerator defining type of media:
0=GenericImage, 1=Logo, 2=SquareImage, 3=LandscapeImage, 4=SeatingPlanImage, 5=Video, 6=Map - `url` string, nullable — URL of media - `thumbnailUrl` string, nullable — Thumbnail URL of media (only returned for Video media to allow showing a thumbnail) - `caption` string, nullable — Caption text for media (if available) - `width` integer, nullable — Width of media in pixels (if available) - `height` integer, nullable — Height of media in pixels (if available) - `extras` OptionalExtra[], nullable — List of optional extras - `eid` string, nullable — Unique extra identifier - `supplier` SupplierInfo — Supplier information object - `supplierType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 — Enumerator defining supplier types:
0=Unknown, 1=HitchHiker, 2=GoldMedalDNATA, 3=HotelBeds, 4=Ingresso, 5=Hoppa, 6=HolidayExtras, 7=FlexibleAutos, 8=AvisBudget, 9=VisaHQ, 10=EAN, 11=Insightly, 12=Tiqets, 13=HolidayTaxis, 14=GAdventures, 15=GoogleAnalytics, 16=Homestay, 17=ApartmentsApart, 18=Mailchimp, 19=Interhome, 20=DemoFlights, 21=TravelifyComparison, 22=SygicData, 23=DemoCarRental, 24=DemoTickets, 25=Leezair, 26=Traveltek, 27=YpsilonFlights, 28=Paxport, 29=Stripe, 30=Braintree, 31=ArrivalGuides, 32=WalkScore, 33=Encharge, 34=MailerLite, 35=DemoTransfer, 36=DemoAirportExtras, 37=AttractionWorld, 38=Square, 39=Impala, 40=PayPal, 41=SolmarVillas, 42=GFAHub, 43=Hubspot, 44=Zapier, 45=RateHawk, 46=Musement, 47=Intuitive, 48=ManualPayments, 49=eMerchantPay, 50=Worldpay, 51=GoGlobal, 52=TBO, 53=Carnect, 54=Yalago, 55=TIG, 56=RadicalStorage, 57=Penguin, 58=BlueInsurance, 59=Opayo, 60=Dolphin, 61=Jet2, 62=Felloh, 63=Barclaycard, 64=GoogleSheets, 65=FlyNowPayLater, 66=Travelify, 67=Tarsc, 68=EcommPay, 69=TrustPayments, 70=GetResponse, 71=Cardstream, 72=TripSolutions, 73=Innstant, 74=Bookabed, 75=JumboTours, 76=DOTW, 77=SunHotels, 78=PTSCloud, 79=Teldar, 80=TripAdvisor, 81=RePUSHTI, 82=Albena, 83=JTA, 84=APH, 85=What3words, 86=Moretrees, 87=Ecologi, 88=OTS, 89=Duffel, 90=Smyrooms, 91=Shareasale, 92=Sendy, 93=Feefo, 94=ConstantContact, 95=Webhook, 96=RoadGoat, 97=Tripian, 98=Olympic, 99=Skistar, 100=iTravex, 101=Suntransfers, 102=Afterpay, 103=Dixa, 104=CCAvenue, 105=AIBMS, 106=Seon, 107=Clicky, 108=Telr, 109=Zoho, 110=Etihad, 111=Advantage, 112=GetAddress, 113=Brightsun, 114=Hotelplanner, 115=USAePay, 116=ReePay, 117=Mondee, 118=VisitGroup, 119=SKAPIT, 120=Faremine, 121=ITSGroup, 122=MyFatoorah, 123=EveryHoliday, 124=ChatGPT, 125=Rewardful, 126=FlutterWave, 127=Decta, 128=Liftie, 129=HighLevelCRM, 130=DidaTravel, 131=Altura, 132=RMI, 133=Tixstock, 134=HNHolidays, 135=CurrencyExchange, 136=Evolvi, 137=Darina, 138=Klaviyo, 139=AerTicket, 140=ProtectGroup, 141=GoogleLogin, 142=VivaPayments, 143=Widgety, 144=Xs2Event, 145=Whapi, 146=CurrencyConverterAPI, 147=Pax2Pay, 148=TravelvogueAnex, 149=SingleSignOn, 150=TTSS, 151=SerpApi, 152=GlobalPay, 153=PKFare, 154=PierreVacances, 155=MercuryHolidays, 156=SunshineTech, 157=TUI, 158=NowPayments, 159=Stuba, 160=Skiset, 161=Easemytrip, 162=LiftsTo, 163=Jonview, 164=SinGSTravel, 165=PayFast, 166=IVectorConnect, 167=ZestCarRental, 168=BarclaysFuse, 169=MajorTravel, 170=Travelpack, 171=MintPayments, 172=TravelWorks, 173=Atlas, 174=Custom, 175=IdealPostcodes, 176=Paximum, 177=Webhotelier, 178=TTNG, 179=SportsEvents365, 180=Brevo, 181=TGContracting, 182=Amitour, 183=TotalProcessing, 184=InComm, 185=Intercom - `subSupplier` string, nullable — Internal sub supplier (if a consolidator) - `gds` string, nullable — Internal GDS supplier (when applicable) - `name` string, nullable — Supplier name - `currency` string, nullable — Currency code of supplier pricing - `supplierPrice` number, double — Supplier purchase price - `commission` number, double — Commission level (percentage) - `supplierResultRef` string, nullable — Supplier reference for result (eg. property reference) - `bookingData` object, nullable — Booking data store for any private data required during booking process - `bookingData` object, nullable — Supplier data store for any private data required during booking process (INTERNAL USE ONLY) - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 — Enumerator defining the type of an extra:
1=Generic, 2=Insurance, 3=Service, 4=FoodDrink, 5=Activity, 6=Luggage, 7=Pet, 8=Ticket, 9=Seat, 10=Transport, 11=Mandatory, 12=Room, 13=GiftVoucher, 14=ForeignExchange, 15=SportsEquipment, 16=OrderPayment - `name` string, nullable — Name of extra - `description` string, nullable — Description of extra - `information` Information[], nullable — Array of extra information - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — Enumerator defining types of information content:
1=Generic, 2=ImportantInfo, 3=BookingConditions, 4=CancelAndAmendments, 5=Inclusions, 6=Exclusions, 7=OpeningTimes, 8=SafetyInformation, 9=Contact, 10=DateInfo, 11=Disclaimer, 12=Notes, 13=Menu - `title` string, nullable — Title of information object - `text` string, nullable — Text content of information object - `seat` SeatData — Seat data object - `col` string, nullable — Column - `row` integer — Row - `ftr` string, nullable — Features - `isPayAtPickup` boolean — Whether the extra charge is payable at reservation or at pickup - `maxQty` integer — Maximum quantity available for selection of this extra - `qtySelected` integer, nullable — Quantity selected - `pricing` Pricing — Pricing information object - `originalCurrency` string, nullable — Currency code of original source price - `originalPrice` number, double, nullable — Original source price (in original currency) - `exchangeRate` number, double — Exchange rate from original source currency - `currency` string, nullable — Currency code of selling and nett price - `nettPrice` number, double, nullable — Source price (before discounts or markups) - `trueNettPrice` number, double, nullable — True source price (before discounts or markups calculated from supplier commission) - `price` number, double — Selling price (after discounts or markups) - `inResortFees` number, double, nullable — In-resort fees (additional fees payable at the resort, if available) - `memberPrice` number, double, nullable — Member selling price - `priceBeforeMod` number, double, nullable — Selling price before modification (internal use only) - `priceChanged` boolean — Indicator that the price has changed between booking stages - `priceBeforeChange` number, double, nullable — Selling price before change (only returned if PriceChanged is true) - `priceMinSell` boolean, nullable — Indicator that this has a minimum selling price from the supplier (only returned if true) - `ruleIds` integer[], nullable — List of rules identifiers applied to pricing - `memberRuleIds` integer[], nullable — List of rules identifiers applied to member pricing - `isRefundable` boolean, nullable — States if rate is refundable (see policies for more information and cancellation costs) - `refundability` 1 | 2 | 3 — Enumerator defining refundability of price:
1=NonRefundable, 2=Refundable, 3=PartialRefundable - `payNowPrice` number, double, nullable — Pay now price (can be used for refundable results where a small or no payment is needed up front) - `payDeadline` string, date-time, nullable — Payment deadline (normally used in conjunction with PayNowPrice) - `isLeadIn` boolean — States if rate is a lead-in/from price or a confirmed price - `breakdown` PriceItem[], nullable — Price breakdown - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `payAtLocation` PriceItem[], nullable — Price breakdown of items payable at location - `type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Enumerator defining type of pricing:
0=Base, 1=Fare, 2=Tax, 3=Insurance, 4=Surcharge, 5=Service, 6=Extra, 7=SalesTax, 8=Delivery - `supplierType` string, nullable — Supplier type/code of item - `name` string, nullable — Name of item - `description` string, nullable — Description of item - `unitPrice` number, double, nullable — Unit price of item - `qty` integer — Quantity (to get total, always multiple unit price by quantity) - `depositOptions` DepositOption[], nullable — Array of deposit options available (if no options then no deposit available) - `id` integer — Option identifier - `ruleId` integer, nullable — Rule identifier - `dedupeId` integer, nullable — Option deduplication identifier - `amount` number, double — Amount to pay now - `installments` integer, nullable — Optional number of installments - `installmentsAmount` number, double, nullable — Optional amount to pay per installment - `dueDate` string, date-time, nullable — Optional balance due date - `supplierDueDate` string, date-time, nullable — Optional supplier balance due date - `balance` number, double, nullable — Optional balance amount - `minDaysBefore` integer, nullable — Optional minimum days before departure - `name` string, nullable — Short name of option - `message` string, nullable — Promo message to show in information popup - `breakdown` DepositBreakdown[], nullable — Array of deposit breakdowns - … - `reward` RewardInfo — Reward object - `id` integer — Reward identifier - `title` string, nullable — Reward title - `description` string, nullable — Reward description - `terms` string, nullable — Reward terms - `imageUrl` string, nullable — Reward image url - `amount` number, double — Reward amount - `location` PickupPoint — Pickup point object - `iataCode` string, nullable — IATA code of the geographical point (if available, only if point is an airport) - `terminal` string, nullable — Terminal of the geographical point (if available, only if point is an airport) - `name` string, nullable — Name of the geographical point (if available) - `description` string, nullable — Description of geographical point (if available) - `address1` string, nullable — First line of the address - `address2` string, nullable — Second line of the address - `city` string, nullable — City name - `state` string, nullable — State/county/region - `postalCode` string, nullable — Postal/Zip code - `country` string, nullable — Country (normally 2-letter country code) - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — Bad Request - `401` — Unauthorized - `417` — Expectation Failed - `500` — Internal Server Error --- [API](https://skmtc.dev/travelify/apis/travelify-io-api.md) · [All operations](https://skmtc.dev/travelify/apis/travelify-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/travelify/travelify-io-api/revisions/b09ce3f0c6d5/schema)