OfferPrice Response - OfferPrice 17.2 Response Specification
Technical Documentation

 OfferPrice Response

DATA MODEL
DATA MODEL
<OfferPriceRS>
Element Details optional
<Document> Document Tag M
<Success> Success flag indicator element will be returned to show if request was successful. M
<Error> Error response elements returned if an Error or Warning is provided in the response. O
<Warnings> Warning Response Message, provides any warning notice returned in relation to offers. O
<ShoppingResponseID> 
												<ShoppingResponseID>
    <ResponseID>tx-08-201-d3d410b5-e707-4469-8b24-b747531ea9a0</ResponseID>
</ShoppingResponseID>
Element Details optional
<ShoppingResponseID>   O
<ResponseID>

Unique shopping response ID. This is normally the date and time stamp.

Example:
tx-08-201-d3d410b5-e707-4469-8b24-b747531ea9a0

 M
<PricedOffer> 
													<PricedOffer OfferID="OF-3749b7c1-ddcb-455c-9f46-394e64307387" Owner="BA">
	<OfferExpirationDateTime>2018-04-15T22:59:00.000Z</OfferExpirationDateTime>
	<PaymentTimeLimitDateTime>2018-04-17T22:15:00.000Z</PaymentTimeLimitDateTime>
	<PriceGuaranteeTimeLimitDateTime>2018-04-15T22:44:00.000Z</PriceGuaranteeTimeLimitDateTime>
	<TotalPrice>
		<SimpleCurrencyPrice Code="GBP">200.20</SimpleCurrencyPrice>
	</TotalPrice>
	<BagDisclosureRefs>HANDBAGOD1 CKBAGOD1 HANDBAGOD2 CKBAGOD2</BagDisclosureRefs>
	<OfferItem OfferItemID="OF-3749b7c1-ddcb-455c-9f46-394e64307387-OI-1" MandatoryInd="true">
		<TotalPriceDetail>
			<TotalAmount>
				<SimpleCurrencyPrice Code="GBP">200.20</SimpleCurrencyPrice>
			</TotalAmount>
		</TotalPriceDetail>
		<Service ServiceID="OF-3749b7c1-ddcb-455c-9f46-394e64307387-OI-1-SVC-1">
			<PassengerRefs>SH1</PassengerRefs>
			<FlightRefs>Flight1</FlightRefs>
		</Service>
		<Service ServiceID="OF-3749b7c1-ddcb-455c-9f46-394e64307387-OI-1-SVC-2">
			<PassengerRefs>SH1</PassengerRefs>
			<FlightRefs>Flight2</FlightRefs>
		</Service>
		<FareDetail>
			<Price>
				<TotalAmount>
					<SimpleCurrencyPrice Code="GBP">200.20</SimpleCurrencyPrice>
				</TotalAmount>
				<BaseAmount Code="GBP">155.00</BaseAmount>
				<Taxes>
					<Total Code="GBP">45.20</Total>
					<Breakdown>
						<Tax>
							<Amount Code="GBP">3.20</Amount>
							<TaxCode>XF</TaxCode>
							<CollectionPoint>
								<CurrCode>USD</CurrCode>
								<AirportAmount>04.50
								</AirportAmount>
								<AirportCode>JFK
								</AirportCode>
							</CollectionPoint>
							<Description>Air Passenger Duty - United Kingdom</Description>
						</Tax>
						<Tax>
							<Amount Code="GBP">42.00</Amount>
							<TaxCode>UB</TaxCode>
							<Description>Passenger Service Charge - United Kingdom</Description>
							<AddlTaxType>AS</AddlTaxType>
						</Tax>
					</Breakdown>
				</Taxes>
			</Price>
			<FareComponent>
				<FareRules>
					<Penalty refs="Rule1 Rule2 Rule3 Rule7 Rule8 Rule9"/>
				</FareRules>
				<PriceClassRef>PCR_1</PriceClassRef>
				<SegmentRefs>FS1</SegmentRefs>
			</FareComponent>
			<FareComponent>
				<FareRules>
					<Penalty refs="Rule4 Rule5 Rule6 Rule7 Rule8 Rule9"/>
				</FareRules>
				<PriceClassRef>PCR_2</PriceClassRef>
				<SegmentRefs>FS2</SegmentRefs>
			</FareComponent>
		</FareDetail>
	</OfferItem>
	<BaggageAllowance>
		<FlightRefs>Flight1 Flight2</FlightRefs>
		<PassengerRefs>SH1</PassengerRefs>
		<BaggageAllowanceRef>HANDBAGALLOWANCE</BaggageAllowanceRef>
	</BaggageAllowance>
	<BaggageAllowance>
		<FlightRefs>Flight1 Flight2</FlightRefs>
		<PassengerRefs>SH1</PassengerRefs>
		<BaggageAllowanceRef>CKBAG1</BaggageAllowanceRef>
	</BaggageAllowance>
