| Status | ||||
|---|---|---|---|---|
|
List of all the promotions that are created in the database, with all the information and the listings associated with each promotion.
| Code Block | ||
|---|---|---|
| ||
<promotions_request>
<link>
<user>integer(4)</user>
<password>character(20)</password>
</link>
<promotion>
<promotion_id>integer(2)</promotion_id>
</promotion>
</promotions_request> |
The <promotion> node is optional.
If there is a <promotion_id>, the response will be only this specific promotion.
If it’s empty, the response will be all the promotions.
Response:
| Code Block | ||
|---|---|---|
| ||
<promotions_request_response>
<promotions>
<promotion>
<id>integer(2)</id>
<name>character(50)</name>
<code>character(50)</code>
<maximum>integer(3)</maximum>
<used>integer(3)</used>
<price>decimal</price>
<type_price>character(50)</type_price>
<base_price>character(50)</base_price>
<booking_date_start>dd/mm/yyyy</booking_date_start>
<booking_date_end>dd/mm/yyyy</booking_date_end>
<stay_date_start>dd/mm/yyyy</stay_date_start>
<stay_date_end>dd/mm/yyyy</stay_date_end>
<weekdays>True/False</weekdays>
<weekends>True/False</weekends>
<lodgings>
<lodging>integer(8)</lodging>
</lodgings>
</promotion>
</promotions>
</promotions_request_response> |
field | description |
|---|---|
id | ID of the promotion |
name | Title of the promotion |
code | Code to put in the booking engine |
maximum | Maximum number of reservations that can use this promotion |
used | Number of promotions used |
price | Discount to apply to the reservation |
type_price | PERCENTAGE / ABSOLUT → the price can be a discount like 10% or like 10€ |
base_price | STAY_PRICE / TOTAL_PRICE → the discount should apply only to the stay price or to the total price (stay + extra fees like cleaning fee, for example) |
booking_date_start | The promotion can only be used during this interval of booking dates |
booking_date_end | |
stay_date_start | The promotion can only be used during this interval of reservation dates |
stay_date_end | |
weekdays | The promotion can only be used if the reservation dates are weekdays |
weekends | The promotion can only be used if the reservation dates are weekends |
lodgings | List of all the listings that can use this promotion. If empty, it means that ALL listings can use it. |