List of offers: An offer will include flights and a total price
M
Carrier Offers grouping of offers
M
An offer will include flights and a total price
XML Example
<Offer>
<BaggageAssociations>
...
</BaggageAssociations>
<JourneyOverview>
...
</JourneyOverview>
<OfferID>9Gt0gR2qaGCQFN2xREFONK001|7f1c3626-6c1a-42cd-befe-a99b25d1a8ca</OfferID>
<OfferItem>
<FareDetail>
...
</FareDetail>
<OfferItemID>9Gt0gR2qaGCQFN2xREFONK001|7f1c3626-6c1a-42cd-befe-a99b25d1a8ca-1</OfferItemID>
<PaymentTimeLimit>
<PaymentTimeLimitDate>
<PaymentTimeLimitDateTime>2022-11-25T17:45:00Z</PaymentTimeLimitDateTime>
</PaymentTimeLimitDate>
</PaymentTimeLimit>
<Price>
<BaseAmount CurCode="GBP">258.00</BaseAmount>
<TaxSummary>
<TotalTaxAmount CurCode="GBP">411.34</TotalTaxAmount>
</TaxSummary>
<TotalAmount CurCode="GBP">669.34</TotalAmount>
</Price>
<Service>
<OfferServiceAssociation>
<PaxJourneyRef>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
</PaxJourneyRef>
</OfferServiceAssociation>
<PaxRefID>ADULT_1</PaxRefID>
<ServiceID>SV1</ServiceID>
</Service>
</OfferItem>
<OfferItem>
...
</OfferItem>
<OfferItem>
...
</OfferItem>
<OwnerCode>VS</OwnerCode>
<TotalPrice>
<TotalAmount CurCode="GBP">1761.02</TotalAmount>
</TotalPrice>
</Offer>
List [1.*]
O
Baggage Allowance associations.
XML Example
<BaggageAssociations>
<BaggageAllowanceRefID>CAB1</BaggageAllowanceRefID>
<OfferFlightAssociations>
<PaxJourneyRef>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
</PaxJourneyRef>
</OfferFlightAssociations>
<PaxRefID>ADULT_1</PaxRefID>
<PaxRefID>CHILD_1</PaxRefID>
<PaxRefID>YOUTH_1</PaxRefID>
</BaggageAssociations>
List [1..*]
O
A reference to the BaggageAllowanceList item that contains details of the baggage allowance associated with this offer - Baggage Allowance referenceID.
XML Example
<BaggageAssociations>
<BaggageAllowanceRefID>CAB1</BaggageAllowanceRefID>
<OfferFlightAssociations>
<PaxJourneyRef>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
</PaxJourneyRef>
</OfferFlightAssociations>
<PaxRefID>ADULT_1</PaxRefID>
<PaxRefID>CHILD_1</PaxRefID>
<PaxRefID>YOUTH_1</PaxRefID>
</BaggageAssociations>
Alphanumeric
M
OfferFlightAssociation details
XML Example
<BaggageAssociations>
<BaggageAllowanceRefID>CAB1</BaggageAllowanceRefID>
<OfferFlightAssociations>
<PaxJourneyRef>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
</PaxJourneyRef>
</OfferFlightAssociations>
<PaxRefID>ADULT_1</PaxRefID>
<PaxRefID>CHILD_1</PaxRefID>
<PaxRefID>YOUTH_1</PaxRefID>
</BaggageAssociations>
List [1..*]
O
A reference to the passenger journey(s) to which the Baggage Allowance is associated.
XML Example
<PaxJourneyRef>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
</PaxJourneyRef>
M
PaxJourney referenceID
XML Example
<PaxJourneyRef>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
</PaxJourneyRef>
Alphanumeric
M
A reference to the Passenger(s) to which the Baggage Allowance is associated.
XML Example
<BaggageAssociations>
<BaggageAllowanceRefID>CAB1</BaggageAllowanceRefID>
<OfferFlightAssociations>
...
</OfferFlightAssociations>
<PaxRefID>ADULT_1</PaxRefID>
<PaxRefID>CHILD_1</PaxRefID>
<PaxRefID>YOUTH_1</PaxRefID>
</BaggageAssociations>
Alphanumeric
M
PriceClass reference(s) for the requested itinerary.
XML Example
<JourneyOverview>
<JourneyPriceClass>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</JourneyPriceClass>
<JourneyPriceClass>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</JourneyPriceClass>
</JourneyOverview>
M
PriceClass reference per PaxJourney/Bound.
XML Example
<JourneyPriceClass>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</JourneyPriceClass>
List [1..*]
M
PaxJourney referenceID
XML Example
<JourneyPriceClass>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</JourneyPriceClass>
Alphanumeric
M
PriceClass referenceID
XML Example
<JourneyPriceClass>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</JourneyPriceClass>
Alphanumeric
M
<OfferExpirationTimeLimitDateTime>
Offer expiration date and time that is applicable for this offer represented in GMT/UTC
DateTime
O
Pass to OfferPrice
Uniquely generated OfferID identifier.
Alphanumeric
M
Pass to OfferPrice
List of offer items: An offer can contain 1 or * offeritem (based on PTC price differences).
List [1..*]
O
Service Taxonomy code that designates the specification that is associated with the requested Fare Product.
Alphanumeric
O
Specific offered service instance
XML Example
<FareDetail>
<FareComponent>
<CancelRestrictions>
<AllowedModificationInd>false</AllowedModificationInd>
<DescText>ANY TIME CANCELLATIONS NOT PERMITTED - LHRJNB</DescText>
</CancelRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>After Departure</JourneyStageCode>
</ChangeRestrictions>
<FareBasisCode>OL10CCLB</FareBasisCode>
<PaxSegmentRefID>SEG1</PaxSegmentRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</FareComponent>
<FareComponent>
<CancelRestrictions>
<AllowedModificationInd>false</AllowedModificationInd>
<DescText>ANY TIME CANCELLATIONS NOT PERMITTED - JNBLHR</DescText>
</CancelRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>JNBLHR</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>JNBLHR</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>After Departure</JourneyStageCode>
</ChangeRestrictions>
<FareBasisCode>OL10CCLB</FareBasisCode>
<PaxSegmentRefID>SEG2</PaxSegmentRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</FareComponent>
<PaxRefID>ADULT_1</PaxRefID>
</FareDetail>
List [1..*]
O
Fare Component information
XML Example
<FareComponent>
<CancelRestrictions>
<AllowedModificationInd>false</AllowedModificationInd>
<DescText>ANY TIME CANCELLATIONS NOT PERMITTED - LHRJNB</DescText>
</CancelRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>After Departure</JourneyStageCode>
</ChangeRestrictions>
<FareBasisCode>OL10CCLB</FareBasisCode>
<PaxSegmentRefID>SEG1</PaxSegmentRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</FareComponent>
List [1..*]
O
Set of restrictions that are related to a contrained priced group of services for the cancellation action.
XML Example
<CancelRestrictions>
<AllowedModificationInd>false</AllowedModificationInd>
<DescText>ANY TIME CANCELLATIONS NOT PERMITTED - LHRJNB</DescText>
</CancelRestrictions>
List [1..*]
O
Flags if changes are allowed, used in conjunction with defined date ranges.
XML Example
<CancelRestrictions>
<AllowedModificationInd>false</AllowedModificationInd>
<DescText>ANY TIME CANCELLATIONS NOT PERMITTED - LHRJNB</DescText>
</CancelRestrictions>
Note:
TRUE - Cancellation is allowed
FALSE - Cancellation not allowed
Boolean
O
Description of changes
XML Example
<CancelRestrictions>
<AllowedModificationInd>false</AllowedModificationInd>
<DescText>ANY TIME CANCELLATIONS NOT PERMITTED - LHRJNB</DescText>
</CancelRestrictions>
String
O
Fee for the allowed changes.
O
ISO 3 Char currency code. Example: GBP, USD
Char(3)
M
The allowed cancellation as part of the journey. It can be:
Note:
1. Before Departure
2. After Departure
ENUM
O
A set of restrictions that are related to a constrained priced grouping of services for change/modification.
XML Example
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
List [1..*]
O
Flags if changes are allowed, used in conjunction with defined date ranges.
XML Example
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
Note:
TRUE - Cancellation is allowed
FALSE - Cancellation not allowed
Boolean
O
Description of changes
XML Example
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
String
O
Fee for the allowed changes.
XML Example
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
O
Fee amount.
XML Example
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
Decimal
M
ISO 3 Char currency code. Example: GBP, USD
XML Example
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
Char(3)
M
The allowed cancellation as part of the journey. It can be:
XML Example
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
Note:
1. Before Departure
2. After Departure
ENUM
O
Fare Basis Code
XML Example
<OfferItem>
<FareBasisCode>OL10CCLB</FareBasisCode>
...
</OfferItem>
Alphanumeric
O
IATA defined Fare Amount Type Code
Note:
70J – Published fare
String
O
List of PaxSegment referenceID(s)
List [1..*]
O
PriceClass referenceID
Alphanumeric
O
Passenger ReferenceID
Alphanumeric
O
If set to 'TRUE' this indicates mandatory Offer Items which cannot be removed from the Offer.
Boolean
O
Unique identifier of an OfferItemID
Alphanumeric
M
Indicates the duration of time after order creation that payment commitment is required for an order item. After this time, an unpaid order will be cancelled by the airline.
O
Payment time limit date.
M
<PaymentTimeLimitDateTime>
A date/time by which payment commitment is required for a given Order Item represented in GMT/UTC.
DateTime
O
OfferItem price details per Pax PTC price.
M
Base price of the OfferItem (excludes taxes)
Decimal
O
ISO 3 Char currency code. Example: GBP, USD.
Char(3)
O
Tax summary information.
List [1..*]
O
Total tax of the OfferItem.
Decimal
ISO 3 Char currency code. Example: GBP, USD
Char(3)
Total price of the OfferItem (includes taxes).
Decimal
O
ISO 3 Char currency code. Example: GBP, USD
Char(3)
O
Specific offered service instance.
List [1..*]
M
<OfferServiceAssociation>
Service association details.
M
List of PaxJourney referenceID(s)
List [1..*]
M
List of Pax referencesID(s)
List [1..*]
M
Unique service identifer.
Alphanumeric
M
IATA carrier code of the airline that owns the offer
Note:
Current implementation always returns "VS"
Char(2)
M
Total offer price details. This is the OfferItem total.
O
Total price of the OfferItem(s).
Decimal
O
ISO 3 Char currency code. Example: GBP, USD
Char(3)
M
Calendar based Flight Price.
List[1..*]
O
A Price Calendar Date
List[1..*]
M
Date on which the journey departs.
DateTime
M
Association to one Origin/Destination.
String
O
List of Pax referenceID(s)
List [1..*] String
O
Total price of the Offer (includes taxes)
Decimal
O
ISO 3 Char currency code (Eg: GBP,USD)
Char(3)
M
<Response>
<DataLists>
...
</DataLists>
<OffersGroup>
<CarrierOffers>
<Offer>
<BaggageAssociations>
<BaggageAllowanceRefID>CAB1</BaggageAllowanceRefID>
<OfferFlightAssociations>
<PaxJourneyRef>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
</PaxJourneyRef>
</OfferFlightAssociations>
<PaxRefID>ADULT_1</PaxRefID>
<PaxRefID>CHILD_1</PaxRefID>
<PaxRefID>YOUTH_1</PaxRefID>
</BaggageAssociations>
<JourneyOverview>
<JourneyPriceClass>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</JourneyPriceClass>
<JourneyPriceClass>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</JourneyPriceClass>
</JourneyOverview>
<OfferID>9Gt0gR2qaGCQFN2xREFONK001|7f1c3626-6c1a-42cd-befe-a99b25d1a8ca</OfferID>
<OfferItem>
<FareDetail>
<FareComponent>
<CancelRestrictions>
<AllowedModificationInd>false</AllowedModificationInd>
<DescText>ANY TIME CANCELLATIONS NOT PERMITTED - LHRJNB</DescText>
</CancelRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>LHRJNB</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>After Departure</JourneyStageCode>
</ChangeRestrictions>
<FareBasisCode>OL10CCLB</FareBasisCode>
<PaxSegmentRefID>SEG1</PaxSegmentRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</FareComponent>
<FareComponent>
<CancelRestrictions>
<AllowedModificationInd>false</AllowedModificationInd>
<DescText>ANY TIME CANCELLATIONS NOT PERMITTED - JNBLHR</DescText>
</CancelRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>JNBLHR</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>Prior To Departure</JourneyStageCode>
</ChangeRestrictions>
<ChangeRestrictions>
<AllowedModificationInd>true</AllowedModificationInd>
<DescText>JNBLHR</DescText>
<Fee>
<Amount CurCode="GBP">150.00</Amount>
</Fee>
<JourneyStageCode>After Departure</JourneyStageCode>
</ChangeRestrictions>
<FareBasisCode>OL10CCLB</FareBasisCode>
<PaxSegmentRefID>SEG2</PaxSegmentRefID>
<PriceClassRefID>PC1</PriceClassRefID>
</FareComponent>
<PaxRefID>ADULT_1</PaxRefID>
</FareDetail>
<OfferItemID>9Gt0gR2qaGCQFN2xREFONK001|7f1c3626-6c1a-42cd-befe-a99b25d1a8ca-1</OfferItemID>
<PaymentTimeLimit>
<PaymentTimeLimitDate>
<PaymentTimeLimitDateTime>2022-11-25T17:45:00Z</PaymentTimeLimitDateTime>
</PaymentTimeLimitDate>
</PaymentTimeLimit>
<Price>
<BaseAmount CurCode="GBP">258.00</BaseAmount>
<TaxSummary>
<TotalTaxAmount CurCode="GBP">411.34</TotalTaxAmount>
</TaxSummary>
<TotalAmount CurCode="GBP">669.34</TotalAmount>
</Price>
<Service>
<OfferServiceAssociation>
<PaxJourneyRef>
<PaxJourneyRefID>JOUR1</PaxJourneyRefID>
<PaxJourneyRefID>JOUR2</PaxJourneyRefID>
</PaxJourneyRef>
</OfferServiceAssociation>
<PaxRefID>ADULT_1</PaxRefID>
<ServiceID>SV1</ServiceID>
</Service>
</OfferItem>
<OfferItem>
...
</OfferItem>
<OfferItem>
...
</OfferItem>
<OwnerCode>VS</OwnerCode>
<TotalPrice>
<TotalAmount CurCode="GBP">1761.02</TotalAmount>
</TotalPrice>
</Offer>
<Offer>
...
</Offer>
<Offer>
...
<Offer>
...
</Offer>
<Offer>
...
</Offer>
</CarrierOffers>
</OffersGroup>
</Response>