Rate Plan Mapping API

---

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 Room-Rate Plan mapping for property.

Possible values:

• "setup" → Performs both create and update operations. If the Room-Rate Plan mapping 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 IRCTC - 282

---

status string (Optional)

Defines the status of the Room-Rate Plan mapping in the system.

Possible values:

• "Active" → Room-Rate Plan mapping is activated.

• "Inactive" → Room-Rate Plan mapping is deactivated.

---

roomid alphanumeric (Required)

Property's Room / Listing ID.

---

rateid alphanumeric (Required)

Property's rate 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.

---

applicablenoofguest numeric (Required)

Number of guests for this room/rate combination applies.

---

multiplier numeric (Required)

Multiplier to adjust Rates by a percentage. For example, 0.90 to apply a 10% decrease, or 1.10 to apply a 10% increase.

---

surcharge numeric (Required)

Additional Charges (fixed value) to be added (if any).

---

defaultminimumnight numeric (Required)

Specifies the default minimum number of nights required for the mapped rate plan.

---

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.

---

defaultchildrate numeric (Required)

Default Extra Child Rate.

---

advance_purchase_days numeric (Optional)

Specifies the minimum number of days in advance a booking must be made. For example, a value of 2 means the booking must be created at least 2 days before the check-in date.

---

fixedminstay object (Optional) Fixed amount for minimum stay.

---

fixed boolean (Required)

If it supports fixed minimum stay or not.

---

minstay numeric (Optional) Number of days (Value for fixed number of days).

If fixed is set to true, the minstay value must be provided in the request to specify the fixed minimum number of days.

---

Sample Request

{
    "hotelid": "TestProp1",
    "action": "setup",
    "channelid": 282,
    "status": "Active",
    "roomid": "201",
    "rateid": "BAR1",
    "pricing": [
        {
            "applicablenoofguest": 1,
            "multiplier": 1.1,
            "surcharge": 10
        },
        {
            "applicablenoofguest": 2,
            "multiplier": 1.1,
            "surcharge": 20
        }
    ],
    "defaultminimumnight": 2,
    "extrarates": {
        "type": "eac",
        "defaultadultrate": 150,
        "defaultchildrate": 110
    },
    "advance_purchase_days": 2,
    "fixedminstay": {
        "fixed": true,
        "minstay": 10
    }
}

---

Response

Success Response

{
    "Status": "Success",
    "Data": {
        "roomid": "201",
        "roomname": "Deluxe",
        "rateplanid": "BAR1",
        "ratename": "Room Only",
        "channelroomid": "2350",
        "channelrateid": "7803901"
    }
}

996 - Error Response

---

Success Response - Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

---

roomid string

Property's Room / Listing ID.

---

roomname string

Property's Room Type Name.

---

rateplanid string

Property's Rate ID.

---

ratename string

Property's Rate Plan Name.

---

channelroomid string

Represents the Room Type ID generated by the system, to be shared with the channel to map/link on their side.

---

channelrateid string

Represents the Rate Plan ID generated by the system, to be shared with the channel to map/link on 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.

For example: "996" indicates a bad request.

ShortText string

A short description of the error.