Display Order Data

JSON Object used to convey Order Details for HPP display.

Merchants from a specific domain, such as airlines, may want to display booking information to customers after they make payment. For example, they can display ticket details along with address of a customer. CellPoint's HPP supports this.

Sample Request

The following is a sample of an airline data request.

{
  "order": {
    "line_items": {
      "line_item": [
        {
          "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"
              }
            ]
          },
          "amount": "10022",
          "product": {
            "airline_data": {
              "billing_summary": {
                "add_ons": {
                  "add_on": [
                    {
                      "amount": "110",
                      "currency": "PHP",
                      "description": "Localization Key - SEAT PRICE",
                      "product_category": "Service",
                      "product_code": "SEAT",
                      "product_item": "4C",
                      "profile_seq": "1",
                      "trip_seq": "1",
                      "trip_tag": "1"
                    },
                    {
                      "amount": "10",
                      "currency": "PHP",
                      "description": "Localization Key - SEAT TAX",
                      "product_category": "Tax",
                      "product_code": "SEAT",
                      "product_item": "4C",
                      "profile_seq": "2",
                      "trip_seq": "1",
                      "trip_tag": "1"
                    },
                    {
                      "amount": "110",
                      "currency": "PHP",
                      "description": "Localization Key - MEAL Price",
                      "product_category": "Service",
                      "product_code": "MEAL",
                      "product_item": "VEG MEAL",
                      "profile_seq": "1",
                      "trip_seq": "1",
                      "trip_tag": "1"
                    },
                    {
                      "amount": "110",
                      "currency": "PHP",
                      "description": "Localization Key - MEAL Price",
                      "product_category": "Service",
                      "product_code": "MEAL",
                      "product_item": "Sandwich",
                      "profile_seq": "2",
                      "trip_seq": "1",
                      "trip_tag": "1"
                    },
                    {
                      "amount": "110",
                      "currency": "PHP",
                      "description": "Localization Key - Bicycle",
                      "product_category": "Special Service",
                      "product_code": "MISC",
                      "product_item": "Bicycle",
                      "profile_seq": "1",
                      "trip_seq": "1",
                      "trip_tag": "1"
                    },
                    {
                      "amount": "110",
                      "currency": "PHP",
                      "description": "Localization Key - GOLF Eqp",
                      "product_category": "Special Service",
                      "product_code": "MISC",
                      "product_item": "Golf Eqp.",
                      "profile_seq": "1",
                      "trip_seq": "1",
                      "trip_tag": "1"
                    },
                    {
                      "amount": "0",
                      "currency": "PHP",
                      "description": "Localization Key - Wheel Chair",
                      "product_category": "Special Service",
                      "product_code": "WCHR",
                      "product_item": "Wheel Chair",
                      "profile_seq": "1",
                      "trip_seq": "0",
                      "trip_tag": "0"
                    },
                    {
                      "amount": "40",
                      "currency": "PHP",
                      "description": "Localization Key - Travel Assitance",
                      "product_category": "Service",
                      "product_code": "INS1",
                      "product_item": "INS30DAY",
                      "profile_seq": "1",
                      "trip_seq": "1",
                      "trip_tag": "1"
                    }
                  ]
                },
                "fare_detail": {
                  "fare": [
                    {
                      "amount": "110",
                      "currency": "PHP",
                      "description": "Localization Key - ADULTBASEFARE",
                      "product_category": "FARE",
                      "product_code": "BASE",
                      "product_item": "Base Fare",
                      "profile_seq": "1"
                    },
                    {
                      "amount": "10",
                      "currency": "PHP",
                      "description": "Localization Key - ADULTBASEFARE Surcharge",
                      "product_category": "FARE",
                      "product_code": "BASE",
                      "product_item": "Internation/Domestic Surcharge",
                      "profile_seq": "1"
                    },
                    {
                      "amount": "20",
                      "currency": "PHP",
                      "description": "Localization Key - Sales Tax Colombia",
                      "product_category": "TAX",
                      "product_code": "YSTR",
                      "product_item": "Sales Tax Colombia",
                      "profile_seq": "1"
                    },
                    {
                      "amount": "20",
                      "currency": "PHP",
                      "description": "Localization Key - International Airport Facility Charge Colombia",
                      "product_category": "TAX",
                      "product_code": "COAE",
                      "product_item": "International Airport Facility Charge Colombia",
                      "profile_seq": "1"
                    },
                    {
                      "amount": "70.89",
                      "currency": "PHP",
                      "description": "Localization Key - CHILDBASEFARE",
                      "product_category": "FARE",
                      "product_code": "BASE",
                      "product_item": "Base Fare",
                      "profile_seq": "2"
                    },
                    {
                      "amount": "10",
                      "currency": "PHP",
                      "description": "Localization Key - CHILDTAX",
                      "product_category": "TAX",
                      "product_code": "",
                      "product_item": "Tax Child",
                      "profile_seq": "2"
                    }
                  ]
                }
              },
              "profiles": {
                "profile": [
                  {
                    "additional_data": {
                      "param": [
                        {
                          "name": "loyality_id",
                          "text": "value"
                        },
                        {
                          "name": "passenger_tier",
                          "text": "value"
                        },
                        {
                          "name": "passport_no",
                          "text": "value"
                        }
                      ]
                    },
                    "contact_info": {
                      "email": "[email protected]",
                      "mobile": {
                        "country_id": "640",
                        "text": "5577868383"
                      }
                    },
                    "first_name": "firstname1",
                    "last_name": "lastname1",
                    "seq": "1",
                    "title": "Mr",
                    "type": "ADT"
                  },
                  {
                    "additional_data": {
                      "param": [
                        {
                          "name": "passport_no",
                          "text": "value"
                        }
                      ]
                    },
                    "contact_info": {
                      "email": "[email protected]",
                      "mobile": {
                        "country_id": "640",
                        "text": "5577868383"
                      }
                    },
                    "first_name": "Passanger2",
                    "last_name": "last2",
                    "seq": "2",
                    "title": "Mr",
                    "type": "CHD"
                  }
                ]
              },
              "trips": {
                "trip": [
                  {
                    "additional_data": {
                      "param": [
                        {
                          "name": "NONSTOP",
                          "text": "Yes"
                        },
                        {
                          "name": "fare_basis",
                          "text": "EGHN46"
                        }
                      ]
                    },
                    "arrival_time": "2020-05-16T13:05:00",
                    "booking_class": "E",
                    "departure_time": "2020-05-15T23:25:00",
                    "destination": {
                      "country_id": "648",
                      "external_id": "BKK",
                      "terminal": "2",
                      "text": "Bangkok",
                      "time_zone": "+8:00"
                    },
                    "origin": {
                      "country_id": "608",
                      "external_id": "DXB",
                      "terminal": "1",
                      "text": "Dubai",
                      "time_zone": "+8:00"
                    },
                    "seq": "1",
                    "service_level": "XL",
                    "tag": "1",
                    "transportation": {
                      "carriers": {
                        "carrier": [
                          {
                            "code": "AV",
                            "number": "123",
                            "type": "Aircraft Boeing-737-9"
                          }
                        ]
                      },
                      "code": "AV",
                      "number": "123"
                    }
                  },
                  {
                    "additional_data": {
                      "param": [
                        {
                          "name": "fare_basis",
                          "text": "EGHN46"
                        }
                      ]
                    },
                    "arrival_time": "2020-05-20T21:40:00",
                    "booking_class": "E",
                    "departure_time": "2020-05-20T16:40:00",
                    "destination": {
                      "country_id": "608",
                      "external_id": "DXB",
                      "text": "Dubai International Airport - Terminal 2",
                      "time_zone": "+8:00"
                    },
                    "origin": {
                      "country_id": "648",
                      "external_id": "BKK",
                      "text": "Bangkok International Airport - Terminal 3",
                      "time_zone": "+8:00"
                    },
                    "seq": "1",
                    "service_level": "XL",
                    "tag": "2",
                    "transportation": {
                      "carriers": {
                        "carrier": [
                          {
                            "code": "AV",
                            "number": "123",
                            "type": "Aircraft Boeing-737-9"
                          }
                        ]
                      },
                      "code": "AV",
                      "number": "123"
                    }
                  }
                ]
              }
            },
            "description": "DXB-BKK:BKK-DXB",
            "name": "RETURN",
            "sku": "ODERWS"
          }
        }
      ]
    },
    "shipping": {
      "city": "str1234",
      "country": "826",
      "name": "str1234",
      "state": "str1234",
      "street": "str1234",
      "street2": "str1234",
      "zip": "30303"
    }
  }
}

