> 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/despegar.md).

# Despegar

This guide walks through creating a channel connection between Channex and Despegar 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 Despegar 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 Despegar 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 Despegar needs.
2. Collect the settings from the user and run a test connection.
3. Get the mapping details — the rooms and rates on the Despegar 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=Despegar
```

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

Response (abridged):

```json
{
  "data": {
    "code": "Despegar",
    "title": "Despegar",
    "kind": "meta",
    "actions": [],
    "params": {
      "partner_account": {
        "default": "channex",
        "position": 0,
        "type": "select",
        "options": ["channex", "pxsol"],
        "title": "Partner Account"
      },
      "hotel_id": {
        "position": 1,
        "type": "string",
        "title": "Hotel ID"
      },
      "user": {
        "position": 2,
        "type": "string",
        "title": "Username"
      },
      "password": {
        "position": 3,
        "type": "password",
        "title": "Password"
      },
      "min_stay_type": {
        "default": "Arrival",
        "position": 4,
        "type": "select",
        "options": ["Arrival", "Through"],
        "title": "Min Stay Type"
      },
      "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"
      },
      "booking_amount_settings": {
        "default": "Total Amount",
        "position": 7,
        "type": "select",
        "options": ["Hotel Payout", "Total Amount"],
        "title": "Booking Amount"
      }
    },
    "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" }
    }
  }
}
```

What to read from it:

* **`params`** — the connection settings to collect from the user. Each entry describes one field: `title` (English label), `type` (`string`, `password`, `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 Despegar, the settings to collect from the user are **`hotel_id`** — the Despegar Hotel ID — and the **`user`** and **`password`** credentials. Keep `partner_account` at its default `channex` unless you were told otherwise; 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": "Despegar",
  "settings": {
    "partner_account": "channex",
    "hotel_id": "5868189",
    "user": "username",
    "password": "password"
  }
}
```

`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 Despegar 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 Despegar side:

```
POST /api/v1/channels/mapping_details
```

The payload is the same as for the test connection:

```json
{
  "channel": "Despegar",
  "settings": {
    "partner_account": "channex",
    "hotel_id": "5868189",
    "user": "username",
    "password": "password"
  }
}
```

Response (abridged):

```json
{
  "data": {
    "pricing_type": "OBP",
    "rooms": [
      {
        "id": "111111",
        "title": "Los Darales",
        "max_children": 6,
        "rates": [
          {
            "id": "333333",
            "title": "Desayuno buffet",
            "charge_type": "per_person",
            "max_persons": 7,
            "occupancies": [1, 2, 3, 4, 5, 6, 7],
            "derived_rate_plan_ids": ["333334"]
          }
        ]
      },
      {
        "id": "222222",
        "title": "La Acarucaria",
        "max_children": 3,
        "rates": [
          {
            "id": "444444",
            "title": "Desayuno buffet",
            "charge_type": "per_person",
            "max_persons": 4,
            "occupancies": [1, 2, 3, 4]
          }
        ]
      }
    ]
  }
}
```

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

**`pricing_type`** — the hotel's pricing model, derived from how its rates are charged:

* `OBP` — occupancy-based pricing (rates charged `per_person`): each rate carries a price per occupancy option.
* `Standard` — per-room pricing (rates charged `per_room`): each rate carries one price per room.

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

| Field          | Description                                  |
| -------------- | -------------------------------------------- |
| `id`           | Room ID on the Despegar side.                |
| `title`        | Room title.                                  |
| `max_children` | Maximum number of children the room accepts. |
| `rates`        | Rates of the room.                           |

Each rate carries:

| Field                   | Description                                                                                                                   |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `id`                    | Rate ID on the Despegar side.                                                                                                 |
| `title`                 | Rate title.                                                                                                                   |
| `charge_type`           | How the rate is charged: `per_person` (price per occupancy, OBP) or `per_room` (one price per room, Standard).                |
| `max_persons`           | Maximum number of persons — the room's maximum occupancy for `per_person` rates, its standard occupancy for `per_room` rates. |
| `occupancies`           | Occupancy options of the rate on this room. Present for `per_person` rates only.                                              |
| `derived_rate_plan_ids` | IDs of the rates derived from this rate. Present only for rates that have derived rates.                                      |

Rooms that offer no rates are not listed.

