Examples of messages with complete flows can be downloaded from here.

Insert excerpt

	API Messages with Examples
	API Messages with Examples
name	Legend
nopanel	true

Common Sections

Expand

title	Common SectionsHTTP Header

HTTP Header

Insert excerpt

	HTTP Header
	HTTP Header
name	HTTP Header
nopanel	true

Expand

title	Language, Version and Name Space

Language, Version and Name Space

Insert excerpt

	Language, Version and Name Space
	Language, Version and Name Space
name	Version_Lang_NameSpace
nopanel	true

Expand

title	Point of Sale

Point of Sale

Insert excerpt

	Point of Sale and Document
	Point of Sale and Document
name	PointOfSale
nopanel	true

Expand

title	Document

Document

Insert excerpt

	Point of Sale and Document
	Point of Sale and Document
name	Document
nopanel	true

Expand

title	Party

Party

Insert excerpt

	Party Elements
	Party Elements
name	SenderSection
nopanel	true

Insert excerpt

	Party Elements
	Party Elements
name	ParticipantSection
nopanel	true

Insert excerpt

	Party Elements
	Party Elements
name	RecipientSection
nopanel	true

In addition to the Common Sections, this service is called with the following data:

Query

Expand

title	Query - OrderCreate

Insert excerpt

	Query (- OrderCreate)
	Query (- OrderCreate)
name	Query_OrderCreate
nopanel	true

DataLists

...

Expand
title DataLists - PassengerList
PassengerList
Insert excerpt
PassengerList
PassengerList
name PassengerList
nopanel true
...
Expand
title ContactListDataLists -
ContactList
Insert excerpt
ContactList
ContactList
name ContactList
nopanel true

DataLists / FlightSegmentList

Expand

title	InstructionsList

DataLists - FlightSegmentList

InstructionList

Insert excerpt

FlightSegmentList

InstructionsList

FlightSegmentList

InstructionsList
name

FlightSegment

InstructionsList
nopanel true

DataLists / InstructionsList

Expand

title

DataLists - InstructionsListexcerpt-include

InstructionsListInstructionsListnameInstructionsListnopaneltrue

...

ServiceDefinitionList

...

expand

DataLists -

	title

ServiceDefinitionList

Insert excerpt
ServiceDefinitionList
ServiceDefinitionList
name ServiceDefinitionList
nopanel true

Metadata

...

Expand
title
Metadata -
Forms of Payment
Insert excerpt
Forms of Payment Metadata
Forms of Payment Metadata
name PaymentFormMetadata
nopanel true

Example OrderCreateRQ:

Expand

