GDS Ticket Retrieve API Reference
Get |
ticket/tickets/{ticketID} Send the ticket number in {ticketID}. Base path: Pre-production https://api.pp.travelport.com/11/air/ Production https://api.travelport.com/11/air/ |
Related Content: Ticket Cancel, Refund, & Exchange Guide
The Ticket Retrieve request returns details for a single ticket for a GDS itinerary.
Also see:
-
To list all ticket numbers on a single reservation, send a Ticket List request.
-
To retrieve all reservation details by ticket number, send a Reservation Retrieve request with the ticket number.
Request
Also see Authorization and Common Headers.
The Ticket Retrieve API requires a GET request with the ticket number to the endpoint above. There are no query parameters or message payload.
Response
The Ticket Display response returns the reservation locator, traveler name, form of payment details, flight departure and arrival information, a price breakdown by PTC, and agency information.
Object |
Description |
---|---|
TicketListResponse |
Top level object for response. Includes the TicketID object. |
TicketID |
Contains all ticketing details. May include the following:
Depending on the data available for the ticket, may include the Identifier, PersonName, ReservationLocator, FormOfPayment, TicketSegment, TicketPrice, PassengerTypeCode, ValidatingCarrier, PricingType, AgencyInfo, Restrictions, and FlightProduct objects. |
Identifier |
Contains the ticket number in the value attribute. |
PersonName |
Traveler name. Key value pairs:
|
ReservationLocator |
Reservation locator. Key value pairs:
|
FormOfPayment |
Top level object for the type of form of payment. Includes PaymentCard if payment was made by credit card. |
PaymentCard |
If payment was made by credit card, card details. Key value pairs:
Contains CardNumber object. |
CardNumber |
Returned if payment was made by credit card. Key value pairs:
|
TicketSegment |
Flight details for the flight or connecting flights making up one leg of the itinerary. Multiple instances are returned for itineraries with more than one leg, such as round-trip or multi-city. Key value pairs:
Includes Departure, Arrival, and TicketBaggage objects. |
Departure |
Key value pairs:
|
Arrival |
Key value pairs:
|
TicketBaggage |
Any baggage that is part of the ticket. |
TicketPrice |
Ticket price details. Key value pairs:
Includes CurrencyCode, Base, Taxes, and Total objects. |
CurrencyCode |
Indicates in the value attribute the code for the currency in which the amounts in TicketPrice are returned. |
Base |
The amount of the base fare. |
Taxes |
Top level object for individual Tax objects for each separate tax in the fare. |
Tax |
Each instance of Tax provides details on a specific tax:
|
Total |
Total of all taxes plus base fare. |
PassengerTypeCode |
PTC for the passenger on this ticket. |
ValidatingCarrier |
The IATA code for the validating carrier. |
PricingType |
This value is usually Auto Priced but could be Manual if back-end processing was required to issue the ticket. |
Restrictions |
Any fare restriction information returned by the carrier. |
AgencyInfo |
Details about the ticketing agency. Key value pairs:
|
FlightProduct |
Class of service and fare code details for each flight in the itinerary. Key value pairs:
|
Example Request
There is no message payload. The GET request looks like:
Example Response
{
"TicketListResponse": {
"TicketID": [
{
"@type": "TicketSummary",
"numberOfTicketsIssued": 1,
"Identifier": {
"value": "0169904503844"
},
"PersonName": {
"@type": "PersonName",
"Given": "TESTFIRST",
"Surname": "TESTLAST"
},
"ReservationLocator": {
"supplierCode": "1G",
"value": "1TRBJ4"
},
"FormOfPayment": [
{
"value": "Cash"
}
],
"TicketSegment": [
{
"@type": "TicketSegment",
"sequence": 1,
"connectionInd": true,
"ClassOfService": "U",
"FareBasisCode": "UAA0OKEM",
"Status": "OpenForUse",
"Carrier": "UA",
"Number": "2240",
"Departure": {
"@type": "Departure",
"location": "ONT",
"date": "2022-08-29",
"time": "06:00:00"
},
"Arrival": {
"@type": "Arrival",
"location": "SFO"
},
"TicketBaggage": {
"@type": "TicketBaggage",
"quantity": 0
}
},
{
"@type": "TicketSegment",
"sequence": 2,
"ClassOfService": "U",
"FareBasisCode": "UAA0OKEM",
"Status": "OpenForUse",
"Carrier": "UA",
"Number": "520",
"Departure": {
"@type": "Departure",
"location": "SFO",
"date": "2022-08-29",
"time": "09:00:00"
},
"Arrival": {
"@type": "Arrival",
"location": "JFK"
},
"TicketBaggage": {
"@type": "TicketBaggage",
"quantity": 0
}
}
],
"TicketPrice": {
"@type": "TicketPrice",
"fareCalculation": "G",
"fareBreakdown": "ONT UA X/SFO UA NYC 544.19 USD544.19END ZPONTSFO",
"CurrencyCode": {
"decimalPlace": 2,
"value": "AUD"
},
"Base": 756,
"Taxes": {
"@type": "TaxesDetail",
"Tax": [
{
"currencyCode": "AUD",
"taxCode": "AY",
"decimalPlace": 2,
"value": 7.8
},
{
"currencyCode": "AUD",
"taxCode": "US",
"decimalPlace": 2,
"value": 56.7
},
{
"currencyCode": "AUD",
"taxCode": "ZP",
"decimalPlace": 2,
"value": 12.6
},
{
"currencyCode": "AUD",
"taxCode": "XF",
"decimalPlace": 2,
"value": 12.6
}
]
},
"Total": 845.7,
"FiledAmount": {
"currencyCode": "USD",
"decimalPlace": 2,
"value": 544.19
}
},
"PassengerTypeCode": "ADT",
"ValidatingCarrier": "016",
"PricingType": "Auto Priced",
"Restrictions": [
"REFUNDABLE"
],
"AgencyInfo": {
"ticketedDate": "2022-07-30",
"name": "TEST CUSTOMER",
"ticketingPCC": "TEST",
"code": "12345678",
"ticketingCountry": "AU",
"ticketingCity": "SYD"
}
}
]
}
}
The following example is for a ticket that has been exchanged; it returns details of the previously exchanged ticket in the PreviousIssue object.
{
"TicketListResponse": {
"@type": "TicketListResponse",
"TicketID": [
{
"@type": "TicketSummary",
"numberOfTicketsIssued": 1,
"Identifier": {
"value": "0759904836638"
},
"PersonName": {
"@type": "PersonName",
"Given": "LATHA",
"Surname": "DEVI"
},
"ReservationLocator": {
"supplierCode": "1G",
"value": "5DGV5P"
},
"FormOfPayment": [
{
"value": "Cash"
}
],
"TicketSegment": [
{
"@type": "TicketSegment",
"sequence": 1,
"ClassOfService": "Y",
"FareBasisCode": "YDNNEOM2/TNETML",
"Status": "OpenForUse",
"Carrier": "IB",
"Number": "3402",
"Departure": {
"@type": "Departure",
"location": "MAD",
"date": "2023-10-24",
"time": "07:30:00"
},
"Arrival": {
"@type": "Arrival",
"location": "ORY"
},
"TicketBaggage": {
"@type": "TicketBaggage",
"quantity": 1
}
}
],
"TicketPrice": {
"@type": "TicketPrice",
"fareCalculation": "A",
"fareBreakdown": "[MAD IB PAR Q16.35 M/BT END ROE0.91728",
"bTFareInd": true,
"CurrencyCode": {
"value": "EUR"
},
"Base": 0,
"Taxes": {
"@type": "TaxesDetail",
"Tax": [
{
"currencyCode": "EUR",
"taxCode": "XT",
"value": 18.38
},
{
"currencyCode": "EUR",
"taxCode": "JD",
"value": 14.48
},
{
"currencyCode": "EUR",
"taxCode": "OG",
"value": 0.63
},
{
"currencyCode": "EUR",
"taxCode": "QV",
"value": 3.27
}
]
},
"Total": 516.38,
"PaidTaxes": {
"@type": "PaidTaxesDetail",
"Tax": [
{
"taxCode": "JD",
"value": 14.48
},
{
"taxCode": "OG",
"value": 0.63
},
{
"taxCode": "QV",
"value": 3.27
}
]
}
},
"PassengerTypeCode": "ADT",
"ValidatingCarrier": "075",
"Restrictions": [
"[015118.REF AND CHGS RESTRI/RESTRICTIONS MAY APPLY]"
],
"AgencyInfo": {
"ticketedDate": "2023-09-19",
"name": "GALILEO SPAIN HELPDESK",
"ticketingPCC": "DU7",
"code": "78299992",
"ticketingCountry": "ES",
"ticketingCity": "MAD"
},
"PreviousIssue": [
{
"issuingCity": "PAR",
"issueDate": "2023-09-19",
"agencyCodeIATA": "20299926",
"documentType": "Ticket",
"value": "0759904650787"
}
]
}
]
}
}