Product Set

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/set
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.


channel_room_id string (Required)

The identifier of the specific room type in the channel’s system. This helps to identify the exact room type offered.


channel_rate_id string (Required)

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 (Optional)

Defines the minimum advance booking time required for the room. Example: "P2D" → booking must be made at least 2 days before check-in.


max_advanced_booking_offset string (Optional)

Specifies the maximum time in advance that the room can be booked. Example: "P3D" → booking allowed up to 3 days before check-in.


min_los string (Optional)

Minimum number of days that a product can be booked. Example: "P3D" → product can be booked for at least 3 days.


max_los string (Optional)

Maximum number of days that a product can be booked. Example: "P3D" → product can be booked for up to 3 days.


cancellation_policy_id enumerated integer (Optional)

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


payment_model enumerated integer (Optional)

Payment model to be used in a rate plan. Available only to Direct Connect Suppliers on request. Supported values:

  • 1 → Pay to Agoda

  • 2 → Pay at Property

  • 3 → Both (Online Payment or Pay at Property)

  • 4 → Merchant Commission


value_added_services object (Optional)

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


services array[object] (Optional)

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


service_id integer (Optional)

This ID refers to the specific service offered in the value-added package. Reference list: Agoda Master Data.


rate_plan object (Required)

Specifies the stay date and sale date range for the rate plan.


sell_date_range object (Required)

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


stay_date_range object (Required)

The date range for which this rate plan is valid for guest stays.


room_info object (Optional)

Identifies the Check-In and/or Check-Out time available for this product.


checkin_time string (Optional)

Check-in time for this property product.


checkout_time string (Optional)

Check-out time for this property product.


Sample Request

{
    "hotel_id": "AWSTEST",
    "channel_hotel_id": "77048595",
    "channel_room_id": "1194119701",
    "channel_rate_id": "21147605",
    "min_advanced_booking_offset": "P5D",
    "max_advanced_booking_offset": "P1",
    "min_los":"P1D",
    "max_los":"P99D",
    "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"
    }
}

Response

Success Response

{
    "Status": "Success",
    "Data": [],
    "Message": "Product set successfully",
    "Ruid": "835c2503-92e7-11f0-b69e-e53ca516bdc6"
}

Success Response

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "572",
            "ShortText": "channel_hotel_id - is invalid or not found!"
        }
    ],
    "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.


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.

Last updated

Was this helpful?