title	XML SampleOrderCreateRQ example

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <OrderCreateRQ Version="5.000" xmlns="http://www.iata.org/IATA/EDIST/2017.2">
         <PointOfSale>
            <Location>
               <CountryCode>ES</CountryCode>
            </Location>
         </PointOfSale>
         <Document>
            <ReferenceVersion>5.000</ReferenceVersion>
         </Document>
         <Party>
            <Sender>
               <TravelAgencySender>
                  <Name>AgencyName</Name>
                  <Contacts>
                     <Contact>
                        <EmailContact>
                           <Address>ibprueb2@gmail.com</Address>
                        </EmailContact>
                        <PhoneContact>
                           <Application>BUSINESS</Application>
                           <Number>+34666554433</Number>
                        </PhoneContact>
                        <Name>
                           <Surname>Martínez</Surname>
                           <Given>Pepe</Given>
                        </Name>
                     </Contact>
                  </Contacts>
                  <IATA_Number>78298065<Number>12345678</IATA_Number>
                  <AgencyID>INTEROPA<AgencyID>TRAVEL VIAJES<AGENCY</AgencyID>
               </TravelAgencySender>
            </Sender>
         </Party>
         <Query>
            <Order>
               <Offer OfferID="IB700fb61f0530487abb23d62f37d536c6OC" Owner="IB" ResponseID="Qm9va2luZ0AxNjI3NDYxNzk2ODY4LUdjUmtu">
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_01">
                     <PassengerRefs>ADULT_01 ADULT_02 ADULT_03 ADULT_04</PassengerRefs>
                  </OfferItem>
               </Offer>
               <!--Introducción de los servicios especiales-->
               <Offer OfferID="ALACARTE_SSR_IB7e5c68abeb5e482c839c6efbdf4472ac" Owner="IB" ResponseID="Qm9va2luZ0AxNjI3NDYxNzk2ODY4LUdjUmtu">
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_DEAF">
                     <PassengerRefs>ADULT_01</PassengerRefs>
                     <ServiceSelection ServiceID="SSR_SN_c9db38dc-ada9-4955-b9db-7a16875ed74f">
                        <ServiceDefinitionID>SPECIAL_NEED-DEAF</ServiceDefinitionID>
                     </ServiceSelection>
                  </OfferItem>
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_SVAN">
                     <PassengerRefs>ADULT_01</PassengerRefs>
                     <ServiceSelection ServiceID="SSR_SN_5e6fb112-7c1d-4242-92a4-b7b48408cacf">
                        <ServiceDefinitionID>SPECIAL_NEED-SVAN</ServiceDefinitionID>
                     </ServiceSelection>
                  </OfferItem>
               </Offer>
            </Order>
            <Payments>
               <Payment>
                  <Type>MS</Type>
                  <Method>
                     <Voucher>
                        <Number>BONO100EUR</Number>
                     </Voucher>
                  </Method>
                  <Amount Code="EUR">1243.56</Amount>
                  <Payer>
                     <ContactInfoRefs>Payer</ContactInfoRefs>
                  </Payer>
               </Payment>
               <Payment>
                  <Type>CA</Type>
                  <Method>
                     <Cash CashInd="true"/>
                  </Method>
                  <Amount Code="EUR">0</Amount>
                  <Payer>
                     <ContactInfoRefs>Payer</ContactInfoRefs>
                  </Payer>
               </Payment>
            </Payments>
            <DataLists>
               <PassengerList>
                  <Passenger PassengerID="ADULT_01">
                     <PTC>ADT</PTC>
                     <Birthdate>1993-12-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_01">
                        <Gender>Male</Gender>
                        <NameTitle>MR</NameTitle>
                        <GivenName>ADULTO</GivenName>
                        <Surname>UNO PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>12345678Z</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_02">
                     <PTC>ADT</PTC>
                     <Birthdate>1987-08-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_02">
                        <Gender>Female</Gender>
                        <NameTitle>MRS</NameTitle>
                        <GivenName>ADULTA</GivenName>
                        <Surname>UNA PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>75481546P</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_03">
                     <PTC>ADT</PTC>
                     <Birthdate>1993-12-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_03">
                        <Gender>Male</Gender>
                        <NameTitle>MR</NameTitle>
                        <GivenName>ADULTO</GivenName>
                        <Surname>TRES PRUEBA</Surname>
                     </Individual>                     
                     <FOID>
                        <FOID_Number>25369424X</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_04">
                     <PTC>ADT</PTC>
                     <Birthdate>1987-08-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_04">
                        <Gender>Female</Gender>
                        <NameTitle>MRS</NameTitle>
                        <GivenName>ADULTA</GivenName>
                        <Surname>CUATRO PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>74582559E</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
               </PassengerList>
               <ContactList>
                  <ContactInformation ContactID="Payer">
                     <ContactType>Payer</ContactType>
                     <ContactProvided>
                        <EmailAddress>
                           <EmailAddressValue>pasajeroib@bylup.com</EmailAddressValue>
                        </EmailAddress>
                     </ContactProvided>
                     <IndividualRef>IND_ADULT_01</IndividualRef>
                  </ContactInformation>
                  <ContactInformation ContactID="REFUSE_CONTACT">
                     <ContactNotProvided/>
                  </ContactInformation>
               </ContactList>
               <ServiceDefinitionList>
                  <ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-DEAF">
                     <Name>Deaf Passenger</Name>
                     <Descriptions>
                        <Description refs="ADULT_01">
                           <Text>Request Service Animal if travelling with one*/?()</Text>
                        </Description>
                     </Descriptions>
                     <BookingInstructions>
                        <SSRCode>DEAF</SSRCode>
                     </BookingInstructions>
                  </ServiceDefinition>
                  <ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-SVAN">
                     <Name>Service Animal</Name>
                     <Descriptions>
                        <Description refs="ADULT_01">
                           <Text>Service Animal travelling in the cabin with Blind, Deaf, Disabled passengers or Certified Instructors. Specify breed and weight of animal</Text>
                        </Description>
                     </Descriptions>
                     <BookingInstructions>
                        <SSRCode>SVAN</SSRCode>
                     </BookingInstructions>
                  </ServiceDefinition>
               </ServiceDefinitionList>
            </DataLists>
         </Query>
      </OrderCreateRQ>
   </soapenv:Body>
</soapenv:Envelope>

Error messages

For further information about all kind of error messages, please go to the following link:

...

Examples OrderCreateRQ 2024:

Expand

title	OrderCreateRQ OpenJaw UC01 example 2024

Code Block

language	xml

<Order>
	<Offer OfferID="IBd9f8773737e74c85b1172bf9168214b1OC" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzEzOTU5MTczMTYyLWg4T041">
		<OfferItem OfferItemID="IBd9f8773737e74c85b1172bf9168214b1OC_01">
			<PassengerRefs>ADULT_01</PassengerRefs>
		</OfferItem>
	</Offer>
</Order>

Expand

title	OrderCreateRQ Baggage Presale on hold UC01 example 2024

Code Block

language	xml

<Query>
	<Order>
		<Offer OfferID="IBd9f8773737e74c85b1172bf9168214b1OC" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzEzOTU5MTczMTYyLWg4T041">
			<OfferItem OfferItemID="IBd9f8773737e74c85b1172bf9168214b1OC_01">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
		</Offer>
		<Offer OfferID="ALACARTE_IB813408348916401a8d0809d10456d25f" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzEzOTU5MTczMTYyLWg4T041">
			<OfferItem OfferItemID="ALACARTE_BAGGAGE_IB813408348916401a8d0809d10456d25f_01">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
			<OfferItem OfferItemID="ALACARTE_BAGGAGE_IB813408348916401a8d0809d10456d25f_10">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
		</Offer>
	</Order>
