Last updated

Managing listings

Use this endpoint to create listings, add rooms, add bed configurations, set occupancy, among other tasks.

You can:

Discover relevant meta information

Before you can perform many of the above tasks, you must retrieve Booking.com specific meta information. For more information, see the Rooms API meta endpoint specification.

The meta endpoint or simply meta provides a complete set of listing types, listing names and bed types IDs supported by Rooms API. All mentioned IDs are mandatory for the listing creation. For example, you can:

  • Create a listing of type Apartment (listing type ID 1) named Apartment with Sea View (listing name ID 44) with a Large bed (King size) (bed type ID 6) inside.
  • Create a listing of type Double (listing type ID 9) named Deluxe Double Room (listing name ID 255) with two Single bed (bed type ID 1) inside.

Each listing type object in meta has a set of important attributes for you to consider before creating a listing:

  • is_active - defines if a listing type can be used to create or update listings; inactive listing types are read-only.
  • allowed_property_categories - defines a set of property categories for which a given listing type can be created.
  • is_multi_room - defines if a listing type is multi-room or mono-room.

Understand the difference between multi-room and mono-room listings

TypeExample listing typesMultiple rooms supportedType of rooms supportedMultiple bed conigurations supported
Multi-room listingApartment, Villa, SuiteyesBEDROOM_SUBROOM, LIVING_ROOM_SUBROOMno
Mono-room listingStudio, DoublenoGUEST_ROOMyes

Creating listings

POST
https://supply-xml.booking.com/rooms-api/properties/{propertyId}/listings

Path parameters

The following table describes the elements you must specify in the path:

ElementDescriptionTypeRequired/
Optional		Notes
propertyIdSpecifies the unique ID of the property.integerrequiredMust be valid and assigned to your account

Request body parameters

The following table describes the elements you can add in the request body:

ElementDescriptionTypeRequired/
Optional		Default valueRoot parameter in HIN
listing_name_idSpecifies the listing name ID that is part of the listing typestringrequiredn/aDescription > Text
number_of_listingsSpecifies the total number of listings available at the propertyintegeroptional1Room > Quantity
smoking_policySpecifies the smoking policy in the listingenumerated stringoptionalSMOKING_AND_NONSMOKINGRoom > NonSmoking
sizeContains the listing size detailsobjectoptionalnull
> valueSpecifies the listing size in the chosen unitintegerrequired1n/aRoom > SizeMeasurement
> unitSpecifies the unit of measurement to represent the listing sizeenumerated stringrequired1n/aRoom > SizeMeasurementUnit
partner_reference_nameSpecifies a custom listing name visible in the extranet and API responsestringoptionalnullNew field
room_located_on_floorsSpecifies the floor where the listing is locatedarray of integer(s)optionalnullNew field
configurationContains the listing configurationobjectrequiredn/a
> listing_type_idSpecifies the listing type IDenumerated stringrequiredn/aRoom > RoomType
> roomsContains the room details provided the listing type supports roomsarray of objectsrequiredn/a
>> typeSpecifies the room type supported by the listing typeenumerated stringrequiredn/aSubRoom > RoomType
>> bed_configurationsContains the details of the bed available in the roomobjectconditional2n/aSubRoom > Amenities
>>> bedsContains the bed type and the total number of bedsarray of objectsrequired1n/a
>>>> bed_type_idSpecifies the bed type ID supported by the listing typeenumerated integerrequired1n/aAmenityCode (or RoomAmenityCode)
>>>> bed_countSpecifies the total number of beds of the type specified aboveintegerrequired1n/aQuantity (or Value)
>>> is_default_configurationSpecifies whether the specified bed configuration is default for the listing/roombooleanrequired1n/aConfiguration
occupancyContains the occupancy details of the listingobjectoptionaln/a-
> max_guestsSpecifies the maximum guest occupancy for the listingintegeroptional1Occupancy > MaxOccupancy
> max_adultsSpecifies the maximum adult occupancy for the listingintegeroptional1Occupancy > MaxAdultOccupancy
> max_childrenSpecifies the maximum child occupancy for the listingintegeroptional0Occupancy > MaxChildOccupancy
> max_children_that_pay_children_rateSpecifies the maximum number of children eligible for the child rateintegeroptional0TPA_Extensions > MaxChildPayableOccupancy
extra_beds_configurationContains the extra beds details for the listingobjectoptionaln/a
> extra_bedsSpecifies the total number of extra beds available on request per listing/roomintegeroptional0Quantities > MaxRollaways
> cribsSpecifies the total number of extra cribs available on request per listing/roomintegeroptional0Quantities > MaxCribs
> is_crib_and_extra_bed_allowedSpecifies whether guests can request both the extra bed and crib in the listing/roombooleanoptionalfalseNew field

1 - required only if a parent field is provided
2 - required for room types GUEST_ROOM and BEDROOM_SUBROOM, optional for LIVING_ROOM_SUBROOM

Request body validations

Request body is subject to validation against a set of rules listed below.

Generic validation rules

Validation rules in the table below apply to any listing created or updated using Rooms API.

Validation ruleRelated fieldsError description if violated
Listing type ID provided must exist in meta and be activeconfiguration.listing_type_idListing type is inactive or does not exist
Listing type must be allowed for a propertyconfiguration.listing_type_idListing type not allowed for selected property type
Listing name ID provided must exist in metalisting_name_idListing name does not exist
Smoking policy is one of SMOKING, NONSMOKING, SMOKING_AND_NONSMOKINGsmoking_policy
Number of listings must be between 0 and 32000number_of_listingsNumber of listings is invalid
Size value must be between 0 and 9999.99size.valueSize value must be between 0 and 9999.99
Size unit must be of type SQM or SQFTsize.unit
At least one bed should be added to each bed configuration provided in the requestconfiguration.rooms[*].bed_configurationsAt least 1 bed should be added to each bed configuration
Bed type IDs provided in the request must exist in meta and be activeconfiguration.rooms[*].bed_configurations[*].beds[*].bed_type_idBed type is inactive or does not exist
Bed types IDs should not be repeated within a single bed configurationconfiguration.rooms[*].bed_configurations[*].beds[*].bed_type_idBed types should not be repeated within a single bed configuration
Exactly one default bed configuration is mandatory for each room providedconfiguration.rooms[*].bed_configurations[*].is_default_configurationExactly 1 default bed configuration is mandatory
Number of beds must be between 1 and 255configuration.rooms[*].bed_configurations[*].beds[*].bed_countNumber of beds must be between 1 and 255
Maximum overall number of guests is between 1 and 50occupancy.max_guests
Maximum number of adults is between 1 and 50occupancy.max_adults
Maximum number of children is between 1 and 49occupancy.max_children
Maximum number of adults cannot exceed the maximum number of guestsoccupancy.max_guests, occupancy.max_adults,Maximum number of guests must be greater than or equal to number of adults and less than or equal to sum of adults and children
Maximum number of children must be less than maximum number of guestsoccupancy.max_guests, occupancy.max_childrenNumber of children must be less than maximum number of guests
Maximum number of guests cannot exceed the maximum number of adults and children combinedoccupancy.max_guests, occupancy.max_adults, occupancy.max_childrenMaximum number of guests must be greater than or equal to number of adults and less than or equal to sum of adults and children
Number of children eligible for the children rate must be less than or equal to number of childrenoccupancy.max_children, max_children_that_pay_children_rateNumber of children eligible for the children rate must be less than or equal to number of children
Maximum number of extra beds provided must be between 0 and 100extra_beds_configuration.extra_beds
Maximum number of cribs provided must be between 0 and 100extra_beds_configuration.cribs

Validation rules specific for multi-room listings

A multi-room listing is any listing which type has is_multi_room = false flag in meta.

Validation rules in the table below apply to multi-room listings only.

Validation ruleRelated fieldsError description if violated
Room types provided must be of types BEDROOM_SUBROOM or LIVING_ROOM_SUBROOMconfiguration.rooms[*].typeRoom type is not allowed for selected (multi-room) listing type
At least one bedroom must be providedconfiguration.roomsAt least 1 room of type BEDROOM_SUBROOM is mandatory for selected (multi-room) listing type
Number of bedrooms must be between 1 and 20configuration.roomsNumber of BEDROOM_SUBROOM rooms must be between 1 and 20
Number of living rooms must be between 1 and 5configuration.roomsNumber of LIVING_ROOM_SUBROOM rooms must be between 1 and 5
Valid number of bed confgiurations is provided: exactly one for BEDROOM_SUBROOM, not more than one for LIVING_ROOM_SUBROOMconfiguration.rooms[*].bed_configurationsRoom type BEDROOM_SUBROOM must have exactly 1 bed configuration; room type LIVING_ROOM_SUBROOM can not have more than 1 bed configuration

Validation rules specific for mono-room listings

A mono-room listing is any listing which type has is_multi_room = false flag in meta.

Validation rules in the table below apply to mono-room listings only.

Validation ruleRelated fieldsError description if violated
Room type provided must be of type GUEST_ROOMconfiguration.rooms[*].typeRoom type is not allowed for selected (mono-room) listing type
Exactly one room of type GUEST_ROOM must be providedconfiguration.roomsSelected (mono-room) room listing type must have exactly 1 room of type GUEST_ROOM
At least one bed configuration is providedconfiguration.rooms[*].bed_configurationsRoom type GUEST_ROOM must have at least 1 bed configuration

Rules and validations specific for certain listing types

Validation rules in the table below apply only to specific listing types such as Single, Dormitory Room and Bed in Dormitory.

Validation ruleRelated fieldsError description if violated
For listing type 10 (Single) maximum number of adults must be exactly 1configuration.listing_type_id, occupancy.max_adult_occupancyMaximum number of adults must be exactly 1 for selected listing type
For listing type ID 25 (Dormitory Room) maximum number of adults must be 2 or moreconfiguration.listing_type_id, occupancy.max_adult_occupancyMaximum number of adults must be 2 or more for selected listing type
For listing type ID 25 (Dormitory Room) at least two beds must be added to each bed configurationconfiguration.rooms[*].bed_configurations[*].bedsAt least 2 beds must be added to each bed configuration for selected listing type
For listing type ID 26 (Bed in Dormitory) exactly one bed configuration must be providedconfiguration.rooms[*].bed_configurationsExactly 1 bed configuration must be provided for selected listing type
For listing type ID 26 (Bed in Dormitory) exactly one bed must be added to bed configurationconfiguration.rooms[*].bed_configurations[*].bedsExactly 1 bed must be added to bed configuration for selected listing type

Request body example

For more request examples for various use cases, see the examples in the Try it section of the POST method in the Open API specification.

For example, the following request creates a multi-room listing with two bedrooms and one living room:

{
  "configuration": {
    "listing_type_id": 1,
    "rooms": [
      {
        "type": "BEDROOM_SUBROOM",
        "bed_configurations": [
          {
            "beds": [
              {
                "bed_type_id": 6,
                "bed_count": 1
              }
            ],
            "is_default_configuration": true
          }
        ]
      },
      {
        "type": "BEDROOM_SUBROOM",
        "bed_configurations": [
          {
            "beds": [
              {
                "bed_type_id": 4,
                "bed_count": 1
              }
            ],
            "is_default_configuration": true
          }
        ]
      },
      {
        "type": "LIVING_ROOM_SUBROOM",
        "bed_configurations": [
          {
            "beds": [
              {
                "bed_type_id": 7,
                "bed_count": 1
              }
            ],
            "is_default_configuration": true
          }
        ]
      }
    ]
  },
  "listing_name_id": 138547,
  "number_of_listings": 5,
  "smoking_policy": "SMOKING_AND_NONSMOKING",
  "size": {
    "value": 155.0,
    "unit": "SQM"
  },
  "partner_reference_name": "Park facing Apartment",
  "floor_numbers_located_on": [
    2
  ],
  "occupancy": {
    "max_guests": 5,
    "max_adults": 5,
    "max_children": 4,
    "max_children_that_pay_children_rate": 2
  },
  "extra_beds_configuration": {
    "extra_beds": 1,
    "cribs": 0,
    "is_crib_and_extra_bed_allowed": false
  }
}

