Property Custom Rates

Request

• Url: /apis/property/{propertyid}/customrates
• Method: GET

Headers

• You can set If-Modified-Since in the request headers. This should be UTC date time. If the data is not modified since that date, we will return status code 304 (NotModified) and empty body.

Path parameters

• propertyId is the property id, it is integer.

Query parameters

• latestRates if set "today", this call will show all rates after this date and rates from the nearest season.

Response

Response parameters

• In the Amount field, the key is the pricing group type (WV - Wedding Venue):
  • 10 | 1 night weekend
  • 15 | 1 night midweek
  • 20 | 1 night midweek CV
  • 50 | 2 night weekend
  • 60 | 3 night weekend
  • 70 | Week
  • 80 | Midweek
  • 85 | 2 night midweek
  • 90 | 5 nights
  • 100 | 2 night weekend WV
  • 110 | 3 night weekend WV
  • 120 | Week WV
  • 130 | Midweek WV
• The prices that are returned may contain the following values:
  • +(any positive value): Prices From
  • 0: Use previous week pricing
  • -1: no price for this week
  • -2: Hide column from pricing group
  • *: 1st Special Offer
  • **: 2nd Special Offer
  • ***: 3rd Special Offer

Example response

{
	"AvailabilityNotes": "",
	"Rates": [{
		"Id": 3414,
		"Month": "2016-01",
		"Notes": "*",
		"WeekPriceList": [{
			"WeekCommencing": "2016-01-01",
			"Amount": {
				"7": "-1",
				"6": "-1",
				"8": "500",
				"5": "350"
			}
		}, {
			"WeekCommencing": "2016-01-08",
			"Amount": {
				"7": "250",
				"6": "350",
				"8": "500",
				"5": "350"
			}
		}, {
			"WeekCommencing": "2016-01-15",
			"Amount": {
				"7": "250",
				"6": "350",
				"8": "500",
				"5": "350"
			}
		}, {
			"WeekCommencing": "2016-01-22",
			"Amount": {
				"7": "250",
				"6": "350",
				"8": "500",
				"5": "350"
			}
		}, {
			"WeekCommencing": "2016-01-29",
			"Amount": {
				"7": "250",
				"6": "350",
				"8": "500",
				"5": "350"
			}
		}],
                "GroupSize": 
	        {
                   "20": 
		   {
                      "Id": 632141,
                      "Month": "2017-03",
                      "Notes": "",
                      "WeekPriceList": [
                      {
                          "WeekCommencing": "2017-03-01",
                          "Amount": {
                               "10": "-2",
                               "15": "-2",
                               "20": "-2"
                          }
                      },
                      {
                         "WeekCommencing": "2017-03-03",
                         "Amount": {
                             "10": "-2",
                             "15": "-2",
                             "20": "-2",                
                         }
                      }
                     ]
                   },
                   "25": 
                   {
                     "Id": 632142,
                     "Month": "2017-03",
                     "Notes": "",
                     "WeekPriceList": [
                     {
                         "WeekCommencing": "2017-03-01",
                          "Amount": {
                             "10": "-2",
                             "15": "-2",
                             "20": "-2"
                          }
                     },
                     {
                         "WeekCommencing": "2017-03-03",
                         "Amount": {
                             "10": "-2",
                             "15": "-2",
                             "20": "-2"             
                          }
                     }
                   ]
                 }
               }
          }]
}