Order Parameters

The following tables provide descriptions of the parameters in an airline data request.

ParameterTypeRequiredDescription
shippingStringNoShipping address. Refer to 'Shipping Parameters,' below, for details.
line_itemsStringYesThe detailed information of the travel itinerary, which includes an array of line_item. Refer to 'Line-item Parameters,' below, for details.

Shipping Parameters

The following table provides a description of the parameters in shipping:

ParameterTypeRequiredDescription
nameStringYesThe name of a customer.
streetStringYesThe first line of the address.
street2StringNoThe second line of the address.
cityStringYesThe city name.
stateStringYesThe state name.
zipIntegerYesThe zip code.
countryIntegerYesThe ISO numeric country code.

Line-item Parameters

The following table provides a description of the parameters in line_items:

ParameterTypeRequiredDescription
productStringYesThe detailed information of travel itinerary, which includes:

• Fare information
• Traveller information
• Trip Information

Refer to 'Product Parameters,' below for details.
amountNumberYesThe total amount of an order.
pointsIntegerNoThe loyalty points used for this order by a customer.
rewardIntegerNoThe reward points used for this order by a customer.
quantityIntegerNoThe quantity of this line item. The default value is 1.
additional_dataStringNoInsert additional information here. For example, its key value data structure accepts values for parameters such as deviceFingerPrint, info_cust_url, office_id, flexi_search, and lowest_fare.

