These are the fixed values a field can take. Values are case-sensitive.
Offers and rate plans
rate_type
rate_type| Value | Meaning |
|---|---|
PUBLIC | Standard public rate |
CNR | Corporate negotiated rate (needs corporate_profile_id) |
NET | Net rate |
MOBILE | Mobile-only rate |
CUG | Closed user group rate |
PACKAGE | Package rate (e.g. unit + extras) |
OPAQUE | Opaque rate: the hotel's identity is not shown to the guest before booking |
B2B | Business-to-business rate |
GENERAL_PROMO | General promotion |
TEMP_PROMO | Temporary promotion |
New values are added over time. Treat an unknown rate_type as PUBLIC rather than failing.
payment_method
payment_methodCREDIT_CARD, KTX_PAYMENTS. See Payments.
payment_modes
payment_modesPAY_NOW, PAY_AT_PROPERTY
meals
meals| Value | Meaning |
|---|---|
Self-catering | No meals included |
Breakfast included | |
Breakfast and lunch included | |
Breakfast and dinner included | Half board |
All inclusive |
taxes[].charged_at
taxes[].charged_atBOOKING: included in the booking price. PROPERTY: paid at the hotel.
Policies
| Field | Values |
|---|---|
charge_type | fixed, percentage, nights |
reference | prior-to-arrival, after-booking |
type | static, dynamic |
See Cancellation for what they mean.
Bookings
Reservation status
statusTO_BE_DELIVERED, CONFIRMED, FAILED, TO_BE_CANCELLED, CANCELLED, CANCELLATION_FAILED. See Booking.
Reservation errors[].code
errors[].codeNO_AVAILABILITY, PRICE_CHANGED, PAYMENT_ERROR, SUPPLIER_ERROR, EXTERNAL_TIMEOUT, INTERNAL_SERVER_ERROR, UPDATE_REJECTED, CANCELLATION_REJECTED. See Booking.
tax_remittance
tax_remittanceSINGLE_REMITTANCE, DUAL_REMITTANCE (US only).
Card types
payment.type accepts:
visa, mastercard, master_card, amex, discover_card, diners_club, carte_blanche, maestro, china_union_pay, japanese_credit_bureau, euro_card, bank_card, carte_bleu, giro_card, forbrugsforeningskort, universal_air_travel
Properties and units
| Field | Meaning |
|---|---|
facilities (property) | Facilities of the property as a whole, e.g. parking, pool, restaurant. |
amenities (unit) | Amenities of a unit type, e.g. air conditioning, minibar. |
images[].tag | Currently only Featured (the main image) or empty. |
star_rating | 0 = no official rating. |
bed_types[].name, unit.type | Free text from the hotel. |
timezone | IANA timezone name, e.g. Europe/Amsterdam. Check-in/out times and policy deadlines are in this timezone. |
check_in_time, check_out_time | As provided by the hotel (e.g. 3pm). Omitted if unknown. |
country_code | Two-letter code, lower case (e.g. gr). Can be empty. |
unit.class, rate plan services | Deprecated. Not maintained and will be removed in a future API version. Don't build on them. |
See Properties for every field.
Property content is updated by the hotels. Refreshing your copy weekly is enough.