> For the complete documentation index, see [llms.txt](https://docs.channex.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.channex.io/channel-api-examples/tablet-hotels.md). # Tablet Hotels This guide walks through creating a channel connection between Channex and Tablet Hotels over the API: discovering the adapter, validating the hotel credentials, reading the rooms and rates on both sides, building the mapping, and creating and activating the connection. A **channel connection** (a *channel*) links rate plans of a Channex property to rooms and rates on the OTA side. Once the connection is active, Channex pushes availability, rates and restrictions to Tablet Hotels and receives bookings back. Every OTA has its own API and data model, so the connection settings and the mapping settings differ per channel. The flow below is shared by most channels (Booking.com, Expedia, Agoda, Open Channel–based OTAs and others); the payloads shown are the Tablet Hotels ones. Airbnb is the exception — it requires an OAuth authorization step and is covered by a separate guide. All endpoints require authentication with an API key, sent in the `user-api-key` header. #### The flow at a glance 1. Get the adapter descriptor — what settings and mapping fields Tablet Hotels needs. 2. Collect the settings from the user and run a test connection. 3. Get the mapping details — the rooms and rates on the Tablet Hotels side. 4. Collect the Channex side — the property, its room types and rate plans. 5. Build the mapping structure. 6. Create the connection. 7. Activate it. #### 1. Get the adapter descriptor Each channel is described by an **adapter descriptor**: the settings it needs (`params`) and the per-mapping fields it needs (`rate_params`). ``` GET /api/v1/channels/adapter?code=TabletHotels ``` The full catalog of adapters is available at `GET /api/v1/channels/list`. Response (abridged): ```json { "data": { "code": "TabletHotels", "title": "TabletHotels", "kind": "meta", "actions": [], "params": { "hotel_id": { "position": 0, "type": "string", "title": "Hotel ID" }, "send_email_notifications": { "default": false, "position": 1, "type": "boolean", "title": "Send Property Notification" }, "email": { "position": 2, "type": "string", "title": "Property Email", "rules": [ { "apply": "hidden", "when": false, "influence_field": "send_email_notifications", "with_value": "" } ] }, "min_stay_type": { "default": "Arrival", "position": 3, "type": "select", "options": ["Arrival", "Through"], "title": "Min Stay Type" }, "booking_amount_settings": { "default": "With Commission", "position": 4, "type": "select", "options": ["With Commission", "Without Commission"], "title": "Booking Amount" }, "ari_amount_settings": { "default": "With Commission", "position": 5, "type": "select", "options": ["With Commission", "Without Commission"], "title": "ARI Amount" } }, "rate_params": { "rate_plan_code": { "position": 0, "title": "Rate", "type": "string" }, "room_type_code": { "position": 1, "title": "Room", "type": "string" }, "pricing_type": { "position": 3, "title": "Pricing Type", "type": "string" }, "primary_occ": { "position": 4, "title": "Primary Occupancy", "type": "boolean" }, "extra_adult_price": { "position": 5, "title": "Extra Adult Price", "type": "integer" }, "extra_child_price": { "position": 6, "title": "Extra Child Price", "type": "integer" }, "occupancy": { "position": 7, "title": "Occupancy", "type": "integer" } } } } ``` What to read from it: * **`params`** — the connection settings to collect from the user. Each entry describes one field: `title` (English label), `type` (`string`, `integer`, `boolean`, `select`, `hidden`), `position` (ordering for a UI), `default`, `options` (for `select` fields) and conditional display `rules`. * **`rate_params`** — the fields each rate plan mapping must carry (step 5), described the same way. For Tablet Hotels, the only setting to collect from the user is **`hotel_id`** — the Tablet Hotels Hotel ID. The remaining settings have sensible defaults; see the settings reference. #### 2. Test the connection Before creating anything, validate the collected settings with a test connection: ``` POST /api/v1/channels/test_connection ``` ```json { "channel": "TabletHotels", "settings": { "hotel_id": "12345" } } ``` `channel` is the adapter code from the descriptor; `settings` is the object built from `params`. Response: ```json { "data": { "success": true, "errors": null } } ``` `success: true` means the credentials are correct and the hotel is ready for connection on the Tablet Hotels side. On failure the response is still `200 OK` with `success: false` — check the `success` field, not the status code. #### 3. Get the mapping details Next, fetch the rooms and rates the hotel exposes on the Tablet Hotels side: ``` POST /api/v1/channels/mapping_details ``` The payload is the same as for the test connection: ```json { "channel": "TabletHotels", "settings": { "hotel_id": "12345" } } ``` Response: ```json { "data": { "pricing_type": "OBP", "rooms": [ { "id": "STDK", "title": "Standard King", "rates": [ { "id": "BAR", "title": "Best Available Rate", "occupancies": [1, 2], "max_persons": 2 } ] }, { "id": "DLXK", "title": "Deluxe King", "rates": [ { "id": "BAR", "title": "Best Available Rate", "occupancies": [1, 2], "max_persons": 2 } ] } ] } } ``` Every channel returns its own mapping-details shape; this one is Tablet Hotels'. **`pricing_type`** — the hotel's pricing model. Tablet Hotels uses occupancy-based pricing only, so it is always `OBP`: each rate carries a price per occupancy option. **`rooms`** — the rooms available for mapping. Each room carries: | Field | Description | | ------- | ---------------------------------- | | `id` | Room ID on the Tablet Hotels side. | | `title` | Room title. | | `rates` | Rates of the room. | Each rate carries: | Field | Description | | ------------- | ------------------------------------------- | | `id` | Rate ID on the Tablet Hotels side. | | `title` | Rate title. | | `occupancies` | Occupancy options of the rate on this room. | | `max_persons` | Maximum number of persons. | The same rate can be offered on several rooms: it appears under each room it is sold on, with the occupancy options it has there, and a mapping always targets one room + rate pair. Tablet Hotels sells single and double occupancy only, so `occupancies` is always `[1, 2]` and `max_persons` is always `2`, whatever capacity the room has on the Tablet Hotels side. Guests beyond the second are priced through the extra adult and extra child surcharges on the mapping. #### 4. Collect the Channex side Tablet Hotels connections are one-to-one: **one connection maps exactly one Channex property to one Tablet Hotels hotel**. Pick the property to connect, then fetch its room types and rate plans through the `options` endpoints: ``` GET /api/v1/room_types/options?filter[property_id]={property_id} GET /api/v1/rate_plans/options?filter[property_id]={property_id}&multi_occupancy=true ``` Enable `multi_occupancy` on the rate plans request: for occupancy-based rate plans it expands each occupancy option into its own entry, which is exactly the granularity Tablet Hotels mappings need. #### 5. Build the mapping structure The mapping is a list of `rate_plans` entries, one per (Channex rate plan occupancy → Tablet Hotels room/rate/occupancy) pair: ```json { "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958", "settings": { "room_type_code": "STDK", "rate_plan_code": "BAR", "occupancy": 2, "pricing_type": "OBP", "primary_occ": true, "extra_adult_price": 0, "extra_child_price": 0 } } ``` **`rate_plan_id`** — the Channex rate plan UUID (from step 4). **`settings`** — the fields declared by `rate_params` in the adapter descriptor: | Field | Description | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `room_type_code` | Room ID on the Tablet Hotels side. | | `rate_plan_code` | Rate ID on the Tablet Hotels side. | | `occupancy` | The occupancy option of the Tablet Hotels rate this mapping serves. | | `pricing_type` | The hotel's pricing model — always `OBP` for Tablet Hotels. | | `primary_occ` | Whether this mapping is the primary one for its room + rate pair. The primary mapping sends availability and restrictions along with prices; non-primary mappings send prices only. | | `extra_adult_price` | Extra adult surcharge amount. Optional. | | `extra_child_price` | Extra child surcharge amount. Optional. | Mark **exactly one mapping of each room + rate pair** as primary, and create one mapping per occupancy option you want to sell. Put the extra adult and extra child surcharges on the primary mapping: they are read from that mapping only. A full mapping for one Tablet Hotels rate sold at occupancies 1 and 2: ```json [ { "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958", "settings": { "room_type_code": "STDK", "rate_plan_code": "BAR", "occupancy": 2, "pricing_type": "OBP", "primary_occ": true, "extra_adult_price": 0, "extra_child_price": 0 } }, { "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d", "settings": { "room_type_code": "STDK", "rate_plan_code": "BAR", "occupancy": 1, "pricing_type": "OBP", "primary_occ": false } } ] ``` #### 6. Create the connection ``` POST /api/v1/channels ``` The payload is wrapped in a `channel` key: ```json { "channel": { "channel": "TabletHotels", "group_id": "60674dd6-1aeb-4c41-9e0c-8ffb378a4570", "title": "Tablet Hotels Channel", "properties": ["acb388d9-546b-42fc-9ae2-baf00e7f0d8c"], "settings": { "hotel_id": "12345", "min_stay_type": "Arrival", "booking_amount_settings": "With Commission", "ari_amount_settings": "With Commission" }, "rate_plans": [ { "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958", "settings": { "room_type_code": "STDK", "rate_plan_code": "BAR", "occupancy": 2, "pricing_type": "OBP", "primary_occ": true, "extra_adult_price": 0, "extra_child_price": 0 } }, { "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d", "settings": { "room_type_code": "STDK", "rate_plan_code": "BAR", "occupancy": 1, "pricing_type": "OBP", "primary_occ": false } } ] } } ``` | Field | Description | | ------------ | ---------------------------------------------------------------------------------------------------------- | | `channel` | The adapter code from the descriptor. | | `group_id` | UUID of the group the connection belongs to. Required. | | `title` | Connection title. Optional — generated from the channel and property names when omitted. | | `properties` | UUIDs of the connected properties. One property for Tablet Hotels. | | `settings` | The connection settings built from `params` — the same object the test connection validated. | | `rate_plans` | The mapping structure from step 5. Optional — mappings can also be added later by updating the connection. | The response is `201 Created` with the channel connection resource (abridged): ```json { "data": { "type": "channel", "id": "ca4ac55f-3be1-4039-9542-21e8285ffbf9", "attributes": { "id": "ca4ac55f-3be1-4039-9542-21e8285ffbf9", "title": "Tablet Hotels Channel", "channel": "TabletHotels", "is_active": false, "actions": [], "properties": ["acb388d9-546b-42fc-9ae2-baf00e7f0d8c"], "settings": { "hotel_id": "12345", "min_stay_type": "Arrival", "booking_amount_settings": "With Commission", "ari_amount_settings": "With Commission" }, "rate_plans": [ { "id": "9d7e45b3-367b-4286-a081-17a6c8d3c62e", "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958", "settings": { "room_type_code": "STDK", "rate_plan_code": "BAR", "occupancy": 2, "pricing_type": "OBP", "primary_occ": true, "extra_adult_price": 0, "extra_child_price": 0 } }, { "id": "0f6fe97e-ab8b-4f0b-a1cd-dc3500f18295", "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d", "settings": { "room_type_code": "STDK", "rate_plan_code": "BAR", "occupancy": 1, "pricing_type": "OBP", "primary_occ": false } } ] }, "relationships": { "group": { "data": { "id": "60674dd6-1aeb-4c41-9e0c-8ffb378a4570", "type": "group" } }, "properties": { "data": [ { "id": "acb388d9-546b-42fc-9ae2-baf00e7f0d8c", "type": "property" } ] } } } } ``` Note that the connection **starts disabled**: `is_active` in the create payload has no effect — a new connection is always created with `is_active: false`. Activation is a separate, explicit step. Only one connection per Tablet Hotels `hotel_id` is allowed on Channex. #### 7. Activate the connection ``` POST /api/v1/channels/{channel_id}/activate ``` No payload. Activation requires the connection to have at least one property and at least one rate plan mapping; activating starts the synchronization — Channex pushes the full current availability, rates and restrictions to Tablet Hotels and begins receiving bookings. The counterpart is `POST /api/v1/channels/{channel_id}/deactivate`, which stops the synchronization but keeps the connection and its mappings. #### Updating a connection ``` PUT /api/v1/channels/{channel_id} ``` The payload has the same shape as for create (wrapped in `channel`). Two rules matter: * **`channel` cannot be changed** — a different adapter code is rejected. * **`rate_plans`, when present, replaces the whole mapping set.** A stored mapping missing from the list is removed, and a mapping sent with `settings: null` is removed as well. Omit `rate_plans` entirely to keep the stored mappings. #### Deleting a connection ``` DELETE /api/v1/channels/{channel_id} ``` An active connection must be deactivated first. Deleting removes the connection and all its mappings; bookings received through it are kept. #### Actions The Tablet Hotels adapter declares no connection actions — `actions` is empty on the descriptor and on every Tablet Hotels connection. #### What gets synchronized An active connection pushes each batch of changes to Tablet Hotels as two calls: an availability notification carrying availability and restrictions, and a rate notification carrying prices. **Availability** is sent per room and rate. An availability of zero or below is sent as `0`. **Rates** are sent per room and rate, with the single and double prices in the same message, so every mapping sends the price of its own occupancy. The extra adult and extra child surcharges travel with them as additional guest amounts, and they are taken from the primary mapping only — surcharges set on a non-primary mapping are not sent. A price of `0` is not sent as a price; it closes the date instead. **Tablet Hotels always wants the single price alongside the double.** When a change covers double occupancy only, Channex fills the single price in: from the current state of the sibling single-occupancy rate plan, or, for a rate plan sold per room, by repeating the same price for one guest. **`ari_amount_settings`** decides how the price is labelled: `With Commission` sends it as the amount after tax, `Without Commission` as the amount before tax. **Restrictions** map as follows: | Channex restriction | Tablet Hotels field | | ------------------- | ------------------- | | `stop_sell` | closed | | `closed_to_arrival` | closed to arrival | | `min_stay` | minimum stay | | `max_stay` | maximum stay | `min_stay` and `max_stay` are both clamped to 1–31 (a `max_stay` of `0`, meaning no limit in Channex, is sent as `31`). Tablet Hotels accepts no closed-to-departure restriction, so that one is never sent. **`min_stay_type`** decides which Channex minimum stay feeds the minimum stay: `Arrival` sends the min-stay-on-arrival value, `Through` sends the min-stay-through value. The other one is ignored. **Merging** — for one date, room and rate, the rate, availability and restriction changes of both occupancies are merged into a single message. Where two mappings disagree on a value that is not per-occupancy, the primary mapping wins. **Horizon** — changes are pushed for the next 365 days, counted from today in the property's timezone. Changes for dates in the past or beyond that window are dropped. **Bookings** are pushed to Channex by Tablet Hotels rather than polled, and are matched back to a Channex rate plan by the room + rate pair they carry. A booking for an unmapped room + rate pair still arrives, but as unmapped. #### Tablet Hotels settings reference The full set of connection `settings` for Tablet Hotels: | Setting | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `hotel_id` | The Tablet Hotels Hotel ID. Required. | | `send_email_notifications` | When `true`, Channex sends a notification about each booking. | | `email` | The email address the notifications go to. | | `min_stay_type` | How the minimum stay restriction is applied: `Arrival` (counted from the arrival date) or `Through` (applied to every stayed-through date). Default `Arrival`. | | `booking_amount_settings` | Which amount is recorded as the booking total: `With Commission` (the amount after tax) or `Without Commission` (the amount before tax). Default `With Commission`. | | `ari_amount_settings` | Which amount the pushed prices are sent as: `With Commission` (the amount after tax) or `Without Commission` (the amount before tax). Default `With Commission`. |