This is an optional service. You can use this endpoint to get a branded fare offer. It is more expensive as compared to the basic fare. It is only applicable to ticket types: Multicity and One-way offers.
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
This is a required field. Choose a response ID for a particular selection. The value will be String.
Query
OfferID: This is a required field. Provide the shopping response’s offer ID for the selected deal. The value will be String.
Metadata
TraceId: Provide the trace ID. This is a String value.
Request URL
curl --location --request POST 'https://uat-apigateway.voyzantonline.com/AirGetBrandedOffers' \
--header 'Authorization: <YOUR_ACCESS_TOKEN>' \
--header 'x-api-key: <your key here>' \
--header 'Content-Type: application/json'\
Request Body Sample
{
"GetBrandedOffersRQ": {
"Document": {
"Name": "Voyzant Portal",
"ReferenceVersion": "1.0"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": " Voyzant Agency",
"IATA_Number": "1111111111",
"AgencyID": "1111111111",
"Contacts": {
"Contact": [
{
"emailcontact": "pst@voyzant.com"
}
]
}
}
}
},
"ShoppingResponseId": "1679568196808325016",
"Query": {
"Offer": [
{
"OfferID": "3296198711679568203146733088"
}
]
},
"MetaData": {
"TraceId": "161777799749"
}
}
}
Response Sample
{
"GetBrandedOffersRS": {
"Document": {
"Name": "API GATEWAY",
"ReferenceVersion": "1.2"
},
"Party": {
"Sender": {
"TravelAgencySender": {
"Name": "Voyzant Agency",
"IATA_Number": "",
"AgencyID": "Voyzant Agency",
"Contacts": {
"Contact": [
{
"EmailContact": "pst@voyzant.com"
}
]
}
}
}
},
"ShoppingResponseId": "1679568196808325016",
"Success": {},
"OffersGroup": {
"AirlineOffers": [
{
"AirlineOfferSnapshot": {
"PassengerQuantity": 1,
"MatchedOfferQuantity": 1
},
"Offer": [
{
"OfferID": "3296198711679568203146733088",
"Owner": "BA",
"OwnerName": "British Airways",
"IsBrandedFare": "Y",
"BrandedFareOptions": [],
"CabinOptions": [],
"IsAdditionalCabinType": "N",
"Eticket": "false",
"AllowHold": "Y",
"TimeLimits": {
"OfferExpirationDateTime": "2023-03-23T12:46:29",
"PaymentExpirationDateTime": "2023-04-12 03:00:00"
},
"PassportRequired": "N",
"BookingCurrencyCode": "CAD",
"EquivCurrencyCode": "CAD",
"HstPercentage": "",
"RewardSettings": {
"RewardAvailable": "N",
"PointTypes": [],
"PointValues": {}
},
"BookingFeeInfo": {
"FeeType": "",
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"TotalPrice": {
"BookingCurrencyPrice": 3753.46,
"EquivCurrencyPrice": 3753.46
},
"BasePrice": {
"BookingCurrencyPrice": 3288,
"EquivCurrencyPrice": 3288
},
"TaxPrice": {
"BookingCurrencyPrice": 465.46,
"EquivCurrencyPrice": 465.46
},
"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": "NA",
"EquivCurrencyPrice": "NA"
},
"After": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
}
},
"CancelationFee": {
"Before": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
},
"After": {
"BookingCurrencyPrice": "NA",
"EquivCurrencyPrice": "NA"
}
}
},
"OfferItem": [
{
"OfferItemID": "OFFERITEMID1",
"Refundable": "false",
"PassengerType": "ADT",
"PassengerQuantity": 1,
"TotalPriceDetail": {
"TotalAmount": {
"BookingCurrencyPrice": 3753.46,
"EquivCurrencyPrice": 3753.46
}
},
"Service": [
{
"ServiceID": "SV1",
"PassengerRefs": "ADT1",
"FlightRefs": "Flight1"
}
],
"FareDetail": {
"PassengerRefs": "ADT1",
"Price": {
"TotalAmount": {
"BookingCurrencyPrice": 3753.46,
"EquivCurrencyPrice": 3753.46
},
"BaseAmount": {
"BookingCurrencyPrice": 3288,
"EquivCurrencyPrice": 3288
},
"TaxAmount": {
"BookingCurrencyPrice": 465.46,
"EquivCurrencyPrice": 465.46
},
"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": 400,
"EquivCurrencyPrice": 400
},
{
"TaxCode": "CA",
"BookingCurrencyPrice": 25.91,
"EquivCurrencyPrice": 25.91
},
{
"TaxCode": "RC",
"BookingCurrencyPrice": 4.55,
"EquivCurrencyPrice": 4.55
},
{
"TaxCode": "SQ",
"BookingCurrencyPrice": 35,
"EquivCurrencyPrice": 35
}
]
}
},
"FareComponent": [
{
"PriceClassRef": "PCR_1",
"SegmentRefs": "Segment1",
"FareBasis": {
"FareBasisCode": {
"Refs": "FG_1",
"Code": "W1N0C9S1"
},
"RBD": "W",
"CabinType": "S",
"SeatLeft": "9"
}
}
]
}
],
"BaggageAllowance": [
{
"SegmentRefs": "Segment1",
"PassengerRefs": "T1",
"BaggageAllowanceRef": "Bag1"
}
],
"BookingToEquivExRate": 1,
"FopRef": "FOP_1341_0_1987_0_ALL_PUB"
}
]
}
]
},
"DataLists": {
"PassengerList": {
"Passengers": [
{
"PassengerID": "T1",
"PTC": "ADT"
}
]
},
"DisclosureList": {
"Disclosures": []
},
"FareList": {
"FareGroup": [
{
"FareGroupRef": "FG_1",
"FareCode": "70J",
"FareBasisCode": "W1N0C9S1"
}
]
},
"FlightSegmentList": {
"FlightSegment": [
{
"SegmentKey": "Segment1",
"Departure": {
"AirportCode": "YYZ",
"Date": "2023-04-14",
"Time": "18:35:00",
"AirportName": "Lester B. Pearson International Airport",
"Terminal": {
"Name": "3"
}
},
"Arrival": {
"AirportCode": "LHR",
"Date": "2023-04-15",
"Time": "06:35:00",
"AirportName": "London Heathrow Airport",
"Terminal": {
"Name": "5"
}
},
"MarketingCarrier": {
"AirlineID": "BA",
"Name": "British Airways",
"FlightNumber": "92"
},
"OperatingCarrier": {
"AirlineID": "BA",
"Name": "British Airways",
"FlightNumber": "92"
},
"Equipment": {
"AircraftCode": "777",
"Name": "Boeing 777 all pax models"
},
"Code": {
"MarriageGroup": "O"
},
"FlightDetail": {
"FlightDuration": {
"Value": "7 H 0 M"
},
"Stops": {
"Value": 0
},
"InterMediate": [],
"AirMilesFlown": 0
},
"BrandId": "PEFLEX"
}
]
},
"FlightList": {
"Flight": [
{
"FlightKey": "Flight1",
"Journey": {
"Time": "7 H 0 M",
"Stops": 0
},
"SegmentReferences": "Segment1"
}
]
},
"OriginDestinationList": {
"OriginDestination": [
{
"OriginDestinationKey": "OD1",
"DepartureCode": "YYZ",
"ArrivalCode": "LHR",
"FlightReferences": "Flight1"
}
]
},
"PriceClassList": {
"PriceClass": [
{
"PriceClassID": "PCR_1",
"Name": "Premium economy fully flex",
"Code": "Premium economy fully flex",
"Descriptions": {
"Description": [
{
"Code": "0LO",
"Type": "F",
"Text": "PREMIUM CATERING"
},
{
"Code": "03P",
"Type": "N",
"Text": "DEDICATED CHECK IN ZONE"
},
{
"Code": "0LW",
"Type": "N",
"Text": "PRIORITY SECURITY"
},
{
"Code": "050",
"Type": "F",
"Text": "SEAT CHOICE"
},
{
"Code": "06I",
"Type": "F",
"Text": "CHANGE BEFORE DEPARTURE"
},
{
"Code": "06J",
"Type": "F",
"Text": "CHANGE AFTER DEPARTURE"
},
{
"Code": "06K",
"Type": "F",
"Text": "REFUND BEFORE DEPARTURE"
}
]
}
}
]
},
"BaggageAllowanceList": {
"BaggageAllowance": [
{
"BaggageAllowanceID": "Bag1",
"BaggageCategory": "Checked",
"AllowanceDescription": {
"ApplicableParty": "Traveler",
"Description": "CHECKED ALLOWANCE"
},
"PieceAllowance": {
"ApplicableParty": "Traveler",
"TotalQuantity": "2",
"Unit": "Pieces"
}
}
]
},
"FopList": [
{
"CC": {
"Allowed": "Y",
"Types": {
"AX": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"MC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"VI": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"JC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"DC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"DUS": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"MA": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"DS": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"TP": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
}
}
},
"DC": {
"Allowed": "Y",
"Types": {
"MC": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"VI": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
},
"RU": {
"F": {
"BookingCurrencyPrice": 0,
"EquivCurrencyPrice": 0
},
"P": 0
}
}
},
"CASH": {
"Allowed": "N",
"Types": {}
},
"CHEQUE": {
"Allowed": "Y",
"Types": {}
},
"ACH": {
"Allowed": "Y",
"Types": {}
},
"PG": {
"Allowed": "N",
"Types": {}
},
"FopKey": "FOP_1341_0_1987_0_ALL_PUB"
}
]
},
"MetaData": {}
}
}