Request Parameters

API Reference: Ticket-level Capture

The sections below describe the parameters used in a Ticket-level Capture (update-order-data) request:

For Ticket-level Capture sample code, see Ticket-level Capture.

transaction

Parents: root: update-order-data

The transaction element is required, and it has one child: orders.

The transaction element has the following attributes:

ParameterFormatRequirementDescription
idIntegerRequiredThe identification number of a transaction
order-noStringRequiredThe order number associated with the transaction.

orders

Parents: root: update-order-data: transaction

Please note:

  • The orders element is required; it provides detailed information about the travel itinerary.

  • The orders element must contain at least one line-item child. It may have multiple line-item children. See their description below.

line-item

Parents: root: update-order-data: transaction: orders

The line-item element is required. It has four children: product, amount, quantity, and additional-data. See their descriptions below.

product

Parents: root: update-order-data: transaction: orders: line-item

Please note:

  • The product element is required. It provides detailed information about the travel itinerary, including fare information, traveler information, and trip information.

  • The product element has four children: type, name, description, and airline-data. See their descriptions below.

The product element has the following attributes:

ParameterFormatRequirementDescription
order-refIntegerRequiredThe order reference number.
skuStringRequiredThe short code for travel itinerary. For example, PNR and order number.

type

Parents: root: update-order-data: transaction: orders: line-item: product

The type element is required, and it has the following text content:

ParameterFormatRequirementDescription
typeIntegerRequiredThe type of product.

name

Parents: root: update-order-data: transaction: orders: line-item: product

The name element is required, and it has the following text content:

ParameterFormatRequirementDescription
nameStringRequiredThe name of a journey. For example, ONEWAY, RETURN, MULTICITY, MYB, and OLCI.

description

Parents: root: update-order-data: transaction: orders: line-item: product

The description element is optional, and it has the following text content:

ParameterFormatRequirementDescription
descriptionStringOptionalA description of the travel itinerary.

airline-data

Parents: root: update-order-data: transaction: orders: line-item: product

Please note:

  • The airline-data element is optional; it provides low-level information of the travel itinerary such as fare information, traveler information, and trip information.

  • The airline-data element has three children: profiles, billing-summary, and trips. See their descriptions below.

profiles

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data

Note the following:

  • The profiles element is required if airline-data is present.
  • The profiles element provides traveler information for the travel itinerary.
  • The profiles element must have at least one profile child; it may have multiple profile children.
  • Each profile child has the following children: seq, title, first-name, last-name, type, contact-info, and additional-data. See their descriptions below.

seq

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile

The seq element is required if profile is present, and it has the following text content:

ParameterFormatRequirementDescription
sequence numberIntegerConditional Requirement: Required if airline-data is present.The sequence number of the passenger.

title

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile

The title element is required if profile is present, and it has the following text content:

ParameterFormatRequirementDescription
titleIntegerConditional Requirement: Required if airline-data is present.The title of the passenger. For example, Mr., Mrs., and Ms.

first-name

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile

The first-name element is required if profile is present, and it has the following text content:

ParameterFormatRequirementDescription
first nameIntegerConditional Requirement: Required if airline-data is present.The first name of the passenger.

last-name

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile

The last-name element is required if profile is present, and it has the following text content:

ParameterFormatRequirementDescription
last nameIntegerConditional Requirement: Required if airline-data is present.The last name of the passenger.

type

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile

The type element is required if profile is present, and it has the following text content:

ParameterFormatRequirementDescription
passenger typeIntegerConditional Requirement: Required if airline-data is present.The type of passenger. For example,
ADT - Adult
CHD - Child
INF - Infant with FAA Seat
Refer to Reference for all possible values.

contact-info

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile

Please note:

  • The contact-info element is required if airline-data is present; it provides contact information for the specified passenger.

  • The contact-info element has two children: email and mobile.

The email child element has the following text content:

ParameterFormatRequirementDescription
email addressStringConditional Requirement: Required if airline-data is present.The passenger's email address.

The mobile child element has the following attribute:

ParameterFormatRequirementDescription
country-idIntegerConditional Requirement: Required if airline-data is present.Three-digit numeric ISO country code of the mobile phone number's country. This is available in Reference.

