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
transactionParents: root: update-order-data
The transaction element is required, and it has one child: orders.
The transaction element has the following attributes:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
id | Integer | Required | The identification number of a transaction |
order-no | String | Required | The order number associated with the transaction. |
orders
ordersParents: root: update-order-data: transaction
Please note:
-
The
orderselement is required; it provides detailed information about the travel itinerary. -
The
orderselement must contain at least oneline-itemchild. It may have multipleline-itemchildren. See their description below.
line-item
line-itemParents: 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
productParents: root: update-order-data: transaction: orders: line-item
Please note:
-
The
productelement is required. It provides detailed information about the travel itinerary, including fare information, traveler information, and trip information. -
The
productelement has four children:type,name,description, andairline-data. See their descriptions below.
The product element has the following attributes:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
order-ref | String | Required | The order reference number. |
sku | String | Required | The short code for travel itinerary. For example, PNR and order number. |
type
typeParents: root: update-order-data: transaction: orders: line-item: product
The type element is required, and it has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| type | Integer | Required | The type of product. |
name
nameParents: root: update-order-data: transaction: orders: line-item: product
The name element is required, and it has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| name | String | Required | The name of a journey. For example, ONEWAY, RETURN, MULTICITY, MYB, and OLCI. |
description
descriptionParents: root: update-order-data: transaction: orders: line-item: product
The description element is optional, and it has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| description | String | Optional | A description of the travel itinerary. |
airline-data
airline-dataParents: root: update-order-data: transaction: orders: line-item: product
Please note:
-
The
airline-dataelement is optional; it provides low-level information of the travel itinerary such as fare information, traveler information, and trip information. -
The
airline-dataelement has three children:profiles,billing-summary, andtrips. See their descriptions below.
profiles
profilesParents: root: update-order-data: transaction: orders: line-item: product: airline-data
Note the following:
- The
profileselement is required ifairline-datais present. - The
profileselement provides traveler information for the travel itinerary. - The
profileselement must have at least oneprofilechild; it may have multipleprofilechildren. - Each
profilechild has the following children:seq,title,first-name,last-name,type,contact-info, andadditional-data. See their descriptions below.
seq
seqParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| sequence number | Integer | Conditional Requirement: Required if airline-data is present. | The sequence number of the passenger. |
title
titleParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| title | String | Conditional Requirement: Required if airline-data is present. | The title of the passenger. For example, Mr., Mrs., and Ms. |
first-name
first-nameParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| first name | String | Conditional Requirement: Required if airline-data is present. | The first name of the passenger. |
last-name
last-nameParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| last name | String | Conditional Requirement: Required if airline-data is present. | The last name of the passenger. |
type
typeParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| passenger type | String | Conditional Requirement: Required if airline-data is present. | The type of passenger. For example, • ADT - Adult• CHD - Child• INF - Infant with FAA SeatRefer to Reference for all possible values. |
contact-info
contact-infoParents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile
Please note:
-
The
contact-infoelement is required ifairline-datais present; it provides contact information for the specified passenger. -
The
contact-infoelement has two children:emailandmobile.
The email child element has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| email address | String | Conditional Requirement: Required if airline-data is present. | The passenger's email address. |
The mobile child element has the following attribute:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
country-id | Integer | Conditional 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| mobile phone number | String | Conditional Requirement: Required if airline-data is present. | The passenger's mobile phone number. |
additional-data
additional-dataParents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile
Please note:
-
The
additional-dataelement is optional; -
The
additional-dataelement provides additional passenger information related to the specified passenger profile, such as loyalty number, passenger tier, and passport number. -
The
additional-dataelement may contain multipleparamchildren.
Each param child element has the following attributes:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
name | String | Optional | The type of additional data being provided in the param text content, such as loyalty_id. |
Each param child element has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| parameter value | String | Optional | The value of the parameter defined in name. |
billing-summary
billing-summaryParents: root: update-order-data: transaction: orders: line-item: product: airline-data
Note the following:
- The
billing-summaryelement is required ifairline-datais present. - The
billing-summaryelement provides billing details of the journey. - The
billing-summaryelement can have the following children:fare-detailandadd-ons. See their descriptions below.
fare-detail
fare-detailParents: root: update-order-data: transaction: orders: line-item: product: airline-data: billing-summary
Please note:
-
The
fare-detailelement is required ifbilling-summaryis present; it provides fare details of the journey. -
The
fare-detailelement must have at least onefarechild; it may have multiplefarechildren.
Each fare child element has the following children:
| Element | Requirement | Format of text content | Description of text content |
|---|---|---|---|
profile-seq | Conditional Requirement: Required if airline-data is present. | Integer | The sequence number of a passenger. |
description | Conditional Requirement: Required if airline-data is present. | String | The description of the fare. |
currency | Conditional Requirement: Required if airline-data is present. | String | The alpha3 ISO currency code of the fare amount. |
amount | Conditional Requirement: Required if airline-data is present. | String | The amount charged for the product. This can be a decimal value. |
product-code | Conditional Requirement: Required if airline-data is present. | String | The product code of the item. |
product-category | Conditional Requirement: Required if airline-data is present. | String | The product category code. |
product-item | Conditional Requirement: Required if airline-data is present. | String | The product name. |
add-ons
add-onsParents: root: update-order-data: transaction: orders: line-item: product: airline-data: billing-summary
Please note:
-
The
add-onselement is required ifairline-datais present. -
The
add-onselement provides additional information for a journey. -
The
add-onselement must have at least oneadd-onchild; it may have multipleadd-onchildren.
Each add-on child element has the following children:
| Element | Requirement | Format of text content | Description of text content |
|---|---|---|---|
profile-seq | Optional | Integer | The sequence number of the passenger linked to this add-on. |
trip-tag | Optional | String | The tag number associated with a trip, which helps identify a trip. |
trip-seq | Optional | String | The trip sequence number to identify the leg of the trip. |
description | Conditional Requirement: Required if airline-data is present. | String | The description of the add-on parameters. |
currency | Conditional Requirement: Required if airline-data is present. | String | The alpha3 ISO currency code of the fare amount. |
amount | Conditional Requirement: Required if airline-data is present. | String | The amount paid for the add-on product. This can be a decimal value. |
product-code | Conditional Requirement: Required if airline-data is present. | String | The code number to identify the add-on product. |
product-category | Conditional Requirement: Required if airline-data is present. | String | The code number to identify the add-on product category. |
product-item | Conditional Requirement: Required if airline-data is present. | String | The product name. |
trips
tripsParents: root: update-order-data: transaction: orders: line-item: product: airline-data
Note the following:
- The
tripselement is required ifairline-datais present. - The
tripselement provides trip information for the travel itinerary. - The
tripselement must have at least onetripchild; it may have multipletripchildren. - Each
tripchild element has the following children:origin,destination,departure-time,arrival-time,booking-class,service-level,transportation, andadditional-data. See their descriptions below.
Each trip child element has the following attributes:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
tag | Integer | Conditional Requirement: Required if airline-data is present. | The sequence of this journey in journeys. |
seq | Integer | Conditional Requirement: Required if airline-data is present. | The sequence of this trip or layover within a journey from end to end. |
origin
originParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
external-id | String | Conditional Requirement: Required if airline-data is present. | The IATA code of the airport where the journey originates. |
country-id | Integer | Conditional Requirement: Required if airline-data is present. | The ISO numeric country code of the place where the journey originates. |
time-zone | String, in +/-HH:MM format | Conditional 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. |
terminal | String | Optional | The airport terminal at which the journey originates. |
The origin element has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| origin | String | Required | The place where the journey originates. |
destination
destinationParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
external-id | String | Conditional Requirement: Required if airline-data is present. | The IATA code of the airport at the destination. |
country-id | Integer | Conditional Requirement: Required if airline-data is present. | The ISO numeric country code of the destination. |
time-zone | String, in +/-HH:MM format | Conditional Requirement: Required if airline-data is present. | The time zone of the destination. The time zone is offset; for example,+08:00. |
terminal | String | Optional |
The destination element has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| destination | String | Required | The destination of the journey. |
departure-time
departure-timeParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| departure time | String | Conditional Requirement: Required if airline-data is present. | The departure time of the flight from its origin, in GMT. |
arrival-time
arrival-timeParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| arrival time | String | Conditional Requirement: Required if airline-data is present. | The arrival time of the flight at its destination, in GMT. |
booking-class
booking-classParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| booking class | String | Conditional Requirement: Required if airline-data is present. | The booking class (RBD – first letter of fare-basis). For example, H. |
service-level
service-levelParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| service level | String | Conditional Requirement: Required if airline-data is present. | The cabin class. For example, Economy. |
transportation
transportationParents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip
Note the following:
- The
transportationelement is required ifairline-datais present; it provides transportation information for the travel itinerary. - The
transportationelement has one child:carriers. See thecarriersdescription below.
The transportation element has the following attributes:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
code | String | Conditional Requirement: Required if airline-data is present. | The marketing airline code for transportation. For example, 5J, PR, OD, and AV. |
number | Integer | Conditional Requirement: Required if airline-data is present. | The operating flight number. |
carriers
carriersParents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip: transportation
Please note:
-
The
carrierselement is required ifairline-datais present; it provides information on carriers used in this journey. -
Each
carrierselement must have at least onecarrierchild; it may have multiplecarrierchildren. -
Each
carrierchild element has one child:number.
The carrier child element has the following attributes:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
code | String | Conditional Requirement: Required if airline-data is present. | The code for the operating airline. For example, PROD, and AV. |
type-id | Integer | Conditional Requirement: Required if airline-data is present. | Aircraft type information. |
Each number child element has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| flight number | Integer | Conditional Requirement: Required if airline-data is present. | The flight number in the airline's system. |
additional-data
additional-dataParents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip
Please note:
-
The
additional-dataelement is optional; it provides additional data about the trip. -
The
additional-dataelement may contain multipleparamchildren.
Each param child element has the following attributes:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
name | String | Optional | The name of a parameter providing additional information, such as fare_basis. |
Each param child element has the following text content:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| parameter value | String | Optional | The value of the parameter defined in name. |
amount
amountParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| amount | Integer | Required | The total amount for an order. |
quantity
quantityParents: 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| quantity | Integer | Optional | The quantity of this line item. Default value is 1. |
additional-data
additional-dataParents: root: update-order-data: transaction: orders: line-item
Please note:
-
The
additional-dataelement is optional; it provides additional data about the line item. -
The
additional-dataelement may contain multipleparamchildren.
Each param child element has the following attributes:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
name | Integer | Optional | The 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:
| Parameter | Format | Requirement | Description |
|---|---|---|---|
| parameter value | String | Optional | The value of the parameter defined in name. |
Updated 3 months ago