</PricedOffer>
Element Details optional
<PricedOffer> This returns total fare, fare per passenger type and tax details along with fare rules for the requested itinerary M 
OfferID attr

A unique offer ID

Example: OF-3749b7c1-ddcb-455c-9f46-394e64307387		 M 
Owner attr
 will always be 'BA' M
<OfferExpirationDateTime>

This is the time by which offer will remain in the system to be used by subsequent APIs calling ‘Order by reference’ method.

Example: 2018-08-07T07:47:14.643Z

 O
<PaymentTimeLimitDateTime>

This is the deadline by which a commitment to pay must be made for the confirmed items in an offer as agreed with the airline

This is also called as Ticket Time Limit, as tickets will only be issued once payment is made

Example: 2016-09-05T22:59:00.000Z

 O

<PriceGuaranteeTimeLimitDateTime>

This is the time by which BA guarantee the offered Price for the booking

Example: 2018-08-07T07:47:14.643Z

O
<TotalPrice> This returns the total price for the requested itinerary for all the requested passengers O
<SimpleCurrencyPrice> Total amount M 
Code attr

Currency Code

Example: GBP		 O
<BagDisclosureRefs>

Baggage disclosures reference e.g.: CKBAG (for Checked Baggage) HANDBAG (for Hand baggage). Each reference will be delimited by a space

Example: HANDBAGOD1 CKBAGOD1

Both hand baggage and checked baggage details for the references are returned in  BagDisclosure  under  DataLists  

O
<OfferItem> This should be repeated for each passenger type M 
OfferItemID attr

A unique offer item ID

Example: OI1		 M 
MandatoryInd attr

Indicates whether the OfferItem is mandatory or optional to create an Order

Possible values: true or false		 O
<TotalPriceDetail>   M
<TotalAmount> This returns the total price of the offer for all the passenger requested per passenger type M
<SimpleCurrencyPrice> Total Amount M 
Code attr

Currency Code

Example: GBP

 O
<Service> This returns the service this OfferItem is entitled to. M 
ServiceID attr

A unique Service ID

Example: OI1SERVICE1		 M
<PassengerRefs>

This returns the passenger reference for all the passenger for who the service is applicable.

Each reference is delimited by a space.

Example: SH1 SH2

Each passenger reference should be detailed in  PassengerList  under  DataLists

 M
<FlightRefs>

This return the all the flight references which are part of this service.

Each reference is delimited by a space.

Example: Flight1 Flight2

Each Flight reference should be detailed in  FlightList  under  DataLists

 M
<FareDetail> This returns FareRules and price detail applicable to flights & passenger type respectively applicable to this OfferItem O
<Price> Price returned per passenger type with total price, fare & tax along with the breakdown M
<TotalAmount> The total amount per passenger type O
<SimpleCurrencyPrice> Total amount (Base fare + Tax) per passenger type for the itinerary M 
Code attr
 Currency Code O
<BaseAmount> Base fare per passenger type for the itinerary M 
Code attr
 Currency Code O
<Taxes> This returns taxes per passenger type for the itinerary O
<Total> Total tax per passenger type O 
Code attr
 Currency Code O
<Breakdown> Return tax breakdown per passenger type O
<Tax>   M
<Amount> Amount M 
Code attr
 Currency code O
<TaxCode> Tax Code O
<AddlTaxType> Nature code for the tax element
Example: AD		 O
<CollectionPoint> Tax data break down by collection point for XF (Extra fee) and ZP (Federal tax segment) taxes O
<CurrCode>

Airport’s local currency code

Example: USD		 O
<AirportAmount>

Amount filed by the airport in the currency applicable to the geographical location of the airport

Example: 4.50		 M
<AirportCode>

Segment departure or arrival airport code

Example: JFK		 M
<Description> Tax description O
<FareComponent> Repeat FareComponent per Origin & Destination O
<FareRules> This returns FareRules for the flights O
<Penalty> This returns Penalties for the requested flights O 
refs attr

This returns the reference to all the penalty rules that are applicable to the flights under OfferItem.

Each reference is delimited by a space.

Example: Rule1 Rule2

Each Penalty rule should be detailed in  PenaltyList  under  DataLists

 O
<PriceClassRef>

This returns the PriceClass reference for the flights applicable to the offerItem

Each reference is delimited by a space.

Example: PCR_1 PCR_2

Each PriceClass reference should be detailed in  PriceClassList  under  DataLists

 O
<SegmentRefs> This returns reference to all the segments applicable per PriceClassRef O
<BaggageAllowance> This returns the baggage allowance for the requested itinerary. This will repeat for each OriginDestination and once for HandBagAllowance for all the OriginDestinations O
<FlightRefs>

All the flight references from which the bag allowance is applicable.

Each reference is delimited by a space.

Example: Flight1 Flight2

Each Flight reference should be detailed in  FlightList  under  DataLists

 M
<PassengerRefs>

All the passenger references for which the bag allowance is applicable.

Each reference is delimited by a space.

Example: SH1 SH2

Each passenger reference should be detailed in  PassengerList  under  DataLists

 M
