Maxxton External API

Sections

Arrival range search

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.

arrivalDateFromstring Required

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

numberOfDaysInResultinteger

The number of days starting from the arrivalDate for which the price range search has been carried out and the numberOfDaysInResult should be passed in days ex: 7. Maximum set limit is 30 days.

offerCodestring

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

offerIdinteger

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

subjectsobject

The details of the person accommodated in an accommodationtype

Show child attributes

locationIdsarray

List of location ids passed to fetch accommodationtypes which belong to the provided locations

Allow unique items
true

Show child attributes

resourceIdsarray

The accommodationtype ids which user wants to apply search on and this field accepts only single resource Id.

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

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' and 'departures'.If a user is passing these filter options then all the possible departures and arrivals available for the requested criteria are displayed in response.

Show child attributes

preBookingboolean

An option to return prebooking prices along with normal prices. By default the value of preBooking is false, if not specified in the request. To enable preBooking support, set the value as true in the request.

voucherCodestring

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

unitIdinteger

UnitId passed to fetch accommodationtypes which belong to the provided unitId

rateTypeIdinteger

Rate type id which will be used to fetch availability. If not provided, then the first rate type will be picked up from the rate types linked to distribution channel and ordered in ascending order of priority.

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.

qualityLevelIdsarray
Allow unique items
true

Show child attributes

Response

200
Object
The request is completed successfully without any errors

Response Attributes

resultsobject

List of filtered result as per the given criterias provided by the user

Show child attributes

filterOptionsResultobject

Show child attributes

400
Object
Either offerCode or voucherCode should be passed
500
Object
Error occurred while fetching accommodationTypes

POST

/

Select
1

Response