Response body example

The following is a response snippet:

{
  "data": {
    "listing_id": 813518812,
    "configuration": {
      "listing_type_id": 1,
      "rooms": [
        {
          "type": "BEDROOM_SUBROOM",
          "bed_configurations": [
            {
              "beds": [
                {
                  "bed_type_id": 6,
                  "bed_count": 1
                }
              ],
              "is_default_configuration": true
            }
          ]
        },
        {
          "type": "BEDROOM_SUBROOM",
          "bed_configurations": [
            {
              "beds": [
                {
                  "bed_type_id": 4,
                  "bed_count": 1
                }
              ],
              "is_default_configuration": true
            }
          ]
        },
        {
          "type": "LIVING_ROOM_SUBROOM",
          "bed_configurations": [
            {
              "beds": [
                {
                  "bed_type_id": 7,
                  "bed_count": 1
                }
              ],
              "is_default_configuration": true
            }
          ]
        }
      ]
    },
    "listing_name_id": 138547,
    "number_of_listings": 5,
    "smoking_policy": "SMOKING_AND_NONSMOKING",
    "size": {
      "value": 155.0,
      "unit": "SQM"
    },
    "partner_reference_name": "Park facing Apartment",
    "floor_numbers_located_on": [
      2
    ],
    "occupancy": {
      "max_guests": 5,
      "max_adults": 5,
      "max_children": 4,
      "max_children_that_pay_children_rate": 2
    },
    "extra_beds_configuration": {
      "extra_beds": 1,
      "cribs": 0,
      "is_crib_and_extra_bed_allowed": false
    }
  },
  "warnings": [],
  "errors": [],
  "meta": {
    "ruid": "812536ee9-h5m3-8519-8d28-0218ebfffc68"
  }
}

Response body elements

The following table describes the response elements:

ElementDescriptionTypeNotes
dataContains details of the listing created.object-
> listing_idSpecifies the listing ID.stringUse this to update or deactivate the listing in subsequent calls.
Same as the InvCode in HDI response.
> configurationContains the listing configuration.object
>> listing_type_idSpecifies the listing type ID.enumerated stringFor a list of all supported listing type IDs, see the Rooms API meta endpoint response.
For example to create an One-Bedroom Apartment listing you must specify the listing type ID: 1.
>> roomsContains the room details provided the listing type supports rooms (also known as subrooms).array of objectsTo determine whether the listing supports room(s), check whether the is_multi_room is set to true for the respective listing type ID in the Rooms API meta endpoint response.
>>> typeSpecifies the room type supported by the listing type.enumerated stringSupports the following values:
  • BEDROOM_SUBROOM
  • LIVING_ROOM_SUBROOM
  • GUEST_ROOM
>>> bed_configurationsContains the details of the bed available in the room.object
>>>> bedsContains the bed type and the total number of beds.array of objects
>>>>> bed_type_idSpecifies the bed type ID that is supported by the listing type.enumerated integerFor a list of all possible bed type IDs, see the bed_type_id key in the Meta endpoint response.
>>>>> bed_countSpecifies the total number of beds available in the listing/room.integer
>>>> is_default_configurationSpecifies whether the specified bed configuration is default for the listing/room.boolean
> listing_name_idSpecifies the listing name ID that is part of the listing type.stringFor a list of all supported listing name IDs, see the Rooms API meta endpoint response.
> number_of_listingsSpecifies the total number of rooms available at the property for the specified room type.integerDefault value: 1.
> smoking_policySpecifies the smoking policy in the room.enumerated stringSupports the following values:
  • SMOKING
  • NonSMOKING
  • SMOKING_AND_NONSMOKING
