Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:Version 17.2 COMBINED (v1 and v2)'.

Common Sections

 Language, Version and Name Space

Language, Version and Name Space

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

Version

The IATA version of the message

Mandatory for Schema

Numeric

Any

All Services

PrimaryLangID

Two character ISO Language Code, for the agent’s preferred language.

This is used for error messages and some other data such as legal waivers.

2 Alphabetical

  • EN

  • ES

All Services

xmlns

IATA official website

Mandatory for Schema

Alphanumeric

Any

All Services

 Document

Document

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Document>

ReferenceVersion

The IATA Schema version.

Numeric

Any

 All Services

 Warnings

Warnings

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

NDC SERVICES

<Warnings>

Warning

Attribute

ShortText

Attribute

Code

Different messages to inform the agency, for example:

  • No price available associated to passenger type…

These warnings should be displayed to the user.

Alphanumeric

Any

All response messages

In addition to the Common Sections the main parts of the request message are the following:

OrderCancel / Response

 OrderCancel / Response

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<Response>

OrderCancelProcessing / MarketingMessages / MarketMessage / Text

Additional text for associated services

Alphabetical

Any

OrderCancelProcessing / Remarks / Remark

Additional remark.

Only shown when it was refunded

Alphanumeric

Any

OrderReference

Order reference

Alphanumeric

Any

OrderCancel / TicketDocInfo

 OrderCancel / TicketDocInfo

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

<Response / TicketDocInfos>

TicketDocInfo / FareInfo / Total / Amount

Attribute

Code

Total amount of ticket

Code refers to currency code

Numeric

Alphabetical

Any

TicketDocument

Attribute

PrimaryDocInd

In case of conjunction tickets, this indicator will be displayed associated to the primary ticket.

Also if conjunction tickets apply, all of them (TicketDocInfo) will be displayed inside the same “TicketDocInfos” tag as a list of associated tickets.

Alphabetical

true

TicketDocInfo / TicketDocument / TicketDocNbr

Number of ticket

Numeric

Any

TicketDocInfo / TicketDocument / Type

Type of ticket

Alphabetical

  • T (Ticket)

  • J (EMD)

TicketDocInfo / TicketDocument / NumberofBooklets

Number of tickets

Numeric

Any

TicketDocInfo / TicketDocument / DateOfIssue

Date of issue for ticket

Date

yyyy-MM-dd

TicketDocInfo / TicketDocument / TimeOfIssue

Hour of issue for ticket

Hour

HH:mm

TicketDocInfo / TicketDocument / CouponInfo / CouponNumber

Number of coupon

Numeric

Any

TicketDocInfo / TicketDocument / CouponInfo / FareBasisCode / Code

Code of fare basis for coupon

Alphanumeric

Any

TicketDocInfo / TicketDocument / CouponInfo / CouponValid / EffectiveDatePeriod / Effective

Date period for coupon valid

Date

yyyy-MM-dd

TicketDocInfo / TicketDocument / CouponInfo / Status

Status for Coupon

Alphabetical

IATA Padis Codeset - List for data element 4405 (Status, coded)

Here some examples of possible values:

  • I (Open for Use)

  • AL (Airport Control)

  • B (Used/Flown)

  • RF (Refunded)

  • E (Exchanged/Reissued)

  • OTH (Others like consumed at issuance)

TicketDocInfo / TicketDocument / CouponInfo / SoldAirlineInfo / DepartureDateTime

Attribute

ShortDate

Attribute

Time

Date of departure

Hour of departure

Date

Hour

yyyy-MM-dd

HH:mm

TicketDocInfo / TicketDocument / CouponInfo / SoldAirlineInfo / Departure / AirportCode

IATA 3 character code for the departure city/airport/station

3 Alphanumeric

Any

TicketDocInfo / TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Date

Date of departure

Date

yyyy-MM-dd

TicketDocInfo / TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Time

Hour of departure

Hour

HH:mm

TicketDocInfo / TicketDocument / CouponInfo / SoldAirlineInfo / Arrival / AirportCode

IATA 3 character code for the arrival city/airport/station

3 Alphanumeric

Any

TicketDocInfo / TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / AirlineID

ID of the airline that markets the flight

Alphabetical

Any

TicketDocInfo / TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / FlightNumber

Number of the airline that markets the flight

Number

Any

TicketDocInfo / TicketDocument / CouponInfo / SoldAirlineInfo /  Status

Status for ticket

Alphabetical

Any

TicketDocInfo / TicketDocument / ReportingType

