### Success Response for Installing an Application

Source: https://docs.channex.io/api-v.1-documentation/applications-api

Example of a successful response after installing an application. It confirms the installation with details like the new installation ID, property ID, and application code.

```json
{
    "data": {
        "attributes": {
            "id": "7db569e1-3fb3-49a7-884b-690140827c50",
            "settings": {},
            "property_id": "18535b75-26a0-4716-ae99-0578006639c5",
            "is_active": true,
            "application_id": "0dbb54b2-1321-43dd-9fe9-30d54e19ff33",
            "application_code": "channex_messages"
        },
        "id": "7db569e1-3fb3-49a7-884b-690140827c50",
        "type": "application_installation",
        "relationships": {
            "rate_plans": {
                "data": []
            }
        }
    }
}
```

--------------------------------

### Success Response for Listing Installed Applications

Source: https://docs.channex.io/api-v.1-documentation/applications-api

Example of a successful response when listing installed applications for a property. It includes installation details like settings, property ID, and application ID.

```json
{
    "data": [
        {
            "attributes": {
                "id": "12ca008c-95e9-4668-942a-d255b618c00e",
                "settings": null,
                "property_id": "c19a05af-8c8c-4754-8c8a-8132845d4cac",
                "application_id": "8587fbf6-a6d1-46f8-8c12-074273284917",
                "application_code": "channex_messages"
            },
            "id": "12ca008c-95e9-4668-942a-d255b618c00e",
            "type": "application_installation"
        }
    ]
}
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.channex.io/application-documentation/api-key-access

To get information not explicitly on the page, make an HTTP GET request with an 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.channex.io/application-documentation/api-key-access.md?ask=<question>
```

--------------------------------

### API Key Authentication Example

Source: https://docs.channex.io/api-v.1-documentation/api-reference

Example of how to authenticate a GET request using an API key. The API key should be included in the `user-api-key` header.

```APIDOC
## API Key Access

Authentication method, where previously generated API Key is used to sign requests:

```
GET https://staging.channex.io/api/v1/properties/ HTTP/1.1
Host: staging.channex.io
Content-Type: application/json
user-api-key: uU08XiMgk8a7CrY4xUjAReUIuTrn83R123adaVb8Tf/qMcVTEgriuJhXWs/1Q1P
```

Please, read this [article](/application-documentation/api-key-access.md) to get more information.
```

--------------------------------

### Install Application

Source: https://docs.channex.io/api-v.1-documentation/applications-api

Install a specified application for a given property. Use `application_code` for installation.

```APIDOC
## POST /api/v1/applications/install

### Description
Method to add Application into Property.

### Method
POST

### Endpoint
/api/v1/applications/install

### Parameters
#### Request Body
- **application_installation** (object) - Required - Details for the application installation.
  - **property_id** (string) - Required - The ID of the property to install the application for.
  - **application_code** (string) - Required - The code of the application to install.

### Request Example
```json
{
    "application_installation": {
        "property_id": "18535b75-26a0-4716-ae99-0578006639c5",
        "application_code": "channex_messages"
    }
}
```

### Response
#### Success Response (200)
- **data** (object) - Details of the newly installed application.
  - **attributes** (object) - Installation attributes.
    - **id** (string) - Unique identifier for the installation.
    - **settings** (object) - Configuration settings for the installed application.
    - **property_id** (string) - Identifier of the property where the application is installed.
    - **is_active** (boolean) - Indicates if the application is currently active.
    - **application_id** (string) - Identifier of the installed application.
    - **application_code** (string) - Code of the installed application.
  - **id** (string) - Unique identifier for the installation entry.
  - **type** (string) - Type of the resource, always "application_installation".
  - **relationships** (object) - Relationships of the installation.
    - **rate_plans** (object) - Associated rate plans.
      - **data** (array) - List of rate plans (can be empty).

### Response Example
```json
{
    "data": {
        "attributes": {
            "id": "7db569e1-3fb3-49a7-884b-690140827c50",
            "settings": {},
            "property_id": "18535b75-26a0-4716-ae99-0578006639c5",
            "is_active": true,
            "application_id": "0dbb54b2-1321-43dd-9fe9-30d54e19ff33",
            "application_code": "channex_messages"
        },
        "id": "7db569e1-3fb3-49a7-884b-690140827c50",
        "type": "application_installation",
        "relationships": {
            "rate_plans": {
                "data": []
            }
        }
    }
}
```
#### Error Response (401)
- **errors** (object) - Error details.
  - **code** (string) - Error code, e.g., "unauthorized".
  - **title** (string) - Error title, e.g., "Unauthorized".
```

