Order Data
7. Order Data
Merchants from a specific domain, such as airlines, want to display booking information to customers after they make payment. For example, displaying ticket details along with address of a customer. The following is a sample of an airline data request.
{
"order":{
"shipping": {
"name": "str1234",
"street": "str1234",
"street2": "str1234",
"city": "str1234",
"state": "str1234",
"zip": "30303",
"country": "826"
},
"line_items":{
"line_item":[
{
"product":{
"sku":"ODERWS",
"name":"RETURN",
"description":"DXB-BKK:BKK-DXB",
"airline_data":{
"profiles":{
"profile":[
{
"seq":"1",
"title":"Mr",
"first_name":"firstname1",
"last_name":"lastname1",
"type":"ADT",
"contact_info":{
"email":"[email protected]",
"mobile":{
"country_id":"640",
"text":"5577868383"
}
},
"additional_data":{
"param":[
{
"name":"loyality_id",
"text":"value"
},
{
"name":"passenger_tier",
"text":"value"
},
{
"name":"passport_no",
"text":"value"
}
]
}
},
{
"seq":"2",
"title":"Mr",
"first_name":"Passanger2",
"last_name":"last2",
"type":"CHD",
"contact_info":{
"email":"[email protected]",
"mobile":{
"country_id":"640",
"text":"5577868383"
}
},
"additional_data":{
"param":[
{
"name":"passport_no",
"text":"value"
}
]
}
}
]
},
"billing_summary":{
"fare_detail":{
"fare":[
{
"description":"Localization Key - ADULTBASEFARE",
"currency":"PHP",
"amount":"110",
"profile_seq":"1",
"product_code":"BASE",
"product_category":"FARE",
"product_item":"Base Fare"
},
{
"description":"Localization Key - ADULTBASEFARE Surcharge",
"currency":"PHP",
"amount":"10",
"profile_seq":"1",
"product_code":"BASE",
"product_category":"FARE",
"product_item":"Internation/Domestic Surcharge"
},
{
"description":"Localization Key - Sales Tax Colombia",
"currency":"PHP",
"amount":"20",
"profile_seq":"1",
"product_code":"YSTR",
"product_category":"TAX",
"product_item":"Sales Tax Colombia"
},
{
"description":"Localization Key - International Airport Facility Charge Colombia",
"currency":"PHP",
"amount":"20",
"profile_seq":"1",
"product_code":"COAE",
"product_category":"TAX",
"product_item":"International Airport Facility Charge Colombia"
},
{
"description":"Localization Key - CHILDBASEFARE",
"currency":"PHP",
"amount":"70.89",
"profile_seq":"2",
"product_code":"BASE",
"product_category":"FARE",
"product_item":"Base Fare"
},
{
"description":"Localization Key - CHILDTAX",
"currency":"PHP",
"amount":"10",
"profile_seq":"2",
"product_code":"",
"product_category":"TAX",
"product_item":"Tax Child"
}
]
},
"add_ons":{
"add_on":[
{
"description":"Localization Key - SEAT PRICE",
"currency":"PHP",
"amount":"110",
"profile_seq":"1",
"trip_tag":"1",
"trip_seq":"1",
"product_code":"SEAT",
"product_category":"Service",
"product_item":"4C"
},
{
"description":"Localization Key - SEAT TAX",
"currency":"PHP",
"amount":"10",
"profile_seq":"2",
"trip_tag":"1",
"trip_seq":"1",
"product_code":"SEAT",
"product_category":"Tax",
"product_item":"4C"
},
{
"description":"Localization Key - MEAL Price",
"currency":"PHP",
"amount":"110",
"profile_seq":"1",
"trip_tag":"1",
"trip_seq":"1",
"product_code":"MEAL",
"product_category":"Service",
"product_item":"VEG MEAL"
},
{
"description":"Localization Key - MEAL Price",
"currency":"PHP",
"amount":"110",
"profile_seq":"2",
"trip_tag":"1",
"trip_seq":"1",
"product_code":"MEAL",
"product_category":"Service",
"product_item":"Sandwich"
},
{
"description":"Localization Key - Bicycle",
"currency":"PHP",
"amount":"110",
"profile_seq":"1",
"trip_tag":"1",
"trip_seq":"1",
"product_code":"MISC",
"product_category":"Special Service",
"product_item":"Bicycle"
},
{
"description":"Localization Key - GOLF Eqp",
"currency":"PHP",
"amount":"110",
"profile_seq":"1",
"trip_tag":"1",
"trip_seq":"1",
"product_code":"MISC",
"product_category":"Special Service",
"product_item":"Golf Eqp."
},
{
"description":"Localization Key - Wheel Chair",
"currency":"PHP",
"amount":"0",
"profile_seq":"1",
"trip_tag":"0",
"trip_seq":"0",
"product_code":"WCHR",
"product_category":"Special Service",
"product_item":"Wheel Chair"
},
{
"description":"Localization Key - Travel Assitance",
"currency":"PHP",
"amount":"40",
"profile_seq":"1",
"trip_tag":"1",
"trip_seq":"1",
"product_code":"INS1",
"product_category":"Service",
"product_item":"INS30DAY"
}
]
}
},
"trips":{
"trip":[
{
"tag":"1",
"seq":"1",
"origin":{
"country_id":"608",
"external_id":"DXB",
"text":"Dubai",
"time_zone":"+8:00",
"terminal":"1"
},
"destination":{
"country_id":"648",
"external_id":"BKK",
"text":"Bangkok",
"time_zone":"+8:00",
"terminal":"2"
},
"departure_time":"2020-05-15T23:25:00",
"arrival_time":"2020-05-16T13:05:00",
"booking_class":"E",
"service_level":"XL",
"transportation":{
"code":"AV",
"number":"123",
"carriers":{
"carrier":[
{
"type":"Aircraft Boeing-737-9",
"code":"AV",
"number":"123"
}
]
}
},
"additional_data":{
"param":[
{
"name":"NONSTOP",
"text":"Yes"
},
{
"name":"fare_basis",
"text":"EGHN46"
}
]
}
},
{
"tag":"2",
"seq":"1",
"origin":{
"country_id":"648",
"external_id":"BKK",
"text":"Bangkok International Airport - Terminal 3",
"time_zone":"+8:00"
},
"destination":{
"country_id":"608",
"external_id":"DXB",
"text":"Dubai International Airport - Terminal 2",
"time_zone":"+8:00"
},
"departure_time":"2020-05-20T16:40:00",
"arrival_time":"2020-05-20T21:40:00",
"booking_class":"E",
"service_level":"XL",
"transportation":{
"code":"AV",
"number":"123",
"carriers":{
"carrier":[
{
"type":"Aircraft Boeing-737-9",
"code":"AV",
"number":"123"
}
]
}
},
"additional_data":{
"param":[
{
"name":"fare_basis",
"text":"EGHN46"
}
]
}
}
]
}
}
},
"amount":"10022",
"additional_data":{
"param":[
{
"name":"pnr_creation_date",
"text":"2021-05-07 08:40:00"
}, {
"name":"flight_sel_url",
"text":"URL"
},
{
"name":"info_cust_url",
"text":"URL"
},
{
"name":"office_id",
"text":"DEAVSLK"
},
{
"name":"promo_code",
"text":"DEAV323"
},
{
"name":"flexi_search",
"text":"Yes"
},
{
"name":"lowest_fare",
"text":"Yes"
}
]
}
}
]
}
}
}
7.1 Description of Order Parameters
The following table provides a description of the parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| shipping | String | No | Shipping address. Refer to Shipping Parameter Details for details. |
| line_items | String | Yes | The detailed information of the travel itinerary, which includes an array of line_item. Refer to Line_item Parameters for details. |
7.2 Shipping Parameter Details
The following table provides a description of the parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | String | Yes | The name of a customer. |
| street | String | Yes | The first line of the address. |
| street2 | String | No | The second line of the address. |
| city | String | Yes | The city name. |
| state | String | Yes | The state name. |
| zip | Integer | Yes | The zip code. |
| country | Integer | Yes | The ISO numeric country code. |
7.3 Line-item Parameters
The following table provides a description of the parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| product | String | Yes | The detailed information of travel itinerary, which includes:
|
| amount | Number | Yes | The total amount of an order. |
| points | Integer | No | The loyalty points used for this order by a customer. |
| reward | Integer | No | The reward points used for this order by a customer. |
| quantity | Integer | No | The quantity of this line item. The default value is 1. |
| additional_data | String | No | Insert additional information here. For example, its key value data structure which accepts values for parameters as deviceFingerPrint, info_cust_url, office_id, flexi_search, lowest_fare. |
7.4 Product Parameters
The following table provides a description of the parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| sku | Integer | Yes | The short code for travel itinerary. For example, PNR and order number. |
| name | String | Yes | The name of a journey. For example, ONEWAY, RETURN, MULTICITY, MYB, and OLCI. |
| description | String | No | The description of travel itinerary |
| Image_url | String | No | The image URL of the product. |
| airline_data | String | No | The low-level information of travel itinerary, which includes:
|
7.5 Airline-data Parameters
The following table provides a description of the parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| profiles | Array | Yes | An array of profile object, which provides traveller information for the travel itinerary. Refer to Profile Parameters for details. |
| billing_summary | Array | No | An array of billing summary, which provides billing details of a journey. Refer to Billing Summary Parameters for details. |
| trips | Array | An array of the trip object, which provides trip information for the travel itinerary. Refer to Trip Parameters for details. |
7.6 Profile Parameters
The following table provides a description of the parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| seq | Integer | Yes | The sequence number of a passenger. |
| title | String | Yes | The title of a passenger. For example, Mr., Mrs., or Ms. |
| first_name | String | Yes | The first name of a passenger. |
| last_name | String | Yes | The last name of a passenger. |
| type | String | Yes | The type of a passenger. For example, adult, child, or infant. Refer to Passenger Type Codes for details. |
| contact_info | String | Yes | The object which contains the following contact information of a passenger:
|
| Additional_data | String | No | The additional passenger information related to a passenger profile such as loyalty number, passenger tier, and passport number. |
7.7 Billing Summary Parameters
The following table provides a description of the parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| fare_detail | String | Yes | The fare details of a journey. |
| add_ons | String | Yes | The additional information of a journey. Refer to Add_on Sub-parameters for details. |
7.8 Trip Parameters
The following table provides a description of the parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| tag | String | Yes | The sequence of this journey in journeys. |
| seq | String | Yes | The sequence of this trip or layover within a journey from end to end. |
| origin | Object | Yes | An object of location object which provides location information for the travel itinerary. Refer to Origin Sub-parameters for details. |
| destination | Object | Yes | An object of location object which provides location information for the travel itinerary. Refer to Destination Sub-parameters for details |
| departure_time | String | Yes | The departure time of flight from origin in local time. |
| arrival_time | String | Yes | The arrival time of flight on destination in local time. |
| booking_class | String | Yes | The booking class (RBD – first letter of fare-basis). For example, H. |
| service_level | String | Yes | The cabin class opted. For example, XL, X, M, or S. |
| transportation | Array | Yes | An array of destination location object, which provides location information for the travel itinerary. Refer to Transportation Sub-parameters for details. |
| additional_data | String | No | The additional data which contains additional trip details. For example, fare_basis and non-stop. |
7.9 Description of Sub-parameters
7.9.1 Contactinfo Sub-parameters
The following table provides a description of the sub-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| String | Yes | The email ID of a passenger. | |
| mobile | Integer | Yes | The mobile number of a passenger along with the country ID. It contains the sub-parameters country_id and mobile. Refer to Mobile Sub-parameters for details. |
7.9.2 Fare Details Sub-parameters
The following table provides a description of the sub-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| profile_seq | Integer | Yes | The sequence number of a passenger linked to this fare component. |
| description | String | Yes | The description of the fare. |
| currency | Number | Yes | The alpha3 ISO currency code of the fare amount. |
| product_code | Integer | Yes | The product code of item. |
| product_category | Integer | Yes | The product code of category. |
| product_item | String | Yes | The product name. |
| amount | Number | Yes | The amount charged for the product. It can be a decimal value. |
Note: Fare components are associated with the profile sequence number, for example, to each passenger traveling. Each Fare component should be repeated for each passenger.
7.9.3 Add-on Sub-parameters
The following table provides a description of the sub-parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| profile_seq | Integer | No | The sequence number of a passenger linked to this add-on. Note: This parameter is mandatory only if it is associated with a passenger. |
| trip_tag | Integer | No | The tag number associated with a trip, which helps identify a trip. Note: This parameter is mandatory only if an add-on is associated with a trip. |
| trip_seq | Integer | No | The trip sequence number to identify the leg of the trip. Note: This parameter is mandatory if add-on is associated with the leg a of trip. |
| description | String | Yes | The description of the add-on parameters. |
| currency | Number | Yes | The alpha3 ISO currency code of the fare amount. |
| product_code | Integer | Yes | The code number to identify the add-on product. |
| product_category | Integer | Yes | The code number to identify the add-on product category. |
| product_item | Integer | Yes | The code number to identify the add-on product item. |
| amount | Number | Yes | The amount paid for the add-on product. It can be a decimal value. |
Note:
- Add-ons can be associated with the passenger, booking, or particular leg of the booking by using the association profile_seq, trip_tag and trip_seq.
- The Product category will be the Service and Tax will be the tax for the add-on price.
7.9.4 Origin Sub-parameters
The following table provides a description of the sub-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | String | Yes | The IATA code of an airport. |
| country_id | Integer | Yes | The ISO numeric country code. |
| time_zone | String | Yes | The time zone of the place where a journey originates. The time zone is offset. For example, +08:00 |
| text | String | Yes | The name of the city. |
| terminal | Integer | Yes | The terminal number. |
7.9.5 Destination Sub-parameters
The following table provides a description of the sub-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | String | Yes | The IATA code of airport. |
| country_id | Integer | Yes | The ISO numeric country code. |
| time_zone | String | Yes | The time zone of the destination. The time zone is offset. For example, +08:00. |
| text | String | Yes | The name of the city. |
| terminal | Integer | Yes | The terminal number. |
7.9.6 Transportation Sub-parameters
The following table provides a description of the sub-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| code | String | Yes | The marketing airline code for transportation. For example, 5J, PR, OD, or AV. |
| number | Number | Yes | The operating flight number. |
| carriers | Array | Yes | The array of a carrier used in this journey. Refer to Carrier Sub-parameters for details. |
7.9.7 Mobile Sub-parameters
The following table provides a description of the sub-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| country_id | Integer | Yes | The three-digit numeric ISO country code of the mobile number country |
| text | String | Yes | The mobile number of a passenger. |
7.9.8 Carrier Sub-parameters
The following table provides a description of the sub-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| type | String | Yes | The aircraft type information. For example, Aircraft Boeing-737-9. |
| code | String | Yes | The code for operating airline. For example, PR,OD, or AV. |
| number | Number | Yes | The flight number of an airline. |
7.9.9 Passenger Type Codes
The following tables provides the applicable codes for passenger types:
| TypeCode | Description |
|---|---|
| ADT | Adult |
| CD | Senior Citizen |
| CHD | Child |
| INF | Infant with FAA Seat |
| LIEX | IPSC Exempted ADT w/o doc |
| LIXC | IPSC Exempted – Child |
| NRMR | Non-revenue PSMR |
| NRSA | Non-revenue SA |
| NRSQ | Non-revenue SQ |
| PWD | Pax with Disability |
| SD | Student – Adult |
| SDC | Student – Child |
| VOU | VOU PSMR |
| BBAG | 2ND Checked Bag 23 KG |
| CBAG | 3rd Checked Bag or More 23 KG |
| HBAG | Prepaid Overweight |
| SPEQ | Golf Equipment |
| SPEQ | Ski Equipment |
| SPEQ | Bicycle |
| SPEQ | Scuba Equipment |
| SPEQ | Surfboard up to 70 LB 32 KG |
| SPEQ | Windsurf Equip up to 70 LB 32 KG |
| SPEQ | Kite Surfboard up to 22 LB 10 KG |
| PETC | Pet in Cabin |
| AVIH | Pet in Hold |
| ASST | Travel Assistance |
| UMNR | Unaccompanied Minor |
| BLND | Blind Passenger Information |
| BSCT | Bassinet/Baby Cot Request |
| DEAF | Deaf Passenger Information |
| DEPA | Accompanied Deportee Information |
| DEPU | Deportee – Accompanied by an Escort |
| DOCA | Passenger Crew Address Information |
| DOCO | Passenger/Crew Other Travel Related Info |
| DOCS | Passenger/Crew Other Travel Document Info |
| DPNA | Disabled Passenger Needing Assistance |
| ESAN | Passenger with Emotional Support/Psychiatric Assistance |
| FOID | Form of Identification for eTicket |
| MEDA | Medical Assistance Information |
| MEQT | Medical Equipment |
| SVAN | Passenger with Service Animal in Cabin |
| WCBD | Wheelchair Dry-cell Battery Request |
| WCBW | Wheelchair Wet-cell Battery Request |
| WCHC | Wheelchair to Seat Request |
| WCHR | Wheelchair to Aircraft Door Request |
| WCHS | Wheelchair Up/Down Stairs Request |
| WCLB | Wheelchair Lithium-Ion Battery Request |
| WCMP | Wheelchair Manual Powered Request |
| WCOB | Wheelchair on Board Request |
| TIME | Time to Think |
Updated about 1 year ago