Channel Password Setup

The Flow of the Channel Password Setup -

Step 1 - Add Traveloka as a channel for which the Setup is to be done.

Step 2 - Add the valid data/values for multiple fields related to the Channel password setup process.

Step 3 - Submit all the data. (If the channel password setup 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)

Defines the status of the channel connection in the system.

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.

status string (Required)

Defines the status of the channel connection in the system.

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).

currency string (Required)

Specifies the default currency code used for pricing.

convertrates boolean (Optional)

Indicates whether the API should automatically convert prices into the configured currency.

defaultmultiplier number (Optional)

Defines the default multiplier value applied in rateplan mapping.

defaultsurcharge number (Optional)

Specifies the default surcharge value applied in rateplan mapping.

pricingmodel string (Required)

Defines pricing model (for example, OBP, RP).

connection_name string (Optional)

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

Sample Request

Response

Success Response - 200 Body Elements

channelmapping array of objects

List of room and rate plan mapping entries.

Each object contains the following fields:

mappedname string

The combined name of the room type and rate plan.

mapping_rateplan string

The short internal code for the mapped rate plan.

mappingformula string

The formula combining the room type ID and rate plan ID using #### as a separator.

rateplan_id string

The internal identifier for the rate plan.

rateplanname string

The name of the rate plan (e.g., "Room Only", "Room and Breakfast").

rateplan_code string

The external or legacy system code for the rate plan (may be empty).

roomtype_id string

The internal identifier for the room type.

roomtypename string

The name of the room type.

type string

Indicates whether the room is manageable or nonmanageable.

rateplan string

The full descriptive name combining the room and rate plan.

channelroomname string

The room name as it appears on the external channel.

channelroomid string

The room ID used by the external channel.

channelratename string

The rate plan name used by the external channel.

channelrateid string

The rate plan ID on the external channel.

mappingstring string

A unique mapping string, typically identical to mappingformula.

fixed_occupany string

Indicates if the room has a fixed occupancy. Usually empty.

is_child string

Indicates if the mapping is for a child-specific room or rate.

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

Errors Response - 400 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.

PreviousTraveloka V2NextRate Plan Mapping API

Last updated

Was this helpful?