Channel Password Setup
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 OTA setup for property.
action is applicable for all the channels listed here.
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, cleartrip (351), Hotelsinone.com (355), klook (353).
channelid is applicable for all the channels listed here.
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.
channelhotelid is applicable for all the channels listed here.
defaultmultiplier number (Required)
Defines the default multiplier value to be applied in rateplan mapping.
defaultmultiplier is applicable for all the channels listed here.
defaultsurcharge number (Required)
Specifies the default surcharge value to be applied in rateplan mapping.
defaultsurcharge is applicable for all the channels listed here.
currency string (Required)
Specifies the currency code to be used for channel pricing.
currency is applicable for the channels: brevistay (325), cleartrip (351), Hyperguest (425), SpaBreaks (362), TravelEssence/Little Travel Group (395), Traveloka (386)
convertrates boolean (Optional)
Indicates whether the system should automatically convert prices for channel into the configured currency.
convertrates is applicable for the channels: brevistay (325), cleartrip (351), Hyperguest (425), SpaBreaks (362), TravelEssence/Little Travel Group (395), Traveloka (386)
pricingmodel string (Required)
Defines the pricing model used by the channel integration.
Possible values:
"OBP"→ Occupancy based Pricing"RP"→ Room based Pricing
pricingmodel is applicable for the channels: ANZCRO (384), brevistay (325), busyrooms (350), Hotelzify (406), Hyperguest (425), ixigo (445), klook (353), moteelz (374), nuitee (370), OpenGDS (371), Traveloka (386)
markdowntax number (Optional)
Specifies the tax percentage to be marked down from the Booking Amount received from channel.
markdowntax is applicable for the channels: ANZCRO (384), Codegen (373), Hotelzify (406), Odeon Tours (403), shiji (380), tourmind (382), wowcher (377)
connection_name string (Optional)
Provides a unique name for the hotel connection to identify it easily in dashboards and reports.
connection_name is applicable for all the channels listed here.
Sample Request
Response
Success Response - Body Elements
channelmapping arrray of objects
Channel mapping response.
rateplan string
The rate plan name.
channelroomname string
Indicates channel room name.
channelroomid string
Indicates channel room id.
channelratename string
Indicates channel rate name.
channelrateid alphanumeric
Indicates channel rate id.
mappingstring string
Indicates channel room id and rate id.
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: "400" indicates a bad request.
ShortText string
A short description of the error.
Last updated
Was this helpful?