Retrieve Products

This endpoint is used to set product details within a property unit. When a request is made to this endpoint, it processes the provided product configuration data and sets a new product.

---

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/product/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

Sample Request Body

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

---

Response

Success Response

Sample Success Response

{
    "Status": "Success",
    "Data": [
        {
            "channel_room_id": "1194119701",
            "channel_rate_id": "21147605",
            "min_advanced_booking_offset": "P2D",
            "max_advanced_booking_offset": "P3D",
            "min_los": "P2D",
            "max_los": "P2D",
            "cancellation_policy_id": "13",
            "payment_model": "4",
            "value_added_serivces": {
                "services": [
                    {
                        "service_id": 1
                    },
                    {
                        "service_id": 2
                    }
                ]
            },
            "rate_plan": {
                "sell_date_range": {
                    "start_date": "2025-07-25",
                    "end_date": "2025-10-25"
                },
                "stay_date_range": {
                    "start_date": "2025-07-25",
                    "end_date": "2025-10-25"
                }
            },
            "room_info": {
                "checkin_time": "12:00",
                "checkout_time": "17:00"
            }
        }
    ],
    "Message": "Product records Retrieved Successfully"
}

Error Response

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_hotel_id string

Specifies the channel-specific hotel ID for the property.

---

channel_rate_id string

The identifier of the rate plan for the specified room type in the channel’s system. It defines the pricing structure for the room.

---

min_advanced_booking_offset string

Defines the minimum advance booking time required for the room. "P2D" means 2 days in advance. The booking should be made at least 2 days before check-in.

---

max_advanced_booking_offset string

Specifies the maximum time in advance that the room can be booked. "P3D" means bookings can be made up to 3 days before check-in.

---

min_los string

Minimum number of days that a product can be booked. "P3D" means a product can be booked for a minimum 3 days.

---

max_los string

Maximum number of days that a product can be booked. "P3D" means a product can be booked for a maximum 3 days.

---

cancellation_policy_id enumerated integer

The code of the cancellation policy to be applied for the given dates.

---

payment_model enumerated integer

Payment model to be used in a rate plan. Its only available to Direct Connect Suppliers on request. Please check with Connectivity Managers.

Supported payment models : 1: Pay to Agoda, 2: Pay at Property,3: Both Payment Available: either Online Payment or Pay at Property and 4: Merchant Commission

---

value_added_services object

Specifies any additional services or packages that are included with the hotel product.

---

services array of objects

A list of individual services that are part of the value-added package.

---

service_id integer

This ID refers to the specific service offered in the value-added package.

List of services : https://connect-sandbox.su-api.com/SUAPI/jservice/agoda/masterData

---

rate_plan object

Specifies the stay date and sale date range for rateplan

---

sell_date_range object

The date range for which this rate plan is offered for sell.

---

start_date string

The start date for the sell date range. Format: YYYY-MM-DD.

---

end_date string

The end date for the sell date range. Format: YYYY-MM-DD.

---

stay_date_range object

The date range for which this rate plan is offered for sell.

---

start_date string

The start date for the stay date range. Format: YYYY-MM-DD.

---

end_date string

The end date for the stay date range. Format: YYYY-MM-DD.

---

room_info object

Identifies the CheckIn and/or CheckOut time available for this product.

---

checkin_time string

Check-in time for this property product

---

checkout_time string

Check-out time for this property product

---

Message string

The message in the response.

---

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.