Create Mobile Only

Creates a new promotion for a listing with support for multiple discount types such as BASIC, DAY_OF_WEEK, and MULTI_NIGHT, along with booking and stay constraints.


Endpoint

POST

https://connect.su-api.com/SUAPI/jservice/vrbo/promotion/create

Attributes

hotel_id string (Required)

Specifies the required node hotel_id contains the IT provider's hotel id for which the provider wishes to create 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 created.


status string (Required)

Defines the lifecycle status of the promotion (e.g., ACTIVE, INACTIVE).


type string (Required)

Specifies the type of promotion (e.g., EARLY_BOOKING, NEW_LISTING_DISCOUNT).


discount_type string (Required)

Defines the type of discount.

circle-info

Possible values:

  • BASIC – Single discount for all users

  • DAY_OF_WEEK – Discounts vary by weekday

  • MULTI_NIGHT – Discounts based on number of nights stayed


"discount_type" = "BASIC"

discount object (Required)

Contains discount configuration details for the promotion.


unit string (Required)

Unit of discount (PERCENT, AMOUNT).


value number (Required)

Discount value.


"discount_type" = "DAY_OF_WEEK"

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.


"discount_type" = "MULTI_NIGHT"

unit string (Required)

Unit of discount (PERCENT, AMOUNT).


value number (Required)

Discount value.


applicability_rules object (Required)

Defines rules that control how and when the multi-night discount is applied.


applicable_nights object (Required)

Specifies the night-based conditions under which the discount becomes applicable.


applicable_night integer (Required)

Defines after how many nights discount applies.


recurring boolean (Required)

Indicates whether discount repeats for every cycle.


discount object (Required)

Contains discount configuration details for the promotion.


tiers array[object] (Required)

List of tier-based discounts.


member_tier string (Required)

Member tier level.

circle-info

Possible values: BLUE, SILVER, GOLD (as per system configuration)


discount object (Required)

Contains discount configuration details for the promotion.


unit string (Required)

Unit of discount (e.g., PERCENT, AMOUNT).


value number (Required)

Discount value for the tier.


min_stay_through integer (Required)

The minimum number of nights a guest must stay to be eligible for the promotion.


max_stay_through integer (Required)

The maximum number of nights a guest must stay to be eligible for the promotion.


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.


stay_date object (Required)

Filters promotions based on stay date range.


start date (YYYY-MM-DD) (Required)

Start date (YYYY-MM-DD)


end date (YYYY-MM-DD) (Required)

End date (YYYY-MM-DD)


excluded_dates array[string] (YYYY-MM-DD) (Optional)

A range of dates during which guests staying at the property will not receive the promotion.


Sample Request - "discount_type" = "BASIC"


Sample Request - "discount_type" = "DAY_OF_WEEK"

Sample Request - "discount_type" = "MULTI_NIGHT"

Response


Success Response - Body Elements

Status string

Indicates the result of the API call.

circle-info

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.


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.

circle-info

"Fail" – The request was not processed successfully due to validation errors or other issues.


TrackingId string

Unique identifier for tracing the request.

Last updated

Was this helpful?