Hướng dẫn tích hợp API

Search exchange

This feature allows searching for a list of new flights for the route the user wants to change tickets for.

Overview

Request URL: https://ibe.datacom.vn/api/flight/searchexchange
Method: POST
Data type: JSON
API Specification: See specifications

Applicable system

System code System name
VN Vietnam Airlines
QH Bamboo Airways
9G Sun Phu Quoc Airways

Request

{
    "RequestInfo": {
        "PrivateKey": "{{PrivateKey}}",
        "ApiAccount": "{{ApiAccount}}",
        "ApiPassword": "{{ApiPassword}}",
        "Currency": "{{Currency}}",
        "Language": "{{Language}}",
        "IpAddress": "{{IpAddress}}"
    },
    "System": "string",
    "Airline": "string",
    "BookingCode": "string",
    "BookingId": "string",
    "ListRoute": [
        {
            "Leg": 0,
            "StartPoint": "string",
            "EndPoint": "string",
            "DepartDate": "string"
        }
    ],
    "ListCancel": [
        {
            "Leg": 0,
            "StartPoint": "string",
            "EndPoint": "string",
            "DepartDate": "string"
        }
    ]
}

Data specification

Information field Describe Data type     Obligatory For example
RequestInfo Query information
See description Shared properties
object Yes  
System Reservation system string Yes VN
Airline
Airline
string
Yes
1
BookingCode
Booking Code
string
Yes
0

BookingId

Booking ID
string
Yes
 

ListRoute

List Route array[] Yes  

      Leg

Leg int Yes 0
StartPoint
Departure airport code string Yes HAN
EndPoint
Destination airport code string Yes SGN
DepartDate
Departure date
Format ddMMyyyy
string Yes 12032025

ListCancel

List of flights to be canceled array[] Yes  

      Leg

Leg int Yes 0
StartPoint
Departure airport code string Yes HAN
EndPoint
Destination airport code string Yes SGN
DepartDate
Departure date
Format ddMMyyyy
string Yes 12032025

 

Response