The mobile child element has the following text content:

ParameterFormatRequirementDescription
mobile phone numberStringConditional Requirement: Required if airline-data is present.The passenger's mobile phone number.

additional-data

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile

Please note:

  • The additional-data element is optional;

  • The additional-data element provides additional passenger information related to the specified passenger profile, such as loyalty number, passenger tier, and passport number.

  • The additional-data element may contain multiple param children.

Each param child element has the following attributes:

ParameterFormatRequirementDescription
nameStringOptionalThe type of additional data being provided in the param text content, such as loyalty_id.

Each param child element has the following text content:

ParameterFormatRequirementDescription
parameter valueStringOptionalThe value of the parameter defined in name.

billing-summary

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data

Note the following:

  • The billing-summary element is required if airline-data is present.
  • The billing-summary element provides billing details of the journey.
  • The billing-summary element can have the following children: fare-detail and add-ons. See their descriptions below.

fare-detail

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: billing-summary

Please note:

  • The fare-detail element is required if billing-summary is present; it provides fare details of the journey.

  • The fare-detail element must have at least one fare child; it may have multiple fare children.

Each fare child element has the following children:

ElementRequirementFormat of text contentDescription of text content
profile-seqConditional Requirement: Required if airline-data is present.IntegerThe sequence number of a passenger.
descriptionConditional Requirement: Required if airline-data is present.StringThe description of the fare.
currencyConditional Requirement: Required if airline-data is present.StringThe alpha3 ISO currency code of the fare amount.
amountConditional Requirement: Required if airline-data is present.StringThe amount charged for the product. This can be a decimal value.
product-codeConditional Requirement: Required if airline-data is present.StringThe product code of the item.
product-categoryConditional Requirement: Required if airline-data is present.StringThe product category code.
product-itemConditional Requirement: Required if airline-data is present.StringThe product name.

add-ons

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: billing-summary

Please note:

  • The add-ons element is required if airline-data is present.

  • The add-ons element provides additional information for a journey.

  • The add-ons element must have at least one add-on child; it may have multiple add-on children.

Each add-on child element has the following children:

ElementRequirementFormat of text contentDescription of text content
profile-seqOptionalIntegerThe sequence number of the passenger linked to this add-on.
trip-tagOptionalStringThe tag number associated with a trip, which helps identify a trip.
trip-seqOptionalStringThe trip sequence number to identify the leg of the trip.
descriptionConditional Requirement: Required if airline-data is present.StringThe description of the add-on parameters.
currencyConditional Requirement: Required if airline-data is present.StringThe alpha3 ISO currency code of the fare amount.
amountConditional Requirement: Required if airline-data is present.StringThe amount paid for the add-on product. This can be a decimal value.
product-codeConditional Requirement: Required if airline-data is present.StringThe code number to identify the add-on product.
product-categoryConditional Requirement: Required if airline-data is present.StringThe code number to identify the add-on product category.
product-itemConditional Requirement: Required if airline-data is present.StringThe product name.

trips

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data

Note the following:

  • The trips element is required if airline-data is present.
  • The trips element provides trip information for the travel itinerary.
  • The trips element must have at least one trip child; it may have multiple trip children.
  • Each trip child element has the following children: origin, destination, departure-time, arrival-time, booking-class, service-level, transportation, and additional-data. See their descriptions below.

Each trip child element has the following attributes:

ParameterFormatRequirementDescription
tagIntegerConditional Requirement: Required if airline-data is present.The sequence of this journey in journeys.
seqIntegerConditional Requirement: Required if airline-data is present.The sequence of this trip or layover within a journey from end to end.

origin

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip

The origin element is required if airline-data is present, and it has the following attributes:

ParameterFormatRequirementDescription
external-idStringConditional Requirement: Required if airline-data is present.The IATA code of the airport where the journey originates.
country-idIntegerConditional Requirement: Required if airline-data is present.The ISO numeric country code of the place where the journey originates.
time-zoneString, in +/-HH:MM formatConditional Requirement: Required if airline-data is present.The time zone of the place where the journey originates. The time zone is offset; for example,+08:00.
terminalStringOptionalThe airport terminal at which the journey originates.

The origin element has the following text content:

ParameterFormatRequirementDescription
originStringRequiredThe place where the journey originates.

destination

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip

The destination element is required if airline-data is present, and it has the following attributes:

ParameterFormatRequirementDescription
external-idStringConditional Requirement: Required if airline-data is present.The IATA code of the airport at the destination.
country-idIntegerConditional Requirement: Required if airline-data is present.The ISO numeric country code of the destination.
time-zoneString, in +/-HH:MM formatConditional Requirement: Required if airline-data is present.The time zone of the destination. The time zone is offset; for example,+08:00.
terminalStringOptional

The destination element has the following text content:

ParameterFormatRequirementDescription
destinationStringRequiredThe destination of the journey.

departure-time

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip

The departure-time element is required if airline-data is present, and it has the following text content:

ParameterFormatRequirementDescription
departure timeStringConditional Requirement: Required if airline-data is present.The departure time of the flight from its origin, in GMT.

arrival-time

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip

The arrival-time element is required if airline-data is present, and it has the following text content:

ParameterFormatRequirementDescription
arrival timeStringConditional Requirement: Required if airline-data is present.The arrival time of the flight at its destination, in GMT.

booking-class

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip

The booking-class element is required if airline-data is present, and it has the following text content:

ParameterFormatRequirementDescription
booking classStringConditional Requirement: Required if airline-data is present.The booking class (RBD – first letter of fare-basis). For example, H.

service-level

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip

The service-level element is required if airline-data is present, and it has the following text content:

ParameterFormatRequirementDescription
service levelStringConditional Requirement: Required if airline-data is present.The cabin class. For example, Economy.

transportation

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip

Note the following:

  • The transportation element is required if airline-data is present; it provides transportation information for the travel itinerary.
  • The transportation element has one child: carriers. See the carriers description below.

The transportation element has the following attributes:

ParameterFormatRequirementDescription
codeStringConditional Requirement: Required if airline-data is present.The marketing airline code for transportation. For example, 5J, PR, OD, and AV.
numberIntegerConditional Requirement: Required if airline-data is present.The operating flight number.

carriers

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip: transportation

Please note:

  • The carriers element is required if airline-data is present; it provides information on carriers used in this journey.

  • Each carriers element must have at least one carrier child; it may have multiple carrier children.

  • Each carrier child element has one child: number.

The carrier child element has the following attributes:

ParameterFormatRequirementDescription
codeStringConditional Requirement: Required if airline-data is present.The code for the operating airline. For example, PROD, and AV.
type-idIntegerConditional Requirement: Required if airline-data is present.Aircraft type information.

Each number child element has the following text content:

ParameterFormatRequirementDescription
flight numberIntegerConditional Requirement: Required if airline-data is present.The flight number in the airline's system.

additional-data

Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip

Please note:

  • The additional-data element is optional; it provides additional data about the trip.

  • The additional-data element may contain multiple param children.

Each param child element has the following attributes:

ParameterFormatRequirementDescription
nameStringOptionalThe name of a parameter providing additional information, such as fare_basis.

Each param child element has the following text content:

ParameterFormatRequirementDescription
parameter valueStringOptionalThe value of the parameter defined in name.

amount

Parents: root: update-order-data: transaction: orders: line-item

The amount element is required; it provides the total amount charged for the line item. It has the following text content:

ParameterFormatRequirementDescription
amountIntegerRequiredThe total amount for an order.

quantity

Parents: root: update-order-data: transaction: orders: line-item

The quantity element is optional; it provides the quantity of the line item. It has the following text content:

ParameterFormatRequirementDescription
quantityIntegerOptionalThe quantity of this line item. Default value is 1.

additional-data

Parents: root: update-order-data: transaction: orders: line-item

Please note:

  • The additional-data element is optional; it provides additional data about the line item.

  • The additional-data element may contain multiple param children.

Each param child element has the following attributes:

ParameterFormatRequirementDescription
nameIntegerOptionalThe name of a parameter providing additional information. Some possible values: merchant_payment_ref, deviceFingerPrint, info_cust_url, office_id, flexi_search, lowest_fare.

Each param child element has the following text content:

ParameterFormatRequirementDescription
parameter valueStringOptionalThe value of the parameter defined in name.