Maxxton

Overview 

URI Scheme

Authentication

API Pricing

Filtering

Pagination

Sorting

Date Fields

Header

Error Codes

Swagger API definition

Entity Relations

Flows

Event Flow

Reservation Flow

Maxxton Environments

Worldline Integration

Webhooks

Contact Information

Default

Third Party API Guides

Production

<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >This section contains all the key information you need to know while using the REST API. You can find here how filtering, pagination, and sorting can be used but also how date fields, and header parameters work. It includes a list of all the error codes you can come across while using our API.</p><p class="slate-p " >Besides this, we have created some flows on the most used scenarios. These flows define step by step how you can create a booking module or use the events from the REST API.</p><p class="slate-p " >There is also a webhook available to push information to your system instead of using the REST API to pull information.</p><p class="slate-p " ></p>

This section contains all the key information you need to know while using the REST API. You can find here how filtering, pagination, and sorting can be used but also how date fields, and header parameters work. It includes a list of all the error codes you can come across while using our API.

Besides this, we have created some flows on the most used scenarios. These flows define step by step how you can create a booking module or use the events from the REST API.

There is also a webhook available to push information to your system instead of using the REST API to pull information.

<p class="slate-p " >Host : </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Test/Acceptance: <span style="color:#4B85E8">https://api-test.maxxton.net </span></div></li><li class="slate-li " ><div style="position:relative">Production/Staging: <span style="color:#4B85E8">https://api.maxxton.net</span></div></li></ul><p class="slate-p " >
BasePath : /maxxton/v2
Schemes : HTTPS</p><p class="slate-p " ></p>


BasePath : /maxxton/v2
Schemes : HTTPS

<p class="slate-p " >Maxxton External APIs are secure RESTful web services and authentication(OAuth2) is required to access them, user will be authenticated based on the token passed in the request.</p><h2 class="slate-h2 " >Generate access token</h2><p class="slate-p " ><span style="color:#00FF00"><strong class="slate-bold">POST</strong></span> /maxxton/v2/authenticate </p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">CURL</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">curl --location ‘https://api.maxxton.net/maxxton/v2/authenticate’ </div><div class="slate-code_line">--header ‘Content-Type: application/x-www-form-urlencoded’ </div><div class="slate-code_line">--header ‘locale: nl_NL’ --data-urlencode ‘grantType={grant type}’ </div><div class="slate-code_line">--data-urlencode ‘clientId={client id}’ </div><div class="slate-code_line">--data-urlencode ‘clientSecret={client secret}’ </div><div class="slate-code_line">--data-urlencode ‘scope={concern code}’</div></div></code></pre></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Request body(x-www-form-urlencoded)</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:274px;">Name</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:274px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >grantType</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Authentication type, this is &apos;client_credentials&apos; for API.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >scope</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >3 letter code that specifies the environment used, usually an abbreviation of the clients name (this can be found in the Maxxton software URL).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >clientId</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The unique client identifier to access the API. This can be found in the Maxxton software back office where API users are configured.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >clientSecret</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The secret associated with client id to access the API. This can be found in the Maxxton software back office where API users are configured.</p></td></div></tr></tbody></table></div><p class="slate-p " >The responses that can be returned are:</p><h4 class="slate-h4 " ><span style="background-color:#ffffff;"><strong class="slate-bold">Responses</strong></span></h4><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">HTTP Code</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >500</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Error occurred while processing</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >200</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >OK. Access token is generated, which is used for further calls.</p></td></div></tr></tbody></table></div><p class="slate-p " >After generating the token, the access token can be used by adding it to the header parameters with
key: Authorization and value: {token_type} {access_token}</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The clientId and the clientSecret will be provided by Maxxton/Maxxton client as part of API credentials.</div></li><li class="slate-li " ><div style="position:relative">Please contact the particular Maxxton client to request API credentials to access their Maxxton environment and data.</div></li><li class="slate-li " ><div style="position:relative">Scope can be used for passing the concern parameter but scope is preferred as it is fully oauth2 compatible.</div></li></ul><p class="slate-p " >For more information: <a href="https://developers.maxxton.com/rest-api/authentication/authenticate" target="">Login</a></p><p class="slate-p " ></p>

Maxxton External APIs are secure RESTful web services and authentication(OAuth2) is required to access them, user will be authenticated based on the token passed in the request.

Name

Description

HTTP Code

After generating the token, the access token can be used by adding it to the header parameters with
key: Authorization and value: {token_type} {access_token}

<p class="slate-p " >The API costs are based on the number of requests per month, the first 750,000 requests per month(25,000 requests per day) are not charged. Subsequent  requests are charged as per the API price calculator. The processes can be speeded up by making multiple API requests at the same time, this is called concurrent calls in the model. Concurrent calls have a bigger impact on the Maxxton API resources, therefore extra costs are charged.</p><h1 class="slate-h1 " >Pricing-slider</h1><h4 class="slate-h4 " >Notes applicable to the API Pricing</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The number of concurrent calls is limited to the maximum number per IP, by default this is 15.</div></li><li class="slate-li " ><div style="position:relative">The number of concurrent calls will be used as a logarithmic parameter in the pay-per-use model and will impact the charges on actual usage.</div></li><li class="slate-li " ><div style="position:relative">The number of requests is not limited and will be charged based on actual usage.</div></li><li class="slate-li " ><div style="position:relative">Costs only apply to the new Maxxton REST API.</div></li><li class="slate-li " ><div style="position:relative">The number of requests only applies to the production API (api.maxxton.net).</div></li><li class="slate-li " ><div style="position:relative">The acceptance (api-test.maxxton.net) API can be used free of charge, subject to adherence to the fair use policy.</div></li><li class="slate-li " ><div style="position:relative">Fair use policy applies to both production and acceptance API.</div></li><li class="slate-li " ><div style="position:relative">API Support is included for daily support questions</div></li><li class="slate-li " ><div style="position:relative">Development of new features and project guidance/management are charged per hour.</div></li><li class="slate-li " ><div style="position:relative">Clients can request new features to decrease the REST API usage. Maxxton will, commercially reasonable, develop new features on request to decrease API usage.</div></li></ul><h4 class="slate-h4 " >Fair Use Policy</h4><p class="slate-p " >On our API we do not have a fixed restriction on the number of API calls. However, a Fair Use Policy applies to the usage of the API.</p><p class="slate-p " >Normal usage is permitted. Excessive usage is not permitted. Excessive usage means, the usage which has an impact on our server performance or impact on other customers who use the API.</p><p class="slate-p " ></p>

The API costs are based on the number of requests per month, the first 750,000 requests per month(25,000 requests per day) are not charged. Subsequent  requests are charged as per the API price calculator. The processes can be speeded up by making multiple API requests at the same time, this is called concurrent calls in the model. Concurrent calls have a bigger impact on the Maxxton API resources, therefore extra costs are charged.

On our API we do not have a fixed restriction on the number of API calls. However, a Fair Use Policy applies to the usage of the API.

Normal usage is permitted. Excessive usage is not permitted. Excessive usage means, the usage which has an impact on our server performance or impact on other customers who use the API.

<p class="slate-p " >Many calls contain filtering, this is a way to filter the output of the calls. In the REST documentation, it says filter parameter where this can be used. filtering means you can filter on any non-nested field in the output with the following features:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:204px;">Definition</div><div style="width:110px;">Symbol              </div><div style="width:349px;">Usage</div><div style="width:0px;">Result</div></div><colgroup ><col style="width:204px"><col style="width:110px"><col style="width:349px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Equals</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >:          </p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">?filter=name:bob</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Selects all the records where the name contains the String bob.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Strict Equals</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >::</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >?filter=name::bob</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Selects all the records where the name is strictly equals to bob.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Not Equals</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">!:</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">?filter=name!:bob</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Selects all the records where the name is not equal to bob.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Greater Than</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">&gt;</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">?filter=age&gt;30</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Selects all the records where the age is greater than 30.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Greater Than Equals</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">&gt;:</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">?filter=age&gt;:30</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Selects all the records where the age is greater than or equal to 30.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Less Than</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">&lt;</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">?filter=age&lt;30</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Selects all the records where the age is less than 30.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Less Than Equals</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">&lt;:</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">?filter=age &lt;: 30</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Selects all the records where the age is less than or equal to 30.</p></td></div></tr></tbody></table></div><p class="slate-p " >These are the operators you can use in the filtering of the filter:</p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:286px;">Definition</div><div style="width:176px;">Symbol</div><div style="width:371px;">Usage</div><div style="width:0px;">Result</div></div><colgroup ><col style="width:286px"><col style="width:176px"><col style="width:371px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Chain multiple filters (OR)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >||</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >?filter=name:Bob||age=30</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Selects all the records where name is Bob or age is 30.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Creating a single filter or chain multiple(AND)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >&amp;</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >?filter=name:Bob&amp;filter=age:30</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Selects all the records where name is Bob and age is 30.</p></td></div></tr></tbody></table></div><p class="slate-p " ><em class="slate-italic">Note: The above operators need to be encoded to work in some cases.</em></p><p class="slate-p " ></p>

Many calls contain filtering, this is a way to filter the output of the calls. In the REST documentation, it says filter parameter where this can be used. filtering means you can filter on any non-nested field in the output with the following features:

Definition

Symbol              

Usage

Result

These are the operators you can use in the filtering of the filter:

Symbol

Note: The above operators need to be encoded to work in some cases.

<p class="slate-p " >Pagination is used to divide large response into small response which leads minimizing the response time. General concept is separating a large page into small pages. Most of the Maxxton External API endpoints follow pagination. You can control the number of results returned in a single request by specifying the page number and page size. Page and Size are 2 request parameters that can be used with request to control pagination.</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:281px;">Name</div><div style="width:687px;">Description</div></div><colgroup ><col style="width:281px"><col style="width:687px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >page</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Default page is 0, Page can be used to extract response of specific page.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >size</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Default size is 20, Size can be used to extract required no of elements per specific page.</p></td></div></tr></tbody></table></div><p class="slate-p " >With every response, there are few parameters in response that gives information about the pagination followed in request.</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:356px;">Size</div><div style="width:612px;">Size value considered for request</div></div><colgroup ><col style="width:356px"><col style="width:612px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >number</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Page no considered for request</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >numberOfElements</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No of elements fetched in the response</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >totalElements</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Total no of elements that can be fetched</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >totalPages</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Total no of pages that can be requested</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >first</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >True if its a first page, else False</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >last</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >True if its a last page, else False</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

Pagination is used to divide large response into small response which leads minimizing the response time. General concept is separating a large page into small pages. Most of the Maxxton External API endpoints follow pagination. You can control the number of results returned in a single request by specifying the page number and page size. Page and Size are 2 request parameters that can be used with request to control pagination.

With every response, there are few parameters in response that gives information about the pagination followed in request.

Size

Size value considered for request

<p class="slate-p " >Sorting is used to order the response based on the values of a particular field of the response. General concept is fetching a page/list of response in the ascending or descending order of the specified field. Sorting is possible in all the endpoints where pagination is supported.</p><p class="slate-p " >This can be done by specifying the sort request parameter with the field name and order of descending, as follows:
sort=fieldname,desc or sort=fieldname,asc</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:157px;">Name</div><div style="width:766px;">Description</div></div><colgroup ><col style="width:157px"><col style="width:766px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >sort</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Default sorting is asc if only sort=fieldname is used, orders the response based on a particular field of the response.</p></td></div></tr></tbody></table></div><p class="slate-p " >With every sorted response, there are few parameters under the section <em class="slate-italic">sort</em> at the end of page that gives information about the sorting followed in request.</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:0px;">direction</div><div style="width:771px;">The order of the sorting. ASC for ascending or DESC for descending</div></div><colgroup ><col style="width:initial"><col style="width:771px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >property</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The fieldname in the response whose value was used for sorting the response</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >direction</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The order of the sorting . ASC for ascending or DESC for descending</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ignoreCase</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Whether casing of alphanumeric values was considered in sorting in case of string fields</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >nullHandling</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Enumeration for null handling hints that can be used in the sorting. Typical values are NATIVE, NULLS_FIRST or NULLS_LAST</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ascending</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >True if sorting was ascending, else False</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >descending</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >True if sorting was descending, else False</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

Sorting is used to order the response based on the values of a particular field of the response. General concept is fetching a page/list of response in the ascending or descending order of the specified field. Sorting is possible in all the endpoints where pagination is supported.

This can be done by specifying the sort request parameter with the field name and order of descending, as follows:
sort=fieldname,desc or sort=fieldname,asc

With every sorted response, there are few parameters under the section 

 at the end of page that gives information about the sorting followed in request.

direction

The order of the sorting. ASC for ascending or DESC for descending

<p class="slate-p " >Following is the description of different date fields used in various domains of API endpoints.</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:0px;">Name</div><div style="width:743px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:743px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >reservationDate</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date the guest creates the reservation.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >arrivalDate</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date the guest arrives.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >departureDate</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date the guest leaves.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >stayDateFrom</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Start of period within a period of the reservation (between and including arrival and departure date).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >stayDateTo</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >End of period within a period of the reservation (between and including arrival and departure date).</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

Following is the description of different date fields used in various domains of API endpoints.

<p class="slate-p " >Header parameters contain important meta-data related to the API request and response. These parameters can be used with Maxxton APIs to customize the behavior of the request and response. Below are the header parameters you can use:</p><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:193px;">Name</div><div style="width:434px;">Description</div><div style="width:0px;">Example</div></div><colgroup ><col style="width:193px"><col style="width:434px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >locale</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This header can be used to filter the translations in the response for a specific language. The language code (and optionally the country code) should be provided as the value of the <code class="slate-code">locale</code> header.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">locale=en</code>
 or
 <code class="slate-code">locale=en_US</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >x-show-archived</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >This header allows you to include archived data in the response. Set the value to &quot;true&quot; to include archived data or &quot;false&quot; to exclude it from the response.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">x-show-archived=true</code>
 or
 <code class="slate-code">x-show-archived=false</code></p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

Header parameters contain important meta-data related to the API request and response. These parameters can be used with Maxxton APIs to customize the behavior of the request and response. Below are the header parameters you can use:

Example

<p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:190px;">ErrorCode</div><div style="width:501px;">Description</div><div style="width:0px;">HTTP Status</div></div><colgroup ><col style="width:190px"><col style="width:501px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

ErrorCode

HTTP Status

<p class="slate-p " >Swagger enables the import of all endpoints into your preferred API tool based on the Open API specification, allowing for a comprehensive overview and streamlined integration. Additionally, the Swagger documentation provides a complete list of available endpoints.</p><p class="slate-p " >
Url:  <a href="https://api.maxxton.net/maxxton/v2/swagger/index.html" target="_blank">The Swagger UI Rest client</a></p><p class="slate-p " ></p>

Swagger enables the import of all endpoints into your preferred API tool based on the Open API specification, allowing for a comprehensive overview and streamlined integration. Additionally, the Swagger documentation provides a complete list of available endpoints.


A location is a group of accommodation types at the same location which provides an array of accommodation types typically including entertainment and recreational activities.
A location may contain one or multiple accommodation types.


An accommodation type is a group of similar units, where units are configured to define the type (Room, Bungalow, Chalet, etc.) and other configurations (Representation, Capacity, Cashflow, Rentability, Reservability, Amenities, etc.).
An accommodation type may contain one or multiple units.


A unit is a room, group of rooms, or bungalow in which someone may live or stay. It can be a single room, bungalow, chalet, etc.

Diagrammatic representation of Location, Accommodation types, and Units:

In the Maxxton system, resources (items) are available in multiple types such as Accommodation type, add-on, or offers. These resources can be booked when creating a reservation, where a reserved resource is added to the reservation as a booked version of the actual resource. A resource is unique in the system and used across multiple reservations, while a reserved resource is unique to the reservation.

Diagrammatic representation of Resources and Reserved resources:

<p class="slate-p " >The Flows section provides a detailed breakdown of the most common integration processes for the REST API, offering step-by-step guidance on how to seamlessly incorporate API functionalities into your project. Users can gain a comprehensive understanding of the most common integration scenarios, enabling them to efficiently navigate and implement API interactions within their applications.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Flows section provides a detailed breakdown of the most common integration processes for the REST API, offering step-by-step guidance on how to seamlessly incorporate API functionalities into your project. Users can gain a comprehensive understanding of the most common integration scenarios, enabling them to efficiently navigate and implement API interactions within their applications.

The webhook solution is integrated into Maxxton Software's Integration Manager and will push data when certain configured data changes are triggered. Unlike the REST API, webhooks cannot be polled but will push data to the subscribed endpoint. Maxxton’s webhook implementation follows standard webhook guidelines. The data structures used are the same as those for the REST API, meaning the REST API documentation applies, and any adjustments made to the REST API will also apply to the webhooks.

There are three main concepts in the Maxxton webhook system:

Every webhook request will have the following structure:

Events are organized by context and type. The context determines the available events and data for the webhook request. The specific event that triggered the webhook request can be identified by the “type” field in the webhook request. The following contexts and events are currently supported:

The data available depends on the selected context. All data is populated through the REST API, and the data structure is the same as that of the REST API. For specific field and entity descriptions, please refer to the REST API documentation.

Context

Data

Cardinality

Endpoint Used

The endpoint used to send the webhook requests can optionally require authentication. The following authentication types are supported:

The receiving party can use a webhook secret to verify that the delivered message is from Maxxton. During webhook setup, the user can provide a secret token, which must be stored securely on their server. Each incoming webhook payload must be validated against the token.

 (Hash-based Message Authentication Code) to generate a hash signature. The signature is generated using the payload content and the provided webhook secret. The signature is sent in the 

Webhooks can be configured through the Maxxton Software Integration Manager under the 

 tab. Access to this module is required to set up new webhooks or view statistics. Please note that Maxxton does not grant access to this module; it is managed by our clients, who are responsible for configuring the webhooks.

To receive requests, you do not need access to Maxxton software.

If you have questions, please contact the party who configured the webhooks for you (usually the Maxxton client). In case of technical queries, a ticket can be created in the Maxxton ticket system or an email can be sent to 

<p class="slate-p " ></p><p class="slate-p " >In case of questions, feedback, or issues you can contact the Maxxton API support by creating a ticket through the <a href="https://support.maxxton.com" target="_blank">Maxxton ticket system </a>(you need an account for this) or reach out to our support team by using the email address below:</p><p class="slate-p " >Contact Email: api@maxxton.com</p><p class="slate-p " >Ticket system: <a href="https://support.maxxton.com" target="">https://support.maxxton.com</a> </p><p class="slate-p " ></p>

In case of questions, feedback, or issues you can contact the Maxxton API support by creating a ticket through the 

(you need an account for this) or reach out to our support team by using the email address below:

Sections