Rate Plan Mapping API

The Flow of Channel Mapping -

Step 1 - Add the Traveloka channel for the channel mapping process.

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

Step 3 - Submit all the data.(If the channel rateplan mapping 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_RatePlanMap

---

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)

Indicates the call is meant to Channel rateplan mapping for property.

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 numeric (Required)

Specifies the status of the request.

---

channelhotelid alphanumeric (Required)

Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).

---

roomid alphanumeric (Required)

Property's Room / Listing ID.

---

rateid alphanumeric (Required)

Property's rate ID.

---

derivedrateids array (Required)

List of Traveloka non-managable rateids.

---

channelroomid alphanumeric (Required)

Channel Room ID.

---

channelrateid alphanumeric (Required)

Channel Rate Plan ID.

---

pricing array of objects (Required)

Number of guests, multiplier and surcharge. PMS must pass object of number of guests according to the pricing OTA supports.

Possible values:

• RP

• OBP

---

applicablenoofguest numeric (Required)

Number of guests for this room/rate combination applies.

---

multiplier numeric (Required)

Multiplier to increase / decrease rates. Both, absolute and percentage value is considered.

---

surcharge numeric (Required)

Additional Charges to added(if any).

---

fixedminstay object (Required)

Fixed amount for minimum stay.

---

fixed boolean (Required)

If it supports fixed minimum stay or not.

---

minstay numeric (Required)

Number of days (Value for fixed number of days).

---

defaultminimumnight numeric (Required)

Defines the default minimum number of nights required for booking if no specific stay rules are set.

---

extrarates object (Required) Rates for Extra Adult and Child Rates.

---

type enum (Required)

Three types of Extra Rates.

Possible values:

• eac - Extra adult and child

• eb - Extra bed

• none - Not set

---

defaultadultrate numeric (Required)

Default Extra Adult Rate (applicable only for the channel's with support, for example, Traveloka V2).

---

defaultchildrate numeric (Required)

Extra Child Rate(applicable only for the channels with support, for example, Traveloka V2).

---

Sample Request

{
    "hotelid": "NT7",
    "action": "setup",
    "channelid": 386,
    "status": "Active",
    "channelhotelid": "123456789",
    "roomid": "1111",
    "rateid": "1",
    "derivedrateids":
    [
        "ROO"
    ],
    "channelroomid": "TRPPSV",
    "channelrateid": "RB",
    "pricing":
    [
        {
            "applicablenoofguest": 1,
            "multiplier": 1,
            "surcharge": 10
        },
        {
            "applicablenoofguest": 2,
            "multiplier": 2,
            "surcharge": 20
        }
    ],
    "defaultminimumnight": 3,
    "extrarates":
    {
        "type": "eac",
        "defaultadultrate": 1,
        "defaultchildrate": 2
    },
    "fixedminstay":
    {
        "fixed": true,
        "minstay": 4
    }
}

---

Response

200 - Success Response

{
  "Status": "Success"
}

400 - Error Response

---

Success Response - 200 Body Elements

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.