title
, city
, latitude
, longitude
, country
, zip_code
, state
, address
and is_available
.
To apply filter pass it as query argument:
/property_list?filter[city]=Moscow
best_offer
, please define checkin_date
and checkout_date
arguments:is_available
will work only with checkin_date
and checkout_date
arguments and will return only Properties, available for bookings at provided time frame.TIT
min_stay_arrival
and min_stay_through
will contain only dates where min stay value is greater than 1.secure-staging.channex.io
[required]
String. Status of Booking, can be one of three values: new
, modified
, cancelled
.[optional]
String. Booking unique ID. For messages with status new
can be empty, in that case Channex will generate unique UUID for booking.[required]
String. Arrival Date represented as string with date in ISO 8601 format by mask YYYY-MM-DD
.[required]
String. Departure Date represented as string with date in ISO 8601 format by mask YYYY-MM-DD
.[optional]
String. Arrival Time represented as string with time in HH:MM
format at 24h.[required]
String. Booking currency code. 3 symbols long string with Currency Alphabetic code based at ISO 4217.[optional]
String. Information about payment collect point. If payment collected via OTA, it should be ota
, in other case it should be property
. Default value is property
.[optional]
String. Information about how payment should be collected. Support bank_transfer
or credit_card
. Can be null
if not specified. bank_transfer
value suitable for OTA collect case.[optional]
String with maximum length of 255 symbols. Name of Customer.[required]
String with maximum length of 255 symbols. Surname of Customer.[optional]
String with maximum length of 255 symbols. Customer City name.[optional]
String with maximum length of 255 symbols. Customer Address.[optional]
String with maximum length of 32 symbols. Customer ZIP Code.[optional]
String with a valid email address. Customer Email address.[optional]
String with maximum length of 32 symbols. Can contain digits, spaces, brackets and special characters. Customer Phone number.[optional]
String. 2 symbols long string with language locale code.[optional]
Object with information about Customer Company (if customer is Business). Can contain next fields:[optional]
String with maximum length of 255 symbols.[optional]
String with maximum length of 255 symbols. Tax Number.[optional]
String with maximum length of 255 symbols. Tax Name (eg: VAT)[optional]
Object without any specific structure where you can pass any additional information about Customer.secure-staging.channex.io
or secure.channex.io
(for production environment) endpoints. Otherwise the credit card will be masked without ability to restore the original card.[required]
String with Card Expiration date in MM/YYYY
format.[required]
String with 3 or 4 numbers. Service code for payment systems.[required]
String. Cardholder name from Card front.[required]
String. Card type name.[required]
String. Card number.[optional]
Object. Can contain any additional information for booking recipient. Also, if you work with Virtual Credit Cards, you can use next fields:room_type_code
, occupancy
, and days breakdown.[optional]
Integer. Room Index to associate Services at Room level. Incremented value, start from 0.[required]
String. Code of Room Type received at Get Rooms List operation.[required]
String. Rate Plan Code received at Get Rooms List operation.[required]
Object with information about occupancy. Should contain next fields:[required]
Integer. Count of adults (persons older then 16 years old)[required]
Integer. Count of children (persons between 2 and 16 years old)[required]
Integer. Count of infants (persons younger then 2 years old)[required]
String. Type of Service. One of possible values: Meal, Fee, Extra
[required]
String. Total Service price.[required]
String. Price per one unit of Service.[required]
String. Service calculation price logic. One of possible values: Per stay, Per night, Per person, Per person per night
[required]
Integer. Count of persons associated with Service.[required]
Integer. Count of nights associated with Service.[required]
String. Name of service.[optional]
Integer. Index of room which is associated with Service. Keep in mind, Room should have index
.