<BaggageAllowanceRef> Reference to the baggage allowance applicable to the offer. This reference is detailed in the  BaggageAllowanceList  under  DataLists M
<OtherOffers> 
													<OtherOffers>
	<Offer OfferID="OF-d334406a-6b98-4bff-85db-c61174dd6b68" Owner="BA">
		<OfferExpirationDateTime>2018-04-15T22:59:00.000Z</OfferExpirationDateTime>
		<PriceGuaranteeTimeLimitDateTime>2018-04-15T22:44:00.000Z</PriceGuaranteeTimeLimitDateTime>
		<TotalPrice>
			<SimpleCurrencyPrice Code="GBP">380.20</SimpleCurrencyPrice>
		</TotalPrice>
		<BagDisclosureRefs>HANDBAGOD1 HANDBAGOD2 CKBAGOD1OFFER2 CKBAGOD2OFFER2</BagDisclosureRefs>
		<OfferItem OfferItemID="OF-d334406a-6b98-4bff-85db-c61174dd6b68-OI-1" MandatoryInd="true">
			<TotalPriceDetail>
				<TotalAmount>
					<SimpleCurrencyPrice Code="GBP">380.20</SimpleCurrencyPrice>
				</TotalAmount>
			</TotalPriceDetail>
			<Service ServiceID="OF-d334406a-6b98-4bff-85db-c61174dd6b68-OI-1-SVC-1">
				<PassengerRefs>SH1</PassengerRefs>
				<FlightRefs>Flight1</FlightRefs>
			</Service>
			<Service ServiceID="OF-d334406a-6b98-4bff-85db-c61174dd6b68-OI-1-SVC-2">
				<PassengerRefs>SH1</PassengerRefs>
				<FlightRefs>Flight2</FlightRefs>
			</Service>
			<FareDetail>
				<Price>
					<TotalAmount>
						<SimpleCurrencyPrice Code="GBP">380.20</SimpleCurrencyPrice>
					</TotalAmount>
					<BaseAmount Code="GBP">322.00</BaseAmount>
					<Taxes>
						<Total Code="GBP">58.20</Total>
						<Breakdown>
							<Tax>
								<Amount Code="GBP">27.00</Amount>
								<TaxCode>GB</TaxCode>
								<Description>Air Passenger Duty - United Kingdom</Description>
								<AddlTaxType>AD</AddlTaxType>
							</Tax>
							<Tax>
								<Amount Code="GBP">28.20</Amount>
								<TaxCode>XU</TaxCode>
								<Description>XUAV</Description>
								<AddlTaxType>AV</AddlTaxType>
							</Tax>
							<Tax>
								<Amount Code="GBP">3.20</Amount>
								<TaxCode>XF</TaxCode>
								<CollectionPoint>
									<CurrCode>USD</CurrCode>
									<AirportAmount>04.50</AirportAmount>
									<AirportCode>JFK</AirportCode>
								</CollectionPoint>
								<Description>Air Passenger Duty - United Kingdom</Description>
							</Tax>       
						</Breakdown>
					</Taxes>
				</Price>
				<FareComponent>
					<FareRules>
						<Penalty refs="Rule1 Rule2 Rule7 Rule8 Rule9 Rule10"/>
					</FareRules>
					<PriceClassRef>PCR_3</PriceClassRef>
					<SegmentRefs>FS1</SegmentRefs>
				</FareComponent>
				<FareComponent>
					<FareRules>
						<Penalty refs="Rule4 Rule5 Rule7 Rule8 Rule9 Rule11"/>
					</FareRules>
					<PriceClassRef>PCR_4</PriceClassRef>
					<SegmentRefs>FS2</SegmentRefs>
				</FareComponent>
			</FareDetail>
		</OfferItem>
		<BaggageAllowance>
			<FlightRefs>Flight1 Flight2</FlightRefs>
			<PassengerRefs>SH1</PassengerRefs>
			<BaggageAllowanceRef>HANDBAGALLOWANCE</BaggageAllowanceRef>
		</BaggageAllowance>
		<BaggageAllowance>
			<FlightRefs>Flight1 Flight2</FlightRefs>
			<PassengerRefs>SH1</PassengerRefs>
			<BaggageAllowanceRef>CKBAG2</BaggageAllowanceRef>
		</BaggageAllowance>
	</Offer>
	<ALaCarteOffer OfferID="O1" Owner="BA"> 
		<ALaCarteOfferItem OfferItemID="AOI1">
			<Eligibility>
				<SegmentRefs>FS1</SegmentRefs>
			</Eligibility>
			<UnitPriceDetail>
				<TotalAmount>
					<SimpleCurrencyPrice Code="GBP">70.00</SimpleCurrencyPrice>
				</TotalAmount>
			</UnitPriceDetail>
			<Service ServiceID="AOI1-SVC-1">
				<ServiceDefinitionRef>SRVC-BAGS-PRICE-1-FS1</ServiceDefinitionRef>
			</Service>
		</ALaCarteOfferItem>
	</ALaCarteOffer>
</OtherOffers>
Element Details optional
<OtherOffers>

This will contain the Offer for cabin upsell and AlaCarte offer for the lead in seat price.


This will contain the Offer for cabin upsell and AlaCarte offer for the lead in seat price, or prepaid excess bag price		 O
<Offer> This will return the cabin upsell offer, if applicable O
OfferID attr

A unique offer ID

Example: OF-d334406a-6b98-4bff-85db-c61174dd6b68		 M
Owner attr will always be 'BA' M

<OfferExpirationDateTime>

This is the time by which offer will remain in the system to be used by subsequent APIs calling ‘Order by reference’ method.

Example: 2018-08-07T07:47:14.643Z

O

< PriceGuaranteeTimeLimitDateTime>