>> sizeContains the listing size details.object
>>> valueSpecifies the listing size in the chosen unit.integer
>>> unitSpecifies the unit of measurement to represent the listing size.enumerated stringSupports the following values:
  • SQM
  • SQFT
> partner_reference_nameSpecifies a custom listing name that is visible in the extranet and in the API response.stringDefault value: "" (an empty string).
> floor_numbers_located_onSpecifies the floor where the listing is located.array of integer(s)Default value: [] (an empty array).
> occupancyContains the occupancy details of the listing.objectoptional
>> max_guestsSpecifies the maximum guest occupancy for the listing.integerMaximum value: 50
Default value: 1.
>> max_adultsSpecifies the maximum adult occupancy for the listing.integerMaximum value: 50
Default value: 1.
Note that the total occupancy (sum of adults and children) must not exceed the room's maximum guest occupancy (max_guests) limit.
>> max_childrenSpecifies the maximum child occupancy for the listing.integerMaximum value: 49
Default value: 0

Note that the total number of children should be less than the maximum number of guests.
>> max_children_that_pay_children_rateSpecifies the maximum number of children eligible for the child rate.integerMaximum value: 49
Default value: 0
Note that the number of children eligible for the child rate specified here cannot exceed the maximum child occupancy (max_children).
> extra_beds_configurationContains the extra beds details for the listing.objectIf not specified, the API specifies default values.
>> extra_bedsSpecifies the total number of extra beds available on request per room/listing.integerDefault value: 0
Maximum 100.
>> cribsSpecifies the total number of extra cribs available on request per room/listing.integerDefault value: 0
Maximum 100.
>> is_crib_and_extra_bed_allowedSpecifies whether guests have the option of requesting both the extra bet and crib in the room/unit.booleanDefault: false.
warningsContains any warnings in the request.object-
errorsContains any errors in the request.object-
metaContains metadata information about the response.object-
> ruidSpecifies the unique request ID.stringYou can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

Updating a listing

PATCH
https://supply-xml.booking.com/rooms-api/properties/{propertyId}/listings/{listingID}

To update an existing listing, copy the relevant portion of the response from the GET property listing details endpoint and use it as the request body. As an update action, the API overlays the existing listing details with the configuration in the request body. Make sure to send the root-level field and their nested fields.

Note that updating a listing doesn't affect existing reservations.

Path parameters

The following table describes the elements you must specify in the path:

ElementDescriptionTypeRequired/
Optional		Notes
propertyIdSpecifies the unique ID of the property.integerrequiredMust be valid and connected to your account
listingIDSpecifies the unique ID of the listing to update.integerrequiredMust belong to the property

Request body parameters

The following table describes the elements you can add in the request body. Note that every root level field is optional, but if it has subfields you must provide all the subfields in full.

