API Documentation UnitPrices
UnitPrices
Allows you to get price information about your accommodations.
You are only entitled to request information of accommodations assigned to you, other accommodations will not be visible.
URL
https://[API URL]/UnitPrices/[API Key]Parameters
Input Parameters
| ID | Mandatory | Array of Accommodation IDs |
| from | Mandatory | Start date in format yyyy-mm-dd |
| to | Mandatory | End date in format yyyy-mm-dd |
Output Parameters
| error | true | false |
| errormsg | errormessage (if any) |
| data | data array with price information of the accommodation |
| input | input variables for checking purposes |
Examples
JSON Input
{
"ID": [
445,
612
],
"from": "2023-02-01",
"to": "2023-12-31"
}XML Input
<?xml version="1.0" encoding="utf-8"?>
<params>
<param>
<value>
<struct>
<member>
<name>ID</name>
<value>
<array>
<data>
<value>
<int>445</int>
</value>
</data>
<data>
<value>
<int>663</int>
</value>
</data>
</array>
</value>
</member>
<member>
<name>from</name>
<value>
<string>2023-02-01</string>
</value>
</member>
<member>
<name>to</name>
<value>
<string>2023-12-31</string>
</value>
</member>
</struct>
</value>
</param>
</params>JSON Output
{
"error": false,
"errormsg": null,
"data": [
{
"ID": "612",
"from": "2023-03-15",
"to": "2023-05-26",
"ppd": 157,
"ppw": 1099,
"arrivalDay": {
"sunday": "1",
"monday": "1",
"tuesday": "1",
"wednesday": "1",
"thursday": "1",
"friday": "1",
"saturday": "1"
},
"departureDay": {
"sunday": "1",
"monday": "1",
"tuesday": "1",
"wednesday": "1",
"thursday": "1",
"friday": "1",
"saturday": "1"
},
"minimumDays": "5"
},
{
"ID": "612",
"from": "2023-05-26",
"to": "2023-06-24",
"ppd": 157,
"ppw": 1099,
"arrivalDay": {
"sunday": "0",
"monday": "0",
"tuesday": "0",
"wednesday": "0",
"thursday": "0",
"friday": "0",
"saturday": "1"
},
"departureDay": {
"sunday": "0",
"monday": "0",
"tuesday": "0",
"wednesday": "0",
"thursday": "0",
"friday": "0",
"saturday": "1"
},
"minimumDays": "7"
},
{
"ID": "612",
"from": "2023-06-24",
"to": "2023-09-01",
"ppd": 235,
"ppw": 1645,
"arrivalDay": {
"sunday": "0",
"monday": "0",
"tuesday": "0",
"wednesday": "0",
"thursday": "0",
"friday": "0",
"saturday": "1"
},
"departureDay": {
"sunday": "0",
"monday": "0",
"tuesday": "0",
"wednesday": "0",
"thursday": "0",
"friday": "0",
"saturday": "1"
},
"minimumDays": "7"
},
{
"ID": "612",
"from": "2023-09-02",
"to": "2023-12-31",
"ppd": 157,
"ppw": 1099,
"arrivalDay": {
"sunday": "1",
"monday": "1",
"tuesday": "1",
"wednesday": "1",
"thursday": "1",
"friday": "1",
"saturday": "1"
},
"departureDay": {
"sunday": "1",
"monday": "1",
"tuesday": "1",
"wednesday": "1",
"thursday": "1",
"friday": "1",
"saturday": "1"
},
"minimumDays": "5"
}
],
"input": {
"ID": [
445,
612
],
"from": "2023-02-01",
"to": "2023-12-31"
}
}XML Output
<?xml version="1.0" encoding="utf-8"?>
<params>
<param>
<value>
<struct>
<member>
<name>error</name>
<value>
<boolean>0</boolean>
</value>
</member>
<member>
<name>errormsg</name>
<value>
<string/>
</value>
</member>
<member>
<name>data</name>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>ID</name>
<value>
<string>663</string>
</value>
</member>
<member>
<name>from</name>
<value>
<string>2023-04-01</string>
</value>
</member>
<member>
<name>to</name>
<value>
<string>2023-05-27</string>
</value>
</member>
<member>
<name>ppd</name>
<value>
<double>121.42857142857</double>
</value>
</member>
<member>
<name>ppw</name>
<value>
<double>850</double>
</value>
</member>
<member>
<name>arrivalDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>departureDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>minimumDays</name>
<value>
<string>4</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>ID</name>
<value>
<string>663</string>
</value>
</member>
<member>
<name>from</name>
<value>
<string>2023-05-27</string>
</value>
</member>
<member>
<name>to</name>
<value>
<string>2023-07-01</string>
</value>
</member>
<member>
<name>ppd</name>
<value>
<double>146.42857142857</double>
</value>
</member>
<member>
<name>ppw</name>
<value>
<double>1025</double>
</value>
</member>
<member>
<name>arrivalDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>departureDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>minimumDays</name>
<value>
<string>4</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>ID</name>
<value>
<string>663</string>
</value>
</member>
<member>
<name>from</name>
<value>
<string>2023-07-01</string>
</value>
</member>
<member>
<name>to</name>
<value>
<string>2023-07-29</string>
</value>
</member>
<member>
<name>ppd</name>
<value>
<double>232.14285714286</double>
</value>
</member>
<member>
<name>ppw</name>
<value>
<double>1625</double>
</value>
</member>
<member>
<name>arrivalDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>departureDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>minimumDays</name>
<value>
<string>7</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>ID</name>
<value>
<string>663</string>
</value>
</member>
<member>
<name>from</name>
<value>
<string>2023-07-29</string>
</value>
</member>
<member>
<name>to</name>
<value>
<string>2023-08-26</string>
</value>
</member>
<member>
<name>ppd</name>
<value>
<double>268</double>
</value>
</member>
<member>
<name>ppw</name>
<value>
<double>1876</double>
</value>
</member>
<member>
<name>arrivalDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>departureDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>minimumDays</name>
<value>
<string>7</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>ID</name>
<value>
<string>663</string>
</value>
</member>
<member>
<name>from</name>
<value>
<string>2023-08-26</string>
</value>
</member>
<member>
<name>to</name>
<value>
<string>2023-09-30</string>
</value>
</member>
<member>
<name>ppd</name>
<value>
<double>151.85714285714</double>
</value>
</member>
<member>
<name>ppw</name>
<value>
<double>1063</double>
</value>
</member>
<member>
<name>arrivalDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>departureDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>minimumDays</name>
<value>
<string>4</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>ID</name>
<value>
<string>663</string>
</value>
</member>
<member>
<name>from</name>
<value>
<string>2023-09-30</string>
</value>
</member>
<member>
<name>to</name>
<value>
<string>2023-11-04</string>
</value>
</member>
<member>
<name>ppd</name>
<value>
<double>121.42857142857</double>
</value>
</member>
<member>
<name>ppw</name>
<value>
<double>850</double>
</value>
</member>
<member>
<name>arrivalDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>departureDay</name>
<value>
<struct>
<member>
<name>sunday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>monday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>tuesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>wednesday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>thursday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>friday</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>saturday</name>
<value>
<string>1</string>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>minimumDays</name>
<value>
<string>4</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</member>
<member>
<name>input</name>
<value>
<struct>
<member>
<name>ID</name>
<value>
<array>
<data>
<value>
<int>445</int>
</value>
<value>
<int>663</int>
</value>
</data>
</array>
</value>
</member>
<member>
<name>from</name>
<value>
<string>2023-02-01</string>
</value>
</member>
<member>
<name>to</name>
<value>
<string>2023-12-31</string>
</value>
</member>
</struct>
</value>
</member>
</struct>
</value>
</param>
</params>Data Output
The data output shows all information of the accommodation
| Name | Type | Description |
|---|---|---|
| ID | Numeric | Accommodation ID |
| from | String | Start date of price period |
| to | String | End date of price period |
| ppd | Numeric | Price per day |
| ppw | Numeric | Price per week |
| arrivalDay | Array | Array with days of week and true/false if this is an arrival day |
| departureDay | Array | Array with days of week and true/false if this is a departure day |
| minimumDays | Numeric | Minimum amount of days that must be booked |