</Query>

Expand

title	OrderCreateRQ Seat Presale on hold UC01 example 2024

Code Block

language	xml

<Query>
	<Order>
		<Offer OfferID="ALACARTE_SEAT_IBe4978f5ea4944de182c3953b3e7eaeef" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzEzOTU5MTczMTYyLWg4T041">
			<OfferItem OfferItemID="ALACARTE_SEAT_IBe4978f5ea4944de182c3953b3e7eaeef_02">
				<PassengerRefs>ADULT_01</PassengerRefs>
				<ALaCarteSelection>
					<Quantity>1</Quantity>
					<SegmentID>IB310220240819</SegmentID>
				</ALaCarteSelection>
				<SeatSelection>
					<Row>8</Row>
					<Column>A</Column>
				</SeatSelection>
			</OfferItem>
			<OfferItem OfferItemID="ALACARTE_SEAT_IBe4978f5ea4944de182c3953b3e7eaeef_06">
				<PassengerRefs>ADULT_01</PassengerRefs>
				<ALaCarteSelection>
					<Quantity>1</Quantity>
					<SegmentID>IB866520240901</SegmentID>
				</ALaCarteSelection>
				<SeatSelection>
					<Row>7</Row>
					<Column>D</Column>
				</SeatSelection>
			</OfferItem>
		</Offer>
	</Order>
</Query>

Expand

title	OrderCreateRQ Cash UC02 example 2024

Code Block

language	xml

<Query>
  <Payments>
	<Payment>
		<Type>CA</Type>
		<Amount Code="EUR">2095.74</Amount>
	</Payment>
  </Payments>
</Query>

Expand

title	OrderCreateRQ Technical Stop UC02 example 2024

Code Block

language	xml

<Query>
	<Order>
		<Offer OfferID="IB95a0ff8f7dd846a7af4227367d18c52cOP" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzEyMjQ1NjA1NzEzLU1teE1Y">
			<OfferItem OfferItemID="IB95a0ff8f7dd846a7af4227367d18c52cOP_01">
				<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
			</OfferItem>
		</Offer>
	</Order>
</Query>

Expand

title	OrderCreateRQ Paid Seats UC02 example 2024

Code Block

language	xml

<Query>
	<Order>
		<Offer OfferID="ALACARTE_SEAT_IB6e2195bdc2b34a638f3f551f70f07ece" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzEyMjQ1NjA1NzEzLU1teE1Y">
			<OfferItem OfferItemID="ALACARTE_SEAT_IB6e2195bdc2b34a638f3f551f70f07ece_13">
				<PassengerRefs>ADULT_01</PassengerRefs>
				<ALaCarteSelection>
					<Quantity>1</Quantity>
					<SegmentID>IB634220240718</SegmentID>
				</ALaCarteSelection>
				<SeatSelection>
					<Row>27</Row>
					<Column>H</Column>
				</SeatSelection>
			</OfferItem>
			<OfferItem OfferItemID="ALACARTE_SEAT_IB6e2195bdc2b34a638f3f551f70f07ece_08">
				<PassengerRefs>ADULT_02</PassengerRefs>
				<ALaCarteSelection>
					<Quantity>1</Quantity>
					<SegmentID>IB634120240703</SegmentID>
				</ALaCarteSelection>
				<SeatSelection>
					<Row> 48</Row>
					<Column>G</Column>
				</SeatSelection>
			</OfferItem>
		</Offer>
	</Order>
</Query>

Expand

title	OrderCreateRQ Private Fare Sport UC03 example 2024

Code Block

language	xml

<Order>
	<Offer OfferID="IBeb2c12f6baf64095ba2e3add170c0a22OC" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzI2ODMwODk3MTMwLXVHdHFq">
		<OfferItem OfferItemID="IBeb2c12f6baf64095ba2e3add170c0a22OC_01">
			<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
		</OfferItem>
	</Offer>
</Order>

Expand

title	OrderCreateRQ Credit Card UC03 example 2024

Code Block

language	xml

<Payments>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard>
				<CardType>VI</CardType>
				<SeriesCode>XXX</SeriesCode>
				<CardHolderName>JANE SMITH</CardHolderName>
				<CardHolderBillingAddress>
					<Street>125 PRESTON RD BRIGH</Street>
					<CityName>MA</CityName>
					<StateProv>BN</StateProv>
					<PostalCode>BN12LP</PostalCode>
					<CountryCode>ES</CountryCode>
				</CardHolderBillingAddress>
				<CardNumber>40XXXXXXXXXXXX99</CardNumber>
				<EffectiveExpireDate>
					<Expiration>MMYY</Expiration>
				</EffectiveExpireDate>
			</PaymentCard>
		</Method>
		<Amount Code="EUR">250.14</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>

Expand

title	OrderCreateRQ Frequent Flyer Passenger 1 UC03 example 2024

Code Block

language	xml

