# 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. | {% tabs %} {% tab title="200 " %} ```javascript { "body": { "id": 66, "name": "Ashburton Manor", "type": "hotel", "checkin_finish": "00:00:00", "email": "test@example.com", "longitude": "-2.823241875000008", "latitude": "56.276557680047155", "max_rooms_per_booking": 3, "checkin_start": "17:15:00", "analytics_account_id": "", "description": "

Ashburton Manor has the elegance of classical French renaissance architecture, complemented by rich furnishings and fabrics to create a truly impressive hotel.

", "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" } ``` {% endtab %} {% endtabs %} {% hint style="info" %} The booking flow is documented on the [booking API page](/api/booking.md) {% endhint %} ## 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 | {% tabs %} {% tab title="200 A list of products, unless filtered." %} ```javascript { "body": [ { "body": { "lead_time_max": null, "show_via_portal": 1, "discount_percentage": "10", "available_to": "2018-12-23", "description": "", "price_description": null, "id": "35921", "terms_and_conditions": "", "min_stay_length": 1, "min_price": 20, "max_stay_length": 28, "category": "Activity Breaks", "enabled": 1, "lead_time_min": null, "default_nights": 1, "name": "Test create offer", "min_price_for_default_occupancy": 120, "first_bookable_date": "2019-09-02", "default_occupancy": 3, "show_via_hotel": 1 }, "head": { "related": { "occupancies": { "body": [ { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "default": true, "infant": 0, "description": "2 adults", "child": 0, "adult": 2, "id": 3 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/offers/35921/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability?product_id=35921" }, "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 } ], "head": { "type": "nights" }, "href": "https://example.allocate.co.uk/api/v2/offers/35921/nights" }, "images": { "body": [], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/offers/35921/images/" } }, "type": "offer" }, "href": "https://example.allocate.co.uk/api/v2/offers/35921" }, { "body": { "lead_time_max": null, "show_via_portal": 1, "discount_percentage": "0", "available_to": "2018-12-23", "description": "", "price_description": null, "id": "35923", "terms_and_conditions": "", "min_stay_length": 1, "min_price": 20, "max_stay_length": 28, "enabled": 1, "lead_time_min": null, "default_nights": 1, "name": "test 3030303", "min_price_for_default_occupancy": 120, "first_bookable_date": "2019-09-02", "default_occupancy": 3, "show_via_hotel": 1 }, "head": { "related": { "occupancies": { "body": [ { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "default": true, "infant": 0, "description": "2 adults", "child": 0, "adult": 2, "id": 3 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/offers/35923/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability?product_id=35923" }, "nights": { "body": [ { "name": "1 Night", "id": 1 }, { "name": "2 Nights", "default": true, "id": 2 }, { "name": "3 Nights", "id": 3 }, { "name": "4 Nights", "id": 4 } ], "head": { "type": "nights" }, "href": "https://example.allocate.co.uk/api/v2/offers/35923/nights" }, "images": { "body": [], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/offers/35923/images/" } }, "type": "offer" }, "href": "https://example.allocate.co.uk/api/v2/offers/35923" }, { "body": { "lead_time_max": null, "show_via_portal": 1, "discount_percentage": "10", "available_to": "2018-12-23", "description": "

Exclusive free late checkout for a limited time only.

\nEscape this Summer at Park Farm Hotel.\n

\nYour arrival will be enhanced with a bottle of chilled Prosecco and a relaxing Spa hamper. Then dine in style with three course dinner in our restaurant from our Menu Du Jour. Full English breakfast each morning will have you perfectly prepared for the day ahead, and complimentary use of our extensive leisure facilities is of course available at your convenience. Free late checkout is also included.

", "price_description": null, "id": "36238", "terms_and_conditions": "

The above rates are based on two people sharing a twin/double room. Exclusion dates may apply. Not applicable for use in conjunction with any other offer. Children may share their parents (Deluxe rooms only) at a cost of £15 per child per night inclusive of full English breakfast only. Prosecco and spa hamper are only included once during your stay. Your package includes three courses from our Seasons Menu. Should you wish to dine from our A La Carte menu you would receive a £28 per person allowance. Any additional costs would be charged to your bedroom account for payment upon your departure. Single room rates are not applicable on this offer. This offer may be withdrawn or altered at any time. (Valid from 1st June 2018 to 30th September 2018) A charge of £75 per room is made should your cancellation or amendment not meet the following terms.\n

