View
Retrieves detailed information of a specific promotion for a given hotel listing using the provided promotion ID.
Endpoint
POST
https://connect.su-api.com/SUAPI/jservice/vrbo/promotion/viewAttributes
hotel_id string (Required)
Specifies the required node hotel_id contains the IT provider's hotel id for which the provider wishes to view the promotions.
channel_hotel_id string (Required)
Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).
listing_id string (Required)
Unique identifier of the listing for which promotions are requested.
promotion_id string (Required)
Enter the promotion ID to fetch detailed information of a specific promotion.
Sample Request
Response
Success Response - Body Elements
Status string
Indicates the result of the API call.
Will be "Success" for successful operations.
Data object
An object containing data related to to fetched promotions. This typically includes identifiers for the created promotions.
promotion_id string
Unique identifier of the promotion.
name string
Name of the promotion.
sell_status object
Indicates whether the promotion is currently valid based on booking dates.
status string
Current sell status (e.g., CURRENT, EXPIRED, UPCOMING).
message string
Explanation of the sell status.
status string
Current lifecycle status of the promotion (e.g., ACTIVE, INACTIVE).
type string
Type of promotion (e.g., EARLY_BOOKING).
discount_type string
Defines the discount calculation type.
discount object
Discount configuration details.
unit string
Unit of discount (e.g., PERCENT, AMOUNT).
value number
Discount value applied.
min_stay_through integer
Minimum number of nights required for the stay.
max_stay_through integer
Maximum number of nights allowed for the stay.
min_advance_booking_days integer
Minimum number of days before check-in required to book.
max_advance_booking_days integer
Maximum number of days before check-in allowed to book.
same_day_booking_start_time string HH:mm:ss (24-hour format)
Start time for same-day bookings (if applicable).
book_date object
Booking date range during which the promotion can be applied.
start string YYYY-MM-DD
Start date for booking eligibility.
end string YYYY-MM-DD
End date for booking eligibility.
book_time object
Daily booking time window.
start string HH:mm:ss (24-hour format)
Start time for bookings.
end string HH:mm:ss (24-hour format)
End time for bookings.
stay_date object
Stay date range for which the promotion applies.
start string YYYY-MM-DD
Start date for stay eligibility.
end string YYYY-MM-DD
End date for stay eligibility.
excluded_dates array[string]
Specific dates excluded from the promotion.
Message string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
TrackingId string
Unique identifier for tracing the request.
Errors Response - Body Elements
Errors Response - Body Elements
Errors array[object]
A list of error objects providing detailed information about one or more issues encountered during request processing. This field may be empty if the error is conveyed through the Message field.
Code string
A unique error code representing the specific type of validation or processing error.
ShortText string
A brief, human-readable description of the error. Typically explains what went wrong and may include accepted values or constraints.
Status string
Indicates the result of the API call.
"Fail" – The request was not processed successfully due to validation errors or other issues.
Last updated
Was this helpful?