Rate Plan Mapping API
Endpoint
POST
Attributes
hotelid alphanumeric (Required)
Specifies the required node hotelid contains the IT provider's hotel id for which the provider wishes to add mapping information.
hotelid is applicable for all the channels listed here.
action enum (Required)
Indicates the call is meant to Room-Rate Plan mapping for property.
action is applicable for all the channels listed here.
Possible values:
"setup"→ Performs both create and update operations. If the Room-Rate Plan mapping does not exist in the system, it will create it; otherwise, it will update the existing one."remove"→ Directly performs a straightforward remove operation.
channelid numeric (Required)
Specifies the Channel Code for OTA in Su. For example, cleartrip (351), Hotelsinone.com (355), klook (353).
channelid is applicable for all the channels listed here.
status string (Optional)
Defines the status of the Room-Rate Plan mapping in the system.
status is applicable for all the channels listed here.
Possible values:
"Active"→ Room-Rate Plan mapping is activated"Inactive"→ Room-Rate Plan mapping is deactivated
channelhotelid alphanumeric (Required)
Specifies the unique hotel ID used in the external distribution channel.
channelhotelid is applicable for all the channels listed here.
roomid alphanumeric (Required)
Property's Room / Listing ID.
roomid is applicable for all the channels listed here.
rateid alphanumeric (Required)
Property's Rate ID.
rateid is applicable for all the channels listed here.
derivedrateids array (Optional)
Specifies the list of derived rate plan IDs mapped to the base rate plan.
If the channel supports derived rate plans and the partner intends to map those derived rate plans of channel, this parameter can be used to pass the derived rate plan IDs. Multiple Rate Plan IDs need to be pass as comma separated.
channelroomid alphanumeric (Required)
Channel Room ID.
channelroomid is applicable for all the channels listed here.
channelrateid alphanumeric (Required)
Channel Rate Plan ID.
channelrateid is applicable for all the channels listed here.
pricing array of objects
(Required)
Number of guests, multiplier and surcharge. PMS must pass object of number of guests according to the pricing model OTA supports.
pricing is applicable for all the channels listed here.
applicablenoofguest numeric (Required)
Number of guests for this room/rate combination applies.
multiplier numeric (Required)
Multiplier to adjust Rates by a percentage. For example, 0.90 to apply a 10% decrease, or 1.10 to apply a 10% increase.
surcharge numeric (Required)
Additional Charges (fixed value) to be added (if any).
defaultminimumnight numeric (Required)
Specifies the default minimum number of nights required for the mapped rate plan.
defaultminimumnight is applicable for all the channels listed here.
extrarates
object (Required)
Rates for Extra Adult and Child.
extrarates is applicable for the channels: AkbarTravels (396), ANZCRO (384), AtticInn (418), Bookingsmaker.com (398), bookmybooking (361), booknfly (379), brevistay (325), busyrooms (350), cleartrip (351), Codegen (373), Columbus.to (344), Guest Incoming (397), HeyTrip (376), Hobse (383), hotelinx (369), Hotelzify (406), iOLXIllusionsOnline (372), ixigo (445), klook (353), LetsGoa (390), mytravelbazaar (363), nuitee (370), Odeon Tours (403), OnlineVacations.in (430), Ottila International (368), PinkElephantInternational (365), Riya Travels (401), shiji (380), TravelBullz (400), Travcal (391), TravelEssence/LittleTravelGroup (395), Traveloka (386), TripAffiliateNetwork (375), Vernost (389), Withinearth (385), Zuba (402), and HyperGuest (425)
type
enum (Required)
Three types of Extra Rates.
Possible values:
eac- Extra adult and childeb- Extra bednone- Not set
defaultadultrate
numeric (Required)
Default Extra Adult Rate (applicable only for the channels that supports).
defaultchildrate
numeric (Required)
Default Extra Child Rate (applicable only for the channels that supports).
advance_purchase_days numeric (Optional)
Specifies the minimum number of days in advance a booking must be made.
For example, a value of 2 means the booking must be created at least 2 days before the check-in date.
fixedminstay object (Optional)
Fixed amount for minimum stay.
fixedminstay is applicable for all the channels listed here
fixed
boolean (Required)
If it supports fixed minimum stay or not.
minstay numeric (Optional)
Number of days (Value for fixed number of days).
If fixed is set to true, the minstay value must be provided in the request to specify the fixed minimum number of days.
Sample Request
Response
Success Response - Body Elements
Status string
Indicates the result of the API call.
Will be "Success" for successful operations.
Errors Response - Body Elements
Status string
Indicates the result of the API call, which will be always "Failed" in case of an error response.
Errors 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: "996" indicates a bad request.
ShortText string
A short description of the error.
Last updated
Was this helpful?