Skip to Content

Changes for page 2. Hotel Prices

Last modified by Giorgi Mdivnishvili on 2024/02/27 12:01
From version 9.1
edited by Giorgi Mdivnishvili
on 2024/02/27 11:56
Change comment: There is no comment for this version
To version 3.1
edited by Giorgi Mdivnishvili
on 2024/02/26 15:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,31 +1,18 @@
1 -= Method Description =
1 +**https:~/~/restapi.rustaronline.com/v1.01/api/hotelprices**
2 2  
3 ->The method returns the object with three list of prices for specified hotel. ContractPrices, Promotions, PromotionsWithConditionsNote: Parameter removedublicates is optional, used for removing duplicate seasons from the list and split prices by seasons. False is default value of this parameter.
3 +Method: GET
4 4  
5 -
6 -== Endpoint URL - [Method - GET] ==
7 -
8 -(% class="box infomessage" %)
9 -(((
10 -[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotelprices>>https://restapi.rustaronline.com/v1.01/api/hotelprices]]
11 -)))
12 -
13 13  Parameters to pass: agentid, agentpassword, hotelid
14 14  
15 15  Sample URL:
16 16  
17 -== Request Parameters ==
9 +**https:~/~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false**
18 18  
19 -(% class="box infomessage" %)
20 -(((
21 -|**Key**|**Value**|**Request URL**
22 -|agentid|test.test|**[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false>>https://restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false]]**
23 -|agentpassword|[[TestP@ssw0rd>>mailto:TestP@ssw0rd]]|**[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false>>https://restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false]]**
24 -|hotelid|d6f9299f-5d94-4955-85e7-003e0383023c|**[[https:~~/~~/restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false>>https://restapi.rustaronline.com/v1.01/api/hotelprices?agentid=test.test&agentpassword=TestP@ssw0rd&hotelid=d6f9299f-5d94-4955-85e7-003e0383023c&removedublicates=false]]**
25 -|removedublicates|false|
26 -)))
27 27  
12 +The method returns the object with three list of prices for specified hotel. ContractPrices, Promotions, PromotionsWithConditions
28 28  
14 +Note: Parameter removedublicates is optional, used for removing duplicate seasons from the list and split prices by seasons. False is default value of this parameter.
15 +
29 29  Return value example:
30 30  
31 31  
... ... @@ -244,46 +244,83 @@
244 244  {{/code}}
245 245  
246 246  
247 -(% class="info" %)|**Value**|(((
248 -**Description**
249 -)))
250 -|**priceid**|GUID of the unique price id in the database of Rustar. This field together with placement creates unique combination of price for room/promotion/mealplan
251 -|**hotelid**|GUID of the hotel in the database of Rustar.
252 -|**roomcategory**|GUID of the Room category
253 -|**roomcategorytype**|GUID of the Room category type. Unique by description of the room
254 -|**roomcategoryname**|string. The name of the room category
255 -|**startdate**|Date. Start date of the price period
256 -|**enddate**|Date. End date of the price period
257 -|**mealplan**|CHAR(2). “RO”,"BB",”HB”,”FB”,”AL”
258 -|**adults**|Integer. Number of Aduts with beds
259 -|**teens**|Integer. Number of children (Teenagers) without extra bed
260 -|**children**|Integer. Number of children between infant and teen ages without extra bed
261 -|**infants**|Integer. Number of infants
262 -|**teenswithextrabeds**|Integer. Number of children (Teenagers) with extra bed
263 -|**childrenwithextrabeds**|Integer. Number of children between infant and teen ages with extra bed
264 -|**childpolicy**| {
265 -|**infantmaxage**|Decimal. Max age of the infant by the policy of the hotel
266 -|**childmaxage**|Decimal. Max age of the child by the policy of the hotel
267 -|**teenmaxage**|Decimal. Max age of the teenager by the policy of the hotel
268 -|**}**|
269 -|**placement**|string. Accomodation of all guests in following format e.g.
270 -|**SGL+1CHDEB(3-13,99)+1CHD(0-2,99)**|
271 -|**price**|Decimal. Price for the accommodation/placement
272 -|**currency**|CHAR(3). Currency of the price above
273 -|**promotioncode**|string. Optional. Promotion code if any of the specified price
274 -|**promotion**| {                  Promotion terms if any
275 -|**staydays**| Integer. Number of days to stay for stay/pay promotion (n nights free)
276 -|**paydays**| Integer. Number of days that will be charged in case of “staydays” stay
277 -|**discount**| Decimal. Discount % that was applied for this promotion
278 -|**cashback**| Decimal. Cashback in specified currency that was applied for this promotion
279 -|**}**|
280 -|**conditions"**| {                Optional conditions for using this price
281 -|**bookingstartdate**| Date. When it is allowed to start the reservation for this promotion/accomodation
282 -|**bookingenddate**| Date. Date, after when the sale of this promotion should be stopped.
283 -|**bookbefore**| Integer. Number of days before checkin to use this promotion (Early Bird)
284 -|**minimumstay**| Integer. Minimal stay of nights to use this promotion
285 -|**maximumstay**| Integer. Maximal stay of nights to use this promotion
286 -|**}**|
287 -|**isactive**| Boolean. True if the price is active and can be used. False if the price is deactivated/inactive.
288 288  
235 +**priceid:**                          GUID of the unique price id in the database of Rustar. This field together with placement creates unique combination of price for room/promotion/mealplan
236 +
237 +**hotelid:**                          GUID of the hotel in the database of Rustar.
238 +
239 +**roomcategory:               **GUID of the Room category
240 +
241 +**roomcategorytype:         **GUID of the Room category type. Unique by description of the room
242 +
243 +**roomcategoryname:       **string. The name of the room category
244 +
245 +**startdate:                       **Date. Start date of the price period
246 +
247 +**enddate:                        **Date. End date of the price period
248 +
249 +**mealplan:                       **CHAR(2). “RO”,"BB",”HB”,”FB”,”AL”
250 +
251 +**adults:                           **Integer. Number of Aduts with beds
252 +
253 +**teens:                            **Integer. Number of children (Teenagers) **without** extra bed
254 +
255 +**children:                        **Integer. Number of children between infant and teen ages **without** extra bed
256 +
257 +**infants:                          **Integer. Number of infants
258 +
259 +**teenswithextrabeds:      **Integer. Number of children (Teenagers) **with** extra bed
260 +
261 +**childrenwithextrabeds: **Integer. Number of children between infant and teen ages **with** extra bed
262 +
263 +**childpolicy: {**
264 +
265 +**infantmaxage:                **Decimal. Max age of the infant by the policy of the hotel
266 +
267 +**childmaxage:                 **Decimal. Max age of the child by the policy of the hotel
268 +
269 +**teenmaxage:                  **Decimal. Max age of the teenager by the policy of the hotel
270 +
271 +**}**
272 +
273 +**placement:                     **string. Accomodation of all guests in following format e.g.
274 +
275 +**"SGL+1CHDEB(3-13,99)+1CHD(0-2,99)"**
276 +
277 +**price:                             **Decimal. Price for the accommodation/placement
278 +
279 +**currency:                       **CHAR(3). Currency of the price above
280 +
281 +**promotioncode:              **string. Optional. Promotion code if any of the specified price
282 +
283 +**promotion: {                  **Promotion terms if any
284 +
285 +**staydays:                       **Integer. Number of days to stay for stay/pay promotion (n nights free)
286 +
287 +**paydays:                        **Integer. Number of days that will be charged in case of “staydays” stay
288 +
289 +**discount:                       **Decimal. Discount % that was applied for this promotion
290 +
291 +**cashback:                      **Decimal. Cashback in specified currency that was applied for this promotion
292 +
293 +**}**
294 +
295 +
296 +**conditions": {                **Optional conditions for using this price
297 +
298 +**bookingstartdate:          **Date. When it is allowed to start the reservation for this promotion/accomodation
299 +
300 +**bookingenddate:            **Date. Date, after when the sale of this promotion should be stopped.
301 +
302 +**bookbefore:                   **Integer. Number of days before checkin to use this promotion (Early Bird)
303 +
304 +**minimumstay:                **Integer. Minimal stay of nights to use this promotion
305 +
306 +**maximumstay:               **Integer. Maximal stay of nights to use this promotion
307 +
308 +**}**
309 +
310 +**isactive:                         **Boolean. True if the price is active and can be used. False if the price is deactivated/inactive.
311 +
312 +
289 289  Please be noted, that the prices are already calculated with all possible discounts.