Maxxton External API

Sections

Search units

Query Parameters

sortstring

Sort parameter is used to sort the response in ascending or descending order on the basis of offer price. In order to sort the response in ascending order 'offer_price_asc' is used and to sort in descending order the value of sort that should be passed is 'offer_price_desc'

Body Parameters

distributionChannelIdinteger Required

If the user pass the distributionChannel id in the request then the data will be filtered based on the provided id else the distributionChannel id will be taken from the token. If no distributionChannel id is passed neither the token contains the distributionChannel id valid error message will be thrown.

arrivalDatestring

The date on which customer/guest will arrive. Date should be added using ISO 8601 standard(yyyy-MM-dd)

durationinteger

The duration for which a user will stay at the accommodationtype and the duration should be passed in days ex: 7.

filterOptionsarray

Filter options can be used to filter the aggregations which are provided in the search response apart from the result field. The possible filter options are 'arrivals', 'departures', 'locations', 'accommodationKinds' and 'amenities'.If a user is passing these filter options then all the possible amenities , departures , locations and arrivals available for the requested criteria are displayed in response.

Show child attributes

includeAllPricesboolean

If the user passed this field as true then 10 records will be shown in response else only one element is shown in response

offerCodestring

Unique code associated with offer on the bases of which accommodationtype is to be filtered

offerIdinteger
subjectsobject

The details of the person accommodated in an accommodationtype

Show child attributes

locationIdinteger

Location id passed to fetch units which belong to the provided locations

resourceIdsarray

List of accommodationtype ids which user wants to apply search on

Allow unique items
true

Show child attributes

petQuantityinteger

The number of pets accommodated in the accommodationtype

amenityIdsarray

List of amenity ids which are linked to the accommodationtype

Allow unique items
true

Show child attributes

accommodationKindIdsarray

List of accommodation kind ids corresponding to which the accommodationtypes are to be fetched

Allow unique items
true

Show child attributes

includeFilterOptionCountsboolean

An option to return the counts of the different filteroptions

regionIdinteger

Region id passed to fetch accommodation types which belong to the provided region

dateMargininteger

Date margin to search other possible stays (arrival dates and durations) when the requested stay is not available.

dateMarginMethodstring

This parameter can be used together with the dateMargin parameter and will define how the alternatives are provided. The possible options are ARRIVAL_DATE which creates alternatives based on different arrival and departure dates but keeps the same duration. DURATION gives alternatives with a longer or shorter period. ARRIVAL_DATE_AND_DURATION which gives alternatives with different arrival and departure dates and also shorter or longer durations. In case this parameter is not used it ...

Enum values:
ARRIVAL_DATEDURATIONARRIVAL_DATE_AND_DURATIONDURATION_AND_ARRIVAL
voucherCodestring
minNrOfBathroomsinteger
maxNrOfBathroomsinteger
minNrOfBedroomsinteger
maxNrOfBedroomsinteger
redeemableLoyaltyPointsinteger

Loyalty points can be redeemed to get discounts, arrival date and duration are required to calculate the loyalty price. The number of points is not linked to the available number of points for a certain customer, this will be checked in the reservation proposal call. Incase only the possibilities for a certain customer should be returned, the current point balance can be fetched using {customer loyalty balance endpoint url here} and the value can be provided in this request parameter.

Response

200
Object
The request is completed successfully without any errors

Response Attributes

resultobject

Show child attributes

filterOptionsResultobject

Show child attributes

400
Object
1. Either offerCode or voucherCode should be passed 2. The dateMargin parameter cannot be used in combination with includeAllPrices parameter.
500
Object
Error occurred while fetching accommodationTypes

POST

/

Select
1

Response