This is the time by which BA guarantee the offered Price for the booking

Example: 2018-08-07T07:47:14.643Z

O
<TotalPrice> This returns the total price for the cabin upsell offer for all the requested passengers O
<SimpleCurrencyPrice> Total amount M
Code attr

Currency Code

Example: GBP		 O
<BagDisclosureRefs>

Baggage disclosures reference e.g.: CKBAG (for Checked Baggage) HANDBAG (for Hand baggage). Each reference will be delimited by a space

Example: HANDBAGOD1 CKBAGOD1

Both hand baggage and checked baggage details for the references are returned in  BagDisclosure  under  DataLists  

O
<OfferItem> This should be repeated for each passenger type M
OfferItemID attr

A unique offer item ID

Example: OF-d334406a-6b98-4bff-85db-c61174dd6b68-OI-1		 M
MandatoryInd attr

Indicates whether the OfferItem is mandatory or optional to create an Order

Possible values: true or false		 O
<TotalPriceDetail>   M
<TotalAmount> This return the total price of cabin upsell offer for all the passenger requested per passenger type M
<SimpleCurrencyPrice> Total Amount M
Code attr

Currency Code

Example: GBP

 O
<Service> This returns the service this OfferiIem is entitled to M
ServiceID attr

A unique Service ID

Example: F-d334406a-6b98-4bff-85db-c61174dd6b68-OI-1-SVC-1		 M
<PassengerRefs>

This return the passenger reference for all the passenger for who the service is applicable.

Each reference is delimited by a space.

Example: SH1 SH2

Each passenger reference should be detailed in  PassengerList  under  DataLists

 M
<FlightRefs>

This return the all the flight references which are part of this service.

Each reference is delimited by a space.

Example: Flight1 Flight2

Each Flight reference should be detailed in  FlightList  under  DataLists

 M
<FareDetail> This returns FareRules and price detail applicable to flights & passenger type respectively applicable to this OfferItem O
<Price> Price returned per passenger type with total price, fare & tax along with the breakdown M
<TotalAmount> The total amount per passenger type O
<SimpleCurrencyPrice> Total amount (Base fare + Tax) per passenger type for the cabin upsell offer M
Code attr Currency Code O
<BaseAmount> Base fare per passenger type for the itinerary M
Code attr Currency Code O
<Taxes> This returns taxes per passenger type for the cabin upsell offer O
<Total> Total tax per passenger type O
Code attr Currency Code O
<Breakdown> Return tax breakdown per passenger type O
<Tax>   M
<Amount Amount M
Code attr Currency code O
<TaxCode> Tax Code O
<AddlTaxType> Nature code for the tax element
Example: AD		 O
<CollectionPoint> Tax data break down by collection point for XF (Extra fee) and ZP (Federal tax segment) taxes O
<CurrCode>

Currency Code

Example: USD

 O
<AirportAmount>

Amount filed by the airport in the currency applicable to the geographical location of the airport

Example: 4.50		 M
<AirportCode>

Segment departure or arrival airport code

Example: JFK		 M
<Description> Tax description O
<FareComponent> Repeat FareComponent per Origin & Destination O
<FareRules> This returns FareRules for the flights O
<Penalty> This returns Penalties for the requested flights O
refs attr

This returns a reference to all the penalty rules that are applicable to the flights under OfferItem.

Each reference is delimited by a space.

Example: Rule1 Rule2

Each Penalty rule should be detailed in  PenaltyList  under  DataLists

 O
<PriceClassRef>

This returns a PriceClass reference for the flights applicable to the offerItem

Example: PCR_1

PriceClass reference should be detailed in  PriceClassList  under  DataLists

 O
<SegmentRefs>

This returns reference to all the segments applicable per PriceClassRef

Each reference is delimited by a space and should be detailed in FlightSegmentList under DataLists

 O
<BaggageAllowance> This returns the baggage allowance for the cabin upsell offer. This will repeat for each OriginDestination and once for HandBagAllowance for all the OriginDestinations O
<FlightRefs>

