Product Map Create (Room Based)
This endpoint creates a new room rate plan mapping for a specific hotel and room type, with pricing and availability details.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/product/mapHeader
-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/jsonapp-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
action string (Required)
The type of operation to be performed.
hotel_id string (Required)
The unique identifier for the hotel. It links the request to a specific hotel in the system, allowing the room rate to be associated with the correct hotel.
room_id string (Required)
The identifier for the specific room type being referenced in the request. This ties the rate plan to a specific room at the hotel.
rate_id string (Required)
The identifier for the rate plan associated with the room. This determines the pricing structure, discounts, or other conditions for booking the room.
channel_hotel_id string (Required)
The identifier for the hotel in the distribution channel’s system. It links the hotel product to the respective channel, enabling it to be managed and booked through that platform.
channel_room_id string (Required)
The identifier for the specific room type in the channel’s system. This associates the rate plan and availability with the correct room type within the channel.
channel_rate_id string (Required)
The identifier for the rate plan in the channel’s system. It defines the pricing and conditions for booking the room in the distribution channel.
channel_id integer (Required)
The identifier for the distribution channel. It links the room and rate plan to a specific external booking platform (for example, OTA, GDS).
pricing array (Required)
An array of pricing rules that apply to the room based on the number of guests.
In this case, it includes:
applicable_no_of_guest integer (Required)
The number of guests the pricing rule applies to.
For example, it might apply to a single guest or multiple guests.
multiplier string (Required)
The multiplier applied to the base rate for the specified number of guests.
surcharge string (Required)
The surcharge applied for the specified number of guests. For example, a surcharge might be added for each additional guest beyond a certain number. In this case, it’s set to "0", meaning there’s no surcharge.
disable_availability boolean (Required)
Indicates whether the room’s availability is disabled.
disable_rate boolean (Required)
Indicates whether the rate for the room is disabled.
fixed_minstay object (Required)
Defines the fixed minimum stay requirement for the room:
fixed boolean (Required)
Indicates whether the minimum stay requirement is fixed.
minstay integer (Required)
The minimum number of nights required for booking the room.
Sample Request
{
"action": "create",
"hotel_id": "AWSTEST",
"room_id": "1000202",
"rate_id": "BAR",
"channel_hotel_id": "12962495",
"channel_room_id": "1296249501",
"channel_rate_id": "49681540",
"channel_id": 19,
"pricing": [
{
"applicable_no_of_guest": 5,
"multiplier": "1",
"surcharge": "0"
}
],
"disable_availability": false,
"disable_rate": false,
"fixed_minstay": {
"fixed": true,
"minstay": 1
}
}
Response
Sample Success Response
{
"Status": "Success",
"Data": [],
"Message": "Rateplan Mapping added successfully",
"Ruid": ""
}Success Response Body Elements
Status string
Indicates the result of the API call.
Data object
An object containing data related to the successful image creation. This typically includes identifiers for the created images.
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.
Errors
Sample Error Response 1 - Validation Error Response
{
"Status": "Fail",
"Errors": [
{
"Code": "496",
"ShortText": "action attribute is required"
},
{
"Code": "400",
"ShortText": "hotel_id: Invalid HotelCode ('')"
},
{
"Code": "852",
"ShortText": "Product: room_id - is invalid or not found!"
},
{
"Code": "856",
"ShortText": "Product: rate_id - is invalid or not found!"
}
],
"Message": "",
"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.
ShortText string
A short description of the error.
Message string
A message providing more information about the error.
Ruid string
A unique identifier for tracking the request.
Last updated
Was this helpful?