Retrieve Rateplan
The endpoint allows users to retrieve rateplan details from Agoda using the hotel ID and channel hotel ID.
Endpoint
POST
Header
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
Response
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.
Last updated
Was this helpful?