\n• Friday and Saturday bookings 2 weeks’ notice would be required.\n

\n• Sunday to Thursday bookings we would require notification by 6pm two days prior to your arrival date.\n

\nSpa relaxation hamper includes massage candles, facial compress towels, Mini Hyol and Base box cleanser, face and body cream samples. Products will be alternated and the exact items cannot be guaranteed.\n* Park Farm Hotel holds private functions along with discos most weekends which finish between midnight and 1:00am. All residents not attending functions are generally allocated rooms as far away as possible to minimise any disturbance, although this cannot be guaranteed.

", "min_stay_length": 1, "min_price": 20, "max_stay_length": 28, "enabled": 1, "lead_time_min": null, "default_nights": 1, "name": "another etseset #2", "min_price_for_default_occupancy": 120, "first_bookable_date": "2019-09-02", "default_occupancy": 3, "show_via_hotel": 1 }, "head": { "related": { "occupancies": { "body": [ { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "default": true, "infant": 0, "description": "2 adults", "child": 0, "adult": 2, "id": 3 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/offers/36238/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability?product_id=36238" }, "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 } ], "head": { "type": "nights" }, "href": "https://example.allocate.co.uk/api/v2/offers/36238/nights" }, "images": { "body": [], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/offers/36238/images/" } }, "type": "offer" }, "href": "https://example.allocate.co.uk/api/v2/offers/36238" }, { "body": { "lead_time_max": null, "show_via_portal": 1, "discount_percentage": "0", "available_to": "2018-12-23", "description": "", "price_description": null, "id": "35922", "terms_and_conditions": "", "min_stay_length": 1, "min_price": 20, "max_stay_length": 28, "enabled": 1, "lead_time_min": null, "default_nights": 1, "name": "Another test", "min_price_for_default_occupancy": 120, "first_bookable_date": "2019-09-02", "default_occupancy": 3, "show_via_hotel": 1 }, "head": { "related": { "occupancies": { "body": [ { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "default": true, "infant": 0, "description": "2 adults", "child": 0, "adult": 2, "id": 3 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/offers/35922/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability?product_id=35922" }, "nights": { "body": [ { "name": "1 Night", "id": 1 }, { "name": "2 Nights", "default": true, "id": 2 }, { "name": "3 Nights", "id": 3 }, { "name": "4 Nights", "id": 4 } ], "head": { "type": "nights" }, "href": "https://example.allocate.co.uk/api/v2/offers/35922/nights" }, "images": { "body": [ { "body": { "href": "https://ucarecdn.com/69967774-2c21-4391-af25-7ad473212bdb/", "type": "uploadcare" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/offers/35922/images/44358" } ], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/offers/35922/images/" } }, "type": "offer" }, "href": "https://example.allocate.co.uk/api/v2/offers/35922" }, { "body": { "lead_time_max": null, "show_via_portal": 1, "discount_percentage": "10", "available_to": "2018-12-23", "description": "

Exclusive free late checkout for a limited time only.

\nEscape this Summer at Park Farm Hotel.\n

\nYour arrival will be enhanced with a bottle of chilled Prosecco and a relaxing Spa hamper. Then dine in style with three course dinner in our restaurant from our Menu Du Jour. Full English breakfast each morning will have you perfectly prepared for the day ahead, and complimentary use of our extensive leisure facilities is of course available at your convenience. Free late checkout is also included.

", "price_description": null, "id": "35924", "terms_and_conditions": "

The above rates are based on two people sharing a twin/double room. Exclusion dates may apply. Not applicable for use in conjunction with any other offer. Children may share their parents (Deluxe rooms only) at a cost of £15 per child per night inclusive of full English breakfast only. Prosecco and spa hamper are only included once during your stay. Your package includes three courses from our Seasons Menu. Should you wish to dine from our A La Carte menu you would receive a £28 per person allowance. Any additional costs would be charged to your bedroom account for payment upon your departure. Single room rates are not applicable on this offer. This offer may be withdrawn or altered at any time. (Valid from 1st June 2018 to 30th September 2018) A charge of £75 per room is made should your cancellation or amendment not meet the following terms.\n

