Overview

Introduction Changelog Requirements Libraries Authorization Testing the Authorization Enumerables

Endpoints

Accounts Amenities Applications Availabilities Bathrooms Bedrooms Booking Discount Codes Booking Discount Code Usages Bookings Booking Comments Bookings Fees Bookings Payments Bookings Tags Bookings Taxes Change Overs Clients Contacts Destinations Fees Fees Taxes Hosts Inbox Attachments Inbox Conversations Inbox Messages Inbox Participants Inquiries Living Rooms LOS Records Me Mid Term Rate Maps Nightly Rate Maps Payment Gateways Payments Periods Photos Rates Rates Rules Rates Tables Rentals Rental Contacts Rental Agreements Rental Cancelation Policies Rental Cancelation Policy Items Rentals Amenities ! Rentals Contents Overrides Rentals Fees Rental Link Groups Rental Links Rentals Tags Rentals Taxes Rental URLs Reviews Seasons Sources Special Offers Taxes Tax Rules

Bedrooms

  1. TOC

Overview

This resource represents the rental’s bedrooms. This resource is mostly static information used for presentational purposes.

Parameters

Name Type Read/Write Description
account Integer Read Account’s ID related to the Bedroom
rental Integer Read Rental’s ID related to the Bedroom
id Integer Read Bedroom’s id.
name Object Read Bedroom’s name, list of locales described in enums section.
bunk_beds_count Integer Read Bedroom’s number of bunk beds.
double_beds_count Integer Read Bedroom’s number of double beds.
kingsize_beds_count Integer Read Bedroom’s number of kingsize beds.
queensize_beds_count Integer Read Bedroom’s number of queensize beds.
single_beds_count Integer Read Bedroom’s number of single beds.
sofa_beds_count Integer Read Bedroom’s number of sofa beds.
futon_beds_count Integer Read Bedroom’s number of futon beds.
floor_mattress_beds_count Integer Read Bedroom’s number of floor mattress beds.
toddler_beds_count Integer Read Bedroom’s number of toddler beds.
crib_beds_count Integer Read Bedroom’s number of crib beds.
air_mattress_beds_count Integer Read Bedroom’s number of air mattress beds.
created_at Time Read Bedroom’s create time.
updated_at Time Read Bedroom’s update time.
Name Type Read/Write Description Constraints
account Integer Read Account’s ID related to the Bedroom  
rental Integer Read Rental’s ID related to the Bedroom  
id Integer Read Bedroom’s id.  
name Object Read Bedroom’s name, list of locales described in enums section.  
name_locale String Write Bedroom’s name, used in write operations. Replace the locale with one of the locales described in enums section (e.g. name_en). Multiple of these attributes could be passed in the same operation, as long as they each have a unique locale (e.g name_en and name_fr) Required for Account’s default locale, maximum length: 25
bunk_beds_count Integer Read/Write Bedroom’s number of bunk beds. integer only, greater than or equal to: 0
double_beds_count Integer Read/Write Bedroom’s number of double beds. integer only, greater than or equal to: 0
kingsize_beds_count Integer Read/Write Bedroom’s number of kingsize beds. integer only, greater than or equal to: 0
queensize_beds_count Integer Read/Write Bedroom’s number of queensize beds. integer only, greater than or equal to: 0
single_beds_count Integer Read/Write Bedroom’s number of single beds. integer only, greater than or equal to: 0
sofa_beds_count Integer Read/Write Bedroom’s number of sofa beds. integer only, greater than or equal to: 0
created_at Time Read Bedroom’s create time.  
updated_at Time Read Bedroom’s update time.  

List bedrooms

List all bedrooms for a given account.

GET /bedrooms

Response

{
  "links": {
    "bedrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bedrooms.rental}"
  },
  "bedrooms": [
    {
      "id": 1,
      "bunk_beds_count": 0,
      "double_beds_count": 1,
      "kingsize_beds_count": 0,
      "name": {
        "en": "bedroom"
      },
      "queensize_beds_count": 0,
      "single_beds_count": 2,
      "sofa_beds_count": 1,
      "created_at": "2023-12-11T08:26:27Z",
      "updated_at": "2023-12-11T08:26:27Z",
      "links": {
        "rental": 1
      }
    }
  ],
  "meta": {
  }
}

Get a single bedroom

Returns a single bedroom identified by ID.

GET /bedrooms/:bedroom_id

Response

{
  "links": {
    "bedrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bedrooms.rental}"
  },
  "bedrooms": [
    {
      "id": 1,
      "bunk_beds_count": 0,
      "double_beds_count": 1,
      "kingsize_beds_count": 0,
      "name": {
        "en": "bedroom"
      },
      "queensize_beds_count": 0,
      "single_beds_count": 2,
      "sofa_beds_count": 1,
      "created_at": "2023-12-11T08:26:27Z",
      "updated_at": "2023-12-11T08:26:27Z",
      "links": {
        "rental": 1
      }
    }
  ],
  "meta": {
  }
}

Create a new bedroom

Creates a bedroom for given rental.

POST /rentals/:rental_id/bedrooms

Example JSON request

{
  "bedrooms": [
    {
      "bunk_beds_count": 0,
      "double_beds_count": 1,
      "kingsize_beds_count": 0,
      "name_en": "bedroom",
      "queensize_beds_count": 0,
      "single_beds_count": 2,
      "sofa_beds_count": 1
    }
  ]
}

Response

{
  "links": {
    "bedrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bedrooms.rental}"
  },
  "bedrooms": [
    {
      "id": 1,
      "bunk_beds_count": 0,
      "double_beds_count": 1,
      "kingsize_beds_count": 0,
      "name": {
        "en": "bedroom"
      },
      "queensize_beds_count": 0,
      "single_beds_count": 2,
      "sofa_beds_count": 1,
      "created_at": "2023-12-11T08:26:27Z",
      "updated_at": "2023-12-11T08:26:27Z",
      "links": {
        "rental": 1
      }
    }
  ],
  "meta": {
  }
}

Update a bedroom

Returns an updated bedroom identified by ID.

PUT /bedrooms/:bedroom_id

Example JSON request

{
  "bedrooms": [
    {
      "bunk_beds_count": 0,
      "double_beds_count": 1,
      "kingsize_beds_count": 0,
      "name_en": "bedroom",
      "queensize_beds_count": 0,
      "single_beds_count": 2,
      "sofa_beds_count": 1
    }
  ]
}

Response

{
  "links": {
    "bedrooms.rental": "https://www.bookingsync.com/api/v3/rentals/{bedrooms.rental}"
  },
  "bedrooms": [
    {
      "id": 1,
      "bunk_beds_count": 0,
      "double_beds_count": 1,
      "kingsize_beds_count": 0,
      "name": {
        "en": "bedroom"
      },
      "queensize_beds_count": 0,
      "single_beds_count": 2,
      "sofa_beds_count": 1,
      "created_at": "2023-12-11T08:26:27Z",
      "updated_at": "2023-12-11T08:26:27Z",
      "links": {
        "rental": 1
      }
    }
  ],
  "meta": {
  }
}

Destroy a bedroom

Required OAuth scope: :rentals_write

Returns an empty response with ‘204 No Content’ status code on success.

DELETE /bedrooms/:bedroom_id