All the flight references from which the bag allowance is applicable.

Each reference is delimited by a space.

Example: Flight1 Flight2

Each Flight reference should be detailed in  FlightList  under  DataLists

 M
<PassengerRefs>

All the passenger references for which the bag allowance is applicable.

Each reference is delimited by a space.

Example: SH1 SH2

Each passenger reference should be detailed in  PassengerList  under  DataLists

 M
<BaggageAllowanceRef> Reference to the baggage allowance applicable to the offer. This reference is detailed in the  BaggageAllowanceList  under  DataLists M

<ALaCarteOffer>

This will return the offers for Seat lead in the price for all the flight segments in the requested Journey.

Note - There will be seat price lead in the price for cabin upsell offers


17.2 IMPROVEMENT - V0.4 PRIME SALE EXCESS BAG PURCHASE

This will return the offers for Seat lead in the price for all the flight segments or prepaid excess bag lead in the price for all the origin-destination in the requested Journey.

Note - There will be no seat or bag lead in the price for cabin upsell offers

O
OfferID attr

A unique OfferID

Example: O1

 M
Owner attr will always set to 'BA' M 
<ALaCarteOfferItem>

It will be repeated for each flight segment in the itinerary

For seat lead in the price - It will be repeated for each flight segment in the itinerary if seat purchase is applicable

For bag lead in the price - It will be repeated for each origin/destination in the itinerary if bag purchase is applicable

 M
OfferItemID attr

A unique OfferItemID

Example: AOI1

 M 
<Eligibility>
 This returns the segment reference M 
<SegmentRefs>
 Example: FS1 O 
<UnitPriceDetail>

This returns the seat or bag lead in price.

 M 
<TotalAmount>
 Total amount in a simple currency M 
<SimpleCurrencyPrice>
 Example: 15.00 M
Code attr

Currency code

Example: GBP

 O 
<Service>
   M
ServiceID attr

A unique service ID

Example: AOI1-SVC-1

 M 
<ServiceDefinitionRef>

This returns the service definition reference which should be defined in  ServiceDefinitionList  under  DataLists

This will identify whether the offer is for seat or bag.

 M
<DataLists>
Element Details optional
<PassengerList> List all the passengers with details as received in OfferPriceRQ O
<BagDisclosureList> List of bag disclosure for each baggage type O
<BaggageAllowanceList> List of baggage allowance for the requested itinerary and cabin upsell offers O
<DisclosureList> Marketing information (BA brand attributes) about each BA cabin is returned here O
<FareList> List of Farebasis code for requested itinerary and cabin upsell offer O
<FlightSegmentList> Flight segment details for the requested itinerary O
<FlightList> Flight List for the requested itinerary O
<OriginDestinationList> List of Origin-Destination for the requested itinerary O
<MediaList> This will contain the link to legal information. O
<PenaltyList> List of Penalty rules applicable to the flight segments in the requested itinerary O
<PriceClassList> List of Price class for the requested itinerary and cabin upsell offer O
<ServiceDefinitionList> Service definition list which has been offered. O
<MetaData>
Element Details optional
<PaymentCardMetadatas>

Returns a list of applicable payment cards along with the mandatory card information that should be provided when the payment card is used as a form of payment in OrderCreateRQ

Note: If PaymentOptions not returned, it means card payment is not applicable to the agent’s location (point of sale) and the customer’s billing country

 M
<AddressMetadatas>

Required Billing address information is returned here

 M
<CurrencyMetadatas>

This is the number of decimal points that are applicable to the currency code is returned

 M
<RuleMetadatas>

Returns changeability and refundability information for selected fare

 M

Working on it ...

Subscribe to Notifications

Get notified when this page gets updated, subscribe to our page notifications service.

email Address Invalid eMail address
Frequency

Subscribe to Notifications



Thank you. Please confirm your subscription by clicking the link in the email we have just sent.

If you have not received the confirmation email click here to Resend