Product Parameters

The following table provides a description of the parameters in product:

ParameterTypeRequiredDescription
skuIntegerYesThe short code for travel itinerary. For example, PNR and order number.
nameStringYesThe name of a journey. For example, ONEWAY, RETURN, MULTICITY, MYB, and OLCI.
descriptionStringNoThe description of travel itinerary
Image_urlStringNoThe image URL of the product.
airline_dataStringNoThe low-level information of travel itinerary, which includes:

• Fare information
• Traveller information
• Trip information

Refer to 'Airline-data Parameters,' below for details.

Airline-data Parameters

The following table provides a description of the parameters in airline_data:

ParameterTypeRequiredDescription
profilesArrayYesAn array of profile object, which provides traveller information for the travel itinerary. Refer to 'Profile Parameters,' below, for details.
billing_summaryArrayNoAn array of billing summary, which provides billing details of a journey. Refer to 'Billing Summary Parameters,' below, for details.
tripsArrayYesAn array of the trip object, which provides trip information for the travel itinerary. Refer to 'Trip Parameters,' below, for details.

Profile Parameters

The following table provides a description of the parameters in profiles:

ParameterTypeRequiredDescription
seqIntegerYesThe sequence number of a passenger.
titleStringYesThe title of a passenger. For example, Mr., Mrs., or Ms.
first_nameStringYesThe first name of a passenger.
last_nameStringYesThe last name of a passenger.
typeStringYesThe type of a passenger. For example, adult, child, or infant. Refer to Passenger Type Codes in 'Sub-parameters,' below, for details.
contact_infoStringYesThe object which contains the following contact information of a passenger:

• email
• mobile

Refer to Contact-info Sub-parameters, below, for details
Additional_dataStringNoThe additional passenger information related to a passenger profile such as loyalty number, passenger tier, and passport number.

Billing Summary Parameters

The following table provides a description of the parameters in billing_summary:

ParameterTypeRequiredDescription
fare_detailStringYesThe fare details of a journey.
add_onsStringYesThe additional information of a journey. Refer to Add_on Sub-parameters, below, for details.

Trip Parameters

The following table provides a description of the parameters in trips:

ParameterTypeRequiredDescription
tagStringYesThe sequence of this journey in journeys.
seqStringYesThe sequence of this trip or layover within a journey from end to end.
originObjectYesAn object of location object which provides location information for the travel itinerary. Refer to Origin Sub-parameters, below, for details.
destinationObjectYesAn object that provides location information for the travel itinerary. Refer to Destination Sub-parameters, below, for details
departure_timeStringYesThe departure time of flight from origin in local time.
arrival_timeStringYesThe arrival time of flight on destination in local time.
booking_classStringYesThe booking class (RBD – first letter of fare-basis). For example, H.
service_levelStringYesThe cabin class opted. For example, XL, X, M, or S.
transportationArrayYesAn array that provides transportation information for the travel itinerary. Refer to Transportation Sub-parameters for details.
additional_dataStringNoAdditional trip details. For example, fare_basis and non-stop.


Sub-parameters

The tables below describe sub-parameters used in an airline data request.

Contact-info Sub-parameters

The following table provides a description of the sub-parameters in contact_info:

ParameterTypeRequiredDescription
emailStringYesThe email ID of a passenger.
mobileIntegerYesThe mobile number of a passenger along with the country ID. It contains the sub-parameters country_id and text. Refer to Mobile Sub-parameters, below, for details.

Fare Details Sub-parameters

The following table provides a description of the sub-parameters in fare:

ParameterTypeRequiredDescription
profile_seqIntegerYesThe sequence number of a passenger linked to this fare component.
descriptionStringYesThe description of the fare.
currencyNumberYesThe alpha3 ISO currency code of the fare amount.
product_codeIntegerYesThe product code of item.
product_categoryIntegerYesThe product code of category.
product_itemStringYesThe product name.
amountNumberYesThe amount charged for the product. This can be a decimal value.

🚧

Note: Fare components are associated with the profile sequence number (profile_seq); for example, to each passenger traveling. Each fare component should be repeated for each passenger.

Add-on Sub-parameters

The following table provides a description of the sub-parameters in add_ons:

