Channel Password Setup

The Flow of the Channel Password Setup -

Step 1 - Add Travco.co.uk 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

https://connect.su-api.com/SUAPI/jservice/OTA_Setup

---

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 operation to perform for 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. (for example, Travco.co.uk).

---

status string (Optional)

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

---

channelapipassword string (Required)

Password/API key provided by the OTA channel for authentication.

---

defaultmultiplier number (Required)

Defines the default multiplier value applied in rateplan mapping.

---

defaultsurcharge number (Required)

Specifies the default surcharge value applied in rateplan mapping.

---

connection_name string (Optional)

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

---

Sample Request

{
  "hotelid": "TPBE",
  "action": "setup",
  "channelid": 280,
  "status": "Active",
  "channelhotelid": "123456789",
  "channelapipassword": "password",
  "defaultmultiplier": 1,
  "defaultsurcharge": 0,
  "connection_name": "test_connection_name"
}

---

Response

200 - Success Response

{
  "channelmapping": [
    {
      "mappedname": "Twin Room with Breakfast-Standard-Bed & Breakfast-Standard",
      "roomtypename": "Twin Room with Breakfast",
      "roomtype_id": "TWB",
      "rateplan_id": "0093",
      "rateplanname": "Standard-Bed & Breakfast-Standard",
      "rateplan_code": "",
      "mappingformula": "TWB####0093",
      "rateplan": "Twin Room with Breakfast-Standard-Bed & Breakfast-Standard",
      "channelroomname": "Twin Room with Breakfast",
      "channelroomid": "TWB",
      "channelratename": "Standard-Bed & Breakfast-Standard",
      "channelrateid": "0093",
      "mappingstring": "TWB####0093"
    },
    {
      "mappedname": "Double Room with Breakfast-Standard-Bed & Breakfast-Standard",
      "roomtypename": "Double Room with Breakfast",
      "roomtype_id": "DWB",
      "rateplan_id": "0093",
      "rateplanname": "Standard-Bed & Breakfast-Standard",
      "rateplan_code": "",
      "mappingformula": "DWB####0093",
      "rateplan": "Double Room with Breakfast-Standard-Bed & Breakfast-Standard",
      "channelroomname": "Double Room with Breakfast",
      "channelroomid": "DWB",
      "channelratename": "Standard-Bed & Breakfast-Standard",
      "channelrateid": "0093",
      "mappingstring": "DWB####0093"
    },
    {
      "mappedname": "Triple Room with Breakfast-Standard-Bed & Breakfast-Standard",
      "roomtypename": "Triple Room with Breakfast",
      "roomtype_id": "TRP",
      "rateplan_id": "0093",
      "rateplanname": "Standard-Bed & Breakfast-Standard",
      "rateplan_code": "",
      "mappingformula": "TRP####0093",
      "rateplan": "Triple Room with Breakfast-Standard-Bed & Breakfast-Standard",
      "channelroomname": "Triple Room with Breakfast",
      "channelroomid": "TRP",
      "channelratename": "Standard-Bed & Breakfast-Standard",
      "channelrateid": "0093",
      "mappingstring": "TRP####0093"
    }
  ],
  "Status": "Success"
}

400 - Error Response

---

Success Response - 200 Body Elements

mappedname string

Final mapped name combining room and rate plan used internally for identification.

---

roomtypename string

Internal PMS room type name.

---

roomtype_id string

Internal PMS room type identifier.

---

rateplan_id string

Unique identifier of the rate plan in the channel system.

---

rateplanname string

Rate plan name as defined in the channel.

---

rateplan_code string

Internal PMS rate plan code (if available). May be blank if not applicable.

---

mappingformula string

Formula used to create the mapping.

---

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 - 400 Body Elements

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.

---

Status string

Indicates the result of the API call, which will be always "Failed" in case of an error response.