TUI Group Booking/retrieve API
The booking/retrieve API from TUI Group — 5 operation(s) for booking/retrieve.
TUI Group Booking/retrieve 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/retrieve. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 5 paths, and defines 162 schemas. It is described by OpenAPI 3.2.0, at version 4.8.6.23.
Requests are made against 2 base URLs: https://prod.api.tui/flight/newskies/rest, https://playground.api.tui/flight/newskies/rest.
5 operations
5 paths
162 schemas
5 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
TUI Group Booking/retrieve API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (jwt) (JWT).
By default, every request must be authenticated.
JWT— Paste your JWT token from the token endpoint.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.
booking/retrieve 5
GET
/api/nsk/v2/booking/retrieve
Retrieves the booking from the New Skies server based on the retrieve booking request parameters and any configured booking retrieve strategies. If the booking exists and the search criteria is allow…
GET
/api/nsk/v1/booking/retrieve/{bookingKey}
Gets a specific booking by key and stores it in state.
GET
/api/nsk/v1/booking/retrieve/byBookingId/{bookingId}
Gets a specific booking by ID and stores it in state.
GET
/api/nsk/v1/booking/retrieve/byRecordLocator/{recordLocator}
Gets a specific booking by record locator and stores it in state.
GET
/api/nsk/v1/booking/retrieve/byThirdPartyRecordLocator
Gets a specific booking by third-party record locator and stores it in state.
Schemas 162
The contract defines 162 schemas that model the data the API accepts and returns. The most detailed are LegInformation (30 properties), PassengerSegment (29 properties), Order (28 properties), Payment (28 properties). Each schema is shown below with its type and property counts.
EmdTypeCode
integer
Represents the EMD type code options. 0 = None 1 = Associated 2 = StandAlone
QueueMode
integer
Determines where a queue request is coming from. 0 = EnQueued 1 = DeQueued
PaymentAttachment
object
Defines a payment attachment.
3 properties
PassengerProgram
object
Model representing a passenger program.
3 properties
AuthenticationStatus
integer
Defines the different possible payment authentication statuses for 3DS. 0 = Unknown 1 = AuthenticationSuccessful 2 = AuthenticationFailed 3 = AuthenticationCou…
Passenger
object
Model information representing a passenger on a journey.
15 properties
1 required
BookingOrder
object
Represents a booking order.
7 properties
OrderFeeType
integer
Defines the travel commerce fee types. 0 = Default 1 = Tax 2 = Markup 3 = Discount
GssStayType
integer
The type of stay type. 0 = None 1 = Vacation 2 = Business 3 = Duty
AmountDue
object
Defines the amounts due for an order.
3 properties
AddOnOrderSummary
object
Defines the details about an order if the order is not available.
11 properties
PassengerPriceBreakdown
object
Defines the individual passenger-level pricing breakdown.
10 properties
InputedParameter
object
Defines a parameter with data input.
3 properties
SeatPreference
object
Represents a single seat preference.
3 properties
2 required
Fare
object
Model describing a fare.
22 properties
HistoryCategory
integer
Represents the various history report types. 0 = Unknown 1 = Baggage 2 = BagTagPrint 3 = BoardingPassPrint 4 = CheckIn 5 = ClassOfServiceChange 6 = Comment 7 =…
PassengerVoucherCustomerProgram
object
Defines the passenger voucher customer program.
2 properties
NestType
integer
Nest type enumeration. 0 = Default 1 = Net 2 = Serial 3 = OneBooking
PassengerEmdCoupon
object
Model information for the passenger EMD coupon.
14 properties
ReceivedByInfo
object
Defines the received by information.
5 properties
CollectType
integer
Used to identify the collect type of a service charge. 0 = SellerChargeable 1 = ExternalChargeable 2 = SellerNonChargeable 3 = ExternalNonChargeable 4 = Extern…
PassengerFare
object
Model that represents the passenger fare details.
5 properties
1 required
OrderFee
object
Defines a order fee.
10 properties
OperationsInformation
object
Model describing the operations information.
15 properties
PaymentAmounts
object
Defines the different applied payment amounts for a single payment.
6 properties
BookingProfileStatus
integer
Defines the profiling status of the booking. 0 = Default 1 = KnownIndividual 2 = ResolutionGroup 3 = SelecteeGroup 4 = NotUsed 5 = FailureGroup 6 = RandomSelec…
QueueAction
integer
Specifies the basics by which a queue filter was created. 0 = Default 1 = Warning 2 = Lock 3 = DefaultAndNotify 4 = WarningAndNotify 5 = LockAndNotify
Order
object
Defines a order.
28 properties
PassengerSegment
object
Model data for the passenger on the booking for the specific segment.
29 properties
PaymentMethodType
integer
Defines the payment method types. 0 = ExternalAccount 1 = PrePaid 2 = AgencyAccount 3 = CustomerAccount 4 = Voucher 5 = Loyalty
BookingHold
object
Defines the booking hold expiration.
1 property
ProductTypeCode
integer
Defines the different travel commerce types. 0 = Default 1 = Insurance 2 = Activity 3 = Hotel 4 = Car
CreatedAddOnDetails
object
Defines a component details.
6 properties
PassengerPriceBreakdownBase
object
Defines the combined booking passengers pricing breakdown.
9 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…
BookingHistory
object
Defines a booking history log entry.
8 properties
Booking
object
Represents a full booking object.
22 properties
QueueEventType
integer
Describes the different queue event types. 0 = Default 1 = BookingBalanceDue 2 = BookingNegativeBalance 3 = BookingCustomerComment 4 = DeclinedPaymentInitial 5…
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 =…
AuthorizationStatus
integer
Defines the different possible payment authorization states. 0 = Unknown 1 = Acknowledged 2 = Pending 3 = InProcess 4 = Approved 5 = Declined 6 = Referral 7 =…
PaidStatus
integer
Paid status enumeration. 0 = UnderPaid 1 = PaidInFull 2 = OverPaid
TransportationIdentifier
object
Represents the transportation identifier model data.
3 properties
2 required
ParticipantDocument
object
Defines a consumer document.
3 properties
TicketStatusCode
integer
This enumeration defines the ticket availability status. 0 = Unknown 1 = TicketAvailableForUse 2 = TicketUnavailableForUse 3 = TicketReissueRequiredForPassenge…
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
PassengerSeat
object
Model for a passenger seat for a segment.
11 properties
TravelClassSeatPreference
integer
Represents a travel class seating preference. 0 = None 1 = Business 2 = Economy 3 = FirstClass
AddOn
object
Defines a booking add on service details.
15 properties
SegmentStatus
integer
The segment status. 0 = UnknownStatus 1 = UnableToConfirmSegment 2 = UnableToSellSegment 3 = HeldPending 4 = WaitListConfirmed 5 = HeldUnconfirmed 6 = HeldConf…
JourneyPriceBreakdownBase
object
Defines the journey price breakdown base.
4 properties
TypeOfSale
object
Defines the type of sale values.
3 properties
PassengerSsr
object
The model for a passengers Ssr details.
13 properties
ChargeBreakdown
object
Defines a charge breakdown.
4 properties
OrderLocation
object
Defines a location.
4 properties
2 required
Gender
integer
Defines the different binary gender types. 0 = XX 1 = Male 2 = Female
FareStatus
integer
This enumeration defines the fare status of a passenger fare. 0 = Default 1 = SameDayStandBy 2 = FareOverrideConfirming 3 = FareOverrideConfirmed 4 = Published…
IJsonResponseOfBooking
object
Defines the JSON response contract.
3 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…
PaymentVoucherDetails
object
Payment voucher details. This describes a voucher applied to a payment.
5 properties
LegNest
object
A model representing a leg nest.
6 properties
LegClass
object
The leg class model information.
11 properties
1 required
DirectCurrencyConversion
object
Defines a direct currency conversion.
7 properties
FareDesignator
object
Model describing the fare designator information.
1 property
LegStatus
integer
Leg status enumeration. 0 = Normal 1 = Closed 2 = Canceled 3 = Suspended 5 = ClosedPending 6 = BlockAllActivities 7 = Mishap
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
SeatPreferences
object
Represents the seating preferences base model.
3 properties
Contact
object
Contact model describing a person contact information.
11 properties
1 required
AddOnPriceBreakdown
object
Defines the addOn price breakdown.
3 properties
PriceStatus
integer
Describes the fare pricing status 0 = Invalid 1 = Override 2 = Valid
BookingPointOfSale
object
Model related to the point of sale.
6 properties
Message
object
Defines a unique informational message.
5 properties
Payment
object
Defines an applied payment on the booking.
28 properties
SegmentTypes
integer
Indicates the type of a segment. 0 = Normal 1 = CodeShareOperating 2 = CodeShareMarketing 3 = InterlineOutbound 4 = InterlineInbound 5 = Passive
AddOnDetails
object
Defines a booking add on base details.
4 properties
OrderParticipant
object
Defines a orders participant.
14 properties
MarketInformation
object
Model information about the market arrival and destination details.
4 properties
4 required
ArrivalStatus
integer
Arrival status. 0 = Default 1 = Cancelled 2 = Arrived 3 = SeeAgent 4 = Delayed
OrderCriteria
object
Defines a products order criteria.
11 properties
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…
BookingHistoryEvent
integer
Represents the different events that trigger an entry into the schedule history. 0 = Unknown 1 = ConvertedHistory 2 = FlightTimeChange 3 = FlightDesignatorChan…
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…
AddOnCharge
object
Defines a booking add ons charge.
7 properties
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
IJsonResponse
object
Defines the JSON response contract for a not content type response.
3 properties
OrderHistory
object
Defines a order history transaction.
5 properties
PassengerFee
object
Model representing passenger fee information.
16 properties
1 required
OverbookIndicatorTypes
integer
Specifies the type of code share agreement. 0 = NormalSell 1 = Oversold 2 = ClassOrCabinOversold
ThreeDSecure
object
Defines three D secure.
24 properties
Coordinate
object
The defined coordinates of a location.
2 properties
LiftStatus
integer
Lift status enumeration. 0 = Default 1 = CheckedIn 2 = Boarded 3 = NoShow
BaggageStatus
integer
Baggage Status enumeration. 0 = Default 1 = Checked 2 = Removed 3 = Added 4 = AddedPrinted
OrderCustomer
object
Defines an order customer contact details.
11 properties
TransportationDesignator
object
Model information about the traveling arrival and destination details.
4 properties
DepartureStatus
integer
Departure status. 0 = Default 1 = Cancelled 2 = Boarding 3 = SeeAgent 4 = Delayed 5 = Departed
BookingStatus
integer
Booking Status Enumeration 0 = Default 1 = Hold 2 = Confirmed 3 = Closed 4 = HoldCanceled 5 = PendingArchive 6 = Archived 7 = ArchivedPrivate 777 = ProcessedFo…
Exception
object
4 properties
JourneyPriceBreakdown
object
Defines a specifics journey pricing breakdown.
5 properties
PassengerInformation
object
Represents additional passenger information.
6 properties
LegSsr
object
A model representing a leg ssr summary.
5 properties
ProductVariationDetail
object
Defines a products variation detail.
3 properties
PassengerVoucher
object
Defines a passenger voucher.
6 properties
PhoneNumber
object
Defines a common phone number.
2 properties
2 required
Leg
object
Model data describing the leg which is a single travel leg from point a to b.
8 properties
PassengerTravelDocument
object
Model representing a passenger travel document.
14 properties
1 required
SeatInfo
object
The model for the seat information such as deck, seat properties, etc.
3 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…
Segment
object
Segment model for an already booked flight.
23 properties
DirectCurrencyConversionStatus
integer
Enumeration that determines the status of a DCC authorization. 0 = DccNotOffered 1 = DccOfferRejected 2 = DccOfferAccepted 3 = DccInitialValue 4 = MccInUse
OrderPayment
object
Defines a payment on an order.
13 properties
1 required
Name
object
Defines a common name.
5 properties
OrderAddress
object
Defines an address with GPS coordinates.
8 properties
ApisAddressStatus
integer
Defines what type of APIS requirement is the address. 0 = Residence 1 = InCountry 2 = Emergency 3 = Contact
PassengerBag
object
Model information about the passenger's baggage.
11 properties
PassengerScore
object
Defines a passenger score.
3 properties
1 required
PointOfSale
object
Model related to the point of sale. This is for read-only operations.
4 properties
BookingComment
object
Defines a booking comment.
5 properties
Address
object
Defines a common address.
7 properties
TicketIndicatorCode
integer
This enumeration defines the ticket requirements 0 = Unknown 1 = TicketRequired 2 = AutomatedTicketLiftRequired 3 = ManualTicketLiftRequired 4 = AutomatedTicke…
PaymentAction
integer
Defines payment action that should be taken by selling system for this service. 1 = SellingSystemCollects 2 = PassThroughHold 3 = NoPaymentRequired 4 = ReferTo…
BookingPriceBreakdown
object
Defines the booking top level pricing breakdown.
13 properties
CommentType
integer
Comment Types Enumerations 0 = Default 1 = Itinerary 2 = Manifest 3 = Alert 4 = Archive 5 = Voucher
Term
object
Defines the terms and conditions of an order.
3 properties
NotificationPreference
integer
Describes types of notifications the user would prefer. 0 = None 1 = Promotional
GateInformation
object
Represents the gate information for the trip status model. Consists of actual gate information and estimated/scheduled gate information.
2 properties
PassengerAddress
object
Passenger address information. This contains more data then the base address class.
15 properties
InboundOutbound
integer
This enumeration specifies direction of flight application. 0 = None 1 = Inbound 2 = Outbound 3 = Both 4 = RoundFrom 5 = RoundTo
BookingSales
object
Defines the different point of sale information.
3 properties
BookingInfo
object
Describes general booking details.
16 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
InfantFee
object
Defines the infant fee information.
12 properties
1 required
ChallengePreference
integer
Defines the challenge preference. 0 = NoPreference 1 = NoChallengeRequested 2 = ChallengeRequested 3 = ChallengeMandated
WeightType
integer
Weight Type enumeration. 0 = Default 1 = Pounds 2 = Kilograms
SsrDurationType
integer
Ssr duration type. 0 = Segment 1 = Journey 2 = Leg
BookingQueueInfo
object
Describes the booking queue info.
14 properties
PaymentDetails
object
Defines the payment details.
9 properties
RecordLocator
object
Defines a unique locator for reference.
7 properties
DepartureEvent
object
Represents the flight operation times for the departure event, which includes an estimated and scheduled time event.
2 properties
Ticket
object
Model for a ticket applied to a passenger.
5 properties
FlightType
integer
Flight types enumeration. 0 = None 1 = NonStop 2 = Through 3 = Direct 4 = Connect 5 = All
ConsumerAddress
object
Defines a consumer address.
8 properties
OrderPriceBreakdown
object
Defines all the different order price breakdown.
18 properties
PassengerSegmentBag
object
Model information about the baggage a passenger has on a segment.
6 properties
3 required
ClassStatus
integer
Indicates whether a leg class may be used or not. 1 = Active 2 = InActive 3 = AvsOpen 4 = AvsOnRequest 5 = AvsClosed
PassengerInfant
object
Model representing an infant with a passenger.
9 properties
SimpleSeatPreference
integer
Represents a simple seating preference. 0 = None 1 = Window 2 = Aisle 3 = Other
BookingRecordLocators
object
Defines the booking's unique identifiers.
4 properties
OptionalServiceInformation
object
Represents the optional service information model.
2 properties
MessageStatus
integer
Defines the message status. 0 = General 1 = Warning 2 = Critical
EmdCouponStatus
integer
Represents the EMD coupon status options. 0 = Unknown 1 = HeldConfirmed 2 = HoldingNeed 3 = HoldingConfirmedEmdRequired 4 = HoldingConfirmedEmdIssued
PassengerBoardingPassDetail
object
Defines information used to populate the printed boarding pass and 2D bar codes.
7 properties
Amount
object
Defines an amount base price and total price.
2 properties
OrderNote
object
Defines a order note.
4 properties
CodeShareIndicator
integer
Specifies the type of code share agreement. 0 = NonCodeShare 1 = CodeShareCommercialDuplicate 2 = SharedDesignatorOrWetLease 3 = CodeShareHostOperatingCarrier…
LegInformation
object
Model describing the detailed leg information.
30 properties
ServiceCharge
object
Model that represents the fare service charge information.
9 properties
Journey
object
Data about the journey which represents the collection of segments and their legs on the journey.
7 properties
ErrorResponse
object
Defines a unique error response.
8 properties
FareApplicationType
integer
This enumeration defines the fare application type of a fare. 0 = Route 1 = Sector 2 = Governing
JourneyMove
object
Summarized move data at the journey level.
2 properties
SeatPreferenceStatus
integer
Defines the seat preference status. 0 = Unknown 1 = Met 2 = NotMet
ChallengePreferenceWindowSize
integer
Defines the challenge preference window size. 0 = SizeFullPage 1 = Size250X400 2 = Size390X400 3 = Size500X600 4 = Size600X400
BookingOrderStatus
integer
Booking Order Status Enumeration 0 = None 1 = FinalizedProcess
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 Air Shopping 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
#booking/retrieve
Where this information came from
This is an independent, third-party profile of TUI Group Booking/retrieve 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.