ParameterTypeRequiredDescription
profile_seqIntegerNoThe sequence number of a passenger linked to this add-on.

Note: This parameter is mandatory only if it is associated with a passenger.
trip_tagIntegerNoThe 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_seqIntegerNoThe trip sequence number to identify the leg of the trip.

Note: This parameter is mandatory if add-on is associated with the leg of trip.
descriptionStringYesThe description of the add-on parameters.
currencyNumberYesThe alpha3 ISO currency code of the fare amount.
product_codeIntegerYesThe code number to identify the add-on product.
product_categoryIntegerYesThe code number to identify the add-on product category.
product_itemIntegerYesThe code number to identify the add-on product item.
amountNumberYesThe amount paid for the add-on product. It can be a decimal value.

🚧

Note:

  • Add-ons can be associated with the passenger, booking, or a particular leg of the booking by using the associated profile_seq, trip_tag and trip_seq.
  • The product_category value Service will be the service, and the value Tax will be the tax for the add-on price.

Origin Sub-parameters

The following table provides a description of the sub-parameters in origin:

ParameterTypeRequiredDescription
external_idStringYesThe IATA code of an airport.
country_idIntegerYesThe ISO numeric country code.
time_zoneStringYesThe time zone of the place where a journey originates. The time zone is offset. For example, +08:00.
textStringYesThe name of the city.
terminalIntegerYesThe terminal number.

Destination Sub-parameters

The following table provides a description of the sub-parameters in destination:

ParameterTypeRequiredDescription
external_idStringYesThe IATA code of airport.
country_idIntegerYesThe ISO numeric country code.
time_zoneStringYesThe time zone of the destination. The time zone is offset. For example, +08:00.
textStringYesThe name of the city.
terminalIntegerYesThe terminal number.

Transportation Sub-parameters

The following table provides a description of the sub-parameters in transportation:

ParameterTypeRequiredDescription
codeStringYesThe marketing airline code for transportation. For example, 5J, PR, OD, or AV.
numberNumberYesThe operating flight number.
carriersArrayYesThe array of a carrier used in this journey. Refer to Carrier Sub-parameters for details.

Mobile Sub-parameters

The following table provides a description of the sub-parameters in mobile:

ParameterTypeRequiredDescription
country_idIntegerYesThe three-digit numeric ISO country code of the mobile number country
textStringYesThe mobile number of a passenger.

Carrier Sub-parameters

The following table provides a description of the sub-parameters in contact_info:

ParameterTypeRequiredDescription
typeStringYesThe aircraft type information. For example, Aircraft Boeing-737-9.
codeStringYesThe code for operating airline. For example, PR, OD, or AV.
numberNumberYesThe flight number of an airline.

Passenger Type Codes

The following tables provides the applicable codes for passenger types (type):

TypeCodeDescription
ADTAdult
CDSenior Citizen
CHDChild
INFInfant with FAA Seat
LIEXIPSC Exempted ADT w/o doc
LIXCIPSC Exempted – Child
NRMRNon-revenue PSMR
NRSANon-revenue SA
NRSQNon-revenue SQ
PWDPax with Disability
SDStudent – Adult
SDCStudent – Child
VOUVOU PSMR
BBAG2ND Checked Bag 23 KG
CBAG3rd Checked Bag or More 23 KG
HBAGPrepaid Overweight
SPEQGolf Equipment
SPEQSki Equipment
SPEQBicycle
SPEQScuba Equipment
SPEQSurfboard up to 70 LB 32 KG
SPEQWindsurf Equip up to 70 LB 32 KG
SPEQKite Surfboard up to 22 LB 10 KG
PETCPet in Cabin
AVIHPet in Hold
ASSTTravel Assistance
UMNRUnaccompanied Minor
BLNDBlind Passenger Information
BSCTBassinet/Baby Cot Request
DEAFDeaf Passenger Information
DEPAAccompanied Deportee Information
DEPUDeportee – Accompanied by an Escort
DOCAPassenger Crew Address Information
DOCOPassenger/Crew Other Travel Related Info
DOCSPassenger/Crew Other Travel Document Info
DPNADisabled Passenger Needing Assistance
ESANPassenger with Emotional Support/Psychiatric Assistance
FOIDForm of Identification for eTicket
MEDAMedical Assistance Information
MEQTMedical Equipment
SVANPassenger with Service Animal in Cabin
WCBDWheelchair Dry-cell Battery Request
WCBWWheelchair Wet-cell Battery Request
WCHCWheelchair to Seat Request
WCHRWheelchair to Aircraft Door Request
WCHSWheelchair Up/Down Stairs Request
WCLBWheelchair Lithium-Ion Battery Request
WCMPWheelchair Manual Powered Request
WCOBWheelchair on Board Request
TIMETime to Think