For the complete documentation index, see llms.txt. This page is also available as Markdown.

Switzerland Travel Centre

This guide walks through creating a channel connection between Channex and Switzerland Travel Centre 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 Switzerland Travel Centre 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 Switzerland Travel Centre 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 Switzerland Travel Centre needs.

  2. Collect the settings from the user and run a test connection.

  3. Get the mapping details — the rooms and rates on the Switzerland Travel Centre 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=STC

The adapter code is STC; the channel is titled Switzerland Travel Centre. The full catalog of adapters is available at GET /api/v1/channels/list.

Response (abridged):

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, switch, hidden), position (ordering for a UI), default, options (for select and switch fields) and conditional display rules.

  • rate_params — the fields each rate plan mapping must carry (step 5), described the same way.

For Switzerland Travel Centre, the only setting to collect from the user is hotel_id — the Switzerland Travel Centre 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:

channel is the adapter code from the descriptor; settings is the object built from params.

Response:

success: true means the credentials are correct and the hotel is ready for connection on the Switzerland Travel Centre 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 Switzerland Travel Centre side:

The payload is the same as for the test connection:

Response (abridged):

Every channel returns its own mapping-details shape; this one is Switzerland Travel Centre's.

pricing_type — the hotel's pricing model. Switzerland Travel Centre 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 Switzerland Travel Centre side.

title

Room title.

rates

Rates of the room.

Each rate carries:

Field
Description

id

Rate ID on the Switzerland Travel Centre 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.

occupancies runs from the room's own minimum occupancy to its maximum, and Switzerland Travel Centre sells at most three guests per room, so the maximum is capped at three. A room whose minimum occupancy is above that cap starts at two instead. max_persons is the capped maximum.

4. Collect the Channex side

Switzerland Travel Centre connections are one-to-one: one connection maps exactly one Channex property to one Switzerland Travel Centre hotel. Pick the property to connect, then fetch its room types and rate plans through the options endpoints:

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 Switzerland Travel Centre mappings need.

5. Build the mapping structure

The mapping is a list of rate_plans entries, one per (Channex rate plan occupancy → Switzerland Travel Centre room/rate/occupancy) pair:

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 Switzerland Travel Centre side.

rate_plan_code

Rate ID on the Switzerland Travel Centre side.

occupancy

The occupancy option of the Switzerland Travel Centre rate this mapping serves.

pricing_type

The hotel's pricing model — always OBP for Switzerland Travel Centre.

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.

A full mapping for one Switzerland Travel Centre rate sold at occupancies 2 and 3:

6. Create the connection

The payload is wrapped in a channel key:

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 Switzerland Travel Centre.

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):

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 Switzerland Travel Centre hotel_id is allowed on Channex.

7. Activate the connection

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 Switzerland Travel Centre 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

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

An active connection must be deactivated first. Deleting removes the connection and all its mappings; bookings received through it are kept.

Actions

The Switzerland Travel Centre adapter declares no connection actions — actions is empty on the descriptor and on every Switzerland Travel Centre connection.

What gets synchronized

An active connection pushes each batch of changes to Switzerland Travel Centre as two calls: an availability update carrying availability and restrictions, and a rate update carrying prices.

Availability is sent per room and rate. An availability of zero or below is sent as 0 and closes the date as well.

Rates are sent per room, rate and guest count, so every mapping sends the price of its own occupancy, together with the extra adult and extra child surcharges declared on that mapping. Where a mapping serves two guests, or its rate plan is sold per room, a combined double-and-child price is derived from the rate and the extra child surcharge and sent alongside. A price of 0 is not sent as a price; it closes the date instead.

Restrictions map as follows:

Channex restriction
Switzerland Travel Centre 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). Switzerland Travel Centre 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.

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 polled from Switzerland Travel Centre rather than pushed, and each one is marked as sent once Channex has taken it. Polling happens only while get_bookings is enabled on the connection; turning it off leaves the ARI synchronization running but stops Channex collecting reservations.

Switzerland Travel Centre settings reference

The full set of connection settings for Switzerland Travel Centre:

Setting
Description

hotel_id

The Switzerland Travel Centre Hotel ID. Required.

send_email_notifications

When true, Channex sends a notification about each booking.

get_bookings

Whether to get bookings from Switzerland Travel Centre: true or false. Optional; default true.

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.

Last updated