Room Types Collection

API methods to work with Room Types

Room Type represents an accommodation inventory at your property. A villa, room or bed at a hostel dormitory can be a Room Type.

If your property uses rooms instead of the traditional room type then just create a room type for each room. If you have vacation rentals you need to make a room type for the property since creating a property alone is not enough.

Room Types List

Retrieve a list of Room Types associated with user Properties.

Request:

GET https://staging.channex.io/api/v1/room_types

Pagination

By default, this method returns the first 10 elements. To get more details, you should use Pagination arguments. Information about count of entities and current pagination position contained at meta section at response object.

Filter

You can use a filter to retrieve Room Types for a specific property:

GET https://staging.channex.io/api/v1/room_types?filter[property_id]=PROPERTY_ID

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a list of Room Type objects in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API key provided.

Room Type Options

Method to get a list of all room types associated with current account without additional details and pagination limits.

Request:

GET https://staging.channex.io/api/v1/room_types/options

Get Room Type by ID

Retrieve specific Room Types by ID.

Request:

GET https://staging.channex.io/api/v1/room_types/:id

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Room Type object in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided or User not have access to requested Room Type.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Room Type with provided ID is not present at system.

Create Room Type

Create a new Room Type.

Availability of all rooms created will be defaulted to 0, to set availability you will need to use the Availability and Rates API

Request:

POST https://staging.channex.io/api/v1/room_types

Query body (JSON):

{
  "room_type": {
    "property_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
    "title": "Standard Room",
    "count_of_rooms": 20,
    "occ_adults": 3,
    "occ_children": 0,
    "occ_infants": 0,
    "default_occupancy": 2,
    "facilities": [],
    "room_kind": "room",
    "capacity": null,
    "content": {
      "description": "Some Room Type Description Text",
      "photos": [
        {
          "author": "Author Name",
          "description": "Room View",
          "kind": "photo",
          "position": 0,
          "url": "https://img.channex.io/af08bc1d-8074-476c-bdb7-cec931edaf6a/"
        }
      ]
    }
  }
}

Fields

property_id [required]

String with a valid UUID of the Property to associate with the created Room Type.

title [required]

Any non-empty string with maximum length of 255 symbols. Note: The Room Type will be represented in the system under that title.

count_of_rooms [required]

Any positive integer number. Note: This field affects billing if the property is a Vacation Rental. It is the amount of Units to sell of this type.

occ_adults [required]

Any positive integer number. Note: How many Adult bed spaces have in this Room Type.

occ_children [required]

Any positive integer number. Note: How many Child only bed spaces in this Room Type. Children can sleep in adult beds also. If no Child only beds then set this to 0.

occ_infants [required]

Any positive integer number. Note: How many Infants cots available in this Room Type.

default_occupancy [required]

Any positive integer number lower or equal to occ_adults. Note: How many guests can stay in the room by default (without extra spaces). Keep in mind, this field can not be greater than occ_adults value. Typically this value is set equal to amount of adults.

facilities [optional]

List of Room Type Facility IDs associated with Property.

room_kind [optional]

String. Type of Room. Enumerable. Possible values: room, dorm.

capacity [optional]

Integer. Count of beds at one physical room. Applicable only for Room Type with kind equal to dorm.

content [optional]

Object with content information for property. Content object can contain: description - optional text field with Property description. By default Description will be equal to null. photos - optional list of photos associated with Property. Each photo is object with next fields: url - photo URL position - integer value to represent photo position at list, Photo with position equal to 0 is used as Cover Photo for Room Type description - Photo text description author - Name of photo Author kind - one of three possible values: photo, ad (advertising), menu (restaurant menu photo). More information about Photo API is here.

Returns

Success Method can return a Success result with 201 Created HTTP Code if operation is successful. Will contain a Room Type object in the answer.

Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided.

Validation Error Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.

Update Room Type

Update a Room Type.

Request:

PUT https://staging.channex.io/api/v1/room_types/:id

Example:

PUT https://staging.channex.io/api/v1/room_types/af08bc1d-8074-476c-bdb7-cec931edaf6a

Query body (JSON):

{
  "room_type": {
    "title": "Standard Room",
    "count_of_rooms": 20,
    "occ_adults": 3,
    "occ_children": 0,
    "occ_infants": 0,
    "default_occupancy": 2,
    "facilities": [],
    "content": {
      "description": "Some Room Type Description Text",
      "photos": [
        {
          "author": "Author Name",
          "description": "Room View",
          "kind": "photo",
          "position": 0,
          "url": "https://img.channex.io/af08bc1d-8074-476c-bdb7-cec931edaf6a/"
        }
      ]
    }
  }
}

Fields

This method use same fields as Create Room Type method.

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Room Type object in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Room Type with provided ID is not present at system.

Validation Error Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.

Decrease occupancy options and connected channels

Sometimes you can have necessity to decrease occupancy options for adults (example: change Adults occupancy from 3 to 2). In that case, if removed occupancy option is mapped to Channel, Channex will return Validation Error. This behaviour allow us to prevent any mistakes from client side. But, in case if you understand what you would like to do, you can trigger update operation with force flag:

PUT /api/v1/room_types/:id?force=true

In that case, Channex will remove occupancy option and all associated mappings from Channels.

Remove Room Type

Remove a Room Type.

Request:

DELETE https://staging.channex.io/api/v1/room_types/:id

Example:

DELETE https://staging.channex.io/api/v1/room_types/af08bc1d-8074-476c-bdb7-cec931edaf6a

Flags

Because the system does not allow to remove room types associated with a channel, we expose an additional feature flag - force. To remove RoomType and un-map it from a channel.

Request:

DELETE https://staging.channex.io/api/v1/room_types/:id?force=true

Example:

DELETE https://staging.channex.io/api/v1/room_types/af08bc1d-8074-476c-bdb7-cec931edaf6a?force=true

Please, be careful with this method, once a room type is removed we can't restore it and any channel mapping information.

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Meta object with message in the answer.

Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong Bearer Token provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Room Type with provided ID is not present at system.

PreviousGroup Users CollectionNextRate Plans Collection

Last updated

Was this helpful?