<PassengerList>
	<Passenger PassengerID="ADULT_01">
		<PTC>ADT</PTC>
		<Birthdate>1975-08-03</Birthdate>
		<Individual IndividualID="IND_ADULT_01">
			<Gender>Male</Gender>
			<NameTitle>MR</NameTitle>
			<GivenName>FERNANDO</GivenName>
			<Surname>FERNANDEZ MARTINEZ</Surname>
		</Individual>
		<LoyaltyProgramAccount>
			<Airline>
				<AirlineDesignator>IB</AirlineDesignator>
			</Airline>
			<AccountNumber>28033504</AccountNumber>
		</LoyaltyProgramAccount>
		<FOID>
			<FOID_Number>XXXXXXXXR</FOID_Number>
			<FOID_Type>NI</FOID_Type>
		</FOID>
		<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
	</Passenger>
	<!-- SECOND PASSENGER WITHOUT FREQUENT FLYER -->
	<Passenger PassengerID="ADULT_02">
		<PTC>ADT</PTC>
		<Birthdate>1955-04-01</Birthdate>
		<Individual IndividualID="IND_ADULT_02">
			<Gender>Female</Gender>
			<NameTitle>MRS</NameTitle>
			<GivenName>BAMBI</GivenName>
			<Surname>DISNEY RESERVAS</Surname>
		</Individual>
		<FOID>
			<FOID_Number>XXXXXXXXV</FOID_Number>
			<FOID_Type>NI</FOID_Type>
		</FOID>
		<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
	</Passenger>
</PassengerList>

Expand

title	OrderCreateRQ Sport Equipment Golf UC03 example 2024

Code Block

language	xml

<InstructionsList>
	<Instruction ListKey="Instruction_01">
		<FreeFormTextInstruction refs="ADULT_01 IB060320250214">
			<Remark>BAGGAGE/SP/0D4</Remark>
		</FreeFormTextInstruction>
	</Instruction>
</InstructionsList>

Expand

title	OrderCreateRQ Public Fare UC04 example 2024

Code Block

language	xml

<Offer OfferID="IB7f6dc0a005474129b12c57947e7d0144OC" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzI1MzU5MTA5Njk1LUxjTnhK">
	<OfferItem OfferItemID="IB7f6dc0a005474129b12c57947e7d0144OC_01">
		<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
	</OfferItem>
</Offer>

Expand

title	OrderCreateRQ Installments UC04 example 2024

Code Block

language	xml

<Payments>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard refs="KEY_QUOTAS">
				<CardType>VI</CardType>
				<SeriesCode>XXX</SeriesCode>
				<CardHolderName>JANE SMITH</CardHolderName>
				<CardHolderBillingAddress>
					<Street>125 PRESTON RD BRIGH</Street>
					<CityName>MA</CityName>
					<StateProv>BN</StateProv>
					<PostalCode>BN12LP</PostalCode>
					<CountryCode>PE</CountryCode>
				</CardHolderBillingAddress>
				<CardNumber>44XXXXXXXXXXXX04</CardNumber>
				<EffectiveExpireDate>
					<Expiration>MMYY</Expiration>
				</EffectiveExpireDate>
			</PaymentCard>
		</Method>
		<Amount Code="USD">119.80</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>
<Metadata>
	<Other>
		<OtherMetadata>
			<PaymentFormMetadatas>
				<PaymentFormMetadata MetadataKey="KEY_QUOTAS">
					<Text>installments/5</Text>
				</PaymentFormMetadata>
			</PaymentFormMetadatas>
		</OtherMetadata>
	</Other>
</Metadata>

Expand

title	OrderCreateRQ Priority Boarding UC04 example 2024

Code Block

language	xml

<Offer OfferID="ALACARTE_IB3258b435f071474a92cf4b0365004e6f" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzI1MzU5MTA5Njk1LUxjTnhK">
	<OfferItem OfferItemID="ALACARTE_PRIORITY_IB3258b435f071474a92cf4b0365004e6f_01">
		<PassengerRefs>ADULT_01</PassengerRefs>
	</OfferItem>
	<OfferItem OfferItemID="ALACARTE_PRIORITY_IB3258b435f071474a92cf4b0365004e6f_01">
		<PassengerRefs>ADULT_02</PassengerRefs>
	</OfferItem>
</Offer>

Expand

title	OrderCreateRQ Fiscal ID UC04 example 2024

Code Block

language	xml

