Mr and Mrs Smith
This guide walks through creating a channel connection between Channex and Mr & Mrs Smith 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 Mr & Mrs Smith 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 Mr & Mrs Smith 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
Get the adapter descriptor — what settings and mapping fields Mr & Mrs Smith needs.
Collect the settings from the user and run a test connection.
Get the mapping details — the rooms and rates on the Mr & Mrs Smith side.
Collect the Channex side — the property, its room types and rate plans.
Build the mapping structure.
Create the connection.
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=MrAndMrsSmithThe 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(forselectandswitchfields) and conditional displayrules.rate_params— the fields each rate plan mapping must carry (step 5), described the same way.
For Mr & Mrs Smith, the only setting to collect from the user is hotel_id — the Mr & Mrs Smith 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 Mr & Mrs Smith 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 Mr & Mrs Smith side:
The payload is the same as for the test connection:
Response (abridged):
Every channel returns its own mapping-details shape; this one is Mr & Mrs Smith's.
pricing_type — the hotel's pricing model. Mr & Mrs Smith uses per-room pricing only, so it is always Standard: each rate carries one price per room.
rooms — the rooms available for mapping. Each room carries:
id
Room ID on the Mr & Mrs Smith side.
title
Room title.
rates
Rates of the room.
Each rate carries:
id
Rate ID on the Mr & Mrs Smith side.
title
Rate title.
charge_type
How the rate is charged: per_room — one price per room per night.
derived_rate_plan_ids
IDs of the rates derived from this rate; empty for rates that have none.
The same rate can be offered on several rooms: it appears under each room it is sold on, and a mapping always targets one room + rate pair.
Only parent rates are listed. Rates that Mr & Mrs Smith derives from another rate do not appear as rates of a room themselves — their IDs are collected in the parent's derived_rate_plan_ids, and when the connection is created or its mappings updated, Channex records known mappings for them automatically, so bookings arriving on a derived rate are allocated to the parent's mapped rate plan.
4. Collect the Channex side
Mr & Mrs Smith connections are one-to-one: one connection maps exactly one Channex property to one Mr & Mrs Smith hotel. Pick the property to connect, then fetch its room types and rate plans through the options endpoints:
5. Build the mapping structure
The mapping is a list of rate_plans entries, one per (Channex rate plan → Mr & Mrs Smith room/rate) pair:
rate_plan_id — the Channex rate plan UUID (from step 4).
settings — the mapping fields:
room_type_code
Room ID on the Mr & Mrs Smith side.
rate_plan_code
Rate ID on the Mr & Mrs Smith side.
pricing_type
The hotel's pricing model — copy it from the mapping details; always Standard for Mr & Mrs Smith.
primary_occ
When true, the mapping sends availability and restrictions along with prices; when false, prices only.
A full mapping for one Mr & Mrs Smith rate sold on two rooms:
6. Create the connection
The payload is wrapped in a channel key:
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 Mr & Mrs Smith.
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 Mr & Mrs Smith 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 Mr & Mrs Smith 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:
channelcannot 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 withsettings: nullis removed as well. Omitrate_plansentirely 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 Mr & Mrs Smith adapter declares no connection actions — actions is empty on the descriptor and on every Mr & Mrs Smith connection.
Mr & Mrs Smith settings reference
The full set of connection settings for Mr & Mrs Smith:
hotel_id
The Mr & Mrs Smith Hotel ID. Required.
email
The email address the notifications go to.
send_email_notifications
When true, Channex sends a notification about each booking.
max_stay_type
How the maximum 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: Gross Amount (including the Mr & Mrs Smith commission) or Net Amount (excluding it). Default Gross Amount.
Last updated