mapping_details/ part is predefined by Channex. Endpoint should end with a / symbol.200 OKhotel_code and return room and rate details for mapping.200 OKroom_types
List of room types available at your side for mapping. Should contain id, title and rate_plansrate_plans
List of rate plans associated with room type available at your side for mapping. Should contain id, title, sell_mode, max_persons, currency, read_only.sell_mode
Flag to show how room is sell at your side. Can have one of 2 options: per_room or per_person. If rate plan is set as per_room Channex.io will provide updates only for max_persons occupancy. If rate plan is set as per_person channex.io will provide updates for each mapped occupancy (from 1 to max_persons).max_persons
Max count of guests allowed by rate plan. Integer value greater than 0.currency
ISO 4217 3-alpha currency code of rate plan.read_only
If your rate plan does not allow updates, but can be sold at 3rd party side, you can pass it with flag read_only equal to true. In that case, we will allow user to map this rate plan but not provide updates for this rate plan.unique_id is a unique key, which can be used to identify the query at an incident review process.request_id and changes list.availability changesrestriction_changesavailability_changes and contains information about:room_type_id at your system)date_from) represented as Date at ISO 8601 (YYYY-MM-DD) formatdate_to) represented as Date at ISO 8601 (YYYY-MM-DD) formatavailability) integer value with count of available roomsrestriction_changes and contain information about:rate_plan_id at your system)date_from) represented as Date at ISO 8601 (YYYY-MM-DD) formatdate_to) represented as Date at ISO 8601 (YYYY-MM-DD) formatstop_sell) represented as Boolean valueclosed_to_arrival) represented as Boolean valueclosed_to_departure) represented as Boolean valuemin_stay_arrival) represented as positive Integer valuemin_stay_through) represented as positive Integer valuemax_stay) represented as non-negative Integer value, where 0 mean restriction is not applicablerates)min_stay_arrival. And then let us know this limitation when we work with you in production. We will create an extra option for your channel to send the correct min stay the customer uses.sell_mode).
For Rate Plans with sell_mode equal to per_room we will provide prices like the next message:sell_mode equal to per_person we will provide prices like the next message:open_channel_api_key, when you finish your implementation, we will provide API Key specific for your channel connection.secure domain name to push bookings to keep provided credit cards at our PCI Storage.[required]
String. Status of Booking, can be one of three values: new, modified, cancelled.[required]
String. Your unique provider_code. Under test, you should use value OpenChannel.[required]
String. Hotel Code used at Mapping details.[optional]
String. Booking unique ID. For messages with status new can be empty, in that case Channex will generate unique UUID for booking. If your system passes bookings from 3rd party OTA, you should provide original reservation ID.[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. Guest notes or special request.[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]
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)[optional]
Array with objects. Information about guest names.[required]
Array with objects. Information about daily prices and rate plans. Keep in mind, our Shopping API support Mixed Rate Plans. Each object should contain next fields:[required]
Date represented as string with date in ISO 8601 format by mask YYYY-MM-DD.[required]
String or Integer. Price of room at specific date.[required]
String. Rate Plan Code received at Get Rooms List operation.[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.request_full_sync method.