--------------------------------

### POST Request to Install an Application

Source: https://docs.channex.io/api-v.1-documentation/applications-api

Install a new application for a property. Use `application_code` for installation, which is recommended over `application_id` for stability.

```json
POST /api/v1/applications/install

{
    "application_installation": {
        "property_id": "18535b75-26a0-4716-ae99-0578006639c5",
        "application_code": "channex_messages"
    }
}
```

--------------------------------

### Install Payment Application

Source: https://docs.channex.io/api-v.1-documentation/payment-application-api

Send a POST request to install the Payment Application for a specific property. The response includes the installation ID.

```json
POST /api/v1/applications

Payload:
{
    "application_installation": {
        "property_id": "{{PROPERTY_ID}}",
        "application_code": "channex_payments"
    }
}

Response:
{
    "data": [
        {
            "attributes": {
                "id": "12ca008c-95e9-4668-942a-d255b618c00e",
                "settings": null,
                "property_id": "c19a05af-8c8c-4754-8c8a-8132845d4cac",
                "application_id": "8587fbf6-a6d1-46f8-8c12-074273284917",
                "application_code": "channex_messages"
            },
            "id": "12ca008c-95e9-4668-942a-d255b618c00e", <-- INSTALLATION ID
            "type": "application_installation"
        }
    ]
}
```

--------------------------------

### Install the Payment Application

Source: https://docs.channex.io/api-v.1-documentation/payment-application-api

Installs the Payment Application for a given property by specifying the property ID and application code.

```APIDOC
## POST /api/v1/applications

### Description
Installs the Payment Application for a property.

### Method
POST

### Endpoint
/api/v1/applications

### Parameters
#### Request Body
- **application_installation** (object) - Required - Contains installation details.
  - **property_id** (string) - Required - The ID of the property.
  - **application_code** (string) - Required - The code for the application to install (e.g., "channex_payments").

### Request Example
```json
{
    "application_installation": {
        "property_id": "{{PROPERTY_ID}}",
        "application_code": "channex_payments"
    }
}
```

### Response
#### Success Response (200)
- **data** (array) - Contains the installation details.
  - **id** (string) - The installation ID.
  - **type** (string) - The resource type.
  - **attributes** (object) - Attributes of the installation.
    - **id** (string) - The installation ID.
    - **settings** (object) - Null or configuration settings.
    - **property_id** (string) - The ID of the property.
    - **application_id** (string) - The ID of the application.
    - **application_code** (string) - The code of the installed application.

### Response Example
```json
{
    "data": [
        {
            "attributes": {
                "id": "12ca008c-95e9-4668-942a-d255b618c00e",
                "settings": null,
                "property_id": "c19a05af-8c8c-4754-8c8a-8132845d4cac",
                "application_id": "8587fbf6-a6d1-46f8-8c12-074273284917",
                "application_code": "channex_messages"
            },
            "id": "12ca008c-95e9-4668-942a-d255b618c00e",
            "type": "application_installation"
        }
    ]
}
```
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.channex.io/application-documentation/rooms-management

Perform an HTTP GET request on a documentation URL with the 'ask' query parameter to get dynamic answers. The question should be specific and in natural language.

```http
GET https://docs.channex.io/application-documentation/rooms-management.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.channex.io/channel-mapping-guides/feratel

To get additional information not explicitly present on the page, perform an HTTP GET request with the 'ask' query parameter. The response will contain direct answers and relevant excerpts.

