Retrieve Rateplan

The endpoint allows users to retrieve rateplan details from Agoda using the hotel ID and channel hotel ID.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/rateplan/retrieve

Header

app-id: c2l0****20=
Authorization: Basic M0****W0

Header	Type	Required	Description
app-id	string	Yes	Your application ID. Required for authentication.
Authorization	string	Yes	Your API key. for authorization. Required for authentication.
Content-Type	string	Yes	Must be set to application/json.

---

Attributes

hotel_id alphanumeric (Required)

Specifies the hotel ID for the property.

---

channel_hotel_id string (Required)

Specifies the channel-specific hotel ID for the property.

---

Sample Request

{
    "hotel_id": "AWSTEST",
    "channel_hotel_id": "77048595"
}

---

Response

Sample Success Response

{
    "Status": "Success",
    "Data": [
        {
            "channel_rate_id": 21147605,
            "name": "Best Rate Plan",
            "status": "Active",
            "rate_plan_type": "1",
            "rate_id": "565669"
        }
    ],
    "Message": "Rateplan records Retrieved Successfully"
}

Sample Error Response 1

{
    "Status": "Fail",
    "Errors": [],
    "Message": "Authorization Failed: User does not have rights for Hotel id: 1234567890",
    "Ruid": "633c29e0-9233-11f0-b3fb-f992349de495"
}

Sample Error Response 2

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "573",
            "ShortText": "channel-mapping not found for this property!"
        }
    ],
    "Message": ""
}

Response Body Element

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

Will be always "Fail" in case of an error response.

---

Data object

The response data, the root element.

---

channel_rate_id string

Specifies the channel-specific rate ID for the room.

---

name string

The human-readable name of the rateplan.

---

status string

Specifies the status value that you want to set for the rateplan. Should be one of these: “Active” , “Inactive” , “Deleted”

---

rate_plan_type enum

Specifies rateplan type from below list for agoda. Must be one of (1,2,3,4)

• Net Exclusive

• Net Inclusive

• Sell Exclusive

• Sell Inclusive

---

rate_id string

The internal ID for the rateplan in your system. Useful for referencing or parent-child mapping.

---

Message string

The message in the response.

---

Code string

Specific error code that helps identify the type of error.

---

ShortText string

A short description of the error.

---

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.