The purpose of this guide is to provide you with all the necessary details in order for you to successfully integrate with our API.
\nIn case of any technical question, please feel free to contact us at b2b.tech@weski.com.
\nAll requests need to be authenticated using two headers:
\nPartnerID
\nPartnerToken
\nThere's no need to automatically refresh the token.
\nContact us to get your credentials.
\nThere's a sandbox environment for you to use for integration and tests. Once ready to go live, we'll go through a quick certification process, after which your credentials will be activated in the production environment.
\nSandbox: https://sandbox-b2b.weski.com/api/v1
\nProduction: https://b2b.weski.com/api/v1
\nDescription: The request contains invalid or missing parameters. This can occur if:
\nA required parameter is missing or invalid.
\nThe bookingReferenceToken is incorrect, invalid, or expired.
The field parameter (or any other required parameter) is incorrect or missing.
{ \"error\": \"BadRequest\", \"message\": \"Invalid 'field' parameter. Please check the provided parameters and try again.\"}
\n{ \"error\": \"BadRequest\", \"message\": \"The 'bookingReferenceToken' is invalid or expired. Please provide a valid token.\"}
\nDescription: Authentication required. All requests need to include the following headers:
\nPartnerID
PartnerToken
{ \"error\": \"Unauthorized\", \"message\": \"Authentication required. Please provide valid 'PartnerID' and 'PartnerToken'.\"}
\nDescription: Forbidden request has been made.
\n{ \"error\": \"Forbidden\", \"message\": \"This partner does not have access to this endpoint. Try sandbox environment or contact us.\"}
\nDescription: Too many requests have been made in a short period. This can occur if:
\n{ \"error\": \"TooManyRequests\",
\"message\": \"Too many requests. Please try again later.\" }
Description: The requested resource could not be found. This can occur if:
\nThe resource ID (e.g., accommodationID, destinationID, rateCode) is incorrect or does not exist.
The pageToken is invalid or expired.
The requested resource (e.g., accommodation availability, booking details) cannot be found with the provided parameters.
\n{ \"error\": \"NotFound\", \"message\": \"'resource' not found. The provided 'resource' does not exist or is invalid.\"}
\nDescription: 5xx errors indicate that the issue is on our server side, not related to the user's request.
\nWhat to do in case of a 5xx error: If you encounter a 5xx error, please contact us for assistance.
\nThis endpoint is supposed to be used in real-time, on every search.
\nPlease note, ski days are not necessarily the same as trip dates. Make sure to provide the first day of ski and the duration (number of ski days).
\nExact child ages are needed as the pricing depends on the actual skier age. Any skier below 18 y/o is considered a child.
\nAs a response, you'll receive the list of relevant ski passes, alongside their IDs, static details, total price and price breakdown.
\nMake sure to save the ID and the total price as you'll need it later for the booking.
\nPlease note, all prices are NET prices for you to pay.
\nThere are two types of skipasses:
\nThis endpoint actually creates the booking.
\nMake sure to pass the same ID, start date, duration and expected price as received during the search request.
\nIn case of any discrepancy, booking request will be rejected.
\nPlease note, prices might change - fetching a price from the /search endpoint doesn't save it until the booking. If the price will change, your booking will be rejected to avoid any non-confirmed charges.
\nUpon successful booking, you will receive our bookingID as a response, use it later to retrieve all the necessary information about your booking.
It takes time to process skipass booking requests and many bookings might not be processed right away and might take up to a few weeks to handle.
\nFor better management of expectations with your customers, we recommend letting them know that all the necessary details will be provided to them up to 7 days before their trip, or within 48 hours in case of a last minute booking.
\nOnce a booking is fully processed on our end, we can send you a simply webhook notification (POST request) in the following format:
\n{\n \"bookingID\": \"kasjdg2823\",\n \"status\": \"booked\"\n}\n\nReceiving status 200 as a response will be considered a success. Otherwise, we might retry sending up to 3 retries.
\nUpon receiving the webhook, or at any other time at your convenience, you can access this endpoint using the bookingID to get all the details needed for your customer to obtain his skipass.
There are two types of skipasses: QR and eVoucher.
\nIn case of a QR code, you should generate a QR code using the provided bookingReference(not the bookingID).
For eVoucher, simply provide the customer with the bookingReference.
You'll be provided with kioskLocation which is a link to Google Maps with relevant kiosk locations, and specialInstructions to help your customers better navigate the process.
Use this endpoint to cancel a booking.
\nPlease note that last-minute cancellations might be subject to charges according to your commercial agreement.
\n","urlObject":{"path":["api","v1","skipass","booking","BOOKING_ID"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a291c768-3bc5-402d-917e-868e47e712fb"}],"id":"0379c415-dbcb-4436-9567-d827b343251f","_postman_id":"0379c415-dbcb-4436-9567-d827b343251f","description":""},{"name":"Common","item":[{"name":"Get all destinations","event":[{"listen":"test","script":{"id":"9a1eff3c-1cee-4283-ab15-79ab254a1266","exec":[""],"type":"text/javascript","packages":{}}}],"id":"81c1033c-0382-42d6-828d-a4489d3a567c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept-encoding":true}},"request":{"method":"GET","header":[{"key":"PartnerID","value":"sandbox","type":"text"},{"key":"PartnerToken","value":"sandbox","type":"text"},{"key":"Accept-Encoding","value":"gzip, deflate","type":"text"}],"url":"{{URL}}/api/v1/common/destinations","description":"This endpoint retrieves an array of all destinations.
\ndestinations (array):
An array of destination objects, where each object represents a ski area, resort, village or country, and contains the following fields:
\nid (string):
The unique identifier of the destination.
\nname (string):
The name of the destination (e.g., \"Val Thorens\").
type (string):
The type of destination. Possible values:
\n\"ski_area\"
\"resort\"
\"village\"
\"country\"
parentID (string or null):
The ID of the parent destination:
\nFor villages: The ID of the parent resort.
\nFor resorts: the ID of the ski area, if the resort belongs to one.
\nnull if this is a top-level destination, such as:
a ski area
\na resort that is not part of a ski area
\ngeo (object):
An object containing geographical and country-related information:
\ncountry (object):
code (string): ISO country code (e.g., \"FR\").
name (string): Country name (e.g., \"France\").
For villages and **resorts (**if they do not contain villages), the geo object may include:
center (object):
The geographical center of the destination:
\nlat (number): Latitude.
lng (number): Longitude.
polygon (array of objects):
A list of geographical boundary points:
\nlat (number): Latitude.
lng (number): Longitude.
Note:
\nIf a resort contains villages, the resort will not have center and polygon fields — these will be defined at the village level only.
If a resort does not contain villages, it may include center and polygon.
This endpoint's response can be cached on the client's end and updated periodically, as the data won't change unless new destinations are added.
\n","urlObject":{"path":["api","v1","common","destinations"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"b849bbe8-f74c-426b-ac81-c4548dcec7ca","name":"Get all ski destinations","originalRequest":{"method":"GET","header":[{"key":"PartnerID","value":"sandbox","type":"text"},{"key":"PartnerToken","value":"sandbox","type":"text"},{"key":"Accept-Encoding","value":"gzip, deflate","type":"text"}],"url":"https://sandbox-b2b.weski.com/api/v1/common/destinations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"destinations\": [\n {\n \"id\": \"skiArea-1\",\n \"name\": \"Three Valleys\",\n \"type\": \"ski_area\",\n \"parentID\": null,\n \"geo\": {\n \"country\": {\n \"code\": \"FR\",\n \"name\": \"France\"\n }\n }\n },\n {\n \"id\": \"resort-1\",\n \"name\": \"Val Thorens\",\n \"type\": \"resort\",\n \"parentID\": \"skiArea-1\",\n \"geo\": {\n \"country\": {\n \"code\": \"FR\",\n \"name\": \"France\"\n }\n }\n },\n {\n \"id\": \"resort-3\",\n \"name\": \"Tignes\",\n \"type\": \"resort\",\n \"parentID\": \"skiArea-1\",\n \"geo\": {\n \"country\": {\n \"code\": \"FR\",\n \"name\": \"France\"\n },\n \"center\": {\n \"lat\": 45.2566579,\n \"lng\": 6.2598896\n },\n \"polygon\": [\n {\n \"lat\": 45.255087,\n \"lng\": 6.2759185\n },\n {\n \"lat\": 45.2550875,\n \"lng\": 6.2759185\n },\n {\n \"lat\": 45.2587575,\n \"lng\": 6.2756073\n },\n {\n \"lat\": 45.2605246,\n \"lng\": 6.2734723\n },\n {\n \"lat\": 45.2598601,\n \"lng\": 6.2494397\n }\n ]\n }\n },\n {\n \"id\": \"village-277\",\n \"name\": \"La Toussuire\",\n \"type\": \"village\",\n \"parentID\": \"resort-1\",\n \"geo\": {\n \"country\": {\n \"code\": \"FR\",\n \"name\": \"France\"\n },\n \"center\": {\n \"lat\": 45.2566579,\n \"lng\": 6.2598896\n },\n \"polygon\": [\n {\n \"lat\": 45.255087,\n \"lng\": 6.2759185\n },\n {\n \"lat\": 45.2550875,\n \"lng\": 6.2759185\n },\n {\n \"lat\": 45.2587575,\n \"lng\": 6.2756073\n },\n {\n \"lat\": 45.2605246,\n \"lng\": 6.2734723\n },\n {\n \"lat\": 45.2598601,\n \"lng\": 6.2494397\n }\n ]\n }\n }\n ]\n}"}],"_postman_id":"81c1033c-0382-42d6-828d-a4489d3a567c"}],"id":"66d5f87c-d790-4bb6-ac88-abb5217aa4ac","_postman_id":"66d5f87c-d790-4bb6-ac88-abb5217aa4ac","description":""},{"name":"Accommodation","item":[{"name":"Content","item":[{"name":"Get accommodations IDs by Destination","event":[{"listen":"test","script":{"id":"7f4309f4-4cef-40c5-8d3c-7d8b643b2b41","exec":[""],"type":"text/javascript","packages":{}}}],"id":"d6712191-5d9a-41db-b191-e36fdd7825aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PartnerID","value":"sandbox","type":"text"},{"key":"PartnerToken","value":"sandbox","type":"text"},{"key":"Accept-Encoding","value":"gzip, deflate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"destinationID\": \"resort-3\"\n// \"dateAddedSince\": \"2021-01-01T00:00:00Z\"\n// \"dateUpdatedSince\": \"2024-01-01T00:00:00Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/accommodation/content/ids","description":"This endpoint retrieves a list of accommodation IDs based on the provided parameters.
\nThe parameters for the request should be sent in the body as a JSON object. The request body should include the following fields:
\ndestinationID (required, string): The ID of the destination for which the accommodations are located.
\ndateAddedSince (optional, string): Filter the results based on the date added since this timestamp.
\ndateUpdatedSince (optional, string): Filter the results based on the date updated since this timestamp.
\n{\n \"destinationID\": \"resort-3\",\n \"dateAddedSince\": \"2024-01-01T00:00:00Z\",\n \"dateUpdatedSince\": \"2024-01-01T00:00:00Z\"\n}\n\nThe response will contain an array of accommodations, where each item includes the following information:
\nid (string): The ID of the accommodation.
\nname (string): The name of the accommodation.
\ntype (string): The type of the accommodation.
\ngeo (object): The geographical coordinates (latitude and longitude) of the property.
\nlat (number): The latitude of the accommodation.
\nlng (number): The longitude of the accommodation.
\n{\n \"accommodationIds\": [\n {\n \"id\": \"AZ42244\",\n \"name\": \"Pierre & Vacances Premium residence La Ginabelle\",\n \"type\": \"Apartment\",\n \"geo\": {\n \"lat\": 45.92398,\n \"lng\": 6.87363\n }\n },\n {\n \"id\": \"4569032\",\n \"name\": \"Hotel Marielle\",\n \"type\": \"Hotel\",\n \"geo\": {\n \"lat\": 45.296568,\n \"lng\": 45.296568\n }\n },\n {\n \"id\": \"14E5473\",\n \"name\": \"SOWELL COLLECTION Hôtel des Dromonts\",\n \"type\": \"Hotel\",\n \"geo\": {\n \"lat\": 46.189546,\n \"lng\": 6.777754\n }\n },\n {\n \"id\": \"1453290\",\n \"name\": \"Le Bois du Bouchet\",\n \"type\": \"Apartment\",\n \"geo\": {\n \"lat\": 45.92874531645409,\n \"lng\": 6.879808106151586\n }\n }\n ],\n \"nextPageToken\": \"Eja8lbOq6qd8oqmwhHj68tiiQUKZHMag\"\n}\n\nThe response will include the list of accommodations along with their IDs, names, types, and geographical coordinates.
\nnextPageToken can be used to fetch the next set of data. To fetch the next page, pass this token as the pageToken parameter in the next request. If no nextPageToken is included in the response, it means there are no more pages to fetch for this request.nextPageTokenIf there are more results available, the nextPageToken will be provided in the response. To fetch the next set of results, include the nextPageToken as the pageToken parameter in the next request. For example:
{\n \"pageToken\": \"Eja8lbOq6qd8oqmwhHj68tiiQUKZHMag\"\n}\n\nBy including the nextPageToken from the previous response as the pageToken in the next request, you will receive the next page of accommodation IDs.
When fetching the next page of results, the pageToken should be the only key specified in the next request body. No other parameters from the original request should be included.
If the nextPageToken is not provided in the response, it indicates that there are no more pages of data to fetch for the current request.
This HTTP POST request is used to retrieve the static content of the requested accommodations by sending a list of accommodation IDs to the specified endpoint.
\nThe request body should contain a list of accommodation IDs for which the static content is requested. Each request can include up to 50 accommodation IDs. If you need to retrieve content for more than 50 accommodations, multiple requests should be made.
\n{\n \"accommodationIDs\": [\n \"AZ42244\",\n \"4569032\",\n \"12345\",\n \"67890\",\n \"111213\"\n ]\n}\n\nThe response will contain detailed information about the accommodations, including their IDs, names, types, descriptions, locations, check-in/out details, additional information such as stars, phone, reception details, rentable units, facilities, and images. The structure of the response will be an array of objects, with each object representing an accommodation and its corresponding static content.
\nThe static content for each accommodation will include main information, additional information, rentable units, facilities, and images. Each accommodation's static content will be structured in a nested format to provide comprehensive details about the accommodation.
\nExample response:
\n{\n \"accommodations\": [\n {\n \"id\": \"AZ42244\",\n \"mainInfo\": {\n \"name\": \"Pierre & Vacances Premium residence La Ginabelle\",\n \"type\": \"Apartment\",\n \"description\": \"La Ginabelle is ideally located in the centre of Chamonix, allowing you to enjoy the bustle of the resort with its pedestrianized streets, shops and restaurants. Enjoy a holiday in the heart of the Alps in the apartments of this luxurious 4-star residence overlooking Mont Blanc.\\n\\nChildren have their own play area in the warm and welcoming reception lounge with its impressive fireplace.\\n\\nThe residence has its own Deep Nature Spa and indoor heated pool, cardio fitness studio, saunas and hammams to guarantee you a relaxing stay.\",\n \"location\": {\n \"address\": \"Rue du Soleil 34, Val Thorens, France\",\n \"geo\": {\n \"center\": {\n \"lat\": 45.29692,\n \"lng\": 6.576937\n }\n },\n \"distances\": {\n \"ski\": 900,\n \"center\": 350\n },\n \"zip\": 73440,\n \"parentDestinationID\": \"village-89\",\n \"attractions\": \"Distances are displayed to the nearest 0.1 mile and kilometer. <br /> <p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Parish Church of St. Antonius - 0.6 km / 0.4 mi <br /> Dias Cable Car - 0.8 km / 0.5 mi <br /> See Ski Resort - 8.5 km / 5.3 mi <br /> High-Bike Testcenter Paznaun - 9.3 km / 5.8 mi <br /> Silvretta Cable Car - 10.9 km / 6.8 mi <br /> Silvretta Arena - 11.2 km / 7 mi <br /> Lattejoch - 12.4 km / 7.7 mi <br /> Bodenalpbahn Ski Lift - 15.3 km / 9.5 mi <br /> Paznauner Thaya Ski Lift - 15.9 km / 9.9 mi <br /> Idalp - 18.8 km / 11.7 mi <br /> Alpinarium Galtuer -\n\nThe unique ID of the accommodation.
\nPrimary descriptive information about the accommodation.
\nname (string): Name of the accommodation.
\ntype (string): Type of accommodation (e.g., Hotel, Apartment).
\ndescription (string): Detailed textual description of the property.
\nlocation (object): Location-related data.
\naddress (string, optional): Full address of the accommodation.
\ngeo (object): Geographic coordinates.
\ndistances (object): Approximate distances to points of interest like the ski lift or town center.
\nzip (string/integer): ZIP/postal code.
\nparentDestinationID (string): Identifier of the parent destination.
\nattractions (string/html, optional): HTML-encoded list of nearby points of interest.
\ncheckInOutDetails (object, optional): Check-in and check-out times and instructions.
\ncheckIn:
\nfrom / to (string, optional): Allowed check-in times.
\ninstructions (string, optional): Instructions for late arrival.
\ncheckOut:
\nto (string, optional): Latest check-out time.
\ninstructions (string, optional): Additional instructions.
\nExtra details about the accommodation.
\nstars (integer, optional): Star rating.
\nphone (string, optional): Contact phone number.
\nreception (boolean, optional): Whether reception is available.attractions
\nagencyDetails (object, optional): Info about managing agency (e.g., address, phone).
\ntwentyFourSevenReception (boolean, optional): Whether the reception operates 24/7.
\nskiInOut (boolean, optional): Indicates ski-in/ski-out access.
\nmandatoryFees (array): List of compulsory charges such as tourist taxes.
\noptionalFees (array): Fees for optional services like parking or pets.
\npolicies (array): List of accommodation policies (e.g., cleaning, contactless check-in, safety measures).
\nA list of rentable units (rooms/apartments) within the accommodation.
\nEach item includes:
\nid (string): Unique ID of the rentable.
\nname (string): Name of the rentable unit.
\ndescription (string/html): Rich HTML description of the unit.
\nbathrooms / bedrooms / livingRooms / toilets (number): Layout breakdown.
\nsize (number, optional): Size in square meters.
\nlevels (number): Number of floors/levels.
\nvirtualTour (string): URL to a video/virtual tour.
\nbreakageDeposit (object, optional):
\namount (number): Deposit required.
\ncurrency (string): Currency code (e.g., EUR).
\nstructure (array): Description of bedding/room structure.
\nmax_occupancy (object):
\ntotal (number): Maximum total number of guests allowed.
\nadults (number): Maximum number of adults allowed.
\nchildren (number): Maximum number of children allowed.
\nmax_children_age (number, optional): Maximum age considered as a child.
\namenities (array): List of features and extras.
Each amenity include:
code (string): Type of amenity (e.g., tv, balcony).
displayName (string, optional): The display name of the amenity
\nchargeType (string):
\nINCLUDED
EXTRA_CHARGE
POTENTIAL_EXTRA_CHARGE
images (array):
\nList of image objects for the unit:
\nfullSizeUrl (string): Full-resolution image URL.
\nthumb720Url (string): Thumbnail image URL (720px width).
\nGeneral facilities available in the accommodation.
\nEach facility includes:
\ncode (string): Type of facility (e.g., wifi, sauna).
displayName (string, optional): Display name of the facility.
\nchargeType (string):
\nINCLUDED
EXTRA_CHARGE
POTENTIAL_EXTRA_CHARGE
General accommodation images, separate from rentable-specific ones.
\nfullSizeUrl (string): URL of the full-size image.
\nthumb720Url (string): URL of the 720px thumbnail version.
\nParish Church of St. Antonius - 0.6 km / 0.4 mi
Dias Cable Car - 0.8 km / 0.5 mi
See Ski Resort - 8.5 km / 5.3 mi
High-Bike Testcenter Paznaun - 9.3 km / 5.8 mi
Silvretta Cable Car - 10.9 km / 6.8 mi
Silvretta Arena - 11.2 km / 7 mi
Lattejoch - 12.4 km / 7.7 mi
Bodenalpbahn Ski Lift - 15.3 km / 9.5 mi
Paznauner Thaya Ski Lift - 15.9 km / 9.9 mi
Idalp - 18.8 km / 11.7 mi
Alpinarium Galtuer - 20.3 km / 12.6 mi
Birkhahn Cable Car - 20.7 km / 12.9 mi
Landeck Castle - 21.5 km / 13.3 mi
Silvretta-Hochalpenstraße - 22.8 km / 14.2 mi
Venet Gondola - 23.7 km / 14.7 mi
1 Double Bed and 1 Twin Bunk Bed
291-sq-foot individually decorated room, balcony with mountain views
Internet - Free WiFi
Entertainment - Flat-screen TV
Sleep - Blackout drapes/curtains and bed sheets
Bathroom - Private bathroom, shower, free toiletries, and a hair dryer
Practical - Safe, desk, and phone; rollaway/extra beds and free cribs/infant beds available on request
Comfort - Daily housekeeping
Non-Smoking
Parish Church of St. Antonius - 0.6 km / 0.4 mi
Dias Cable Car - 0.8 km / 0.5 mi
See Ski Resort - 8.5 km / 5.3 mi
High-Bike Testcenter Paznaun - 9.3 km / 5.8 mi
Silvretta Cable Car - 10.9 km / 6.8 mi
Silvretta Arena - 11.2 km / 7 mi
Lattejoch - 12.4 km / 7.7 mi
Bodenalpbahn Ski Lift - 15.3 km / 9.5 mi
Paznauner Thaya Ski Lift - 15.9 km / 9.9 mi
Idalp - 18.8 km / 11.7 mi
Alpinarium Galtuer - 20.3 km / 12.6 mi
Birkhahn Cable Car - 20.7 km / 12.9 mi
Landeck Castle - 21.5 km / 13.3 mi
Silvretta-Hochalpenstraße - 22.8 km / 14.2 mi
Venet Gondola - 23.7 km / 14.7 mi
1 Double Bed and 1 Twin Bunk Bed
291-sq-foot individually decorated room, balcony with mountain views
Internet - Free WiFi
Entertainment - Flat-screen TV
Sleep - Blackout drapes/curtains and bed sheets
Bathroom - Private bathroom, shower, free toiletries, and a hair dryer
Practical - Safe, desk, and phone; rollaway/extra beds and free cribs/infant beds available on request
Comfort - Daily housekeeping
Non-Smoking
This endpoint makes an HTTP GET request to retrieve the constants related to accommodation content in JSON format.
\nThe response of this request can be documented as a JSON schema to provide a structured description of the data format.
\n","urlObject":{"path":["api","v1","accommodation","content","constants"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"4805cf06-28fb-4e41-83fa-1b62bbeaaa06","name":"Get accommodation constants","originalRequest":{"method":"GET","header":[{"key":"PartnerID","value":"sandbox","type":"text"},{"key":"PartnerToken","value":"sandbox","type":"text"}],"url":"{{URL}}/api/v1/accommodation/content/constants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"accommodationFacilities\": [\n {\n \"code\": \"parking\",\n \"displayName\": \"Parking\",\n \"category\": \"transport\",\n \"popular\": true\n },\n {\n \"code\": \"wifi\",\n \"displayName\": \"WiFi Access\",\n \"category\": \"general\",\n \"popular\": true\n },\n {\n \"code\": \"laundry\",\n \"displayName\": \"Laundry\",\n \"category\": \"guest_services\",\n \"popular\": false\n }\n ],\n \"accommodationAmenities\": [\n {\n \"code\": \"microwave\",\n \"displayName\": \"Microwave\",\n \"category\": \"general\",\n \"popular\": true\n },\n {\n \"code\": \"heating\",\n \"displayName\": \"Heating\",\n \"categoryCode\": \"general\",\n \"popular\": false\n }\n ],\n \"chargeTypes\": [\n \"INCLUDED\",\n \"PER_ITEM\",\n \"PER_GUEST\",\n \"PER_NIGHT\",\n \"PER_GUEST_PER_NIGHT\",\n \"EXTRA_CHARGE\",\n \"POTENTIAL_EXTRA_CHARGE\"\n ],\n \"paymentTiming\": [\n \"PAY_ONLINE\",\n \"PAY_AT_PROPERTY\"\n ],\n \"accommodationTypes\": [\n \"Aparthotel\",\n \"Apartment\",\n \"Bed & breakfast\",\n \"Chalet\",\n \"Condo\",\n \"Guesthouse\",\n \"Holiday House\",\n \"Holiday Park\",\n \"Hostel/Backpacker accommodation\",\n \"Hotel\",\n \"Inn\",\n \"Lodge\",\n \"Pension\",\n \"Private vacation home\",\n \"Residence\",\n \"Resort\",\n \"Villa\"\n ],\n \"cancellationPolicy\": [\n \"NR\",\n \"FC\",\n \"TC\"\n ],\n \"penaltyTypes\": [\n \"FIXED\",\n \"PERCENT\"\n ],\n \"boardTypes\": {\n \"room_only\": \"RO\",\n \"breakfast\": \"BB\",\n \"catered_breakfast\": \"CB\",\n \"delivered_breakfast\": \"DB\",\n \"dinner_only\": \"DO\",\n \"catered_dinner\": \"CD\",\n \"delivered_dinner\": \"DD\",\n \"lunch_only\": \"LO\",\n \"catered_lunch\": \"CL\",\n \"delivered_lunch\": \"DL\",\n \"half_board\": \"HB\",\n \"catered_half_board\": \"CHB\",\n \"delivered_half_board\": \"DHB\",\n \"full_board\": \"FB\",\n \"fully_catered\": \"FC\",\n \"delivered_full_board\": \"DFB\",\n \"all_inclusive\": \"AI\"\n },\n \"currencies\": [\n \"GBP\",\n \"EUR\",\n \"USD\",\n \"BGN\",\n \"PLN\",\n \"CHF\",\n \"GEL\"\n ],\n \"markets\": {\n \"AF\": \"Afghanistan\",\n \"AL\": \"Albania\",\n \"AE\": \"United Arab Emirates\",\n \"DZ\": \"Algeria\",\n \"US\": \"USA\",\n \"AD\": \"Andorra\",\n \"AO\": \"Angola\",\n \"AG\": \"Antigua\",\n \"AR\": \"Argentina\",\n \"AM\": \"Armenia\",\n \"AU\": \"Australia\",\n \"AT\": \"Austria\",\n \"AZ\": \"Azerbaijan\",\n \"BS\": \"Bahamas\",\n \"BH\": \"Bahrain\",\n \"BD\": \"Bangladesh\",\n \"BB\": \"Barbados\",\n \"BY\": \"Belarus\",\n \"BE\": \"Belgium\",\n \"BZ\": \"Beliz\",\n \"BJ\": \"Benin\",\n \"BT\": \"Bhutan\",\n \"BO\": \"Bolivia\",\n \"BA\": \"Bosnia\",\n \"BW\": \"Botswana\",\n \"BR\": \"Brazil\",\n \"GB\": \"UK\",\n \"BN\": \"Brunei\",\n \"BG\": \"Bulgaria\",\n \"BF\": \"Burkina Faso\",\n \"BI\": \"Burundi\",\n \"KH\": \"Cambodia\",\n \"CM\": \"Cameroon\",\n \"CA\": \"Canada\",\n \"CV\": \"Cape Verde\",\n \"CF\": \"Central Africa\",\n \"TD\": \"Chad\",\n \"CL\": \"Chile\",\n \"CN\": \"China\",\n \"CO\": \"Colombia\",\n \"KM\": \"Comoros\",\n \"CR\": \"Costa Rica\",\n \"HR\": \"Croatia\",\n \"CU\": \"Cuba\",\n \"CY\": \"Cyprus\",\n \"CZ\": \"Czech Republic\",\n \"DK\": \"Denemark\",\n \"DJ\": \"Djibouti\",\n \"DM\": \"Dominica\",\n \"NL\": \"Netherlands\",\n \"EC\": \"Ecuador\",\n \"EG\": \"Egypt\",\n \"EE\": \"Estonia\",\n \"ET\": \"Ethiopia\",\n \"FJ\": \"Fiji\",\n \"PH\": \"Philippines\",\n \"FI\": \"Finland\",\n \"FR\": \"France\",\n \"GA\": \"Gabon\",\n \"GM\": \"Gambia\",\n \"GE\": \"Georgia\",\n \"DE\": \"Germany\",\n \"GH\": \"Ghana\",\n \"GR\": \"Greece\",\n \"GD\": \"Grenada\",\n \"GT\": \"Guatemala\",\n \"GN\": \"Guinea\",\n \"GY\": \"Guyana\",\n \"HT\": \"Haiti\",\n \"HN\": \"Honduras\",\n \"HU\": \"Hungaria\",\n \"HK\": \"Hong Kong\",\n \"IS\": \"Iceland\",\n \"IN\": \"India\",\n \"ID\": \"Indonesia\",\n \"IE\": \"Ireland\",\n \"IL\": \"Israel\",\n \"IT\": \"Italy\",\n \"JM\": \"Jamaica\",\n \"JP\": \"Japan\",\n \"JO\": \"Jordan\",\n \"KZ\": \"Kazakhstan\",\n \"KE\": \"Kenya\",\n \"KR\": \"South Korea\",\n \"KW\": \"Kuwait\",\n \"KG\": \"Kyrgyzstan\",\n \"LA\": \"Laos\",\n \"LV\": \"Latvia\",\n \"LR\": \"Liberia\",\n \"LY\": \"Libya\",\n \"LI\": \"Liechtenstein\",\n \"LT\": \"Lithuania\",\n \"LU\": \"Luxembourg\",\n \"MK\": \"Macedonia\",\n \"MG\": \"Madagascar\",\n \"MW\": \"Malawi\",\n \"MY\": \"Malaysia\",\n \"MV\": \"Maldives\",\n \"ML\": \"Mali\",\n \"MT\": \"Malta\",\n \"MH\": \"Marshall Islands\",\n \"MR\": \"Mauritania\",\n \"MU\": \"Mauritius\",\n \"MX\": \"Mexico\",\n \"FM\": \"Micronesia\",\n \"MD\": \"Moldova\",\n \"MC\": \"Monaco\",\n \"MN\": \"Mongolia\",\n \"MA\": \"Morocco\",\n \"MZ\": \"Mozambic\",\n \"NA\": \"Namibia\",\n \"NP\": \"Nepal\",\n \"NZ\": \"New Zealand\",\n \"VU\": \"Vanuatu\",\n \"NI\": \"Nicaragua\",\n \"NG\": \"Nigeria\",\n \"NO\": \"Norway\",\n \"OM\": \"Oman\",\n \"PK\": \"Pakistan\",\n \"PW\": \"Palau\",\n \"PA\": \"Panama\",\n \"PG\": \"Papua New Guinea\",\n \"PY\": \"Paraguay\",\n \"PE\": \"Peru\",\n \"PL\": \"Poland\",\n \"PT\": \"Portugal\",\n \"QA\": \"Qatar\",\n \"RO\": \"Romania\",\n \"RU\": \"Russia\",\n \"RW\": \"Rwanda\",\n \"SV\": \"El Salvador\",\n \"WS\": \"Samoa\",\n \"SM\": \"San Marino\",\n \"ST\": \"Sao Tome and Principe\",\n \"SA\": \"Saudi Arabia\",\n \"SN\": \"Senegal\",\n \"RS\": \"Serbia\",\n \"SC\": \"Seychelles\",\n \"SL\": \"Sierra Leon\",\n \"SG\": \"Singapor\",\n \"SK\": \"Slovakia\",\n \"SI\": \"Slovenia\",\n \"SB\": \"Solomon Islands\",\n \"SO\": \"Somalia\",\n \"ZA\": \"South Africa\",\n \"ES\": \"Spain\",\n \"LK\": \"Sri Lanka\",\n \"SD\": \"Sudan\",\n \"SR\": \"Surinam\",\n \"SZ\": \"Eswatini\",\n \"SE\": \"Sweden\",\n \"CH\": \"Switzerland\",\n \"TW\": \"Taiwan\",\n \"TJ\": \"Tajikistan\",\n \"TZ\": \"Tanzania\",\n \"TH\": \"Thailand\",\n \"TG\": \"Togo\",\n \"TO\": \"Tonga\",\n \"TT\": \"Trinidad and Tobago\",\n \"TN\": \"Tunisia\",\n \"TR\": \"Turkey\",\n \"TM\": \"Turkmenistan\",\n \"TV\": \"Tuvalu\",\n \"UG\": \"Uganda\",\n \"UA\": \"Ukraine\",\n \"UY\": \"Uruguay\",\n \"UZ\": \"Uzbekistan\",\n \"VE\": \"Venezuela\",\n \"VN\": \"Vietnam\",\n \"ZM\": \"Zambia\",\n \"ZW\": \"Zimbabwe\"\n },\n \"nationalities\": {\n \"AF\": \"Afghan\",\n \"AL\": \"Albanian\",\n \"AE\": \"Emirati\",\n \"DZ\": \"Algerian\",\n \"US\": \"American\",\n \"AD\": \"Andorran\",\n \"AO\": \"Angolan\",\n \"AG\": \"Antiguans\",\n \"AR\": \"Argentinean\",\n \"AM\": \"Armenian\",\n \"AU\": \"Australian\",\n \"AT\": \"Austrian\",\n \"AZ\": \"Azerbaijani\",\n \"BS\": \"Bahamian\",\n \"BH\": \"Bahraini\",\n \"BD\": \"Bangladeshi\",\n \"BB\": \"Barbadian\",\n \"BY\": \"Belarusian\",\n \"BE\": \"Belgian\",\n \"BZ\": \"Belizean\",\n \"BJ\": \"Beninese\",\n \"BT\": \"Bhutanese\",\n \"BO\": \"Bolivian\",\n \"BA\": \"Bosnian\",\n \"BW\": \"Botswanan\",\n \"BR\": \"Brazilian\",\n \"GB\": \"British\",\n \"BN\": \"Bruneian\",\n \"BG\": \"Bulgarian\",\n \"BF\": \"Burkinabe\",\n \"BI\": \"Burundian\",\n \"KH\": \"Cambodian\",\n \"CM\": \"Cameroonian\",\n \"CA\": \"Canadian\",\n \"CV\": \"Cape Verdean\",\n \"CF\": \"Central African\",\n \"TD\": \"Chadian\",\n \"CL\": \"Chilean\",\n \"CN\": \"Chinese\",\n \"CO\": \"Colombian\",\n \"KM\": \"Comoran\",\n \"CR\": \"Costa Rican\",\n \"HR\": \"Croatian\",\n \"CU\": \"Cuban\",\n \"CY\": \"Cypriot\",\n \"CZ\": \"Czech\",\n \"DK\": \"Danish\",\n \"DJ\": \"Djibouti\",\n \"DM\": \"Dominican\",\n \"NL\": \"Dutch\",\n \"EC\": \"Ecuadorean\",\n \"EG\": \"Egyptian\",\n \"EE\": \"Estonian\",\n \"ET\": \"Ethiopian\",\n \"FJ\": \"Fijian\",\n \"PH\": \"Filipino\",\n \"FI\": \"Finnish\",\n \"FR\": \"French\",\n \"GA\": \"Gabonese\",\n \"GM\": \"Gambian\",\n \"GE\": \"Georgian\",\n \"DE\": \"German\",\n \"GH\": \"Ghanaian\",\n \"GR\": \"Greek\",\n \"GD\": \"Grenadian\",\n \"GT\": \"Guatemalan\",\n \"GN\": \"Guinean\",\n \"GY\": \"Guyanese\",\n \"HT\": \"Haitian\",\n \"HN\": \"Honduran\",\n \"HU\": \"Hungarian\",\n \"HK\": \"Hongkongese\",\n \"IS\": \"Icelander\",\n \"IN\": \"Indian\",\n \"ID\": \"Indonesian\",\n \"IE\": \"Irish\",\n \"IL\": \"Israeli\",\n \"IT\": \"Italian\",\n \"JM\": \"Jamaican\",\n \"JP\": \"Japanese\",\n \"JO\": \"Jordanian\",\n \"KZ\": \"Kazakhstani\",\n \"KE\": \"Kenyan\",\n \"KR\": \"Korean\",\n \"KW\": \"Kuwaiti\",\n \"KG\": \"Kyrgyz\",\n \"LA\": \"Laotian\",\n \"LV\": \"Latvian\",\n \"LR\": \"Liberian\",\n \"LY\": \"Libyan\",\n \"LI\": \"Liechtensteiner\",\n \"LT\": \"Lithuanian\",\n \"LU\": \"Luxembourger\",\n \"MK\": \"Macedonian\",\n \"MG\": \"Malagasy\",\n \"MW\": \"Malawian\",\n \"MY\": \"Malaysian\",\n \"MV\": \"Maldivan\",\n \"ML\": \"Malian\",\n \"MT\": \"Maltese\",\n \"MH\": \"Marshallese\",\n \"MR\": \"Mauritanian\",\n \"MU\": \"Mauritian\",\n \"MX\": \"Mexican\",\n \"FM\": \"Micronesian\",\n \"MD\": \"Moldovan\",\n \"MC\": \"Monacan\",\n \"MN\": \"Mongolian\",\n \"MA\": \"Moroccan\",\n \"MZ\": \"Mozambican\",\n \"NA\": \"Namibian\",\n \"NP\": \"Nepalese\",\n \"NZ\": \"New Zealander\",\n \"VU\": \"Ni-Vanuatu\",\n \"NI\": \"Nicaraguan\",\n \"NG\": \"Nigerien\",\n \"NO\": \"Norwegian\",\n \"OM\": \"Omani\",\n \"PK\": \"Pakistani\",\n \"PW\": \"Palauan\",\n \"PA\": \"Panamanian\",\n \"PG\": \"Papua New Guinean\",\n \"PY\": \"Paraguayan\",\n \"PE\": \"Peruvian\",\n \"PL\": \"Polish\",\n \"PT\": \"Portuguese\",\n \"QA\": \"Qatari\",\n \"RO\": \"Romanian\",\n \"RU\": \"Russian\",\n \"RW\": \"Rwandan\",\n \"SV\": \"Salvadoran\",\n \"WS\": \"Samoan\",\n \"SM\": \"San Marinese\",\n \"ST\": \"Sao Tomean\",\n \"SA\": \"Saudi\",\n \"SN\": \"Senegalese\",\n \"RS\": \"Serbian\",\n \"SC\": \"Seychellois\",\n \"SL\": \"Sierra Leonean\",\n \"SG\": \"Singaporean\",\n \"SK\": \"Slovakian\",\n \"SI\": \"Slovenian\",\n \"SB\": \"Solomon Islander\",\n \"SO\": \"Somali\",\n \"ZA\": \"South African\",\n \"ES\": \"Spanish\",\n \"LK\": \"Sri Lankan\",\n \"SD\": \"Sudanese\",\n \"SR\": \"Surinamer\",\n \"SZ\": \"Swazi\",\n \"SE\": \"Swedish\",\n \"CH\": \"Swiss\",\n \"TW\": \"Taiwanese\",\n \"TJ\": \"Tajik\",\n \"TZ\": \"Tanzanian\",\n \"TH\": \"Thai\",\n \"TG\": \"Togolese\",\n \"TO\": \"Tongan\",\n \"TT\": \"Trinidadian or Tobagonian\",\n \"TN\": \"Tunisian\",\n \"TR\": \"Turkish\",\n \"TM\": \"Turkmenistani\",\n \"TV\": \"Tuvaluan\",\n \"UG\": \"Ugandan\",\n \"UA\": \"Ukrainian\",\n \"UY\": \"Uruguayan\",\n \"UZ\": \"Uzbekistani\",\n \"VE\": \"Venezuelan\",\n \"VN\": \"Vietnamese\",\n \"ZM\": \"Zambian\",\n \"ZW\": \"Zimbabwean\"\n }\n}"}],"_postman_id":"68554db9-caa6-44f3-9720-b7e60477010f"}],"id":"6b7ec758-68fa-4317-b554-20a7eeab95ad","_postman_id":"6b7ec758-68fa-4317-b554-20a7eeab95ad","description":""},{"name":"Search","item":[{"name":"Search for availabilities","id":"105a64a1-0dd3-4e65-8607-66b17874b8ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PartnerID","value":"sandbox","type":"text"},{"key":"PartnerToken","value":"sandbox","type":"text"},{"key":"Accept-Encoding","value":"gzip, deflate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"destinationIds\": [\"resort-1\"],\n // \"accommodationIds\": [\"bcm_10581640\"],\n \"checkIn\": \"2025-12-07\",\n \"checkOut\": \"2025-12-14\",\n \"originCountry\": \"uk\",\n \"occupancy\": {\n \"numberOfAdults\": 2\n }\n // \"pageToken\": \"jAAAAPQkeyJkZXN0aW5hdGlvbklEIjoic2tpQXJlYS0xNSIsImNoZWNrSW4iOiIyMDI2LTAyLTE0FwA3T3V0GADwCDIyIiwib3JpZ2luQ291bnRyeSI6InVrFQDwGWNjdXBhbmN5Ijp7Im51bWJlck9mQWR1bHRzIjoyfSwicGFnZSI6Mn0=\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/accommodation/search","description":"This endpoint retrieves available accommodations based on the provided search parameters.
\nNote: You must provide exactly one of destinationIds or accommodationIds. Supplying neither or both will result in a rejected request.
destinationIds (array of strings): All destination IDs. A maximum of 10 destination IDs can be sent per request. All destination IDs must be of the same type. More than 1 destination supported only for resort / village destination types.
\naccommodationIds (array of strings): An array of accommodation IDs to search availabilities for. A maximum of 50 accommodation IDs can be sent per request.
\ncheckIn (required, string): The check-in date for the accommodation search. Format must be 'YYYY-MM-DD'.
\ncheckOut (required, string): The check-out date for the accommodation search. Format must be 'YYYY-MM-DD'.
\noriginCountry (optional, string): The origin country of the guest.
\noccupancy (required, object): The guest details for the request, including the number of adults and optional children, and their allocation to rooms.
\noccupancy.numberOfAdults (required, integer): The total number of adults (at least 1).
\noccupancy.numberOfRooms (optional, integer): The number of rooms needed (at least 1).
\noccupancy.children[] (optional, array of integers): An array of children’s ages for the booking.
\noccupancy.allocation[] (optional, array of objects): Defines the allocation of guests to rooms.
\noccupancy.allocation[].children (optional, array of integers): The children’s ages for the room.
\noccupancy.allocation[].numberOfAdults (integer, required): The number of adults for the room (at least 1).
\nThe response will be a JSON object with the following schema:
\n{\n \"availableResults\": [\n {\n \"accommodationID\": \"23455\",\n \"name\": \"Pierre & Vacances Premium residence La Ginabelle\",\n \"type\": \"Hotel\",\n \"options\": [\n {\n \"rentables\": [\n {\n \"id\": \"23455.AD34\",\n \"name\": \"Double Room\",\n \"quantity\": 1,\n \"availableQuantity\": 5\n },\n {\n \"id\": \"23455.AD36X\",\n \"name\": \"Single Room\",\n \"quantity\": 2,\n \"availableQuantity\": 4\n }\n ],\n \"rates\": [\n {\n \"rateCode\": \"RO_NR\", \n \"boardType\": \"RO\",\n \"price\": {\n \"total\": {\n \"baseNetAmount\": 1234.90,\n \"baseGrossAmount\": 1400,\n \"currency\":\"EUR\",\n \"timing\": \"PAY_ONLINE\"\n },\n \"extraCharges\": [\n {\n \"code\": \"cityTax\",\n \"displayName\": \"City Tax\",\n \"price\": 2.40,\n \"currency\": \"EUR\",\n \"chargeType\": \"PER_GUEST\",\n \"timing\": \"PAY_AT_PROPERTY\",\n \"isMandatory\": true\n },\n {\n \"code\": \"towels\",\n \"displayName\": \"Towels\",\n \"price\": 3.00,\n \"currency\": \"EUR\",\n \"chargeType\": \"PER_GUEST\",\n \"timing\": \"PAY_ONLINE\",\n \"isMandatory\": false\n }\n ]\n },\n \"cancellationTerms\": [\n {\n \"penalty\": 100,\n \"currency\": \"EUR\",\n \"penaltyType\": \"FIXED\",\n \"startDate\": \"2024-10-13\"\n },\n {\n \"penalty\": 75,\n \"penaltyType\": \"PERCENT\",\n \"startDate\": \"2025-02-13\"\n },\n {\n \"penalty\": 100,\n \"penaltyType\": \"PERCENT\",\n \"startDate\": \"2025-03-10\"\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"nextPageToken\": \"kEeeGYDFTSJgl3G0jZduld0v4sz3rksQ\"\n}\n\nThe response includes available accommodations with details such as accommodation ID, name, type, rentables, rates, and cancellation terms.
\nExplanation:
\navailableResults (array): A list of available accommodations matching the request. Each item contains the accommodation details and available options.
accommodationID (string): The unique ID of the accommodation.
name (string): The name of the accommodation.
type (string): The type of accommodation (e.g., hotel, apartment).
options (array): A list of available options for the accommodation. Each option includes rentable items and their associated rates.
rentables (array): A list of rentable items within the option.
id (string): The unique ID of the rentable item.
name (string): The name of the rentable (e.g., \"Double Room\").
quantity (integer): The quantity of this rentable item requested in the search.
availableQuantity (integer): The number of this rentable item currently available for booking.
rates (array): A list of available rate options for this combination of rentables.
rateCode (string): The unique identifier for the rate (e.g., \"RO_NR\").
boardType (string): The board type included in the rate (e.g., \"RO\" for Room Only, \"FB\" for Full Board).
price (object): The pricing breakdown for the rate.
total (object): Contains the base price information for the rate.
baseNetAmount (number): The base net amount of the rate before any extra charges.
baseGrossAmount (number): The base gross amount of the rate before any extra charges, if applicable.
strikethroughPrice (number, optional): Represents the original price of the rate before any promotion, special offer, or discount is applied. If this field appears, it indicates that a discount, promotion, or special rate has been included in the price.
currency (string): The currency in which the price is represented (e.g., \"EUR\").
timing (string): Indicates when the price is to be paid — typically \"PAY_ONLINE\".
extraCharges (array): A unified list of all additional charges related to the rate. This array includes both mandatory and optional charges that are not included in the base price. Each charge object includes:
code (string): Identifier of the extra charge.
displayName (string): Human-readable name of the charge.
price (number): Cost of the charge.
currency (string): Currency of the charge (e.g., \"EUR\").
chargeType (string): How the charge is calculated — e.g., PER_NIGHT, PER_GUEST, FIXED.
timing (string): When the charge must be paid — either PAY_ONLINE or PAY_AT_PROPERTY.
isMandatory (boolean):
true: The charge is mandatory and must be paid. It is typically paid at the property, such as city tax or resort fees.
false: The charge is optional and may be added to the booking only if timing is \"PAY_ONLINE\".
If the client chooses to include this charge, its code must be sent in the /accommodation/booking/check-availability-price request under the additionalCharges array.
cancellationTerms (array): A list of cancellation terms that apply to this rate.
penalty (number): The penalty amount or percentage charged if the booking is canceled during the penalty period.
currency (string): The currency of the penalty amount (if penaltyType is FIXED).
penaltyType (string): The type of penalty — either \"FIXED\" (a static amount) or \"PERCENT\" (a percentage of the booking value).
startDate (string): The date from which the penalty starts to apply (in YYYY-MM-DD format).
nextPageToken (optional, string): A token provided in the response when there are more results available. If there are additional pages of results, the nextPageToken can be used to fetch the next set of data. To fetch the next page, pass this token as the pageToken parameter in the next request. If no nextPageToken is included in the response, it means there are no more pages to fetch for this request.
nextPageTokenIf there are more results available, the nextPageToken will be provided in the response. To fetch the next set of results, include the nextPageToken as the pageToken parameter in the next request. For example:
{\n \"pageToken\": \"Eja8lbOq6qd8oqmwhHj68tiiQUKZHMag\"\n}\n\nBy including the nextPageToken from the previous response as the pageToken in the next request, you will receive the next page of accommodation search results.
When fetching the next page of results, the pageToken should be the only key specified in the next request body. No other parameters from the original request should be included.
If the nextPageToken is not provided in the response, it indicates that there are no more pages of data to fetch for the current request.
This endpoint allows users to check the real-time availability and prices for accommodations.
\nThe request body should be in JSON format and includes the following parameters:
\naccommodationID (required, string): The ID of the accommodation.
\nrentables (required, array): An array of rentable items with the following properties:
\nid (required, string): The ID of the rentable item.
\nadults (required, integer): The number of adults.
\nchildrenAges (required, array of integers): The ages of children.
\ncheckIn (required, string): The check-in date.
\ncheckOut (required, string): The check-out date.
\noriginCountry (optional, string): The origin country of the guest.
\nrateCode (required, string): The rate code.
\nadditionalCharges: (optional, array): Optional list of extra charge codes (e.g. [\"towels\", \"bed_linen\"]) to include. These codes must match the code values found in the extraCharges[].code list returned in the selected rate of the /accommodation/search response.
Only charges with:
\n\"timing\": \"PAY_ONLINE\"are eligible to be included in this field.These selected charges will be added to the calculated additionalChargesAmount and reflected in the final totalAmount in the response.
{\n \"accommodationID\": \"AZ42244\",\n \"rentables\": [\n {\n \"id\": \"101\",\n \"adults\": 2,\n \"childrenAges\": [4, 9]\n }\n ],\n \"checkIn\": \"2024-12-25\",\n \"checkOut\": \"2024-12-31\",\n \"originCountry\": \"UK\",\n \"rateCode\": \"FB_TC\",\n \"additionalCharges\": [\"bed_linen\", \"towels\"]\n}\n\nThe response will provide real-time availability and pricing details for the requested accommodation. It will return a single option object with the requested rate option if available, rather than an array of options and rates. If the requested option is unavailable, the response will indicate this.
\n{\n \"available\": true,\n \"resultDetails\": {\n \"accommodationID\": \"AZ42244\",\n \"name\": \"Mountain View Lodge\",\n \"type\": \"Hotel\",\n \"option\": {\n \"rentables\": [\n {\n \"id\": \"23556.AC23\",\n \"name\": \"Standard Room\",\n \"adults\": 2,\n \"childrenAges\": [2, 7],\n \"quantity\": 1,\n \"availableQuantity\": 4\n },\n {\n \"id\": \"23556.AC56X\",\n \"name\": \"Standard Room\",\n \"adults\": 1,\n \"childrenAges\": [16],\n \"quantity\": 1,\n \"availableQuantity\": 5\n }\n ],\n \"rate\": {\n \"rateCode\": \"FB_TC\",\n \"boardType\": \"FB\",\n \"price\": {\n \"total\": {\n \"baseNetAmount\": 1235,\n \"baseGrossAmount\": 1400,\n \"additionalChargesAmount\": 32,\n \"totalNetAmount\": 1267,\n \"currency\": \"EUR\",\n \"timing\": \"PAY_ONLINE\"\n },\n \"extraCharges\": [\n {\n \"code\": \"cityTax\",\n \"displayName\": \"City Tax\",\n \"price\": 2.4,\n \"currency\": \"EUR\",\n \"chargeType\": \"PER_GUEST\",\n \"timing\": \"PAY_AT_PROPERTY\",\n \"isMandatory\": true\n },\n {\n \"code\": \"towels\",\n \"displayName\": \"Towels\",\n \"price\": 3,\n \"currency\": \"EUR\",\n \"chargeType\": \"PER_GUEST\",\n \"timing\": \"PAY_ONLINE\",\n \"isMandatory\": false\n }\n {\n \"code\": \"bed_linen\",\n \"displayName\": \"Bed Linen\",\n \"price\": 5,\n \"currency\": \"EUR\",\n \"chargeType\": \"PER_GUEST\",\n \"timing\": \"PAY_ONLINE\",\n \"isMandatory\": false\n }\n ]\n },\n \"cancellationTerms\": [\n {\n \"penalty\": 50.00,\n \"currency\": \"USD\",\n \"penaltyType\": \"FIXED\",\n \"startDate\": \"2024-12-24\"\n }\n ]\n }\n }\n },\n \"bookingReferenceToken\": \"d3f6f84a5c7d8e3b92c10123ac456789\"\n}\n\navailable (boolean): Indicates whether the requested accommodation is available for the requested dates.
\nresultDetails (object): Contains detailed information about the requested accommodation and its available option.
\naccommodationID (string): The ID of the accommodation.
\nname (string): The name of the accommodation.
\ntype (string): The type of accommodation (e.g., hotel, apartment).
\noption (object): The requested accommodation option, with its associated rentable items and rate.
\nrentables (array): A list of the requested rentables:
\nid (string): The unique ID of the rentable item.
name (string): The name of the rentable (e.g., \"Double Room\").
quantity (integer): The quantity of this rentable item requested in the search.
availableQuantity (integer): The number of this rentable item currently available for
rate (object): The rate details for the requested rentable item, including pricing and cancellation terms.
\nrateCode (string): The rate code.
\nboardType (string): The board type for the accommodation (e.g., FB for full board).
price (object): Includes the pricing breakdown and all applicable extra charges.
total (object): The calculated price breakdown.
baseNetAmount (number): The base net price without any extra charges.
baseGrossAmount (number): The base gross price without any extra charges.
additionalChargesAmount (number): The total price of selected optional charges (those specified in the additionalCharges field of the request).
totalNetAmount (number): The final total net price (baseNetAmount + additionalChargesAmount).
currency (string): The currency of the amounts (e.g., EUR).
timing (string): When the price must be paid (e.g., PAY_ONLINE).
extraCharges (array): List of all extra charges not included in the base price.
code (string): Unique code identifying the extra charge.
displayName (string): A human-readable name of the charge.
price (number): The charge amount per unit.
currency (string): The currency for the charge.
chargeType (string): Defines how the charge is calculated (e.g., PER_NIGHT, PER_GUEST, FIXED).
timing (string): Indicates when the charge is paid — either PAY_ONLINE or PAY_AT_PROPERTY.
isMandatory (boolean):
true: The charge is required (usually paid at the property) and cannot be selected manually.
false: The charge is optional and may be included in the booking if its code is provided in the additionalCharges field of the check-availability-price request.
cancellationTerms (array): A list of cancellation terms for the rate, including any penalty fees.
\nbookingReferenceToken (string): A token containing the necessary data to be used in the booking/create request. This token can be used in subsequent requests to finalize the booking.
\nbookingReferenceTokenThe bookingReferenceToken returned in this response is essential for creating the booking. Include this token in the POST /api/v1/accommodation/book request to finalize the accommodation booking.
This endpoint allows you to create a new accommodation booking.
\nThe request body should be in JSON format and include the following fields:
\nbookingReferenceToken (required, string): The token returned from the Check Availability and Price endpoint.
\nexpectedTotalNetPrice (required, number): The expected total price for the booking.
\ncurrency (required, string): The currency for the booking (e.g., \"EUR\").
\nreferenceID (required, string): A reference ID for the booking from your side.
\nmainGuest (required, object): The details of the main guest.
\ntitle (required, string): The title of the main guest (e.g., \"Mr\", \"Ms\").
\nfirstName (required, string): The first name of the main guest.
\nlastName (required, string): The last name of the main guest.
\noriginCountry (required, string): The origin country of the guest.
\nemail (required, string): The email of the main guest.
\nphone (required, object): The phone number of the main guest.
\ncountryCode (required, string): The country code for the phone number.
\nnumber (required, string): The phone number.
\n{\n \"bookingReferenceToken\": \"d3f6f84a5c7d8e3b92c10123ac456789\",\n \"expectedTotalNetPrice\": 1234.99,\n \"currency\": \"EUR\",\n \"referenceID\": \"4480ABC\",\n \"mainGuest\": {\n \"title\": \"Mr\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"email\": \"john@example.com\",\n \"phone\": {\n \"countryCode\": \"+44\",\n \"number\": \"235550077\"\n }\n }\n}\n\nThe response will contain the status of the booking creation and the generated bookingID.
\n{\n \"status\": \"success\",\n \"bookingID\": \"1234567890\"\n}\n\nIf the request fails, an error will be returned with a 400 Bad Request status.
A required parameter is missing or invalid.
\nThe bookingReferenceToken is incorrect, invalid, or expired.
The field parameter (or any other required parameter) is incorrect or missing.
Example error responses:
\n{\n \"error\": \"BadRequest\",\n \"message\": \"Invalid 'field' parameter. Please check the provided parameters and try again.\"\n}\n\n{\n \"error\": \"BadRequest\",\n \"message\": \"The 'bookingReferenceToken' is invalid or expired. Please provide a valid token.\"\n}\n\nThis endpoint retrieves the details of a specific accommodation booking identified by the bookingId and mainGuestEmail.
The request body should be in JSON format and include the following parameters:
\nbookingId (required, string): The ID of the accommodation booking.
\nmainGuestEmail (optional, string): The email address of the main guest for the booking.
\n{\n \"bookingId\": \"WES-362437\",\n \"mainGuestEmail\": \"john@example.com\"\n}\n\nUpon successful processing of the request, the response will include the booking details such as the booking ID, status, accommodation details, check-in/check-out details, pricing information, and cancellation terms.
\n{\n \"bookingID\": \"WES-362437\",\n \"status\": \"booked\",\n \"accommodationID\": \"23566\",\n \"name\": \"Pierre & Vacances Premium residence La Ginabelle\",\n \"type\": \"Hotel\",\n \"accommodationBookingID\": \"ALSL-023442\",\n \"onlineCheckIn\": \"https://www.odalys-vacances.com/checkin-online?culture=en-GB\",\n \"originCountry\": \"UK\",\n \"rentables\": [\n {\n \"id\": \"23556.AC23\",\n \"name\": \"Double Room\",\n \"quantity\": 1,\n \"apartmentNumber\": \"32\",\n \"keyBoxCode\": \"121314\",\n \"adults\": 2,\n \"childrenAges\": [\n 2,\n 7\n ]\n },\n {\n \"id\": \"23556.AC56X\",\n \"name\": \"Single Room\",\n \"quantity\": 2,\n \"apartmentNumber\": \"A14\",\n \"keyBoxCode\": \"764343\",\n \"adults\": 1,\n \"childrenAges\": [\n 16\n ]\n }\n ],\n \"rate\": {\n \"rateCode\": \"FB_TC\",\n \"boardType\": \"FB\",\n \"price\": {\n \"total\": {\n \"baseNetAmount\": 1235,\n \"baseGrossAmount\": 1400,\n \"additionalChargesAmount\": 32,\n \"totalAmount\": 1267,\n \"currency\": \"EUR\",\n \"timing\": \"PAY_ONLINE\"\n },\n \"extraCharges\": [\n {\n \"code\": \"cityTax\",\n \"displayName\": \"City Tax\",\n \"price\": 2.4,\n \"currency\": \"EUR\",\n \"chargeType\": \"PER_GUEST\",\n \"timing\": \"PAY_AT_PROPERTY\",\n \"isMandatory\": true\n },\n {\n \"code\": \"towels\",\n \"displayName\": \"Towels\",\n \"price\": 3,\n \"currency\": \"EUR\",\n \"chargeType\": \"PER_GUEST\",\n \"timing\": \"PAY_ONLINE\",\n \"isMandatory\": false\n },\n {\n \"code\": \"bed_linen\",\n \"displayName\": \"Bed Linen\",\n \"price\": 5,\n \"currency\": \"EUR\",\n \"chargeType\": \"PER_GUEST\",\n \"timing\": \"PAY_ONLINE\",\n \"isMandatory\": false\n }\n ]\n },\n \"cancellationTerms\": [\n {\n \"penalty\": 50.00,\n \"currency\": \"USD\",\n \"penaltyType\": \"FIXED\",\n \"startDate\": \"2024-12-24\"\n }\n ]\n },\n \"checkIn\": \"2024-12-24\",\n \"checkOut\": \"2024-12-31\",\n \"checkInOutDetails\": {\n \"checkIn\": {\n \"from\": \"16:00\",\n \"to\": \"23:00\",\n \"instructions\": \"If you're planning to arrive after 20:00 PM, your key will be left in an envelope under your name, in a security box. Please contact the reception in advance to ask for the security box code. \\nIn case you arrive late and still need assistance with retrieving the code for the safe box, you may call emergency number +33458830110\"\n },\n \"checkOut\": {\n \"to\": \"11:00\",\n \"instructions\": \"\"\n }\n },\n \"referenceID\": \"4480ABC\",\n \"mainGuest\": {\n \"title\": \"Mr\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"email\": \"john@example.com\",\n \"phone\": {\n \"countryCode\": \"+44\",\n \"number\": \"235550077\"\n }\n }\n}\n\nExplanation:
\nbookingID (string): The ID of the accommodation booking.
status (string): The status of the booking (e.g., \"booked\").
accommodationID (string): The ID of the accommodation.
name (string): The name of the accommodation.
type (string): The type of accommodation (e.g., hotel, apartment).
accommodationBookingID (string): The unique booking ID from the accommodation provider.
onlineCheckIn (string): A URL link for completing online check-in, if available.
originCountry (string): The origin country of the guest (ISO country code).
rentables (array): The list of rentable units for the booking. Each item includes:
id (string): The ID of the rentable unit.
name (string): The name of the rentable.
quantity (number): The number of units booked of this rentable.
apartmentNumber (string): The assigned apartment or room number.
keyBoxCode (string): The key box or safe code for check-in access.
adults (number): The number of adults in the unit.
childrenAges (array): The ages of the children in the unit.
rate (object): The selected rate for the booking.
rateCode (string): The rate identifier used for booking.
boardType (string): The board basis (e.g., \"FB\" for Full Board).
price (object): The pricing breakdown for the booking.
total (object): The full pricing summary.
baseNetAmount (number): The base net price without any extra charges.
baseGrossAmount (number): The base gross price, if applicable.
additionalChargesAmount (number): The total amount for optional charges that were selected by the customer (those with timing: PAY_ONLINE).
totalAmount (number): The final total amount of the booking, including selected optional charges.
currency (string): The currency in which the price is displayed and charged (e.g., \"EUR\").
timing (string): Indicates when the amount is to be paid (typically \"PAY_ONLINE\").
extraCharges (array): A list of extra charges related to the booking. Includes both mandatory and optional charges, whether prepaid or due at the property. Each item includes:
code (string): Unique code identifying the extra charge.
displayName (string): A human-readable name for the charge.
price (number): The cost of the charge per unit (e.g., per guest or per night).
currency (string): The currency used for the charge (e.g., \"EUR\").
chargeType (string): Defines how the charge is calculated — e.g., PER_GUEST, PER_NIGHT, or FIXED.
timing (string): When the charge must be paid — either PAY_ONLINE or PAY_AT_PROPERTY.
isMandatory (boolean):
true: This charge is required by the provider and typically paid at the property.
false: This charge was optional and has been selected and included in the booking (prepaid if timing is PAY_ONLINE).
cancellationTerms (array): A list of cancellation policies for the booking.
penalty (number): The penalty amount or percentage to be charged.
currency (string): The currency for the penalty (if penaltyType is FIXED).
penaltyType (string): The type of penalty — either FIXED or PERCENT.
startDate (string): The date from which the penalty starts to apply.
checkIn (string): The check-in date (format: YYYY-MM-DD).
checkOut (string): The check-out date (format: YYYY-MM-DD).
checkInOutDetails (object): Instructions and time windows for check-in and check-out.
checkIn (object): Details for arrival.
from (string): Earliest check-in time.
to (string): Latest check-in time.
instructions (string): Instructions for accessing the accommodation.
checkOut (object): Details for departure.
to (string): Latest check-out time.
instructions (string): Check-out instructions, if any.
referenceID (string): A reference ID provided for the booking.
mainGuest (object): Details of the main guest on the booking.
title (string): Guest’s title (e.g., \"Mr\", \"Ms\").
firstName (string): Guest’s first name.
lastName (string): Guest’s last name.
email (string): Guest’s email address.
phone (object): Guest’s phone number.
This endpoint allows you to cancel a specific accommodation booking identified by the bookingId and mainGuestEmail.
The request body should be in JSON format and include the following parameters:
\nbookingId (required, string): The ID of the accommodation booking.
\nmainGuestEmail (optional, string): The email address of the main guest for the booking.
\n{\n \"bookingId\": \"WES-362437\",\n \"mainGuestEmail\": \"john@example.com\"\n}\n\nThe response body will contain information about the cancellation status in JSON format. For example:
\n{\n \"status\": \"canceled\",\n}\n\nPlease note that last-minute cancellations might be subject to charges according to your commercial agreement.
\n","urlObject":{"path":["api","v1","accommodation","booking","cancel"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"8f3242a6-16a1-4e3f-b794-df7acde832f6","name":"Cancel booking","originalRequest":{"method":"POST","header":[{"key":"PartnerID","value":"sandbox","type":"text"},{"key":"PartnerToken","value":"sandbox","type":"text"},{"key":"Accept-Encoding","value":"gzip, deflate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bookingId\": \"5q2oA9KMJy\",\n \"mainGuestEmail\": \"john@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/accommodation/booking/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"21"},{"key":"ETag","value":"W/\"15-GnyCTwPopYDGTdEhUucF4F1qvRY\""},{"key":"Server-Timing","value":"total; dur=5991.529458; desc=\"Total Response Time\""},{"key":"Date","value":"Wed, 16 Jul 2025 14:24:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"canceled\"\n}"}],"_postman_id":"08c88837-b6ac-45c3-940b-a0f9cc94253d"},{"name":"Change guest details","id":"9697c3ad-faaa-4326-b747-80ed49096489","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"PartnerID","value":"sandbox","type":"text"},{"key":"PartnerToken","value":"sandbox","type":"text"},{"key":"Accept-Encoding","value":"gzip, deflate","type":"text"}],"body":{"mode":"raw","raw":"{\n \"bookingID\": \"1234567890\",\n \"title\": \"Mr\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"email\": \"john@example.com\",\n \"phone\": {\n \"countryCode\": \"+44\",\n \"number\": \"235550077\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/accommodation/booking/change-guest-details","description":"This endpoint allows you to update the GUEST details of a specific accommodation booking identified by the bookingID.
The request body should be in JSON format and include the following parameters:
\nbookingID (required, string): The ID of the accommodation booking.
\ntitle (required, string): The title of the guest (e.g., \"Mr\", \"Ms\").
\nfirstName (required, string): The first name of the guest.
\nlastName (required, string): The last name of the guest.
\nemail (required, string): The email address of the guest.
\nphone (required, object): The phone number of the guest.
\ncountryCode (required, string): The country code for the phone number.
\nnumber (required, string): The phone number.
\n{\n \"bookingID\": \"1234567890\",\n \"title\": \"Mr\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"email\": \"john@example.com\",\n \"phone\": {\n \"countryCode\": \"+44\",\n \"number\": \"235550077\"\n }\n}\n\nThe response will indicate the status of the name change request.
\n{\n \"status\": \"pending\"\n}\n\nstatus (string): The status of the name change request. Possible values:
\n\"pending\": The name change request is in progress and has been accepted but not completed yet.