```http
GET https://docs.channex.io/channel-mapping-guides/feratel.md?ask=<question>
```

--------------------------------

### Get List of Installed Applications

Source: https://docs.channex.io/api-v.1-documentation/applications-api

Retrieve a list of applications that have been installed for the current property.

```APIDOC
## GET /api/v1/applications/installed

### Description
Retrieve list of installed Applications.

### Method
GET

### Endpoint
/api/v1/applications/installed

### Response
#### Success Response (200)
- **data** (array) - List of installed applications.
  - **attributes** (object) - Installation details.
    - **id** (string) - Unique identifier for the installation.
    - **settings** (object) - Configuration settings for the installed application (can be null).
    - **property_id** (string) - Identifier of the property where the application is installed.
    - **application_id** (string) - Identifier of the application that is installed.
    - **application_code** (string) - Code of the installed application.
  - **id** (string) - Unique identifier for the installation entry.
  - **type** (string) - Type of the resource, always "application_installation".

### Response Example
```json
{
    "data": [
        {
            "attributes": {
                "id": "12ca008c-95e9-4668-942a-d255b618c00e",
                "settings": null,
                "property_id": "c19a05af-8c8c-4754-8c8a-8132845d4cac",
                "application_id": "8587fbf6-a6d1-46f8-8c12-074273284917",
                "application_code": "channex_messages"
            },
            "id": "12ca008c-95e9-4668-942a-d255b618c00e",
            "type": "application_installation"
        }
    ]
}
```
#### Error Response (401)
- **errors** (object) - Error details.
  - **code** (string) - Error code, e.g., "unauthorized".
  - **title** (string) - Error title, e.g., "Unauthorized".
```

--------------------------------

### GET Request to List Installed Applications

Source: https://docs.channex.io/api-v.1-documentation/applications-api

Retrieve a list of applications that have been installed for a specific property. This endpoint helps in managing active integrations.

```http
GET /api/v1/applications/installed
```

--------------------------------

### Create Per Person Manual Rate Plan

Source: https://docs.channex.io/api-v.1-documentation/rate-plans-collection

This example shows how to configure a rate plan for per-person selling with manual rate adjustments. It includes options for different occupancy levels.

```json
{
  "rate_plan": {
    "title": "Best Available Rate",
    "property_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
    "room_type_id": "994d1375-dbbd-4072-8724-b2ab32ce781b",
    "parent_rate_plan_id": null,
    "children_fee": "0.00",
    "infant_fee": "0.00",
    "max_stay": [0, 0, 0, 0, 0, 0, 0],
    "min_stay_arrival": [1, 1, 1, 1, 1, 1, 1],
    "min_stay_through": [1, 1, 1, 1, 1, 1, 1],
    "closed_to_arrival": [false, false, false, false, false, false, false],
    "closed_to_departure": [false, false, false, false, false, false, false],
    "stop_sell": [false, false, false, false, false, false, false],
    "options": [
      {
        "occupancy": 1,
        "is_primary": false,
        "rate": 0
      },
      {
        "occupancy": 2,
        "is_primary": false,
        "rate": 0
      },
      {
        "occupancy": 3,
        "is_primary": true,
        "rate": 0
      }
    ],
    "currency": "GBP",
    "sell_mode": "per_person",
    "rate_mode": "manual",
    "inherit_rate": false,
    "inherit_closed_to_arrival": false,
    "inherit_closed_to_departure": false,
    "inherit_stop_sell": false,
    "inherit_min_stay_arrival": false,
    "inherit_min_stay_through": false,
    "inherit_max_stay": false,
    "inherit_max_sell": false,
    "inherit_max_availability": false,
    "inherit_availability_offset": false,
    "auto_rate_settings": null
  }
}
```

--------------------------------

### API Key Authentication Example

Source: https://docs.channex.io/api-v.1-documentation/api-reference

Example of an HTTP GET request using API key authentication. The API key is provided in the 'user-api-key' header.