<PassengerList>
	<Passenger PassengerID="ADULT_01">
		<PTC>ADT</PTC>
		<Birthdate>1970-02-28</Birthdate>
		<Individual IndividualID="IND_ADULT_01">
			<Gender>Male</Gender>
			<NameTitle>MR</NameTitle>
			<GivenName>JANE</GivenName>
			<Surname>SMITH</Surname>
		</Individual>
		<FOID>
			<FOID_Number>XXXXXXXXL</FOID_Number>
			<FOID_Type>NI</FOID_Type>
		</FOID>
		<IdentityDocument>
			<IdentityDocumentNumber>RUC/XXXXXXXXL/CompanyName</IdentityDocumentNumber>
			<IdentityDocumentType>F</IdentityDocumentType>
		</IdentityDocument>
		<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
	</Passenger>
	<Passenger PassengerID="ADULT_02">
		<PTC>ADT</PTC>
		<Birthdate>1955-04-01</Birthdate>
		<Individual IndividualID="IND_ADULT_02">
			<Gender>Female</Gender>
			<NameTitle>MRS</NameTitle>
			<GivenName>BAMBI</GivenName>
			<Surname>DISNEY RESERVAS</Surname>
		</Individual>
		<FOID>
			<FOID_Number>XXXXXXXXV</FOID_Number>
			<FOID_Type>NI</FOID_Type>
		</FOID>
		<IdentityDocument>
			<IdentityDocumentNumber>RUC/XXXXXXXXV/CompanyName</IdentityDocumentNumber>
			<IdentityDocumentType>F</IdentityDocumentType>
		</IdentityDocument>
		<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
	</Passenger>
</PassengerList>

Expand

title	OrderCreateRQ Cheapest Type Y UC05 example 2024

Code Block

language	xml

<Offer OfferID="IB9d0d403df3c84fefa794d6d938579590OC" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzEzNDU2MjMxMjE2LThNNmdD">
	<OfferItem OfferItemID="IB9d0d403df3c84fefa794d6d938579590OC_01">
		<PassengerRefs>ADULT_01</PassengerRefs>
	</OfferItem>
</Offer>

Expand

title	OrderCreateRQ Resident UC05 example 2024

Code Block

language	xml

<Passenger PassengerID="ADULT_01">
	<PTC>ADT</PTC>
	<Birthdate>1961-04-22</Birthdate>
	<Individual IndividualID="IND_ADULT_01">
		<Gender>Male</Gender>
		<NameTitle>MR</NameTitle>
		<GivenName>JANE</GivenName>
		<Surname>SMITH</Surname>
	</Individual>
	<FOID>
		<FOID_Number>000000000R</FOID_Number>
		<FOID_Type>NI</FOID_Type>
	</FOID>
	<IdentityDocument>
		<IdentityDocumentNumber>12313123111</IdentityDocumentNumber>
		<IdentityDocumentType>F1</IdentityDocumentType>
	</IdentityDocument>
	<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
	<Remark>
		<Remark>RESIDENT-380201</Remark>
	</Remark>
</Passenger>

Expand

title	OrderCreateRQ Service Fee UC05 example 2024

Code Block

language	xml

<Payment>
  <Type>SF</Type>
  <Method>
      <Other>
        <Remarks refs="ADULT_01">
            <Remark>ServiceFee</Remark>
        </Remarks>
      </Other>
  </Method>
  <Amount Code="EUR">10</Amount>
</Payment>

Expand

title	OrderCreateRQ Credit Card 3DS UC05 example 2024

Code Block

language	xml

<Payment>
	<Type>CC</Type>
	<Method>
		<PaymentCard refs="KEY_3DS">
			<CardType>VI</CardType>
			<SeriesCode>XXX</SeriesCode>
			<CardHolderName>JANE SMITH</CardHolderName>
			<CardHolderBillingAddress>
				<Street>125 PRESTON RD BRIGH</Street>
				<CityName>MA</CityName>
				<StateProv>BN</StateProv>
				<PostalCode>BN12LP</PostalCode>
				<CountryCode>ES</CountryCode>
			</CardHolderBillingAddress>
			<CardNumber>454XXXXXXXXXX774</CardNumber>
			<EffectiveExpireDate>
				<Expiration>MMYY</Expiration>
			</EffectiveExpireDate>
		</PaymentCard>
	</Method>
	<Amount Code="EUR">131.80</Amount>
	<Payer>
		<ContactInfoRefs>Payer</ContactInfoRefs>
	</Payer>
</Payment>

Expand

title	OrderCreateRQ Paid Baggage UC05 example 2024

Code Block

language	xml

<Offer OfferID="ALACARTE_IBdeb27cfd8a4248b59915909ba56d4b11" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzEzNDU2MjMxMjE2LThNNmdD">
	<OfferItem OfferItemID="ALACARTE_BAGGAGE_IBdeb27cfd8a4248b59915909ba56d4b11_09">
		<PassengerRefs>ADULT_01</PassengerRefs>
	</OfferItem>
	<OfferItem OfferItemID="ALACARTE_BAGGAGE_IBdeb27cfd8a4248b59915909ba56d4b11_01">
		<PassengerRefs>ADULT_01</PassengerRefs>
	</OfferItem>
</Offer>

Expand

title	OrderCreateRQ Public & Corporate Fare Combination UC06 example 2024

Code Block

language	xml

<Sender>
	<CorporateSender>
		<ID>IXXXXXXS</ID>
	</CorporateSender>
</Sender>

Expand

title	OrderCreateRQ Special Need UC06 example 2024

Code Block

language	xml