Type of reporting, for billing and settlement purposes. Each time a travel agent requests an airline to perform an action on a document (issuance, refund, exchange), they need to know how the Ticket and/or EMD has been reconciled.

Alphabetical

  • Airline

  • BSP

  • ARC

Example OrderCancelRS:

 OrderCancelRS example
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<OrderCancelRS Version="5.000" PrimaryLangID="es" xmlns:ns2="http://www.iberia.com/IATA/NDC/SecurePayment/2017.2" xmlns="http://www.iata.org/IATA/EDIST/2017.2">
			<Document>
				<ReferenceVersion>5.000</ReferenceVersion>
			</Document>
			<Success/>
			<Warnings>
				<Warning ShortText="001" Code="486">Para los servicios comprados por fuera de NDC, se debe solicitar reembolso por el mismo canal donde lo compró</Warning>
			</Warnings>
			<Response>
				<OrderCancelProcessing>
					<MarketingMessages>
						<MarketMessage>
							<Text>En caso de haber contratado otros servicios, para solicitar el reembolso debe contactarse con Iberia</Text>
						</MarketMessage>
					</MarketingMessages>
					<Remarks>
						<Remark>REFUNDED-EUR-1003.16</Remark>
					</Remarks>
				</OrderCancelProcessing>
				<OrderReference>IB7df9d4d356ff4c11a13295d81dc7be8bOC</OrderReference>
				<TicketDocInfos>
					<TicketDocInfo>
						<FareInfo>
							<Total>
								<Amount Code="EUR">250.79</Amount>
							</Total>
						</FareInfo>
						<TicketDocument>
							<TicketDocNbr>0752104735538</TicketDocNbr>
							<Type>T</Type>
							<NumberofBooklets>1</NumberofBooklets>
							<DateOfIssue>2023-07-24</DateOfIssue>
							<TimeOfIssue>13:44</TimeOfIssue>
							<CouponInfo>
								<CouponNumber>1</CouponNumber>
								<FareBasisCode>
									<Code>VZNNANB4</Code>
								</FareBasisCode>
								<CouponValid>
									<EffectiveDatePeriod>
										<Effective>2023-09-18</Effective>
									</EffectiveDatePeriod>
								</CouponValid>
								<Status>RF</Status>
								<SoldAirlineInfo>
									<DepartureDateTime ShortDate="2023-09-18" Time="09:05"/>
									<Departure>
										<AirportCode>MAD</AirportCode>
										<Date>2023-09-18</Date>
										<Time>09:05</Time>
									</Departure>
									<Arrival>
										<AirportCode>BRU</AirportCode>
									</Arrival>
									<MarketingCarrier>
										<AirlineID>IB</AirlineID>
										<FlightNumber>3206</FlightNumber>
									</MarketingCarrier>
									<Status>OK</Status>
								</SoldAirlineInfo>
								<AddlBaggageInfo>
									<AllowableBag Number="0"/>
								</AddlBaggageInfo>
							</CouponInfo>
							<CouponInfo>
								<CouponNumber>2</CouponNumber>
								<FareBasisCode>
									<Code>NWNNANB4</Code>
								</FareBasisCode>
								<CouponValid>
									<EffectiveDatePeriod>
										<Effective>2023-09-24</Effective>
									</EffectiveDatePeriod>
								</CouponValid>
								<Status>RF</Status>
								<SoldAirlineInfo>
									<DepartureDateTime ShortDate="2023-09-24" Time="19:40"/>
									<Departure>
										<AirportCode>BRU</AirportCode>
										<Date>2023-09-24</Date>
										<Time>19:40</Time>
									</Departure>
									<Arrival>
										<AirportCode>MAD</AirportCode>
									</Arrival>
									<MarketingCarrier>
										<AirlineID>IB</AirlineID>
										<FlightNumber>3205</FlightNumber>
									</MarketingCarrier>
									<Status>OK</Status>
								</SoldAirlineInfo>
								<AddlBaggageInfo>
									<AllowableBag Number="0"/>
								</AddlBaggageInfo>
							</CouponInfo>
							<ReportingType>BSP</ReportingType>
						</TicketDocument>
					</TicketDocInfo>
					<TicketDocInfo>
						<FareInfo>
							<Total>
								<Amount Code="EUR">250.79</Amount>
							</Total>
						</FareInfo>
						<TicketDocument>
							<TicketDocNbr>0752104735539</TicketDocNbr>
							<Type>T</Type>
							<NumberofBooklets>1</NumberofBooklets>
							<DateOfIssue>2023-07-24</DateOfIssue>
							<TimeOfIssue>13:44</TimeOfIssue>
							<CouponInfo>
								<CouponNumber>1</CouponNumber>
								<FareBasisCode>
									<Code>VZNNANB4</Code>
								</FareBasisCode>
								<CouponValid>
									<EffectiveDatePeriod>
										<Effective>2023-09-18</Effective>
									</EffectiveDatePeriod>
								</CouponValid>
								<Status>RF</Status>
								<SoldAirlineInfo>
									<DepartureDateTime ShortDate="2023-09-18" Time="09:05"/>
									<Departure>
										<AirportCode>MAD</AirportCode>
										<Date>2023-09-18</Date>
										<Time>09:05</Time>
									</Departure>
									<Arrival>
										<AirportCode>BRU</AirportCode>
									</Arrival>
									<MarketingCarrier>
										<AirlineID>IB</AirlineID>
										<FlightNumber>3206</FlightNumber>
									</MarketingCarrier>
									<Status>OK</Status>
								</SoldAirlineInfo>
								<AddlBaggageInfo>
									<AllowableBag Number="0"/>
								</AddlBaggageInfo>
							</CouponInfo>
							<CouponInfo>
								<CouponNumber>2</CouponNumber>
								<FareBasisCode>
									<Code>NWNNANB4</Code>
								</FareBasisCode>
								<CouponValid>
									<EffectiveDatePeriod>
										<Effective>2023-09-24</Effective>
									</EffectiveDatePeriod>
								</CouponValid>
								<Status>RF</Status>
								<SoldAirlineInfo>
									<DepartureDateTime ShortDate="2023-09-24" Time="19:40"/>
									<Departure>
										<AirportCode>BRU</AirportCode>
										<Date>2023-09-24</Date>
										<Time>19:40</Time>
									</Departure>
									<Arrival>
										<AirportCode>MAD</AirportCode>
									</Arrival>
									<MarketingCarrier>
										<AirlineID>IB</AirlineID>
										<FlightNumber>3205</FlightNumber>
									</MarketingCarrier>
									<Status>OK</Status>
								</SoldAirlineInfo>
								<AddlBaggageInfo>
									<AllowableBag Number="0"/>
								</AddlBaggageInfo>
							</CouponInfo>
							<ReportingType>BSP</ReportingType>
						</TicketDocument>
					</TicketDocInfo>
					<TicketDocInfo>
						<FareInfo>
							<Total>
								<Amount Code="EUR">250.79</Amount>
							</Total>
						</FareInfo>
						<TicketDocument>
							<TicketDocNbr>0752104735537</TicketDocNbr>
							<Type>T</Type>
							<NumberofBooklets>1</NumberofBooklets>
							<DateOfIssue>2023-07-24</DateOfIssue>
							<TimeOfIssue>13:44</TimeOfIssue>
							<CouponInfo>
								<CouponNumber>1</CouponNumber>
								<FareBasisCode>
									<Code>VZNNANB4</Code>
								</FareBasisCode>
								<CouponValid>
									<EffectiveDatePeriod>
										<Effective>2023-09-18</Effective>
									</EffectiveDatePeriod>
								</CouponValid>
								<Status>RF</Status>
								<SoldAirlineInfo>
									<DepartureDateTime ShortDate="2023-09-18" Time="09:05"/>
									<Departure>
										<AirportCode>MAD</AirportCode>
										<Date>2023-09-18</Date>
										<Time>09:05</Time>
									</Departure>
									<Arrival>
										<AirportCode>BRU</AirportCode>
									</Arrival>
									<MarketingCarrier>
										<AirlineID>IB</AirlineID>
										<FlightNumber>3206</FlightNumber>
									</MarketingCarrier>
									<Status>OK</Status>
								</SoldAirlineInfo>
								<AddlBaggageInfo>
									<AllowableBag Number="0"/>
								</AddlBaggageInfo>
							</CouponInfo>
							<CouponInfo>
								<CouponNumber>2</CouponNumber>
								<FareBasisCode>
									<Code>NWNNANB4</Code>
								</FareBasisCode>
								<CouponValid>
									<EffectiveDatePeriod>
										<Effective>2023-09-24</Effective>
									</EffectiveDatePeriod>
								</CouponValid>
								<Status>RF</Status>
								<SoldAirlineInfo>
									<DepartureDateTime ShortDate="2023-09-24" Time="19:40"/>
									<Departure>
										<AirportCode>BRU</AirportCode>
										<Date>2023-09-24</Date>
										<Time>19:40</Time>
									</Departure>
									<Arrival>
										<AirportCode>MAD</AirportCode>
									</Arrival>
									<MarketingCarrier>
										<AirlineID>IB</AirlineID>
										<FlightNumber>3205</FlightNumber>
									</MarketingCarrier>
									<Status>OK</Status>
								</SoldAirlineInfo>
								<AddlBaggageInfo>
									<AllowableBag Number="0"/>
								</AddlBaggageInfo>
							</CouponInfo>
							<ReportingType>BSP</ReportingType>
						</TicketDocument>
					</TicketDocInfo>
					<TicketDocInfo>
						<FareInfo>
							<Total>
								<Amount Code="EUR">250.79</Amount>
							</Total>
						</FareInfo>
						<TicketDocument>
							<TicketDocNbr>0752104735540</TicketDocNbr>
							<Type>T</Type>
							<NumberofBooklets>1</NumberofBooklets>
							<DateOfIssue>2023-07-24</DateOfIssue>
							<TimeOfIssue>13:44</TimeOfIssue>
							<CouponInfo>
								<CouponNumber>1</CouponNumber>
								<FareBasisCode>
									<Code>VZNNANB4</Code>
								</FareBasisCode>
								<CouponValid>
									<EffectiveDatePeriod>
										<Effective>2023-09-18</Effective>
									</EffectiveDatePeriod>
								</CouponValid>
								<Status>RF</Status>
								<SoldAirlineInfo>
									<DepartureDateTime ShortDate="2023-09-18" Time="09:05"/>
									<Departure>
										<AirportCode>MAD</AirportCode>
										<Date>2023-09-18</Date>
										<Time>09:05</Time>
									</Departure>
									<Arrival>
										<AirportCode>BRU</AirportCode>
									</Arrival>
									<MarketingCarrier>
										<AirlineID>IB</AirlineID>
										<FlightNumber>3206</FlightNumber>
									</MarketingCarrier>
									<Status>OK</Status>
								</SoldAirlineInfo>
								<AddlBaggageInfo>
									<AllowableBag Number="0"/>
								</AddlBaggageInfo>
							</CouponInfo>
							<CouponInfo>
								<CouponNumber>2</CouponNumber>
								<FareBasisCode>
									<Code>NWNNANB4</Code>
								</FareBasisCode>
								<CouponValid>
									<EffectiveDatePeriod>
										<Effective>2023-09-24</Effective>
									</EffectiveDatePeriod>
								</CouponValid>
								<Status>RF</Status>
								<SoldAirlineInfo>
									<DepartureDateTime ShortDate="2023-09-24" Time="19:40"/>
									<Departure>
										<AirportCode>BRU</AirportCode>
										<Date>2023-09-24</Date>
										<Time>19:40</Time>
									</Departure>
									<Arrival>
										<AirportCode>MAD</AirportCode>
									</Arrival>
									<MarketingCarrier>
										<AirlineID>IB</AirlineID>
										<FlightNumber>3205</FlightNumber>
									</MarketingCarrier>
									<Status>OK</Status>
								</SoldAirlineInfo>
								<AddlBaggageInfo>
									<AllowableBag Number="0"/>
								</AddlBaggageInfo>
							</CouponInfo>
							<ReportingType>BSP</ReportingType>
						</TicketDocument>
					</TicketDocInfo>
				</TicketDocInfos>
			</Response>
		</OrderCancelRS>
	</soap:Body>
</soap:Envelope>

Examples OrderCancelRS 2024:

 OrderCancelRS OrderCancel UC01 example 2024
<Response>
	<OrderReference>IBd9f8773737e74c85b1172bf9168214b1OC</OrderReference>
</Response>
 OrderCancelRS Upselling UC07 example 2024
<OrderCancelProcessing>
	<Remarks>
		<Remark>REFUNDED-EUR-339.67</Remark>
	</Remarks>
</OrderCancelProcessing>
<OrderReference>IB1efddf008dde4414824bb611a260e75bOP</OrderReference>
 OrderCancelRS IATA Delegation UC08 example 2024
<OrderCancelProcessing>
	<Remarks>
		<Remark>REFUNDED-ARS-6422928.70</Remark>
	</Remarks>
</OrderCancelProcessing>
<OrderReference>IB0a88e0b496d7465286620feb1a282412OC</OrderReference>

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

  • No labels