Special Offers

The tabs booking system allows an agency to add special offers onto properties in order to reduce the price of particular holidays. This special offer data is available via the API in a number of ways.

Finding Properties with Special Offers

You are able to get a list of properties that have special offers on using the specialOffer filter

http://<APIROOT>/property?filter=specialOffer=true

The specialOffer filter can also be combined with other filters in order to return more specific searches. eg.

http://<APIROOT>/property?filter=specialOffer=true&accommodates=2

More examples are available on the Performing-a-property-search page

Getting a list of special offers associated with a given property

Details of any special offers are included in the JSON returned from both /property and /property/ endpoints. eg.

"specialOffers": [
    {
        "propref": "mousecott",
        "fromDate": "2012-06-09",
        "toDate": "2012-07-14",
        "description": "10% discount for full week stays between 9 June and 14 July 2012",
        "type": "%",
        "amount": 10
    },
    {
        "propref": "mousecott",
        "fromDate": "2012-07-14",
        "toDate": "2012-07-21",
        "description": "50% discount for full week stays between 14 July 2012 and 21 July 2012",
        "type": "%",
        "amount": 50
    }
]

Special Offer Types

• % - This discount removes the specified percentage from the basic holiday price
• £ - This discount removes the specified amount from the basic holiday price
• S - This discount will offer a week holiday for the same price as a short break (3 nights)
• P - This discount sets the basic holiday price to the specified amount
• B - This discount will treat the current week as a different price band

Getting a price with a special offer applied

All prices returned when you create either a booking-enquiry or booking will automatically have the special offer applied to the basicPrice field, so you don't need to do any calculation yourself. The amount discounted will also be shown in the specialOffer node:

{
    "id": "mousecott_ss",
    "propertyRef": "mousecott",
    "brandCode": "SS",
    "fromDate": "2012-07-01",
    "toDate": "2012-07-08",
    "partySize": 5,
    "pets": 2,
    "available": true,
    "price": {
        "outstandingBalance": 168.45,
        "basicPrice": 123.45,
        "extras": {
            "PET": {
                "quantity": 2,
                "description": "Pet Fee",
                "price": 10.00,
                "totalPrice": 20.00,
                "type": "compulsory"
            },
            "BKFE": {
                "quantity": 1,
                "description": "Booking Fee",
                "price": 25.00,
                "totalPrice": 25.00,
                "type": "compulsory"
            }
        },
        "totalPrice": 168.45,
        "securityDeposit": 100.00,
        "depositAmount": 100.00,
        "specialOffer": {
            "saving": 10.00
        }
    }
}