Retrieve booking
This feature allows to get current booking information from the airline system including itinerary information, passenger information, additional services, etc.
Overview
| Request URL: | https://ibe.datacom.vn/api/flight/retrievebooking |
| Method: | POST |
| Data type: | JSON |
| API Specification: | See specifications |
Applicable system
| System code | System name |
|---|---|
| VN | Vietnam Airlines |
| VJ | Vietjet Air |
| QH | Bamboo Airways |
| VU | Vietravel Airlines |
| 9G | Sun Phu Quoc Airways |
| 1G | Galileo |
| 1A | Amadeus + NDC |
| FO | Flyone |
| AK | AirAsia |
| TR | Scoot |
Request
{
"RequestInfo": {
"PrivateKey": "string",
"ApiAccount": "string",
"ApiPassword": "string",
"Currency": "string",
"Language": "string",
"IpAddress": "string"
},
"System": "string",
"BookingCode": "string",
"PassengerName": "string"
}
Data specification
| Information field | Describe | Data type | Obligatory | For example |
|---|---|---|---|---|
| RequestInfo | Query information See description Shared properties |
object | Yes |
|
| System | System | string | Yes | VN |
| BookingCode | Booking code | string | Yes | |
| PassengerName | Passenger name | string | Yes |
Response
{
"StatusCode": "string",
"Success": true,
"Message": "string",
"Language": "string",
"RequestID": 0,
"Booking": {
"Source": "string",
"System": "string",
"Airline": "string",
"OrderCode": "string",
"OrderId": "string",
"GdsCode": "string",
"BookingCode": "string",
"BookingStatus": "string",
"ExpirationTime": "string",
"TimePurchase": "string",
"TotalPrice": 0,
"Currency": "string",
"BookingPcc": "string",
"BookingSignIn": "string",
"BookingImage": "string",
"ResponseTime": 0,
"AutoIssue": true,
"Sandbox": true,
"StatusCode": "string",
"Message": "string",
"Warning": "string",
"GuestContact": {
"Title": "string",
"Name": "string",
"Area": "string",
"Phone": "string",
"Email": "string",
"Address": "string",
"Remark": "string",
"ReceiveEmail": true
},
"AgentContact": {
"Title": "string",
"Name": "string",
"Area": "string",
"Phone": "string",
"Email": "string",
"Address": "string",
"Remark": "string",
"ReceiveEmail": true
},
"ListFlightFare": [
{
"Leg": 0,
"Journey": "string",
"Itinerary": 0,
"Airline": "string",
"System": "string",
"Source": "string",
"Remark": "string",
"FareInfo": {
"OptionId": 0,
"FareClass": "string",
"FareBasis": "string",
"FareFamily": "string",
"CabinCode": "string",
"CabinName": "string",
"Refundable": true,
"Availability": 0,
"Unavailable": true,
"ExpiryDate": "string",
"BaseFare": 0,
"BaseFareOrigin": 0,
"PriceAdt": 0,
"PriceAdtOrigin": 0,
"NetFare": 0,
"NetFareOrigin": 0,
"TotalFare": 0,
"TotalFareOrigin": 0,
"Currency": "string",
"Airline": "string",
"System": "string",
"Source": "string",
"Tourcode": "string",
"ListFarePax": [
{
"PaxType": "string",
"PaxNumb": 0,
"BaseFare": 0,
"BaseFareOrigin": 0,
"NetFare": 0,
"NetFareOrigin": 0,
"TotalFare": 0,
"TotalFareOrigin": 0,
"ListFareItem": [
{
"Code": "string",
"Amount": 0,
"Name": "string"
}
],
"ListTaxDetail": [
{
"Code": "string",
"Amount": 0,
"Name": "string"
}
],
"ListFareInfo": [
{
"SegmentId": "string",
"StartPoint": "string",
"EndPoint": "string",
"FareClass": "string",
"FareBasis": "string",
"HandBaggage": "string",
"FreeBaggage": "string",
"Availability": 0
}
]
}
]
},
"ListFlight": [
{
"Leg": 0,
"FlightId": "string",
"Airline": "string",
"Operator": "string",
"StartPoint": "string",
"EndPoint": "string",
"StartDate": "2024-11-27T07:03:07.407Z",
"EndDate": "2024-11-27T07:03:07.407Z",
"DepartDate": "string",
"ArriveDate": "string",
"FlightNumber": "string",
"StopNum": 0,
"Duration": 0,
"ListSegment": [
{
"Leg": 0,
"SegmentId": "string",
"Airline": "string",
"Operator": "string",
"StartPoint": "string",
"EndPoint": "string",
"StartDate": "2024-11-27T07:03:07.407Z",
"EndDate": "2024-11-27T07:03:07.407Z",
"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"
}
]
}
],
"Adt": 0,
"Chd": 0,
"Inf": 0,
"Session": "string",
"Status": true,
"Error": "string",
"Message": "string",
"Language": "string",
"AgentId": "string",
"AgentCode": "string",
"AgentType": "string"
}
],
"ListPassenger": [
{
"Index": 0,
"ParentId": 0,
"NameId": "string",
"Type": "string",
"Title": "string",
"Gender": 0,
"GivenName": "string",
"Surname": "string",
"DateOfBirth": "string",
"PassengerId": "string",
"Passport": {
"DocumentType": "string",
"DocumentCode": "string",
"DocumentExpiry": "string",
"Nationality": "string",
"IssueCountry": "string"
},
"ListBaggage": [
{
"System": "string",
"Airline": "string",
"Value": "string",
"Type": "string",
"PaxType": "string",
"Name": "string",
"Description": "string",
"Price": 0,
"Currency": "string",
"Leg": 0,
"StartPoint": "string",
"EndPoint": "string",
"StatusCode": "string",
"Confirmed": true,
"Session": "string"
}
],
"ListPreSeat": [
{
"System": "string",
"Airline": "string",
"Value": "string",
"Type": "string",
"PaxType": "string",
"Name": "string",
"Description": "string",
"Price": 0,
"Currency": "string",
"Leg": 0,
"StartPoint": "string",
"EndPoint": "string",
"StatusCode": "string",
"Confirmed": true,
"Session": "string"
}
],
"ListService": [
{
"System": "string",
"Airline": "string",
"Value": "string",
"Type": "string",
"PaxType": "string",
"Name": "string",
"Description": "string",
"Price": 0,
"Currency": "string",
"Leg": 0,
"StartPoint": "string",
"EndPoint": "string",
"StatusCode": "string",
"Confirmed": true,
"Session": "string"
}
],
"ListFareInfo": [
{
"Code": "string",
"Amount": 0,
"Name": "string"
}
],
"ListMembership": [
{
"Airline": "string",
"MembershipID": "string",
"MembershipType": "string"
}
]
}
],
"ListTicket": [
{
"Index": 0,
"System": "string",
"Airline": "string",
"BookingCode": "string",
"ConjTktNum": "string",
"TicketNumber": "string",
"TicketType": "string",
"TicketStatus": "string",
"TicketRelated": "string",
"RelatedType": "string",
"ServiceType": "string",
"ServiceCode": "string",
"PaxType": "string",
"FullName": "string",
"GivenName": "string",
"Surname": "string",
"NameId": "string",
"Fare": 0,
"Tax": 0,
"Fee": 0,
"Vat": 0,
"Total": 0,
"Currency": "string",
"Itinerary": 0,
"StartPoint": "string",
"EndPoint": "string",
"DepartDate": "string",
"ReturnDate": "string",
"FareClass": "string",
"FareBasis": "string",
"FlightType": "string",
"Segments": "string",
"Remark": "string",
"TicketImage": "string",
"IssueDate": "2024-11-27T07:03:07.407Z"
}
]
}
}
Data specification
| Information field | Describe | Data type | For example |
|---|---|---|---|
| StatusCode | Status code | string | 0000 |
| Success | Success | boolean | true |
| Message | Message | string | |
| Language | Language | string | Vi |
| RequestId | Request Id | int | |
|
Booking
|
Booking | object | |
|
Source
|
Source | string | API |
|
System
|
System | string | VN |
|
Airline
|
Airline | string | 1G |
|
OrderCode
|
Order code | string | |
|
OrderId
|
Order ID | string | |
|
GdsCode
|
Gds ode | string | |
|
BookingCode
|
Booking code | string | |
|
BookingStatus
|
Booking status | string | |
|
ExpirationTime
|
Expiration time | string | |
|
ExpirationTime
|
Expiration time | string | |
|
TotalPrice
|
Total price | double | |
|
Currency
|
Currency | string | VND |
|
BookingPcc
|
Booking Pcc | string | |
|
BookingSignIn
|
Booking Sign In | string | |
|
BookingImage
|
Booking image/td> | string | |
|
ResponseTime
|
Response time | double | 2.21 |
|
AutoIssue
|
Auto issue | boolean | false |
|
Sandbox
|
Sandbox | boolean | |
|
StatusCode
|
Status code | string | |
|
Message
|
Message | string | |
|
Warning
|
Warning | string | |
|
GuestContact
|
Guest contact | object | |
|
Title
|
Title | string | |
|
Name
|
Name | string | |
|
Area
|
Area | string | |
|
Phone
|
Phone | string | |
|
Email
|
string | ||
|
Address
|
Address | string | |
|
Remark
|
Remark | string | |
|
ReceiveEmail
|
Receive email | boolean | |
|
AgentContact
|
Agent contact | object | |
|
Title
|
Title | string | |
|
Name
|
Name | string | |
|
Area
|
Area | string | |
|
Phone
|
Phone | string | |
|
Email
|
string | ||
|
Address
|
Address | string | |
|
Remark
|
Remark | string | |
|
ReceiveEmail
|
Receive email | boolean | |
|
ListFlightFare
|
List flight fare | object | |
|
Leg
|
Leg | int | 0 |
|
Journey
|
Journey | string | HANSGN23112024 |
|
Itinerary
|
Itinerary | int | |
|
Airline
|
Airline | string | VN |
|
System
|
System | string | 1G |
|
Source
|
Source | string | API |
|
Remark
|
Remark | string | |
|
FareInfo
|
Fare info | list | |
|
OptionId
|
Option ID | int | 0 |
|
FareClass
|
Fare class | string | H |
|
FareBasis
|
Fare basis | string | First Class |
|
FareFamily
|
Fare family | string | |
|
CabinCode
|
Cabin code | string | |
|
CabinName
|
Cabin name | string | |
|
Refundable
|
Refundable | boolean | True/false |
|
Availability
|
Availability | int | 9 |
|
Unavailable
|
Unavailable | boolean | True/false |
|
ExpiryDate
|
Expiry date | string | 120 |
|
BaseFare
|
Base fare | double | 0 |
|
BaseFareOrigin
|
Base fare origin | double | 0 |
|
PriceAdt
|
Price Adt | double | 0 |
|
PriceAdtOrigin
|
Price Adt origin | double | 0 |
|
NetFare
|
Net fare | double | 0 |
|
NetFareOrigin
|
Net fare origin | double | 0 |
|
TotalFare
|
Total fare | double | 0 |
|
TotalFareOrigin
|
Total fare origin | double | 0 |
|
Currency
|
Currency | string | VND |
|
Airline
|
Airline | string | VN |
|
System
|
System | string | VN |
|
Source
|
Source | string | |
|
Tourcode
|
Tourcode | string | |
|
ListFarePax
|
List fare pax | list | |
|
PaxType
|
Pax ype | 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 | array[] | |
|
Code
|
Code | string | |
|
Amount
|
Amount | double | |
|
Name
|
Name | String | |
|
ListTaxDetail
|
List of tax details | array[] | |
|
Code
|
Code | string | |
|
Amount
|
Amount | double | |
|
Name
|
Name | string | |
|
ListFareInfo
|
List of detailed ticket class information | array[] | |
|
SegmentId
|
Segment 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 | |
|
ListFlight
|
Flight list | list | |
|
Leg
|
Leg | int | 0 |
|
FlightId
|
Flight ID | string | 123456 |
|
Airline
|
Airline | string | VN |
|
Operator
|
Operator | string | VN |
|
StartPoint
|
Departure airport code | string | HAN |
|
EndPoint
|
Destination airport code | string | SGN |
|
StartDate
|
Departure Date Format ddMMyyyy |
string | 12032025 |
|
EndDate
|
Landing Date Format ddMMyyyy |
string | 12102025 |
|
DepartDate
|
Departure Date Format ddMMyyyy |
string | 12032025 |
|
ArriveDate
|
Landing Date Format ddMMyyyy |
string | 12102025 |
|
FlightNumber
|
Flight number | string | VN205 |
|
StopNum
|
Number of stops | int | 0 |
|
Duration
|
Duration | int | 0 |
|
ListSegment
|
List segment | list | |
|
Leg
|
Leg | int | 0 |
|
SegmentId
|
Segment ID | string | 123456 |
|
Airline
|
Airline | string | VJ |
|
Operator
|
Operator | string | VN |
|
StartPoint
|
Departure airport code | string | HAN |
|
EndPoint
|
Destination airport code | string | SGN |
|
StartDate
|
Departure Date Format ddMMyyyy |
string | 11122024 |
|
EndDate
|
Landing Date Format ddMMyyyy |
string | 01012025 |
|
DepartDate
|
Departure Date Format ddMMyyyy |
datetime | 11122024 |
|
ArriveDate
|
Landing Date Format ddMMyyyy |
datetime | 12122024 |
|
StartTerminal
|
Departure terminal | string | 1 |
|
EndTerminal
|
Landing terminal | string | 1 |
|
FlightNumber
|
Flight number | string | VN205 |
|
Equipment
|
Equipment | 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
|
Technical stop | string | |
|
MarriageGrp
|
Flight groups in pairs | string | |
|
FlightsMiles
|
Flights miles | int | |
|
Status
|
Status | string | |
|
Adt
|
Number of adult guests | int | |
|
Chd
|
Number of children | int | |
|
Inf
|
Number of infant guests | int | |
|
Session
|
Session | string | |
|
Status
|
Status | boolean | |
|
Error
|
Error | string | |
|
Message
|
Message | string | |
|
Language
|
Language | string | Vi |
|
AgentId
|
Agent ID | string | |
|
AgentCode
|
Agent code | string | |
|
AgentType
|
Agent type | string | |
|
ListPassenger
|
Passenger list information | object | |
|
Index
|
Index |
int
|
|
|
ParentId
|
Identification code of adult accompanying the infant |
int
|
|
|
NameId
|
Identification code returned by the airline system |
string
|
|
|
Type
|
Type | string | |
|
Title
|
Title | string | Mrs |
|
Gender
|
Gender | int | |
|
GivenName
|
Given name | string | |
|
Surname
|
Surname | string | |
|
DateOfBirth
|
Date of birth | string | |
|
PassengerId
|
Passenger ID | string | |
|
Passport
|
Passport | object | |
|
DocumentType
|
Document type | string | |
|
DocumentCode
|
Document code | string | |
|
DocumentExpiry
|
Document expiry | string | |
|
Nationality
|
Nationality | string | |
|
IssueCountry
|
Issue country | string | |
|
ListBaggage
|
List baggage | object | |
|
System
|
System | string | VN |
|
Airline
|
Airline | string | 1G |
|
Value
|
Value | string | |
|
Type
|
Type | string | |
|
PaxType
|
Pax type | string | ADT |
|
Name
|
Name | string | |
|
Description
|
Description | string | |
|
Price
|
Price | double | |
|
Currency
|
Currency | string | VND |
|
Leg
|
Leg | int | |
|
StartPoint
|
Start point | string | HAN |
|
EndPoint
|
End point | string | SGN |
|
StatusCode
|
Stacode | string | |
|
Confirmed
|
Confirmed | boolean | |
|
Session
|
Session | string | |
|
ListPreSeat
|
Pre-booked seat list information | object | |
|
System
|
System | string | VN |
|
Airline
|
Airline | string | 1G |
|
Value
|
Value | string | |
|
Type
|
Type | string | |
|
PaxType
|
Pax type | string | ADT |
|
Name
|
Name | string | |
|
Description
|
Description | string | |
|
Price
|
Price | double | |
|
Currency
|
Currency | string | VND |
|
Leg
|
Leg | int | |
|
StartPoint
|
Departure airport code | string | HAN |
|
EndPoint
|
Destination airport code | string | SGN |
|
StatusCode
|
Status code | string | |
|
Confirmed
|
Confirmed | boolean | |
|
Session
|
Session | string | |
|
ListService
|
Service list information | object | |
|
System
|
System | string | VN |
|
Airline
|
Airline | string | 1G |
|
Value
|
Value | string | |
|
Type
|
Type | string | |
|
PaxType
|
Pax type | string | ADT |
|
Name
|
Name | string | |
|
Description
|
Description | string | |
|
Price
|
Price | double | |
|
Currency
|
Currency | string | VND |
|
Leg
|
Leg | int | |
|
StartPoint
|
Start point | string | HAN |
|
EndPoint
|
End point | string | SGN |
|
StatusCode
|
Stacode | string | |
|
Confirmed
|
Confirmed | boolean | |
|
Session
|
Session | string | |
|
ListFareInfo
|
Ticket price list information | object | |
|
Code
|
Code | string | |
|
Amount
|
Amount | double | |
|
Name
|
Name | String | |
|
ListMembership
|
Membership card list information | object | |
|
Airline
|
Airline | string | |
|
MembershipId
|
Membership ID | string | |
|
MembershipType
|
Membership type | string | |
|
ListTicket
|
Ticket list information | object | |
|
Index
|
Index |
int
|
|
|
System
|
System | string | 1G |
|
Airline
|
Airline | string | VN |
|
BookingCode
|
Booking code | string | |
|
ConjTktNum
|
Conj ticket number | string | |
|
TicketNumber
|
Ticket number | string | |
|
TicketType
|
Ticket type | string | |
|
TicketStatus
|
Ticstatus | string | |
|
TicketRelated
|
Ticket related | string | |
|
RelatedType
|
Relatype | string | |
|
ServiceType
|
Service type | string | |
|
ServiceCode
|
Service code | string | |
|
PaxType
|
Pax type | string | |
|
FullName
|
Full name | string | |
|
GivenName
|
Given name | string | |
|
Surname
|
Surname | string | |
|
NameId
|
Identification code returned by the airline system | string | |
|
Fare
|
Fare | double | 10000000 |
|
Tax
|
Tax | double | 500000 |
|
Fee
|
Fee | double | 500000 |
|
Vat
|
Vat | double | 10 |
|
Total
|
Total | double | 10000000 |
|
Currency
|
Currency | string | VND |
|
Itinerary
|
Itinerary | int | |
|
StartPoint
|
Airport code, departure city | string | HAN |
|
EndPoint
|
Airport code, destination city | string | SGN |
|
DepartDate
|
Departure Date Format ddMMyyyy |
string | 12032025 |
|
ReturnDate
|
Landing Date Format ddMMyyyy |
string | 18032025 |
|
FareClass
|
Fare class | string | H |
|
FareBasis
|
Fare basis | string | First Class |
|
FlightType
|
Flight type | string | |
|
Segments
|
Segments | string | |
|
Remark
|
Remark | string | |
|
TicketImage
|
Ticket image | string | |
|
IssueDate
|
Issue date Format ddMMyyyy |
string | 12032025 |
Error code
| Error code | Interpretation |
|---|---|
| 0000 | Success |
| 0001 | System error |
| 0002 | Invalid request |