Health Check
POST/v2.0/ping
Introduction
Simple health-check endpoint, used to confirm the API is up and that authentication (Username/Password) is working.
Request
- application/json
Body
Your id for this call, up to 128 printable characters. Returned as is in the response, success or error, and kept in our logs: quote it when contacting support, even if the response never reached you. Use a new value for each call.
When you sent this request, by your clock: ISO 8601 with a timezone offset, e.g. 2026-11-13T14:32:05.120-03:00. Kept in our logs.
Responses
- 200
- default
- application/json
- Schema
- Example (from schema)
Schema
Our id for this call, also in the X-Request-Id header. Quote it when contacting support.
The externalRequestId of the request, as sent. Absent when it wasn't sent.
When we answered, by our clock: ISO 8601 in UTC, e.g. 2026-11-13T17:32:05.874Z.
Always "ok" when the API is up.
{
"requestId": "string",
"externalRequestId": "string",
"timestamp": "string",
"status": "string"
}
Error. The status depends on error.code.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
Our id for this call, also in the X-Request-Id header. Quote it when contacting support.
The externalRequestId of the request, as sent. Absent when it wasn't sent.
When we answered, by our clock: ISO 8601 in UTC, e.g. 2026-11-13T17:32:05.874Z.
error objectrequired
Stable reason; decide what to do based on it, not on message.
| Code | Status | When |
| --- | --- | --- |
| INVALID_REQUEST | 400 | The request was rejected; field problems are listed in details |
| UNAUTHORIZED | 401 | Missing or invalid credentials |
| FORBIDDEN | 403 | Valid credentials, access denied |
| NOT_FOUND | 404 | Order not found, or no endpoint for this method and path |
| TOKEN_EXPIRED | 409 | rateToken or bookingToken past its expiration; search or check the price again |
| DUPLICATE_REFERENCE | 409 | The booking's externalReference already has an order; read it with v2.0/orders/details |
| FEATURE_NOT_AVAILABLE | 422 | A valid request that isn't supported yet |
| RATE_LIMITED | 429 | Too many requests, or quota exceeded |
| SEARCH_FAILED | as received | The hotel search failed; message has the reason given |
| BOOKING_FAILED | as received | The booking was not completed; message has the reason given |
| CANCELLATION_FAILED | as received | The cancellation was not completed; message has the reason given |
| SUPPLIER_ERROR | 502 | A supplier failed or answered badly |
| TIMEOUT | 504 | The request took too long; a booking may still complete |
| INTERNAL_ERROR | 500 | Unexpected failure on our side |
Explanation for people. May change; don't parse it.
details object[]nullable
Every field problem found, even when there is only one. Only with INVALID_REQUEST.
INVALID_FIELD (a value is wrong) or REQUIRED_FIELD (a value is missing).
Path of the field in the request, e.g. items[0].rooms[1].rateToken. Absent when the problem involves several fields.
Explanation, in English.
{
"requestId": "string",
"externalRequestId": "string",
"timestamp": "string",
"error": {
"code": "string",
"message": "string",
"details": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
}
}