View on GitHub

api-documentation

RESTful API for MyTourist

Back to overview


Price Rates

This API endpoint let you manage your price rates. Most useful to fetch price rates per roomtype.

Index:

List all price rates

Get a list of all price rates inside a roomtype.

GET https://app.mytourist.cloud/api/v1/price-rates

Query Parameters

roomtype_idoptional (recommended)The API will only return the results for this particular roomtypes.
languageoptionalISO 639-1

Example result

[
    {
        "id":"23192010281",
        "default_price_per_night":"70.00",
        "price_per_night_percentage":false,
        "...":"..."
    },
    {
        "id":"23192011041",
        "parent_id":"23192010281",
        "roomtype_id":"23192010281",
        "internal_name":"Long weekend",
        "public_name":{
            "nl" : "Lang weekend",
            "en" : "Verlängertes Wochenende",
            ".." : ""
        },
        "note":"This rate is only bookable in the weekends. Based on the main price with -10%",
        "enabled_for_booking_engine":true,  
        "persons":2,                        
        "min_stay":4,
        "max_stay":null,
        "closed_on_arrival":"mo,tu,we,th,sa,su",
        "closed_on_departure":"tu,we,th,fr,sa",
        "default_price_per_night":"10.00", 
        "price_per_night_percentage":true,
        "arrangement_products_inclusive":[
            {
                "id":"231920110418",
                "name":{
                    "nl":"Ontbijt"
                },
                "calculation_methods":["person","night"]
            }
        ],
        "translated_at":"2020-11-04 13:21:29",
        "created_at":"2020-11-04 12:21:29",
        "updated_at":"2020-11-04 12:21:29"
    }
]

Retrieve a single price rate

Same result as above but than a particular single price rate wil returned in json. The same parameters can be used as the list endpoint.

GET https://app.mytourist.cloud/api/v1/price-rates/{RATE_ID}

Results explained

parent_idWhen rate is acting as sub price rate. (cleaner calendar and possibility to change price in percentages)
public_nameWhen rate is visible inside the booking engine we automatically translate your manually given name into +/- 15 languages.
enabled_for_booking_engineShow rate publicly inside your booking engine
closed_on_arrivalNo arrival possible at this day; mo,tu,we,th,fr,sa,su
closed_on_departureNo departure possible at this day; mo,tu,we,th,fr,sa,su
default_price_per_nightDefault price per night in euro's or in percentages.
price_per_night_percentagePrice value is percentage (only available when sub rate)