ors-soap-api:public:getunitpricesbyparams
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
ors-soap-api:public:getunitpricesbyparams [2015/02/21 18:56] admin [Return Values] |
ors-soap-api:public:getunitpricesbyparams [2015/03/05 11:48] (current) admin [Return parameters] |
||
|---|---|---|---|
| Line 184: | Line 184: | ||
| ) | ) | ||
| - | [minimumStay] => Array | + | [minimumStay] => Array |
| ( | ( | ||
| [generalMinLength] => 0 | [generalMinLength] => 0 | ||
| [generalMaxLength] => 0 | [generalMaxLength] => 0 | ||
| - | [dates] => Array | + | [periods] => Array |
| ( | ( | ||
| - | [2015-04-06] => Array | + | [0] => Array |
| ( | ( | ||
| + | [dateFrom] => 2015-04-06 | ||
| + | [dateTo] => 2015-07-10 | ||
| [minLength] => 3 | [minLength] => 3 | ||
| [arrivalDays] => Array | [arrivalDays] => Array | ||
| Line 206: | Line 208: | ||
| ) | ) | ||
| - | [2015-04-07] => Array | + | [1] => Array |
| ( | ( | ||
| - | [minLength] => 3 | + | [dateFrom] => 2015-07-11 |
| + | [dateTo] => 2015-07-24 | ||
| + | [minLength] => 4 | ||
| [arrivalDays] => Array | [arrivalDays] => Array | ||
| ( | ( | ||
| Line 222: | Line 226: | ||
| ) | ) | ||
| - | [2015-04-08] => Array | + | [2] => Array |
| ( | ( | ||
| + | [dateFrom] => 2015-07-25 | ||
| + | [dateTo] => 2015-08-21 | ||
| + | [minLength] => 5 | ||
| + | [arrivalDays] => Array | ||
| + | ( | ||
| + | [monday] => 1 | ||
| + | [tuesday] => 1 | ||
| + | [wednesday] => 1 | ||
| + | [thursday] => 1 | ||
| + | [friday] => 1 | ||
| + | [saturday] => 1 | ||
| + | [sunday] => 1 | ||
| + | ) | ||
| + | |||
| + | ) | ||
| + | |||
| + | [3] => Array | ||
| + | ( | ||
| + | [dateFrom] => 2015-08-22 | ||
| + | [dateTo] => 2015-10-17 | ||
| [minLength] => 3 | [minLength] => 3 | ||
| [arrivalDays] => Array | [arrivalDays] => Array | ||
| Line 237: | Line 261: | ||
| ) | ) | ||
| - | ... | + | |
| + | ) | ||
| + | |||
| + | ) | ||
| [releases] => Array | [releases] => Array | ||
| ( | ( | ||
| Line 423: | Line 451: | ||
| * ''generalMinLength'' : general minimum length (''dates'' overwrite this value) | * ''generalMinLength'' : general minimum length (''dates'' overwrite this value) | ||
| * ''generalMaxLength'' : general maximum length | * ''generalMaxLength'' : general maximum length | ||
| - | * ''dates'' array() : minimum length for some of the dates | + | * ''periods'' array() : minimum stay periods |
| + | * ''dateFrom'' : date from | ||
| + | * ''dateTo'' : date to | ||
| * ''minLength'' : minimum length for this date | * ''minLength'' : minimum length for this date | ||
| * ''arrivalDays'' array() : minimum length is valid only for this arrival days | * ''arrivalDays'' array() : minimum length is valid only for this arrival days | ||
| Line 431: | Line 461: | ||
| * ''release_days'' : release days for this date | * ''release_days'' : release days for this date | ||
| * ''arrivalDays'' array() : release days is valid only for this arrival days | * ''arrivalDays'' array() : release days is valid only for this arrival days | ||
| + | * ''supplements'' array() : a list of supplements and discounts | ||
| + | * ''gratisDays'' : type of discount that deducts price of gratis days (ie. 7=6 , means that if you travel for 7 hights you'll only pay for 6 nights. The cheapest days is usually deducted). | ||
| + | * ''firstMinute'' : discounts for first minute promotions | ||
| + | * ''lastMinute'' : discounts for last minute promotions | ||
| + | * ''discount'' : this are generic discounts (depending on set attributes) | ||
| + | * ''promoCode'' : by entering the corect promo code, user can receive this discount | ||
| + | * ''childDiscount'' : discounts for children (sometimes this is also used for adults) | ||
| + | * ''supplement'' : this is a generic supplement(depending on set attributes) | ||
| + | * ''bookingFee'' : special supplement used for setting booking fees | ||
| + | * ''touristTax'' : special supplement used for setting tourist taxes | ||
| + | * **attributes**: discount/supplement is deducted/added when all this parameters are met | ||
| + | * ''type'' : type of discount | ||
| + | * ''description'' : discount description (when promoCode discount is used, this is actually a promo code user must enter) | ||
| + | * ''reservationDate_from'' (YYYY-MM-DD) : used when reservation date is grater or equal then... | ||
| + | * ''reservationDate_to''(YYYY-MM-DD) : used when reservation date is less or equal then... | ||
| + | * ''checkInPeriod_from''(YYYY-MM-DD) : used when check-In date is grater or equal then... | ||
| + | * ''checkInPeriod_to''(YYYY-MM-DD) : used when check-In date is less or equal then... | ||
| + | * ''exactCheckInPeriod'' (bool) : used if ''check-In = checkInPeriod_from'' and ''check-Out = checkInPeriod_to'' | ||
| + | * ''betweenCheckInPeriod'' (bool) : used if ''check-In >= checkInPeriod_from'' and ''check-Out <= checkInPeriod_to'' | ||
| + | * ''daysUntilCheckIn'' : used if number of days until check-In match this criteria | ||
| + | * ''checkInDays'' : used if check-In is one of the following | ||
| + | * ''numberOfNights1'' : used if number of nights staying match this criteria | ||
| + | * ''numberOfNights2'' : same as ''numberOfNights1'' (can be used together for options like "from" - "to" number of nights) | ||
| + | * ''stayFromDayOfTheWeek'' : day of the week (from) | ||
| + | * ''stayToDayOfTheWeek'' : day of the week (to) | ||
| + | * ''roomType'' : used if room type match this criteria | ||
| + | * ''serviceType'' : used if service type match this criteria | ||
| + | * ''personType'' (adult or child) : used if person type match this criteria | ||
| + | * ''personAge'' (min-max) : used if person age is between this value. (ie. 5-12 ... means: >= 5 years and < 12 years. If person is exactly 12 age or older, this criteria is not met!) | ||
| + | * ''numberOfAdults'' : used if number of adults is the same as this value | ||
| + | * ''whichAdult'' : used if adult number is the same as this value (ie. 2 ... means: discount is only for second adult) | ||
| + | * ''numberOfChildren'' : used if number of childrens is the same as this value | ||
| + | * ''whichChild'' : used if child number is the same as this value (ie. 1 ... means: discount is only for first child) | ||
| + | * ''whichBasicBed'' : used if bed number is the same as this value (ie. 2 ... means: discount is only for person on second bed) | ||
| + | * ''whichExtraBed'' : used if extra bed number is the same as this value (ie. 2 ... means: discount is only for person on second extra bed) | ||
| + | * ''gratisDays'' (max=min): used if number of nights is the same as ''max'' value. ''min'' value states how many nights are paid for (the cheapest nights are deducted) | ||
| + | * ''lessThenMinimumStayAllowed'' (bool) : if true, then this supplement is added when person stay is less then minimum stay set for this rate plan | ||
| + | * ''isOnlyForBasicServiceType'' (bool) : if true, then this discount is only used when person is booking basic service. For other additional service types this discount does not matter. | ||
| + | * ''notWhenFirstminuteIsApplied'' (bool) : don't use this discount if firstMinute discount is already been used | ||
| + | * ''ignoreFirstminuteDiscount'' (bool) : if true, then ignore first minute discounts | ||
| + | * ''notWhenGratisDaysIsApplied'' (bool) : don't use this discount if gratisDays discount is already been used | ||
| + | * ''discountIsAddedToOtherDiscounts'' (bool) : if true then discount value is calculated from previous used discount, if false then discount is calculated from original unit price. | ||
| + | * ''priceType'' : price type ('price per person', 'price per unit', 'price per person per stay', 'price per stay') | ||
| + | * ''price'' : discount price. (ie. -10% , +30, -10) | ||
| + | |||
ors-soap-api/public/getunitpricesbyparams.1424541375.txt.gz · Last modified: 2015/02/21 18:56 by admin
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