Only parent rates are listed. Rates that Despegar 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

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

### 5. Build the mapping structure

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

```json
{
  "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
  "settings": {
    "room_type_code": "111111",
    "rate_plan_code": "333333",
    "occupancy": 2,
    "pricing_type": "OBP",
    "primary_occ": true
  }
}
```

**`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 Despegar side.                                                                                                                                                       |
| `rate_plan_code` | Rate ID on the Despegar side.                                                                                                                                                       |
| `occupancy`      | The occupancy option of the Despegar rate this mapping serves. Required for both pricing models — for `Standard` rates use the rate's `max_persons`.                                |
| `pricing_type`   | The hotel's pricing model — copy it from the mapping details (`OBP` or `Standard`).                                                                                                 |
| `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. |

Mark **exactly one mapping of each room + rate pair** as primary. For `OBP` hotels, create one mapping per occupancy option you want to sell; for `Standard` hotels, a room + rate pair has a single mapping.

A full mapping for one Despegar OBP rate sold at two occupancies:

```json
[
  {
    "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
    "settings": {
      "room_type_code": "111111",
      "rate_plan_code": "333333",
      "occupancy": 2,
      "pricing_type": "OBP",
      "primary_occ": true
    }
  },
  {
    "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d",
    "settings": {
      "room_type_code": "111111",
      "rate_plan_code": "333333",
      "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": "Despegar",
    "group_id": "60674dd6-1aeb-4c41-9e0c-8ffb378a4570",
    "title": "Despegar Channel",
    "properties": ["acb388d9-546b-42fc-9ae2-baf00e7f0d8c"],
    "settings": {
      "partner_account": "channex",
      "hotel_id": "5868189",
      "user": "username",
      "password": "password",
      "min_stay_type": "Arrival"
    },
    "rate_plans": [
      {
        "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
        "settings": {
          "room_type_code": "111111",
          "rate_plan_code": "333333",
          "occupancy": 2,
          "pricing_type": "OBP",
          "primary_occ": true
        }
      },
      {
        "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d",
        "settings": {
          "room_type_code": "111111",
          "rate_plan_code": "333333",
          "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 Despegar.                                              |
| `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": "Despegar Channel",
      "channel": "Despegar",
      "is_active": false,
      "actions": [],
      "properties": ["acb388d9-546b-42fc-9ae2-baf00e7f0d8c"],
      "settings": {
        "partner_account": "channex",
        "hotel_id": "5868189",
        "user": "username",
        "password": "password",
        "min_stay_type": "Arrival"
      },
      "rate_plans": [
        {
          "id": "9d7e45b3-367b-4286-a081-17a6c8d3c62e",
          "rate_plan_id": "a35f1fd4-63c6-4fbc-8fbe-359869bd9958",
          "settings": {
            "room_type_code": "111111",
            "rate_plan_code": "333333",
            "occupancy": 2,
            "pricing_type": "OBP",
            "primary_occ": true
          }
        },
        {
          "id": "0f6fe97e-ab8b-4f0b-a1cd-dc3500f18295",
          "rate_plan_id": "2a0c416b-d8e6-4950-b52e-e7821030fd9d",
          "settings": {
            "room_type_code": "111111",
            "rate_plan_code": "333333",
            "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 Despegar `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 Despegar 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 Despegar adapter declares no connection actions — `actions` is empty on the descriptor and on every Despegar connection.

### Despegar settings reference

The full set of connection `settings` for Despegar:

| Setting                    | Description                                                                                                                                                                           |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `partner_account`          | The partner account Channex connects to Despegar under: `channex` or `pxsol`. Default `channex`.                                                                                      |
| `hotel_id`                 | The Despegar Hotel ID. Required.                                                                                                                                                      |
| `user`                     | The Despegar username. Required.                                                                                                                                                      |
| `password`                 | The Despegar password. Required.                                                                                                                                                      |
| `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`.                        |
| `email`                    | The email address the notifications go to.                                                                                                                                            |
| `send_email_notifications` | When `true`, Channex sends a notification about each booking.                                                                                                                         |
| `booking_amount_settings`  | Which amount is recorded as the booking total: `Total Amount` (the full amount the guest pays) or `Hotel Payout` (the amount Despegar pays out to the hotel). Default `Total Amount`. |