{
  "StatusCode": "string",
  "Success": true,
  "Expired": true,
  "Message": "string",
  "Language": "string",
  "CustomProperties": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "RequestID": 0,
  "ApiQueries": [
    {
      "Step": 0,
      "Type": "string",
      "Name": "string",
      "Request": "string",
      "Response": "string",
      "Url": "string"
    }
  ],
  "Session": "string",
  "ListGroup": [
    {
      "Leg": 0,
      "TripType": "string",
      "Journey": "string",
      "StartPoint": "string",
      "EndPoint": "string",
      "DepartDate": "string",
      "ListAirOption": [
        {
          "OptionId": 0,
          "Leg": 0,
          "Itinerary": 0,
          "Airline": "string",
          "System": "string",
          "Source": "string",
          "Remark": "string",
          "Session": "string",
          "ListFlightOption": [
            {
              "OptionId": 0,
              "ListFlight": [
                {
                  "Leg": 0,
                  "FlightId": "string",
                  "Airline": "string",
                  "Operator": "string",
                  "StartPoint": "string",
                  "EndPoint": "string",
                  "StartDate": "2025-11-13T07:43:26.294Z",
                  "EndDate": "2025-11-13T07:43:26.294Z",
                  "DepartDate": "string",
                  "ArriveDate": "string",
                  "FlightNumber": "string",
                  "Special": true,
                  "StopNum": 0,
                  "Duration": 0,
                  "ListSegment": [
                    {
                      "Leg": 0,
                      "SegmentId": "string",
                      "Airline": "string",
                      "Operator": "string",
                      "StartPoint": "string",
                      "EndPoint": "string",
                      "StartDate": "2025-11-13T07:43:26.294Z",
                      "EndDate": "2025-11-13T07:43:26.294Z",
                      "DepartDate": "string",
                      "ArriveDate": "string",
                      "StartTerminal": "string",
                      "EndTerminal": "string",
                      "FlightNumber": "string",
                      "Equipment": "string",
                      "FareClass": "string",
                      "FareBasis": "string",
                      "Duration": 0,
                      "HasStop": true,
                      "StopPoint": "string",
                      "StopTime": 0,
                      "TechnicalStop": "string",
                      "MarriageGrp": "string",
                      "FlightsMiles": 0,
                      "Status": "string"
                    }
                  ]
                }
              ]
            }
          ],
          "ListFareOption": [
            {
              "OptionId": 0,
              "FareClass": "string",
              "FareBasis": "string",
              "FareFamily": "string",
              "CabinCode": "string",
              "CabinName": "string",
              "Refundable": true,
              "Exchangeable": true,
              "Availability": 0,
              "Unavailable": true,
              "ExpiryDate": "string",
              "BaseFare": 0,
              "PriceAdt": 0,
              "NetFare": 0,
              "TotalFare": 0,
              "Discount": 0,
              "Currency": "string",
              "Airline": "string",
              "System": "string",
              "Source": "string",
              "Tourcode": "string",
              "ListFarePax": [
                {
                  "PaxType": "string",
                  "PaxNumb": 0,
                  "BaseFare": 0,
                  "NetFare": 0,
                  "TotalFare": 0,
                  "Discount": 0,
                  "Currency": "string",
                  "ListFareItem": [
                    {
                      "Code": "string",
                      "Amount": 0,
                      "Currency": "string",
                      "Name": "string"
                    }
                  ],
                  "ListTaxDetail": [
                    {
                      "Code": "string",
                      "Amount": 0,
                      "Currency": "string",
                      "Name": "string"
                    }
                  ],
                  "ListFareInfo": [
                    {
                      "SegmentId": "string",
                      "StartPoint": "string",
                      "EndPoint": "string",
                      "FareClass": "string",
                      "FareBasis": "string",
                      "HandBaggage": "string",
                      "FreeBaggage": "string",
                      "Availability": 0,
                      "FareFamily": "string",
                      "CabinCode": "string",
                      "CabinName": "string",
                      "MealService": "string",
                      "Entertainment": "string",
                      "PowerOutlet": "string",
                      "WideAircraft": "string",
                      "FreeWifi": "string"
                    }
                  ],
                  "FareDiscount": {
                    "Code": "string",
                    "Amount": 0,
                    "Currency": "string",
                    "Name": "string"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "RequestIDs": "string"
}
Data specification
Information field Describe Data type For example
StatusCode Status code string 0000
Success Return status boolean True/False
Message Error message returned string  
Language Return language string Vi
RequestID Request ID string 123456
ListGroup Flight group information list array[]  
      Leg Leg int 0
     TripType Trip type string
 
     System System
string
VN
     StartPoint Airport code, departure city string HAN
     EndPoint Airport code, destination city string SGN
     DepartDate Departure date
Format ddMMyyyy
string 12032025

ListAirOption

Flight options list object  
Leg
Leg int  
Itinerary
Itinerary int  
Airline
Airline string VN
System
System string 1G
Source
Source string API
Remark
Remark string  
ListFlightOption
Flight options list object  
OptionId
Option ID int  
ListFlight
List Flight object  
Leg
Leg int 0
FlightId
Flight ID string 123456
Airline
Airline code string VN
Operator
Carrier code string VN
StartPoint
Departure airport code string HAN
EndPoint
Destination airport code string SGN
StartDate
Start date
Format ddMMyyyy
string 12032025
EndDate
End date
Format ddMMyyyy
string 12102025
DepartDate
Departure date
Format ddMMyyyy
string 12032025
ArriveDate
Arrive Date
Format ddMMyyyy
string 12102025
FlightNumber
Flight number string VN205
StopNum
Number of stops int 0
Duration
Duration int 0
ListSegment
Flight list list  
Leg
Leg int 0
SegmentId
Flight itinerary ID string 123456
Airline
Airline code string VJ
Operator
Carrier code string VN
StartPoint
Departure airport code string HAN
EndPoint
Destination airport code string SGN
StartDate
Start Date
Format ddMMyyyy
string 11122024
EndDate
End Date
Format ddMMyyyy
string 01012025
DepartDate
Departure date
Format ddMMyyyy
datetime 11122024
ArriveDate
Arrive Date
Format ddMMyyyy
datetime 12122024
StartTerminal
Departure terminal string 1
EndTerminal
Landing terminal string 1
FlightNumber
Flight number string VN205
Equipment
Aircraft type code string  Airbus A321
FareClass
Fare Class string H
FareBasis
Fare Basis string First Class
Duration
Duration int 120
HasStop
Has Stop boolean True/false
StopPoint
Stop Point string  
StopTime
Stop Time double  
TechnicalStop
Airport code technical stop string  
MarriageGrp
The group is married string  
FlightsMiles
Air miles int  
Status
Status string  
ListFareOption
List of fare options object  
OptionId
Option ID int 0
FareClass
Fare Class string H
FareBasis
Fare Basis string First Class
FareFamily
Price group string  
CabinCode
Cabin Code string  
CabinName
Cabin Name string  
Refundable
Refundable boolean True/false
Availability
Availability int 9
Unavailable
Unavailable boolean True/false
ExpiryDate
ExpiryDate string 120
BaseFare
Basic fare for an adult double 0
BaseFareOrigin
Base fare for an adult without airline discount code double 0
PriceAdt
Ticket price for one adult double 0
PriceAdtOrigin
Price per adult ticket without airline discount code double 0
NetFare
Net fare double 0
NetFareOrigin
Net fare before applying the company's discount code double 0
TotalFare
Total fare double 0
TotalFareOrigin
Total fare before applying airline discount code double 0
Currency
Currency string VND
Airline
Airline string VN
System
System string VN
Source
Source string  
Tourcode
Tourcode string  
ListFarePax
List of ticket price information for each customer list  
PaxType
Target audience string  
PaxNumb
Number of guests int  
BaseFare
Base fare double  
BaseFareOrigin 
Basic fare without airline discount code applied double  
NetFare
Net fare double  
NetFareOrigin
Net fare before applying the company's discount code double  
TotalFare
Total fare double  
TotalFareOrigin
Total fare before applying airline discount code double  
ListFareItem
List of detailed ticket price information    
Code
Code string  
Amount
Amount double  
Name
Name String  
ListTaxDetail
List of tax details    
Code
Code string  
Amount
Amount double  
Name
Name string  
ListFareInfo
List of detailed fare class information    
SegmentId
Segmen ID int  
StartPoint
Airport code, departure city string HAN
EndPoint
Airport code, destination city string SGN
FareClass
Fare class string  
FareBasis
Fare basis string  
HandBaggage
Free carry-on baggage string  
FreeBaggage
Free checked baggage string  
Availability
Availability int  
Error code
Error code Interpretation
0000 Success
0001 System error
0002 Flight not found