Bookeasy

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

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

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

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

Response (abridged):

{
  "data": {
    "code": "Bookeasy",
    "title": "Bookeasy",
    "kind": "meta",
    "actions": [],
    "params": {
      "hotel_id": {
        "position": 0,
        "type": "string",
        "title": "Hotel ID"
      },
      "username": {
        "position": 1,
        "type": "string",
        "title": "Username"
      },
      "password": {
        "position": 2,
        "type": "password",
        "title": "Password"
      },
      "email": {
        "position": 5,
        "type": "string",
        "title": "Property Email",
        "rules": [
          {
            "apply": "hidden",
            "when": false,
            "influence_field": "send_email_notifications",
            "with_value": ""
          }
        ]
      },
      "send_email_notifications": {
        "default": false,
        "position": 6,
        "type": "boolean",
        "title": "Send Property Notification"
      }
    },
    "rate_params": {
      "rate_plan_code": { "position": 0, "title": "Rate", "type": "string" },
      "room_type_code": { "position": 1, "title": "Room", "type": "string" },
      "occupancy": { "position": 2, "title": "Occupancy", "type": "integer" },
      "pricing_type": { "position": 3, "title": "PricingType", "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" }
    }
  }
}

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, password, 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 Bookeasy, the settings to collect from the user are hotel_id, username and password — the credentials of the operator on Bookeasy. 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

{
  "channel": "Bookeasy",
  "settings": {
    "hotel_id": "4821",
    "username": "coastalstays",
    "password": "Xk7pQ2mN"
  }
}

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 Bookeasy 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 Bookeasy side:

POST /api/v1/channels/mapping_details

The payload is the same as for the test connection:

{
  "channel": "Bookeasy",
  "settings": {
    "hotel_id": "4821",
    "username": "coastalstays",
    "password": "Xk7pQ2mN"
  }
}

Response:

{
  "data": {
    "pricing_type": "OBP",
    "rooms": [
      {
        "id": "31882",
        "title": "Ocean View Apartment",
        "rates": [
          {
            "id": "1",
            "title": "1 Night Rate",
            "occupancies": [1, 2, 3],
            "max_persons": 3
          },
          {
            "id": "7",
            "title": "7 Nights Rate",
            "occupancies": [1, 2, 3],
            "max_persons": 3
          }
        ]
      }
    ]
  }
}

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

pricing_type — the hotel's pricing model. Bookeasy 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 Bookeasy side.
title	Room title.
rates	Rates of the room.

Each rate carries:

Field	Description
id	Rate ID on the Bookeasy side.
title	Rate title.
occupancies	Occupancy options of the rate on this room.
max_persons	Maximum number of persons.

Bookeasy rates are length-of-stay rates: the rate ID is the number of nights the rate applies to, and the title is derived from it (1 Night Rate, 7 Nights Rate). A room exposes one rate per stay length its Bookeasy setup offers, and occupancies runs from one guest to the room's maximum. Rooms that are inactive on the Bookeasy side are not returned and cannot be mapped.

4. Collect the Channex side

Bookeasy connections are one-to-one: one connection maps exactly one Channex property to one Bookeasy 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 Bookeasy mappings need.

5. Build the mapping structure

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

{
  "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
  "settings": {
    "room_type_code": "31882",
    "rate_plan_code": "1",
    "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 Bookeasy side.
rate_plan_code	Rate ID on the Bookeasy side.
occupancy	The occupancy option of the Bookeasy rate this mapping serves.
pricing_type	The hotel's pricing model — always OBP for Bookeasy.
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	Surcharge for each extra adult.
extra_child_price	Surcharge for each extra child.

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 Bookeasy rate sold at occupancies 1 and 2:

[
  {
    "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
    "settings": {
      "room_type_code": "31882",
      "rate_plan_code": "1",
      "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": "31882",
      "rate_plan_code": "1",
      "occupancy": 1,
      "pricing_type": "OBP",
      "primary_occ": false,
      "extra_adult_price": 0,
      "extra_child_price": 0
    }
  }
]

6. Create the connection

POST /api/v1/channels

The payload is wrapped in a channel key:

{
  "channel": {
    "channel": "Bookeasy",
    "group_id": "60674dd6-1aeb-4c41-9e0c-8ffb378a4570",
    "title": "Bookeasy Channel",
    "properties": ["acb388d9-546b-42fc-9ae2-baf00e7f0d8c"],
    "settings": {
      "hotel_id": "4821",
      "username": "coastalstays",
      "password": "Xk7pQ2mN"
    },
    "rate_plans": [
      {
        "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
        "settings": {
          "room_type_code": "31882",
          "rate_plan_code": "1",
          "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": "31882",
          "rate_plan_code": "1",
          "occupancy": 1,
          "pricing_type": "OBP",
          "primary_occ": false,
          "extra_adult_price": 0,
          "extra_child_price": 0
        }
      }
    ]
  }
}

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 Bookeasy.
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": "Bookeasy Channel",
      "channel": "Bookeasy",
      "is_active": false,
      "actions": [],
      "properties": ["acb388d9-546b-42fc-9ae2-baf00e7f0d8c"],
      "settings": {
        "hotel_id": "4821",
        "username": "coastalstays",
        "password": "Xk7pQ2mN"
      },
      "rate_plans": [
        {
          "id": "9d7e45b3-367b-4286-a081-17a6c8d3c62e",
          "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
          "settings": {
            "room_type_code": "31882",
            "rate_plan_code": "1",
            "occupancy": 2,
            "pricing_type": "OBP",
            "primary_occ": true,
            "extra_adult_price": 0,
            "extra_child_price": 0
          }
        }
      ]
    },
    "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 Bookeasy 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 Bookeasy and begins receiving bookings.

For Bookeasy, activating also switches on the operator's notification options (availability, booking, operator, rate, room and tour notifications) so that Bookeasy starts delivering bookings to Channex.

The counterpart is POST /api/v1/channels/{channel_id}/deactivate, which stops the synchronization but keeps the connection and its mappings. It switches those notification options back off.

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 Bookeasy adapter declares no connection actions — actions is empty on the descriptor and on every Bookeasy connection.

What gets synchronized

An active connection pushes each batch of changes to Bookeasy as two calls: set rates and set availability.

Availability is room-level on the Bookeasy 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 among that room's primary mappings wins. An availability of zero or below is sent as 0 and closes the room for that date.

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. A price of 0 is not sent as a price — it closes the date instead.

Restrictions — Bookeasy accepts stop sell only. Minimum stay, maximum stay, closed to arrival and closed to departure are not part of the Bookeasy ARI API and are never sent; length of stay is expressed through the length-of-stay rates themselves.

Channex restriction	Bookeasy field
stop_sell	closed

Batching — consecutive dates that carry identical values are collapsed into a single date range, so a month of unchanged rates travels as one entry rather than thirty.

Horizon — changes are pushed for the next 1000 days, counted from today in the property's timezone. Changes for dates in the past or beyond that window are dropped.

Bookeasy settings reference

The full set of connection settings for Bookeasy:

Setting	Description
hotel_id	The Bookeasy Hotel ID. Required.
username	The Bookeasy operator username. Required.
password	The Bookeasy operator password. Required.
email	The email address the notifications go to.
send_email_notifications	When true, Channex sends a notification about each booking.