Rate Plan Mapping API
The Flow of Channel Mapping -
Step 1 - Add the Expedia channel for the channel mapping process.
Step 2 - Add the valid data/values for multiple fields related to the Channel Mapping process.
Step 3 - Submit all the data.(If the channel rateplan mapping is successfully done, the system will acknowledge with a message - "Success". And in case of failure, system will acknowledge with an error message.)
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.
action enum (Required)
Indicates the call is meant to Channel rateplan mapping for property.
Possible values:
"setup"→ Performs both create and update operations. If the channel password 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, Expedia.
status string (Required)
Defines the status of the channel connection in the system.
status is applicable for all the channels listed here.
Possible values:
"Active"→ Channel integration is enabled"Inactive"→ Channel integration is disabled
channelhotelid alphanumeric (Required)
Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).
roomid alphanumeric (Required)
Property's Room / Listing ID.
rateid alphanumeric (Required)
Property's rate ID.
derivedrateids
array of strings (Required)
List of derived rate plan identifiers from the PMS that are mapped to the base rate plan for the channel.
channelroomid alphanumeric (Required)
Channel Room ID.
channelrateid alphanumeric (Required)
Channel Rate Plan ID.
pricing array of objects
(Required)
Number of guests, multiplier and surcharge. PMS must pass object of number of guests according to the pricing OTA supports.
applicablenoofguest numeric (Required)
Number of guests for this room/rate combination applies.
multiplier numeric (Required)
Multiplier to increase / decrease rates. Both, absolute and percentage value is considered.
surcharge numeric (Required)
Additional Charges to added (if any).
disablerates boolean (Optional)
Flag to disable rates while mapping derived rate plan combination.
disableavailablity boolean (Optional)
Flag to disable inventory while mapping derived room/inventory combination.
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.
fixed
boolean (Required)
If it supports fixed minimum stay or not.
minstay numeric (Optional but required when fixed is true)
Number of days (Value for fixed number of days).
Sample Request
Response
Success Response - 200 Body Elements
Status string
Indicates the result of the API call.
Will be "Success" for successful operations.
Errors Response - 895 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: "895" indicates a bad request.
ShortText string
A short description of the error.
Last updated
Was this helpful?