ElementDescriptionTypeRequired/
Optional		Root parameter in HIN
listing_name_idSpecifies the listing name ID that is part of the listing typestringoptionalDescription > Text
number_of_listingsSpecifies the total number of listings available at the propertyintegeroptionalRoom > Quantity
smoking_policySpecifies the smoking policy in the listingenumerated stringoptionalRoom > NonSmoking
sizeContains the listing size detailsobjectoptional
> valueSpecifies the listing size in the chosen unitintegerrequired1Room > SizeMeasurement
> unitSpecifies the unit of measurement to represent the listing sizeenumerated stringrequired1Room > SizeMeasurementUnit
partner_reference_nameSpecifies a custom listing name visible in the extranet and API responsestringoptionalNew field
room_located_on_floorsSpecifies the floor where the listing is locatedarray of integer(s)optionalNew field
configurationContains the listing configurationobjectoptional
> listing_type_idSpecifies the listing type IDenumerated stringrequired1Room > RoomType
> roomsContains the room details provided the listing type supports roomsarray of objectsrequired1
>> typeSpecifies the room type supported by the listing typeenumerated stringrequired1SubRoom > RoomType
>> bed_configurationsContains the details of the bed available in the roomobjectconditional2SubRoom > Amenities
>>> bedsContains the bed type and the total number of bedsarray of objectsrequired1
>>>> bed_type_idSpecifies the bed type ID supported by the listing typeenumerated integerrequired1AmenityCode (or RoomAmenityCode)
>>>> bed_countSpecifies the total number of beds of the type specified aboveintegerrequired1Quantity (or Value)
>>> is_default_configurationSpecifies whether the specified bed configuration is default for the listing/roombooleanrequired1Configuration
occupancyContains the occupancy details of the listingobjectoptional-
> max_guestsSpecifies the maximum guest occupancy for the listingintegerrequired1Occupancy > MaxOccupancy
> max_adultsSpecifies the maximum adult occupancy for the listingintegerrequired1Occupancy > MaxAdultOccupancy
> max_childrenSpecifies the maximum child occupancy for the listingintegerrequired1Occupancy > MaxChildOccupancy
> max_children_that_pay_children_rateSpecifies the maximum number of children eligible for the child rateintegerrequired1TPA_Extensions > MaxChildPayableOccupancy
extra_beds_configurationContains the extra beds details for the listingobjectoptional
> extra_bedsSpecifies the total number of extra beds available on request per listing/roomintegerrequired1Quantities > MaxRollaways
> cribsSpecifies the total number of extra cribs available on request per listing/roomintegerrequired1Quantities > MaxCribs
> is_crib_and_extra_bed_allowedSpecifies whether guests can request both the extra bed and crib in the listing/roombooleanrequired1New field

1 - required only if a parent field is provided
2 - required for room types GUEST_ROOM and BEDROOM_SUBROOM, optional for LIVING_ROOM_SUBROOM

Request body validations

Request body for update requests is subject to the same set of validations as create requests

Request body example

For more request examples for various use cases, see the examples in the Try it section of the PATCH method in the Open API specification.

For example, the following request sets new smoking policy, size and occupancy for an existing listing:

{
  "smoking_policy": "NONSMOKING",
  "size": {
      "value": 45.0,
      "unit": "SQM"
  },
  "occupancy": {
      "max_guests": 4,
      "max_adults": 4,
      "max_children": 3,
      "max_children_that_pay_children_rate": 3
  }
}

Response body example

The following is a response snippet:

{
  "warnings": [],
  "errors": [],
  "meta": {
    "ruid": "463dye036s-9j3v-8b1l-p17n-d7e66289938d"
  }
}

Response body elements

The following table describes the response elements:

ElementDescriptionTypeNotes
warningsContains any warnings in the request.object-
errorsContains any errors in the request.object-
metaContains metadata information about the response.object-
> ruidSpecifies the unique request ID.stringYou can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

Deactivating a listing

DELETE
https://supply-xml.booking.com/rooms-api/properties/{propertyId}/listings/{listingID}

Note that you can deactivate a listing only if there are no active or future reservations for that listing. Deactivating a listing is irreversible.

Path parameters

The following table describes the elements you must specify in the path:

ElementDescriptionTypeRequired/
Optional		Notes
propertyIdSpecifies the unique ID of the property.integerrequiredMust be valid and connected to your account
listingIDSpecifies the unique ID of the listing to deactivate.integerrequiredMust belong to the property

Response body example

The following is a response snippet:

{
  "warnings": [],
  "errors": [],
  "meta": {
    "ruid": "827nee036s-3n7h-8b1l-p17n-d7e66280827d"
  }
}

Response body elements

