AirOrderRetreive

You can use this endpoint to retrieve the order or booking using an Order ID and GDS Booking Reference. It helps you to retrieve or check, whether the offer has been stored, and also to retrieve the booking’s current status.

Note: GDS-Global Distribution System.

Schema

  • Name: Provide the name for the request. This is a String value.

  • ReferenceVersion: Provide the version number. This is a Numeric value.


  • 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. This is a String value.

    • Contacts: This is an Array.

      • EmailContact: Provide the email contact for the request. This is a String value.

  • OrderID: This is a required field. Provide the order ID for a specific selection. The value will be String.

  • GDSBookingReference: This is a required field. Provide the GDS Booking Reference for a specific selection. The value will be String.

It is multiple when it’s a one-way offer.


Request URL

curl --location --request POST 'https://newapi.tltid.com/AirOrderRetreive' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \

Request Body Sample

{
    "OrderRetreiveRQ": {
        "Document": {
            "Name": "Wintlt NDC GATEWAY",
            "ReferenceVersion": "1.0"
        },
        "Party": {
            "Sender": {
                "TravelAgencySender": {
                    "Name": "Skyroute B2B Portal",
                    "IATA_Number": "1111111111",
                    "AgencyID": "Skyroute B2B Portal",
                    "Contacts": {
                        "Contact": [
                            {
                                "EmailContact": "skyroute@gmail.com"
                            }
                        ]
                    }
                }
            }
        },
        "Query": {
            "OrderID": "VF2EGBN1",
            "GdsBookingReference": ["UPMEFY"]
        }
    }
}

Response Sample

