` values provided by Gotadi to Partners.
#### Encryption of transmitted data and digital signature authentication
Step 1: Generate random key
Step 2: Encrypt random key
Step 3: Generate digital signature
Step 4: Encrypt data
**Decrypt the received data and verify the electronic signature**
**Input** Encrypted Key, Encrypted Data, Receiver’s RSA PrivateKey, Sender’s RSA PublicKey
**Output** Original Data, Verify Result
Step 1: Decrypt 3DES random key
Step 2: Decrypt Data
Step 3: Verify digital signature
***
#### Abbreviation convention
Model
* key (string, required),
Key decrypts (encrypted) data. How to establish refer to the section: Encryption of transmitted data and authentication of digital signature
* data (string, required),
Data with electronic signature (encrypted). How to decrypt refer to the section: Encryption of transmitted data and authentication of digital signature
*Signature data schema:*
```
|||
```
*Original data schema:*
```
||||
```
* access\_code (String, required)
Access code provided by Gotadi to Partners.
* user\_id (String, required)
User identifier on the Partner’s system.
* layout (String, optional)
The value is dual or single corresponding to 2 types of layout Gotadi provides to partners.
* product (String, required)
* The value is flight or hotel. Corresponding to 2 products Gotadi provided to partners.
* When the layout is single: Used to select the display service on the webview.
* When the layout is dual: Used to focus the service displayed on the webview.
#### Response
Model
* key (String, required)
Key decrypts (encrypted) data. How to establish refer to the section: Encryption of transmitted data and authentication of digital signature
* data (String, required)
Data with electronic signature (encrypted). How to decrypt refer to the section: Encryption of transmitted data and authentication of digital signature
*Signature data schema:*
```
||
```
*Original data schema:*
```
|||
```
* access\_code (String, required)
Access code provided by Gotadi to Partners.
* error\_code (String, required)
[Error code](https://developer.gotadi.com/dev-guide-en/agency-partner/integration-documentation/#error-code)
* redirect\_url (String, optional)
Link to Gotadi Webview with jwtToken included.
```
https://?access_token=
```
# Flight
# Search API
### Get airport list API Departure airport code
|
| destination\_code (String, Required) | Destination airport code
|
| departure\_date (String, Required) | Departure day
|
| returnure\_date (String, Required) | Return day
|
| cabin\_class (String, Required) | Ticket class
|
| route\_type (String, Optional) | Journey type:
|
| aduts\_qtt (Integer, Optional) | Number of adult passengers (12 years old and above)
|
| children\_qtt (Integer, Optional) | Number of passengers who are children (from 2 years old and under 12 years old)
|
| infants\_qtt (Integer, Optional) | Number of passengers who are infants (under 2 years old)
|
| time (String, Optional) | API Call Time (UnixTimeStamp)
|
| key (String, Optional) | Key to checksum. How to create value:MAC-SHA256(, ‘Gotadi’) |
| skip\_filter (Boolean, Optional) | By default, when `false`, the response will include `groupPricedItineraries`, which contains the list of itineraries returned from the search results. Otherwise, it will not be displayed. |
| include-equivfare (Boolean, Optional) | Request to pay additional ticketing fee information (EquivFare) |
| page (Integer, Optional) | Number of pages you want to get results (eg: 0) |
| size (Integer, Optional) | Number of results you want to get in 1 page (eg 20) |
| sort (String, Optional) | Sort the results by the value of the returned property ascending or descending (eg: propertiesName,desc / propertiesName,asc) |
**Example**
```
?origin_code=SGN&destination_code=HAN&departure_date=07-21-2021&returnture_date=07-28-2021&cabin_class=E&route_type=ROUNDTRIP&aduts_qtt=1&children_qtt=0&infants_qtt=0&time=1625552814666&key=/xNr15RmY0dqSUkhvpKI1bIbKIuyZr1Q38rLi3bqxVk=&page=0&size=15
```
#### Response Reference code to search for flight tickets
|
| returnSearchId(String, Required) | Reference code to search for air tickets
|
| groupPricedItineraries (Array\[GroupPricedItineraryDTO], Optional) | Information about the list of journeys returned by search results |
| airSupplier(String, Required) | Carriers (VietnamAirline - VNA, VjetJet - VJ, BamBoo - QH, …) |
| aircraft (String, Optional) | Type of aircraft (Airbus A330, Boeing 787, .....) |
| airline(String, Optional) | Airlines (VJ, VNA, …) |
| airlineName(String, Optional) | Name of airline (Vietjet Air, Vietnam Airlines, Bamboo, …) |
| arrivalDateTime(String, Required) | Arrival date and time, using UTC/GMT+7 time zone |
| departureDateTime (String, Required) | Split flight time, using UTC/GMT+7 time zone |
| destinationLocationCode (String, Optional) | Flight end city code |
| destinationCountry(String, Optional) | The name of the country where the flight ended |
| destinationCountryCode (String, Optional) | Flight end country code |
| destinationCity(String, Optional) | The name of the city where the flight ends |
| destinationLocationName (String, Optional) | Airport name where the flight ends |
| flightNo(String, Optional) | Airplane number |
| flightNo(String, Optional) | Airplane number |
| flightType(String, Optional) | Type of flight domestic or international
|
| groupId(String, Required) | Journey identifier in the list of journeys returned by search results |
| originCity(String, Optional) | City name at departure point |
| originCountry(String, Optional) | Country name at departure point |
| originCountryCode(String, Optional) | Country code at departure point |
| originLocationCode(String, Optional) | Flight departure city code |
| originLocationName(String, Optional) | Airport name at departure point |
| totalPricedItinerary (Integer, Required) | Total number of detailed journeys |
| pricedItineraries (Array\[PricedItineraries], Required) | Itinerary details |
| airItineraryPricingInfo (AirItineraryPricingInfo, Required) | Detailed price information of the itinerary |
| adultFare (FareBreakdown, Required) | |
| passengerFare (PassengerFare, Required) | Adult fare information |
| baseFare(FareInfo, required) | Basic fare information |
| amount (Double, Required) | Amount of money |
| decimalPlaces(Integer, Optional) | Decimal places rounded to |
| equivFare (FareInfo, Optional) | Similar to baseFare
|
| serviceTax (FareInfo, Required) | Similar to baseFare
|
| totalFare (FareInfo, Required) | Similar to baseFare
|
| surcharges (Array\[Surcharge], Required) | Information about surcharges per booking / per segment |
| passengerTypeQuantities (PassengerTypeQuantities, Optional) | Number/type of passengers |
| code(String, Required) | Adult/Child/Infant Identifier
|
| quantity (Integer, Required) | Number of adults / children / infants |
| childFare(PassengerFare, Optional) | Child fare information
|
| infantFare (PassengerFare, Optional) | Infant fare information
|
| itinTotalFare (PassengerFare, Required) | Total fare information of the journey
|
| fareSourceCode(String, Required) | Journey identifier information
|
| allowHold (Boolean, Required) | Information to allow to hold a reservation or not |
| cabinClassName(String, Required) | Seat class information:
|
| fightNo(String, Optional) | Displays aircraft number information |
| originDestinationOptions (Array(OriginDestinationOptions), Required) | Cruise’s blocking/stopping information |
| flightDirection(String, Required) | Show flight direction information of the journey
|
| journeyDuration (Integer, Required) | Show flight time |
| flightSegments (Array(FlightSegments), Required) | Show detailed information of departure / end points in the journey |
| page (AirPage, Required) | Object that describes information about pagination.
|
| duration(Integer, Optional), | |
| errors (Array\[Error], Optional) | |
| infos(Array\[Info], Optional) | |
| success(Boolean, Optional) | |
| textMessage(String, Optional) | |
**Example**
```json
{
"returnSearchId": "ATD::210706::519f4508-b6df-4d96-8d43-538c96a0d90b-R",
"departureSearchId": "ATD::210706::519f4508-b6df-4d96-8d43-538c96a0d90b",
"duration": 46854,
"errors": null,
"groupPricedItineraries": [
{
"airSupplier": "VJ",
"aircraft": "Airbus A330",
"vnaArea": null,
"airline": "VJ",
"airlineName": "VietJet Air",
"arrivalDateTime": "2021-07-21T21:45:00.000Z",
"departureDateTime": "2021-07-21T19:35:00.000Z",
"destinationCity": "Hà Nội",
"destinationCountry": "Vietnam",
"destinationCountryCode": "VN",
"destinationLocationCode": "HAN",
"destinationLocationName": "Sân bay Nội Bài",
"fightNo": "156",
"flightType": "DOMESTIC",
"groupId": "599a7a20-32b8-4e6b-b167-27feb4f324f5",
"originCity": "Hồ Chí Minh",
"originCountry": "Vietnam",
"originCountryCode": "VN",
"originLocationCode": "SGN",
"originLocationName": "Sân bay Tân Sơn Nhất",
"pricedItineraries": [
{
"airItineraryPricingInfo": {
"adultFare": {
"fareBasisCodes": null,
"passengerFare": {
"baseFare": {
"amount": 399000,
"currencyCode": null,
"decimalPlaces": 2
},
"comboMarkup": null,
"equivFare": null,
"serviceTax": {
"amount": 258900,
"currencyCode": null,
"decimalPlaces": 2
},
"surcharges": [
{
"amount": 0,
"indicator": "Ticket fee per segment",
"type": "Ticket fee per segment"
}
],
"taxes": null,
"totalFare": {
"amount": 657900,
"currencyCode": null,
"decimalPlaces": 2
},
"totalPaxFee": null
},
"passengerTypeQuantities": {
"code": "ADT",
"quantity": 1
}
},
"childFare": null,
"divideInPartyIndicator": false,
"fareInfoReferences": null,
"fareSourceCode": "dom5226c7ae-e46c-48de-ae99-a7d4e3bf0782",
"fareType": "PUBLIC",
"infantFare": null,
"itinTotalFare": {
"baseFare": {
"amount": 399000,
"currencyCode": null,
"decimalPlaces": 2
},
"comboMarkup": null,
"equivFare": null,
"serviceTax": {
"amount": 258900,
"currencyCode": null,
"decimalPlaces": 2
},
"totalFare": {
"amount": 657900,
"currencyCode": null,
"decimalPlaces": 2
},
"totalPaxFee": null,
"totalTax": {
"amount": 0,
"currencyCode": null,
"decimalPlaces": 2
}
}
},
"allowHold": true,
"baggageItems": [
{
"amount": 0,
"code": "air-tickets.baggage-items.vietnam.vj.economy.baggage.adult.free",
"direction": null,
"fareCode": null,
"id": "air-tickets.baggage-items.vietnam.vj.economy.baggage.adult.free",
"name": "7kg xách tay",
"serviceType": "BAGGAGE"
}
],
"cabinClassName": "ECONOMY",
"directionInd": "DEPARTURE",
"fightNo": "156",
"mealItems": null,
"onlyPayLater": false,
"originDestinationOptions": [
{
"cabinClassName": "ECONOMY",
"destinationCity": "Hà Nội",
"destinationDateTime": "2021-07-21T21:45:00.000Z",
"destinationLocationCode": "HAN",
"destinationLocationName": "Sân bay Nội Bài",
"flightDirection": "D",
"flightSegments": [
{
"adultBaggage": null,
"aircraft": "Airbus A330",
"arrivalAirportLocationCode": "HAN",
"arrivalAirportLocationName": "Sân bay Nội Bài",
"arrivalCity": "Hà Nội",
"arrivalDateTime": "2021-07-21T21:45:00.000Z",
"cabinClassCode": "Z1_ECO",
"cabinClassName": "ECONOMY",
"cabinClassText": "Economy",
"childBaggage": null,
"departureAirportLocationCode": "SGN",
"departureAirportLocationName": "Sân bay Tân Sơn Nhất",
"departureCity": "Hồ Chí Minh",
"departureDateTime": "2021-07-21T19:35:00.000Z",
"eticket": true,
"fareBasicCode": null,
"fareCode": null,
"flightDirection": "D",
"flightNumber": "156",
"infantBaggage": null,
"journeyDuration": 130,
"marketingAirlineCode": "VJ",
"marriageGroup": null,
"mealCode": null,
"operatingAirline": {
"code": "VJ",
"equipment": null,
"flightNumber": "156",
"name": "VietJet Air"
},
"resBookDesignCode": "Z1_ECO",
"seatsRemaining": null,
"stopQuantity": 0,
"stopQuantityInfo": null,
"supplierFareKey": null,
"supplierJourneyKey": "qPHglSL8tSGƒ3tYhxs32unUB07y8mK5BDYQX2BnPQJuYvXBionML¥MStNiƒK98yyAOIpSQgCYƒdoFP¥a2VnwgUPQJAmkk89BX1s9VLDde6FRhlAFf34qJAHS3DNEEwbaCBRcmqPevNTjFuizmUVPBSKBj6HlNSuyrpPZEREJgN8ThsfKqQnB6zAkEhnwV0rNNPzwWYQqRMFAZYiXy5p0roZGgAxbnU6itFQzVmWzpƒƒd1GUseZ6vDwLWRqbO2lnJcw7qbRbSƒ9Lw0btZKtBHz2zAUgpGG97MNdAf1xN2g2cFSƒxTc7lrjWfIJsC53YbqXvqMhzgmUSDj¥B5dxg4bloOeLI5¥YWAlkIGawk57IcgpyzGprHK5Pn3Bv2CR4sMsg7ey0Z5eGFvalCScS72idlrgHBzOYnbwZ21mkGjsXVus¥ƒoEJSpWVB3meJug14SIGSd88mzGXtT4ƒQg1Tam4wvySRzi9gO4QGGXpcbBF4ƒs="
}
],
"journeyDuration": 130,
"originCity": "Hồ Chí Minh",
"originDateTime": "2021-07-21T19:35:00.000Z",
"originLocationCode": "SGN",
"originLocationName": "Sân bay Tân Sơn Nhất"
}
],
"passportMandatory": true,
"refundable": false,
"sequenceNumber": "ibe3541984955292126",
"ticketType": "ETICKET",
"validReturnCabinClasses": null,
"validatingAirlineCode": "VJ",
"validatingAirlineName": "VietJet Air"
}
],
"requiredFields": null,
"returnDateTime": null,
"roundType": "ROUNDTRIP",
"totalPricedItinerary": 3
}
],
"infos": null,
"page": {
"nextPageNumber": 1,
"offset": 15,
"pageNumber": 0,
"previousPageNumber": -1,
"totalElements": 57,
"totalPage": 4
},
"searchId": "ATD::210706::519f4508-b6df-4d96-8d43-538c96a0d90b",
"success": true,
"textMessage": null
}
```
***
### Get filter list information API Data used to refer to search results
|
| departureItinerary (AirItineraryInfo, Optional) | Outbound ticket information in case of getting filter-options for return ticket |
| airlineCode (String, Required) | VN: Vietnam Airlines
|
| groupId (String, Required) | Journey identifier in the list of journeys returned by search results |
| fareSourceCode (String, Required) | Journey identifier information |
| supplierCode (String, Required) | The company code is also provided |
| searchId (String, Required) | Data used to refer to search results |
**Example**
```json
{
"searchId": "ATD::210707::01a59301-d1f7-4302-954a-7047ee06e001-R",
"departureItinerary": {
"groupId": "01e650b9-2771-48cb-80fa-3004d0bd9eef",
"airlineCode": "VN",
"fareSourceCode": "dom5fb76509-3ac6-4c7b-baaa-b1ea844e3d7e",
"supplierCode": "VN",
"searchId": "ATD::210707::01a59301-d1f7-4302-954a-7047ee06e001"
}
}
```
#### Response Data used to refer to search results
|
| departureItinerary (AirItineraryInfo, Optional) | Outbound ticket information in case of getting filter-availability for return ticket |
| airlineCode (String, Required) | VN: Vietnam Airlines
|
| groupId(String, Optional) | Journey identifier in the list of journeys returned by search results |
| fareSourceCode(String, Required) | Journey identifier information |
| supplierCode(String, Required) | The company code is also provided |
| searchId(String, Required) | Data used to refer to search results |
| filter (ItineraryFilter, Required) | Used to input the desired filtering and sorting criteria |
| cabinClassOptions(Array\[String], Optional) | Information about the seat class you want to filter and sort |
| step(String, Required) | Information used to distinguish between departure and return
|
| flightType(String, Required) | Flight type information
|
| stopOption(Array\[String], Optional) | Stop Information |
| airlineOptions(Array\[String], Optional) | Airline information |
| departureDateTimeOptions (Array\[String], Optional) | Information about departure time starts at around or at what time
|
| arrivalDateTimeReturnOptions (Array\[String], Optional) | The end time information starts at what time or interval
|
**Example**
```json
{
"searchId": "ATD::210707::01a59301-d1f7-4302-954a-7047ee06e001",
"filter": {
"cabinClassOptions": [],
"ticketPolicyOptions": [],
"airlineOptions": [],
"stopOptions": [],
"step": "1",
"flightType": "DOMESTIC",
"departureDateTimeOptions": [],
"arrivalDateTimeReturnOptions": [],
"arrivalDateTimeOptions": [],
"priceItineraryId": "",
"loadMore": false,
"departureDateTimeReturnOptions": []
},
"departureItinerary": null
}
```
#### Response Type of flight domestic or international? Flight type:
|
| groupId(String, Required) | Journey identifier in the list of journeys returned by search results |
| originCity(String, Optional) | City name at departure point |
| originCountry(String, Optional) | Country name at departure point |
| originCountryCode(String, Optional) | Country code at departure point |
| originLocationCode(String, Optional) | Flight departure city code |
| originLocationName(String, Optional) | Airport name at departure point |
| totalPricedItinerary (Integer, Required) | Total number of detailed journeys |
| pricedItineraries (Array\[PricedItineraries], Required) | Itinerary details |
| airItineraryPricingInfo (AirItineraryPricingInfo, Required) | Detailed price information of the itinerary |
| adultFare (FareBreakdown, Required) | |
| passengerFare (PassengerFare, Required) | Adult fare information |
| baseFare(FareInfo, required) | Basic fare information |
| amount (Double, Required) | Amount of money |
| decimalPlaces(Integer, Optional) | Decimal places rounded to |
| equivFare (FareInfo, Optional) | Similar to baseFare
|
| serviceTax (FareInfo, Required) | Similar to baseFare
|
| totalFare (FareInfo, Required) | Similar to baseFare
|
| surcharges (Array\[Surcharge], Required) | Information about surcharges per booking / per segment |
| passengerTypeQuantities (PassengerTypeQuantities, Optional) | Number/type of passengers |
| code(String, Required) | Adult/Child/Infant Identifier
|
| quantity (Integer, Required) | Number of adults / children / infants |
| childFare(PassengerFare, Optional) | Child fare information
|
| infantFare (PassengerFare, Optional) | Infant fare information
|
| itinTotalFare (PassengerFare, Required) | Total fare information of the journey
|
| fareSourceCode(String, Required) | Journey identifier information
|
| allowHold (Boolean, Required) | Information to allow to hold a reservation or not |
| cabinClassName(String, Required) | Seat class information:
|
| fightNo(String, Optional) | Displays aircraft number information |
| originDestinationOptions (Array(OriginDestinationOptions), Required) | Cruise’s blocking/stopping information |
| flightDirection(String, Required) | Show flight direction information of the journey
|
| journeyDuration (Integer, Required) | Show flight time |
| flightSegments (Array(FlightSegments), Required) | Show detailed information of departure / end points in the journey |
| page (AirPage, Required) | Object that describes information about pagination.
|
| duration(Integer, Optional), | |
| errors (Array\[Error], Optional) | |
| infos(Array\[Info], Optional) | |
| success(Boolean, Optional) | |
| textMessage(String, Optional) | |
**Example**
```
{
"searchId": "ATD::210707::1f5e34da-24d5-46bf-993e-8cda8d716d15",
"duration": 1034,
"errors": null,
"groupPricedItineraries": [
{
"airSupplier": "VN",
"aircraft": "Airbus A321",
"vnaArea": "NorthTrip",
"airline": "VN",
"airlineName": "Vietnam Airlines",
"arrivalDateTime": "2021-07-23T07:15:00.000Z",
"departureDateTime": "2021-07-23T05:00:00.000Z",
"destinationCity": "Hồ Chí Minh",
"destinationCountry": "Vietnam",
"destinationCountryCode": "VN",
"destinationLocationCode": "SGN",
"destinationLocationName": "Sân bay Tân Sơn Nhất",
"fightNo": "205",
"flightType": "DOMESTIC",
"groupId": "8527f1e5-5291-42cf-8b76-c6874889b6c6",
"originCity": "Hà Nội",
"originCountry": "Vietnam",
"originCountryCode": "VN",
"originLocationCode": "HAN",
"originLocationName": "Sân bay Nội Bài",
"pricedItineraries": [
{
"airItineraryPricingInfo": {
"adultFare": {
"fareBasisCodes": null,
"passengerFare": {
"baseFare": {
"amount": 2739000,
"currencyCode": null,
"decimalPlaces": 2
},
"comboMarkup": null,
"equivFare": null,
"serviceTax": {
"amount": 844000,
"currencyCode": null,
"decimalPlaces": 2
},
"surcharges": [
{
"amount": 0,
"indicator": "Ticket fee per segment",
"type": "Ticket fee per segment"
}
],
"taxes": null,
"totalFare": {
"amount": 3583000,
"currencyCode": null,
"decimalPlaces": 2
},
"totalPaxFee": null
},
"passengerTypeQuantities": {
"code": "ADT",
"quantity": 1
}
},
"childFare": null,
"divideInPartyIndicator": false,
"fareInfoReferences": null,
"fareSourceCode": "dom2ac8e775-85a1-4a3a-a945-7c2e8eee905e",
"fareType": "PUBLIC",
"infantFare": null,
"itinTotalFare": {
"baseFare": {
"amount": 2739000,
"currencyCode": null,
"decimalPlaces": 2
},
"comboMarkup": null,
"equivFare": null,
"serviceTax": {
"amount": 844000,
"currencyCode": null,
"decimalPlaces": 2
},
"totalFare": {
"amount": 3583000,
"currencyCode": null,
"decimalPlaces": 2
},
"totalPaxFee": null,
"totalTax": {
"amount": 0,
"currencyCode": null,
"decimalPlaces": 2
}
}
},
"allowHold": true,
"baggageItems": [
{
"amount": 0,
"code": "air-tickets.baggage-items.vn.adult-child.12kg-1x23kg.free",
"direction": null,
"fareCode": null,
"id": "air-tickets.baggage-items.vn.adult-child.12kg-1x23kg.free",
"name": "Xách tay 12kg + Ký gửi 1x23kg",
"serviceType": "BAGGAGE"
}
],
"cabinClassName": "ECONOMY",
"directionInd": "DEPARTURE",
"fightNo": "205",
"mealItems": null,
"onlyPayLater": false,
"originDestinationOptions": [
{
"cabinClassName": "ECONOMY",
"destinationCity": "Hồ Chí Minh",
"destinationDateTime": "2021-07-23T07:15:00.000Z",
"destinationLocationCode": "SGN",
"destinationLocationName": "Sân bay Tân Sơn Nhất",
"flightDirection": "D",
"flightSegments": [
{
"adultBaggage": null,
"aircraft": "Airbus A321",
"arrivalAirportLocationCode": "SGN",
"arrivalAirportLocationName": "Sân bay Tân Sơn Nhất",
"arrivalCity": "Hồ Chí Minh",
"arrivalDateTime": "2021-07-23T07:15:00.000Z",
"cabinClassCode": "M",
"cabinClassName": "ECONOMY",
"cabinClassText": "Economy Flex",
"childBaggage": null,
"departureAirportLocationCode": "HAN",
"departureAirportLocationName": "Sân bay Nội Bài",
"departureCity": "Hà Nội",
"departureDateTime": "2021-07-23T05:00:00.000Z",
"eticket": true,
"fareBasicCode": null,
"fareCode": null,
"flightDirection": "D",
"flightNumber": "205",
"infantBaggage": null,
"journeyDuration": 135,
"marketingAirlineCode": "VN",
"marriageGroup": null,
"mealCode": null,
"operatingAirline": {
"code": "VN",
"equipment": null,
"flightNumber": "205",
"name": "Vietnam Airlines"
},
"resBookDesignCode": "M",
"seatsRemaining": null,
"stopQuantity": 0,
"stopQuantityInfo": null,
"supplierFareKey": null,
"supplierJourneyKey": "b+T7Lz8Bk6JHev8ZaYn6JdksP71z9ZD2metfP5B9ooYsM9jko+XIuxjgA14ghnjgUaj450N5VDUtJjP9AGhuOW+4XTufOS5VZDXm0TvXcwMXZzjJrTD4yzKE2HcSkpV2GU4fA4JI8HBo2DdLJAOlMuSGTpcN0/ylBtnM8MWr9faFvtwUUNLcIEma87mvAT2djGS7D2B65bkfIudjgUgMzxbClvY862C1Fkqt6J1iU8QvNRJygV+tIM581jkWISXEqEBWynub65QcCSh37U/HZ7vCCNWM0CbjqbnEJDbIFDJMWEPs/reBsAdLJ1oQVj/XMMOfVyWYykSzqBjrSxEbjlC2kfUf/qcH2a+VjzSftFZ4xgxv9BVcyjEvt6nfFl9eNxB0u2sH6O6Jr+V4yhqo8MHUvHs61leE3ihqaZr2WOW0tagXPQjFe/IRySSO/gsZvNE8SnbYsjkmvY0YDSdfgzGbkxJQVHTcIztxg1JG5c0MlwrGdbVINsLXyL9s5TOANlBpNtr9ArzEcr2/M7lZy4PjAlRZqPhyAl6dK4cR1gZaz/P+LivHga86vjAGHUcMqbZsicH4D44YFGqjeYKbhTmudhnn5KWfWJcR+ES9bumTSt+dw5VYbIybf83v3nGVuiAe30K2Jmuc58pHcTlxSbUMaevMbegAHSVUreKGVI9Rzh69kmTuVo3uFsEeAgMKIGPXSuHX0T6SY0wFXhEPk9xpFbMEs3fHicGr5KwZGGQHXZyCzD2BcWJhFCfWvTBwzL517DWLdUl7I4ac9b9DrGu1hUkt0Tr1999yumGvley4csmh5p/BiJJryCF7/igdMlBV8oXwHiWF8zfscyHfodL4xYL+jWseqE00zGfgKUvRY8kMyOtxfR0yEWP3sJjQ9AXfMjpTdCCIpulJfwAkY9pgvipjnwN4P2URX7Vfk+dvm0lAOo8QtEqupcQNeUaNv/H0jO1OHwpdUFRzUzALfJycZXI0aq0gBPNrz+4VWUF4EXXss1DJRVLBO4Z1SLNW+yxrB3uK3g9QDbkKfcsmvdGd/5LA9NuSSqXqzD5O92kn0TtDH5Ne4IuN2B8/6UqJWz5VNUVeT+ph1k24Uv9/iotAuUYfvsqosCb2BvokHpa4rIvDLTLAsmC5f1WeMsY8Ydnwf2e0cmZLXPVwQcKDE3zP8PnI91Fd+oL5Zx7+sdGa4QFs8dtV9y2hgYarchiugXf5tcIzDdDOm7FnBj8/Y64D7ZuSZCu16w7VvBEjHcuJwIf/Z/OhKKTv50JKU8a5RNcD3/7CCCrIvtxOK8F57arqMPJHtOXkD7dtns4NpRaghfCGX6OphkRNdJxzzx2KQzo39Lj4xEaWqwYD/3FRJiRap+5WGLonTpOIlN5ryMLLyL59lXSa7ZvfuAipLvm5TrmBlVt7FHvVj/BZ/PmpLUSTNg25tw+hJVpXCGOn+4EI7AH0Ph0SuVGKv8dnEM0P/mFWnSjpKNUb6mmm3ippgIjQwonVKbnhO3eDF9F7Ll0="
}
],
"journeyDuration": 135,
"originCity": "Hà Nội",
"originDateTime": "2021-07-23T05:00:00.000Z",
"originLocationCode": "HAN",
"originLocationName": "Sân bay Nội Bài"
}
],
"passportMandatory": true,
"refundable": false,
"sequenceNumber": "ibe3638861560249232",
"ticketType": "ETICKET",
"validReturnCabinClasses": null,
"validatingAirlineCode": "VN",
"validatingAirlineName": "Vietnam Airlines"
}
],
"requiredFields": null,
"returnDateTime": null,
"roundType": "ROUNDTRIP",
"totalPricedItinerary": 1
}
],
"infos": null,
"page": {
"nextPageNumber": 1,
"offset": 15,
"pageNumber": 0,
"previousPageNumber": -1,
"totalElements": 67,
"totalPage": 5
},
"success": true,
"textMessage": null
}
```
***
### Get the list of tickets open for sale on a flight API Data used to refer to search results
|
| departureItinerary (AirItineraryInfo, Optional) | Outbound ticket information in case of getting filter-availability for return ticket |
| airlineCode(String, Required) | VN: Vietnam Airlines
|
| groupId(String, Optional) | Journey identifier in the list of journeys returned by search results |
| fareSourceCode(String, Required) | Journey identifier information |
| supplierCode(String, Required) | The company code is also provided |
| searchId(String, Required) | Data used to refer to search results |
| filter (ItineraryFilter, Required) | Used to input the desired filtering and sorting criteria |
| cabinClassOptions(Array\[String], Optional) | Information about the seat class you want to filter and sort |
| step(String, Required) | Information used to distinguish between departure and return
|
| flightType(String, Required) | Flight type information
|
| stopOption(Array\[String], Optional) | Stop Information |
| airlineOptions(Array\[String], Optional) | Airline information |
| departureDateTimeOptions (Array\[String], Optional) | Information about departure time starts at around or at what time
|
| arrivalDateTimeReturnOptions (Array\[String], Optional) | The end time information starts at what time or interval
|
| groupId(String, Required) | Itinerary identifier in the itinerary list retrieved from the search results |
**Example**
```json
{
"searchId": "ATD::210707::66c84a6f-fa81-4526-a2d9-2f7b7975214b",
"departureItinerary": null,
"filter": {
"stopOptions": [],
"airlineOptions": [],
"cabinClassOptions": [],
"ticketPolicyOptions": [],
"departureDateTimeOptions": [],
"arrivalDateTimeOptions": [],
"departureDateTimeReturnOptions": [],
"arrivalDateTimeReturnOptions": [],
"flightType": "DOMESTIC",
"groupId": "052a9f35-12eb-430b-baa0-7ea85a98e8b3",
"loadMore": true,
"step": "1"
}
}
```
#### Response Type of flight domestic or international? Flight type:
|
| groupId(String, Required) | Journey identifier in the list of journeys returned by search results |
| originCity(String, Optional) | City name at departure point |
| originCountry(String, Optional) | Country name at departure point |
| originCountryCode(String, Optional) | Country code at departure point |
| originLocationCode(String, Optional) | Flight departure city code |
| originLocationName(String, Optional) | Airport name at departure point |
| totalPricedItinerary (Integer, Required) | Total number of detailed journeys |
| pricedItineraries (Array\[PricedItineraries], Required) | Itinerary details |
| airItineraryPricingInfo (AirItineraryPricingInfo, Required) | Detailed price information of the itinerary |
| adultFare (FareBreakdown, Required) | |
| passengerFare (PassengerFare, Required) | Adult fare information |
| baseFare(FareInfo, required) | Basic fare information |
| amount (Double, Required) | Amount of money |
| decimalPlaces(Integer, Optional) | Decimal places rounded to |
| equivFare (FareInfo, Optional) | Similar to baseFare
|
| serviceTax (FareInfo, Required) | Similar to baseFare
|
| totalFare (FareInfo, Required) | Similar to baseFare
|
| surcharges (Array\[Surcharge], Required) | Information about surcharges per booking / per segment |
| passengerTypeQuantities (PassengerTypeQuantities, Optional) | Number/type of passengers |
| code(String, Required) | Adult/Child/Infant Identifier
|
| quantity (Integer, Required) | Number of adults / children / infants |
| childFare(PassengerFare, Optional) | Child fare information
|
| infantFare (PassengerFare, Optional) | Infant fare information
|
| itinTotalFare (PassengerFare, Required) | Total fare information of the journey
|
| fareSourceCode(String, Required) | Journey identifier information
|
| allowHold (Boolean, Required) | Information to allow to hold a reservation or not |
| cabinClassName(String, Required) | Seat class information:
|
| fightNo(String, Optional) | Displays aircraft number information |
| originDestinationOptions (Array(OriginDestinationOptions), Required) | Cruise’s blocking/stopping information |
| flightDirection(String, Required) | Show flight direction information of the journey
|
| journeyDuration (Integer, Required) | Show flight time |
| flightSegments (Array(FlightSegments), Required) | Show detailed information of departure / end points in the journey |
| page (AirPage, Required) | Object that describes information about pagination.
|
| duration(Integer, Optional), | |
| errors (Array\[Error], Optional) | |
| infos(Array\[Info], Optional) | |
| success(Boolean, Optional) | |
| textMessage(String, Optional) | |
**Example**
```json
{
"duration" : 1025,
"errors" : null,
"groupPricedItinerary" : {
"airSupplier" : "VJ",
"aircraft" : "Airbus A321",
"vnaArea" : null,
"airline" : "VJ",
"airlineName" : "VietJet Air",
"arrivalDateTime" : "2021-07-23T07:20:00.000Z",
"departureDateTime" : "2021-07-23T05:10:00.000Z",
"destinationCity" : "Hồ Chí Minh",
"destinationCountry" : "Vietnam",
"destinationCountryCode" : "VN",
"destinationLocationCode" : "SGN",
"destinationLocationName" : "Sân bay Tân Sơn Nhất",
"fightNo" : "135",
"flightType" : "DOMESTIC",
"groupId" : "052a9f35-12eb-430b-baa0-7ea85a98e8b3",
"originCity" : "Hà Nội",
"originCountry" : "Vietnam",
"originCountryCode" : "VN",
"originLocationCode" : "HAN",
"originLocationName" : "Sân bay Nội Bài",
"pricedItineraries" : [ {
"airItineraryPricingInfo" : {
"adultFare" : {
"fareBasisCodes" : null,
"passengerFare" : {
"baseFare" : {
"amount" : 1319000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"comboMarkup" : null,
"equivFare" : null,
"serviceTax" : {
"amount" : 350900.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"surcharges" : [ {
"amount" : 0.0,
"indicator" : "Ticket fee per segment",
"type" : "Ticket fee per segment"
} ],
"taxes" : null,
"totalFare" : {
"amount" : 1669900.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalPaxFee" : null
},
"passengerTypeQuantities" : {
"code" : "ADT",
"quantity" : 1
}
},
"childFare" : null,
"divideInPartyIndicator" : false,
"fareInfoReferences" : null,
"fareSourceCode" : "dom95053f40-3fd0-4f62-a96c-d4afa489c283",
"fareType" : "PUBLIC",
"infantFare" : null,
"itinTotalFare" : {
"baseFare" : {
"amount" : 1319000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"comboMarkup" : null,
"equivFare" : null,
"serviceTax" : {
"amount" : 350900.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalFare" : {
"amount" : 1669900.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalPaxFee" : null,
"totalTax" : {
"amount" : 0.0,
"currencyCode" : null,
"decimalPlaces" : 2
}
}
},
"allowHold" : true,
"baggageItems" : [ {
"amount" : 0.0,
"code" : "air-tickets.baggage-items.vietnam.vj.economy.baggage.adult.free",
"direction" : null,
"fareCode" : null,
"id" : "air-tickets.baggage-items.vietnam.vj.economy.baggage.adult.free",
"name" : "7kg xách tay",
"serviceType" : "BAGGAGE"
} ],
"cabinClassName" : "ECONOMY",
"directionInd" : "DEPARTURE",
"fightNo" : "135",
"mealItems" : null,
"onlyPayLater" : false,
"originDestinationOptions" : [ {
"cabinClassName" : "ECONOMY",
"destinationCity" : "Hồ Chí Minh",
"destinationDateTime" : "2021-07-23T07:20:00.000Z",
"destinationLocationCode" : "SGN",
"destinationLocationName" : "Sân bay Tân Sơn Nhất",
"flightDirection" : "D",
"flightSegments" : [ {
"adultBaggage" : null,
"aircraft" : "Airbus A321",
"arrivalAirportLocationCode" : "SGN",
"arrivalAirportLocationName" : "Sân bay Tân Sơn Nhất",
"arrivalCity" : "Hồ Chí Minh",
"arrivalDateTime" : "2021-07-23T07:20:00.000Z",
"cabinClassCode" : "L1_ECO",
"cabinClassName" : "ECONOMY",
"cabinClassText" : "Economy",
"childBaggage" : null,
"departureAirportLocationCode" : "HAN",
"departureAirportLocationName" : "Sân bay Nội Bài",
"departureCity" : "Hà Nội",
"departureDateTime" : "2021-07-23T05:10:00.000Z",
"eticket" : true,
"fareBasicCode" : null,
"fareCode" : null,
"flightDirection" : "D",
"flightNumber" : "135",
"infantBaggage" : null,
"journeyDuration" : 130,
"marketingAirlineCode" : "VJ",
"marriageGroup" : null,
"mealCode" : null,
"operatingAirline" : {
"code" : "VJ",
"equipment" : null,
"flightNumber" : "135",
"name" : "VietJet Air"
},
"resBookDesignCode" : "L1_ECO",
"seatsRemaining" : null,
"stopQuantity" : 0,
"stopQuantityInfo" : null,
"supplierFareKey" : null,
"supplierJourneyKey" : "FE1G3mI6J96guNcAzJB8yTeBzLZRAYEOnwn9YGOFJJztƒS7kLTBSBi25njFnV5B0HNFbXtvvIQiUDfNE¥Pqx3WSriPxr9IlTddLHufsqIM0oNnapPeNa1YAcBL4BUZyzjPyb¥0vzaCP¥5Bk9LpFxJTyFThaƒJiL7Tkƒhz4a¥FVSƒXfpqmsCaQWijrGgcOExEM7¥YXajB5L1W9SjqIYUUSewƒSb7BuyBX9sYii0QbSnQ8BdSvR4f2sq3pzUPx3AdCb2hZzEbIfpSEF8q5JAvRjuANKRqQhVei1eyTI72ZPbI0lKƒvrLemkP6OyE88rTƒuvxxHDe¥6K9dKwVV4GtkXj3J3lQOMsH2HKNOmpwG5TR4L1RiOI75PJ4YkC62AHux5vvTƒ¥R8vac6V9lKlMeMFra27Bv3qYhfwSWCgGNOcFsrs2yO1W¥WWXNMvWA2jNKUJl1H65iX18UHyzANy9Vrcthtjjr6PXKZHhQPnLP¥flZA="
} ],
"journeyDuration" : 130,
"originCity" : "Hà Nội",
"originDateTime" : "2021-07-23T05:10:00.000Z",
"originLocationCode" : "HAN",
"originLocationName" : "Sân bay Nội Bài"
} ],
"passportMandatory" : true,
"refundable" : false,
"sequenceNumber" : "ibe3640395997485504",
"ticketType" : "ETICKET",
"validReturnCabinClasses" : null,
"validatingAirlineCode" : "VJ",
"validatingAirlineName" : "VietJet Air"
}, {
"airItineraryPricingInfo" : {
"adultFare" : {
"fareBasisCodes" : null,
"passengerFare" : {
"baseFare" : {
"amount" : 1499000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"comboMarkup" : null,
"equivFare" : null,
"serviceTax" : {
"amount" : 368900.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"surcharges" : [ {
"amount" : 0.0,
"indicator" : "Ticket fee per segment",
"type" : "Ticket fee per segment"
} ],
"taxes" : null,
"totalFare" : {
"amount" : 1867900.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalPaxFee" : null
},
"passengerTypeQuantities" : {
"code" : "ADT",
"quantity" : 1
}
},
"childFare" : null,
"divideInPartyIndicator" : false,
"fareInfoReferences" : null,
"fareSourceCode" : "domb8304899-04b8-4ff4-9262-9ad713608507",
"fareType" : "PUBLIC",
"infantFare" : null,
"itinTotalFare" : {
"baseFare" : {
"amount" : 1499000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"comboMarkup" : null,
"equivFare" : null,
"serviceTax" : {
"amount" : 368900.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalFare" : {
"amount" : 1867900.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalPaxFee" : null,
"totalTax" : {
"amount" : 0.0,
"currencyCode" : null,
"decimalPlaces" : 2
}
}
},
"allowHold" : true,
"baggageItems" : [ {
"amount" : 0.0,
"code" : "air-tickets.baggage-items.vietnam.vj.premium.baggage.adult.free",
"direction" : null,
"fareCode" : null,
"id" : "air-tickets.baggage-items.vietnam.vj.premium.baggage.adult.free",
"name" : "7kg xách tay + 20kg ký gửi",
"serviceType" : "BAGGAGE"
} ],
"cabinClassName" : "PREMIUM",
"directionInd" : "DEPARTURE",
"fightNo" : "135",
"mealItems" : null,
"onlyPayLater" : false,
"originDestinationOptions" : [ {
"cabinClassName" : "PREMIUM",
"destinationCity" : "Hồ Chí Minh",
"destinationDateTime" : "2021-07-23T07:20:00.000Z",
"destinationLocationCode" : "SGN",
"destinationLocationName" : "Sân bay Tân Sơn Nhất",
"flightDirection" : "D",
"flightSegments" : [ {
"adultBaggage" : null,
"aircraft" : "Airbus A321",
"arrivalAirportLocationCode" : "SGN",
"arrivalAirportLocationName" : "Sân bay Tân Sơn Nhất",
"arrivalCity" : "Hồ Chí Minh",
"arrivalDateTime" : "2021-07-23T07:20:00.000Z",
"cabinClassCode" : "B1_DLX",
"cabinClassName" : "PREMIUM",
"cabinClassText" : "Premium",
"childBaggage" : null,
"departureAirportLocationCode" : "HAN",
"departureAirportLocationName" : "Sân bay Nội Bài",
"departureCity" : "Hà Nội",
"departureDateTime" : "2021-07-23T05:10:00.000Z",
"eticket" : true,
"fareBasicCode" : null,
"fareCode" : null,
"flightDirection" : "D",
"flightNumber" : "135",
"infantBaggage" : null,
"journeyDuration" : 130,
"marketingAirlineCode" : "VJ",
"marriageGroup" : null,
"mealCode" : null,
"operatingAirline" : {
"code" : "VJ",
"equipment" : null,
"flightNumber" : "135",
"name" : "VietJet Air"
},
"resBookDesignCode" : "B1_DLX",
"seatsRemaining" : null,
"stopQuantity" : 0,
"stopQuantityInfo" : null,
"supplierFareKey" : null,
"supplierJourneyKey" : "FE1G3mI6J96guNcAzJB8ySG7yJpj7V0vJxur9hB00jyNcwƒ20DdiB6fj9ƒvf9GgUPS3rI8a¥ƒYn83OMqVXPoZwCp649T3OB0aQ7ItYXABxYRfM6ZiDbfC62m¥¥yAZf5jf7NBG6IJSBVQnsJZWUMvrv6CtZ9j1N5OQ5sUtFN37WkEjJEfSORxmB2ZQdKamFtKHi¥dgP¥7EYIHXmy1f6hdavIhehIqx9Kl¥0gPaxg2ycItGrM0ZkRcUFypKbAlYoUw8DaNiLc3Q3XcNkHy0LJlg4QzLcoWk6uwDkBMr3KUnCxyBR1beBxMhopJovzMvnRZWaWuTMfz¥7dhh32SnQ9OzYwz0uZ¥FreZDsZLp1kzrXPZDcmzsxpvfVaclBhMlJPxz¥ByUpAMUKCQyhfbDINrCiqXDKG5aFEXYs5AFl2SyTl12¥ghZJ8nfkZve9QoEA0EEfsSomUdKcaNƒrCH1H1Esj8jVUthM3fCppoSJPGjOjI="
} ],
"journeyDuration" : 130,
"originCity" : "Hà Nội",
"originDateTime" : "2021-07-23T05:10:00.000Z",
"originLocationCode" : "HAN",
"originLocationName" : "Sân bay Nội Bài"
} ],
"passportMandatory" : true,
"refundable" : false,
"sequenceNumber" : "ibe3640395997554532",
"ticketType" : "ETICKET",
"validReturnCabinClasses" : null,
"validatingAirlineCode" : "VJ",
"validatingAirlineName" : "VietJet Air"
}, {
"airItineraryPricingInfo" : {
"adultFare" : {
"fareBasisCodes" : null,
"passengerFare" : {
"baseFare" : {
"amount" : 3200000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"comboMarkup" : null,
"equivFare" : null,
"serviceTax" : {
"amount" : 539000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"surcharges" : [ {
"amount" : 0.0,
"indicator" : "Ticket fee per segment",
"type" : "Ticket fee per segment"
} ],
"taxes" : null,
"totalFare" : {
"amount" : 3739000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalPaxFee" : null
},
"passengerTypeQuantities" : {
"code" : "ADT",
"quantity" : 1
}
},
"childFare" : null,
"divideInPartyIndicator" : false,
"fareInfoReferences" : null,
"fareSourceCode" : "dom1c7a82fb-83f9-4fe0-9451-bb023179deaa",
"fareType" : "PUBLIC",
"infantFare" : null,
"itinTotalFare" : {
"baseFare" : {
"amount" : 3200000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"comboMarkup" : null,
"equivFare" : null,
"serviceTax" : {
"amount" : 539000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalFare" : {
"amount" : 3739000.0,
"currencyCode" : null,
"decimalPlaces" : 2
},
"totalPaxFee" : null,
"totalTax" : {
"amount" : 0.0,
"currencyCode" : null,
"decimalPlaces" : 2
}
}
},
"allowHold" : true,
"baggageItems" : [ {
"amount" : 0.0,
"code" : "air-tickets.baggage-items.vietnam.vj.business.baggage.adult.free",
"direction" : null,
"fareCode" : null,
"id" : "air-tickets.baggage-items.vietnam.vj.business.baggage.adult.free",
"name" : "10kg xách tay + 30kg ký gửi",
"serviceType" : "BAGGAGE"
} ],
"cabinClassName" : "BUSINESS",
"directionInd" : "DEPARTURE",
"fightNo" : "135",
"mealItems" : null,
"onlyPayLater" : false,
"originDestinationOptions" : [ {
"cabinClassName" : "BUSINESS",
"destinationCity" : "Hồ Chí Minh",
"destinationDateTime" : "2021-07-23T07:20:00.000Z",
"destinationLocationCode" : "SGN",
"destinationLocationName" : "Sân bay Tân Sơn Nhất",
"flightDirection" : "D",
"flightSegments" : [ {
"adultBaggage" : null,
"aircraft" : "Airbus A321",
"arrivalAirportLocationCode" : "SGN",
"arrivalAirportLocationName" : "Sân bay Tân Sơn Nhất",
"arrivalCity" : "Hồ Chí Minh",
"arrivalDateTime" : "2021-07-23T07:20:00.000Z",
"cabinClassCode" : "V_SBoss",
"cabinClassName" : "BUSINESS",
"cabinClassText" : "SkyBoss",
"childBaggage" : null,
"departureAirportLocationCode" : "HAN",
"departureAirportLocationName" : "Sân bay Nội Bài",
"departureCity" : "Hà Nội",
"departureDateTime" : "2021-07-23T05:10:00.000Z",
"eticket" : true,
"fareBasicCode" : null,
"fareCode" : null,
"flightDirection" : "D",
"flightNumber" : "135",
"infantBaggage" : null,
"journeyDuration" : 130,
"marketingAirlineCode" : "VJ",
"marriageGroup" : null,
"mealCode" : null,
"operatingAirline" : {
"code" : "VJ",
"equipment" : null,
"flightNumber" : "135",
"name" : "VietJet Air"
},
"resBookDesignCode" : "V_SBoss",
"seatsRemaining" : null,
"stopQuantity" : 0,
"stopQuantityInfo" : null,
"supplierFareKey" : null,
"supplierJourneyKey" : "FE1G3mI6J96guNcAzJB8yZ¥FGw7p5Weqh1jFldOtANHbBsM1ZM4xm9eJCMdqbmYTODQA1GPi0yHK6bYrz1U6SPAnrzCjhNqS6fuU9vMGIlpY3BwX937d9zbpx5aotYD2Hkad7SVACsbXLfkhQm2Bu0X¥k9ƒAQbtCjpXj6rFƒKBXVZSRY4hOF8GQQZ2IFqdegJGFHN6kEeNGHYeJt39SUgpDDRMq0OtLvm0iic¥1YGj1AJVIaj6FUƒxPo4OkVIUB83axadxG7pbDxZCn28¥85bUM50I2Bcp4yxrKnHC7YkXWAKN5JhIQzRHTrt1HbQzF9MP3FP7PWoNvG0BHUndiYelƒ653zOv0dSzƒSX2Tzomz11Rf2fHWHPXwigUvBA74Zsy5vKwDNZxYYv9aJC3c33pEƒ6LsD5NDmdiSRtXzrl8tzStLzyjYapGU0fDSh9bThcZCxpeejWyEVyjHdgqV4e77ncQTeUWUKNa1ggƒrerpRc="
} ],
"journeyDuration" : 130,
"originCity" : "Hà Nội",
"originDateTime" : "2021-07-23T05:10:00.000Z",
"originLocationCode" : "HAN",
"originLocationName" : "Sân bay Nội Bài"
} ],
"passportMandatory" : true,
"refundable" : false,
"sequenceNumber" : "ibe3640395997606506",
"ticketType" : "ETICKET",
"validReturnCabinClasses" : null,
"validatingAirlineCode" : "VJ",
"validatingAirlineName" : "VietJet Air"
} ],
"requiredFields" : null,
"returnDateTime" : null,
"roundType" : "ROUNDTRIP",
"totalPricedItinerary" : 3
},
"infos" : null,
"searchId" : "ATD::210707::66c84a6f-fa81-4526-a2d9-2f7b7975214b",
"success" : true,
"textMessage" : null
}
```
***
### Get flight ticket condition API Data used to refer to search results
|
| groupId(String, Required) | Journey identifier in the list of journeys returned by search results |
| fareSourceCode(String, Required) | Journey identifier information |
Example
```
{
"fareSourceCode": "dom07b2da7b-3232-4294-9278-b35fb6307714",
"groupId": "27b091a7-62b8-4ce2-b45b-eda3340d7673",
"searchId": "ATD::210720::dc96e1a9-c39e-4f48-974e-e0be6abb45c7"
}
```
#### Response Departure time
|
| arrivalDateTime(String, Required) | Arrival time
|
| fareRuleItems (Array\[FareRuleItem], Required) | Detailed list of ticket conditions |
| detail(String, Required) | Detailed information about ticket conditions
|
| title(String, Required) | Information about the conditions of the return ticket / the condition of the return ticket |
| duration(Integer, Optional), | |
| errors (Array\[Error], Optional), | |
| infos(Array\[Info], Optional), | |
| success(Boolean, Optional), | |
| textMessage(String, Optional) | |
Example
```json
{
"duration": 1444,
"errors": null,
"fareRules": [
{
"arrivalAirportLocationCode": "SGN",
"arrivalAirportLocationName": null,
"arrivalCity": null,
"arrivalDateTime": "2021-08-16T07:55:00.000Z",
"departureAirportLocationCode": "HAN",
"departureAirportLocationName": null,
"departureCity": null,
"departureDateTime": "2021-08-16T05:45:00.000Z",
"fareRuleItems": [
{
"detail": "\n \n - Hạng đặt chỗ: Economy Saver\n - Thay đổi: Trước 3h tính từ giờ khởi hành từng chặng bay : 270.000 VND . Trong/sau 3h tính từ giờ khởi hành từng chặng bay: Không áp dụng\n - Hoàn/hủy vé: Không áp dụng\n - Đổi tên: Chỉ áp dụng đối với vé chưa sử dụng. Thay đổi trước giờ khởi hành 3h của chuyến bay đầu tiên và phải đổi tên cho cả hành trình, thu phí thay đổi tên 350.000 VND\n - Hành lý: Xách tay 7kg + Ký gửi 20kg\n - Suất ăn: Đã bao gồm\n - Hệ số cộng điểm Bamboo Club: 0.25\n\t - Ghi chú: Mọi thay đổi trên vé phải thực hiện trước 3h so với giờ khởi hành hoặc theo quy định của từng loại vé. Tất cả phí áp dụng chưa bao gồm VAT và được tính cho từng khách/chặng + chênh lệch vé (nếu có). Tết Nguyên Đán 2022: 17/01/2022 – 16/02/2022\n\t\t - Ghi chú Covid-19: HÀNH KHÁCH KHI ĐẶT CHỖ MUA VÉ CẦN THỰC HIỆN KHAI BÁO Y TẾ ĐIỆN TỬ BẮT BUỘC TRƯỚC KHI TỚI SÂN BAY\n Tham khảo thêm Điều kiện giá vé áp dụng cho các vé xuất và khởi hành từ ngày 01/03/2021 \n\t\t\t\n ",
"title": "Điều kiện chiều đi"
}
],
"operatingAirline": {
"code": "VN",
"equipment": null,
"flightNumber": null,
"name": null
}
}
],
"fareSourceCode": null,
"groupId": null,
"infos": null,
"searchId": null,
"success": true,
"textMessage": null
}
```
# Booking API
### Ticket Status Check API Data used to refer to search results
|
| groupId(String, Required) | Journey identifier in the list of journeys returned by search results |
| fareSourceCode(String, Required) | Journey identifier information |
**Example**
```json
{
"fareSourceCode": "dom07b2da7b-3232-4294-9278-b35fb6307714",
"groupId": "27b091a7-62b8-4ce2-b45b-eda3340d7673",
"searchId": "ATD::210720::dc96e1a9-c39e-4f48-974e-e0be6abb45c7"
}
```
#### Response Data used to refer to search results
|
| groupId(String, Required) | Journey identifier in the list of journeys returned by search results |
| fareSourceCode(String, Required) | Journey identifier information |
**Example**
```json
{
"itineraryInfos": [
{
"fareSourceCode": "dom07b2da7b-3232-4294-9278-b35fb6307714",
"groupId": "27b091a7-62b8-4ce2-b45b-eda3340d7673",
"searchId": "ATD::210720::dc96e1a9-c39e-4f48-974e-e0be6abb45c7"
},
{
"fareSourceCode": "domb771ff7f-57b5-4bd5-9443-e43b79f61aaa",
"groupId": "8ceaa3c5-bbcf-451a-95ae-cd0a81e60993",
"searchId": "ATD::210720::dc96e1a9-c39e-4f48-974e-e0be6abb45c7-R"
}
]
}
```
#### Response Information showing the type of booking: Domestic or international
|
| departDraftItineraryInfo (DraftItineraryInfo, Required) | Outbound itinerary information |
| bookingDirection(String, Required) | Direction information
|
| fareSourceCode(String, Required) | Journey identifier information |
| groupId(String, Required) | Journey identifier in the list of journeys returned by search results |
| itinTotalFare (ItinTotalFare, Required) | Information about the prices of the journey |
| baseFare(FareInfo, required) | Basic fare information |
| amount (Double, Required) | Amount of money |
| decimalPlaces(Integer, Optional) | Decimal places rounded to |
| equivFare (FareInfo, Optional) | Similar to baseFare |
| Ticketing fee information | |
| serviceTax (FareInfo, Required) | Similar to baseFare |
| Service fee information | |
| totalTax (FareInfo, Required) | Similar to baseFare |
| Information about total service fee | |
| totalFare (FareInfo, Required) | Similar to baseFare |
| Total ticket price information | |
| returnDraftItineraryInfo (DraftItineraryInfo, Optional) | Similar to the detailed information of the outbound journey |
| Return journey information | |
| duration(Integer, Optional) | |
| errors (Array\[Error], Optional) | |
| infos(Array\[Info], Optional) | |
| success(Boolean, Optional) | |
| textMessage(String, Optional) | |
**Example**
```json
{
"bookingCode": {
"bookingCode": "BOD::210720::b87fd70e-4a9b-4532-9cb6-7d8142822ac3",
"bookingNumber": "ADCO2107201223803"
},
"bookingType": "DOME",
"departDraftItineraryInfo": {
"bookingDirection": "DEPARTURE",
"fareSourceCode": "dom07b2da7b-3232-4294-9278-b35fb6307714",
"groupId": "27b091a7-62b8-4ce2-b45b-eda3340d7673",
"itinTotalFare": {
"baseFare": {
"amount": 399000,
"currencyCode": null,
"decimalPlaces": 2
},
"comboMarkup": null,
"equivFare": {
"amount": 0,
"currencyCode": null,
"decimalPlaces": 2
},
"serviceTax": {
"amount": 512000,
"currencyCode": null,
"decimalPlaces": 2
},
"totalFare": {
"amount": 911000,
"currencyCode": null,
"decimalPlaces": 2
},
"totalPaxFee": null,
"totalTax": {
"amount": 0,
"currencyCode": null,
"decimalPlaces": 2
}
},
"searchId": "ATD::210720::dc96e1a9-c39e-4f48-974e-e0be6abb45c7"
},
"duration": 3498,
"errors": null,
"infos": null,
"isPerBookingType": true,
"isRoundTripType": true,
"isSuccess": true,
"markupType": "PER_BOOKING",
"returnDraftItineraryInfo": {
"bookingDirection": "RETURN",
"fareSourceCode": "domb771ff7f-57b5-4bd5-9443-e43b79f61aaa",
"groupId": "8ceaa3c5-bbcf-451a-95ae-cd0a81e60993",
"itinTotalFare": {
"baseFare": {
"amount": 1319000,
"currencyCode": null,
"decimalPlaces": 2
},
"comboMarkup": null,
"equivFare": null,
"serviceTax": {
"amount": 350900,
"currencyCode": null,
"decimalPlaces": 2
},
"totalFare": {
"amount": 1669900,
"currencyCode": null,
"decimalPlaces": 2
},
"totalPaxFee": null,
"totalTax": {
"amount": 0,
"currencyCode": null,
"decimalPlaces": 2
}
},
"searchId": "ATD::210720::dc96e1a9-c39e-4f48-974e-e0be6abb45c7-R"
},
"roundType": "RoundTrip",
"success": true,
"textMessage": null
}
```
***
### Get booking detail API
Parameters
* keyword query (String, optional) Search keyword
* language query (String, Required)
Language
* `vi` : Vietnamese
* `en`: English
* pageNumber `query` (String, Optional)
Page No
* pageSize `quer`y (String, Optional)
Number of elements on the page
## Response
**Code 200**
Model
* result(SearchKeywordResult, optional) Information returned results
* contents (Array\[Content], optional), List of areas, hotels
* searchCode(String, optional), Search Identifier
* searchType(string, optional) = \[CONTINENT, COUNTRY, PROVINCE\_STATE, HIGH\_LEVEL\_REGION, MULTI\_CITY\_VICINITY, CITY, NEIGHBORHOOD, AIRPORT, POINT\_OF\_INTEREST, TRAIN\_STATION, METRO\_STATION, HOTEL],
Search Type
* name(String, optional), Name of area, hotel
* supplier(String, optional) = \[EXPEDIA, AXISROOM, BEDLINKER, VINPEARL], Supplier
* address(Address, optional) Hotel address information
* city(string, optional), City
* countryCode(string, optional), Country code
* countryName(string, optional), Country name
* lineOne(string, optional), Address line 1
* lineTwo(string, optional), Address line 2
* postalCode(string, optional), ZIP code
* stateProvinceCode(string, optional), City code
* stateProvinceName(string, optional) Name of province
* tags (Array\[String], optional), Tags
* duration (integer, optional),
* errors (Array\[Error], optional),
* infos(Array\[Info], optional),
* success(boolean, optional),
* textMessage(string, optional)
## 2. Hotel Search API with best price selection (search-best-rate)
`GET: /api/v3/hotel/search-best-rates`
Returns hotel search results with the best price selection.
The data will be cached for a period of time with the key as searchId. Caching time is about 15 minutes, this time is subject to change.
Allows filtering and sorting of returned results.
[Filtering by coordinates, distance requires 3 parameters:](#user-content-fn-1)[^1]
* filterGeoDistanceLat
* filterGeoDistanceLon
* filterGeoDistanceMeters
Parameters
* rateOption query(String, optional)
Price options. There are 2 pricing options: `OTA, TA`. Default is `OTA`.
Attention
* Only TA contracting partners can use the TA pricing option.
* If you want to get both price options, then `?rateOption=TA,OTA&...`
* searchCode `query` (String, Required)
Area code or hotel code.
* In case you want to search by hotel list, you must first get the hotel list containing the id to search.
* Syntax to find multiple hotels `...&searchCode=id1,id2,id3&searchType=HOTEL&supplier=GOTADI&...`
* searchType `query` (String, Required)
Area code type. Ex: CITY, HOTEL, …
* language `query` (String, Required)
Language. (vi, en)
* currency `query` (String, Required)
Currency. (VND, USD)
* checkIn `query` (String, Required)
Check-in date. Format: yyyy-MM-dd
* checkOut `query` (String, Required)
Check-out date. Format: yyyy-MM-dd
* paxInfos `query` (String\[], Required)
Room and guest information
Format: `SoNguoiLon-TuoiTreEm1,TuoiTreEm2`
For example:
* 2 adults and 2 children, 1 4-year-old, 1 6-year-old: `...&paxInfos=2-4,6&...`
* 2 rooms, room 1 includes 2 adults, room 2 includes 2 adults and 2 children, 1 child 4 years old and 1 child 6 years old: `...&paxInfos=2&paxInfos=2-4,6&...`
* supplier `query` (String, Required)
Supplier, Get information from the results returned item 4.2
* filterHotelName `query` (String, Optional)
Filter by names that start with
* filterHotelCategories `query` (String, Optional)
Filter by hotel category
* filterFromPrice `query` (Double, Optional)
Filter by price starting from
* filterToPrice `query` (Double, Optional)
Filter by price ending to
* filterFromStarRating `query` (Double, Optional)
Filter by star rating starting from
* filterToStarRating `query` (Double, Optional)
Filter by star rating ending to
* filterFromGuestRating `query` (Double, Optional)
Filter by guest reviews starting at
* filterToGuestRating `query` (Double, Optional)
Filter by guest reviews ending in
* filterAmenities `query` (String\[], Optional)
Filter by hotel amenities
* filterRoomAmenities `query` (String\[], Optional)
Filter by room amenities
* filterRoomViews `query` (String\[], Optional)
Filter by room view
* filterThemes `query` (String\[], Optional)
Filter by hotel theme
* filterMealPlans `query` (String\[], Optional)
Filter by meal
* filterGeoDistanceLat `query` (Double, Optional)
Filter by lat . coordinates
* filterGeoDistanceLon `query` (Double, Optional)
Filter by coordinates lon
* filterGeoDistanceMeters `query` (Integer, Optional)
Filter by coordinates and distance. Units of meters
* sortField `query`(String, Optional)
Sort by: price, starRating, guestRating
* sortOrder `query`(String, Optional)
Sort by: ASC, DESC
* pageNumber `query` (String, Optional)
Page No
* pageSize `query` (String, Optional)
Number of elements on the page
#### Response
Model
* result (Object, Optional)
Thông tin kết quả trả về
* searchId (String, Optional)
* Mã tham chiếu đến kết quả tìm kiếm
* searchId được tạo ra dựa trên các tham số bắt buộc, nếu các tham số không thay đổi thì searchId sẽ không thay đổi
* Được dùng làm tham số khi search-all-rates
* propertyAvailable (Array\[PropertyAvailable], Optional)
Mảng chứa đối tượng thông tin khách sạn
* address (Address, optional),
Thông tin địa chỉ khách sạn
* city (string, optional),
Thành phố
* countryCode (string, optional),
Mã quốc gia
* countryName (string, optional),
Tên quốc gia
* lineOne (string, optional),
Địa chỉ dòng 1
* lineTow (string, optional),
Địa chỉ dòng 2
* postalCode (string, optional),
Mã bưu điện
* stateProvinceCode (string, optional),
Mã tỉnh thành
* stateProvinceName (string, optional)
Tên tỉnh thành
* amenities (Array\[Amenity], optional),
Thông tin danh sách tện nghi kèm theo của tùy chọn giá
* id (string, optional),
Id của tiện nghi
* name (string, optional)
Tên của tiện nghi
* ~~value (string, optional)~~
* ~~group (string, optional)~~
* basePrice (number, optional),
Giá cơ bản
* basePriceBeforePromo (number, optional),
Giá cơ bản trước khuyến mãi. Nếu không có khuyến mãi thì giá trị là 0
* breakfastIncluded (boolean, optional),
Có bao gồm bữa ăn sáng hay không
* cancelFree (boolean, optional),
Cho phép hủy phòng miễn phí hay không
* currency (string, optional) = \[‘VND’, ‘USD’],
Tiền tệ
* images (Array\[HotelImage], optional),
Thông tin hình ảnh của khách sạn
* caption (string, optional),
Tiêu đề hình ảnh
* link (string, optional),
Liên kết hình ảnh, là đường dẫn tuyệt đối
* position (integer, optional)
Vị trí sắp xếp của hình ảnh
* language (string, optional) = \[‘vi’, ‘en’],
Ngôn ngữ
* latitude (number, optional),
Vĩ độ
* longitude (number, optional),
Kinh độ
* promo (boolean, optional),
Có khuyến mãi hay không
* propertyCategory (PropertyCategory, optional),
Danh mục khách sạn
* id (string, optional),
Id danh mục khách sạn
* name (string, optional)
Tên danh mục khách sạn
* propertyId (string, optional),
Id định danh khách sạn
* propertyName (string, optional),
Tên khách sạn
* refundable (boolean, optional),
Có được trả tiền khi hủy phòng hay không
* reviewCount (string, optional),
Số lượng đánh giá của khách
* ~~reviewRecommendPercent (string, optional),~~
* reviewScore (string, optional),
Điểm đánh giá trung bình của khách. Lớn nhất là 5
* stars (string, optional),
Hạng sao khách sạn
* supplier (string, optional) = \[‘EXPEDIA’, ‘AXISROOM’, ‘BEDLINKER’],
Nguồn cung cấp khách sạn
* tags (Array\[string], optional),
Thẻ cuả khách sạn
* taxAndServiceFree (number, optional),
Thuế và phí kèm theo
* totalPrice (number, optional),
Tổng giá tiền tạm tính
* totalRooms (integer, optional),
Số lượng phòng còn trống có thể book
* ~~tripAdvisor (TripAdvisor, optional)~~
* rateOption (String, optional)
Tuỳ chọn giá. Có 2 tuỳ chọn giá là `OTA, TA`. Mặc định là `OTA`.
* masterPropertyId (Long, optional)
Mã định danh khách sạn chính.
* pageResult (Object, Optional)
Thông tin trang trả về
* pageSize (Integer, Optional)
Kích thước trang
* pageNumber (Integer, Optional)
Thứ tự trang
* totalPage (Integer, Optional)
Tổng số trang
* totalItems (Integer, Optional)
Tổng số phần tử
* duration (Integer, Optional)
* success (Integer, Bool)
* infos (Array\[InfosDTO], Optional)
* errors (Array\[ErrorsDTO], Optional)
* textMessage (String, Optional)
### 3. API Filter option
Parameters
* language `query` (String, Required)
Ngôn ngữ
* `vi` : Tiếng Việt
* `en`: Tiếng Anh
#### Response
Model
* result (FilterOptionsResult, optional)
Thông tin kết quả trả về
* guestRatings (Array\[FilterItemDouble], optional),
Thông tin đánh giá khách sạn của khách. Cao nhất là 5
* name (string, optional),
Tên bộ lọc đánh giá của khách
* value (number, optional)
Giá trị bộ lọc đánh gía của khách
* language (string, optional) = \[‘vi’, ‘en’],
Ngôn ngữ trả về
* mealPlans (Array\[FilterItemString], optional),
Thông tin tùy chọn bộ lọc theo bữa ăn
* name (string, optional),
Mô tả bữa ăn
* value (string, optional)
Id của bộ lọc bữa ăn
* prices (Array\[FilterPrice], optional),
Thông tin tùy chọn theo bộ lọc giá
* operator (string, optional),
Phương thức so sánh
* `less_than`: Giá nhỏ hơn
* `range`: Giá trong khoảng
* `greater_than`: Giá lớn hơn
* from (number, optional),
Giá từ
* to (number, optional)
Giá đến
* propertyAmenities (Array\[FilterItemString], optional),
Thông tin bộ lọc theo tiện nghi khách sạn
* name (string, optional),
Mô tả tiện nghi
* value (string, optional)
Id của bộ lọc tiện nghi
* propertyCategories (Array\[FilterItemString], optional),
Thông tin bộ lọc theo danh mục khách sạn
* name (string, optional),
Mô tả danh mục khách sạn
* value (string, optional)
Id của bộ lọc theo danh mục khách sạn
* propertyRatings (Array\[FilterItemDouble], optional),
Thông tin bộ lọc theo hạng sao
* name (string, optional),
Mô tả hạng sao
* value (number, optional)
Giá trị hạng sao
* roomAmenities (Array\[FilterItemString], optional),
Thông tin bộ lọc theo tiện nghi trong phòng
* name (string, optional),
Mô tả tiện nghi trong phòng
* value (string, optional)
Id của bộ lọc theo tiện nghi trong phòng
* roomViews (Array\[FilterItemString], optional),
Thông tin bộ lọc theo hướng nhìn phòng
* name (string, optional),
Mô tả hướng nhìn phòng
* value (string, optional)
Id của bộ lọc theo hướng nhìn phòng
* themes (Array\[FilterItemString], optional)
Thông tin bộ lọc theo chủ đề của khách sạn
* name (string, optional),
Mô tả chủ đề của khách sạn
* value (string, optional)
Id của bộ lọc theo chủ đề
* bedTypes (Array\[FilterItemString], optional)
Thông tin bộ lọc theo loại giường của khách sạn
* name (string, optional),
Mô tả loại giường của khách sạn
* value (string, optional)
Id của bộ lọc theo loại giường
* duration (integer, optional),
* errors (Array\[Error], optional),
* infos (Array\[Info], optional),
* success (boolean, optional),
* textMessage (string, optional)
***
### 4. Hotel Searching API with all prices rates (search-all-rates)
Parameters
* searchId `query` (string, required)
Mã tìm kiếm, được lấy từ mục search-all-rate
* propertyId `query` (string, required)
Mã định danh khách sạn theo supplier. Được lấy từ kết quả trả về của search-best-rate
* supplier `query` (String, required)
Nhà cung cấp. Được lấy từ kết quả trả về của search-best-rate
* checkIn `query` (String, required)
Ngày nhận phòng.
Định dạng: `yyyy-MM-dd`
* checkOut `query` (String, required)
Ngày trả phòng.
Định dạng: `yyyy-MM-dd`
* paxInfos `query` (String\[], required)
Thông tin phòng và khách ở
Định dạng: `SoNguoiLon-TuoiTreEm1,TuoiTreEm2`
Ví dụ:
* 2 người lớn và 2 trẻ em, 1 trẻ 4 tuổi, 1 trẻ 6 tuổi: \`…\&paxInfos=2-4,6&…
* 2 phòng, phòng 1 gồm 2 người lớn, phòng 2 gồm 2 người lớn và 2 trẻ em, 1 trẻ em 4 tuổi và 1 trẻ em 6 tuổi: \`…\&paxInfos=2\&paxInfos=2-4,6&…
#### Response
Model
* result (SearchAllRatesResult, optional),
* tripId (string, optional),
Mã định danh kết quả search-all-rate, mỗi lần gọi search-all-rate sẽ tạo ra tripId mới, nó được sử dụng khi đi thao tác đặt phòng
* searchId (string, optional),
Mã tham chiếu đến search-best-rate, được lấy từ kết quả search-best-rate
* propertyAllRate (PropertyAllRate, optional)
Thông tin trả về chi tiết của một khách sạn, thông tin phòng và thông tin của tất cả tùy chọn giá
* address (Address, optional)
Thông tin địa chỉ khách sạn
* city (string, optional),
Thành phố
* countryCode (string, optional),
Mã quốc gia
* countryName (string, optional),
Tên quốc gia
* lineOne (string, optional),
Địa chỉ dòng 1
* lineTow (string, optional),
Địa chỉ dòng 2
* postalCode (string, optional),
Mã bưu điện
* stateProvinceCode (string, optional),
Mã tỉnh thành
* stateProvinceName (string, optional)
Tên tỉnh thành
* airportCode (string, optional),
Mã sân bay
* amenities (Array\[Amenity], optional),
Mảng đối tượng chứa thông tin tiện nghi của khách sạn
* id (string, optional),
Mã tiện nghi khách sạn
* name (string, optional),
Tên của tiện nghi khách sạn
* symbol (string, optional),
Biểu tượng hiển thị của tiện nghi khách sạn
* ~~value (string, optional)~~
* group (string, optional)
Thông tin tiện nghi của khách sạn được gom nhóm, với các nhóm sau
* `OTHER`: Tiện nghi khác
* `POPULAR_FACILITIES`: Tiện nghi phổ biến
* `SERVICE`: Dịch vụ
* `BUSINESS_SERVICE`: Dịch vụ doanh nghiệp
* `RECREATION`: Cơ sở giải trí
* `ENTERTAINMENT`: Giải trí đa phương tiện
* `FITNESS_AND_SPA`: fitness và spa
* `FOOD_AND_DRINK`: Khu vực ăn uống
* `CONVENIENCES`: Tiện ích
* `INTERNET`: Mạng intenet
* `PARKING_AND_TRANSPORT`: Khu vực để xe và đưa đón
* `PET`: Thú cưng
* ~~attributes (Array\[Attribute], optional),~~
* checkin (Checkin, optional),
Khoảng thời gian nhận phòng, theo giờ địa phương của khách sạn
* beginTime (string, optional),
Thời gian bắt đầu được nhận phòng. Mặc định: 14:00
* endTime (string, optional)
Thời gian kết thúc được nhận phòng. Mặc định: 24:00
* checkout (Checkout, optional),
Thông tin thời gian trả phòng. Mặc định trước 12:00
* endTime (string, optional)
Thời gian trả phòng tối đa. Mặc định trước 12:00
* currency (string, optional) = \[‘VND’, ‘USD’],
Thông tin tiền tệ trả về
* descriptions (Array\[Attribute], optional),
Thông tin mô tả về khách sạn
* id (string, optional),
Mã định danh thuộc tính mô tả
* name (string, optional),
Tên thuộc tính
* `description`: mô tả chung
* `amenities`: mô tả chung về tiện nghi của khách sạn
* `dining`: Mô tả về chỗ ăn uống của khách sạn
* `renovations`: Mô tả về quá trình cải tạo phòng hoặc khách sạn mới đây
* `national_ratings`: Nêu rõ nguồn xếp hạng sao của khách sạn
* `business_amenities`: Mô tả về tiện nghi dành cho doanh nghiệp tại chỗ nghỉ, Ví dụ: phòng hội nghị
* `rooms`: Mô tả về phòng
* `attractions`: Mô tả về điểm tham quan gần khách sạn
* `location`: Mô tả về vị trí của khách sạn
* `headline`: Mô tả tóm tắt
* value (string, optional)
Thông tin mô tả
* fees (Array\[Attribute], optional),
Thông tin mô tả về một số khoản phụ phí kèm theo
* id (string, optional),
Mã định danh thuộc tính phí
* name (string, optional),
Tên thuộc tính phí
* `mandatory`: Phí bắt buộc
* `optional`: Phí không bắt buộc
* value (string, optional)
Mô tả về khoản phí
* images (Array\[HotelImage], optional),
Hình ảnh của khách sạn
* caption (string, optional),
Tiêu đề của hình ảnh
* link (string, optional),
Liên kết tới hình ảnh. Liên kết tuyệt đối
* position (integer, optional)
Vị trí sắp xếp hình ảnh
* inclusions (Array\[Attribute], optional),
Mảng đối tượng chứa thông tin mô tả về thuộc tính của khách sạn
* id (string, optional),
Mã định danh thuộc tính
* name (string, optional),
Mô tả thuộc tính
* ~~value (string, optional)~~
* language (string, optional) = \[‘vi’, ‘en’],
Ngôn ngữ trả về
* latitude (number, optional),
Vĩ độ của khách sạn
* longitude (number, optional),
Kinh độ của khách sạn
* policies (Array\[Attribute], optional),
Thông tin về chính sách khách sạn mà khách cần lưu ý.
* id (string, optional),
Mã định danh chính sách
* name (string, optional),
Tên thuộc chính sách
* `know_before_you_go`: Mô tả thông tin có thể hữu ích khi lập kế hoạch cho chuyến đi đến nơi này
* value (string, optional)
Mô tả về chính sách
* propertyCategory (PropertyCategory, optional),
Danh mục của khách sạn
* id (string, optional),
Mã định danh danh mục khách sạn
* name (string, optional)
Tên danh mục khách sạn
* propertyId (string, optional),
Mã định danh khách sạn
* propertyName (string, optional),
Tên khách sạn
* ~~rank (integer, optional),~~
* rating (Rating, optional),
Đánh giá về khách sạn
* ratingGuest (RatingGuest, optional)
Đánh giá của khách
* amenities (string, optional),
Xếp hạng cho các tiện nghi do khách sạn cung cấp, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* cleanliness (string, optional),
Đánh giá mức độ sạch sẽ cho khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* comfort (string, optional),
Đánh giá mức độ thoải mái của các phòng, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* condition (string, optional),
Xếp hạng cho tình trạng của chỗ nghỉ, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* count (integer, optional),
Tất cả xếp hạng đánh giá của khách giành cho khách sạn
* location (string, optional),
Xếp hạng về mức độ hấp dẫn của vị trí của khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* neighborhood (string, optional),
Xếp hạng về mức độ hài lòng của khu vực lân cận của khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* overall (string, optional),
Đánh giá chung cho khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* quality (string, optional),
Xếp hạng chất lượng của các phòng, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* recommendationPercent (string, optional),
Phần trăm khách giới thiệu ở tại chỗ nghỉ này.
* ~~score (string, optional),~~
* service (string, optional),
Đánh giá về dịch vụ của nhân viên đối với chỗ nghỉ, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* value (string, optional)
Xếp hạng cho giá trị của bất động sản cung cấp cho chi phí lưu trú, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* ratingProperty (RatingProperty, optional)
Đánh giá hạng sao khách sạn
* rating (string, optional),
Giá trị sếp hạng. Trả về giá trị từ 0,0 đến 5,0. Giá trị 0,0 hoặc giá trị trống cho biết không có xếp hạng nào.
* type (string, optional)
Loại đánh giá
* `Star`: Xếp hạng sao của khách sạn
* rooms (Array\[PropertyRoom], optional),
Mảng đối tượng chứa thông tin phòng
* descriptions (Array\[Attribute], optional),
Thông tin mô tả
* id (string, optional),
Mã định danh
* name (string, optional),
Tên mô tả
* `overview`: Thông tin mô tả tổng quan về căn phòng
* value (string, optional)
Thông tin mô tả
* id (string, optional),
Mã định danh cho loại phòng
* images (Array\[RoomImage], optional),
Mảng đối tượng chứa thông tin hình ảnh của loại phòng
* caption (string, optional),
Tiêu đề của hình ảnh
* link (string, optional),
Liên kết tới hình ảnh, là liên kết tuyệt đối
* position (integer, optional)
Vị trí sắp xếp của hình ảnh
* name (string, optional),
Tên của loại phòng
* ratePlans (Array\[RatePlan], optional),
Mảng đối tượng chứa thông tin về tùy chọn giá
* amenities (Array\[Amenity], optional),
Mảng đối tượng chứa thông tin tiện nghi của tùy chọn giá
* id (string, optional),
Mã định danh tiện nghi
* name (string, optional),
Tên tiện nghi
* ~~value (string, optional)~~
* ~~group (sting, optional)~~
* basePrice (number, optional),
Giá cơ bản
* basePriceBeforePromo (number, optional),
Giá cơ bản trước khuyến mãi
* bedGroups (Array\[BedGroup], optional),
Mảng đối tượng nhóm giường trong phòng
* configurations (Array\[ConfigurationBedGroup], optional),
Thông tin cấu hình giường cho phòng
* quantity (integer, optional),
Số lượng giường
* size (string, optional),
Kích thước của giường
* type (string, optional)
Loại giường
* description (string, optional),
Mô tả hiển thị giường cho phòng này
* id (string, optional)
Mã định danh nhóm giường
* breakfastIncluded (boolean, optional),
Tùy chọn giá có bao gồm bữa sáng hay không
* cancelFree (boolean, optional),
Mô tả thông tin được phép hủy đặt phòng với tùy chọn giá này có tốn phí phạt hay không
* `true`: Hủy đặt phòng miễn phí
* `false`: Không đặt hủy đặt phòng miễn phí
* cancelFreeBeforeDate (string, optional),
Ngày giới hạn cho phép hủy đặt phòng với tùy chọn giá này một cách miễn phí
* cancelPenalties (Array\[CancelPenalty], optional),
Mô tả các hình thức phạt khi hủy đặt phòng với tùy chọn giá này. [Xem mô tả thêm ở đây](https://developer.gotadi.com/dev-guide/api-hotel/api-cancellation/#cac-hinh-thuc-phat)
* type (string, optional)
Loại hình phạt
* `NIGHTS`: Số đêm bị phạt
* `AMOUNT`: Số tiền bị phạt
* `PERCENT`: Số phần trăm bị phạt
* currency (string, optional) = \[‘VND’, ‘USD’],
Đơn vị tiền tệ đối với `type = AMOUNT`
* amount (string, optional),
Số tiền của hình phạt
* description (string, optional),
Mô tả về hình phạt
* nights (string, optional),
Số đêm bị tính phí phạt
* percent (string, optional),
Số phần trăm bị phạt
* startDate (string, optional),
Ngày bắt đầu có hiệu lực của hình phạt
* endDate (string, optional),
Ngày kết thúc của hình phạt
* fees (Map, optional),
Thông tin các loại phí được phu bởi khách sạn Giá trị mối loại phí là tổng của loại đó. Phạm vi ảnh hưởng của mô tả này chỉ là thông tin thông báo cho khách hàng biết.
* `mandatory_fee`: Một khoản phí bắt buộc do khách sạn thu khi nhận phòng hoặc trả phòng.
* `resort_fee`: Một khoản phí cho các tiện nghi và dịch vụ bổ sung và được khách sạn thu khi nhận phòng hoặc trả phòng.
* `mandatory_tax`: Khoản thuế bắt buộc do chỗ nghỉ thu khi nhận phòng hoặc trả phòng.
* paxPrice (Array\[PaxPrice], optional),
Mảng đối tượng chứa thông tin giá theo số lượng người ở trong một phòng
* nightPrices (Array\[NightPrice], optional),
Mảng đối tượng chứa thông tin giá theo từng đêm
* nightKey (string, optional),
Khóa định danh của từng đêm
* nightPriceDetails (Array\[NightPriceDetail], optional)
Mảng đối tượng chứ thông tin giá chi tiết theo từng đêm
* name (string, optional),
Tên loại giá
* `base_rate`: Giá cơ bản không bao gồm thuế phí
* `tax_and_service_fee`: Thuế và phí
* value (number, optional),
Số tiền
* ~~valueByHotelCurrency (string, optional)~~
* paxInfo (PaxInfo, optional)
Mô tả thông tin người ở
* adultQuantity (integer, optional),
Số lượng người lớn
* childAges (Array\[integer], optional),
Mảng chứa thông tin tuổi của trẻ em, số lượng phần từ mảng bằng với số lượng trẻ em
* childQuantity (integer, optional),
Số lượng trẻ em
* ~~infantQuantity (integer, optional)~~
* promo (boolean, optional),
Thông tin xác định có khuyến mãi hay không
* `true`: Có khuyến mãi
* `false`: Không có khuyến mãi
* promoDescription (string, optional),
Mô tả thông tin khuyến mãi
* ratePlanId (string, optional),
Mã định danh tùy chọn giá
* ratePlanName (string, optional),
Tên của tùy chọn giá
* refundable (boolean, optional),
Thông tin xác định khi hủy phòng có được hoàn tiền hay không
* `true`: Được hoàn tiền khi hủy
* `false`: Không được hoàn tiền khi hủy
* taxAndFees (number, optional),
Thuế và phí của tùy chọn giá
* totalPrice (number, optional),
Giá tổng cộng đã bao gồm thuế phí
* ~~totalPriceByHotelCurrency (number, optional),~~
* totalRooms (integer, optional)
Số lượng phòng còn trống
* roomArea (RoomArea, optional)
Thông tin về diện tích căn phòng
* `squareFeet`: Diện tích của phòng được tính bằng feet vuông
* `squareMeters`: Diện tích của phòng được tính bằng mét vuông
* bedGroupStatics (Array\[BedGroupStatic], optional)
Mảng các đối tượng nhóm giường trong phòng
* id (String, optional)
mã định danh nhóm giường
* name (String, optional)
Tên nhóm giường
* ~~value (String, optional)~~
* views (Array\[View], optional)
Thông tin mô tả hướng nhìn của phòng
* id (String, optional)
mã định danh hướng nhìn
* name (String, optional)
Mô tả hướng nhìn
* ~~value (String, optional)~~
* occupancyAllowed (OccupancyAllowed, optional)
Thông tin về số người ở được phép
* roomMaxAllowed (RoomMaxAllowed, optional)
Sức chứa tối đa
* adult (integer, optional)
Số người lớn
* children (integer, optional)
Số trẻ em
* total (integer, optional)
Tổng số người
* ~~roomAgeCategories (Array\[Attribute], optional)~~
* amenities (Array\[Amenity], optional)
Mảng chứa đối tương thông tin tiện nghi của phòng
* id (string, optional),
Mã định danh tiện nghi phòng
* name (string, optional),
Tên tiện nghi phòng
* symbol (string, optional),
Biểu tượng hiện thị của nghi phòng
* ~~value (string, optional)~~
* group (string, optional)
Thông tin tiện nghi của phòng được gom nhóm, với các nhóm sau
* `OTHER`: Tiện nghi khác
* `BEDROOM`: Tiện nghi phòng ngủ
* `BATHROOM`: Tiện nghi phòng tắm
* `ENTERTAINMENT`: Giải trí đa phương tiện trong phòng
* `FOOD_AND_DRINK`: Tiện nghi về đồ ăn thức uống trong phòng
* `ROOM_VIEW`: Hướng nhìn
* `INTERNET`: Mạng intenet
* `SMOKING`: Hút thuốc
* spokenLanguage (Array\[Attribute], optional),
Các ngôn ngữ giao tiếp với nhân viên khách sạn.
* id (string, optional),
Mã định danh ngôn ngữ
* name (string, optional),
Tên ngôn ngữ
* ~~value (string, optional)~~
* statistics (Array\[Attribute], optional),
Thống kê về tài sản, chẳng hạn như số tầng
* id (string, optional),
Mã định danh thống kê
* name (string, optional),
Mô tả thống kê bao gồm tên và giá trị thống kê
```
{
"id": "52",
"name": "Tổng số phòng: - 335",
"value": "335"
}
```
* value (string, optional)
Giá trị của thống kê
* supplier (string, optional) = \[EXPEDIA, AXISROOM, BEDLINKER],
Nguồn khách sạn
* tags (Array\[string], optional),
Thẻ được gắn cho khách sạn, để xác định một số yêu cầu đặc biệt
* themes (Array\[Attribute], optional)
Mảng đối tượng chứa thông tin về chủ đề của khách sạn
* id (string, optional),
Mã định chủ đề
* name (string, optional),
Tên chủ đề
* ~~value (string, optional)~~
* masterPropertyId (Long, optional)
Mã định danh khách sạn chính.
* duration (integer, optional),
* errors (Array\[Error], optional),
* infos (Array\[Info], optional),
* success (boolean, optional),
* textMessage (string, optional)
***
### 5. API Get all hotel list
Parameter
* id `query` (String, optional)
Hotel identifier
* language `query` (String, Required)
Language
Example
* Find by update time
```
?language=vi&lastModifiedDate=2021-09-10&pageNumber=0&pageSize=50
```
* Find by Id
```
?id=123&language=vi
```
#### Parameters
Model
* result (FilterOptionsResult, optional)
Thông tin kết quả trả về
* masterProperties (Array\[MasterProperty], optional),
Danh sách thông tin khách sạn
* id (Long, optional),
Mã định danh
* propertyName (string, optional),
Tên khách sạn
* address (Address, optional)
Thông tin địa chỉ khách sạn
* city (string, optional),
Thành phố
* countryCode (string, optional),
Mã quốc gia
* countryName (string, optional),
Tên quốc gia
* lineOne (string, optional),
Địa chỉ dòng 1
* lineTow (string, optional),
Địa chỉ dòng 2
* postalCode (string, optional),
Mã bưu điện
* stateProvinceCode (string, optional),
Mã tỉnh thành
* stateProvinceName (string, optional)
Tên tỉnh thành
* propertyLocation (PropertyLocation, optional) = \[‘vi’, ‘en’],
Vị trí toạ độ
* longitude (string, optional),
Kinh độ
* latitude (string, optional),
Vĩ độ
* activated (boolean, required),
Trạng thái `true`: hoạt động / `false`: không hoạt động
* legacyIds (Array\[Long], optional),
Danh sách mã định danh cũ
* duration (integer, optional),
* errors (Array\[Error], optional),
* infos (Array\[Info], optional),
* success (boolean, optional),
* textMessage (string, optional)
[^1]:
# Booking API
### 1. API Kiểm tra tình trạng phòng (checkout)
Request Body
* tripId (String, Required)
Mã định danh kết quả search-all-rate, lấy từ kết quả trả về search-all-rates
* roomId (String, Required)
Mã định danh phòng, lấy từ kết quả trả về search-all-rates
* ratePlanId (String, Required)
Mã định danh tùy chọn giá, lấy từ kết quả trả về search-all-rates
* metadata (String, Required)
Thông tin mở rộng
* customer-ip (String, Required)
Địa chỉ IP của người dùng cuối
Example
#### Response
Model
* result (CheckoutResult, Optional)
Thông tin kết quả trả về
* status (string, optional) = \[‘AVAILABLE’, ‘PRICE\_CHANGED’, ‘SOLD\_OUT’, ‘UNKNOWN’]
Thông tin xác định trạng thái của phòng
* `AVAILABLE`: Phòng đang tồn tại sẳn sàng để book
* `PRICE_CHANGED`: Giá phòng đã bị thay đổi, thông tin giá thay đổi được cập nhật trong HotelProduct
* `SOLD_OUT`: Phòng đã hết
* `UNKNOWN`: Không xác định trạng thái phòng
* hotelProduct (HotelProduct, optional),
Thông tin phòng trả về
* address (Address, optional),
Thông tin địa chỉ khách sạn
* city (string, optional),
Thành phố
* countryCode (string, optional),
Mã quốc gia
* countryName (string, optional),
Tên quốc gia
* lineOne (string, optional),
Địa chỉ dòng 1
* lineTow (string, optional),
Địa chỉ dòng 2
* postalCode (string, optional),
Mã bưu điện
* stateProvinceCode (string, optional),
Mã tỉnh thành
* stateProvinceName (string, optional)
Tên tỉnh thành
* amenities (Array\[Attribute], optional),
Mảng đối tượng chứa thông tin tiện nghi của khách sạn
* id (string, optional),
Mã tiện nghi khách sạn
* name (string, optional),
Tên của tiện nghi khách sạn
* ~~value (string, optional)~~
* ~~attributes (Array\[Attribute], optional),~~
* checkin (Checkin, optional),
Khoảng thời gian nhận phòng, theo giờ địa phương của khách sạn
* beginTime (string, optional),
Thời gian bắt đầu được nhận phòng. Mặc định: 14:00
* endTime (string, optional)
Thời gian kết thúc được nhận phòng. Mặc định: 24:00
* checkout (Checkout, optional),
Thông tin thời gian trả phòng. Mặc định trước 12:00
* endTime (string, optional)
Thời gian trả phòng tối đa. Mặc định trước 12:00
* currency (string, optional) = \[‘VND’, ‘USD’],
Thông tin tiền tệ trả về
* customerIp (string, optional),
Thông tin địa chỉ ip của người dùng cuối
* descriptions (Array\[Attribute], optional),
Thông tin mô tả về khách sạn
* id (string, optional),
Mã định danh thuộc tính mô tả
* name (string, optional),
Tên thuộc tính
* `description`: mô tả chung
* `amenities`: mô tả chung về tiện nghi của khách sạn
* `dining`: Mô tả về chỗ ăn uống của khách sạn
* `renovations`: Mô tả về quá trình cải tạo phòng hoặc khách sạn mới đây
* `national_ratings`: Nêu rõ nguồn xếp hạng sao của khách sạn
* `business_amenities`: Mô tả về tiện nghi dành cho doanh nghiệp tại chỗ nghỉ, Ví dụ: phòng hội nghị
* `rooms`: Mô tả về phòng
* `attractions`: Mô tả về điểm tham quan gần khách sạn
* `location`: Mô tả về vị trí của khách sạn
* `headline`: Mô tả tóm tắt
* value (string, optional)
Thông tin mô tả
* fees (Array\[Attribute], optional),
Thông tin mô tả về một số khoản phụ phí kèm theo
* id (string, optional),
Mã định danh thuộc tính phí
* name (string, optional),
Tên thuộc tính phí
* `mandatory`: Phí bắt buộc
* `optional`: Phí không bắt buộc
* value (string, optional)
Mô tả về khoản phí
* images (Array\[HotelImage], optional),
Hình ảnh của khách sạn
* caption (string, optional),
Tiêu đề của hình ảnh
* link (string, optional),
Liên kết tới hình ảnh. Liên kết tuyệt đối
* position (integer, optional)
Vị trí sắp xếp hình ảnh
* inclusions (Array\[Attribute], optional),
Mảng đối tượng chứa thông tin mô tả về thuộc tính của khách sạn
* id (string, optional),
Mã định danh thuộc tính
* name (string, optional),
Mô tả thuộc tính
* ~~value (string, optional)~~
* language (string, optional) = \[‘vi’, ‘en’],
Ngôn ngữ trả về
* latitude (number, optional),
Vĩ độ của khách sạn
* longitude (number, optional),
Kinh độ của khách sạn
* policies (Array\[Attribute], optional),
Thông tin về chính sách khách sạn mà khách cần lưu ý.
* id (string, optional),
Mã định danh chính sách
* name (string, optional),
Tên thuộc chính sách
* `know_before_you_go`: Mô tả thông tin có thể hữu ích khi lập kế hoạch cho chuyến đi đến nơi này
* value (string, optional)
Mô tả về chính sách
* productId (string, optional),
Mã định danh sản phẩm
* propertyCategory (PropertyCategory, optional),
Danh mục của khách sạn
* id (string, optional),
Mã định danh danh mục khách sạn
* name (string, optional)
Tên danh mục khách sạn
* propertyId (string, optional),
Mã định danh khách sạn
* propertyName (string, optional),
Tên khách sạn
* ~~rank (integer, optional),~~
* rating (Rating, optional),
Đánh giá về khách sạn
* ratingGuest (RatingGuest, optional)
Đánh giá của khách
* amenities (string, optional),
Xếp hạng cho các tiện nghi do khách sạn cung cấp, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* cleanliness (string, optional),
Đánh giá mức độ sạch sẽ cho khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* comfort (string, optional),
Đánh giá mức độ thoải mái của các phòng, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* condition (string, optional),
Xếp hạng cho tình trạng của chỗ nghỉ, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* count (integer, optional),
Tất cả xếp hạng đánh giá của khách giành cho khách sạn
* location (string, optional),
Xếp hạng về mức độ hấp dẫn của vị trí của khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* neighborhood (string, optional),
Xếp hạng về mức độ hài lòng của khu vực lân cận của khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* overall (string, optional),
Đánh giá chung cho khách sạn, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* quality (string, optional),
Xếp hạng chất lượng của các phòng, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* recommendationPercent (string, optional),
Phần trăm khách giới thiệu ở tại chỗ nghỉ này.
* ~~score (string, optional),~~
* service (string, optional),
Đánh giá về dịch vụ của nhân viên đối với chỗ nghỉ, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* value (string, optional)
Xếp hạng cho giá trị của bất động sản cung cấp cho chi phí lưu trú, được tính trung bình từ tất cả các đánh giá của khách. Trả về giá trị từ 1,0 đến 5,0.
* ratingProperty (RatingProperty, optional)
Đánh giá hạng sao khách sạn
* rating (string, optional),
Giá trị sếp hạng. Trả về giá trị từ 0,0 đến 5,0. Giá trị 0,0 hoặc giá trị trống cho biết không có xếp hạng nào.
* type (string, optional)
Loại đánh giá
* `Star`: Xếp hạng sao của khách sạn
* rooms (Array\[PropertyRoom], optional),
Mảng đối tượng chứa thông tin phòng
* descriptions (Array\[Attribute], optional),
Thông tin mô tả
* id (string, optional),
Mã định danh
* name (string, optional),
Tên mô tả
* `overview`: Thông tin mô tả tổng quan về căn phòng
* value (string, optional)
Thông tin mô tả
* id (string, optional),
Mã định danh cho loại phòng
* images (Array\[RoomImage], optional),
Mảng đối tượng chứa thông tin hình ảnh của loại phòng
* caption (string, optional),
Tiêu đề của hình ảnh
* link (string, optional),
Liên kết tới hình ảnh, là liên kết tuyệt đối
* position (integer, optional)
Vị trí sắp xếp của hình ảnh
* name (string, optional),
Tên của loại phòng
* ratePlans (Array\[RatePlan], optional),
Mảng đối tượng chứa thông tin về tùy chọn giá
* amenities (Array\[Amenity], optional),
Mảng đối tượng chứa thông tin tiện nghi của tùy chọn giá
* id (string, optional),
Mã định danh tiện nghi
* name (string, optional),
Tên tiện nghi
* ~~value (string, optional)~~
* ~~group (sting, optional)~~
* basePrice (number, optional),
Giá cơ bản
* basePriceBeforePromo (number, optional),
Giá cơ bản trước khuyến mãi
* bedGroups (Array\[BedGroup], optional),
Mảng đối tượng nhóm giường trong phòng
* configurations (Array\[ConfigurationBedGroup], optional),
Thông tin cấu hình giường cho phòng
* quantity (integer, optional),
Số lượng giường
* size (string, optional),
Kích thước của giường
* type (string, optional)
Loại giường
* description (string, optional),
Mô tả hiển thị giường cho phòng này
* id (string, optional)
Mã định danh nhóm giường
* breakfastIncluded (boolean, optional),
Tùy chọn giá có bao gồm bữa sáng hay không
* cancelFree (boolean, optional),
Mô tả thông tin được phép hủy đặt phòng với tùy chọn giá này có tốn phí phạt hay không
* `true`: Hủy đặt phòng miễn phí
* `false`: Không đặt hủy đặt phòng miễn phí
* cancelFreeBeforeDate (string, optional),
Ngày giới hạn cho phép hủy đặt phòng với tùy chọn giá này một cách miễn phí
* cancelPenalties (Array\[CancelPenalty], optional),
Mô tả các hình thức phạt khi hủy đặt phòng với tùy chọn giá này. Xem thêm chi tiết ở tài liệu api search-all-rates.
* type (string, optional)
Loại hình phạt
* `NIGHTS`: Số đêm bị phạt
* `AMOUNT`: Số tiền bị phạt
* `PERCENT`: Số phần trăm bị phạt
* currency (string, optional) = \[‘VND’, ‘USD’],
Đơn vị tiền tệ đối với `type = AMOUNT`
* amount (string, optional),
Số tiền của hình phạt
* description (string, optional),
Mô tả về hình phạt
* nights (string, optional),
Số đêm bị tính phí phạt
* percent (string, optional),
Số phần trăm bị phạt
* startDate (string, optional),
Ngày bắt đầu có hiệu lực của hình phạt
* endDate (string, optional),
Ngày kết thúc của hình phạt
* fees (Map, optional),
Thông tin các loại phí được phu bởi khách sạn Giá trị mối loại phí là tổng của loại đó. Phạm vi ảnh hưởng của mô tả này chỉ là thông tin thông báo cho khách hàng biết.
* `mandatory_fee`: Một khoản phí bắt buộc do khách sạn thu khi nhận phòng hoặc trả phòng.
* `resort_fee`: Một khoản phí cho các tiện nghi và dịch vụ bổ sung và được khách sạn thu khi nhận phòng hoặc trả phòng.
* `mandatory_tax`: Khoản thuế bắt buộc do chỗ nghỉ thu khi nhận phòng hoặc trả phòng.
* paxPrice (Array\[PaxPrice], optional),
Mảng đối tượng chứa thông tin giá theo số lượng người ở trong một phòng
* nightPrices (Array\[NightPrice], optional),
Mảng đối tượng chứa thông tin giá theo từng đêm
* nightKey (string, optional),
Khóa định danh của từng đêm
* nightPriceDetails (Array\[NightPriceDetail], optional)
Mảng đối tượng chứ thông tin giá chi tiết theo từng đêm
* name (string, optional),
Tên loại giá
* `base_rate`: Giá cơ bản không bao gồm thuế phí
* `tax_and_service_fee`: Thuế và phí
* value (number, optional),
Số tiền
* ~~valueByHotelCurrency (string, optional)~~
* paxInfo (PaxInfo, optional)
Mô tả thông tin người ở
* adultQuantity (integer, optional),
Số lượng người lớn
* childAges (Array\[integer], optional),
Mảng chứa thông tin tuổi của trẻ em, số lượng phần từ mảng bằng với số lượng trẻ em
* childQuantity (integer, optional),
Số lượng trẻ em
* ~~infantQuantity (integer, optional)~~
* promo (boolean, optional),
Thông tin xác định có khuyến mãi hay không
* `true`: Có khuyến mãi
* `false`: Không có khuyến mãi
* promoDescription (string, optional),
Mô tả thông tin khuyến mãi
* ratePlanId (string, optional),
Mã định danh tùy chọn giá
* ratePlanName (string, optional),
Tên của tùy chọn giá
* refundable (boolean, optional),
Thông tin xác định khi hủy phòng có được hoàn tiền hay không
* `true`: Được hoàn tiền khi hủy
* `false`: Không được hoàn tiền khi hủy
* taxAndFees (number, optional),
Thuế và phí của tùy chọn giá
* totalPrice (number, optional),
Giá tổng cộng đã bao gồm thuế phí
* ~~totalPriceByHotelCurrency (number, optional),~~
* totalRooms (integer, optional)
Số lượng phòng còn trống
* roomArea (RoomArea, optional)
Thông tin về diện tích căn phòng
* `squareFeet`: Diện tích của phòng được tính bằng feet vuông
* `squareMeters`: Diện tích của phòng được tính bằng mét vuông
* searchId (string, optional),
* Mã tham chiếu đến kết quả tìm kiếm (search-best-rate)
* statistics (Array\[Attribute], optional),
Thống kê về tài sản, chẳng hạn như số tầng
* id (string, optional),
Mã định danh thống kê
* name (string, optional),
Mô tả thống kê bao gồm tên và giá trị thống kê
```
{
"id": "52",
"name": "Tổng số phòng: - 335",
"value": "335"
}
```
* value (string, optional)
Giá trị của thống kê
* supplier (string, optional) = \[‘EXPEDIA’, ‘AXISROOM’, ‘BEDLINKER’],
Nguồn khách sạn
* themes (Array\[Attribute], optional),
Mảng đối tượng chứa thông tin về chủ đề của khách sạn
* id (string, optional),
Mã định chủ đề
* name (string, optional),
Tên chủ đề
* ~~value (string, optional)~~
* tripId (string, optional),
Mã liên kết đến kết quả search-all-rates
* hotelContact (HotelContact, optional),
Thông tin liên hệ trực tiếp của khách sạn
* phone (string, optional),
Số điện thoại khách sạn
* email (string, optional),
Email khách sạn
* fax (integer, optional)
Số fax khách sạn
* mealPlans (Array\[Attribute], optional),
Mảng chứa thông tin bữa ăn của ratePlan
* id (string, optional),
Mã định danh bữa ăn
* name (string, optional),
Tên gói bữa ăn
* ~~value (string, optional)~~
* duration (Integer, Optional)
* success (Integer, Bool)
* infos (Array\[InfosDTO], Optional)
* errors (Array\[ErrorsDTO], Optional)
* textMessage (String, Optional)
***
### 2. API Khởi tạo booking
Request Body
* tripId (String, Required)
Mã định danh kết quả search-all-rate, lấy từ kết quả trả về search-all-rates
* roomId (String, Required)
Mã định danh phòng, lấy từ kết quả trả về search-all-rates
* ratePlanId (String, Required)
Mã định danh tùy chọn giá, lấy từ kết quả trả về search-all-rates
* metadata (String, Required)
Thông tin mở rộng
* customer-ip (String, Required)
Địa chỉ IP của người dùng cuối
Example
#### Response
Model
* result (Booking, optional)
Thông tin booking đã tạo
* additionalFee (number, optional),
Các khoản phí khác
* agencyCode (string, optional),
Mã đại lý. Mã dùng tham chiếu đến tác giả của booking
* ~~agencyMarkupValue (number, optional),~~
* agentCode (string, optional),
Mã nhân viên đại lý. Mã dùng tham chiếu đến tác giả của booking
* agentId (integer, optional),
Id nhân viên đại lý
* agentName (string, optional),
Tên nhân viên đại lý
* baseFare (number, optional),
Giá phòng chưa bao gồm thuế phí
* bookBy (string, optional),
Người đặt booking
* bookByCode (string, optional),
Mã người đặt
* bookingCode (string, optional),
Mã dùng mô tả các thông tin cơ bản của booking
* bookingDate (string, optional),
Ngày tạo booking
* bookingNote (string, optional),
Ghi chú của booking
* bookingNumber (string, optional),
Mã dùng tham chiếu đến booking. Mã này là duy nhất.
* bookingType (string, optional) = \[‘DOME’, ‘INTE’],
Xác định điểm đến là trong nước hay quốc tế
* `DOME`: Trong nước
* `INTE`: Quốc tế
* branchCode (string, optional),
Mã chi nhánh
* cancellationBy (string, optional),
Hủy đặt phòng bởi …
* cancellationDate (string, optional),
Ngày hủy đặt phòng
* cancellationFee (number, optional),
Phí hủy đặt phòng
* cancellationNotes (string, optional),
Ghi chú hủy
* channelType (string, optional) = \[‘ONLINE’, ‘OFFLINE’],
Loại kênh đặt phòng
* commissionValue (number, optional),
Giá trị hoa hồng
* createdBy (string, optional),
Người tạo booking
* createdDate (string, optional),
Ngày tạo booking
* customerCode (string, optional),
Mã khách hàng
* customerEmail (string, optional),
Email của khách hàng
* customerFirstName (string, optional),
Họ của khách hàng
* customerId (integer, optional),
Id của khách hàng
* customerLastName (string, optional),
Tên của khách hàng
* customerPhoneNumber1 (string, optional),
Số điện thoại 1 của khách hàng
* customerPhoneNumber2 (string, optional),
Số điện thoại 2 của khách hàng
* departureDate (string, optional),
Ngày nhận phòng
* discountAmount (number, optional),
Số tiền được giảm
* discountDate (string, optional),
Ngày sử dụng mã giảm giá
* discountRedeemCode (string, optional),
Mã liên kết đổi thưởng
* discountRedeemId (string, optional),
Id định danh liên kết đổi thường
* discountTrackingCode (string, optional),
Mã theo dõi thông tin giảm giá
* discountVoucherCode (string, optional),
Mã voucher
* discountVoucherName (string, optional),
Tên voucher
* ~~equivFare (number, optional),~~
* ~~fromCity (string, optional),~~
* ~~fromLocationCode (string, optional),~~
* ~~fromLocationName (string, optional),~~
* id (integer, optional),
Id của booking
* ~~internalBookingNote (string, optional),~~
* ~~isDeleted (boolean, optional),~~
* issuedBy (string, optional),
Xuất phòng bởi …
* issuedByCode (string, optional),
Mã người xuất phòng
* issuedDate (string, optional),
Ngày xuất phòng
* issuedStatus (string, optional) = \[‘PENDING’, ‘TICKET\_ON\_PROCESS’, ‘SUCCEEDED’, ‘FAILED’],
Trạng thái xuất phòng
* `PENDING`: Đợi xuất phòng
* `TICKET_ON_PROCESS`: Xuất phòng đang được xử lý
* `SUCCEEDED`: Xuất phòng thành công
* `FAILED`: Xuất phòng thất bại
* ~~markupValue (number, optional),~~
* orgCode (string),
Mã tổ chức
* partnerOrderId (string, optional),
Id định danh đặt hàng của đối tác
* partnerRequestId (string, optional),
Id định danh request của đối tác
* paymentBy (string, optional),
Thanh toán bởi …
* paymentByCode (string, optional),
Mã người thanh toán
* paymentDate (string, optional),
Thời gian thanh toán
* paymentFee (number, optional),
Phí thanh toán
* paymentRefNumber (string, optional),
Mã tham chiếu thanh toán
* paymentStatus (string, optional) = \[‘SUCCEEDED’, ‘FAILED’, ‘REFUNDED’, ‘PENDING’],
Trạng thái thanh toán
* `PENDING`: Chờ thanh toán
* `SUCCEEDED`: Thanh toán thành công
* `FAILED`: Thanh toán thất bại
* `REFUNDED`: Hoàn tiền
* paymentTotalAmount (number, optional),
Tổng số tiền thanh toán
* paymentType (string, optional) = \[‘BALANCE’, ‘CREDIT’, ‘ATM\_DEBIT’, ‘VNPAYQR’, ‘VIETTELPAY’, ‘MOMO’, ‘ZALO’, ‘AIRPAY’, ‘PAYOO’, ‘CASH’, ‘TRANSFER’, ‘PARTNER’, ‘OTHER’],
Hình thức thanh toán
* ~~promotionID (Array\[string], optional),~~
* ~~reconciliationType (string, optional) = \[‘NEW’, ‘ALREADY\_RECONCILIATION’],~~
* refundAmount (number, optional),
Số tiền hoàn trả
* refundBy (string, optional),
Người hoàn trả
* refundByCode (string, optional),
Mã của người thực hiện hoàn trả
* refundDate (string, optional),
Ngày hoàn trả
* ~~refundNextVoidDate (string, optional),~~
* returnDate (string, optional),
Ngày trả phòng
* roundType (string, optional) = \[‘RoundTrip],
* saleChannel (string, optional) = \[‘B2B’, ‘B2C’, ‘B2B2C’, ‘B2C\_WEB’, ‘B2C\_WEB\_APP’, ‘B2C\_MOBILE’],
Kênh phân phối
* serviceTax (number, optional),
Thuế và phí
* ~~sessionSearchId (string, optional),~~
* status (string, optional) = \[‘PENDING’, ‘BOOKING\_ON\_PROCESS’, ‘BOOKED’, ‘FAILED’, ‘CANCELLED’, ‘EXPIRED’],
Trạng thái của booking
* `PENDING`: Chờ xác nhận booking
* `BOOKING_ON_PROCESS`: Booking đang được xử lý
* `BOOKED`: Booking đã được xác nhận
* `FAILED`: Booking thất bại
* `EXPIRED`: Booking hết hạn
* `CANCELLED`: Booking đã bị hủy
* supplierType (string, optional) = \[‘AIR’, ‘HOTEL’, ‘TOURS’, ‘TRAIN’, ‘SHIP’, ‘OTHER’],
Loại sản phẩm
* ~~tags (string, optional),~~
* taxAddress1 (string, optional),
Địa chỉ xuất hóa đơn dòng 1
* taxAddress2 (string, optional),
Địa chỉ xuất hóa đơn dòng 2
* taxCompanyName (string, optional),
Tên công ty xuất hóa đơn
* taxNumber (string, optional),
Mã số thuế cần xuất hóa đơn
* taxPersonalInfoContact (string, optional),
Người nhận hóa đơn
* taxReceiptRequest (boolean, optional),
Yêu cầu xuất hóa đơn hay không
* timeToLive (string, optional),
Thời gian chờ thanh toán, sau thời gian này trạng thái của booking sẽ chuyển sang `EXPIRED`
* ~~timeToLiveExpired (string, optional),~~
* toCity (string, optional),
Tên tỉnh, thành phố nơi đặt phòng khách sạn
* toLocationCode (string, optional),
Mã định danh khách sạn
* toLocationName (string, optional),
Tên khách sạn
* totalFare (number, optional),
Tổng giá phòng
* ~~totalSsrValue (number, optional),~~
* totalTax (number, optional),
Tổng số tiền thuế phí
* updatedBy (string, optional),
Người cập nhật
* updatedDate (string, optional),
Ngày cập nhật
* ~~vat (number, optional)~~
* duration (integer, optional),
* errors (Array\[Error], optional),
* infos (Array\[Info], optional),
* success (boolean, optional),
* textMessage (string, optional)
***
### 3. API Lấy chi tiết booking
Parameters
* bookingNumber `query` (string, required),
Mã tham chiếu đến booking
#### Response
Model
* id (string, optional),
Mã định danh chi tiết booking
* agencyCode (string, optional),
Mã đại lý. Mã dùng tham chiếu đến tác giả của booking
* agentCode (string, optional),
Mã nhân viên đại lý. Mã dùng tham chiếu đến tác giả của booking
* bookingCode (string, optional),
Mã dùng mô tả các thông tin cơ bản của booking
* bookingDate (string, optional),
Ngày tạo booking
* bookingInfo (BookingInfo, optional),
Thông tin booking
* additionalFee (number, optional),
Các khoản phí khác
* agencyCode (string, optional),
Mã đại lý. Mã dùng tham chiếu đến tác giả của booking
* ~~agencyMarkupInfos (Array\[BookingAgencyMarkupInfo], optional),~~
* ~~agencyMarkupValue (number, optional),~~
* agentCode (string, optional),
Mã nhân viên đại lý. Mã dùng tham chiếu đến tác giả của booking
* agentId (integer, optional),
Id nhân viên đại lý
* agentName (string, optional),
Tên nhân viên đại lý
* allowHold (boolean, optional),
Cho phép giữ phòng hay không
`true`: cho phép giữ phòng
`false`: Không cho phép giữ phòng
* baseFare (number, optional),
Giá phòng chưa bao gồm thuế phí
* bookBy (string, optional),
Người đặt booking
* bookByCode (string, optional),
Mã người đặt
* bookingCode (string, optional),
Mã dùng mô tả các thông tin cơ bản của booking
* bookingDate (string, optional),
Ngày tạo booking
* ~~bookingIssuedType (string, optional) = \[‘INSTANT\_BOOKING’, ‘CONFIRM\_OFFLINE’],~~
* bookingNote (string, optional),
Ghi chú của booking
* bookingNumber (string, optional),
Mã dùng tham chiếu đến booking. Mã này là duy nhất.
* bookingType (string, optional) = \[‘DOME’, ‘INTE’],
Xác định điểm đến là trong nước hay quốc tế
* `DOME`: Trong nước
* `INTE`: Quốc tế
* branchCode (string, optional),
Mã chi nhánh
* cancellationBy (string, optional),
Hủy đặt phòng bởi …
* cancellationDate (string, optional),
Ngày hủy đặt phòng
* cancellationFee (number, optional),
Phí hủy đặt phòng
* cancellationNotes (string, optional),
Ghi chú hủy
* channelType (string, optional) = \[‘ONLINE’, ‘OFFLINE’],
Loại kênh đặt phòng
* contactInfos (Array\[BookingContactInfo], optional),
Mảng đối tượng chứ thông tin người liên hệ
* bookingNumber (string, optional),
Mã tham chiếu đến booking
* contactLevel (string, optional) = \[‘PRIMARY’, ‘SECONDARY’, ‘OTHER’],
Cấp của người liên hệ
* contactType (string, optional) = \[‘CUSTOMER’, ‘AGENCY’],
Loại của người liên hệ
* email (string, optional),
Địa chỉ email
* firstName (string, optional),
Tên đêm và tên người liên hệ
* phoneCode1 (string, optional),
Mã quốc gia
* phoneNumber1 (string, optional),
Số điện thoại 1
* surName (string, optional)
Họ người liên hệ
* customerCode (string, optional),
Mã khách hàng
* customerEmail (string, optional),
Email của khách hàng
* customerFirstName (string, optional),
Họ của khách hàng
* customerId (integer, optional),
Id của khách hàng
* customerLastName (string, optional),
Tên của khách hàng
* customerPhoneNumber1 (string, optional),
Số điện thoại 1 của khách hàng
* customerPhoneNumber2 (string, optional),
Số điện thoại 2 của khách hàng
* ~~deleted (boolean, optional),~~
* departureDate (string, optional),
Ngày nhận phòng
* discountAmount (number, optional),
Số tiền được giảm
* discountDate (string, optional),
Ngày sử dụng mã giảm giá
* discountRedeemCode (string, optional),
Mã liên kết đổi thưởng
* discountRedeemId (string, optional),
Id định danh liên kết đổi thường
* discountVoucherCode (string, optional),
Mã voucher
* discountVoucherName (string, optional),
Tên voucher
* ~~displayPriceInfo (BookingPriceInfo, optional),~~
* ~~equivFare (number, optional),~~
* etickets (string, optional),
Mã liên kết với nhà cung cấp, được sử dụng để nhận phòng
* ~~fromCity (string, optional),~~
* ~~fromLocationCode (string, optional),~~
* ~~fromLocationName (string, optional),~~
* id (integer, optional),
Id của booking
* ~~internalBookingNote (string, optional),~~
* issuedByCode (string, optional),
Xuất phòng bởi …
* issuedDate (string, optional),
Ngày xuất phòng
* issuedStatus (string, optional) = \[‘PENDING’, ‘TICKET\_ON\_PROCESS’, ‘SUCCEEDED’, ‘FAILED’],
Trạng thái xuất phòng
* `PENDING`: Đợi xuất phòng
* `TICKET_ON_PROCESS`: Xuất phòng đang được xử lý
* `SUCCEEDED`: Xuất phòng thành công
* `FAILED`: Xuất phòng thất bại
* ~~markupValue (number, optional),~~
* ~~onlyPayLater (boolean, optional),~~
* orgCode (string, optional),
Mã tổ chức
* ownerBooking (boolean, optional),
Chủ sở hữu đặt chỗ
* passengerNameRecords (string, optional),
Mã liên kết với nhà cung cấp, được sử dụng để nhận phòng
* paymentBy (string, optional),
Thanh toán bởi …
* paymentByCode (string, optional),
Mã người thanh toán
* paymentDate (string, optional),
Thời gian thanh toán
* paymentFee (number, optional),
Phí thanh toán
* paymentRefNumber (string, optional),
Mã tham chiếu thanh toán
* paymentStatus (string, optional) = \[‘SUCCEEDED’, ‘FAILED’, ‘REFUNDED’, ‘PENDING’],
Trạng thái thanh toán
* `PENDING`: Chờ thanh toán
* `SUCCEEDED`: Thanh toán thành công
* `FAILED`: Thanh toán thất bại
* `REFUNDED`: Hoàn tiền
* paymentTotalAmount (number, optional),
Tổng số tiền thanh toán
* paymentType (string, optional) = \[‘BALANCE’, ‘CREDIT’, ‘ATM\_DEBIT’, ‘AIRPAY’, ‘VNPAYQR’, ‘VIETTELPAY’, ‘MOMO’, ‘ZALO’, ‘PAYOO’, ‘CASH’, ‘TRANSFER’, ‘PARTNER’, ‘OTHER’],
Hình thức thanh toán
* ~~promotionID (Array\[string], optional),~~
* ~~reasonCodePaymentFailed (string, optional),~~
* refundBy (string, optional),
Người hoàn trả
* refundByCode (string, optional),
Mã của người thực hiện hoàn trả
* refundable (boolean, optional),
Ngày hoàn trả
* returnDate (string, optional),
Ngày trả phòng
* roundType (string, optional) = \[‘RoundTrip],
* saleChannel (string, optional) = \[‘B2B’, ‘B2C’, ‘B2B2C’, ‘B2C\_WEB’, ‘B2C\_WEB\_APP’, ‘B2C\_MOBILE’],
Kênh phân phối
* serviceTax (number, optional),
Thuế và phí
* ~~showPayLaterOption (boolean, optional),~~
* ~~showPayNowOption (boolean, optional),~~
* status (string, optional) = \[‘PENDING’, ‘BOOKING\_ON\_PROCESS’, ‘BOOKED’, ‘FAILED’, ‘CANCELLED’, ‘EXPIRED’],
Trạng thái của booking
* `PENDING`: Chờ xác nhận booking
* `BOOKING_ON_PROCESS`: Booking đang được xử lý
* `BOOKED`: Booking đã được xác nhận
* `FAILED`: Booking thất bại
* `EXPIRED`: Booking hết hạn
* `CANCELLED`: Booking đã bị hủy
* ~~supplierBookingStatus (string, optional),~~
* supplierType (string, optional) = \[‘AIR’, ‘HOTEL’, ‘TOURS’, ‘TRAIN’, ‘SHIP’, ‘OTHER’],
Loại nhà cung cấp
* taxAddress1 (string, optional),
Địa chỉ xuất hóa đơn dòng 1
* taxAddress2 (string, optional),
Địa chỉ xuất hóa đơn dòng 2
* taxCompanyName (string, optional),
Tên công ty xuất hóa đơn
* taxNumber (string, optional),
Mã số thuế cần xuất hóa đơn
* taxPersonalInfoContact (string, optional),
Người nhận hóa đơn
* taxReceiptRequest (boolean, optional),
Yêu cầu xuất hóa đơn hay không
* timeToLive (string, optional),
Thời gian chờ thanh toán, sau thời gian này trạng thái của booking sẽ chuyển sang `EXPIRED`
* toCity (string, optional),
Tên tỉnh, thành phố nơi đặt phòng khách sạn
* toLocationCode (string, optional),
Mã định danh khách sạn
* toLocationName (string, optional),
Tên khách sạn
* totalFare (number, optional),
Tổng giá phòng
* ~~totalSsrValue (number, optional),~~
* totalTax (number, optional),
Tổng số tiền thuế phí
* transactionInfos (Array\[BookingTransactionInfo], optional),
Mảng đối tượng chứa thông tin giao dịch
* id (integer, optional),
Id định danh giao dịch
* ~~agencyMarkupValue (number, optional),~~
* allowHold (boolean, optional),
Cho phép giữ phòng hay không
* bookingCode (string, optional),
Mã dùng mô tả các thông tin cơ bản của booking
* bookingDate (string, optional),
Ngày tạo booking
* bookingDirection (string, optional) = \[‘TRIP’],
* bookingNumber (string, optional),
Mã dùng tham chiếu đến booking.
* bookingRefNo (string, optional),
Mã liên kết với nhà cung cấp
* channelType (string, optional) = \[‘ONLINE’, ‘OFFLINE’],
Loại kênh bán
* checkIn (string, optional),
Ngày nhận phòng
* checkOut (string, optional),
Ngày trả phòng
* destinationLocationCode (string, optional),
Mã định danh khách sạn
* detail (string, optional),
Tên khách sạn
* etickets (string, optional),
Mã liên kết với nhà cung cấp, được sử dụng để nhận phòng
* issuedDate (string, optional),
Ngày xuất phòng
* issuedStatus (string, optional) = \[‘PENDING’, ‘TICKET\_ON\_PROCESS’, ‘SUCCEEDED’, ‘FAILED’],
Trạng thái xuất phòng
* `PENDING`: Đợi xuất phòng
* `TICKET_ON_PROCESS`: Xuất phòng đang được xử lý
* `SUCCEEDED`: Xuất phòng thành công
* `FAILED`: Xuất phòng thất bại
* ~~markupCode (string, optional),~~
* ~~markupFormula (string, optional),~~
* ~~markupKey (string, optional),~~
* ~~markupValue (number, optional),~~
* noAdult (integer, optional),
Số người lớn
* noChild (integer, optional),
Số trể em
* onlyPayLater (boolean, optional),
Cho phép trả sau hay không
* passengerNameRecord (string, optional),
Mã liên kết với nhà cung cấp, được sử dụng để nhận phòng
* paymentAmount (number, optional),
Số tiền thanh toán
* productSeqNumber (string, optional),
Mã sản phẩm
* refundable (boolean, optional),
Có hoàn tiền khi hủy phòng hay không
* saleChannel (string, optional) = \[‘B2B’, ‘B2C’, ‘B2B2C’, ‘B2C\_WEB’, ‘B2C\_WEB\_APP’, ‘B2C\_MOBILE’],
Kênh phân phối
* serviceTax (number, optional),
Thuế và phí
* status (string, optional) = \[‘PENDING’, ‘BOOKING\_ON\_PROCESS’, ‘BOOKED’, ‘FAILED’, ‘CANCELLED’, ‘EXPIRED’],
Trạng thái của booking
* `PENDING`: Chờ xác nhận booking
* `BOOKING_ON_PROCESS`: Booking đang được xử lý
* `BOOKED`: Booking đã được xác nhận
* `FAILED`: Booking thất bại
* `EXPIRED`: Booking hết hạn
* `CANCELLED`: Booking đã bị hủy
* supplierCode (string, optional),
Mã nhà cung cấp
* supplierName (string, optional),
Tên nhà cung cấp
* supplierType (string, optional) = \[‘AIR’, ‘HOTEL’, ‘TOURS’, ‘TRAIN’, ‘SHIP’, ‘OTHER’]
Loại sản phẩm
* totalFare (number, optional),
Tổng giá phòng
* totalTax (number, optional)
Tổng thuế và phí
* baseFare (number, optional),
Giá phòng không bao gồm thuế phí
* travelerInfos (Array\[BookingTravelerInfo], optional),
Mảng đối tượng chứa thông tin người nhận phòng. Người nhận phòng phải là người lớn. Mỗi một phòng tương ứng với 1 phần tử của mảng.
* bookingNumber (string),
Mã tham chiếu đến booking
* firstName (string),
Tên đêm và tên người nhận phòng
* surName (string)
Họ của người nhận phòng
* bookingNumber (string, optional),
Mã dùng tham chiếu đến booking. Mã này là duy nhất.
* bookingType (string, optional),
Xác định điểm đến là trong nước hay quốc tế
* `DOME`: Trong nước
* `INTE`: Quốc tế
* branchCode (string, optional),
Mã chi nhánh
* cacheType (string, optional) = \[‘HOTEL’],
* ~~channelType (string, optional) = \[‘ONLINE’, ‘OFFLINE’],~~
Loại kênh đặt phòng
* ~~customerCode (string, optional),~~
Mã khách hàng
* ~~groupPricedItineraries (Array\[GroupPricedItinerary], optional),~~
* ~~hotelAvailability (HotelAvailability, optional),~~
* hotelProduct (HotelProduct, optional),
Đối tượng chứa thông tin phòng (Xem thêm ở response API checkout)
* hotelProductPayload (HotelProductPayload, optional),
Đối tượng chứa thông tin định danh sản phẩm
* tripId (String, optional)
Mã định danh kết quả search-all-rate
* roomId (String, optional)
Mã định danh phòng
* ratePlanId (String, optional)
Mã định danh tùy chọn giá
* ~~isPerBookingType (boolean, optional),~~
* ~~markupType (string, optional),~~
* ~~offlineBooking (OfflineBooking, optional),~~
* orgCode (string, optional),
Mã tổ chức
* saleChannel (string, optional) = \[‘B2B’, ‘B2C’, ‘B2B2C’, ‘B2C\_WEB’, ‘B2C\_WEB\_APP’, ‘B2C\_MOBILE’],
Kênh phân phối
* supplierType (string, optional) = \[‘AIR’, ‘HOTEL’, ‘TOURS’, ‘TRAIN’, ‘SHIP’, ‘OTHER’],
Loại nhà cung cấp
* ~~travelerInfo (TravelerInfo, optional),~~
* ~~updatedDate (string, optional)~~
***
### 4. API Cập nhật thông tin booking và giữ chỗ
Request Body
* bookingNumber (string, required),
Mã tham chiếu đến booking
* bookingContacts (Array\[BookingContactDTO], required),
Mảng đối tượng chứ thông tin người liên hệ
* bookingNumber (string),
Mã tham chiếu đến booking
* phoneNumber1 (string, optional),
Số điện thoại 1
* email (string, optional),
Địa chỉ email người liên hệ
* surName (string)
Họ người liên hệ
* firstName (string),
Tên đêm và tên người liên hệ
* phoneCode1 (string, optional),
Mã quốc gia
* bookingTravelerInfos (Array\[BookingTravelerInfoDTO], required),
Mảng đối tượng chứa thông tin người nhận phòng. Người nhận phòng phải là người lớn. Mỗi một phòng tương ứng với 1 phần tử của mảng.
* traveler (BookingTravelerDTO, optional)
Thông tin người nhận phòng
* bookingNumber (string),
Mã tham chiếu đến booking
* firstName (string),
Tên đêm và tên người nhận phòng
* surName (string)
Họ của người nhận phòng
* taxReceiptRequest (BookingTaxReceiptRequestDTO, optional)
Yêu cầu xuất hóa đơn. Nếu không yêu cầu xuất hóa đơn thì để trống
* bookingNumber (string, optional),
Mã tham chiếu đến booking
* taxAddress1 (string, optional),
Địa chỉ công ty
* taxCompanyName (string, optional),
Tên công ty
* taxNumber (string, optional),
Mã số thuế
* taxPersonalInfoContact (string, optional),
Thông tin liên hệ người yêu cầu xuất hóa đơn
Là chuỗi json của đối tượng:
* name (string, required)
Họ người liên hệ
* fname (string, required)
Tên đệm và tên người liên hệ
* phone (string, required)
Số điện thoại người liên hệ
* email (string, required)
Email người liên hệ
* phonecode3 (string, required)
Mã điện thoại
* taxReceiptRequest (boolean, optional)
Yêu cầu xuất hóa đơn
* `true`: Yêu cầu xuất hóa đơn
Example
#### Response
Model
* result (SearchAllRatesResult, optional),
* bookingCode (BookingCode, optional),
Mã định danh kết quả search-all-rate, mỗi lần gọi search-all-rate sẽ tạo ra tripId mới, nó được sử dụng khi đi thao tác đặt phòng
* bookingCode (string, optional)
Mã dùng mô tả các thông tin cơ bản của booking
* bookingNumber (string, optional)
Mã dùng tham chiếu đến booking
* duration (integer, optional),
* errors (Array\[Error], optional),
* infos (Array\[Info], optional),
* success (boolean, optional),
* textMessage (string, optional)
{% embed url="" %}
# Cancellation API
Document Hotel API Cancellation
## Description of penalties for cancellation
If you do not check in, or if you cancel or modify this reservation after the check-in time, you may be subject to a penalty fee of up to 100% of the booking value.
### Penalties
Request Body
* bookingNumber (String, Required)
Reference code (Unique)
Example
#### Response
Model
* result (CheckCancelPenaltyResult, Optional)
Returned result information
* status (string, optional) = \[‘ALLOW\_CANCELLATION’, ‘NOT\_ALLOW\_CANCELLATION’, ‘UNKNOWN’]
Information to determine cancellation status
* `ALLOW_CANCELLATION`: Chấp nhận huỷ phòng
* `NOT_ALLOW_CANCELLATION`: Không chấp nhận huỷ phòng
* `UNKNOWN`: Unable to determine status, needs to be rechecked.
* cancelPenalties (Array\[CancelPenalty], optional),
* cancelPenaltyTotal (number, optional),
* duration (Integer, Optional)
* success (Integer, Bool)
* infos (Array\[InfosDTO], Optional)
* errors (Array\[ErrorsDTO], Optional)
* textMessage (String, Optional)
***
## 2. API request to cancel hotel booking
Model
#### **Key (string, required)**
* Decryption key for the encrypted data.
**Data (string, required)**
* Encrypted data containing a digital signature.
**Signature Data Schema:**
```
||
```
#### **Original Data Schema:**
```
|||
```
* **access\_code (String, required)** – Access code provided by Gotadi to the Partner.
* **bookingNumber (String, required)** – Reference code for the booking.
* **cancel\_penalty\_amount (String, optional)** – Cancellation penalty fee, formatted to two decimal places (0.00).
#### Response
Model
* **key (String, required)** – Decryption key for the encrypted data.
* **data (String, required)** – Encrypted data containing a digital signature.
*Signature data schema:*
```
||||
```
*Original data schema:*
```
|||||
```
* **access\_code (String, required)** – Access code provided by Gotadi to the Partner.
* **booking\_number (String, required)** – Reference code for the booking.
* **error\_code (String, required)** – Error code.
* **product\_type (String, optional)** – Product type, with possible values: `AIR` (flight) or `HOTEL` (hotel), corresponding to the purchased product.
* **cancellation\_status (String, optional)** – Cancellation status information:
* **CANCEL\_UNKNOWN** – Status is unknown and requires rechecking.
* **CANCEL\_PENALTY\_MISMATCH** – The cancellation penalty fee does not match. The API for checking cancellation eligibility and penalty fees should be called again before resubmitting the cancellation request.
* **CANCEL\_WAITING\_CONFIRM** – Cancellation request sent successfully, waiting for confirmation from the provider.
* **CANCEL\_CONFIRMED** – Cancellation confirmed successfully.
* **CANCEL\_EXPIRED** – Cancellation request has expired.
## 3. **API to Check Room Cancellation Status**
Model
* key (string, required),
* data (string, required),
*Signature data schema:*
```
|>
```
*Original data schema:*
```
||
```
* access\_code (String, required)
Gotadi provide
* bookingNumber (String, required)
Reference code
#### Response
Model
* key (String, required)
* data (String, required)
*Signature data schema:*
```
|||||
```
*Original data schema:*
```
||||||
```
* **access\_code (String, required)** – Access code provided by Gotadi to the Partner.
* **booking\_number (String, required)** – Reference code for the booking.
* **error\_code (String, required)** – Error code.
* **product\_type (String, optional)** – Product type, with possible values: `AIR` (flight) or `HOTEL` (hotel), corresponding to the purchased product.
* **cancellation\_status (String, optional)** – Cancellation status information:
* **CANCEL\_UNKNOWN** – Status is unknown and requires rechecking.
* **CANCEL\_PENALTY\_MISMATCH** – The cancellation penalty fee does not match. Call the API for checking cancellation eligibility and penalty fees before resubmitting the cancellation request.
* **CANCEL\_WAITING\_CONFIRM** – Cancellation request sent successfully, waiting for confirmation from the provider.
* **CANCEL\_CONFIRMED** – Cancellation confirmed successfully.
* **CANCEL\_EXPIRED** – Cancellation request has expired.
* **product\_type (String, optional)** – Product type (`AIR` for flight, `HOTEL` for hotel).
* **cancel\_penalty\_amount (String, optional)** – Cancellation fee amount, formatted to two decimal places (0.00).
# Booking Journey Handling
### 1. Commit API
* Calling the **Commit API** is considered the start of a booking journey flow. You must ensure that the current booking journey has been fully completed before initiating a new one.
* The Commit API only triggers two actions: **payment** and **ticket issuance**. It should not be used alone to determine the completion of a booking journey. Instead, it must be used together with the **booking-detail API** (which will be replaced by the **final-booking-detail API** as recommended in this document).
### 2. Final Booking Detail API
* The **final-detail-booking API** is used to determine the status of a booking through the following statuses:
* Payment statuses
* Issued statuses
* This API enhances the handling of both successful and failed cases:
* In the **happy case** (success), the API immediately returns the result.
* In the **failure case**, the API will automatically retry to retrieve the latest booking status and return the result until the preconfigured timeout is reached.
* Conditions where the booking journey is considered completed and a new journey can be started:
* Payment failed: **`paymentStatus =`` `****`Failed`**
* Payment succeeded and ticket issuance succeeded: **`paymentStatus =`` `****`Success`** and **`issueStatus =`` `****`Success`**
* Conditions where the booking journey is considered incomplete (must be held and further processed):
* Payment succeeded but ticket issuance not yet succeeded: **`paymentStatus =`` `****`Success`** and **`issueStatus !=`` `****`Succes`**
### 3. Recommendation
* When calling the **Commit API**, some errors may occur outside of the predefined error code table (e.g., API call failure, timeout, or long response time). In such cases, the **final-booking-detail API** should be used to determine the status of a booking.
* After retrieving the result from **final-booking-detail**:
* If **`paymentStatus =`` `****`Success`** but **`issueStatus !=`` `****`Success`** , you should continue retrying **GET final-booking-detail** until the most accurate status is returned.
# Payment API
### Voucher validation API
Model
* result (String, optional),
Information returned in the format:
````json
```
?key=?data=
```
*Signature data schema:*
```
|||
```
*Original data schema:*
```
||||
```
- access_code (String, required)
!!! quote ""
Access code provided by Gotadi to Partners.
- bookingNumber (String, optional)
!!! quote ""
Code used to refer to booking
- product_type (String, optional)
!!! quote ""
Type of product, whose value is AIR or HOTEL corresponding to the type of product purchased
- total_amount (String, optional)
!!! quote ""
Total payment amount
- payment_url (String, required)
!!! quote ""
URL navigate to payment page
- encrypted_key (String, required)
!!! quote ""
Key decrypts (encrypted) data. How to decrypt refer to the section: Encryption of transmission data and digital signature authentication
- encrypted_data (String, required)
!!! quote ""
Data with digital signature (encrypted). How to decrypt refer to the section: Encryption of transmission data and digital signature authentication
````
* duration (integer, optional),
* errors (Array\[Error], optional),
* infos (Array\[Info], optional),
* success (boolean, optional),
* textMessage (string, optional)
***
### Payment Recording and Booking Commit API
Model
* key (string, required),
Data decrypted key. How to decrypt refer to the section: Encryption of transmission data and digital signature authentication
* data (string, required),
Data with digital signature (encrypted). How to decrypt refer to the section: Encryption of transmission data and digital signature authentication
*Signature data schema:*
```
|||
```
*Original data schema:*
```
||||
```
* access\_code (String, required)
Access code provided by Gotadi to Partners.
* bookingNumber (String, required)
Code used to refer to booking
* partner\_trans\_id (String, optional)
Partner transaction identifier. If the partner does not pass a value to this field, the default value will be assigned using booking\_number
* product\_type (String, required)
Type of product, whose value is AIR or HOTEL corresponding to the type of product purchased
Example
#### Response
Model
* key (String, required)
Data decrypted key. How to decrypt refer to the section: Encryption of transmission data and digital signature authentication
* data (String, required)
Data with digital signature (encrypted). How to decrypt refer to the section: Encryption of transmission data and digital signature authentication
*Signature data schema:*
```
||||||
```
*Original data schema:*
```
|||||||
```
* access\_code (String, required)
Access code provided by Gotadi to Partners.
* booking\_number (String, required)
Code used to refer to booking
* error\_code (String, required)
Error code
* product\_type (String, optional)
Type of product, whose value is AIR or HOTEL corresponding to the type of product purchased
* properties (String, optional)
…
* return\_url (String, optional)
…
* total\_amount (Double, required)
…
***
### API to retrieve Booking Details After Ticket Issuance
GET: /api/products/final-booking-detail
**Description:**
This API is optimized to retrieve the booking status for use in the payment process (its usage is similar to the **booking-detail API**). It also adds enhanced handling for both successful and failed cases.
* In the **happy case** (success), the API immediately returns the result.
* In the **failure case**, the API automatically retries to fetch the latest booking status and continues returning results until the configured timeout is reached.
Parameter
Parameter
* booking\_number (String, Required)\
Booking Reference Code
**Response**
**Code 200**
> OK
**Model**
Model
* orgCode (String, Optional)\
Organization code referencing the creator of the booking.
* branchCode (String, Optional)\
Branch code referencing the creator of the booking.
* agencyCode (String, Optional)\
Agency code referencing the creator of the booking.
* agentCode (String, Optional)\
Agent (staff) code referencing the creator of the booking.
* customerCode (String, Optional)\
Customer code referencing the creator of the booking.
* id (String, Optional)\
Unique ID of the booking.
* bookingNumber (String, Optional)\
Reference code of the booking.
* bookingCode (String, Optional)\
Code describing the basic information of the booking.
* bookingType (String, Optional)\
Booking type: `FLIGHT` or `HOTEL`, depending on the purchased product.
* bookingInfo (BookingInfoDTO, Optional)\
Detailed booking information.
* groupPricedItineraries (GroupPricedItineraryDTO\[], Optional)\
Group itinerary details (already specified in the **Search** section).
* travelerInfo (TravelerInfoDTO, Optional)\
Passenger and contact information.
* channelType (String, Optional)\
Distribution channel type: `B2B` or `B2C`.
* saleChannel (String, Optional)\
Sales channel. Example: `B2B_WEB`, `B2B_APP`, etc.
* supplierType (String, Optional)\
Supplier type. Example: `AIR`, `HOTEL`, etc.
* bookingDate (String, Optional)\
Booking creation date (reservation date).
# Corporate Agent Partner (CA)
{% content-ref url="/pages/O0FYvCTygonPog0gpU0p" %}
[Integration Process](/english/corporate-agent-partner-ca/integration-process)
{% endcontent-ref %}
{% content-ref url="/pages/I6lgcaxcSS6VuUFjR9uh" %}
[Authentication API](/english/corporate-agent-partner-ca/authentication-api)
{% endcontent-ref %}
# Integration Process
Partners only need to integrate a single API for authentication and generating a link to access the Gotadi website.
All business processes, including but not limited to Search, Booking, and Payment, will be handled within the Gotadi Website.
This document provides detailed guidance on integrating the required API.
### 1. Before you start
API Specification
* URL: \/api/partnership/v1/login
* Method: POST
* Description: Authentication API for Booker and PreBooker
* Security requirement: [Encrypt data and include a digital signature.](/english/corporate-agent-partner-ca/security-requirements)
Request
Signature data schema
ACCESSCODE|agencyInfo.partnerRefCode|userInfo.partnerRefCode|userInfo.email|userInfo.phoneNumber
Example:
```json
{
"agencyInfo": {
"partnerRefCode": "CHI_NHANH_123",
"fullName": "Chi nhanh Sai Gon",
"shortName": "Cty X, Chi nhanh Sai Gon",
"taxCode": "123456",
"faxNumber": "123456",
"phoneNumber": "0123456789",
"address": "194 Nguyen Thi Minh Khai, Phuong 17, Quan Phu Nhuan",
"email": "user_y@partner_x.com",
"representativeName": "Nguyen Van A",
"representativePhone": "0123456789",
"representativeEmail": "user_y@partner_x.com",
"extends": {
"key": "value",
"key1": "value1"
}
},
"userInfo": {
"partnerRefCode": "USER_123",
"firstName": "Nguyen",
"lastName": "Van A",
"address": "194 Nguyen Thi Minh Khai, Phuong 17, Quan Phu Nhuan",
"email": "user_y@partner_x.com",
"phoneNumber": "0932909474",
"roles": [
"BOOKER", "PRE_BOOKER"
],
"extends": {
"key": "value",
"key1": "value1"
}
},
"signature": "..."
}
```
Response
#### Example
```json
{
"url": "https://uat-v2-vendor.gotadi.com/?merchant_code=A::1_29001&access_token=...",
"signature": "...",
"errorCode": "00"
}
```
HTTP Code
* 400: Bad Request
* 401: Unauthorized
* 403: Forbidden
* 404: Not Found
* 500: Unknown Internal Error
* 503: Service Unavailable
# Security Requirements
### API Key
* x-ibe-req-name: \
Note
The \ and \ values are provided by Gotadi to the Partner.
***
### Digital signature
Generating a Digital Signature
Digital signature verification
Parameters
* utm\_source `query` (String, Optional)
Traffic source
* aff\_sid `query` (String, Optional)
Customer ID exists in the system.
Example
```
https://www.gotadi.com/?utm_source=ZALO&aff_sid=Gotadi_User_2021
```
# FAQ section
What are the booking statuses in the Gotadi system?
The booking status in the Gotadi system is a combination of three statuses:
* **Booking status:** Reservation status
* **Payment status:** Payment status
* **Issued status:** Ticket issuance status, which refers to the service provider's confirmation status after successful payment.
For more details, please refer to the following document:
[Booking Statuses in Gotadi's Booking Flow](/english/faq-section/booking-statuses-in-gotadis-booking-flow)
What test cases are required to complete the B2B2C integration with Gotadi?
Please refer to the standard test case set for B2B2C partners here.
[Bộ Testcase dành cho đối tác B2B2C](/vietnamese/cau-hoi-thuong-gap/bo-testcase-danh-cho-doi-tac-b2b2c)
What are the rules for testing and refund/cancellation of booked tickets during testing?
Please refer to the testing regulations for flight and hotel bookings for both international and domestic itineraries as outlined below.
[Regulations for Testing](/english/faq-section/regulations-for-testing)
What are the steps in the integration process?
The integration process may vary depending on the type of partnership, but it always includes the following two final steps:
* **Acceptance Testing:** Passing the test case set and processing refunds/cancellations for booked tickets during testing.
* **Customer Support Channel Setup:** Establishing a connection with the customer support team.
For more details on the integration process, please refer to the official page.g quan giới thiệu các phương thức
[B2B2C Partner](/english/b2b2c-partner)
[Corporate Agent Partner (CA)](/english/corporate-agent-partner-ca)
[Affiliate Partner](/english/affiliate-partner)
# Booking Statuses in Gotadi's Booking Flow
## Statuses from Booking Management
The Gotadi system has three statuses that are combined into a final status displayed to the user: Booking Status, Payment Status, and Issued Status.
Booking statuses
* Pending
* Booking on Process
* Booked
* Failed
* Expired
Payment statuses
* Pending
* Success
* Failed
* Refund
Issued statuses
* Pending
* Ticket on Process
* Success
* Failed
* Cancel
The statuses will change differently depending on the user's booking flow. Details are as follows:
| Booking successful, awaiting payment, ticket not issued | Combo, Flight, Hotel, Tour | |
| Payment successful, awaiting ticket issuance | Booked | Success | Pending |
| Booking successful, payment successful, awaiting ticket issuance | Combo, Flight, Hotel, Tour | |
| Request submitted, awaiting processing | Booking On Process | Pending | Pending |
| Booking request submitted, awaiting confirmation. Request sent to the Operations team for review & direct customer contact | Tour | |
| Payment failed | Booked | Failed | Pending |
| Booking successful, payment failed, ticket not issued | Combo, Flight, Hotel, Tour | |
| Transaction expired | Expired | Pending | Pending |
| Booking successful, awaiting ticket issuance, payment deadline expired | Combo, Flight, Hotel, Tour | |
| Transaction successful | Booked | Success | Success |
| Booking successful, payment successful, ticket issued successfully | Combo, Flight, Hotel, Tour | |
| Payment successful, ticket issuance failed | Booked | Success | Failed |
| Booking successful, payment successful, ticket issuance failed during manual processing | Combo, Flight | |
| Payment successful, room issuance failed | Booked | Success | Failed |
| Booking successful, payment successful, ticket issuance failed during manual processing | Combo, Hotel | |
| Transaction expired | Booked | Expired | Failed |
| Booking successful, ticket issuance failed, payment deadline expired | Combo, Flight, Hotel, Tour | |
| Transaction processing | Booked | Success | Ticket on Process |
| Booking successful, payment successful, but due to technical issues (network, infrastructure, etc.), information was not sent to the partner and requires manual processing | Combo, Flight, Hotel, Tour | |
| Canceled faulty ticket | Cancel | Success | Ticket on Process |
| Booking successful, payment successful, ticket issuance request is being processed, then booking canceled | Combo, Flight, Hotel, Tour | |
| Canceled successfully issued ticket | Cancel | Success | Success |
| Booking successful, payment successful, ticket issuance request was successful, then booking canceled | Combo, Flight, Hotel, Tour | |
| Refunded faulty ticket | Cancel | Refuned | Ticket on Process |
| Booking canceled due to ticket issue, refund issued to the customer | Combo, Flight, Hotel, Tour | |
| Refunded successfully issued ticket | Cancel | Refuned | Success |
| Booking canceled after successful ticket issuance, refund issued to the customer | Combo, Flight, Hotel, Tour | |
# Regulations for Testing
# Flight
## Introduction:
Description of the steps and regulations for booking domestic flight tickets in Vietnam during the integration process between partners and Gotadi in both environments:
* Production Environment
* UAT Environment
## Domestic Itinerary:
{% hint style="warning" %}
Please notify in advance before performing ticket testing.
{% endhint %}
1. You can search and book tickets (without issuing tickets) for all airlines.
2. Only Vietnam Airlines (VNA) ticket issuance can be tested, with a maximum of **4 passengers per booking**.
3. Passenger name, phone number, and email must be **the tester's actual information**.
4. **Do not use dummy data** (e.g., NGUYEN VAN A, 0900000000, , etc.).
5. Test-issued VNA tickets must be booked at least **30 days in advance** and **must not be on the same flight and travel date**.
6. For test ticket refund/cancellation requests on **UAT/PRODUCTION**, please send an email to **** before **4 PM** on the same day. The email should include the **cancellation request details and the refund amount (if applicable).**
Refund / Cancellation Request Template
**Subject:** \[\-Testing] - Flight Refund/Cancellation Request \
**Email Content:**\
\
Please find the booking details for the refund/cancellation request:
* **Booking Code:** \[Insert PNR Code]
* **Reference Code:** \[Insert Reference Code]
* **Itinerary:** \[Insert Itinerary]
* **Guest Names:** \[List of Guests]
## International Itinerary
{% hint style="warning" %}
Please notify in advance before performing ticket testing.
{% endhint %}
1. You can search and book tickets (without issuing tickets) for all airlines and notify Gotadi of the booked tickets.
2. Only **Vietnam Airlines (VNA) ticket issuance** can be tested, with a maximum of **4 passengers per booking**, and only **1 to 2 bookings per day** can be issued.
3. Passenger name, phone number, and email must be **the tester's actual information**.
4. **Do not use dummy data** (e.g., NGUYEN VAN A, 0900000000, , etc.).
5. Test-issued VNA tickets must be booked **at least 30 days in advance** and **must not be on the same flight and travel date**.
6. For **test ticket refund/cancellation requests on UAT/PRODUCTION**, please send an email to **** before **4 PM** on the same day. The email should include the **cancellation request details and the refund amount (if applicable).**
7. If you need to test ticket issuance for airlines **other than VNA**, please contact Gotadi, and testing is only allowed on airlines designated by Gotadi.
{% hint style="danger" %}
Besides Vietnam Airlines, if you need to test other airlines, please only test on airlines provided by Gotadi.
Depending on the testing period, please contact Gotadi’s technical support team to obtain the list of international airlines available at the time of testing.
{% endhint %}
Refund / Cancellation Request Template
**Subject:** \[\-Testing] - Flight Refund/Cancellation Request \
**Email Content:**\
\
Please find the booking details for the refund/cancellation request:
* **Booking Code:** \[Insert PNR Code]
* **Reference Code:** \[Insert Reference Code]
* **Itinerary:** \[Insert Itinerary]
* **Guest Names:** \[List of Guests]
# Hotel
## Introduction:
Description of the steps and regulations for booking domestic flight tickets in Vietnam during the integration process between partners and Gotadi in both environments:
* Production Environment
* UAT Environment
{% hint style="warning" %}
Please notify in advance before performing ticket testing.
{% endhint %}
{% hint style="danger" %}
Testing is only allowed on hotels provided by Gotadi. Depending on the testing period, please contact Gotadi’s technical support team to obtain the hotel list at the time of testing.
{% endhint %}
1. Select check-in/out dates at least **3 months** from the testing date.
2. Guest information, email, and phone number must be the **actual details** of the tester.
3. **Do not use dummy test data** (e.g., NGUYEN VAN A, 090000000, , etc.).
4. For test ticket refund/cancellation requests on **UAT/PRODUCTION**, please send an email to **** and CC **** **before 4 PM** on the same day. The email should include the **cancellation request details and the refund amount (if applicable).**
Refund / Cancellation Request Template
**Subject:** \[\-Testing] - Hotel Refund/Cancellation Request \
**Email Content:**\
\
Please find the booking details for the refund/cancellation request:
* **Booking Code:** \[Insert Booking Code]
* **Reference Code:** \[Insert Reference Code]
* **Hotel Name:** \[Insert Hotel Name]
* **Guest Names:** \[List of Guests]
* **Paid Amount:** \[Insert Amount]
* **Check-in - Check-out Date:** \[DD/MM/YYYY - DD/MM/YYYY]
# CS Support Overall Flow
" %}