The following table describes the response elements:

ElementDescriptionTypeNotes
warningsContains any warnings in the request.object-
errorsContains any errors in the request.object-
metaContains metadata information about the response.object-
> ruidSpecifies the unique request ID.stringYou can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

Retrieving listing details

GET
https://supply-xml.booking.com/rooms-api/properties/{propertyId}/listings

Retrieve all listings available in the specified property. When updating a listing, you can also copy the relevant portion of the response from this endpoint and use it as the request body.

Path parameters

The following table describes the elements you must specify in the path:

ElementDescriptionTypeRequired/
Optional		Notes
propertyIdSpecifies the unique ID of the property.integerrequiredMust be valid and connected to your account

Response body example

The following is a response body snippet:

{
  "data": [
    {
      "listing_id": 813518811,
      "configuration": {
        "listing_type_id": 1,
        "rooms": [
          {
            "type": "BEDROOM_SUBROOM",
            "bed_configurations": [
              {
                "beds": [
                  {
                    "bed_type_id": 3,
                    "bed_count": 1
                  }
                ],
                "is_default_configuration": true
              }
            ]
          },
          {
            "type": "BEDROOM_SUBROOM",
            "bed_configurations": [
              {
                "beds": [
                  {
                    "bed_type_id": 3,
                    "bed_count": 1
                  }
                ],
                "is_default_configuration": true
              }
            ]
          },
          {
            "type": "LIVING_ROOM_SUBROOM",
            "bed_configurations": [
              {
                "beds": [
                  {
                    "bed_type_id": 5,
                    "bed_count": 1
                  }
                ],
                "is_default_configuration": true
              }
            ]
          }
        ]
      },
      "listing_name_id": 146362,
      "number_of_listings": 5,
      "smoking_policy": "NONSMOKING",
      "size": {
        "value": 115.0,
        "unit": "SQM"
      },
      "partner_reference_name": null,
      "floor_numbers_located_on": null,
      "occupancy": {
        "max_guests": 6,
        "max_adults": 4,
        "max_children": 2,
        "max_children_that_pay_children_rate": 2
      },
      "extra_beds_configuration": {
        "extra_beds": 0,
        "cribs": 0,
        "is_crib_and_extra_bed_allowed": true
      }
    },
    {
      "listing_id": 813518812,
      "configuration": {
        "listing_type_id": 1,
        "rooms": [
          {
            "type": "BEDROOM_SUBROOM",
            "bed_configurations": [
              {
                "beds": [
                  {
                    "bed_type_id": 6,
                    "bed_count": 1
                  }
                ],
                "is_default_configuration": true
              }
            ]
          },
          {
            "type": "BEDROOM_SUBROOM",
            "bed_configurations": [
              {
                "beds": [
                  {
                    "bed_type_id": 4,
                    "bed_count": 1
                  }
                ],
                "is_default_configuration": true
              }
            ]
          },
          {
            "type": "LIVING_ROOM_SUBROOM",
            "bed_configurations": [
              {
                "beds": [
                  {
                    "bed_type_id": 7,
                    "bed_count": 1
                  }
                ],
                "is_default_configuration": true
              }
            ]
          }
        ]
      },
      "listing_name_id": 140088,
      "number_of_listings": 5,
      "smoking_policy": "SMOKING_AND_NONSMOKING",
      "size": {
        "value": 155.0,
        "unit": "SQM"
      },
      "partner_reference_name": "Park facing Apartment",
      "floor_numbers_located_on": [
        2
      ],
      "occupancy": {
        "max_guests": 5,
        "max_adults": 5,
        "max_children": 4,
        "max_children_that_pay_children_rate": 2
      },
      "extra_beds_configuration": {
        "extra_beds": 1,
        "cribs": 0,
        "is_crib_and_extra_bed_allowed": false
      }
    }
  ],
  "warnings": [],
  "errors": [],
  "meta": {
    "ruid": "8n5t26mw-125e-44b6-869e-70357e19n72w"
  }
}

