Agoda Channel Password Setup

The Flow of the Channel Password Setup -

Step 1 - Add Agoda 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 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. (for example, Booking.com, Expedia, Airbnb).


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.


connection_name string (Optional)

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


Sample Request

{
  "hotelid": "P5",
  "action": "setup",
  "channelid": 189,
  "status": "Active",
  "channelhotelid": "4746650",
  "currency": "USD",
  "convertrates": true,
  "defaultmultiplier": 1,
  "defaultsurcharge": 0
}

Response

{
  "channelmapping": [
    {
      "rateplan": "1 Bed in 4-Bed Dormitory - Air Conditioning-STANDARD RATE",
      "channelroomname": "1 Bed in 4-Bed Dormitory - Air Conditioning",
      "channelroomid": "10632338",
      "channelratename": "STANDARD RATE",
      "channelrateid": "2545504",
      "mappingstring": "10632338####2545504"
    },
    {
      "rateplan": "1 Person in 4-Bed Dormitory - Female Only-STANDARD RATE",
      "channelroomname": "1 Person in 4-Bed Dormitory - Female Only",
      "channelroomid": "10632345",
      "channelratename": "STANDARD RATE",
      "channelrateid": "2545504",
      "mappingstring": "10632345####2545504"
    },
    {
      "rateplan": "Double (Fan Room)-STANDARD RATE",
      "channelroomname": "Double (Fan Room)",
      "channelroomid": "12478356",
      "channelratename": "STANDARD RATE",
      "channelrateid": "2545504",
      "mappingstring": "12478356####2545504"
    },
    {
      "rateplan": "1 Person in 4-Bed Dormitory - Mixed-STANDARD RATE",
      "channelroomname": "1 Person in 4-Bed Dormitory - Mixed",
      "channelroomid": "4440251",
      "channelratename": "STANDARD RATE",
      "channelrateid": "2545504",
      "mappingstring": "4440251####2545504"
    }
  ],
  "Status": "Success"
}

Success Response - 200 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 - 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.

Last updated

Was this helpful?