Property
Additional public information about a property
Property Information
GET https://example.allocate.co.uk/api/v2
Query Parameters
Name
Type
Description
property_id
string
if the requested domain is a hotel group or consortium you can limit to a single property.
{
"body": {
"id": 66,
"name": "Ashburton Manor",
"type": "hotel",
"checkin_finish": "00:00:00",
"email": "[email protected]",
"longitude": "-2.823241875000008",
"latitude": "56.276557680047155",
"max_rooms_per_booking": 3,
"checkin_start": "17:15:00",
"analytics_account_id": "",
"description": "<p>Ashburton Manor has the elegance of classical French renaissance architecture, complemented by rich furnishings and fabrics to create a truly impressive hotel.</p>",
"last_booking_time": "20:00:00",
"telephone": "01732 780940",
"county": "Fife",
"address_line_1": "Swanton Way",
"url": "",
"country": "United Kingdom",
"postcode": "DU5 8ES",
"town_city": "Troon",
"first_bookable_date": "2019-09-02",
"address_line_3": "",
"address_line_2": "Briddle"
},
"head": {
"related": {
"facilities": {
"href": "https://example.allocate.co.uk/api/v2/facilities/"
},
"cancel": { "href": "https://example.allocate.co.uk/api/v2/cancel" },
"extras": { "href": "https://example.allocate.co.uk/api/v2/extras/" },
"countries": {
"href": "https://example.allocate.co.uk/api/v2/countries/"
},
"images": {
"body": [
{
"body": {
"href": "https://ucarecdn.com/1c14d1f3-12cd-4e93-ac49-dac03c49b0e1/",
"type": "uploadcare"
},
"head": { "type": "image" },
"href": "https://example.allocate.co.uk/api/v2/images/10546"
}
],
"head": { "type": "images" },
"href": "https://example.allocate.co.uk/api/v2/images/"
},
"staytypes": {
"body": [
{
"body": {
"name": "Room Only",
"stay_type_id": 1,
"short_name": "Room Only",
"description": ""
},
"head": { "type": "staytype" },
"href": "https://example.allocate.co.uk/api/v2/staytypes/1"
},
{
"body": {
"name": "Bed and Breakfast",
"stay_type_id": 2,
"short_name": "B & B",
"description": ""
},
"head": { "type": "staytype" },
"href": "https://example.allocate.co.uk/api/v2/staytypes/2"
},
{
"body": {
"name": "Dinner, Bed and Breakfast",
"stay_type_id": 3,
"short_name": "D,B & B",
"description": ""
},
"head": { "type": "staytype" },
"href": "https://example.allocate.co.uk/api/v2/staytypes/3"
},
{
"body": {
"name": "Full Board",
"stay_type_id": 4,
"short_name": "Full Board",
"description": ""
},
"head": { "type": "staytype" },
"href": "https://example.allocate.co.uk/api/v2/staytypes/4"
}
],
"head": { "type": "staytypes" },
"href": "https://example.allocate.co.uk/api/v2/staytypes/"
},
"bookings": { "href": "https://example.allocate.co.uk/api/v2/bookings/" },
"offers": { "href": "https://example.allocate.co.uk/api/v2/offers/" },
"nested_occupancies": {
"href": "https://example.allocate.co.uk/api/v2/nested_occupancies/"
},
"rooms": { "href": "https://example.allocate.co.uk/api/v2/rooms/" },
"availability": {
"href": "https://example.allocate.co.uk/api/v2/availability/"
},
"authenticate": {
"href": "https://example.allocate.co.uk/api/v2/authenticate/"
},
"room-options": {
"href": "https://example.allocate.co.uk/api/v2/room-options/"
},
"currency": {
"head": { "type": "currency" },
"body": {
"symbol": "£",
"symbol_html": "£",
"description": "pound",
"exchange_rate": "0",
"iso_alpha": "GBP",
"id": 1,
"iso_numeric": 826
},
"href": "https://example.allocate.co.uk/api/v2/currency"
},
"rack": {
"body": {
"terms_and_conditions": null,
"min_stay_length": 1,
"lead_time_max": 250,
"max_stay_length": 21,
"enabled": 1,
"lead_time_min": null,
"default_nights": 2,
"name": "Standard Rate",
"description": "Booking can be amended up to 3 days before arrival",
"first_bookable_date": "2019-09-02",
"default_occupancy": 3,
"id": 344
},
"head": {
"related": {
"availability": {
"href": "https://example.allocate.co.uk/api/v2/rack/availability/"
},
"occupancies": {
"body": [
{
"infant": 0,
"description": "1 child",
"child": 1,
"adult": 0,
"id": 1
},
{
"infant": 0,
"description": "1 adult",
"child": 0,
"adult": 1,
"id": 2
},
{
"default": true,
"infant": 0,
"description": "2 adults",
"child": 0,
"adult": 2,
"id": 3
},
{
"infant": 0,
"description": "1 adult, 1 child",
"child": 1,
"adult": 1,
"id": 5
},
{
"infant": 1,
"description": "1 adult, 1 infant",
"child": 0,
"adult": 1,
"id": 6
},
{
"infant": 0,
"description": "2 adults, 3 children",
"child": 3,
"adult": 2,
"id": 17
},
{
"infant": 1,
"description": "2 adults, 2 children, 1 infant",
"child": 2,
"adult": 2,
"id": 18
},
{
"infant": 0,
"description": "2 adults, 2 children",
"child": 2,
"adult": 2,
"id": 19
},
{
"infant": 2,
"description": "2 adults, 1 child, 2 infants",
"child": 1,
"adult": 2,
"id": 20
},
{
"infant": 0,
"description": "2 adults, 1 child",
"child": 1,
"adult": 2,
"id": 21
},
{
"infant": 1,
"description": "1 adult, 2 children, 1 infant",
"child": 2,
"adult": 1,
"id": 27
},
{
"infant": 0,
"description": "1 adult, 2 children",
"child": 2,
"adult": 1,
"id": 28
},
{
"infant": 3,
"description": "1 adult, 3 infants",
"child": 0,
"adult": 1,
"id": 31
},
{
"infant": 2,
"description": "1 adult, 2 infants",
"child": 0,
"adult": 1,
"id": 32
}
],
"head": { "type": "occupancies" },
"href": "https://example.allocate.co.uk/api/v2/rack/occupancies/"
},
"images": {
"body": [
{
"body": {
"href": "https://ucarecdn.com/9853a1a2-ea80-4289-9113-e1c8bd23c074/",
"type": "uploadcare"
},
"head": { "type": "image" },
"href": "https://example.allocate.co.uk/api/v2/rack/images/57334"
}
],
"head": { "type": "images" },
"href": "https://example.allocate.co.uk/api/v2/rack/images/"
},
"nights": {
"body": [
{ "name": "1 Night", "id": 1 },
{ "name": "2 Nights", "default": true, "id": 2 },
{ "name": "3 Nights", "id": 3 },
{ "name": "4 Nights", "id": 4 },
{ "name": "5 Nights", "id": 5 },
{ "name": "6 Nights", "id": 6 },
{ "name": "7 Nights", "id": 7 },
{ "name": "8 Nights", "id": 8 },
{ "name": "9 Nights", "id": 9 },
{ "name": "10 Nights", "id": 10 },
{ "name": "11 Nights", "id": 11 },
{ "name": "12 Nights", "id": 12 },
{ "name": "13 Nights", "id": 13 },
{ "name": "14 Nights", "id": 14 },
{ "name": "15 Nights", "id": 15 },
{ "name": "16 Nights", "id": 16 },
{ "name": "17 Nights", "id": 17 },
{ "name": "18 Nights", "id": 18 },
{ "name": "19 Nights", "id": 19 },
{ "name": "20 Nights", "id": 20 },
{ "name": "21 Nights", "id": 21 }
],
"head": { "type": "nights" },
"href": "https://example.allocate.co.uk/api/v2/rack/nights"
}
},
"type": "rack"
},
"href": "https://example.allocate.co.uk/api/v2/rack"
}
},
"type": "property"
},
"href": "https://example.allocate.co.uk/api/v2"
}
Products
GET https://example.allocate.co.uk/api/v2/offers/
Returns a list of bookable products available at this property.
Path Parameters
Name
Type
Description
id
number
limit to a particular offer id
Query Parameters
Name
Type
Description
property_id
number
If on a group endpoint, limit to this property
limit_type
string
Filter to offers of type
visible_only
boolean
Only offers that are shown during the booking process
promo_code
string
Filter to matching promo code
Rooms
GET https://example.allocate.co.uk/api/v2/rooms/
Retrieves a list of rooms / zones at a property.
Path Parameters
Name
Type
Description
id
number
Limit to only this room ID
Query Parameters
Name
Type
Description
limit_not_type
string
Limit to rooms or zones that don't match this type or types
limit_type
string
Limit to only this type or types of room or zone
Extras
GET https://example.allocate.co.uk/api/v2/extras/
List all extras available at this property.
Path Parameters
Name
Type
Description
string
Stay Types
GET https://example.allocate.co.uk/api/v2/staytypes/
List of stay types available at this property.
Images
GET https://example.allocate.co.uk/api/v2/images/
Images to display of the property.
Countries
GET https://example.allocate.co.uk/api/v2/countries/
List countries that can be picked for this property.
Last updated
Was this helpful?