{
    "OrderViewRS": {
        "Document": {
            "Name": "Clarity NDC GATEWAY",
            "ReferenceVersion": "1.2"
        },
        "Party": {
            "Sender": {
                "TravelAgencySender": {
                    "Name": "kathir",
                    "IATA_Number": "",
                    "AgencyID": "",
                    "Contacts": {
                        "Contact": [
                            {
                                "EmailContact": "kathir@gmail.com"
                            }
                        ]
                    }
                }
            }
        },
        "ShoppingResponseId": "1620222081937399839",
        "Success": {},
        "Order": [
            {
                "OrderID": "VF2EGBN1",
                "GdsBookingReference": "UPMEFY",
                "OrderStatus": "BOOKED",
                "PaymentStatus": "PAID",
                "TicketStatus": "NOT TICKETED",
                "NeedToTicket": "N",
                "OptionalServiceStatus": "SUCCESS",
                "SeatSelectionStatus": "SUCCESS",
                "OfferID": "151711620222089401678730",
                "Owner": "EY",
                "OwnerName": "Etihad Airways",
                "IsBrandedFare": "Y",
                "CabinOptions": [],
                "IsAdditionalCabinType": "N",
                "TimeLimits": {
                    "OfferExpirationDateTime": "2021-05-05T21:26:37"
                },
                "BookingCurrencyCode": "CAD",
                "EquivCurrencyCode": "CAD",
                "RewardSettings": {
                    "RewardAvailable": "N",
                    "PointTypes": [],
                    "PointValues": {}
                },
                "BookingFeeInfo": {
                    "FeeType": "",
                    "BookingCurrencyPrice": 0,
                    "EquivCurrencyPrice": 0
                },
                "TotalPrice": {
                    "BookingCurrencyPrice": 130.383,
                    "EquivCurrencyPrice": 130.383
                },
                "BasePrice": {
                    "BookingCurrencyPrice": 64.173,
                    "EquivCurrencyPrice": 64.173
                },
                "TaxPrice": {
                    "BookingCurrencyPrice": 66.21,
                    "EquivCurrencyPrice": 66.21
                },
                "Commission": {
                    "AgencyCommission": {
                        "BookingCurrencyPrice": 0,
                        "EquivCurrencyPrice": 0
                    },
                    "AgencyYqCommission": {
                        "BookingCurrencyPrice": 0,
                        "EquivCurrencyPrice": 0
                    }
                },
                "PortalCharges": {
                    "Markup": {
                        "BookingCurrencyPrice": 0,
                        "EquivCurrencyPrice": 0
                    },
                    "Surcharge": {
                        "BookingCurrencyPrice": 0,
                        "EquivCurrencyPrice": 0
                    },
                    "Discount": {
                        "BookingCurrencyPrice": 0,
                        "EquivCurrencyPrice": 0
                    }
                },
                "Penalty": {
                    "ChangeFee": {
                        "Before": {
                            "BookingCurrencyPrice": 226.22,
                            "EquivCurrencyPrice": 226.22
                        },
                        "After": {
                            "BookingCurrencyPrice": 236.22,
                            "EquivCurrencyPrice": 236.22
                        }
                    },
                    "CancelationFee": {
                        "Before": {
                            "BookingCurrencyPrice": 174,
                            "EquivCurrencyPrice": 174
                        },
                        "After": {
                            "BookingCurrencyPrice": 184,
                            "EquivCurrencyPrice": 184
                        }
                    }
                },
                "PaxSeatInfo": [],
                "OfferItem": [
                    {
                        "OfferItemID": "OFFERITEMID1",
                        "Refundable": "true",
                        "PassengerType": "ADT",
                        "PassengerQuantity": 1,
                        "TotalPriceDetail": {
                            "TotalAmount": {
                                "BookingCurrencyPrice": 130.383,
                                "EquivCurrencyPrice": 130.383
                            }
                        },
                        "Service": [
                            {
                                "ServiceID": "SV1",
                                "PassengerRefs": "ADT1",
                                "FlightRefs": "Flight1"
                            }
                        ],
                        "FareDetail": {
                            "PassengerRefs": "ADT1",
                            "Price": {
                                "TotalAmount": {
                                    "BookingCurrencyPrice": 130.383,
                                    "EquivCurrencyPrice": 130.383
                                },
                                "BaseAmount": {
                                    "BookingCurrencyPrice": 64.173,
                                    "EquivCurrencyPrice": 64.173
                                },
                                "TaxAmount": {
                                    "BookingCurrencyPrice": 66.21,
                                    "EquivCurrencyPrice": 66.21
                                },
                                "Commission": {
                                    "AgencyCommission": {
                                        "BookingCurrencyPrice": 0,
                                        "EquivCurrencyPrice": 0
                                    },
                                    "AgencyYqCommission": {
                                        "BookingCurrencyPrice": 0,
                                        "EquivCurrencyPrice": 0
                                    }
                                },
                                "BookingFee": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                },
                                "PortalCharges": {
                                    "Markup": {
                                        "BookingCurrencyPrice": 0,
                                        "EquivCurrencyPrice": 0
                                    },
                                    "Surcharge": {
                                        "BookingCurrencyPrice": 0,
                                        "EquivCurrencyPrice": 0
                                    },
                                    "Discount": {
                                        "BookingCurrencyPrice": 0,
                                        "EquivCurrencyPrice": 0
                                    }
                                },
                                "Taxes": [
                                    {
                                        "TaxCode": "YQ",
                                        "BookingCurrencyPrice": 36.86,
                                        "EquivCurrencyPrice": 36.86
                                    },
                                    {
                                        "TaxCode": "YR",
                                        "BookingCurrencyPrice": 3.69,
                                        "EquivCurrencyPrice": 3.69
                                    },
                                    {
                                        "TaxCode": "K3",
                                        "BookingCurrencyPrice": 5.23,
                                        "EquivCurrencyPrice": 5.23
                                    },
                                    {
                                        "TaxCode": "IN",
                                        "BookingCurrencyPrice": 1.36,
                                        "EquivCurrencyPrice": 1.36
                                    },
                                    {
                                        "TaxCode": "ZR",
                                        "BookingCurrencyPrice": 1.67,
                                        "EquivCurrencyPrice": 1.67
                                    },
                                    {
                                        "TaxCode": "P2",
                                        "BookingCurrencyPrice": 17.4,
                                        "EquivCurrencyPrice": 17.4
                                    }
                                ]
                            }
                        },
                        "FareComponent": [
                            {
                                "PriceClassRef": "PCR_1",
                                "SegmentRefs": "Segment1 Segment2",
                                "FareBasis": {
                                    "FareBasisCode": {
                                        "Refs": "FG_1 FG_1",
                                        "Code": "ERH1EY ERH1EY"
                                    },
                                    "RBD": "E E",
                                    "CabinType": "Y Y",
                                    "SeatLeft": "9 9"
                                }
                            }
                        ]
                    },
                    {
                        "OfferItemID": "SRV-OfferItem-1",
                        "Service": {
                            "PassengerRefs": "ADT1",
                            "SegmentRefs": "Segment1"
                        },
                        "Price": {
                            "Base": {
                                "BookingCurrencyPrice": 6.14,
                                "EquivCurrencyPrice": 6.14
                            },
                            "Tax": {
                                "BookingCurrencyPrice": 0,
                                "EquivCurrencyPrice": 0
                            },
                            "Total": {
                                "BookingCurrencyPrice": 6.14,
                                "EquivCurrencyPrice": 6.14
                            }
                        },
                        "ServiceDefinitionRef": "SRV-1"
                    },
                    {
                        "OfferItemID": "Seat-OfferItem-1",
                        "Service": {
                            "PassengerRefs": "ADT1",
                            "SegmentRefs": "Segment1",
                            "SelectedSeat": {
                                "Seat": {
                                    "Row": 8,
                                    "Column": "A"
                                }
                            }
                        },
                        "Price": {
                            "Base": {
                                "BookingCurrencyPrice": 0,
                                "EquivCurrencyPrice": 0
                            },
                            "Tax": {
                                "BookingCurrencyPrice": 0,
                                "EquivCurrencyPrice": 0
                            },
                            "Total": {
                                "BookingCurrencyPrice": 0,
                                "EquivCurrencyPrice": 0
                            }
                        }
                    }
                ],
                "BaggageAllowance": [
                    {
                        "SegmentRefs": "Segment1 Segment2",
                        "PassengerRefs": "ADT1",
                        "BaggageAllowanceRef": "Bag1"
                    }
                ],
                "BookingToEquivExRate": 1,
                "FopRef": "FOP_5_5_17_0_ALL"
            }
        ],
        "DataLists": {
            "PassengerList": {
                "Passengers": [
                    {
                        "attributes": {
                            "PassengerID": "ADT1"
                        },
                        "PassengerID": "ADT1",
                        "PTC": "ADT",
                        "BirthDate": "2000-07-21",
                        "NameTitle": "Mr",
                        "FirstName": "downey",
                        "MiddleName": "",
                        "LastName": "Robert",
                        "TravelDocument": {
                            "DocumentNumber": "9658745",
                            "ExpiryDate": "2024-01-01",
                            "IssuingCountry": "CA",
                            "DocumentType": ""
                        },
                        "Preference": {
                            "WheelChairPreference": {
                                "Reason": ""
                            },
                            "SeatPreference": "any"
                        },
                        "LoyaltyProgramAccount": [
                            {
                                "ProgramID": "AA",
                                "AirlineID": "AA",
                                "AccountNumber": "8349843875"
                            }
                        ],
                        "ContactInfoRef": "CTC1"
                    }
                ]
            },
            "DisclosureList": {
                "Disclosures": []
            },
            "FareList": {
                "FareGroup": [
                    {
                        "FareGroupRef": "FG_1",
                        "FareCode": "70J",
                        "FareBasisCode": "ERH1EY"
                    }
                ]
            },
            "FlightSegmentList": {
                "FlightSegment": [
                    {
                        "SegmentKey": "Segment1",
                        "Departure": {
                            "AirportCode": "MAA",
                            "Date": "2021-10-25",
                            "Time": "09:25:00",
                            "AirportName": "Chennai International Airport",
                            "Terminal": {
                                "Name": "4"
                            }
                        },
                        "Arrival": {
                            "AirportCode": "AUH",
                            "Date": "2021-10-25",
                            "Time": "12:15:00",
                            "AirportName": "Abu Dhabi International Airport",
                            "Terminal": {
                                "Name": "1"
                            }
                        },
                        "MarketingCarrier": {
                            "AirlineID": "EY",
                            "Name": "Etihad Airways",
                            "FlightNumber": "239"
                        },
                        "OperatingCarrier": {
                            "AirlineID": "EY",
                            "Name": "Etihad Airways",
                            "FlightNumber": "239"
                        },
                        "Equipment": {
                            "AircraftCode": "",
                            "Name": ""
                        },
                        "Code": {
                            "MarriageGroup": ""
                        },
                        "FlightDetail": {
                            "FlightDuration": {
                                "Value": "4 Hrs 20 Min"
                            },
                            "Stops": {
                                "Value": 0
                            },
                            "InterMediate": [],
                            "AirMilesFlown": "1860"
                        },
                        "BrandId": "YH"
                    },
                    {
                        "SegmentKey": "Segment2",
                        "Departure": {
                            "AirportCode": "AUH",
                            "Date": "2021-10-25",
                            "Time": "13:00:00",
                            "AirportName": "Abu Dhabi International Airport",
                            "Terminal": {
                                "Name": "1"
                            }
                        },
                        "Arrival": {
                            "AirportCode": "XNB",
                            "Date": "2021-10-25",
                            "Time": "14:20:00",
                            "AirportName": "United Arab Emirates",
                            "Terminal": {
                                "Name": ""
                            }
                        },
                        "MarketingCarrier": {
                            "AirlineID": "EY",
                            "Name": "Etihad Airways",
                            "FlightNumber": "5422"
                        },
                        "OperatingCarrier": {
                            "AirlineID": "EY",
                            "Name": "Etihad Airways",
                            "FlightNumber": "5422"
                        },
                        "Equipment": {
                            "AircraftCode": "Bus",
                            "Name": "Bus"
                        },
                        "Code": {
                            "MarriageGroup": ""
                        },
                        "FlightDetail": {
                            "FlightDuration": {
                                "Value": "1 Hrs 20 Min"
                            },
                            "Stops": {
                                "Value": 0
                            },
                            "InterMediate": [],
                            "AirMilesFlown": "381"
                        },
                        "BrandId": "YH"
                    }
                ]
            },
            "FlightList": {
                "Flight": [
                    {
                        "FlightKey": "Flight1",
                        "Journey": {
                            "Time": "10 H 25 M",
                            "Stops": 1
                        },
                        "SegmentReferences": "Segment1 Segment2"
                    }
                ]
            },
            "OriginDestinationList": {
                "OriginDestination": [
                    {
                        "OriginDestinationKey": "OD1",
                        "DepartureCode": "MAA",
                        "ArrivalCode": "XNB",
                        "FlightReferences": "Flight1"
                    }
                ]
            },
            "PriceClassList": {
                "PriceClass": [
                    {
                        "PriceClassID": "PCR_1",
                        "Name": "ECONOMY HBO",
                        "Code": "ECONOMY HBO",
                        "Descriptions": {
                            "Description": []
                        }
                    }
                ]
            },
            "BaggageAllowanceList": {
                "BaggageAllowance": [
                    {
                        "BaggageAllowanceID": "Bag1",
                        "BaggageCategory": "Checked",
                        "AllowanceDescription": {
                            "ApplicableParty": "Traveler",
                            "Description": "CHECKED ALLOWANCE"
                        },
                        "PieceAllowance": {
                            "ApplicableParty": "Traveler",
                            "TotalQuantity": "0",
                            "Unit": "kg"
                        }
                    }
                ]
            },
            "ServiceDefinitionList": {
                "ServiceDefinition": [
                    {
                        "ServiceDefinitionID": "SRV-1",
                        "ServiceType": "MEAL",
                        "ServiceCode": "HOT DINNER",
                        "ServiceName": "HOT DINNER"
                    }
                ]
            },
            "FopList": [
                {
                    "CC": {
                        "Allowed": "Y",
                        "Types": {
                            "AX": {
                                "F": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                },
                                "P": 0,
                                "Charges": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                }
                            },
                            "MC": {
                                "F": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                },
                                "P": 0,
                                "Charges": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                }
                            },
                            "VI": {
                                "F": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                },
                                "P": 0,
                                "Charges": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                }
                            }
                        }
                    },
                    "DC": {
                        "Allowed": "Y",
                        "Types": {
                            "MC": {
                                "F": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                },
                                "P": 0,
                                "Charges": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                }
                            },
                            "VI": {
                                "F": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                },
                                "P": 0,
                                "Charges": {
                                    "BookingCurrencyPrice": 0,
                                    "EquivCurrencyPrice": 0
                                }
                            }
                        }
                    },
                    "CASH": {
                        "Allowed": "Y",
                        "Types": {}
                    },
                    "CHEQUE": {
                        "Allowed": "Y",
                        "Types": {}
                    },
                    "ACH": {
                        "Allowed": "Y",
                        "Types": {}
                    },
                    "PG": {
                        "Allowed": "Y",
                        "Types": {}
                    },
                    "FopKey": "FOP_5_5_17_0_ALL"
                }
            ]
        },
        "MetaData": {
            "PassengerMetadata": {
                "SpecialServiceRequest": [
                    {
                        "PassengerID": "ADT1",
                        "Origin": "LAX",
                        "Destination": "EWR",
                        "DepartureDateTime": "2021-06-19",
                        "MarketingFlightNumber": "3058",
                        "MarketingCarrier": "UA",
                        "SsrType": "SSR",
                        "SsrCode": "Ambulatory",
                        "FreeText": "jk"
                    },
                    {
                        "PassengerID": "ADT1",
                        "Origin": "LAX",
                        "Destination": "EWR",
                        "DepartureDateTime": "2021-06-19",
                        "MarketingFlightNumber": "3058",
                        "MarketingCarrier": "UA",
                        "SsrType": "SSR",
                        "SsrCode": "FREE MEAL",
                        "FreeText": "SSRRR"
                    }
                ]
            }
        }
    }
}

Try it out!