\n• Friday and Saturday bookings 2 weeks’ notice would be required.\n

\n• Sunday to Thursday bookings we would require notification by 6pm two days prior to your arrival date.\n

\nSpa relaxation hamper includes massage candles, facial compress towels, Mini Hyol and Base box cleanser, face and body cream samples. Products will be alternated and the exact items cannot be guaranteed.\n* Park Farm Hotel holds private functions along with discos most weekends which finish between midnight and 1:00am. All residents not attending functions are generally allocated rooms as far away as possible to minimise any disturbance, although this cannot be guaranteed.

", "min_stay_length": 1, "min_price": 20, "max_stay_length": 28, "enabled": 1, "lead_time_min": null, "default_nights": 1, "name": "another etseset", "min_price_for_default_occupancy": 120, "first_bookable_date": "2019-09-02", "default_occupancy": 3, "show_via_hotel": 1 }, "head": { "related": { "occupancies": { "body": [ { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "default": true, "infant": 0, "description": "2 adults", "child": 0, "adult": 2, "id": 3 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/offers/35924/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability?product_id=35924" }, "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 } ], "head": { "type": "nights" }, "href": "https://example.allocate.co.uk/api/v2/offers/35924/nights" }, "images": { "body": [], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/offers/35924/images/" } }, "type": "offer" }, "href": "https://example.allocate.co.uk/api/v2/offers/35924" }, { "body": { "lead_time_max": null, "show_via_portal": 1, "discount_percentage": "10", "available_to": "2025-11-05", "description": "

book more than 7 days in advance and get 10% discount

