Retrieve Promotion Details API

Fetches all promotions associated with a specified property on Booking.com, including those previously created.


Endpoint

POST

https://connect.su-api.com/SUAPI/jservice/bdc/promotion/retrieveAll

Attributes

hotel_id string (Required)

Specifies the required node hotel_id contains the IT provider's hotel id for which the provider wishes to retrieve promotion details.


channel_hotel_id string (Required)

Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).


Sample Request

{
  "hotel_id": " Test ",
  "channel_hotel_id": "13130615"
}


Response


Success Response - Body Elements

Status string

Indicates the result of the API call.

circle-info

Will be "Success" for successful operations.


Message string

A message receives within the response body. This will generally be an empty string if no additional information is needed.


Ruid string

Specifies the unique request ID.


Data object

An object containing data related to the successful promotion creation. This typically includes identifiers for the created promotions.

id integer

The most recently generated promotion ID.


name string

Name of the promotion.


type string

The type of promotion.


active boolean

Indicates whether the promotion is currently active.


target_channel string

Determines who can see the promotion.


min_stay_through integer

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


non_refundable boolean

Whether or not the guest can receive a refund if they cancel.


no_cc_promotion boolean

Indicates whether the promotion applies to bookings without a credit card.


discount object

Contains discount-related information.


value integer

The discount percentage applied to the promotion.


last_minute object

Indicates whether the promotion is configured as a last-minute deal.


unit string

The unit defining the last-minute condition.


value integer

The numeric value associated with the unit.


early_booker object

Indicates whether the promotion is configured as an early booking deal.


value integer

The number of days in advance the booking must be made.


book_date object

The date range the promotion is visible.


start date (YYYY-MM-DD)

The first date the promotion is available.


end date (YYYY-MM-DD)

The last date the promotion is available.


book_time object

The time range the promotion is visible.


start integer

Start time in 24-hour format.


end integer

End time in 24-hour format.


stay_date object

The date range during which guests must stay to receive the promotion.


start date (YYYY-MM-DD)

The first valid stay date.


end date (YYYY-MM-DD)

The last valid stay date.


excluded_dates array[string]

Dates during which the promotion does not apply.


parent_rates array[integer]

List of parent rate plan IDs.


stats object

Provides performance metrics for the promotion.


total_revenue object

The gross revenue from all bookings with this promotion.


value number

The total revenue amount.


currency string

The currency code.


nr_room_nights integer

The total number of room nights booked with this promotion.


nr_bookings integer

The total number of bookings with this promotion.


nr_cancellations integer

The total number of cancellations with this promotion.


Errors Response - Body Elements


Errors Response - Body Elements


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.


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.


Message string

A descriptive error message summarizing the failure.


Ruid string

A unique request identifier generated for tracking and debugging purposes. This value should be provided when contacting support for issue investigation.

Last updated

Was this helpful?