Flight Ticket

This page describes the extended dataInfo for flight ticket scenarios, please also check the base API.

Please be aware below UI snapshots may not be the latest, you should refer to the actual APP UI as the final version.

image.png

Request parameters

$airlineName_zh_HK$ string  REQUIRED

Name of the airline.

More information:

  • Maximum length: 250 characters

$airlineName_en_US$ string  REQUIRED

Name of the airline.

More information:

  • Maximum length: 500 characters

$airlineLogo_zh_HK$ string  

An URL reference of airline logo.

More information:

  • Maximum length: 256 characters
  • Value range: <100 KB

$airlineLogo_en_US$ string  

An URL reference of airline logo.

More information:

  • Maximum length: 256 characters
  • Value range: <100 KB

$from_zh_HK$ string  REQUIRED

Name of the departure station.

Suggest to provide name of city appending with name of airport.

More information:

  • Maximum length: 24 characters

$from_en_US$ string  REQUIRED

Name of the departure station.

Suggest to provide name of city appending with name of airport.

More information:

  • Maximum length: 48 characters

$to_zh_HK$ string  REQUIRED

Name of the arrival station.

Suggest to provide name of city appending with name of airport.

More information:

  • Maximum length: 24 characters

$to_en_US$ string  REQUIRED

Name of the departure station.

Suggest to provide name of city appending with name of airport.

More information:

  • Maximum length: 48 characters

$fromAddress_zh_HK$ string  REQUIRED

Address of the departure station.

More information:

  • Maximum length: 250 characters

$fromAddress_en_US$ string  REQUIRED

Address of the departure station.

More information:

  • Maximum length: 500 characters

$toAddress_zh_HK$ string  REQUIRED

Address of the arrival station.

More information:

  • Maximum length: 250 characters

$toAddress_en_US$ string  REQUIRED

Address of the arrival station.

More information:

  • Maximum length: 500 characters

$startTime_zh_HK$ number  REQUIRED

Departure datetime in milliseconds.

$startTime_en_US$ number  REQUIRED

Departure datetime in milliseconds.

$endTime_zh_HK$ number  REQUIRED

Arrival datetime in milliseconds.

$endTime_en_US$ number  REQUIRED

Arrival datetime in milliseconds.

$shiftNumber_zh_HK$ string  REQUIRED

The flight number.

$shiftNumber_en_US$ string  REQUIRED

The flight number.

$passengerInfoList_zh_HK$ Array<object>  

List of passengers information.

More information:

  • Maximum size: 9 elements
Show child parameters

$passengerInfoList_en_US$ Array<object>  

List of passengers information.

More information:

  • Maximum size: 9 elements
Show child parameters

$platformName_zh_HK$ string  

Name of the platform / agency.

More information:

  • Maximum length: 32 characters

$platformName_en_US$ string  

Name of the platform / agency.

More information:

  • Maximum length: 64 characters

$platformLogo_zh_HK$ string  

An URL redirects to the logo of the platform / agency.

More information:

  • Maximum length: 256 characters
  • Value range: <100 KB

$platformLogo_en_US$ string  

An URL redirects to the logo of the platform / agency.

More information:

  • Maximum length: 256 characters
  • Value range: <100 KB

$fromTimeZone_zh_HK$ string  

Time zone of the departure station, i.e. GMT+8.

$fromTimeZone_en_US$ string  

Time zone of the departure station, i.e. GMT+8.

$toTimeZone_zh_HK$ string  

Time zone of the arrival station, i.e. ​​GMT+6​.

$toTimeZone_en_US$ string  

Time zone of the arrival station, i.e. GMT+6.

Response parameters

No request parameters.
API Explorer

Request

Request Body

Response

Response Body