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.

circle-info

hotelid is applicable for all the channels listed here.


action enum (Required)

Indicates the call is meant to OTA setup for property.

circle-info

action is applicable for all the channels listed here.

circle-info

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, Air Asia (328), AltoVita, Rezlive (274).

circle-info

channelid is applicable for all the channels listed here.


status string (Required)

Defines the status of the channel connection in the system.

circle-info

status is applicable for all the channels listed here.

circle-info

Possible values:

  • "Active" → Channel integration is enabled

  • "Inactive" → Channel integration is disabled


defaultmultiplier number (Required)

Defines the default multiplier value to be applied in rateplan mapping.

circle-info

defaultmultiplier is applicable for all the channels listed here.


defaultsurcharge number (Required)

Specifies the default surcharge value to be applied in rateplan mapping.

circle-info

defaultsurcharge is applicable for all the channels listed here.


currency string (Required)

Specifies the currency code to be used for channel pricing.

circle-info

currency is applicable for the channels: Air Asia (328), AltoVita (319), Dida Travel (320), Findbulous (300), happyeasygo (284), Hobse OLD (297), KliknBook (313), Omnihotelier (295), Rezlive (274), saffronstays (270), Simplotel (281), Tripfactory (296), VacanceSelect Travel (301)


convertrates boolean (Optional)

Indicates whether the system should automatically convert prices for channel into the configured currency.

circle-info

convertrates is applicable for the channels: Air Asia (328), AltoVita (319), Dida Travel (320), Findbulous (300), happyeasygo (284), Hobse OLD (297), KliknBook (313), Omnihotelier (295), Rezlive (274), saffronstays (270), Simplotel (281), Tripfactory (296), VacanceSelect Travel (301)


pricingmodel string (Required)

Defines the pricing model used by the channel integration.

circle-info

Possible values:

  • "OBP" → Occupancy based Pricing

  • "RP" → Room based Pricing

circle-info

pricingmodel is applicable for Hyperguest OLD (291).


infantage number (Optional)

Defines the maximum age limit considered as an infant.

circle-info

infantage is applicable for the channels: TXGB (317) and AltoVita (319)


childage number (Optional)

Defines the maximum age limit considered as a child.

circle-info

childage is applicable for the channels: TXGB (317) and AltoVita (319)


connection_name string (Optional)

Provides a unique name for the hotel connection to identify it easily in dashboards and reports.

circle-info

connection_name is applicable for all the channels listed here.


Sample Request


Response


Success Response - Body Elements


Status string

Indicates the result of the API call.

circle-info

Will be "Success" for successful operations.


channelhotelid integer

Represents the unique hotel ID generated by the system, to be shared with the channel to establish the connection from their side.


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.

circle-info

For example: "400" indicates a bad request.

ShortText string

A short description of the error.

Last updated

Was this helpful?