<Offer OfferID="ALACARTE_SSR_IB04f82e00be414c0497a03cc187ce7fd4" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzE3NDkwMTg5NDcwLUdqRFF1">
	<OfferItem OfferItemID="IB172608836eca4768900811bef7635f76OC_WCHR">
		<PassengerRefs>ADULT_01</PassengerRefs>
		<ServiceSelection ServiceID="SSR_SN_7f3eb62e-6824-4d74-93eb-6b5641fb7f8a">
			<ServiceDefinitionID>SPECIAL_NEED-WCHR</ServiceDefinitionID>
		</ServiceSelection>
	</OfferItem>
</Offer>
<ServiceDefinitionList>
	<ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-WCHR">
		<Name>Silla de ruedas para rampas</Name>
		<Descriptions>
			<Description refs="ADULT_01">
				<Text>Necesito la silla de ruedas para cubrir la distancia hasta / desde la puerta de embarque. Puedo acceder al avi�n por escaleras y desplazarme dentro del mismo sin necesidad de asistencia.</Text>
			</Description>
		</Descriptions>
		<BookingInstructions>
			<SSRCode>WCHR</SSRCode>
		</BookingInstructions>
	</ServiceDefinition>
</ServiceDefinitionList>

Expand

title	OrderCreateRQ Voucher UC06 example 2024

Code Block

language	xml

<Payments>
	<Payment>
		<Type>MS</Type>
		<Method>
			<Voucher>
				<Number>BONO1000EUR</Number>
			</Voucher>
		</Method>
		<Amount Code="EUR">314.61</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>

Expand

title	OrderCreateRQ Large Family UC06 example 2024

Code Block

language	xml

<PassengerList>
	<Passenger PassengerID="ADULT_01">
		<PTC>ADT</PTC>
		<Birthdate>1979-03-24</Birthdate>
		<Individual IndividualID="IND_ADULT_01">
			<Gender>Male</Gender>
			<NameTitle>MR</NameTitle>
			<GivenName>JANE</GivenName>
			<Surname>SMITH</Surname>
		</Individual>
		<FOID>
			<FOID_Number>XXXXXXXXR</FOID_Number>
			<FOID_Type>NI</FOID_Type>
		</FOID>
		<IdentityDocument>
			<IdentityDocumentNumber>123131414143</IdentityDocumentNumber>
			<IdentityDocumentType>AI</IdentityDocumentType>
		</IdentityDocument>
		<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
		<Remark>
			<Remark>LARGEFAMILY-060830</Remark>
		</Remark>
	</Passenger>
</PassengerList>

Expand

title	OrderCreateRQ Upselling UC07 example 2024

Code Block

language	xml

<Offer OfferID="IB1059a538e2e646b98c1a6ae0e11dd745OP" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzE4MTkwODkzMzE2LWNDaUJ4">
	<OfferItem OfferItemID="IB1059a538e2e646b98c1a6ae0e11dd745OP_01">
		<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
	</OfferItem>
</Offer>

Expand

title	OrderCreateRQ 15 & 32 kg Baggage UC07 example 2024

Code Block

language	xml

<Offer OfferID="ALACARTE_IB058b638f162445c983238dd39cf05a51" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzE4MTkwODkzMzE2LWNDaUJ4">
	<OfferItem OfferItemID="ALACARTE_BAGGAGE_IB058b638f162445c983238dd39cf05a51_01">
		<PassengerRefs>ADULT_01</PassengerRefs>
	</OfferItem>
	<OfferItem OfferItemID="ALACARTE_BAGGAGE_IB058b638f162445c983238dd39cf05a51_15">
		<PassengerRefs>ADULT_02</PassengerRefs>
	</OfferItem>
	<OfferItem OfferItemID="ALACARTE_SSR_IB058b638f162445c983238dd39cf05a51_DEAF">
		<PassengerRefs>ADULT_01</PassengerRefs>
		<ServiceSelection ServiceID="SSR_DEAF_1e8c484a-df8b-4b13-a618-b842e67c187c">
			<ServiceDefinitionID>SPECIAL_NEED-DEAF</ServiceDefinitionID>
		</ServiceSelection>
	</OfferItem>
	<OfferItem OfferItemID="ALACARTE_SSR_IB058b638f162445c983238dd39cf05a51_WCHR">
		<PassengerRefs>ADULT_02</PassengerRefs>
		<ServiceSelection ServiceID="SSR_WCHR_447c3b40-4f8c-4660-8679-3d05eae9ed9f">
			<ServiceDefinitionID>SPECIAL_NEED-WCHR</ServiceDefinitionID>
		</ServiceSelection>
	</OfferItem>
</Offer>

Expand

title	OrderCreateRQ Voucher and Cash UC07 example 2024

Code Block

language	xml

<Payments>
	<Payment>
		<Type>MS</Type>
		<Method>
			<Voucher>
				<Number>BONO100EUR</Number>
			</Voucher>
		</Method>
		<Amount Code="EUR">239.67</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
	<Payment>
		<Type>CA</Type>
		<Method>
			<Cash CashInd="true"/>
		</Method>
		<Amount Code="EUR">0</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>

Expand

title	OrderCreateRQ Special Need UC07 example 2024

Code Block

language	xml

