Retrieve Rateplan

This endpoint allows you to retrieve all rateplan, active rateplan and deactivated rateplan list.


Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/rateplan/retrieve
-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json
Header
Type
Required
Description

app-id

string

Yes

Your application ID. Required for authentication.

Authorization

string

Yes

Your API key. for authorization. Required for authentication.

Content-Type

string

Yes

Must be set to application/json.


Attributes

hotel_id string (Required)

The unique property ID as assigned by the provider upon creation of the property.


channel_hotel_id string (Required)

The unique id for the hotel on the specific channel.


status string (Required)

Specifies the status of the rate plans you want to retrieve.

  • status = 1, retrieve all rateplans (activate and deactived both)

  • status = 3, retrieve all active rate plans

  • status = 6, retrieve all deactivated rateplans


Sample Requests

{
  "Hotel_id": "new1",
  "channel_hotel_id": "12915674",
  "status": "6"
}

Response

Sample Success Response 1

{
  "Status": "Success",
  "Data": [],
  "Message": "Rateplan details Set Successfully",
  "Ruid": "UmFuZG9tSVYkc2RlIyh9YSPNt5WoaZhm5rf7WoiC3q/2sF8DwOzVLR7IgWwjDUz/2EBrgCiM9fbE526V0QhvPmjDzbl+cAuz"
}

Success Response Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.


Message string

A message receives within the response body. This will generally be an empty string if no additional information is needed.


Ruid string

Specifies the unique request ID.

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.


Data array

An array of charge data, each item containing details about charge types, categories, and other associated information (for example, tax types, legacy codes).


Errors

Sample Error Response 1

{
  "Errors": [
    {
      "Code": "400",
      "ShortText": "HotelCode: Invalid HotelCode ('NT711')"
    }
  ],
  "Status": "Fail",
  "Ruid": ""
}

Sample Error Response 2

{
  "Errors": [
    {
      "Code": "573",
      "ShortText": "channel-mapping not found for this property!"
    }
  ],
  "Status": "Fail",
  "Ruid": ""
}

Error Response Body Elements

Status string

Indicates the result of the API call, which will be always "Fail" in case of an error response.


Error array

Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:

Code string

Specific error code that helps identify the type of error.

For example: "400" indicates a bad request.

ShortText string

A short description of the error.


Message string

A message providing more information about the error.


Ruid string

Specifies the unique request ID.

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

In the case where a RUID (Request Unique Identifier) is provided by Booking.com, it will be displayed in the response. If no RUID is received, the field will be left blank.

Last updated

Was this helpful?