Skip to content
/About Try it

Rooms API (1.2)

Contains Rooms API specification

Download OpenAPI description
rooms-api-specification.json
rooms-api-specification.yaml
Overview
URL
https://connect.booking.com
Connectivity Team
connectivity@booking.com
Languages
Servers
Test static response
https://developers.booking.com/_mock/connectivity/docs/openapispecs/rooms-api/rooms-api-specification
Test using live endpoint
https://supply-xml.booking.com

rooms-api

Create, update, retrieve and delete property units

Operations

meta

Retrieve units meta data and translations

Operations

About Try it

Learn how to effectively use the Try it feature in the Rooms API documentation.

Use the Try it feature to send test request examples to the API endpoints directly from the developer portal and depending on the selected environment either see static, pre-built responses or dynamic responses from a test property.

Environment

You can select between two different environments (top right corner in the UI):

Test static response (default):

  • Helps to understand the response data schema
  • Recommended for all write operations (POST, PUT, DELETE)
  • Environment for testing without affecting live/test data

Test live endpoint:

  • Make sure to use only test properties.
  • Changes will affect your test property data
  • Requires valid credentials
  • Same API structure as production

Request

Using the UI, toggle between Edit and Preview tabs to see the values applied to the path or query placeholders (if there are any). You can also click on any unresolved placeholders to add a value or edit an existing placeholder value.

The portal loads the default request body. Where the specification supports multiple request body examples (for example: Rooms API POST endpoint), you can choose a different request body from the drop-down list.

Some helpful pointers before running a request:

  • Authentication (when using live endpoint): Configure your authentication headers

    • API Key or OAuth token as required. Use the Environments tab.
    • Make sure to manage separate machine accounts for test vs. properties in production.
    • Ensure credentials match your selected environment.

  • Parameters: Fill in required parameters

    • Path parameters (like propertyId)
    • Query parameters (like language_code)
    • Request body for POST/PUT operations

  • Execute: Click Send to send the request

    • The request is sent to the selected environment
    • When sending requests to the live endpoint, real HTTP request is made to the API

Response

The Try it feature provides comprehensive response information to the extent supported by the Open API specification: