Search

Sections

Maxxton External API

The document comprises RESTful web services which refers to the methods (GET, POST, PUT, DELETE), endpoints of the APIs, required fields and explains what services consumes and produces. It also tells what data is to be sent in request body and what will be returned in response body. The dates that are being entered along with time depicts the UTC time zone and the one without time represents just that day.

Base URL

Production:

https://api.maxxton.net

Language Box

Accommodation Types

A collection of similar units grouped together.

Endpoints

POST
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
POST
GET
POST
GET
GET
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
GET
POST
GET
GET
POST
POST
GET
GET
POST
POST
GET

AddOn

A product or extra that can be booked optionally in a reservation or will be added mandatory to the reservation. Examples of optional addons are: bedlinnen, breakfast, baby cot. Example of mandatory addons are: cleaning, tourist tax

Endpoints

GET
GET
GET
GET
GET
PUT
GET
GET
GET

Admin Organisation

A main level to funnel the companies, locations, employees, accounts and other properties that exclusively belongs to that Admin organisation.

Endpoints

POST
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
PUT

Allotment

The allocation of a certain number of accommodation types or units for a specific period or purpose per distribution channel.

Endpoints

GET
GET

Amenity

A feature or service provided to enhance the guest experience, such as a pool, gym, or Wi-Fi.

Endpoints

POST
GET
GET
GET

Authentication

Authenticate to get access to the API. Authentication details can be provided by the Maxxton client who would like to give access to their environment using the API.

Endpoints

POST

Brands

A distinctive name associated with a specific product or service.

Endpoints

GET
GET

Cash Clearance

The process of reconciling and recording cash transactions to ensure accurate financial records.

Endpoints

GET
GET
GET
GET
GET
GET

Contracts

A formal agreement outlining the terms and conditions between an owner and an organisation about renting his unit.

Endpoints

POST
DELETE
GET
GET
PUT
GET
GET

Countries

All available countries, the countries are configured in Maxxton.

Endpoints

GET
GET

Currency

The type of money used in financial transactions, such as USD or EUR.

Endpoints

GET
GET

Customer Status

A certain label that is given to a customer. This can be assigned automatically or manually.

Endpoints

GET
GET

Customers

An individual or entity that purchases or uses accommodations or services.

Endpoints

POST
GET
GET
GET
PUT
GET
PUT
GET
PUT
GET
GET
POST
GET
GET
POST
GET
GET

DistributionChannels

The sales channel through which products or services are delivered to customers.

Endpoints

GET
GET
GET
GET
GET
GET
GET

Employee

An individual working for an organization, responsible for various tasks or roles.

Endpoints

POST
GET
PUT

Events

When certain entities are changed this will result in an event. This event can be used to update/refresh the data in the external system.

Endpoints

GET

Facilities

A physical location or infrastructure used to support operations or services.

Endpoints

GET
GET

Groups

Grouping of certain entities such as marketing groups, location groups in Maxxton.

Endpoints

GET
GET

Housekeeping

A specific job or duty that needs to be done on an accommodation on a specified date and time.

Endpoints

GET
GET

Icals

Ical calendar file to show reservations made for a certain unit. Mostly used for owners to show the usage of their unit.

Endpoints

GET

Infotexts

A piece of informative text visible to the customer.

Endpoints

POST
GET

Languages

The choice of language for user interfaces, or communication within the system.

Endpoints

GET

Ledgers

A comprehensive record of all financial transactions, including accounts and balances.

Endpoints

GET
GET
GET
GET

Locations

A physical place or address where accommodations or services are provided like a location.

Endpoints

POST
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
POST
POST
GET

Create a location

creates a new location

Body Parameters

adminOrganisationIdinteger (int64)
codestring
internalLocationNumberstring
originstring
originIdstring
parentIdinteger (int64)
locationNumberinteger (int64)
locationPriorityinteger (int64)
visitAddressobject

Show child attributes

mailAddressobject

Show child attributes

translationsarray

Show child attributes

Response

200
Object
The request is completed successfully without any errors

Response Attributes

locationPriorityinteger (int64)

Priority set to the location in which it will be visible to the user

locationNumberinteger (int32)

Number associated with each location

resArrivalDateFromstring (date)

Date on which the user can arrive

internalLocationNumberstring

Automatic generated location number from where the reservation number will start

codestring

Unique code associated with each location

locationIdinteger (int64)

Unique id associated with each location

parentIdinteger (int64)

If location is a child of another location then the id of the parent location is displayed

archivedFromstring (date)

Date from which the location was archived. The locations will not be displayed if the location is archived. Thus for all locations which are being displayed the value will be null

translationsarray

Information of the locations which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Show child attributes

mailAddressobject

details of the visit address of the user

Show child attributes

visitAddressobject

details of the visit address of the user

Show child attributes

adminOrganisationIdinteger (int64)

Id of the admin organisation to which location is linked.

originstring
originIdstring
bookableLocationboolean

To show if location contains actual accommodation types and not just used for defining hierarchy

previousPmsIdstring

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

minAgeForBookinginteger (int32)

Field to denote the minAge of the customer for making a reservation on the location

500
Object
Error occurred while creating location.

POST

/maxxton/v2/locations

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 curl --location 'https://api.maxxton.net/maxxton/v2/locations' \ --data '{ "adminOrganisationId": 0, "code": "string", "internalLocationNumber": "string", "origin": "string", "originId": "string", "parentId": 0, "locationNumber": 0, "locationPriority": 0, "visitAddress": { "accuracy": "ROOFTOP", "address1": "string", "address2": "string", "address3": "string", "alternateContactPerson": "string", "boxNumber": "string", "city": "string", "countryId": 0, "dateEnd": "2025-06-19", "dateBegin": "2025-06-19", "district": "string", "email": "string", "exposeLocation": true, "fax": "string", "houseNumber": "string", "houseNumberSuffix": "string", "latitude": 0, "longitude": 0, "mobilePhone": "string", "mobilePhone2": "string", "municipality": "string", "poBox": "string", "poBoxZipcode": "string", "poBoxCity": "string", "privatePhone": "string", "stateId": 0, "workPhone": "string", "zipCode": "string" }, "mailAddress": { "accuracy": "ROOFTOP", "address1": "string", "address2": "string", "address3": "string", "alternateContactPerson": "string", "boxNumber": "string", "city": "string", "countryId": 0, "dateEnd": "2025-06-19", "dateBegin": "2025-06-19", "district": "string", "email": "string", "exposeLocation": true, "fax": "string", "houseNumber": "string", "houseNumberSuffix": "string", "latitude": 0, "longitude": 0, "mobilePhone": "string", "mobilePhone2": "string", "municipality": "string", "poBox": "string", "poBoxZipcode": "string", "poBoxCity": "string", "privatePhone": "string", "stateId": 0, "workPhone": "string", "zipCode": "string" }, "translations": [ { "language": "string", "name": "string", "description": "string", "shortDescription": "string" } ] }'

Response

{
  "locationPriority": 0,
  "locationNumber": 0,
  "resArrivalDateFrom": "2025-06-19",
  "internalLocationNumber": "string",
  "code": "string",
  "locationId": 0,
  "parentId": 0,
  "archivedFrom": "2025-06-19",
  "translations": [
    {
      "language": "string",
      "name": "string",
      "description": "string",
      "shortDescription": "string"
    }
  ],
  "mailAddress": {
    "addressId": 0,
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "boxNumber": "string",
    "houseNumberSuffix": "string",
    "zipCode": "string",
    "poBox": "string",
    "poBoxZipcode": "string",
    "poBoxCity": "string",
    "city": "string",
    "countryId": 0,
    "municipality": "string",
    "mobilePhone2": "string",
    "latitude": 0,
    "longitude": 0,
    "email": "string",
    "stateId": 0,
    "mobilePhone": "string",
    "houseNumber": "string",
    "district": "string",
    "privatePhone": "string",
    "workPhone": "string",
    "exposeLocation": true,
    "dateEnd": "2025-06-19",
    "dateBegin": "2025-06-19",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "visitAddress": {
    "addressId": 0,
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "boxNumber": "string",
    "houseNumberSuffix": "string",
    "zipCode": "string",
    "poBox": "string",
    "poBoxZipcode": "string",
    "poBoxCity": "string",
    "city": "string",
    "countryId": 0,
    "municipality": "string",
    "mobilePhone2": "string",
    "latitude": 0,
    "longitude": 0,
    "email": "string",
    "stateId": 0,
    "mobilePhone": "string",
    "houseNumber": "string",
    "district": "string",
    "privatePhone": "string",
    "workPhone": "string",
    "exposeLocation": true,
    "dateEnd": "2025-06-19",
    "dateBegin": "2025-06-19",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "adminOrganisationId": 0,
  "origin": "string",
  "originId": "string",
  "bookableLocation": true,
  "previousPmsId": "string",
  "minAgeForBooking": 0
}

Get a location

Get's a location by its Id

Path Parameters

locationIdinteger (int64)Required

locationId to fetch location

Response

200
Object
The request is completed successfully without any errors

Response Attributes

locationPriorityinteger (int64)

Priority set to the location in which it will be visible to the user

locationNumberinteger (int32)

Number associated with each location

resArrivalDateFromstring (date)

Date on which the user can arrive

internalLocationNumberstring

Automatic generated location number from where the reservation number will start

codestring

Unique code associated with each location

locationIdinteger (int64)

Unique id associated with each location

parentIdinteger (int64)

If location is a child of another location then the id of the parent location is displayed

archivedFromstring (date)

Date from which the location was archived. The locations will not be displayed if the location is archived. Thus for all locations which are being displayed the value will be null

translationsarray

Information of the locations which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Show child attributes

mailAddressobject

details of the visit address of the user

Show child attributes

visitAddressobject

details of the visit address of the user

Show child attributes

adminOrganisationIdinteger (int64)

Id of the admin organisation to which location is linked.

originstring
originIdstring
bookableLocationboolean

To show if location contains actual accommodation types and not just used for defining hierarchy

previousPmsIdstring

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

minAgeForBookinginteger (int32)

Field to denote the minAge of the customer for making a reservation on the location

404
Object
No location found for given criteria.
500
Object
Error occurred while fetching location.

GET

/maxxton/v2/locations/{locationId}

Select
1 curl --location --globoff 'https://api.maxxton.net/maxxton/v2/locations/{locationId}'

Response

{
  "locationPriority": 0,
  "locationNumber": 0,
  "resArrivalDateFrom": "2025-06-19",
  "internalLocationNumber": "string",
  "code": "string",
  "locationId": 0,
  "parentId": 0,
  "archivedFrom": "2025-06-19",
  "translations": [
    {
      "language": "string",
      "name": "string",
      "description": "string",
      "shortDescription": "string"
    }
  ],
  "mailAddress": {
    "addressId": 0,
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "boxNumber": "string",
    "houseNumberSuffix": "string",
    "zipCode": "string",
    "poBox": "string",
    "poBoxZipcode": "string",
    "poBoxCity": "string",
    "city": "string",
    "countryId": 0,
    "municipality": "string",
    "mobilePhone2": "string",
    "latitude": 0,
    "longitude": 0,
    "email": "string",
    "stateId": 0,
    "mobilePhone": "string",
    "houseNumber": "string",
    "district": "string",
    "privatePhone": "string",
    "workPhone": "string",
    "exposeLocation": true,
    "dateEnd": "2025-06-19",
    "dateBegin": "2025-06-19",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "visitAddress": {
    "addressId": 0,
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "boxNumber": "string",
    "houseNumberSuffix": "string",
    "zipCode": "string",
    "poBox": "string",
    "poBoxZipcode": "string",
    "poBoxCity": "string",
    "city": "string",
    "countryId": 0,
    "municipality": "string",
    "mobilePhone2": "string",
    "latitude": 0,
    "longitude": 0,
    "email": "string",
    "stateId": 0,
    "mobilePhone": "string",
    "houseNumber": "string",
    "district": "string",
    "privatePhone": "string",
    "workPhone": "string",
    "exposeLocation": true,
    "dateEnd": "2025-06-19",
    "dateBegin": "2025-06-19",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "adminOrganisationId": 0,
  "origin": "string",
  "originId": "string",
  "bookableLocation": true,
  "previousPmsId": "string",
  "minAgeForBooking": 0
}

Get all locations

Get a page holding location objects.The records can be filtered based on location object.It also supports pageable.

Query Parameters

locationIdsarray
pageinteger (int32)

Page number

sizeinteger (int32)

Size of the current page

sortstring

Sort parameter

filterarray

Following fields can be used for filtering response.
locationPriority:0,
locationNumber:0,
internalLocationNumber:String,
code:String,
locationId:0,
parentId:0,
archivedFrom:2025-06-19,
adminOrganisationId:0,
origin:String,
originId:String,
bookableLocation:true,
previousPmsId:String,
minAgeForBooking:0For more information, check: Filtering

Response

200
Object
The request is completed successfully without any errors

Response Attributes

totalElementsinteger (int64)

Total number of elements available in the whole response.

totalPagesinteger (int32)

Total number of pages the response has.

firstboolean

Boolean field to specify if its the first page or not.

lastboolean

Boolean field to specify if its the last page or not.

sizeinteger (int32)

Size of the current page.

contentarray

Show child attributes

numberinteger (int32)

Page number currently accessed.

sortarray

Show child attributes

numberOfElementsinteger (int32)

Total number of elements in the current page.

emptyboolean
404
Object
No locations found for given criteria.
500
Object
Error occurred while fetching locations.

GET

/maxxton/v2/locations?locationIds=&page=&size=&sort=&filter=

Select
1 curl --location 'https://api.maxxton.net/maxxton/v2/locations'

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "locationPriority": 0,
      "locationNumber": 0,
      "resArrivalDateFrom": "2025-06-19",
      "internalLocationNumber": "string",
      "code": "string",
      "locationId": 0,
      "parentId": 0,
      "archivedFrom": "2025-06-19",
      "translations": [
        {
          "language": "string",
          "name": "string",
          "description": "string",
          "shortDescription": "string"
        }
      ],
      "mailAddress": {
        "addressId": 0,
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "boxNumber": "string",
        "houseNumberSuffix": "string",
        "zipCode": "string",
        "poBox": "string",
        "poBoxZipcode": "string",
        "poBoxCity": "string",
        "city": "string",
        "countryId": 0,
        "municipality": "string",
        "mobilePhone2": "string",
        "latitude": 0,
        "longitude": 0,
        "email": "string",
        "stateId": 0,
        "mobilePhone": "string",
        "houseNumber": "string",
        "district": "string",
        "privatePhone": "string",
        "workPhone": "string",
        "exposeLocation": true,
        "dateEnd": "2025-06-19",
        "dateBegin": "2025-06-19",
        "fax": "string",
        "alternateContactPerson": "string",
        "accuracy": "ROOFTOP",
        "country": {
          "countryId": 0,
          "priority": 0,
          "translations": [
            {
              "name": "string",
              "language": "string"
            }
          ],
          "default": true,
          "code": "string"
        }
      },
      "visitAddress": {
        "addressId": 0,
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "boxNumber": "string",
        "houseNumberSuffix": "string",
        "zipCode": "string",
        "poBox": "string",
        "poBoxZipcode": "string",
        "poBoxCity": "string",
        "city": "string",
        "countryId": 0,
        "municipality": "string",
        "mobilePhone2": "string",
        "latitude": 0,
        "longitude": 0,
        "email": "string",
        "stateId": 0,
        "mobilePhone": "string",
        "houseNumber": "string",
        "district": "string",
        "privatePhone": "string",
        "workPhone": "string",
        "exposeLocation": true,
        "dateEnd": "2025-06-19",
        "dateBegin": "2025-06-19",
        "fax": "string",
        "alternateContactPerson": "string",
        "accuracy": "ROOFTOP",
        "country": {
          "countryId": 0,
          "priority": 0,
          "translations": [
            {
              "name": "string",
              "language": "string"
            }
          ],
          "default": true,
          "code": "string"
        }
      },
      "adminOrganisationId": 0,
      "origin": "string",
      "originId": "string",
      "bookableLocation": true,
      "previousPmsId": "string",
      "minAgeForBooking": 0
    }
  ],
  "number": 0,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "empty": true
}

Update a location

updates a existing location

Path Parameters

locationIdinteger (int64)Required

locationId to update location

Body Parameters

adminOrganisationIdinteger (int64)
codestring
internalLocationNumberstring
originstring
originIdstring
parentIdinteger (int64)
locationNumberinteger (int64)
locationPriorityinteger (int64)
visitAddressobject

Show child attributes

mailAddressobject

Show child attributes

translationsarray

Show child attributes

Response

200
Object
The request is completed successfully without any errors

Response Attributes

locationPriorityinteger (int64)

Priority set to the location in which it will be visible to the user

locationNumberinteger (int32)

Number associated with each location

resArrivalDateFromstring (date)

Date on which the user can arrive

internalLocationNumberstring

Automatic generated location number from where the reservation number will start

codestring

Unique code associated with each location

locationIdinteger (int64)

Unique id associated with each location

parentIdinteger (int64)

If location is a child of another location then the id of the parent location is displayed

archivedFromstring (date)

Date from which the location was archived. The locations will not be displayed if the location is archived. Thus for all locations which are being displayed the value will be null

translationsarray

Information of the locations which depends on a language and is translatable by the user. Multiple entries for different languages can exist.

Show child attributes

mailAddressobject

details of the visit address of the user

Show child attributes

visitAddressobject

details of the visit address of the user

Show child attributes

adminOrganisationIdinteger (int64)

Id of the admin organisation to which location is linked.

originstring
originIdstring
bookableLocationboolean

To show if location contains actual accommodation types and not just used for defining hierarchy

previousPmsIdstring

Primary key of the entity it used to have in the previous pms used by the client. This is generally imported once while migrating from another PMS to Maxxton

minAgeForBookinginteger (int32)

Field to denote the minAge of the customer for making a reservation on the location

500
Object
Error occurred while creating location.

PUT

/maxxton/v2/locations/{locationId}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 curl --location --globoff --request PUT 'https://api.maxxton.net/maxxton/v2/locations/{locationId}' \ --data '{ "adminOrganisationId": 0, "code": "string", "internalLocationNumber": "string", "origin": "string", "originId": "string", "parentId": 0, "locationNumber": 0, "locationPriority": 0, "visitAddress": { "accuracy": "ROOFTOP", "address1": "string", "address2": "string", "address3": "string", "alternateContactPerson": "string", "boxNumber": "string", "city": "string", "countryId": 0, "dateEnd": "2025-06-19", "dateBegin": "2025-06-19", "district": "string", "email": "string", "exposeLocation": true, "fax": "string", "houseNumber": "string", "houseNumberSuffix": "string", "latitude": 0, "longitude": 0, "mobilePhone": "string", "mobilePhone2": "string", "municipality": "string", "poBox": "string", "poBoxZipcode": "string", "poBoxCity": "string", "privatePhone": "string", "stateId": 0, "workPhone": "string", "zipCode": "string" }, "mailAddress": { "accuracy": "ROOFTOP", "address1": "string", "address2": "string", "address3": "string", "alternateContactPerson": "string", "boxNumber": "string", "city": "string", "countryId": 0, "dateEnd": "2025-06-19", "dateBegin": "2025-06-19", "district": "string", "email": "string", "exposeLocation": true, "fax": "string", "houseNumber": "string", "houseNumberSuffix": "string", "latitude": 0, "longitude": 0, "mobilePhone": "string", "mobilePhone2": "string", "municipality": "string", "poBox": "string", "poBoxZipcode": "string", "poBoxCity": "string", "privatePhone": "string", "stateId": 0, "workPhone": "string", "zipCode": "string" }, "translations": [ { "language": "string", "name": "string", "description": "string", "shortDescription": "string" } ] }'

Response

{
  "locationPriority": 0,
  "locationNumber": 0,
  "resArrivalDateFrom": "2025-06-19",
  "internalLocationNumber": "string",
  "code": "string",
  "locationId": 0,
  "parentId": 0,
  "archivedFrom": "2025-06-19",
  "translations": [
    {
      "language": "string",
      "name": "string",
      "description": "string",
      "shortDescription": "string"
    }
  ],
  "mailAddress": {
    "addressId": 0,
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "boxNumber": "string",
    "houseNumberSuffix": "string",
    "zipCode": "string",
    "poBox": "string",
    "poBoxZipcode": "string",
    "poBoxCity": "string",
    "city": "string",
    "countryId": 0,
    "municipality": "string",
    "mobilePhone2": "string",
    "latitude": 0,
    "longitude": 0,
    "email": "string",
    "stateId": 0,
    "mobilePhone": "string",
    "houseNumber": "string",
    "district": "string",
    "privatePhone": "string",
    "workPhone": "string",
    "exposeLocation": true,
    "dateEnd": "2025-06-19",
    "dateBegin": "2025-06-19",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "visitAddress": {
    "addressId": 0,
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "boxNumber": "string",
    "houseNumberSuffix": "string",
    "zipCode": "string",
    "poBox": "string",
    "poBoxZipcode": "string",
    "poBoxCity": "string",
    "city": "string",
    "countryId": 0,
    "municipality": "string",
    "mobilePhone2": "string",
    "latitude": 0,
    "longitude": 0,
    "email": "string",
    "stateId": 0,
    "mobilePhone": "string",
    "houseNumber": "string",
    "district": "string",
    "privatePhone": "string",
    "workPhone": "string",
    "exposeLocation": true,
    "dateEnd": "2025-06-19",
    "dateBegin": "2025-06-19",
    "fax": "string",
    "alternateContactPerson": "string",
    "accuracy": "ROOFTOP",
    "country": {
      "countryId": 0,
      "priority": 0,
      "translations": [
        {
          "name": "string",
          "language": "string"
        }
      ],
      "default": true,
      "code": "string"
    }
  },
  "adminOrganisationId": 0,
  "origin": "string",
  "originId": "string",
  "bookableLocation": true,
  "previousPmsId": "string",
  "minAgeForBooking": 0
}

Activities

Endpoints

GET

Amenitylinks

Endpoints

GET
GET
PUT

Details

Endpoints

GET
GET

Dynamicfields

Endpoints

GET
PUT

Images

Endpoints

GET

Priorities

Endpoints

GET
GET
POST

Search

Endpoints

POST

Search for locations

The above endpoint is used to search through the availability of the whole inventory based on locations. The endpoint will club the accommodation types with availability per location and provide them as a nested list within the location entity. The result can be filtered based on the provided request criteria. For example: arrival date, duration, locations, amenities and subjects are possible filters. The result can contain filter options, filter options provide all possible filter possibilities based on the currently provided filter options. This provides you with all possible arrivals, departures, locations and amenities as per the criteria passed in the request. In case of prebooking, the accommdationtype prices are null. The "dateMargin" request parameter will provide up to 4 alternative stays according to the number that is supplied in "dateMargin" in case there is no match with the requested criteria. It's up to the client to choose which of these alternatives to use. In case there is an exact match with the requested stay dates only 1 available stay is provided in the result. In case no request parameters are provided by default for each accommodation type the cheapest option over all available stays is returned. This is also the case if multiple prices are available for one stay. See below diagram for an explanation on how the alternative stays work: image:images/DateMarginFlowDiagram.png[DateMarginFlowDiagram role="text-center"]

Query Parameters

defaultSelectionstring

nearest_arrival, cheapest_price [nearest_arrival - First available arrival(based on today's date) if no arrival date is provided. cheapest_price - sort based on cheapest price]

segmentIdinteger (int64)

if provided, it will fetch the location priorities based on this segmentId.if not provided, but segments are used, it will use the priority configured on the location level instead and sort the location based on that

sortstring

if provided, it will sort the location priorities in the given direction. if not provided, it will sort the location priorities in ascending order. Possible : LOCATION_PRIORITY_ASC, LOCATION_PRIORITY_DESC.

Enum values:
LOCATION_PRIORITY_ASCLOCATION_PRIORITY_DESC

Body Parameters

distributionChannelIdinteger (int64)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 (date)

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

durationinteger (int32)

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 and arrivals available for the requested criteria are displayed in response.

Show child attributes

offerCodestring

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

offerIdinteger (int64)
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

petQuantityinteger (int32)

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 (int64)

Region id passed to fetch locations which belong to the provided region

includeAccommodationtypesboolean

An option to return the accommodationtypes in the response or not

dateMargininteger (int32)

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 ...

Enum values:
ARRIVAL_DATEDURATIONARRIVAL_DATE_AND_DURATIONDURATION_AND_ARRIVAL
minNrOfBathroomsinteger (int32)
maxNrOfBathroomsinteger (int32)
minNrOfBedroomsinteger (int32)
maxNrOfBedroomsinteger (int32)
redeemableLoyaltyPointsinteger (int32)

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

500
Object
Error occurred while fetching locations

POST

/maxxton/v2/locations/search?defaultSelection=&segmentId=&sort=LOCATION_PRIORITY_ASC

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 curl --location 'https://api.maxxton.net/maxxton/v2/locations/search?sort=LOCATION_PRIORITY_ASC' \ --data '{ "distributionChannelId": 0, "arrivalDate": "2025-06-19", "duration": 0, "filterOptions": [ "" ], "offerCode": "string", "offerId": 0, "subjects": { "persons": [ { "maxAge": "string", "quantity": 0 } ] }, "locationIds": [ "" ], "petQuantity": 0, "amenityIds": [ "" ], "accommodationKindIds": [ "" ], "includeFilterOptionCounts": true, "regionId": 0, "includeAccommodationtypes": true, "dateMargin": 0, "dateMarginMethod": "ARRIVAL_DATE", "minNrOfBathrooms": 0, "maxNrOfBathrooms": 0, "minNrOfBedrooms": 0, "maxNrOfBedrooms": 0, "redeemableLoyaltyPoints": 0 }'

Response

{
  "result": {
    "totalElements": 0,
    "totalPages": 0,
    "first": true,
    "last": true,
    "size": 0,
    "content": [
      {
        "accommodationtypes": [
          {
            "resourceId": 0,
            "accommodationKindId": 0,
            "arrivalDate": "2025-06-19",
            "departureDate": "2025-06-19",
            "offerCode": "string",
            "basePrice": 0,
            "basePriceInclusive": 0,
            "offerPrice": 0,
            "offerPriceInclusive": 0,
            "totalCapacity": 0,
            "referencePrice": 0,
            "referencePriceInclusive": 0,
            "duration": 0,
            "rateTypeId": 0,
            "nrOfBathrooms": 0,
            "nrOfBedrooms": 0,
            "loyaltyPrice": 0,
            "loyaltyPriceInclusive": 0,
            "requiredLoyaltyPoints": 0,
            "freeLoyaltyDuration": 0
          }
        ],
        "locationId": 0
      }
    ],
    "number": 0,
    "sort": [
      {
        "direction": "string",
        "nullHandling": "string",
        "ascending": true,
        "property": "string",
        "ignoreCase": true
      }
    ],
    "numberOfElements": 0,
    "empty": true
  },
  "filterOptionsResult": {
    "arrivals": [
      ""
    ],
    "departures": [
      ""
    ],
    "amenities": [
      ""
    ],
    "accommodationKinds": [
      ""
    ]
  }
}

Subjects

A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.

Endpoints

GET

Locks

A lock will make the accommodationtype or unit unavailable to book because of a certain reason like maintenance.

Endpoints

GET

Memos

A remark or informative text added to an entity.

Endpoints

GET

Offer

A discount or additional product/service that can be added to a reservation.

Endpoints

POST
GET
GET
PUT
POST
GET
GET
PUT
POST
DELETE
GET
GET
GET
POST
GET
POST
POST
GET

Operations

Technical services which handles tasks to fix issues or maintenance in units.

Endpoints

GET
GET
GET

Owners

An individual or entity that holds a contractual agreement with the admin organization. Based on this agreement, the owner earns income when specific accommodations they control are utilized in reservations.

Endpoints

POST
GET
GET
PUT
GET
GET
GET
PUT
GET
GET
GET
POST
GET
GET
GET
POST
GET
GET
GET
GET
GET
PUT

Packages

Multiple add-ons which can be booked together.

Endpoints

GET
GET

Payment Term Set

Conditions like when and in how many times to pay the full reservation. The payment term sets will result in the instalments, with the actual amount to pay, when chosen in the reservation.

Endpoints

GET

Points Of Interests

Certain interesting features around the location such as cities, airports, theme parks.

Endpoints

GET
GET

Predefined Memo

A brief written message or note used for communication or record-keeping within the software.

Endpoints

GET

Rate Types

The category or classification of rates based on their application and currency such as BAR rate or tour operator rate.

Endpoints

GET
GET
GET

Region

A geographical area or division used for organizing and managing locations or data.

Endpoints

GET
GET

Rentability

The rules and conditions that define how an accommodation, product or services property can be booked or used. For example, the allowed arrival and departure date for an accommodation type.

Endpoints

GET
GET
GET

Representation

Triangle view of rentability, accommodation type, and distribution channel. Representations exist to connect a (set) of rentability rules to a (group) of distribution channels.

Endpoints

DELETE
GET
GET
PUT
POST
DELETE
GET

Resellers

An individual or entity that sells products or services on behalf of another company.

Endpoints

GET
GET
GET

Reservability

Actual count of available units per period or date without considering if it's allowed to arrive or depart on the certain date.

Endpoints

GET
GET
GET
GET
GET

Reservations

An arrangement to secure an accommodation or service for a specific time and date.

Endpoints

POST
POST
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
POST
GET
GET
GET
POST
GET
GET
GET
GET
POST
GET
GET
GET
GET
GET
POST
POST
POST
GET
POST
GET
POST
GET
DELETE
PUT
GET
GET
DELETE
GET
GET
PUT
POST
GET

Room Types

The classification of rooms based on their characteristics, such as bedroom, bathroom, or living area.

Endpoints

GET

Rooms

A distinct space within a unit provided for guests to stay.

Endpoints

GET
GET

Send Methods

Defines how to communicate with the customer.

Endpoints

GET

Subjects

A classification of individuals, pets, travel methods, or equipment based on specific criteria such as age, size, etc.

Endpoints

GET

Suppliers

An integration with Maxxton to make it possible to to book external inventory from the Maxxton system

Endpoints

GET

Units

A place where guests stay, such as a hotel room, apartment, or vacation rental.

Endpoints

POST
GET
GET
PUT
GET
POST
DELETE
GET
GET
PUT
GET
GET
GET
GET
GET
GET
GET
GET
PUT
GET
PUT
POST
GET
POST
DELETE
GET
GET
GET
POST
GET