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
transaction
Parents: 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
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 oneline-item
child. It may have multipleline-item
children. See their description below.
line-item
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
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
, andairline-data
. See their descriptions below.
The product
element has the following attributes:
Parameter | Format | Requirement | Description |
---|---|---|---|
order-ref | Integer | Required | The order reference number. |
sku | String | Required | The short code for travel itinerary. For example, PNR and order number. |
type
type
Parents: 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
name
Parents: 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
description
Parents: 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-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
, andtrips
. See their descriptions below.
profiles
profiles
Parents: root: update-order-data: transaction: orders: line-item: product: airline-data
Note the following:
- The
profiles
element is required ifairline-data
is present. - The
profiles
element provides traveler information for the travel itinerary. - The
profiles
element must have at least oneprofile
child; it may have multipleprofile
children. - Each
profile
child has the following children:seq
,title
,first-name
,last-name
,type
,contact-info
, andadditional-data
. See their descriptions below.
seq
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:
Parameter | Format | Requirement | Description |
---|---|---|---|
sequence number | Integer | Conditional Requirement: Required if airline-data is present. | The sequence number of the passenger. |
title
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:
Parameter | Format | Requirement | Description |
---|---|---|---|
title | Integer | Conditional Requirement: Required if airline-data is present. | The title of the passenger. For example, Mr. , Mrs. , and Ms. |
first-name
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:
Parameter | Format | Requirement | Description |
---|---|---|---|
first name | Integer | Conditional Requirement: Required if airline-data is present. | The first name of the passenger. |
last-name
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:
Parameter | Format | Requirement | Description |
---|---|---|---|
last name | Integer | Conditional Requirement: Required if airline-data is present. | The last name of the passenger. |
type
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:
Parameter | Format | Requirement | Description |
---|---|---|---|
passenger type | Integer | 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-info
Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: profiles: profile
Please note:
-
The
contact-info
element is required ifairline-data
is present; it provides contact information for the specified passenger. -
The
contact-info
element has two children:email
andmobile
.
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-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 multipleparam
children.
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-summary
Parents: root: update-order-data: transaction: orders: line-item: product: airline-data
Note the following:
- The
billing-summary
element is required ifairline-data
is present. - The
billing-summary
element provides billing details of the journey. - The
billing-summary
element can have the following children:fare-detail
andadd-ons
. See their descriptions below.
fare-detail
fare-detail
Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: billing-summary
Please note:
-
The
fare-detail
element is required ifbilling-summary
is present; it provides fare details of the journey. -
The
fare-detail
element must have at least onefare
child; it may have multiplefare
children.
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-ons
Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: billing-summary
Please note:
-
The
add-ons
element is required ifairline-data
is present. -
The
add-ons
element provides additional information for a journey. -
The
add-ons
element must have at least oneadd-on
child; it may have multipleadd-on
children.
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
trips
Parents: root: update-order-data: transaction: orders: line-item: product: airline-data
Note the following:
- The
trips
element is required ifairline-data
is present. - The
trips
element provides trip information for the travel itinerary. - The
trips
element must have at least onetrip
child; it may have multipletrip
children. - Each
trip
child 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
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:
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
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:
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-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:
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-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:
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-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:
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-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:
Parameter | Format | Requirement | Description |
---|---|---|---|
service level | String | Conditional Requirement: Required if airline-data is present. | The cabin class. For example, Economy . |
transportation
transportation
Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip
Note the following:
- The
transportation
element is required ifairline-data
is present; it provides transportation information for the travel itinerary. - The
transportation
element has one child:carriers
. See thecarriers
description 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
carriers
Parents: root: update-order-data: transaction: orders: line-item: product: airline-data: trips: trip: transportation
Please note:
-
The
carriers
element is required ifairline-data
is present; it provides information on carriers used in this journey. -
Each
carriers
element must have at least onecarrier
child; it may have multiplecarrier
children. -
Each
carrier
child 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-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 multipleparam
children.
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
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:
Parameter | Format | Requirement | Description |
---|---|---|---|
amount | Integer | Required | The total amount for an order. |
quantity
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:
Parameter | Format | Requirement | Description |
---|---|---|---|
quantity | Integer | Optional | The quantity of this line item. Default value is 1 . |
additional-data
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 multipleparam
children.
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 11 days ago