You can use this endpoint to check the availability of services like extra baggage or meal. Information about ShoppingResponseID, OfferID, and the passenger list details are required to get the service lists. This is an optional service.
Schema
Document
-
Name: Provide the name for the request. This is a String value.
-
ReferenceVersion: Provide the version number. This is a Numeric value.
Party
-
Travel Agency Sender:
-
Name: Provide the name for the request. This is a String value.
-
IATA Number: Provide the IATA number for the request. This is a String value.
-
Agency ID: Provide the agency ID for the request. This is a String value.
-
Contacts: This is an Array.
- EmailContact: Provide the email contact for the request. This is a String value.
-
ShoppingResponseId
The Shopping Response ID is a unique identifier that is generated when a customer performs a search for flights and receives a list of available options.
This is the required field, and the value will be String.
Query
- OfferID: When a customer performs a search for flights, the airline generates a list of available offers that meet the customer’s search criteria. Each offer within that list is assigned a unique OfferID.It is important to provide the correct numeric value to ensure that the system can identify the correct offer.This is the required field, and the value will be String.
DataLists
-
Passenger: This is an Array.
Note: This is a required field. The passenger list must have at least one adult. Infant object count should be less than or equal to adult count. Total passenger count should be less than or eqaul to 9.
-
PassengerID: Provide the passenger ID assigned to you. Valid values are
T1,T2, andT3. The value will be String. -
PTC: Provide the passenger type. Valid values are
ADT,CHD, andINF. The value will be String.
-
Metadata
TraceId: Provide the trace ID. This is a String value.
Response References
- ShoppingResponseId: Unique identifier for the shopping response.
- ServiceListResponseId: Unique identifier for the service list response.
ALaCarteOffer
- TimeLimits:
- OfferExpiration: The timestamp when the offer expires.
- ALaCarteOfferItem: List of additional purchase options.
- OfferItemID: Unique identifier for the item.
- Eligibility:
- PassengerRefs: Reference to the passenger(s).
- SegmentRefs: Reference to the applicable flight segment(s).
- Price:
- Base: The base price before taxes.
- BookingCurrencyPrice: Price in the booking currency.
- EquivCurrencyPrice: Price in the equivalent currency
- Total: Final price including taxes.
- BookingCurrencyPrice: Total price in booking currency.
- EquivCurrencyPrice: Equivalent total price in requested currency.
- Tax: Tax amount applied to the item.
- BookingCurrencyPrice: Tax amount in booking currency.
- EquivCurrencyPrice: Equivalent tax amount in requested currency.
- Base: The base price before taxes.
Service List
- ServiceList: A list of services associated with offer items.
- OfferItemRefs: Reference to the associated offer item.
- ServiceID: Unique identifier for the service.
- ServiceDefinitionRef: Reference to the service definition.
Data Lists
- PassengerList: Contains passenger details.
- Passengers: List of passengers.
- PassengerID: Unique identifier for the passenger.
- PTC: Passenger type code (e.g., ADT for adult).
- Passengers: List of passengers.
- ServiceDefinitionList: Defines the available services.
- ServiceDefinition: List of service definitions.
- ServiceDefinitionID: Unique identifier for the service definition.
- ServiceType: Type of service (e.g., BAG for baggage).
- ServiceCode: Service code identifier.
- ServiceName: Human-readable name of the service.
- ServiceDefinition: List of service definitions.
- FlightSegmentList: Details about individual flight segments.
- FlightSegment: List of flight segments.
- SegmentKey: Unique identifier for the segment.
- Departure: Departure details.
- AirportCode: IATA code of the departure airport.
- Date: Departure date.
- Time: Departure time.
- AirportName: Name of the departure airport.
- Terminal: Terminal details (if available).
- Arrival: Arrival details.
- AirportCode: IATA code of the arrival airport.
- Date: Arrival date.
- Time: Arrival time.
- AirportName: Name of the arrival airport.
- Terminal: Terminal details (if available).
- MarketingCarrier: Marketing airline information.
- AirlineID: IATA airline code.
- Name: Airline name.
- FlightNumber: Flight number assigned by the marketing carrier.
- OperatingCarrier: Operating airline information.
- AirlineID: IATA airline code.
- Name: Airline name.
- FlightNumber: Flight number assigned by the operating carrier.
- Equipment: Aircraft details.
- AircraftCode: Code of the aircraft.
- Name: Name of the aircraft.
- Code: Additional segment codes.
- MarriageGroup: Marriage group code for flight segments.
- FlightDetail: Additional flight details.
- FlightDuration: Total flight duration.
- Stops: Number of stopovers.
- BrandId: Fare brand identifier.
- FlightSegment: List of flight segments.
- FlightList: List of flights.
- Flight: Flight details.
- FlightKey: Unique flight identifier.
- Journey: Journey details.
- Time: Total journey time.
- Stops: Number of stops in the journey.
- SegmentReferences: References to associated flight segments.
- Flight: Flight details.
- OriginDestinationList: Origin and destination details.
- OriginDestination: List of origin-destination details.
- OriginDestinationKey: Unique identifier for the origin-destination pair.
- DepartureCode: Departure airport code.
- ArrivalCode: Arrival airport code.
- FlightReferences: References to flights associated with this origin-destination pair.
- OriginDestination: List of origin-destination details.
Request URL
curl --location --request POST 'https://newapi.tltid.com/AirOfferServiceList' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \
Request Body Sample
{
"AirServiceListRQ": {
"Document": {
"Name": "Skyroute B2B Portal",
"ReferenceVersion": "1.0"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Skyroute B2B",
"IATA_Number": "1111111111",
"AgencyID": "1111111111",
"Contacts": {
"Contact": [
{
"EmailContact": "pst@claritytts.com"
}
]
}
}
}
},
"ShoppingResponseId": "1678884980680630342",
"Query": {
"Offer": [
{
"OfferID": "137211721101678884984951212459"
}
]
},
"DataLists": {
"PassengerList": {
"Passenger": [
{
"PassengerID": "T1",
"PTC": "ADT"
}
]
}
},
"MetaData": {
"TraceId": "161777799749"
}
}
}
Response Sample
{
"AirServiceListRS": {
"Document": {
"Name": "API GATEWAY",
"ReferenceVersion": "1.2"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Lucky Travels",
"IATA_Number": "",
"AgencyID": "",
"Contacts": {
"Contact": [
{
"EmailContact": "pst@claritytts.com"
}
]
}
}
}
},
"ShoppingResponseId": "1678884980680630342",
"ServiceListResponseId": "1678885102048509620",
"ALaCarteOffer": {
"Parameters": {
"TotalItemQuantity": 6
},
"TimeLimits": {
"OfferExpiration": "2023-03-15T13:28:30"
},
"ALaCarteOfferItem": [
{
"OfferItemID": "ALaCarteOfferItem-1",
"Eligibility": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment1"
},
"Price": {
"Base": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Tax": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Total": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
}
},
{
"OfferItemID": "ALaCarteOfferItem-2",
"Eligibility": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment2"
},
"Price": {
"Base": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Tax": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Total": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
}
},
{
"OfferItemID": "ALaCarteOfferItem-3",
"Eligibility": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment1"
},
"Price": {
"Base": {
"BookingCurrencyPrice": 30,
"EquivCurrencyPrice": 30
},
"Tax": {
"BookingCurrencyPrice": 3.8999999999999986,
"EquivCurrencyPrice": 3.8999999999999986
},
"Total": {
"BookingCurrencyPrice": 33.9,
"EquivCurrencyPrice": 33.9
}
}
},
{
"OfferItemID": "ALaCarteOfferItem-4",
"Eligibility": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment2"
},
"Price": {
"Base": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Tax": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Total": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
}
},
{
"OfferItemID": "ALaCarteOfferItem-5",
"Eligibility": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment1"
},
"Price": {
"Base": {
"BookingCurrencyPrice": 50,
"EquivCurrencyPrice": 50
},
"Tax": {
"BookingCurrencyPrice": 6.5,
"EquivCurrencyPrice": 6.5
},
"Total": {
"BookingCurrencyPrice": 56.5,
"EquivCurrencyPrice": 56.5
}
}
},
{
"OfferItemID": "ALaCarteOfferItem-6",
"Eligibility": {
"PassengerRefs": "ADT1",
"SegmentRefs": "Segment2"
},
"Price": {
"Base": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Tax": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"Total": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
}
}
}
]
},
"ServiceList": [
{
"OfferItemRefs": "ALaCarteOfferItem-1",
"ServiceID": "1678885110745738541",
"ServiceDefinitionRef": "SRV-1"
},
{
"OfferItemRefs": "ALaCarteOfferItem-2",
"ServiceID": "1678885110745589905",
"ServiceDefinitionRef": "SRV-1"
},
{
"OfferItemRefs": "ALaCarteOfferItem-3",
"ServiceID": "1678885110745232670",
"ServiceDefinitionRef": "SRV-2"
},
{
"OfferItemRefs": "ALaCarteOfferItem-4",
"ServiceID": "1678885110745609073",
"ServiceDefinitionRef": "SRV-2"
},
{
"OfferItemRefs": "ALaCarteOfferItem-5",
"ServiceID": "1678885110745809003",
"ServiceDefinitionRef": "SRV-3"
},
{
"OfferItemRefs": "ALaCarteOfferItem-6",
"ServiceID": "1678885110745378283",
"ServiceDefinitionRef": "SRV-3"
}
],
"DataLists": {
"PassengerList": {
"Passengers": [
{
"PassengerID": "T1",
"PTC": "ADT"
}
]
},
"ServiceDefinitionList": {
"ServiceDefinition": [
{
"ServiceDefinitionID": "SRV-1",
"ServiceType": "BAG",
"ServiceCode": "ASSISTIVE DEVICE",
"ServiceName": "ASSISTIVE DEVICE"
},
{
"ServiceDefinitionID": "SRV-2",
"ServiceType": "BAG",
"ServiceCode": "FIRST CHARGEABLE BAG_ASVC",
"ServiceName": "FIRST CHARGEABLE BAG"
},
{
"ServiceDefinitionID": "SRV-3",
"ServiceType": "BAG",
"ServiceCode": "SECOND CHARGEABLE BAG_ASVC",
"ServiceName": "SECOND CHARGEABLE BAG"
}
]
},
"FlightSegmentList": {
"FlightSegment": [
{
"SegmentKey": "Segment1",
"Departure": {
"AirportCode": "YKF",
"Date": "2023-05-20",
"Time": "16:25:00",
"AirportName": "Waterloo Airport",
"Terminal": {
"Name": ""
}
},
"Arrival": {
"AirportCode": "YYC",
"Date": "2023-05-20",
"Time": "18:30:00",
"AirportName": "Calgary International Airport",
"Terminal": {
"Name": ""
}
},
"MarketingCarrier": {
"AirlineID": "WS",
"Name": "Westjet",
"FlightNumber": "557"
},
"OperatingCarrier": {
"AirlineID": "WS",
"Name": "Westjet",
"FlightNumber": "557"
},
"Equipment": {
"AircraftCode": "73W",
"Name": "73W"
},
"Code": {
"MarriageGroup": "O"
},
"FlightDetail": {
"FlightDuration": {
"Value": "4 H 5 M"
},
"Stops": {
"Value": ""
}
},
"BrandId": "BASIC"
},
{
"SegmentKey": "Segment2",
"Departure": {
"AirportCode": "YYC",
"Date": "2023-05-20",
"Time": "20:00:00",
"AirportName": "Calgary International Airport",
"Terminal": {
"Name": ""
}
},
"Arrival": {
"AirportCode": "YVR",
"Date": "2023-05-20",
"Time": "20:32:00",
"AirportName": "Vancouver International Airport",
"Terminal": {
"Name": "M"
}
},
"MarketingCarrier": {
"AirlineID": "WS",
"Name": "Westjet",
"FlightNumber": "66"
},
"OperatingCarrier": {
"AirlineID": "WS",
"Name": "Westjet",
"FlightNumber": "66"
},
"Equipment": {
"AircraftCode": "7M8",
"Name": "7M8"
},
"Code": {
"MarriageGroup": "I"
},
"FlightDetail": {
"FlightDuration": {
"Value": "1 H 32 M"
},
"Stops": {
"Value": ""
}
},
"BrandId": "BASIC"
}
]
},
"FlightList": {
"Flight": [
{
"FlightKey": "Flight1",
"Journey": {
"Time": "7 H 7 M",
"Stops": 1
},
"SegmentReferences": "Segment1 Segment2"
}
]
},
"OriginDestinationList": {
"OriginDestination": [
{
"OriginDestinationKey": "OD1",
"DepartureCode": "YKF",
"ArrivalCode": "YVR",
"FlightReferences": "Flight1"
}
]
}
}
}
}