These parameters should be included in all the request of APIs.
O: Optional; R: Required; SR: Special Required
| Name | Type | O/R/SR | Limitation | Description | Example |
|---|---|---|---|---|---|
| AuthenticationToken |
R |
The authentication node which should be included in all the request. |
|||
| AuthenticationToken.Username |
String |
R |
|
Allowable account that granted by 3rd party provider for API invocation |
Fliggy |
| AuthenticationToken.RequestTimestamp |
long |
R |
|
The server time in seconds. Vendors should verify the time, the timestamp before 5 minutes or after 5 minutes is invalid. |
23453455 |
| AuthenticationToken.Signature |
String |
R |
|
SHA256(Username+Password+RequestTimestamp), password is the one that allow API invocation. |
ae7e12812dc83aa255e6dd6eba8aa6e2 |
These nodes should be included in all the response of APIs.
O: Optional; R: Required; SR: Special Required
| Name | Type | O/R/SR | Limitation | Description | Example |
|---|---|---|---|---|---|
| ResponseTimestamp |
long |
R |
|
The timestamp when this response generated, in seconds. The time should be verified and the time before 5 minutes or after 5 minutes is invalid. |
123456789 |
| Error |
O |
The error code and message when an error occur. |
|||
| Error.Code |
String | R |
See error code list | The error code of the error. |
|
| Error.Message |
String | R |
256 | The error message specifies the error. |
| Value | Description |
|---|---|
| NO_INVENTORY |
The rate has no enough inventory |
| HOTEL_INVALID |
The hotel is invalid, no more query again |
| ROOM_TYPE_INVALID |
The room type is invalid, no more query again |
| RATE_PLAN_INVALID |
The rate plain is invalid, no more query again |
| RATE_EXPIRED |
The rate is expired, please validate again |
| PRICE_CHANGED |
The total price is changed, please validate again |
| DUPLICATE_CREATE | Duplicate create,please check the order id |
| ALREADY_CANCELLED | The order is cancelled, please do not cancel again |
| ORDER_NOT_FOUND | Can not find the order,please check the order id |
| AUTH_ERROR | Authorization failed |
| PARA_ERROR | Parameters error |
| SYSTEM_EXCEPTION | System error, please check the rate/order status again. Notice that, when this error occurs, the trade status should be unclear, the extra order query operations should be done. |
The currency codes which are supported by Fliggy, any other currency codes are invalid.
| Value |
|---|
| CNY |
| EUR |
| USD |
| JPY |
| GBP |
| HKD |
| FRF |
| SGD |
| NZD |
| CAD |
| THB |
| AUD |
| KRW |
| Value |
|---|
| Adults |
| Children |
| Value | Description |
|---|---|
| CONFIRMED |
The order status is confirmed by hotels. |
| CANCELLED |
The order is cancelled by customers. Notice that fliggy will cancel the order on customers side when customers apply for cancellation, no matter what cancellation response from vendors side. |
| CONFIRM_PENDING |
The order status is pending after the booking request. Fliggy will continue to query the order status util the order becomes CONFIRMED or the 30 minutes time-up comes. |
| CONFIRM_FAILED |
If the comfirmation process fails, the order status will become CONFIRM_FAILED. |
| Value | Description |
|---|---|
| No |
No breakfast will be served |
| American |
American breakfast. |
| Continental |
Continental breakfast |
| English |
English breakfast |
| Irish |
Irish breakfast |
| Scotland | Scotland breakfast |
| Japanese | Japanese breakfast |
| Chinese | Chinese breakfast |
| Buffet | Buffet breakfast |
| Breakfast | Default Breakfast, when the category of breakfast is not sure. |
| TwoBoards | The breakfast and the dinner |
| FullBoards | Three meals for one day |
| Value | Description |
|---|---|
| 0 |
OTHER（TaxCode corresponding to other taxes except rent tax） |
| 3 |
RENTAL_TAX（Hong Kong） |