<ServiceDefinitionList>
	<ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-DEAF">
		<Name>Pasajero sordo</Name>
		<Descriptions>
			<Description refs="ADULT_01">
				<Text>Solicite servicio de animales si viaja con uno</Text>
			</Description>
		</Descriptions>
		<BookingInstructions>
			<SSRCode>DEAF</SSRCode>
		</BookingInstructions>
	</ServiceDefinition>
	<ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-WCHR">
		<Name>Silla de ruedas para rampas</Name>
		<Descriptions>
			<Description refs="ADULT_02">
				<Text>Necesito la silla de ruedas para cubrir la distancia hasta / desde la puerta de embarque. Puedo acceder al avi�n por escaleras y desplazarme dentro del mismo sin necesidad de asistencia.</Text>
			</Description>
		</Descriptions>
		<BookingInstructions>
			<SSRCode>WCHR</SSRCode>
		</BookingInstructions>
	</ServiceDefinition>
</ServiceDefinitionList>

Expand

title	OrderCreateRQ Two Surnames UC07 example 2024

Code Block

language	xml

<PassengerList>
	<Passenger PassengerID="ADULT_01">
		<PTC>ADT</PTC>
		<Birthdate>1983-03-09</Birthdate>
		<Individual IndividualID="IND_ADULT_01">
			<Gender>Male</Gender>
			<NameTitle>MR</NameTitle>
			<GivenName>JANE</GivenName>
			<Surname>SMITH@MARTINEZ</Surname>
		</Individual>
		<FOID>
			<FOID_Number>XXXXXXXXL</FOID_Number>
			<FOID_Type>NI</FOID_Type>
		</FOID>
		<ContactInfoRef>ADULT_01_CONTACT</ContactInfoRef>
	</Passenger>
</PassengerList>

Expand

title	OrderCreateRQ on hold UC08 example 2024

Code Block

language	xml

<Order>
	<Offer OfferID="IB0a88e0b496d7465286620feb1a282412OC" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzE5OTkxMTAzNzAzLTNERXd6">
		<OfferItem OfferItemID="IB0a88e0b496d7465286620feb1a282412OC_01">
			<PassengerRefs>ADULT_01</PassengerRefs>
		</OfferItem>
	</Offer>
</Order>

Expand

title	OrderCreateRQ Cash UC09 example 2024

Code Block

language	xml

<Payments>
	<Payment>
		<Type>CA</Type>
		<Amount>
			<SimpleCurrencyPrice Code="EUR">3439.88</SimpleCurrencyPrice>
		</Amount>
		<Method>
			<CashMethod/>
		</Method>
	</Payment>
</Payments>

Expand

title	OrderCreateRQ Credit Card UC10 example 2024

Code Block

language	xml

<Payments>
	<Payment>
		<Type>CC</Type>
		<Method>
			<PaymentCard>
				<CardType>VI</CardType>
				<SeriesCode>XXX</SeriesCode>
				<CardHolderName>JANE SMITH</CardHolderName>
				<CardHolderBillingAddress>
					<Street>125 PRESTON RD BRIGH</Street>
					<CityName>MA</CityName>
					<StateProv>BN</StateProv>
					<PostalCode>BN12LP</PostalCode>
					<CountryCode>ES</CountryCode>
				</CardHolderBillingAddress>
				<CardNumber>40XXXXXXXXXXXX23</CardNumber>
				<EffectiveExpireDate>
					<Expiration>MMYY</Expiration>
				</EffectiveExpireDate>
			</PaymentCard>
		</Method>
		<Amount Code="CLP">501020.00</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>

Expand

title	OrderCreateRQ Private Fare Sport UC11 example 2024

Code Block

language	xml

<Order>
	<Offer OfferID="IB30c290390a7a41268d2316713f0edc9fOC" Owner="IB" ResponseID="Qm9va2luZ0BHVy0xNzIzMDIwMjgyNTQ2LTZ1cXdk">
		<OfferItem OfferItemID="IB30c290390a7a41268d2316713f0edc9fOC_01">
			<PassengerRefs>ADULT_01</PassengerRefs>
		</OfferItem>
	</Offer>
</Order>

Expand

title	OrderCreateRQ On Business UC11 example 2024

Code Block

language	xml

<LoyaltyProgramAccount>
	<Airline>
		<AirlineDesignator>IB</AirlineDesignator>
	</Airline>
	<AccountNumber>OB12345678</AccountNumber>
</LoyaltyProgramAccount>

Expand

title	OrderCreateRQ Sport Equipment Bike UC11 example 2024

Code Block

language	xml

<InstructionsList>
	<Instruction ListKey="Instruction_01">
		<FreeFormTextInstruction refs="ADULT_01 IB395020240826">
			<Remark>BAGGAGE/SP/0EC</Remark>
		</FreeFormTextInstruction>
	</Instruction>
</InstructionsList>

Expand

title	OrderCreateRQ Email Control UC12 example 2024

Code Block

language	xml

