List RTB requests¶

Use the /rtb/requests endpoint to retrieve RTB requests for all of your properties.

Method and URL¶

GET https://supply-xml.booking.com/rtb/requests

Request query parameters¶

Parameter	Description	Type	Required	Min	Max	Default
`propertyId`	Specify a property ID to return RTB entities specific to the property.	Integer	-	1	-	-
`status`	Specify the RTB request status. Can contain the following values: - `CREATED`: Request is created. - `APPROVED`: Request is approved by partner. - `REJECTED`: Request is declined by partner. - `BOOKED`: Request was booked by guest after being APPROVED by partner. - `EXPIRED_PENDING_APPROVAL`: Request expired because partner did not take any action. - `EXPIRED_AFTER_APPROVAL`: Request expired due to guest's inaction after partner's approval.	Enum	-	-	-	-
`page`	Specifies the page number you want to access.	Integer	-	1	-	1
`pageSize`	Specifies the number of RTB entities per page.	Integer	-	1	100	20
`updatedSince`	Only returns requests modified after the provided date (ISO 8601 date in UTC) For example: 2022-10-23T13:16:18Z	String	-	-	-	-

How to avoid breaching the rate limit?

To limit the number of requests you make and avoid breaching the rate limit, we recommend that you use the updatedSince parameter.

Request headers¶

Header	Description	Type	Required
`Authorization`	Your Base-64 encoded username and password.	String	Required

Sample request¶

curl --user username:password \
-H 'Content-Type: application/json' \
"https://supply-xml.booking.com/rtb/requests?status=CREATED&updatedSince=2022-10-23T13:16:18Z

Response¶

In case of a successful request, you'll receive status code 200 with an array of RTB entities from all of your properties sorted by created date in descending order and information about the next page in the metadata.

In case of an error, you'll receive the following:

an error code
a message explaining the error, and
an RUID in the metadata

Sample response — Success¶

{
  "data": [{
    "id": 737767,
    "propertyId": 10125435,
    "requestStatus": "EXPIRED_PENDING_APPROVAL",
    "checkin": "2023-06-03",
    "checkout": "2023-06-04",
    "totalPrice": {
      "amount": 365.0,
      "currency": "EUR"
    },
    "units": [{
      "id": 738539,
      "rateId": 35579440,
      "name": "One-Bedroom Apartment",
      "price": {
        "amount": 365.0,
        "currency": "EUR"
      }
    }],
    "occupancy": {
      "adults": 1,
      "children": 0,
      "total": 1
    },
    "guestInfo": {
      "guestMessage": "ftbvznw ifs adyk xnwffhch"
    },
    "statusUpdateTime": "2023-05-31T10:26:29Z",
    "createdAt": "2023-05-30T10:25:27Z",
    "updatedAt": "2023-05-31T10:26:29Z"
  }, {
      "id": 686410,
      "propertyId": 10122635,
      "requestStatus": "EXPIRED_PENDING_APPROVAL",
      "checkin": "2023-06-24",
      "checkout": "2023-06-25",
      "totalPrice": {
        "amount": 392.49999999999994,
        "currency": "EUR"
      },
      "units": [{
        "id": 683222,
        "rateId": 35939440,
        "name": "One-Bedroom Apartment",
        "price": {
          "amount": 392.49999999999994,
          "currency": "EUR"
        }
      }],
      "occupancy": {
        "adults": 2,
        "children": 0,
        "total": 2
      },
      "guestInfo": {
        "guestMessage": "ktsxq oobh. vki yea mjo wkyh: oesw lswv bgvrc wal pmujo dhpc"
      },
      "statusUpdateTime": "2023-05-26T13:28:54Z",
      "createdAt": "2023-05-25T13:27:47Z",
      "updatedAt": "2023-05-26T13:28:54Z"
    }
  ],
  "warnings": [],
  "errors": [],
  "meta": {
    "ruid": "0000000000000000000000000000000000000000000000000000000000000000000000000000",
    "hasNextPage": true,
    "nextPageUrl": "https://supply-xml.booking.com/rtb/properties/10127435/requests?status=EXPIRED_PENDING_APPROVAL&page=2&pageSize=2"
  }
}

Sample response — Errors¶

{
  "warnings": [],
  "errors": [
    {
      "message": "Parameter page must be greater than or equal to 1.",
      "code": "BAD_REQUEST"
    }
  ],
  "meta": {
    "ruid": "0000000000000000000000000000000000000000000000000000000000000000000000000000"
  }
}

Detailed Guest Information¶

Guest details are added to the guestInfo property in an RTB entity. Information unknown for a specific guest is not included in the object.

Parameter	Type	Description
`guestMessage`	String	Message written by the guest when making the request to book.
`emailVerified`	Boolean	If the email was verified as working by Booking.com.
`phoneVerified`	Boolean	If the phone was verified as working by Booking.com.
`registeredSince`	String	Year of registry on Booking.com.
`domestic`	Boolean	If the guest is traveling within the same country.
`hasNoShow`	Boolean	If the guest has a previous no-show.
`hasPastMisconduct`	Boolean	If the guest was marked with misconduct before.
`hasStayWithPartnerBefore`	Boolean	Whether this guest already stayed in this property.
`completedStays`	String	"5+" is present when the guest has at least 5 completed stays on Booking.com.

Is this page helpful? Yes | No