", "price_description": null, "id": "31276", "terms_and_conditions": "", "min_stay_length": 0, "min_price": 20, "max_stay_length": 28, "enabled": 1, "lead_time_min": 7, "default_nights": 2, "name": "Advanced purchase", "min_price_for_default_occupancy": 120, "first_bookable_date": "2019-09-09", "default_occupancy": 3, "show_via_hotel": 1 }, "head": { "related": { "occupancies": { "body": [ { "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": 0, "description": "2 adults, 3 children", "child": 3, "adult": 2, "id": 17 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/offers/31276/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability?product_id=31276" }, "nights": { "body": [ { "name": "1 Night", "id": 1 }, { "name": "2 Nights", "default": true, "id": 2 }, { "name": "3 Nights", "id": 3 } ], "head": { "type": "nights" }, "href": "https://example.allocate.co.uk/api/v2/offers/31276/nights" }, "images": { "body": [], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/offers/31276/images/" } }, "type": "offer" }, "href": "https://example.allocate.co.uk/api/v2/offers/31276" }, { "body": { "lead_time_max": null, "show_via_portal": 1, "discount_percentage": "0", "available_to": "2014-03-04", "description": "

dsa dasd sad

", "price_description": null, "id": "27899", "terms_and_conditions": "", "min_stay_length": 4, "min_price": 20, "max_stay_length": 4, "enabled": 1, "lead_time_min": null, "default_nights": 4, "name": "week 4 nights asdsad ", "min_price_for_default_occupancy": 120, "first_bookable_date": "2019-09-02", "default_occupancy": 3, "show_via_hotel": 1 }, "head": { "related": { "occupancies": { "body": [ { "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 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/offers/27899/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability?product_id=27899" }, "nights": { "body": [{ "name": "4 Nights", "id": 4 }], "head": { "type": "nights" }, "href": "https://example.allocate.co.uk/api/v2/offers/27899/nights" }, "images": { "body": [], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/offers/27899/images/" } }, "type": "offer" }, "href": "https://example.allocate.co.uk/api/v2/offers/27899" } ], "head": { "related": { "options": { "head": { "related": { "occupancies": { "body": [ { "infant": 0, "description": "1 adult", "child": 0, "adult": 1, "id": 2 }, { "default": true, "infant": 0, "description": "2 adults", "child": 0, "adult": 2, "id": 3 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/offers/occupancies/" }, "nights": { "head": { "type": "nights" }, "body": [ { "name": "1 Night", "default": true, "id": 1 }, { "name": "2 Nights", "id": 2 }, { "name": "3 Nights", "id": 3 } ], "href": "nights" } } }, "body": { "skip_option": "none", "default_nights": 1, "suffix": ["Room", "Rooms"], "first_bookable_date": "2019-09-02", "max_rooms_per_booking": 3 } }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability/" } }, "type": "special_offers" } } ``` {% endtab %} {% endtabs %} ## 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 | {% tabs %} {% tab title="200 List of rooms in body." %} ```javascript { "body": [ { "body": { "max_rooms_per_booking": 3, "avail_by_occupancy": 0, "name": "Family room", "default_nights": 2, "suffix": ["Room", "Rooms"], "description": "

Our family rooms are all on the ground floor and have French doors onto our enclosed courtyard. The double bed is screened from the single beds for extra privacy. Mini bars are stocked with milk as well as the usual bar selection. A microwave is provided for heating baby food or milk.

", "amount": 100, "is_apartment": 0, "id": 149, "default_occupancy": 3 }, "head": { "related": { "occupancies": { "href": "https://example.allocate.co.uk/api/v2/rooms/149/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability/?room_id=149" }, "images": { "body": [ { "body": { "href": "https://ucarecdn.com/8d2fb819-8224-411e-a6d9-942120193ec4/", "type": "uploadcare" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/rooms/149/images/64250" } ], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/rooms/149/images/" } }, "type": "room" }, "href": "https://example.allocate.co.uk/api/v2/rooms/149" }, { "body": { "max_rooms_per_booking": 3, "avail_by_occupancy": 0, "name": "Superior Double room", "default_nights": 2, "suffix": ["Room", "Rooms"], "description": "

The Superior double rooms are in the secluded annexe and have fantastic views. Each has its own cinema system. Bathrooms have multi jet showers and spa baths. Each of these 3 rooms have distinctive beds, either sleigh or four poster.

", "amount": 100, "is_apartment": 0, "id": 5179, "default_occupancy": 3 }, "head": { "related": { "occupancies": { "href": "https://example.allocate.co.uk/api/v2/rooms/5179/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability/?room_id=5179" }, "images": { "body": [ { "body": { "href": "https://ucarecdn.com/3ea95141-2ed7-4e7b-9f7c-c30d5535830e/", "type": "uploadcare" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/rooms/5179/images/64251" } ], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/rooms/5179/images/" } }, "type": "room" }, "href": "https://example.allocate.co.uk/api/v2/rooms/5179" }, { "body": { "max_rooms_per_booking": 3, "avail_by_occupancy": 0, "name": "", "default_nights": 2, "suffix": ["Room", "Rooms"], "description": "

sdfsdfsf

", "amount": 6, "is_apartment": 0, "id": 6783, "default_occupancy": 3 }, "head": { "related": { "occupancies": { "href": "https://example.allocate.co.uk/api/v2/rooms/6783/occupancies/" }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability/?room_id=6783" }, "images": { "body": [], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/rooms/6783/images/" } }, "type": "room" }, "href": "https://example.allocate.co.uk/api/v2/rooms/6783" } ], "head": { "related": { "options": { "head": { "related": { "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 } ], "head": { "type": "occupancies" }, "href": "https://example.allocate.co.uk/api/v2/rooms/occupancies/" } } }, "body": { "skip_option": "none", "default_nights": 2, "suffix": ["Room", "Rooms"], "first_bookable_date": "2019-09-02", "max_rooms_per_booking": 3 } }, "availability": { "href": "https://example.allocate.co.uk/api/v2/availability/" } }, "type": "rooms" } } ``` {% endtab %} {% endtabs %} ## Extras `GET` `https://example.allocate.co.uk/api/v2/extras/` List all extras available at this property. #### Path Parameters | Name | Type | Description | | ---- | ------ | ----------- | | | string | | {% tabs %} {% tab title="200 " %} ```javascript { "body": [ { "body": { "show_via_portal": 1, "category_id": 11, "lead_time_max": null, "per_night": 0, "position": null, "prototype_id": null, "description": "

Why not start your stay with us with a bottle of one of France's Premier Champagnes and a box of Belgium's best dark chocolates. only

", "package_only": 0, "minimum": null, "price_description": "", "id": 1519, "min_stay_length": 1, "terms_and_conditions": "", "max_stay_length": 21, "maximum": 1, "per_person": 0, "lead_time_min": null, "enabled": 1, "hotel_id": 66, "name": "Champagne and Chocolates", "accounting_item": null, "default_selection": 0, "show_via_hotel": 1 }, "head": { "related": { "images": { "body": [ { "body": { "href": "https://ucarecdn.com/4d8a5b48-dee1-4fa0-9ba7-c627f92bc752/", "type": "uploadcare" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/extras/1519/images/10340" }, { "body": { "href": "https://ucarecdn.com/29cba68c-66aa-4473-8cb5-a722a8742659/", "type": "uploadcare" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/extras/1519/images/10339" }, { "body": { "href": "https://ucarecdn.com/72584db4-86d9-4a1f-a7db-59639272d7e0/", "type": "uploadcare" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/extras/1519/images/10341" }, { "body": { "href": "https://ucarecdn.com/b076a0f6-a663-4448-9b85-a0afb32b8005/", "type": "uploadcare" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/extras/1519/images/10342" } ], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/extras/1519/images/" } }, "type": "extra" }, "href": "https://example.allocate.co.uk/api/v2/extras/1519" }, { "body": { "show_via_portal": 1, "category_id": null, "lead_time_max": null, "per_night": 0, "position": 0, "prototype_id": null, "description": "

Refundable Security Deposit

", "package_only": 1, "minimum": null, "price_description": "Per use", "id": 31762, "min_stay_length": 1, "terms_and_conditions": "", "max_stay_length": 21, "maximum": 20, "per_person": 0, "lead_time_min": null, "enabled": 1, "hotel_id": 66, "name": "Security Deposit", "accounting_item": "", "default_selection": 0, "show_via_hotel": 1 }, "head": { "related": { "images": { "body": [], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/extras/31762/images/" } }, "type": "extra" }, "href": "https://example.allocate.co.uk/api/v2/extras/31762" }, { "body": { "show_via_portal": 1, "category_id": 9, "lead_time_max": null, "per_night": 0, "position": 0, "prototype_id": null, "description": "

Enjoy a special dinner in our renowned restaurant.

", "package_only": 0, "minimum": null, "price_description": "Per use", "id": 1520, "min_stay_length": 1, "terms_and_conditions": "

If you are staying more than 1 night please let us know which night(s) you wish to take dinner in the Additional requests field on the next screen.

", "max_stay_length": 21, "maximum": 20, "per_person": 0, "lead_time_min": null, "enabled": 1, "hotel_id": 66, "name": "Olive Tree Dinner", "accounting_item": "", "default_selection": 0, "show_via_hotel": 1 }, "head": { "related": { "images": { "body": [ { "body": { "href": "https://ucarecdn.com/f308204b-5ac1-41ec-96d1-916c6525da35/", "type": "uploadcare" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/extras/1520/images/10343" } ], "head": { "type": "images" }, "href": "https://example.allocate.co.uk/api/v2/extras/1520/images/" } }, "type": "extra" }, "href": "https://example.allocate.co.uk/api/v2/extras/1520" } ], "head": { "type": "extras" } } ``` {% endtab %} {% endtabs %} ## Stay Types `GET` `https://example.allocate.co.uk/api/v2/staytypes/` List of stay types available at this property. {% tabs %} {% tab title="200 " %} ```javascript { "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" } } ``` {% endtab %} {% endtabs %} ## Images `GET` `https://example.allocate.co.uk/api/v2/images/` Images to display of the property. {% tabs %} {% tab title="200 " %} ```javascript { "body": [ { "body": { "href": "https://d1eiaac68kzo6p.cloudfront.net/api/file/PGfQbkLSTWFaOBNhCYCw", "type": "filepicker" }, "head": { "type": "image" }, "href": "https://example.allocate.co.uk/api/v2/images/11096" } ], "head": { "type": "images" } } ``` {% endtab %} {% endtabs %} ## Countries `GET` `https://example.allocate.co.uk/api/v2/countries/` List countries that can be picked for this property. {% tabs %} {% tab title="200 A list of countries" %} ``` { "body": [ { "name": "United Kingdom", "symbol": "gb", "postal_code": null, "region_name": null, "head": { "type": "country" }, "href": "https://example.allocate.co.uk/api/v2/countries/1" } ] } ``` {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.allocate.co.uk/api/property-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.