Response body elements

The following table describes the response elements:

ElementDescriptionTypeNotes
dataContains details of all active listings for a propertyobject-
> listing_idSpecifies the listing ID.stringUse this to update or deactivate the listing in subsequent calls.
Same as the InvCode in HDI response.
> configurationContains the listing configuration.object
>> listing_type_idSpecifies the listing type ID.enumerated stringFor a list of all supported listing type IDs, see the Rooms API meta endpoint response.
For example to create an One-Bedroom Apartment listing you must specify the listing type ID: 1.
>> roomsContains the room details provided the listing type supports rooms (also known as subrooms).array of objectsTo determine whether the listing supports room(s), check whether the is_multi_room is set to true for the respective listing type ID in the Rooms API meta endpoint response.
>>> typeSpecifies the room type supported by the listing type.enumerated stringSupports the following values:
  • BEDROOM_SUBROOM
  • LIVING_ROOM_SUBROOM
  • GUEST_ROOM
>>> bed_configurationsContains the details of the bed available in the room.object
>>>> bedsContains the bed type and the total number of beds.array of objects
>>>>> bed_type_idSpecifies the bed type ID that is supported by the listing type.enumerated integerFor a list of all possible bed type IDs, see the bed_type_id key in the Meta endpoint response.
>>>>> bed_countSpecifies the total number of beds available in the listing/room.integer
>>>> is_default_configurationSpecifies whether the specified bed configuration is default for the listing/room.boolean
> listing_name_idSpecifies the listing name ID that is part of the listing type.stringFor a list of all supported listing name IDs, see the Rooms API meta endpoint response.
> number_of_listingsSpecifies the total number of rooms available at the property for the specified room type.integerDefault value: 1.
> smoking_policySpecifies the smoking policy in the room.enumerated stringSupports the following values:
  • SMOKING
  • NonSMOKING
  • SMOKING_AND_NONSMOKING
>> sizeContains the listing size details.object
>>> valueSpecifies the listing size in the chosen unit.integer
>>> unitSpecifies the unit of measurement to represent the listing size.enumerated stringSupports the following values:
  • SQM
  • SQFT
> partner_reference_nameSpecifies a custom listing name that is visible in the extranet and in the API response.stringDefault value: "" (an empty string).
> floor_numbers_located_onSpecifies the floor where the listing is located.array of integer(s)Default value: [] (an empty array).
> occupancyContains the occupancy details of the listing.objectoptional
>> max_guestsSpecifies the maximum guest occupancy for the listing.integerMaximum value: 50
Default value: 1.
>> max_adultsSpecifies the maximum adult occupancy for the listing.integerMaximum value: 50
Default value: 1.
Note that the total occupancy (sum of adults and children) must not exceed the room's maximum guest occupancy (max_guests) limit.
>> max_childrenSpecifies the maximum child occupancy for the listing.integerMaximum value: 49
Default value: 0

Note that the total number of children should be less than the maximum number of guests.
>> max_children_that_pay_children_rateSpecifies the maximum number of children eligible for the child rate.integerMaximum value: 49
Default value: 0
Note that the number of children eligible for the child rate specified here cannot exceed the maximum child occupancy (max_children).
> extra_beds_configurationContains the extra beds details for the listing.objectIf not specified, the API specifies default values.
>> extra_bedsSpecifies the total number of extra beds available on request per room/listing.integerDefault value: 0
Maximum 100.
>> cribsSpecifies the total number of extra cribs available on request per room/listing.integerDefault value: 0
Maximum 100.
>> is_crib_and_extra_bed_allowedSpecifies whether guests have the option of requesting both the extra bet and crib in the room/unit.booleanDefault: false.
warningsContains any warnings in the request.object-
errorsContains any errors in the request.object-
metaContains metadata information about the response.object-
> ruidSpecifies the unique request ID.stringYou can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.
Previous page
Next page