```http
GET https://staging.channex.io/api/v1/properties/ HTTP/1.1
Host: staging.channex.io
Content-Type: application/json
user-api-key: uU08XiMgk8a7CrY4xUjAReUIuTrn83R123adaVb8Tf/qMcVTEgriuJhXWs/1Q1P
```

--------------------------------

### Example Original Booking Link

Source: https://docs.channex.io/google/google-hotel-ads

This is an example of a standard booking link before applying Channex variables for dynamic content.

```text
https://bookingengine.com/Hotel1?Checkin=2021-06-01&nights=2
```

--------------------------------

### Get list of connected Providers

Source: https://docs.channex.io/api-v.1-documentation/payment-application-api

Retrieves a list of connected payment providers for a specific application installation, with pagination support.

```APIDOC
## POST /api/v1/applications/payment_app/{{installation_id}}/providers

### Description
Retrieves a list of connected payment providers for a given application installation.

### Method
POST

### Endpoint
/api/v1/applications/payment_app/{{installation_id}}/providers

### Parameters
#### Path Parameters
- **installation_id** (string) - Required - The ID of the application installation.

#### Request Body
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of items per page. Defaults to 10.

### Request Example
```json
{
  "page": 1,
  "limit": 10
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of connected payment providers.
  - **id** (string) - The unique identifier for the payment provider entry.
  - **type** (string) - The resource type (e.g., "payment_provider").
  - **attributes** (object) - Attributes of the payment provider.
    - **id** (string) - The unique identifier for the payment provider.
    - **title** (string) - The title of the payment provider.
    - **provider** (string) - The name of the payment provider (e.g., "stripe").
    - **is_active** (string) - The currency code if active (e.g., "USD").
    - **is_default** (boolean) - Indicates if this is the default provider.
    - **details** (object) - Specific details about the provider connection.
      - **account_id** (string) - The account ID of the connected provider.

### Response Example
```json
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "payment_provider",
      "attributes": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "title": "string",
        "provider": "stripe",
        "is_active": "USD",
        "is_default": true,
        "details": {
          "account_id": "xyz123"
        }
      }
    }
  ]
}
```
```

--------------------------------

### GET Request to List Applications

Source: https://docs.channex.io/api-v.1-documentation/applications-api

Use this endpoint to retrieve a list of all available applications on the Channex.io platform. This includes applications that can be installed for a property.

```http
GET /api/v1/applications
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.channex.io/api-v.1-documentation/groups-collection

Perform an HTTP GET request with the 'ask' query parameter to dynamically query the documentation for additional information.

```http
GET https://docs.channex.io/api-v.1-documentation/groups-collection.md?ask=<question>
```

--------------------------------

### Success Response for Get Booking Revision

Source: https://docs.channex.io/api-v.1-documentation/bookings-collection

Example of a successful response when retrieving a booking revision. It includes comprehensive details about the booking revision.

```javascript
{
  "data": {
    "type": "booking_revision",
    "id": "03dd7198-c5b7-493c-a889-74d0c2211de7",
    "attributes": {
      "id": "03dd7198-c5b7-493c-a889-74d0c2211de7",
      "property_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
      "booking_id": "cfa33f3b-bd32-4b90-8ef9-bde2bfe986cd",
      "unique_id": "BDC-9996013801",
      "system_id": "12331233123",
      "ota_reservation_code": "9996013801",
      "ota_name": "Booking.com",
      "status": "new",
      "rooms": [
        {
          "amount": "200.00",
          "checkin_date": "2019-04-26",
          "checkout_date": "2019-04-27",
          "rate_plan_id": "445835fb-7956-42ac-9efc-3e6f331f0808",
          "room_type_id": "994d1375-dbbd-4072-8724-b2ab32ce781b",
          "ota_unique_id": "49",
          "days": {
            "2019-04-26": "200.00"
          },
          "occupancy": {
            "adults": 2,
            "children": 0,
            "infants": 0
          }
        }
      ],
      "services": [
        {
          "type": "Breakfast",
          "total_price": "20.00",
          "price_per_unit": "10.00",
          "price_mode": "Per person per night",
          "persons": 2,
          "nights": 1,
          "name": "Breakfast"
        }
      ],
      "guarantee": {
        "expiration_date": "10/2020",
        "cvv": "***",
        "cardholder_name": "Channex User",
        "card_type": "visa",
        "card_number": "411111******1111"
      },
      "customer": {
        "zip": "2031 BE",
        "surname": "Channex",
        "phone": "1234567890",
        "name": "User",
        "mail": "user@channex.io",
        "language": "en",
        "country": "NL",
        "city": "Haarlem",
        "address": "JW Lucasweg 35",
        "company": {
          "title": "Company Name",
          "number": "1123331",
          "number_type": "VAT",
          "type": "Registration Number"
        }
      },
      "occupancy": {
        "adults": 2,
        "children": 0,
        "infants": 0
      },
      "arrival_date": "2019-04-26",
      "departure_date": "2019-04-27",
      "arrival_hour": "10:00",
      "amount": "220.00",
      "ota_commission": "10.00",
      "currency": "GBP",
      "notes": "You have a booker that would like free parking. (based on availability)\nYou have a booker that would prefer a quiet room. (based on availability)",
      "inserted_at": "2019-04-23T10:03:29.335485"
    }
  }
}
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.channex.io/api-v.1-documentation/api-reference

Perform an HTTP GET request with an 'ask' query parameter to dynamically query the documentation.

```http
GET https://docs.channex.io/api-v.1-documentation/api-reference.md?ask=<question>
```

--------------------------------

### Get Reviews List Success Response

Source: https://docs.channex.io/api-v.1-documentation/reviews-collection

Example of a successful response when fetching a list of reviews. It includes review details, scores, and metadata.

```javascript
{
  "data": [
    {
      "attributes": {
        "content": "Guest review test",
        "guest_name": "Guest Name",
        "id": "5d9aa0d9-a888-46b5-bde8-13cc7a15161c",
        "inserted_at": "2022-06-06T05:00:41.020781",
        "is_hidden": false,
        "is_replied": false,
        "ota": "BookingCom",
        "ota_reservation_id": "2328423042",
        "overall_score": 10.0,
        "received_at": "2022-06-06T05:45:23.000000",
        "reply": null,
        "scores": [
          {
            "category": "clean",
            "score": 10
          },
          {
            "category": "comfort",
            "score": 7.5
          },
          {
            "category": "facilities",
            "score": 10
          },
          {
            "category": "location",
            "score": 10
          },
          {
            "category": "staff",
            "score": 10
          },
          {
            "category": "value",
            "score": 7.5
          }
        ],
        "tags": [],
        "updated_at": "2022-06-06T05:00:41.020781"
      },
      "id": "5d9aa0d9-a888-46b5-bde8-13cc7a15161c",
      "relationships": {
        "booking": {
          "data": {
            "id": "203f359b-08d6-4e5c-b64c-1aa67cfb775d",
            "type": "booking"
          }
        },
        "channel": {
          "data": {
            "id": "9d571186-b4d0-4792-84b7-af04ab1e28e1",
            "type": "channel"
          }
        },
        "property": {
          "data": {
            "id": "2b4832de-ad00-489b-8acc-b5051ea86d94",
            "type": "property"
          }
        }
      },
      "type": "review"
    }
  ],
  "meta": {
      "limit": 10,
      "order_by": "received_at",
      "order_direction": "desc",
      "page": 1,
      "total": 1
  }
}
```

--------------------------------

### Success Response for Get Property by ID

Source: https://docs.channex.io/api-v.1-documentation/hotels-collection

This is an example of a successful response when retrieving a property by its ID. It includes detailed attributes and relationships of the property.

```javascript
{
  "data": {
    "type": "property",
    "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
    "attributes": {
      "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
      "title": "Demo Hotel",
      "is_active": true,
      "email": "hotel@channex.io",
      "phone": "01267237037",
      "currency": "GBP",
      "country": "GB",
      "state": "Demo State",
      "city": "Demo Town",
      "address": "Demo Street",
      "zip_code": "SA23 2JH",
      "latitude": null,
      "longitude": null,
      "timezone": "Europe/London",
      "property_type": "hotel",
      "content": {
        "description": "Some Property Description Text",
        "photos": [{
          "author": "Author Name",
          "description": "Room View",
          "id": "4355439c-df23-4f12-bffd-26476e31dd4a",
          "kind": "photo",
          "position": 0,
          "property_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
          "room_type_id": null,
          "url": "https://img.channex.io/af08bc1d-8074-476c-bdb7-cec931edaf6a/"
        }],
        "important_information": null
      },
      "settings": {
        "allow_availability_autoupdate_on_confirmation": true,
        "allow_availability_autoupdate_on_modification": true,
        "allow_availability_autoupdate_on_cancellation": true,
        "min_stay_type": "both",
        "max_price": null,
        "min_price": null,
        "max_day_advance": null
      },
      "logo_url": null,
      "acc_channels_count": 0
    },
    "relationships": {
      "groups": {
        "data": [
          {
            "id": "f5338935-7fe0-40eb-9d7e-4dbf7ecc52c7",
            "type": "group",
            "attributes": {
              "id": "f5338935-7fe0-40eb-9d7e-4dbf7ecc52c7",
              "title": "User Group"
            }
          }
        ]
      },
      "facilities": {
          "data": []
      }
    }
  }
}
```

--------------------------------

### New Booking Example for Booking.com

Source: https://docs.channex.io/api-v.1-documentation/bookings-collection

This snippet demonstrates the JSON payload structure for creating a new booking via the Booking.com channel. It includes comprehensive details about the guest, room, dates, and pricing.

```javascript
{
  "data": {
    "attributes": {
      "amount": "153.00",
      "ota_commission": "10.00",
      "arrival_date": "2020-11-13",
      "arrival_hour": null,
      "currency": "GBP",
      "customer": {
        "address": null,
        "city": ".",
        "company": null,
        "country": "GB",
        "language": null,
        "mail": "customer_email@guest.booking.com",
        "meta": {
          "is_genius": false
        },
        "name": "Name",
        "phone": "Custom Phone",
        "surname": "Surname",
        "zip": null
      },
      "departure_date": "2020-11-15",
      "guarantee": {
        "card_number": "411111******1111",
        "card_type": "VI",
        "cardholder_name": "CARDHOLDER NAME",
        "cvv": "***",
        "expiration_date": "11/2021",
        "is_virtual": false
      },
      "id": "3e029821-d446-45e9-8394-42d78a3aa1b1",
      "inserted_at": "2020-11-12T11:39:50.111087",
      "notes": null,
      "occupancy": {
        "adults": 2,
        "children": 0,
        "infants": 0
      },
      "ota_name": "BookingCom",
      "ota_reservation_code": "3333333333",
      "payment_collect": null,
      "payment_type": null,
      "property_id": "57b92389-1878-4772-9f0d-47e31d22609f",
      "revision_id": "2399140e-4673-427a-bb40-0074d917d21f",
      "rooms": [
        {
          "amount": "153.00",
          "booking_room_id": "d0f5a93b-12ba-40b5-a134-48bbf1c77532",
          "checkin_date": "2020-11-13",
          "checkout_date": "2020-11-15",
          "ota_unique_id": "49",
          "days": {
            "2020-11-13": "76.50",
            "2020-11-14": "76.50"
          },
          "guests": [
            {
              "name": "Guest Name",
              "surname": "Guest Surname"
            }
          ],
          "meta": {
            "additional_details": [],
            "booking_com_room_index": 875,
            "cancel_penalties": [
              {
                "amount": "0.00",
                "currency": "GBP",
                "from": "2020-11-09T17:32:51"
              },
              {
                "amount": "76.50",
                "currency": "GBP",
                "from": "2020-11-12T00:00:00"
              }
            ],
            "days_breakdown": [
              {
                "amount": "76.50",
                "date": "2020-11-13",
                "promotion": {
                  "id": "71591484",
                  "title": "genius rate"
                },
                "rate_code": 117855,
                "rate_plan": "785360cd-6ddb-430b-b31e-be3a2e9662a1"
              },
              {
                "amount": "76.50",
                "date": "2020-11-14",
                "promotion": {
                  "id": "71591484",
                  "title": "genius rate"
                },
                "rate_code": 117855,
                "rate_plan": "785360cd-6ddb-430b-b31e-be3a2e9662a1"
              }
            ],
            "meal_plan": "Breakfast is included in the room rate.",
            "policies": "Children and Extra Bed Policy: All children are welcome. All children under 3 years stay free of charge when using existing beds. All children from 3 to 18 years are charged  GBP 10 per night when using existing beds. There is no capacity for extra beds in the room. The maximum number of total guests in a room is 2. There is no capacity for cots in the room.  Deposit Policy: No prepayment is needed.  Cancellation Policy: The guest can cancel free of charge until 1 day before arrival. The guest will be charged the cost of the first night if they cancel within 1 day before arrival.",
            "promotion": [
              {
                "from_code": "0",
                "from_name": "genius rate",
                "promotion_id": "71591484",
                "to_code": "117855"
              }
            ],
            "rate_plan_code": 117855,
            "room_remarks": [],
            "room_type_code": "3636404",
            "smoking_preferences": null
          },
          "occupancy": {
            "adults": 2,
            "children": 0,
            "infants": 0
          },
          "rate_plan_id": "785360cd-6ddb-430b-b31e-be3a2e9662a1",
          "room_type_id": "e2a15383-7843-4240-adda-736608d72eca",
          "services": [],
          "taxes": [
            {
              "is_inclusive": true,
              "name": "VAT (5%)",
              "nights": 2,
              "persons": 2,
              "price_mode": "Per booking",
              "price_per_unit": "7.29",
              "total_price": "7.29",
              "type": "Value Added Tax (VAT)"
            }
          ]
        }
      ],
      "services": [],
      "status": "new",
      "unique_id": "BDC-3333333333"
    },
    "id": "3e029821-d446-45e9-8394-42d78a3aa1b1",
    "type": "booking"
  }
}
```

--------------------------------

### Get List of Connected Payment Providers

Source: https://docs.channex.io/api-v.1-documentation/payment-application-api

Retrieve a list of connected payment providers for a given installation ID. This API call paginates the results.

```json
POST /api/v1/applications/payment_app/{{installation_id}}/providers

Payload:
{
  "page": 1,
  "limit": 10
}

Response:
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "payment_provider",
      "attributes": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "title": "string",
        "provider": "stripe",
        "is_active": "USD",
        "is_default": true,
        "details": {
          "account_id": "xyz123"
        }
      }
    }
  ]
}
```

--------------------------------

### GET Property Users List Success Response

Source: https://docs.channex.io/api-v.1-documentation/property-users-collection

Example of a successful response when retrieving a list of property users. Includes user and property relationship details.

```javascript
{
  "data": [
    {
      "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
      "type": "property_user"
      "attributes": {
        "id": "776533f2-c10e-49d8-bddc-14b3e27c2a00",
        "overrides": null,
        "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
        "role": "owner",
        "user_id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184"
      },
      "relationships": {
        "property": {
          "data": {
            "id": "52397a6e-c330-44f4-a293-47042d3a3607",
            "type": "property"
          }
        },
        "user": {
          "data": {
            "id": "c9cfa184-5095-4ef2-bbe2-e723ffb49184",
            "type": "user",
            "email": "user@channex.io",
            "name": "Channex User"
          }
        }
      }
    }
  ]
}
```

--------------------------------

### Booking Room Price Breakdown Example

Source: https://docs.channex.io/api-v.1-documentation/bookings-collection

Shows the structure for a price breakdown per day for a booking room, mapping dates to amounts.

```javascript
"days": {
  "2019-05-09": "100.00"
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.channex.io/channel-mapping-guides/klook

Use this GET request to query the documentation with a specific question. The response will contain a direct answer and relevant excerpts from the documentation.

```http
GET https://docs.channex.io/channel-mapping-guides/klook.md?ask=<question>
```

--------------------------------

### Success Response Example for Get Photo by ID

Source: https://docs.channex.io/api-v.1-documentation/photos-collection

This is the expected response when successfully retrieving a single photo by its ID. It contains the photo's attributes and its unique identifier.

```json
{
  "data": {
    "attributes": {
      "author": null,
      "description": null,
      "id": "ae75d43e-21c5-46b6-a593-5046791f7841",
      "kind": "ad",
      "position": 0,
      "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
      "room_type_id": null,
      "url": "https://img.channex.io/312fa6cb-8151-409b-b612-773e271a76df/"
    },
    "id": "ae75d43e-21c5-46b6-a593-5046791f7841",
    "type": "photo"
  }
}
```

--------------------------------

### API Key Usage Example

Source: https://docs.channex.io/application-documentation/api-key-access

Pass the API key as a 'user-api-key' header in your GET requests to authenticate with the Channex API. Ensure the host and content type are correctly set.

```http
GET /api/v1/properties/ HTTP/1.1
Host: staging.channex.io
Content-Type: application/json
user-api-key: uU08XiMgk8a7CrY4xUjAReUIuTrn83R123adaVb8Tf/qMcVTEgriuJhXWs/1Q1P
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.channex.io/application-documentation/overview

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to get specific answers and relevant excerpts from the documentation. Use this when information is not explicitly present or for clarification.

```http
GET https://docs.channex.io/application-documentation/overview.md?ask=<question>
```

--------------------------------

### GET Room Types Options Success Response

Source: https://docs.channex.io/api-v.1-documentation/room-types-collection

Example of a successful response when retrieving room type options. Includes essential attributes like ID, property ID, and title.

```javascript
{
  "data": [
    {
      "attributes": {
        "default_occupancy": 2,
        "id": "994d1375-dbbd-4072-8724-b2ab32ce781b",
        "property_id": "2941337f-50d6-4189-ae13-f76efaf9c515",
        "title": "Standard Room"
      },
      "id": "994d1375-dbbd-4072-8724-b2ab32ce781b",
      "type": "room_type"
    }
  ]
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.channex.io/application-documentation/property-tasks

Use this method to dynamically query the documentation. Perform an HTTP GET request on the current page URL with the `ask` query parameter followed by your question.

```http
GET https://docs.channex.io/application-documentation/property-tasks.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.channex.io/api-v.1-documentation/ari

Demonstrates how to dynamically query the documentation by making an HTTP GET request to the current page URL with an 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.channex.io/api-v.1-documentation/ari.md?ask=<question>
```

--------------------------------

### GET Room Types List Success Response

Source: https://docs.channex.io/api-v.1-documentation/room-types-collection

Example of a successful response when retrieving a list of room types. Includes data, meta information for pagination, and details of a room type.

```javascript
{
  "data": [
    {
      "type": "room_type",
      "id": "994d1375-dbbd-4072-8724-b2ab32ce781b",
      "attributes": {
        "id": "994d1375-dbbd-4072-8724-b2ab32ce781b",
        "title": "Standard Room",
        "occ_adults": 3,
        "occ_children": 0,
        "occ_infants": 0,
        "default_occupancy": 2,
        "count_of_rooms": 20,
        "room_kind": "room",
        "capacity": null,
        "content": {
          "description": "Some Room Type Description Text",
          "photos": [
            {
              "author": "Author Name",
              "description": "Room View",
              "id": "198a19d4-42c0-48d8-a55c-c7836b2c1f7e",
              "kind": "photo",
              "position": 0,
              "property_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
              "room_type_id": "994d1375-dbbd-4072-8724-b2ab32ce781b",
              "url": "https://img.channex.io/af08bc1d-8074-476c-bdb7-cec931edaf6a/"
            }
          ]
        }
      },
      "relationships": {
        "facilities": {
          "data": []
        },
        "property": {
          "data": {
            "type": "property",
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920"
          }
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "total": 1,
    "limit": 10
  }
}
```