<Sender>
	<TravelAgencySender>
		<Name>AgencyName</Name>
		<Contacts>
			<Contact ContactType="itin_and_price">
				<EmailContact>
					<Address>agency@agencyemail.com</Address>
				</EmailContact>
				<PhoneContact>
					<Application>MOBILE</Application>
					<Number>+34666666666</Number>
				</PhoneContact>
				<Name>
					<Surname>Perez</Surname>
					<Given>Pepe</Given>
				</Name>
			</Contact>
		</Contacts>
		<IATA_Number>11111111</IATA_Number>
		<AgencyID>First Agency</AgencyID>
	</TravelAgencySender>
</Sender>
<ContactList>
	<ContactInformation ContactID="ADULT_01_CONTACT">
		<ContactType>itin_only</ContactType>
		<ContactProvided>
			<EmailAddress>
				<EmailAddressValue>xxxxx@xxxxxx.com</EmailAddressValue>
			</EmailAddress>
		</ContactProvided>
		<ContactProvided>
			<Phone>
				<Label>Passenger</Label>
				<PhoneNumber>+34666554433</PhoneNumber>
			</Phone>
			<Phone>
				<Label>Emergency</Label>
				<PhoneNumber>34666554433</PhoneNumber>
			</Phone>
		</ContactProvided>
		<Individual>
			<GivenName>CONTACTO</GivenName>
			<Surname>EMERGENCIA</Surname>
		</Individual>
	</ContactInformation>
	<ContactInformation ContactID="Payer">
		<ContactType>Payer</ContactType>
		<ContactProvided>
			<EmailAddress>
				<EmailAddressValue>xxxxxx.xxxxx@xxxxx.es</EmailAddressValue>
			</EmailAddress>
		</ContactProvided>
		<ContactProvided>
			<Phone>
				<Label/>
				<PhoneNumber>1273211111</PhoneNumber>
			</Phone>
		</ContactProvided>
		<IndividualRef>IND_ADULT_01</IndividualRef>
	</ContactInformation>
</ContactList>

Expand

title	OrderCreateRQ USD Cash UC12 example 2024

Code Block

language	xml

<Payments>
	<Payment>
		<Type>CA</Type>
		<Method>
			<Cash CashInd="true"/>
		</Method>
		<Amount Code="USD">2041.20</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>

Response Body

OrderViewRS

Examples of messages with complete flows can be downloaded from here.

Error messages

For further information about all kind of error messages, please go to the following link:

Errors

Versions Compared

Old Version 11

New Version Current

Key

Examples of messages with complete flows can be downloaded from here.

Common Sections

HTTP Header

Language, Version and Name Space

Point of Sale

Document

Party

Query

DataLists

Expand
title DataLists - PassengerList
PassengerList
Insert excerpt
PassengerList
PassengerList
name PassengerList
nopanel true
...
Expand
title ContactListDataLists -
ContactList
Insert excerpt
ContactList
ContactList
name ContactList
nopanel true

PassengerList

Insert excerpt
PassengerList
PassengerList
name PassengerList
nopanel true

ContactList

DataLists / FlightSegmentList

InstructionList

Insert excerpt

InstructionsList

InstructionsList
name

InstructionsList
nopanel true

DataLists / InstructionsList

ServiceDefinitionList

Insert excerpt
ServiceDefinitionList
ServiceDefinitionList
name ServiceDefinitionList
nopanel true

Metadata

Expand
title
Metadata -
Forms of Payment
Insert excerpt
Forms of Payment Metadata
Forms of Payment Metadata
name PaymentFormMetadata
nopanel true

Example OrderCreateRQ:

Error messages

Examples OrderCreateRQ 2024:

Response Body

Examples of messages with complete flows can be downloaded from here.

Error messages

Page Comparison

Versions Compared

Key

Examples of messages with complete flows can be downloaded from here.

ExpandtitleDataLists - PassengerListPassengerList Insert excerptPassengerListPassengerListnamePassengerListnopaneltrue... ExpandtitleContactListDataLists - ContactList Insert excerptContactListContactListnameContactListnopaneltrue

Insert excerptPassengerListPassengerListnamePassengerListnopaneltrue

Insert excerpt

InstructionsList

InstructionsListname

InstructionsListnopaneltrue

Insert excerptServiceDefinitionListServiceDefinitionListnameServiceDefinitionListnopaneltrue

ExpandtitleMetadata - Forms of Payment Insert excerptForms of Payment MetadataForms of Payment MetadatanamePaymentFormMetadatanopaneltrue

Example OrderCreateRQ:

Error messages

Examples OrderCreateRQ 2024:

Response Body

Examples of messages with complete flows can be downloaded from here.

Error messages

Expand
title DataLists - PassengerList
PassengerList
Insert excerpt
PassengerList
PassengerList
name PassengerList
nopanel true
...
Expand
title ContactListDataLists -
ContactList
Insert excerpt
ContactList
ContactList
name ContactList
nopanel true

Insert excerpt
PassengerList
PassengerList
name PassengerList
nopanel true

InstructionsList
name

InstructionsList
nopanel true

Insert excerpt
ServiceDefinitionList
ServiceDefinitionList
name ServiceDefinitionList
nopanel true

Expand
title
Metadata -
Forms of Payment
Insert excerpt
Forms of Payment Metadata
Forms of Payment Metadata
name PaymentFormMetadata
nopanel true