List
Retrieves a paginated list of promotions for a given hotel and listing, with optional filters for status, stay dates, and booking dates/times.
Endpoint
POST
https://connect.su-api.com/SUAPI/jservice/vrbo/promotion/listAttributes
hotel_id string (Required)
Specifies the required node hotel_id contains the IT provider's hotel id for which the provider wishes to list all 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.
stay_date object (Optional)
Filters promotions based on stay date range.
start date (YYYY-MM-DD) (Optional)
Start date (YYYY-MM-DD)
end date (YYYY-MM-DD) (Optional)
End date (YYYY-MM-DD)
book_date object (Optional)
The date range the promotion will appear.
Start date (YYYY-MM-DD) (Optional)
Start date (YYYY-MM-DD)
end date (YYYY-MM-DD) (Optional)
End date (YYYY-MM-DD)
book_time object (Optional)
The times of day (on dates specified in book_date) the promotion appears on VRBO, in 24-hour format, in the property's timezone.
start string (Optional) HH:mm:ss (24-hour format)
The time of day (on dates specified in book_date) the promotion will appear on VRBO, in 24-hour format, in the property's timezone.
end string (Optional) HH:mm:ss (24-hour format)
The time of day (on dates specified in book_date) the promotion will no longer appear on VRBO, in 24-hour format, in the property's timezone.
page_size integer (Optional)
Number of records to be returned per page.
next_page integer (Optional)
Pagination token for fetching the next set of results.
Sample Request - For All
Sample Request - With Pagination
Sample Request - With status Filter
Sample Request - With stay_date Filter
Sample Request - With book_date and book_time Filter
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 fetched promotions. This typically includes identifiers for the created promotions.
total_count integer
Total number of promotions available.
next_page string
Pagination token used to fetch the next set of results.
edges array of objects
List of promotion records.
promotion_id string
Unique identifier of the promotion.
name string
Name of the promotion.
sell_status object
Represents the current lifecycle status of the promotion.
status string
Indicates whether the promotion is CURRENT, FUTURE, or EXPIRED.
message string
Description explaining the sell status.
status string
Indicates whether the promotion is ACTIVE or INACTIVE.
type string
Type of promotion (e.g., EARLY_BOOKING, LAST_MINUTE, MOBILE_ONLY,MEMBER_ONLY, and NEW_LISTING_DISCOUNT.
discount_type string
Defines how the discount is applied (e.g., BASIC, DAY_OF_WEEK, MULTI_NIGHT, and TIERED)
discount object (Required)
Contains discount configuration details for the promotion.
unit string (Required)
Unit of discount (PERCENT, AMOUNT).
day_of_week object (Required)
Specifies the day of week, Where <day> = monday, tuesday, wednesday, thursday, friday, saturday, sunday.
<day> number (Required) [Where <day> = monday, tuesday, wednesday, thursday, friday, saturday, sunday.]
Discount value on that day.
supplier_discount_id string (Required)
Discount id for the supplier.
if discount type is MULTI_NIGHT
discount object (Required)
Contains discount configuration details for the promotion.
applicability_rules object
Rules defining how the discount applies.
applicable_nights object
Defines applicable nights.
applicable_night integer
Number of nights eligible for discount.
recurring boolean
Indicates if discount applies repeatedly.
min_stay_through integer
Minimum number of nights allowed.
max_stay_through integer
Maximum number of nights allowed.
min_advance_booking_days integer
Minimum days before check-in allowed to book.
max_advance_booking_days integer
Maximum days before check-in allowed to book.
same_day_booking_start_time string
Start time for same-day booking eligibility.
book_date object
Valid booking date range.
start date (YYYY-MM-DD)
Start date when promotion can be booked.
end date (YYYY-MM-DD)
End date when promotion can be booked.
book_time object
Defines booking time window.
start string
Start time (HH:mm:ss).
end string
End time (HH:mm:ss).
stay_date object
Valid stay date range.
start date (YYYY-MM-DD)
Start date of stay eligibility.
end date (YYYY-MM-DD)
End date of stay eligibility.
excluded_dates array of strings
List of excluded stay dates.
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?