Hotel.getPackages

Returns hotel packages. 

This function returns all data which can be set in Settings - Stay packages. Hence we recommend that you check your settings before using this funtion to better understand the output structure. 

Parameters

Name Description
login Username
password Password
hotId Hotel ID
term Time period
currencies Currency filter
lanId Language ID, in which you would like descriptions to be returned (optional)

term

Returns hotel packages within selected time period. 

Insert dates in W3 date format. Example: 2010-04-29

<term> [1]  
 
<from> [1] from (date)
<to> [1] to (date)

currencies

With this parameter you can specify in which currencies you would like prices of hotel packages to be returned. You can only select currencies which the hotel permits.

If you leave out this parameter, the function returns package prices in the default currency of the hotel. 

<currencies> [0..1]  
 
<currency> [1..*] Specified curreny. Specify by EITHER currency ID OR code.
 
<curId> [0..1] Currency ID
<code> [0..1] Currency code

Sample request

<request>
        <login>prihlasovaci_jmeno</login>
        <password>heslo</password>
        <hotId>745896</hotId>
        <term>
            <from>2010-01-01</from>
            <to>2010-12-31</to>
        </term>
        <currencies>
            <currency>
                <code>CZK</code>
            </currency>
            <currency>
                <code>EUR</code>
            </currency>
        </currencies>
        <lanId>2</lanId>
</request>

Output

Possible ways to select a package

Option Description
text As a text
checkbox As a checkbox

Billing method for packages - Version as of 6th Sept. 2010

pcuId Name Description
1 /balíček Price for the whole package
2 /noc Price charged per night
3 /os./noc Price charged per person per night
4 /os. Price charged per person
5 /pokoj/noc Price charged per room per night
6 /pokoj Price charged per room 

Root element - packages

<packages> [1]  
 
<package> [0..*] Represents one package

package

<package> [0..*] If the hotel doesn't offer packages, the function will not return anything. 
 
<pckId> [1] Package ID
<hotId> [1] Hotel ID
<tax> [1] VAT rate in %
<name> [1] Package name
<description> [0..1] Package description
<group> [0..1] Group of packages. One or more packages can be included in one group. 
<nights> [0..1] Package can be booked only for stays of length of %d nights 
<galId> [0..1] Package gallery ID
<selection> [1] Package selection method
<unit> [1] Billing method for the package. Only of importance for online bookings. The reservation grid for these units are ignored and the price is determined based on the number of packages. 
 
<pcuId> [1] Unit ID
<name> [1] Unit name. Price in %
<description> [1] Unit description
 
<season> [1..*]

If the package price differs for various different time periods, the element <season> with its elements <from> and <to> appear multiple times in the output. If the element <season> only appears once in the output without the elements <from> and <to>, then the package price remains the same throughout the year. 

 
<from> [0..1] from
<to> [0..1] to
<display> [1] This package is displayed on the web and on the booking form. Possible values "true" or "false"
<required> [1] This package is required for online reservations. Possible values "true" or "false"
<price> [1..*] Package price. If the price for different room kinds is different, the element appears multiple times in the output. 
 
<objectKind> [0..1] Room kind, provided that the package price is for different room kinds
 
<obkId> [1] Object kind ID 
<name> [1] Object kind name
<rate> [1..*] Package price. If the request specified multiple currency types, the element appears multiple times in the output. 
 
<price> [1] Price (amount in selected currency)
<currency> [1] Currency 
 
<curId> [1] Currency ID
<code> [1] Currency code

Sample output

<packages>
    <package>
        <pckId>1</pckId>
        <hotId>1</hotId>
        <tax>20</tax>
        <name>Silvestrovská show</name>
        <selection>text</selection>
        <unit>
            <pcuId>1</pcuId>
            <name>/balíček</name>
            <description>Cena je jednorázová za celý balíček.</description>
        </unit>
        <season>
            <display>true</display>
            <required>false</required>
            <price>
                <rate>
                    <price>1500</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>60</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
        </season>
    </package>
    <package>
        <pckId>2</pckId>
        <hotId>1</hotId>
        <tax>20</tax>
        <name>Parkovací místa (1 auto = 1 místo)</name>
        <description>Parkovací místo v podzemní garáži hotelu.<description>
        <group>V.I.P. klienti<group>
        <selection>text</selection>
        <unit>
            <pcuId>5</pcuId>
            <name>/pokoj/noc</name>
            <description>Cena je učtována za každý pokoj a noc.</description>
        </unit>
        <season>
            <display>true</display>
            <required>false</required>
            <price>
                <rate>
                    <price>100</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>4</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
        </season>
    </package>
    <package>
        <pckId>3</pckId>
        <hotId>1</hotId>
        <tax>20</tax>
        <name>TV k dispozici na pokoji</name>
        <description>Satelitní TV s plazmovou obrazovkou.<description>
        <galId>22789</galId>
        <selection>text</selection>
        <unit>
            <pcuId>6</pcuId>
            <name>/pokoj</name>
            <description>Cena je učtována za každý pokoj.</description>
        </unit>
        <season>
            <from>2010-09-01</from>
            <to>2010-09-30</to>
            <display>true</display>
            <required>false</required>
            <price>
                <objectKind>
                    <obkId>1</obkId>
                    <name>Single Room</name>
                </objectKind>
                <rate>
                    <price>300</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>12</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
            <price>
                <objectKind>
                    <obkId>2</obkId>
                    <name>Double Room</name>
                </objectKind>
                <rate>
                    <price>400</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>15</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
            <price>
                <objectKind>
                    <obkId>3</obkId>
                    <name>Trojlůžkové</name>
                </objectKind>
                <rate>
                    <price>500</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>20</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
            <price>
                <objectKind>
                    <obkId>4</obkId>
                    <name>Double Queen Room</name>
                </objectKind>
                <rate>
                    <price>600</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>25</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
        </season>
        <season>
            <from>2010-10-01</from>
            <to>2010-10-31</to>
            <display>true</display>
            <required>false</required>
            <price>
                <objectKind>
                    <obkId>1</obkId>
                    <name>Single Room</name>
                </objectKind>
                <rate>
                    <price>330</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>15</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
            <price>
                <objectKind>
                    <obkId>2</obkId>
                    <name>Double Room</name>
                </objectKind>
                <rate>
                    <price>440</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>20</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
            <price>
                <objectKind>
                    <obkId>3</obkId>
                    <name>Trojlůžkové</name>
                </objectKind>
                <rate>
                    <price>550</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>25</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
            <price>
                <objectKind>
                    <obkId>4</obkId>
                    <name>Double Queen Room</name>
                </objectKind>
                <rate>
                    <price>660</price>
                    <currency>
                        <curId>1</curId>
                        <code>CZK</code>
                    </currency>
                </rate>
                <rate>
                    <price>30</price>
                    <currency>
                        <curId>2</curId>
                        <code>EUR</code>
                    </currency>
                </rate>
            </price>
        </season>
    </package>
</packages>