Hoterip

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

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

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

The full catalog of adapters is available at GET /api/v1/channels/list.

Response (abridged):

{
  "data": {
    "code": "Hoterip",
    "title": "Hoterip",
    "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"
      }
    },
    "rate_params": {
      "rate_plan_code": { "position": 0, "title": "Rate", "type": "string" },
      "room_type_code": { "position": 1, "title": "Room", "type": "string" }
    }
  }
}

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 Hoterip, the only setting to collect from the user is hotel_id — the Hoterip Hotel ID. The remaining settings have sensible defaults; see the settings reference.

Note how short rate_params is: a Hoterip mapping is a room and a rate, with no occupancy dimension. That shapes steps 4 and 5.

2. Test the connection

Before creating anything, validate the collected settings with a test connection:

POST /api/v1/channels/test_connection

{
  "channel": "Hoterip",
  "settings": {
    "hotel_id": "58412"
  }
}

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

Response:

{
  "data": {
    "success": true,
    "errors": null
  }
}

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

POST /api/v1/channels/mapping_details

The payload is the same as for the test connection:

{
  "channel": "Hoterip",
  "settings": {
    "hotel_id": "58412"
  }
}

Response:

{
  "data": {
    "pricing_type": "Standard",
    "rooms": [
      {
        "id": "704311",
        "title": "Deluxe Double Room",
        "rates": [
          {
            "id": "1288402",
            "title": "Room Only"
          },
          {
            "id": "1288403",
            "title": "Room with Breakfast"
          }
        ]
      }
    ]
  }
}

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

pricing_type — the hotel's pricing model. Hoterip uses standard per-room pricing, so it is always Standard: a rate carries one price per date, whatever the occupancy.

rooms — the rooms available for mapping. Each room carries:

Field	Description
id	Room ID on the Hoterip side.
title	Room title.
rates	Rates of the room.

Each rate carries:

Field	Description
id	Rate ID on the Hoterip side.
title	Rate title.

Rates carry no occupancy options, because Hoterip prices a room rather than a headcount.

4. Collect the Channex side

Hoterip connections are one-to-one: one connection maps exactly one Channex property to one Hoterip 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}

Do not enable multi_occupancy here. Hoterip mappings have no occupancy field, so one Channex rate plan maps to one Hoterip rate as a whole; expanding occupancy options would produce entries the mapping cannot express.

5. Build the mapping structure

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

{
  "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
  "settings": {
    "room_type_code": "704311",
    "rate_plan_code": "1288402"
  }
}

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 Hoterip side.
rate_plan_code	Rate ID on the Hoterip side.

Create one mapping per Hoterip room + rate pair you want to sell. There is no primary mapping to nominate: with one mapping per rate, every mapping carries that rate's price, availability and restrictions.

A full mapping for a room sold on two Hoterip rates:

[
  {
    "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
    "settings": {
      "room_type_code": "704311",
      "rate_plan_code": "1288402"
    }
  },
  {
    "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d",
    "settings": {
      "room_type_code": "704311",
      "rate_plan_code": "1288403"
    }
  }
]

6. Create the connection

POST /api/v1/channels

The payload is wrapped in a channel key:

{
  "channel": {
    "channel": "Hoterip",
    "group_id": "60674dd6-1aeb-4c41-9e0c-8ffb378a4570",
    "title": "Hoterip Channel",
    "properties": ["acb388d9-546b-42fc-9ae2-baf00e7f0d8c"],
    "settings": {
      "hotel_id": "58412",
      "min_stay_type": "Arrival",
      "booking_amount_settings": "With Commission"
    },
    "rate_plans": [
      {
        "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
        "settings": {
          "room_type_code": "704311",
          "rate_plan_code": "1288402"
        }
      },
      {
        "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d",
        "settings": {
          "room_type_code": "704311",
          "rate_plan_code": "1288403"
        }
      }
    ]
  }
}

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

{
  "data": {
    "type": "channel",
    "id": "ca4ac55f-3be1-4039-9542-21e8285ffbf9",
    "attributes": {
      "id": "ca4ac55f-3be1-4039-9542-21e8285ffbf9",
      "title": "Hoterip Channel",
      "channel": "Hoterip",
      "is_active": false,
      "actions": [],
      "properties": ["acb388d9-546b-42fc-9ae2-baf00e7f0d8c"],
      "settings": {
        "hotel_id": "58412",
        "min_stay_type": "Arrival",
        "booking_amount_settings": "With Commission"
      },
      "rate_plans": [
        {
          "id": "9d7e45b3-367b-4286-a081-17a6c8d3c62e",
          "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
          "settings": {
            "room_type_code": "704311",
            "rate_plan_code": "1288402"
          }
        },
        {
          "id": "0f6fe97e-ab8b-4f0b-a1cd-dc3500f18295",
          "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d",
          "settings": {
            "room_type_code": "704311",
            "rate_plan_code": "1288403"
          }
        }
      ]
    },
    "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 Hoterip 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 Hoterip 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 Hoterip adapter declares no connection actions — actions is empty on the descriptor and on every Hoterip connection.

What gets synchronized

An active connection pushes each batch of changes to Hoterip as two calls: an availability notification carrying availability and restrictions, and a rate notification carrying prices.

Availability is room-level on the Hoterip side, so it is sent per room and date, not per rate. When several mappings of the same room disagree for a date, the highest availability wins. An availability of zero or below is sent as 0 and closes the date as well.

Rates are sent per room and rate, one price per date — Hoterip prices the room, not the occupancy. A price of 0 is not sent as a price; it closes the date instead.

Restrictions are sent alongside availability and map as follows:

Channex restriction	Hoterip field
stop_sell	closed
closed_to_arrival	closed to arrival
closed_to_departure	closed to departure
min_stay	minimum stay

min_stay is clamped to 1–31. Hoterip accepts no maximum stay, so that restriction is never sent.

min_stay_type decides which Channex minimum stay feeds the Hoterip minimum stay: Arrival sends the min-stay-on-arrival value, Through sends the min-stay-through value. The other one is ignored.

Batching — consecutive dates that carry identical values are collapsed into a single date range, and availability notifications are sent in chunks of thirty messages in parallel.

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.

Hoterip settings reference

The full set of connection settings for Hoterip:

Setting	Description
hotel_id	The Hoterip 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	Which minimum stay restriction is sent: Arrival (min stay on arrival) or Through (min stay through). 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.