TUI Group Bookings API
The Bookings API from TUI Group — 71 operation(s) for bookings.
TUI Group Bookings API is one of 113 APIs that TUI Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Booking. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 76 operations across 71 paths, and defines 357 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 6 base URLs: https://prod.api.tui/cruise-ota-book, https://pre-prod.api.tui/cruise-ota-book, https://prod.api.tui/flight/newskies/rest, https://playground.api.tui/flight/newskies/rest, https://prod.api.tui/flight/newskies/gonow, https://playground.api.tui/flight/newskies/gonow.
76 operations
71 paths
357 schemas
5 DELETE45 GET21 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
TUI Group Bookings API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (jwt) (JWT).
JWT— Paste your JWT token from the token endpoint.
Paths & Operations 76
Across 71 paths, the API surfaces 76 operations — 5 DELETE, 45 GET, 21 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Bookings 76
POST
/validate-holiday
Validate holiday for cruises
POST
/confirm-holiday
Confirm to book holiday for cruises
GET
/api/nsk/v2/bookings
Retrieves the booking from the New Skies server based on the retrieve booking…
GET
/api/nsk/v1/bookings/{bookingKey}/history
Gets an itinerary history stateless
GET
/api/nsk/v1/bookings/{bookingKey}/history/bagTagPrint
Gets the current bag tag print history for a booking, stateless
POST
/api/nsk/v1/bookings/{bookingKey}/history/bagTagPrint
Creates a bag tag print history for a booking, stateless
GET
/api/nsk/v1/bookings/{bookingKey}/history/flightMove
Gets a flight move history stateless
GET
/api/nsk/v1/bookings/{bookingKey}/history/holdDateChange
Gets the hold date change history records for a booking
GET
/api/nsk/v1/bookings/{bookingKey}/history/itinerarySent
Gets the itinerary sent history records for a booking
GET
/api/nsk/v1/bookings/{bookingKey}/history/message
Gets a booking's message history, stateless
GET
/api/nsk/v1/bookings/{bookingKey}/history/notification
Gets the booking notification history, stateless
GET
/api/nsk/v1/bookings/{bookingKey}/history/seatAssignment
Gets a seat assignment history stateless
GET
/api/nsk/v1/bookings/{bookingKey}/history/segmentChange
Gets a segment change history stateless
POST
/api/nsk/v3/bookings/{bookingKey}/queue
Adds a booking to a booking queue
POST
/api/nsk/v2/bookings/{bookingKey}/queuedeprecated
Adds a booking to a booking queue
DELETE
/api/nsk/v2/bookings/{bookingKey}/queue
Removes a booking from a booking queue
POST
/api/nsk/v1/bookings/{bookingKey}/queue/history
Gets the booking queue history for a specific booking
GET
/api/nsk/v1/bookings/{recordLocator}
Retrieves a booking itinerary stateless
GET
/api/nsk/v1/bookings/{recordLocator}/account
Retrieves the booking account and collections based on the record locator
POST
/api/nsk/v1/bookings/{recordLocator}/account
Creates the booking account based on the record locator and data in the request
POST
/api/nsk/v1/bookings/{recordLocator}/account/collection
Creates a booking account collection and transaction based on the record…
GET
/api/nsk/v1/bookings/{recordLocator}/account/collection/{accountCollectionKey}/transactionsdeprecated
Retrieves the booking account collection transactions based on the record…
POST
/api/nsk/v1/bookings/{recordLocator}/account/collection/{accountCollectionKey}/transactions
Creates a booking account collection transaction based on the record locator…
GET
/api/nsk/v2/bookings/{recordLocator}/account/collection/{accountCollectionKey}/transactions
Retrieves the booking account collection transactions based on the record…
PUT
/api/nsk/v1/bookings/{recordLocator}/account/status
Updates the booking account status
GET
/api/nsk/v1/bookings/{recordLocator}/account/transactionsdeprecated
Retrieves all of the transactions for all of the collections for the booking
GET
/api/nsk/v2/bookings/{recordLocator}/account/transactions
Retrieves all of the transactions for the booking
GET
/api/nsk/v1/bookings/{recordLocator}/children
Gets children record locators of a booking not in state
POST
/api/nsk/v3/bookings/{recordLocator}/comments
Adds a comment to a booking not in state
POST
/api/nsk/v1/bookings/{recordLocator}/email
Sends itinerary notification via email
POST
/api/nsk/v1/bookings/{recordLocator}/fareOverride/journey/{journeyKey}
Replaces an existing fare price with an amount specified
PUT
/api/nsk/v1/bookings/{recordLocator}/fees/{passengerFeeKey}/confirm
Confirms the passenger fee for a given booking
PUT
/api/nsk/v1/bookings/{recordLocator}/journeydeprecated
Moves a journey on a stateless booking to a different journey
PUT
/api/nsk/v2/bookings/{recordLocator}/journey
Moves a journey on a stateless booking to a different journey
PUT
/api/nsk/v1/bookings/{recordLocator}/journey/adHocMove
Combines a collection of journeys represented by the "ToJourneyKeys" into one…
POST
/api/nsk/v2/bookings/{recordLocator}/notification
Sends itinerary notification
GET
/api/dcs/v1/bookings/{recordLocator}/passengers/{passengerKey}/documents/check
Gets the document check status for a specific passenger if there are any on a…
GET
/api/dcs/v1/bookings/{recordLocator}/passengers/{passengerKey}/infant/documents/check
Gets the document check status for a specific passenger's infant if there are…
POST
/api/nsk/v1/bookings/{recordLocator}/passengers/{passengerKey}/seats/{unitKey}
Agent only. Adds a seat assignment to a specific passenger on a booking
DELETE
/api/nsk/v1/bookings/{recordLocator}/passengers/{passengerKey}/seats/{unitKey}
Agent only. Deletes a seat assignment from a specific passenger on a booking
POST
/api/nsk/v1/bookings/{recordLocator}/queues/{queueCode}
Retrieves the details for the booking queues of a specific booking
GET
/api/nsk/v1/bookings/byBookingId/{bookingId}
Retrieves a booking itinerary stateless
DELETE
/api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}
Removes the checkin status of passengers for a specific journey stateless
POST
/api/nsk/v3/bookings/checkin/{recordLocator}/journey/{journeyKey}
Checks in a collection of passengers to a specific journey stateless
GET
/api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}/requirementsdeprecated
Gets the checkin pre-validation requirements for a specific journey
GET
/api/nsk/v2/bookings/checkin/{recordLocator}/journey/{journeyKey}/requirements
Gets the checkin pre-validation requirements for a specific journey version 2
GET
/api/nsk/v1/bookings/checkin/{recordLocator}/journey/{journeyKey}/status
Gets the passengers lift status stateless for a specific journey based on the…
DELETE
/api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}
Removes the checkin status of passengers for a specific journey's segment…
POST
/api/nsk/v3/bookings/checkin/{recordLocator}/segment/{segmentKey}
Checks in a collection of passengers to a specific journeys segment stateless
GET
/api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}/requirementsdeprecated
Gets the checkin pre-validation requirements for a specific bookings journeys…
GET
/api/nsk/v2/bookings/checkin/{recordLocator}/segment/{segmentKey}/requirements
Gets the checkin pre-validation requirements for a specific bookings journeys…
GET
/api/nsk/v1/bookings/checkin/{recordLocator}/segment/{segmentKey}/status
Gets the passengers lift status stateless for a specific segment based on the…
POST
/api/nsk/v1/bookings/queues
Queues the bookings by inventory leg
DELETE
/api/nsk/v1/bookings/queues/{bookingQueueKey}
Removes a booking from the specified booking queue item
GET
/api/nsk/v2/bookings/queues/{queueCode}/items
Retrieves the booking queue items associated with the queue code
POST
/api/nsk/v2/bookings/quote
Retrieves an itinerary quote based on the request
GET
/api/nsk/v2/bookings/searchByAgency
Find booking by agency
GET
/api/nsk/v2/bookings/searchByAgent
Find booking by agent
GET
/api/nsk/v2/bookings/searchByAgentCode
Find booking by the agent code
GET
/api/nsk/v3/bookings/searchByBagTag
Find booking by a bag tag.
GET
/api/nsk/v2/bookings/searchByContact
Find booking by contact
GET
/api/nsk/v2/bookings/searchByContactCustomerNumber
Find booking by contact customer number
POST
/api/nsk/v1/bookings/searchByCreditCard
Find booking by credit card number
GET
/api/nsk/v2/bookings/searchByCustomerNumber
Find booking by customer number
GET
/api/nsk/v2/bookings/searchByDate
Find booking by date
GET
/api/nsk/v2/bookings/searchByDocument
Find booking by document
GET
/api/nsk/v2/bookings/searchByEmail
Find booking by email
GET
/api/nsk/v1/bookings/searchByExternalPayment
Used to search the list of bookings that have used the account from the payment.
GET
/api/nsk/v2/bookings/searchByLastName
Find booking by last name
GET
/api/nsk/v1/bookings/searchByPerson
Retrieves the bookings of the specified person based on the date range
GET
/api/nsk/v2/bookings/searchByPhone
Find booking by phone
GET
/api/nsk/v2/bookings/searchByRecordLocator
Find booking by record locator
GET
/api/nsk/v2/bookings/searchByReferenceNumber
Find booking by reference number.
GET
/api/nsk/v3/bookings/searchByThirdPartyRecordLocator
Find booking by a third party record locator
GET
/api/nsk/v1/bookings/watchList/{bookingKey}
Retrieves the watch list for a specific booking
POST
/api/dcs/v2/bookings/searchByScan
Parses scanner output and performs a booking search based on the type of scan
Schemas 357
The contract defines 357 schemas that model the data the API accepts and returns. The most detailed are LegInformation (30 properties), PassengerSegment (29 properties), Payment (28 properties), ValHolidayResponseRoute (28 properties). Each schema is shown below with its type and property counts.
ValidateHolidayRequest
object
1 property
1 required
ValHolidayResponseFlight_DateTime
object
2 properties
1 required
ValHolidayResponseAdm
object
6 properties
ValHolidayResponseProm
object
Promotion information
5 properties
ValHolidayResponseCltInfo
object
11 properties
InfoBookingRequest
object
7 properties
7 required
Memo
array
Memo information
ValHolidayRequestFlight_DateTime
object
2 properties
1 required
ValHolidayRequestMultiCentre
object
7 properties
5 required
Transfer_Info
array
Transfer information
ValHolidayRequestBkg_Ent
object
3 properties
Prom
object
Promotion object with attributes
1 property
1 required
ValHolidayResponseSource
object
3 properties
ValHolidayResponseRoomCode
object
20 properties
3 required
ValidateHolidayResponse
object
1 property
1 required
ValHolidayRequestSource
object
1 property
1 required
ValHolidayResponsePackage
object
3 properties
ValHolidayRequestRouting
object
3 properties
2 required
SubServPaxs
object
1 property
ValHolidayResponseRouting
object
2 properties
2 required
TUITILResponse
object
1 property
1 required
ValHolidayRequestMultiCentreProduct
object
3 properties
1 required
ValHolidayResponseAccommodation
object
12 properties
5 required
Problem
object
General error response object based on RFC 7807
3 properties
ValHolidayRequestOfferChoice
object
2 properties
1 required
ValHolidayRequestHotelProduct
object
3 properties
2 required
RoomCode
object
4 properties
3 required
ConfirmHolidayRequest
object
1 property
ValHolidayResponseSec
object
13 properties
4 required
Summary_Prices
object
1 property
ValHolidayResponseRoute
object
28 properties
4 required
ValHolidayRequestPackage
object
3 properties
ValHolidayRequestRoute
object
13 properties
4 required
Prices
object
1 property
TILInfoBookingResponse
object
2 properties
2 required
Item
array
List of additional items in the booking
ValHolidayRequestAdm
object
1 property
ValHolidayResponseBkg_Ent
object
13 properties
SubServPax
object
1 property
1 required
ValHolidayRequestRoute_List
object
1 property
1 required
SubServicePassengers
object
1 property
ValHolidayRequestSub_Source
object
1 property
1 required
ValHolidayResponseHotelProduct
object
1 property
2 required
Flt_Extra_Cat_List
array
ValHolidayResponseRoute_List
object
1 property
1 required
ValHolidayResponseMultiCentre
object
10 properties
5 required
Item_Element
object
11 properties
5 required
ValHolidayRequestAccommodation
object
5 properties
5 required
ValHolidayResponseItem_Element
object
24 properties
5 required
ValHolidayResponseOfferChoice
object
4 properties
1 required
ValHolidayResponseSub_Source
object
3 properties
Person
object
5 properties
5 required
InfoBookingResponse
object
23 properties
4 required
PayData
object
10 properties
Pax_Element
object
3 properties
2 required
ValHolidayRequestSec
object
5 properties
4 required
ConfirmHolidayResponse
object
1 property
Pax
array
List of passengers in the booking
ValHolidayResponseMultiCentreProduct
object
5 properties
1 required
SubServicePassenger
object
1 property
1 required
Address
object
Defines a common address.
7 properties
IJsonResponseOfIListOfString
object
Defines the JSON response contract.
3 properties
CheckinPassengerRestriction
object
Defines a passengers restriction for the current segment trying to be checked into.
2 properties
BookingHistoryEvent
integer
Represents the different events that trigger an entry into the schedule history. 0 = Unknown 1 = ConvertedHistory 2 = FlightTimeChange 3 = FlightDesignatorChan…
DistributionOption
integer
This enumeration specifies the distribution methods for sending notifications. 0 = None 1 = Mail 2 = Email 3 = Fax 4 = MailFax 5 = Airport 6 = Hold 7 = Print
CommentType
integer
Comment Types Enumerations 0 = Default 1 = Itinerary 2 = Manifest 3 = Alert 4 = Archive 5 = Voucher
SsrDurationType
integer
Ssr duration type. 0 = Segment 1 = Journey 2 = Leg
PagedTransactionResponse
object
The paged transaction response.
3 properties
AddOnOrderSummary
object
Defines the details about an order if the order is not available.
11 properties
Exception
object
4 properties
Segment
object
Segment model for an already booked flight.
23 properties
TransactionType
integer
The dotREZ specific transaction types. This includes some system specific values that are not allowed during a transaction creation. 0 = Default 1 = Payment 2…
BookingStatus
integer
Booking Status Enumeration 0 = Default 1 = Hold 2 = Confirmed 3 = Closed 4 = HoldCanceled 5 = PendingArchive 6 = Archived 7 = ArchivedPrivate 777 = ProcessedFo…
SeatPreferenceStatus
integer
Defines the seat preference status. 0 = Unknown 1 = Met 2 = NotMet
GovernmentPassengerDocumentRequirementv2
object
Defines a specific government document requirements for a specific passenger. Version 2
5 properties
AmountDue
object
Defines the amounts due for an order.
3 properties
PagedBookingSearchByPersonResult
object
Defines a paged booking search by person result.
2 properties
PassengerBag
object
Model information about the passenger's baggage.
11 properties
IJsonResponseOfIListOfBagTagPrintHistory
object
Defines the JSON response contract.
3 properties
TravelClassSeatPreference
integer
Represents a travel class seating preference. 0 = None 1 = Business 2 = Economy 3 = FirstClass
AddOnPriceBreakdown
object
Defines the addOn price breakdown.
3 properties
OrderCustomer
object
Defines an order customer contact details.
11 properties
ThreeDSecure
object
Defines three D secure.
24 properties
ReceivedByInfo
object
Defines the received by information.
5 properties
AccountCollection
object
The account collection model.
7 properties
RecordLocator
object
Defines a unique locator for reference.
7 properties
ChallengePreference
integer
Defines the challenge preference. 0 = NoPreference 1 = NoChallengeRequested 2 = ChallengeRequested 3 = ChallengeMandated
FareApplicationType
integer
This enumeration defines the fare application type of a fare. 0 = Route 1 = Sector 2 = Governing
WatchListResponse
object
The watch list response.
8 properties
PassengerScore
object
Defines a passenger score.
3 properties
1 required
BookingQueueHistoryEvent
integer
The booking queue history code values represent the different events that trigger an entry into the booking queue history. 0 = Unknown 1 = Add 2 = Remove 3 = U…
ChannelType
integer
Defines the available channel types doing invoking the communication with the server. 0 = Default 1 = Direct 2 = Web 3 = Gds 4 = Api 5 = DigitalApi 6 = Digital…
BookingPaymentStatus
integer
Determines if the booking has been paid for or not. 0 = New 1 = Received 2 = Pending 3 = Approved 4 = Declined 5 = Unknown 6 = PendingCustomerAction
OrderLocation
object
Defines a location.
4 properties
2 required
PaymentAction
integer
Defines payment action that should be taken by selling system for this service. 1 = SellingSystemCollects 2 = PassThroughHold 3 = NoPaymentRequired 4 = ReferTo…
BookingSearchResult
object
Booking model data.
17 properties
DirectCurrencyConversion
object
Defines a direct currency conversion.
7 properties
PassengerTicketInfo
object
Represents detailed information for an e-ticket assigned to a passenger.
4 properties
UnitInventoryControlType
integer
Enum indicates the type of hold placed on the seat. 0 = Session 1 = None
CheckinRestrictionType
integer
Defines the checkin level restriction types. 0 = Closed 1 = NotOpened 2 = PnrLocked 3 = MarketingCodeShareNotAllowed 4 = NotPaidInFull 5 = PaymentsPending 6 =…
BookingHistory
object
Defines a booking history log entry.
8 properties
TransitType
integer
Defines the different type of transit states. 0 = Default 1 = Origin 2 = Destination 3 = Both
HoldDateChangeHistoryResponse
object
Defines a hold date change history response.
2 properties
OverbookIndicatorTypes
integer
Specifies the type of code share agreement. 0 = NormalSell 1 = Oversold 2 = ClassOrCabinOversold
Ticket
object
Model for a ticket applied to a passenger.
5 properties
LegStatus
integer
Leg status enumeration. 0 = Normal 1 = Closed 2 = Canceled 3 = Suspended 5 = ClosedPending 6 = BlockAllActivities 7 = Mishap
GovernmentPassengerDocumentRequirement
object
Defines a specific government document requirements for a specific passenger.
3 properties
IJsonResponseOfPagedTransactionResponse
object
Defines the JSON response contract.
3 properties
QueueAction
integer
Specifies the basics by which a queue filter was created. 0 = Default 1 = Warning 2 = Lock 3 = DefaultAndNotify 4 = WarningAndNotify 5 = LockAndNotify
SubscriptionEventType
integer
Represents the different subscription events. 0 = Unknown 1 = Departure 2 = DepartureDelay 3 = Arrival 4 = ArrivalDelay 5 = ScheduleChange 6 = CheckIn 7 = Gate…
PassengerInfant
object
Model representing an infant with a passenger.
9 properties
SeatAssignmentHistory
object
Defines a seat assignment history log entry.
10 properties
CollectType
integer
Used to identify the collect type of a service charge. 0 = SellerChargeable 1 = ExternalChargeable 2 = SellerNonChargeable 3 = ExternalNonChargeable 4 = Extern…
TypeOfSale
object
Defines the type of sale values.
3 properties
GssStayType
integer
The type of stay type. 0 = None 1 = Vacation 2 = Business 3 = Duty
ChargeBreakdown
object
Defines a charge breakdown.
4 properties
Order
object
Defines a order.
28 properties
FlightMoveHistory
object
Defines a flight move history log entry.
10 properties
IJsonResponseOfIListOfBookingMessageHistory
object
Defines the JSON response contract.
3 properties
DocumentCheckStatus
integer
Represents the status of a document after performing a third party document check. More detailed information is intentionally not provided for security reasons…
FareDesignator
object
Model describing the fare designator information.
1 property
PaymentAttachment
object
Defines a payment attachment.
3 properties
PassengerVoucherCustomerProgram
object
Defines the passenger voucher customer program.
2 properties
SearchBookingsByCreditCard
object
Search for a booking by credit card.
4 properties
1 required
FlightType
integer
Flight types enumeration. 0 = None 1 = NonStop 2 = Through 3 = Direct 4 = Connect 5 = All
BagTagInformation
object
Defines bag tag information.
5 properties
ClassStatus
integer
Indicates whether a leg class may be used or not. 1 = Active 2 = InActive 3 = AvsOpen 4 = AvsOnRequest 5 = AvsClosed
AuthorizationStatus
integer
Defines the different possible payment authorization states. 0 = Unknown 1 = Acknowledged 2 = Pending 3 = InProcess 4 = Approved 5 = Declined 6 = Referral 7 =…
PassengerFee
object
Model representing passenger fee information.
16 properties
1 required
PassengerFare
object
Model that represents the passenger fare details.
5 properties
1 required
Amount
object
Defines an amount base price and total price.
2 properties
PassengerInformation
object
Represents additional passenger information.
6 properties
Contact
object
Contact model describing a person contact information.
11 properties
1 required
CheckinPassengerRequest
object
Defines the individual passenger checkin request.
4 properties
1 required
PassengerVoucherUsageType
integer
Passenger voucher usage type specifies what parts of a booking this voucher can pay for. 0 = None 1 = Fares 2 = Taxes 3 = TravelFees 4 = ServiceFees 5 = Penalt…
CheckinDocumentRequirementsv2
object
Defines passenger checkin document requirements version 2.
3 properties
Payment
object
Defines an applied payment on the booking.
28 properties
BookingQueueDetail
object
The detail in a booking queue model.
4 properties
AddOnStatus
integer
An enumeration to indicate the add on's current status. 0 = Unknown 1 = Active 2 = Pending 3 = Confirming 4 = CancelPending 5 = Cancelled
ItineraryQuote
object
Defines the itinerary quote model.
3 properties
FlightMoveHistoryResponse
object
Defines a flight move history response.
2 properties
FareStatus
integer
This enumeration defines the fare status of a passenger fare. 0 = Default 1 = SameDayStandBy 2 = FareOverrideConfirming 3 = FareOverrideConfirmed 4 = Published…
SeatAssignmentEvent
integer
Represents the different events that trigger an entry into the seat assignment history. 4 = AssignedSeat 5 = RemoveSeat
HoldDateChangeEvent
integer
Represents the different events that trigger an entry into the hold date change history. 66 = Created 67 = Removed 68 = Changed
PassengerTypeCriteria
object
Defines the availability criteria passenger types.
2 properties
1 required
QueueMode
integer
Determines where a queue request is coming from. 0 = EnQueued 1 = DeQueued
QueueBookingByInventoryLegRequest
object
The queue booking by inventory leg request model
3 properties
3 required
BookingMessageHistoryType
integer
Represents the booking message history types. 0 = TeletypeMessage 1 = ETicket 2 = GovernmentSecurity 3 = PnrGovernment 4 = BaggageMessage 5 = Iatci 6 = EMD
HoldDateChangeHistory
object
Defines a hold date change history log entry.
7 properties
PassengerAddress
object
Passenger address information. This contains more data then the base address class.
15 properties
SeatPreferences
object
Represents the seating preferences base model.
3 properties
IJsonResponseOfSeatAssignmentHistoryResponse
object
Defines the JSON response contract.
3 properties
CheckinPassengerLiftStatus
object
Defines a single passengers checkin status for a specific segment.
2 properties
BookingQueuesRequest
object
The booking request base model for retrieving booking queues.
3 properties
BookingProfileStatus
integer
Defines the profiling status of the booking. 0 = Default 1 = KnownIndividual 2 = ResolutionGroup 3 = SelecteeGroup 4 = NotUsed 5 = FailureGroup 6 = RandomSelec…
LegInformation
object
Model describing the detailed leg information.
30 properties
Fare
object
Model describing a fare.
22 properties
DepartureEvent
object
Represents the flight operation times for the departure event, which includes an estimated and scheduled time event.
2 properties
InputedParameter
object
Defines a parameter with data input.
3 properties
ErrorResponse
object
Defines a unique error response.
8 properties
IJsonResponseOfHistoryResponse
object
Defines the JSON response contract.
3 properties
RetrieveBookingQueueResponseItem
object
The booking queue response items for retrieving booking queue items.
8 properties
ApisAddressStatus
integer
Defines what type of APIS requirement is the address. 0 = Residence 1 = InCountry 2 = Emergency 3 = Contact
IJsonResponseOfRetrieveBookingQueueResponse
object
Defines the JSON response contract.
3 properties
RetrieveBookingQueueResponse
object
The booking queue response for retrieving booking queue items.
2 properties
MatchKeyType
integer
The match key type enumeration. 0 = Default 1 = PassengerAlternateKey 2 = ContactTypeCode 3 = PaymentKey
CheckinPassengerRestrictionType
integer
Defines the checkin passenger restriction types. 0 = NotFound 1 = MissingDestinationAddress 2 = MissingCountryOrResidence 3 = OnLockQueue 4 = MissingRequiredSs…
GovernmentAdditionalDataType
integer
Defines the additional data that is required for a government program but are not collected with documents. 0 = CountryOfResidence 1 = InTransitOrigin 2 = InTr…
OrderAddress
object
Defines an address with GPS coordinates.
8 properties
IJsonResponseOfItinerarySentHistoryResponse
object
Defines the JSON response contract.
3 properties
CreateAccountRequest
object
The create account request model.
1 property
BookingFilters
object
Model representing the booking filters available when searching.
9 properties
BagTagPrintHistory
object
Defines bag tag print history.
12 properties
SeatAssignmentHistoryResponse
object
Defines a seat assignment history response.
2 properties
BookingQueueDeleteRequest
object
The booking queue delete request.
4 properties
2 required
IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus
object
Defines the JSON response contract.
3 properties
IJsonResponseOfCheckinRequirementsv2
object
Defines the JSON response contract.
3 properties
Journey
object
Data about the journey which represents the collection of segments and their legs on the journey.
7 properties
OrderPayment
object
Defines a payment on an order.
13 properties
1 required
BookingQueueHistoryRequest
object
The booking queue history request model.
4 properties
FeeType
integer
Enumeration representing all the different fee types. 0 = All 1 = Tax 2 = TravelFee 3 = ServiceFee 4 = PaymentFee 5 = PenaltyFee 6 = SsrFee 7 = NonFlightServic…
BookingSales
object
Defines the different point of sale information.
3 properties
BookingQueueDeleteByKeyRequest
object
The booking queue delete by queue key request.
3 properties
2 required
LiftStatus
integer
Lift status enumeration. 0 = Default 1 = CheckedIn 2 = Boarded 3 = NoShow
BookingQueueRestriction
integer
Defines the restrictions associated with a BookingQueue 0 = Restricted 1 = AddAllowedOnly 2 = Allowed
IJsonResponseOfPagedBookingSearchByPersonResult
object
Defines the JSON response contract.
3 properties
NestType
integer
Nest type enumeration. 0 = Default 1 = Net 2 = Serial 3 = OneBooking
BookingPriceBreakdown
object
Defines the booking top level pricing breakdown.
13 properties
MessageStatus
integer
Defines the message status. 0 = General 1 = Warning 2 = Critical
CheckinAddressRequirements
object
Defines a passenger checkin address requirements.
3 properties
IJsonResponseOfIListOfBookingNotificationHistory
object
Defines the JSON response contract.
3 properties
LegClass
object
The leg class model information.
11 properties
1 required
MoveJourneyRequest
object
Defines the move journey request.
9 properties
3 required
BookingPointOfSale
object
Model related to the point of sale.
6 properties
ChargeType
integer
The type of a service charge. 0 = FarePrice 1 = Discount 2 = IncludedTravelFee 3 = IncludedTax 4 = TravelFee 5 = Tax 6 = ServiceCharge 7 = PromotionDiscount 8…
CodeShareIndicator
integer
Specifies the type of code share agreement. 0 = NonCodeShare 1 = CodeShareCommercialDuplicate 2 = SharedDesignatorOrWetLease 3 = CodeShareHostOperatingCarrier…
SegmentStatus
integer
The segment status. 0 = UnknownStatus 1 = UnableToConfirmSegment 2 = UnableToSellSegment 3 = HeldPending 4 = WaitListConfirmed 5 = HeldUnconfirmed 6 = HeldConf…
PassengerPriceBreakdownBase
object
Defines the combined booking passengers pricing breakdown.
9 properties
IJsonResponseOfIListOfTransaction
object
Defines the JSON response contract.
3 properties
OrderPriceBreakdown
object
Defines all the different order price breakdown.
18 properties
CreatedAddOnDetails
object
Defines a component details.
6 properties
SimpleSeatPreference
integer
Represents a simple seating preference. 0 = None 1 = Window 2 = Aisle 3 = Other
ItinerarySentHistory
object
Defines an itinerary sent history log entry.
8 properties
DirectCurrencyConversionStatus
integer
Enumeration that determines the status of a DCC authorization. 0 = DccNotOffered 1 = DccOfferRejected 2 = DccOfferAccepted 3 = DccInitialValue 4 = MccInUse
PaymentMethodType
integer
Defines the payment method types. 0 = ExternalAccount 1 = PrePaid 2 = AgencyAccount 3 = CustomerAccount 4 = Voucher 5 = Loyalty
DepartureStatus
integer
Departure status. 0 = Default 1 = Cancelled 2 = Boarding 3 = SeeAgent 4 = Delayed 5 = Departed
AccountStatus
integer
The account status enumeration. 0 = Open 1 = Closed 2 = AgencyInactive 3 = Unknown
AddOn
object
Defines a booking add on service details.
15 properties
MatchType
integer
Match list enumeration. 0 = Default 1 = PaymentAccountNumber 2 = ContactEmailAddress 3 = ContactPhone 4 = ContactFullName 5 = ContactLastNameFirstInitial 6 = C…
PaymentDetails
object
Defines the payment details.
9 properties
TicketIndicatorCode
integer
This enumeration defines the ticket requirements 0 = Unknown 1 = TicketRequired 2 = AutomatedTicketLiftRequired 3 = ManualTicketLiftRequired 4 = AutomatedTicke…
GovernmentProgramRequirements
object
Defines a government programs document requirements.
6 properties
AdHocMoveJourneyRequest
object
Defines the ad hoc move journey request.
8 properties
2 required
PassengerSeat
object
Model for a passenger seat for a segment.
11 properties
OptionalServiceInformation
object
Represents the optional service information model.
2 properties
SegmentChangeEvent
integer
Represents the different events that trigger an entry into the segment change history. 6 = AddedFlight 7 = DeletedFlight
BaggageStatus
integer
Baggage Status enumeration. 0 = Default 1 = Checked 2 = Removed 3 = Added 4 = AddedPrinted
PaidStatus
integer
Paid status enumeration. 0 = UnderPaid 1 = PaidInFull 2 = OverPaid
StatelessChangeReasonCodes
integer
Specifies the change reason code for a stateless booking. 0 = Irop 1 = ScheduleChange 2 = Move 3 = VoluntaryFlyAhead 4 = InvoluntaryFlyAhead
EmdCouponStatus
integer
Represents the EMD coupon status options. 0 = Unknown 1 = HeldConfirmed 2 = HoldingNeed 3 = HoldingConfirmedEmdRequired 4 = HoldingConfirmedEmdIssued
CheckinPassengerRequirementsv2
object
Defines an individual passengers checkin requirements.
7 properties
BagTagPrintHistoryRequest
object
Contains information needed to add bag tag print history for a specific passenger.
5 properties
2 required
AccountCollectionRequest
object
The account collection request model.
5 properties
2 required
OrderNote
object
Defines a order note.
4 properties
BookingQueueRequestv2
object
The booking queue request v2 model.
3 properties
1 required
BookingInfo
object
Describes general booking details.
16 properties
WeightCategory
integer
Defines the categories of adults by gender or specifies the passenger as a child. This is used for balance determinations. 0 = Undefined 1 = Male 2 = Female 3…
AddOnCharge
object
Defines a booking add ons charge.
7 properties
CheckinRequirementsv2
object
Defines the pre checkin requirements.
4 properties
Name
object
Defines a common name.
5 properties
PointOfSale
object
Model related to the point of sale. This is for read-only operations.
4 properties
IJsonResponseOfItineraryQuote
object
Defines the JSON response contract.
3 properties
OrderHistory
object
Defines a order history transaction.
5 properties
TicketStatusCode
integer
This enumeration defines the ticket availability status. 0 = Unknown 1 = TicketAvailableForUse 2 = TicketUnavailableForUse 3 = TicketReissueRequiredForPassenge…
PassengerTravelDocument
object
Model representing a passenger travel document.
14 properties
1 required
ChangeReasonCodes
integer
Specifies the reason code on why the change on the journey or segment is performed. 0 = NoChange 1 = Irop 2 = ScheduleChange 3 = Move 4 = VoluntaryFlyAhead 5 =…
OperationsInformation
object
Model describing the operations information.
15 properties
PhoneNumberType
integer
Defines the types of phone numbers. Note: New Skies does not support Mobile for booking contacts. 0 = Other 1 = Home 2 = Work 3 = Mobile 4 = Fax
Transaction
object
The transaction model.
13 properties
2 required
TransportationDesignator
object
Model information about the traveling arrival and destination details.
4 properties
SegmentTypes
integer
Indicates the type of a segment. 0 = Normal 1 = CodeShareOperating 2 = CodeShareMarketing 3 = InterlineOutbound 4 = InterlineInbound 5 = Passive
SeatInfo
object
The model for the seat information such as deck, seat properties, etc.
3 properties
CheckinDocumentRequirements
object
Defines a passenger checkin document requirements.
4 properties
SellKey
object
Sell key represents the journey and the fare sell keys to combine to what journey and fare will be sold.
4 properties
2 required
AccountOwnerType
integer
The account owner type enumeration. 0 = Organization 1 = Personnal 2 = Booking 3 = Unknown
BookingQueue
object
The booking queue model.
5 properties
PassengerDocumentCheckResponse
object
Model for passenger document check response.
3 properties
Account
object
The account model.
14 properties
PassengerVoucher
object
Defines a passenger voucher.
6 properties
LegSsr
object
A model representing a leg ssr summary.
5 properties
GovernmentDocumentRequirement
object
Defines a certain document requirement regarding a specific government instance.
2 properties
Passenger
object
Model information representing a passenger on a journey.
15 properties
1 required
QueueEventType
integer
Describes the different queue event types. 0 = Default 1 = BookingBalanceDue 2 = BookingNegativeBalance 3 = BookingCustomerComment 4 = DeclinedPaymentInitial 5…
PassengerSearchCriteria
object
Model representing an passenger group type for availability search.
3 properties
2 required
OrderCriteria
object
Defines a products order criteria.
11 properties
BookingOrderStatus
integer
Booking Order Status Enumeration 0 = None 1 = FinalizedProcess
PassengerSegment
object
Model data for the passenger on the booking for the specific segment.
29 properties
BookingOrder
object
Represents a booking order.
7 properties
SeatPreference
object
Represents a single seat preference.
3 properties
2 required
IJsonResponseOfFlightMoveHistoryResponse
object
Defines the JSON response contract.
3 properties
PaymentAmounts
object
Defines the different applied payment amounts for a single payment.
6 properties
OrderFeeType
integer
Defines the travel commerce fee types. 0 = Default 1 = Tax 2 = Markup 3 = Discount
InfantFee
object
Defines the infant fee information.
12 properties
1 required
CheckinPassengersRequest
object
Defines the checkin passengers request.
4 properties
1 required
AddOnDetails
object
Defines a booking add on base details.
4 properties
CheckinMissingSegmentRequiredSsr
object
Defines the a segments collection of missing SSR's.
2 properties
ProductTypeCode
integer
Defines the different travel commerce types. 0 = Default 1 = Insurance 2 = Activity 3 = Hotel 4 = Car
ItinerarySentHistoryResponse
object
Defines an itinerary sent history response.
2 properties
Leg
object
Model data describing the leg which is a single travel leg from point a to b.
8 properties
SsrRequestByPassengerType
object
SSR request for a single passenger type.
2 properties
1 required
CheckinPassengerRequestv2
object
Defines the individual passenger checkin request.
4 properties
1 required
AddUnitStatelessConfig
object
Unit sell config defines the different configurations when selling stateless units.
3 properties
SsrDesignatorRequest
object
SSR request for a Ssr designator request.
3 properties
1 required
DayOfWeek
integer
Defines the day of the week with none as an option. 0 = None 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday
GovernmentDocumentFieldType
integer
Defines all the different travel document fields that a government program can require to be prompted/required. 0 = FirstName 1 = MiddleName 2 = LastName 3 = T…
PassengerEmdCoupon
object
Model information for the passenger EMD coupon.
14 properties
GateInformation
object
Represents the gate information for the trip status model. Consists of actual gate information and estimated/scheduled gate information.
2 properties
IJsonResponseOfIListOfWatchListResponse
object
Defines the JSON response contract.
3 properties
AccountType
integer
The account type enumeration. 0 = Credit 1 = Prepaid 2 = Supplementary 3 = Dependent 4 = Unknown
SegmentChangeHistoryResponse
object
Defines a segment change history response.
2 properties
ItineraryQuoteRequest
object
Defines the itinerary booking quote request.
9 properties
2 required
IJsonResponseOfBooking
object
Defines the JSON response contract.
3 properties
ServiceCharge
object
Model that represents the fare service charge information.
9 properties
JourneyPriceBreakdown
object
Defines a specifics journey pricing breakdown.
5 properties
MoveJourneyRequestv2
object
Defines the move journey request, version two.
7 properties
3 required
BookingsCommentRequest
object
Defines a booking comment.
3 properties
BookingSearchByPersonResult
object
Defines the search booking by person result.
6 properties
Message
object
Defines a unique informational message.
5 properties
JourneyMove
object
Summarized move data at the journey level.
2 properties
IJsonResponseOfCheckinRequirements
object
Defines the JSON response contract.
3 properties
IJsonResponseOfIListOfBookingQueueHistory
object
Defines the JSON response contract.
3 properties
DeleteUnitStatelessConfig
object
Unit delete config defines the different configurations when removing stateless units.
1 property
HistoryResponse
object
Defines a booking history response.
2 properties
IJsonResponseOfAccount
object
Defines the JSON response contract.
3 properties
PriceStatus
integer
Describes the fare pricing status 0 = Invalid 1 = Override 2 = Valid
BookingMessageHistory
object
Defines a booking message history log entry.
3 properties
PassengerSsr
object
The model for a passengers Ssr details.
13 properties
InboundOutbound
integer
This enumeration specifies direction of flight application. 0 = None 1 = Inbound 2 = Outbound 3 = Both 4 = RoundFrom 5 = RoundTo
CheckinPassengerRequirements
object
Defines an individual passengers checkin requirements.
7 properties
ChallengePreferenceWindowSize
integer
Defines the challenge preference window size. 0 = SizeFullPage 1 = Size250X400 2 = Size390X400 3 = Size500X600 4 = Size600X400
ProductVariationDetail
object
Defines a products variation detail.
3 properties
Gender
integer
Defines the different binary gender types. 0 = XX 1 = Male 2 = Female
OrderParticipant
object
Defines a orders participant.
14 properties
BookingQueueHistory
object
Represents a booking queue history item.
16 properties
SegmentChangeHistory
object
Defines a segment change history log entry.
16 properties
JourneyPriceBreakdownBase
object
Defines the journey price breakdown base.
4 properties
ConsumerAddress
object
Defines a consumer address.
8 properties
InventoryControlType
integer
Defines the different ways inventory is held at the time of sell. 0 = HoldSpace 1 = SoftHoldSpace 2 = ClaimSpace 3 = OversellSpace 4 = StandBy
MarketInformation
object
Model information about the market arrival and destination details.
4 properties
4 required
AuthenticationStatus
integer
Defines the different possible payment authentication statuses for 3DS. 0 = Unknown 1 = AuthenticationSuccessful 2 = AuthenticationFailed 3 = AuthenticationCou…
PassengerBoardingPassDetail
object
Defines information used to populate the printed boarding pass and 2D bar codes.
7 properties
SsrsStatelessRequest
object
Ssrs by type model allows multiple Ssr requests for a specific type.
2 properties
1 required
CheckinRequirements
object
Defines the pre checkin requirements.
4 properties
Booking
object
Represents a full booking object.
22 properties
BookingRecordLocators
object
Defines the booking's unique identifiers.
4 properties
CheckinPassengersRequestv3
object
Defines the checkin passengers request v3 model.
3 properties
1 required
PaymentVoucherDetails
object
Payment voucher details. This describes a voucher applied to a payment.
5 properties
TransportationIdentifier
object
Represents the transportation identifier model data.
3 properties
2 required
EmdTypeCode
integer
Represents the EMD type code options. 0 = None 1 = Associated 2 = StandAlone
LegNest
object
A model representing a leg nest.
6 properties
IJsonResponseOfSegmentChangeHistoryResponse
object
Defines the JSON response contract.
3 properties
HistoryCategory
integer
Represents the various history report types. 0 = Unknown 1 = Baggage 2 = BagTagPrint 3 = BoardingPassPrint 4 = CheckIn 5 = ClassOfServiceChange 6 = Comment 7 =…
BookingComment
object
Defines a booking comment.
5 properties
IJsonResponseOfIListOfBookingSearchResult
object
Defines the JSON response contract.
3 properties
IJsonResponseOfPassengerDocumentCheckResponse
object
Defines the JSON response contract.
3 properties
PhoneNumber
object
Defines a common phone number.
2 properties
2 required
ParticipantDocument
object
Defines a consumer document.
3 properties
PassengerProgram
object
Model representing a passenger program.
3 properties
ArrivalStatus
integer
Arrival status. 0 = Default 1 = Cancelled 2 = Arrived 3 = SeeAgent 4 = Delayed
OrderFee
object
Defines a order fee.
10 properties
IJsonResponseOfHoldDateChangeHistoryResponse
object
Defines the JSON response contract.
3 properties
Term
object
Defines the terms and conditions of an order.
3 properties
Coordinate
object
The defined coordinates of a location.
2 properties
MarketDesignator
object
Model information about the date market which identifies a market and the departure date.
3 properties
3 required
FareOverrideRequest
object
Defines a fare override.
2 properties
1 required
BookingHold
object
Defines the booking hold expiration.
1 property
DocumentGroup
integer
The document grouping enumeration. 0 = Unknown 1 = AlienRegistrationCard 2 = PermanentResidentCard 3 = FacilitationDocument 4 = InsPass 5 = MilitaryId 6 = Pass…
PassengerSegmentBag
object
Model information about the baggage a passenger has on a segment.
6 properties
3 required
WeightType
integer
Weight Type enumeration. 0 = Default 1 = Pounds 2 = Kilograms
TransactionRequest
object
The create transaction request.
3 properties
2 required
BookingQueueInfo
object
Describes the booking queue info.
14 properties
IJsonResponse
object
Defines the JSON response contract for a not content type response.
3 properties
PassengerPriceBreakdown
object
Defines the individual passenger-level pricing breakdown.
10 properties
IJsonResponseOfIListOfBookingQueue
object
Defines the JSON response contract.
3 properties
NotificationPreference
integer
Describes types of notifications the user would prefer. 0 = None 1 = Promotional
BookingNotificationHistory
object
Defines a booking notification history.
8 properties
MessageStatus_2
integer
0 = General 1 = Warning 2 = Critical
SearchByScanRequestV2
object
3 properties
1 required
IJsonResponseOfListOfBookingSummary
object
3 properties
IJsonResponse_2
object
3 properties
BookingStatus_2
integer
0 = Default 1 = Hold 2 = Confirmed 3 = Closed 4 = HoldCanceled 5 = PendingArchive 6 = Archived 7 = ArchivedPrivate 777 = ProcessedForArchive
ChannelType_2
integer
Defines the available channel types invoking communication with the server. 0 = Default 1 = Direct 2 = Web 3 = Gds 4 = Api 5 = DigitalApi 6 = DigitalWeb 7 = Ndc
Name_2
object
5 properties
ErrorResponse_2
object
8 properties
BookingSummary
object
17 properties
ParseScanRequestV2
object
5 properties
Message_2
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TUI Group 12
Other APIs TUI Group publishes across the network.
TUI Group Account API
TUI Group Airline Profile API
TUI Group APIS Message API
TUI Group Apo API
TUI Group Auth API
TUI Group Availability API
TUI Group Baggage API
TUI Group Bag Tag API
TUI Group Boarding API
TUI Group Boarding Devices API
TUI Group Booking/addons API
TUI Group Booking API
#Booking
Where this information came from
This is an independent, third-party profile of TUI Group Bookings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.