NAV
Shell Ruby PHP JavaScript

Introduction

Welcome to the Booking Experts API v3 reference documentation. API calls are made by a Booking Experts App. For more information on Booking Experts Apps, please see our App Guide.

Basics

Standards

The Booking Experts API is organized around REST and it follows the JSON API specification. The API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.

Documentation is standardized by using the Open API 3 (OAS3) specification, this allows you to inspect the API using other clients like for example Swagger UI and Postman. The specification is hosted here: https://api.bookingexperts.nl/v3/oas3.json

Responses

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations \
  --header 'accept: application/vnd.api+json' \
  --header 'accept-language: en,nl' \
  --header 'x-api-key: API_KEY'

Might produce the following output

{
  "errors": [
    {
      "status": 401,
      "code": "RESOURCE_NOT_FOUND",
      "title": "Unauthorized error",
      "detail": "Please make sure to set the Authorization HTTP header"
    }
  ]
}

The Booking Experts API will always respond with a HTTP status code. The API can return the following codes:

Code Semantic Meaning
200 OK Request was successful
400 Bad Request Parameters for the request are missing or malformed. Body contains the errors.
401 Unauthorized Your API key is wrong
403 Forbidden IP is blacklisted for API usage, see Throttling information
404 Not Found Entity not found
422 Unprocessable entity Saving the entity in the database failed due to validation errors. Body contains the errors.
429 Too Many Requests You're requesting too many kittens! Slow down!
5XX Server Errors Something went wrong on Booking Experts's end. We are probably already busy solving the issue. It's your responsibility to retry the request at a later point.

Accept Language

You can always pass an Accept-Language header containing a comma separated list of locales. This will limit the result of 'localized' attributes to the locales specified.

X_BE_ENV header

When your application receives a request from Booking Experts, for example when a webhook or command is called, the X_BE_ENV header is passed. Usually, the value of this header will be 'production', denoting that the request originated from our production environment. For testing purposes however, it might be possible that your app will receive requests from a different environment, for example 'staging'. You can check this header if you want to handle these requests differently.

X_BE_SIGNATURE header

When your application receives a request from Booking Experts, for example when a webhook or command is called, the X_BE_SIGNATURE header is passed to allow you to verify that the request was sent by our systems. It uses a HMAC hexdigest to compute the hash based on your Client Secret.

To verify a request, your code should look something like this:

def verify_signature(payload_body)
  signature = 'sha256=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), ENV['OAUTH_CLIENT_SECRET'], payload_body)
  return halt 500, "Signatures didn't match!" unless Rack::Utils.secure_compare(signature, request.env['HTTP_X_BE_SIGNATURE'])
end
import os

secret = os.environ['OAUTH_CLIENT_SECRET']
header_signature = request.headers.get('X_BE_SIGNATURE')

# HMAC requires the key to be bytes, but data is string
mac = hmac.new(str(secret), msg=request.data, digestmod='sha256')

# Python prior to 2.7.7 does not have hmac.compare_digest
if hexversion >= 0x020707F0:
  if not hmac.compare_digest(str(mac.hexdigest()), str(signature)):
    abort(403)
else:
  # What compare_digest provides is protection against timing
  # attacks; we can live without this protection for a web-based
  # application
  if not str(mac.hexdigest()) == str(signature):
    abort(403)
$sig_check = 'sha256=' . hash_hmac('sha256', Request::getContent(), $_ENV['OAUTH_CLIENT_SECRET']);

if ($sig_check === Request::header('HTTP_X_BE_SIGNATURE')) {  // php >=5.6 and above should use hash_equals() for comparison
  // sigs match, do stuff
}

Throttling

Usage of the Booking Experts API is virtually unlimited. However, to prevent fraud and abuse, requests to the API are throttled. By default you are allowed to call the API 500 times within a moving window of 15 minutes. Additionally, bursts of 100 calls per minute are allowed within this window.

While within the limit, each response contains a X-RateLimit-Limit and a X-RateLimit-Remaining header containing the set limit & the remaining allowance in the window. If you exceed the limit, the API will respond with a 429 Too many requests response. This response contains a header Retry-After containing the time after which a new calls are allowed.

If your use case requires more lenient rate limits, please contact us at api@bookingexperts.nl to request a higher limit.

Pagination

{
  "links": {
    "self": "https://api.bookingexperts.nl/v3/administrations/1/reservations?page%5Bnumber%5D=2",
    "first": "https://api.bookingexperts.nl/v3/administrations/1/reservations?page%5Bnumber%5D=1",
    "last": "https://api.bookingexperts.nl/v3/administrations/1/reservations?page%5Bnumber%5D=14",
    "prev": "https://api.bookingexperts.nl/v3/administrations/1/reservations?page%5Bnumber%5D=1",
    "next": "https://api.bookingexperts.nl/v3/administrations/1/reservations?page%5Bnumber%5D=3"
  }
  "data": [...]
}

All collection responses include pagination. In the response body you will find a links node that contains links to first, self, next, prev, last pages. Most responses have 30 records per page.

Sparse field sets

By default every request returns a quite complete set of fields (attributes and relationships). You can limit or expand this default set however. Per record type you can specify which fields to include.

curl --request GET \
  --url 'http://api.lvh.me:3000/v3/administrations?fields[administration]=name,description' \
  --header 'accept: application/vnd.api+json' \
  --header 'accept-language: en,nl' \
  --header 'x-api-key: API_KEY' | jsonpp

Will return only the name and description fields of every administration. Note that this will also omit defined relationships of the resource.

Includes

Includes are a standard part of the jsonapi specification. Each relationship on a resource can be included. Which relationships a resource has can be determined by looking at its Schema.

As an example: the Reservation resource defines a relationship called extra_order_items. This means that you can add extra_order_items to the includes list in the query string. In turn, the ExtraOrderItem has a relationship with an extra, so you could in that case also include the metadata of the associated extra by specifying extra_order_items.extra in your includes list. When you only need the ID of a relationship, it is not necessary to include a resource, as the ID is defined within the relationship itself.

Filters

The following attribute filters are available on GET API calls:

All expressions can be inverted by prefixing a !, this holds for the entire expression.

OR-filtering

An OR filter can be created by separating attribute names in a filter with a pipe:

Security

{
  "errors": [{
    "status": "403",
    "code": "NO_VALID_SCOPE",
    "title": "Forbidden",
    "detail": "The scopes for your application do not grant you permission to perform this action. One of the following scopes is required: payment|write."
  }]
}

To be able to fetch resources, either directly or through including related resources, you need the appropriate permissions. Permissions can be defined in you App's settings and they translate into OAuth2 scopes that the user needs to explicitly approve. When you are missing permissions for the call you are executing, an error will be returned like the one on the right.

Note: When you update your App's permissions, these will apply directly when using API keys. When using OAuth2 however, subscribers will need to grant permission again in order for the new permissions to be applied.

Example permissions (scopes):

There are also some channel specific permissions. This functionality is meant for tour operators who don't need to access all reservations, but only reservations and related resources that have been created through their own channel:

Authorization scopes

Scope Scope Description
accommodation_subtype read
administration read
agenda_period read
agreement read
amenity read
area_type read
availability read
booking read
category_group read
category read
channel::booking read
channel::customer read
channel::order read
channel::reservation read
channel delete
channel read
channel write
city read
contact read
cost read
currency_conversion read
customer read
customer write
debtor read
discount_action read
discount_card read
executor read
extra_order_item read
extra_order_item write
extra read
facility read
guest read
internal_message write
invoice read
journal_transaction read
label read
label write
ledger_account read
main_order_item read
master_price_list read
master_price_list write
measurer read
memo write
message write
order read
organization read
owner read
package_entry read
package read
payment_handler read
payment_method read
payment_request read
payment_result write
payment read
payment write
period read
planner read
receipt read
region read
register read
rentable_identity read
rentable read
reservation read
reservation write
review_form read
review read
review write
room_type read
room read
signature read
signature write
terms read
todo_image delete
todo_image write
todo_list read
todo delete
todo read
todo write
user read
vat_code read
vat_tariff read

Administration Channels

Manage channels of an administration

GET channels

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/channels \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/channels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/channels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/channels");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/channels

Returns channels of the administration

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
page[number] query string false string Page number
page[size] query string false string Page size
sort query string false string Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \- to sort in descending order
fields[channel] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[email] query string false string Filter on email
filter[kind] query string false string Filter on kind
filter[rent_invoiced_to] query string false string Filter on rent_invoiced_to
filter[costs_invoiced_to] query string false string Filter on costs_invoiced_to
filter[use_costs_invoiced_to] query string false string Filter on use_costs_invoiced_to
filter[behave_as_own_site] query string false string Filter on behave_as_own_site
filter[confirm_reservations] query string false string Filter on confirm_reservations
filter[confirm_by_email] query string false string Filter on confirm_by_email
filter[customer_invoice_payable_on_park] query string false string Filter on customer_invoice_payable_on_park
filter[archived] query string false string Filter on archived
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[administration] query string false string Filter on administration. Specify a comma separated list of IDs to filter on.
filter[guest_payment_policy] query string false string Filter on guest_payment_policy. Specify a comma separated list of IDs to filter on.
filter[channel_payment_policy] query string false string Filter on channel_payment_policy. Specify a comma separated list of IDs to filter on.
filter[excluded_costs] query string false string Filter on excluded_costs. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.
include_archived query boolean false true When true, archived channels are included in the response

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "channel",
      "attributes": {
        "name": "Tours Inc.",
        "email": "info@tours.inc",
        "kind": "reseller",
        "available_currencies": [
          "EUR",
          "USD"
        ],
        "pricing_type": "string",
        "archivable": false,
        "synchronizes_costs": false,
        "allows_costs_with_multiple_price_periods": true,
        "allows_costs_with_negative_amounts": true,
        "determines_price": false,
        "rent_invoiced_to": "guest",
        "costs_invoiced_to": "guest",
        "use_costs_invoiced_to": true,
        "behave_as_own_site": false,
        "confirm_reservations": true,
        "confirm_by_email": false,
        "customer_invoice_payable_on_park": false,
        "fixed_attributes": [
          "kind",
          "pricing_type"
        ],
        "can_be_set_as_default_channel": false,
        "requires_cancellation_originator": false,
        "requires_restitution_after_cancellation": false,
        "uses_remote_reservation_key": false,
        "archived": true,
        "debtor_code": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "relationships": {
        "administration": {
          "data": {}
        },
        "guest_payment_policy": {
          "data": {}
        },
        "channel_payment_policy": {
          "data": {}
        },
        "excluded_costs": {
          "data": [
            null
          ]
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK ChannelCollectionResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [[Channel](#schemachannel)] false none [Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on.
Administrations can customize the following aspects for each Channel:

* Extras
* Costs
* Availability
* Rent prices
* Invoicing
]
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name string false none Name of the channel. This name is also shown in the back-office.
——— email string false none Contact email address of the channel. This email address is also shown in the back-office.
——— kind string false none Channel kind.
——— available_currencies [string] false none Lists the currencies that are available for this channel. One or more of: EUR, USD, CHF, CZK, TRY, CVE, ANG, GBP.
——— pricing_type string false none Type of pricing that applies to this channel. One of: night_prices, complex_prices.
——— archivable boolean false none Whether the channel can be archived or not.
——— synchronizes_costs boolean false none Whether the channel synchronizes costs or not.
——— allows_costs_with_multiple_price_periods boolean false none Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— allows_costs_with_negative_amounts boolean false none Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— determines_price boolean false none Whether the channel determines the price or not.
——— rent_invoiced_to string false none Whether the channel invoices rent to the guest or the channel.
——— costs_invoiced_to string false none Whether the channel invoices costs to the guest or the channel.
——— use_costs_invoiced_to boolean false none Whether the channel should use the costs_invoiced_to setting to determine invoicing or not. Setting this to false allows overriding the invoicing for individual costs.
——— behave_as_own_site boolean false none Whether the channel behaves as the own site channel or not. Must be false when kind is set to tour_operator.
——— confirm_reservations boolean false none Whether the channel automatically confirms reservations or not
——— confirm_by_email boolean false none Whether the channel sends the channel invoice to the specified email or not
——— customer_invoice_payable_on_park boolean false none Whether the guest invoice can be paid on arrival or not
——— fixed_attributes [string] false none Lists the attributes of the channel that cannot be freely edited in the back-office. One or more of: name, pricing_type, kind, rent_invoiced_to, costs_invoiced_to, use_costs_invoiced_to, behave_as_own_site, confirm_reservations, confirm_by_email, customer_invoice_payable_on_park, available_currencies, email.
——— can_be_set_as_default_channel boolean false none Whether the channel can be set as the default channel for new back office reservations etc. or not. Can only be specified on creation.
——— requires_cancellation_originator boolean false none Whether the channel requires the originator of reservation cancellations to be known or not. Can only be specified on creation.
——— requires_restitution_after_cancellation boolean false none Whether the channel requires mandatory restitution after a reservation cancellation or not. Can only be specified on creation.
——— uses_remote_reservation_key boolean false none Whether the channel uses a remote reservation key or not. Can only be specified on creation.
——— archived boolean false read-only Whether this channel has been archived or not.
——— debtor_code string false read-only A system wide unique identifier for this debtor
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_payment_policy object false none none
———— data object false none none
————— id string false none guest_payment_policy ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel_payment_policy object false none none
———— data object false none none
————— id string false none channel_payment_policy ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— excluded_costs object false none none
———— data [object] false none none
————— id string false none excluded_costs ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.
— meta object false none none
—— pagination object false none none
——— total_records integer false none none
——— page integer false none none
——— size integer false none none

Enumerated Values

Property Value
kind reseller
kind tour_operator
rent_invoiced_to guest
rent_invoiced_to channel
costs_invoiced_to guest
costs_invoiced_to channel

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

POST channel

Code samples

curl --request POST \
  --url https://api.bookingexperts.nl/v3/administrations/1/channels \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-API-KEY: API_KEY' \
  --data '{"data":{"type":"channel","attributes":{"name":"Tours Inc.","email":"info@tours.inc","kind":"reseller","available_currencies":["EUR","USD"],"pricing_type":"string","archivable":false,"synchronizes_costs":false,"allows_costs_with_multiple_price_periods":true,"allows_costs_with_negative_amounts":true,"determines_price":false,"rent_invoiced_to":"guest","costs_invoiced_to":"guest","use_costs_invoiced_to":true,"behave_as_own_site":false,"confirm_reservations":true,"confirm_by_email":false,"customer_invoice_payable_on_park":false,"fixed_attributes":["kind","pricing_type"],"can_be_set_as_default_channel":false,"requires_cancellation_originator":false,"requires_restitution_after_cancellation":false,"uses_remote_reservation_key":false},"relationships":{"administration":{"data":{"id":null,"type":null,"meta":null}},"guest_payment_policy":{"data":{"id":null,"type":null,"meta":null}},"channel_payment_policy":{"data":{"id":null,"type":null,"meta":null}},"excluded_costs":{"data":[{}]}},"meta":{"temp_id":"string"}}}'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/channels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/vnd.api+json'
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'
request.body = "{\"data\":{\"type\":\"channel\",\"attributes\":{\"name\":\"Tours Inc.\",\"email\":\"info@tours.inc\",\"kind\":\"reseller\",\"available_currencies\":[\"EUR\",\"USD\"],\"pricing_type\":\"string\",\"archivable\":false,\"synchronizes_costs\":false,\"allows_costs_with_multiple_price_periods\":true,\"allows_costs_with_negative_amounts\":true,\"determines_price\":false,\"rent_invoiced_to\":\"guest\",\"costs_invoiced_to\":\"guest\",\"use_costs_invoiced_to\":true,\"behave_as_own_site\":false,\"confirm_reservations\":true,\"confirm_by_email\":false,\"customer_invoice_payable_on_park\":false,\"fixed_attributes\":[\"kind\",\"pricing_type\"],\"can_be_set_as_default_channel\":false,\"requires_cancellation_originator\":false,\"requires_restitution_after_cancellation\":false,\"uses_remote_reservation_key\":false},\"relationships\":{\"administration\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"guest_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"channel_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"excluded_costs\":{\"data\":[{}]}},\"meta\":{\"temp_id\":\"string\"}}}"

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/channels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"data\":{\"type\":\"channel\",\"attributes\":{\"name\":\"Tours Inc.\",\"email\":\"info@tours.inc\",\"kind\":\"reseller\",\"available_currencies\":[\"EUR\",\"USD\"],\"pricing_type\":\"string\",\"archivable\":false,\"synchronizes_costs\":false,\"allows_costs_with_multiple_price_periods\":true,\"allows_costs_with_negative_amounts\":true,\"determines_price\":false,\"rent_invoiced_to\":\"guest\",\"costs_invoiced_to\":\"guest\",\"use_costs_invoiced_to\":true,\"behave_as_own_site\":false,\"confirm_reservations\":true,\"confirm_by_email\":false,\"customer_invoice_payable_on_park\":false,\"fixed_attributes\":[\"kind\",\"pricing_type\"],\"can_be_set_as_default_channel\":false,\"requires_cancellation_originator\":false,\"requires_restitution_after_cancellation\":false,\"uses_remote_reservation_key\":false},\"relationships\":{\"administration\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"guest_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"channel_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"excluded_costs\":{\"data\":[{}]}},\"meta\":{\"temp_id\":\"string\"}}}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "Content-Type: application/vnd.api+json",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = "{\"data\":{\"type\":\"channel\",\"attributes\":{\"name\":\"Tours Inc.\",\"email\":\"info@tours.inc\",\"kind\":\"reseller\",\"available_currencies\":[\"EUR\",\"USD\"],\"pricing_type\":\"string\",\"archivable\":false,\"synchronizes_costs\":false,\"allows_costs_with_multiple_price_periods\":true,\"allows_costs_with_negative_amounts\":true,\"determines_price\":false,\"rent_invoiced_to\":\"guest\",\"costs_invoiced_to\":\"guest\",\"use_costs_invoiced_to\":true,\"behave_as_own_site\":false,\"confirm_reservations\":true,\"confirm_by_email\":false,\"customer_invoice_payable_on_park\":false,\"fixed_attributes\":[\"kind\",\"pricing_type\"],\"can_be_set_as_default_channel\":false,\"requires_cancellation_originator\":false,\"requires_restitution_after_cancellation\":false,\"uses_remote_reservation_key\":false},\"relationships\":{\"administration\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"guest_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"channel_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"excluded_costs\":{\"data\":[{}]}},\"meta\":{\"temp_id\":\"string\"}}}";

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.bookingexperts.nl/v3/administrations/1/channels");
xhr.setRequestHeader("Content-Type", "application/vnd.api+json");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

POST /v3/administrations/{administration_id}/channels

Create a new channel that is associated to the current subscription

Body parameter

{
  "data": {
    "type": "channel",
    "attributes": {
      "name": "Tours Inc.",
      "email": "info@tours.inc",
      "kind": "reseller",
      "available_currencies": [
        "EUR",
        "USD"
      ],
      "pricing_type": "string",
      "archivable": false,
      "synchronizes_costs": false,
      "allows_costs_with_multiple_price_periods": true,
      "allows_costs_with_negative_amounts": true,
      "determines_price": false,
      "rent_invoiced_to": "guest",
      "costs_invoiced_to": "guest",
      "use_costs_invoiced_to": true,
      "behave_as_own_site": false,
      "confirm_reservations": true,
      "confirm_by_email": false,
      "customer_invoice_payable_on_park": false,
      "fixed_attributes": [
        "kind",
        "pricing_type"
      ],
      "can_be_set_as_default_channel": false,
      "requires_cancellation_originator": false,
      "requires_restitution_after_cancellation": false,
      "uses_remote_reservation_key": false
    },
    "relationships": {
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "excluded_costs": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.
body body object true [object Object] none
— data body object false [object Object] Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on.
—— type body string false channel Type
—— attributes body object false [object Object] Attributes
——— name body string false Tours Inc. Name of the channel. This name is also shown in the back-office.
——— email body string false info@tours.inc Contact email address of the channel. This email address is also shown in the back-office.
——— kind body string false reseller Channel kind.
——— available_currencies body [string] false EUR,USD Lists the currencies that are available for this channel. One or more of: EUR, USD, CHF, CZK, TRY, CVE, ANG, GBP.
——— pricing_type body string false string Type of pricing that applies to this channel. One of: night_prices, complex_prices.
——— archivable body boolean false false Whether the channel can be archived or not.
——— synchronizes_costs body boolean false false Whether the channel synchronizes costs or not.
——— allows_costs_with_multiple_price_periods body boolean false true Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— allows_costs_with_negative_amounts body boolean false true Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— determines_price body boolean false false Whether the channel determines the price or not.
——— rent_invoiced_to body string false guest Whether the channel invoices rent to the guest or the channel.
——— costs_invoiced_to body string false guest Whether the channel invoices costs to the guest or the channel.
——— use_costs_invoiced_to body boolean false true Whether the channel should use the costs_invoiced_to setting to determine invoicing or not. Setting this to false allows overriding the invoicing for individual costs.
——— behave_as_own_site body boolean false false Whether the channel behaves as the own site channel or not. Must be false when kind is set to tour_operator.
——— confirm_reservations body boolean false true Whether the channel automatically confirms reservations or not
——— confirm_by_email body boolean false false Whether the channel sends the channel invoice to the specified email or not
——— customer_invoice_payable_on_park body boolean false false Whether the guest invoice can be paid on arrival or not
——— fixed_attributes body [string] false kind,pricing_type Lists the attributes of the channel that cannot be freely edited in the back-office. One or more of: name, pricing_type, kind, rent_invoiced_to, costs_invoiced_to, use_costs_invoiced_to, behave_as_own_site, confirm_reservations, confirm_by_email, customer_invoice_payable_on_park, available_currencies, email.
——— can_be_set_as_default_channel body boolean false false Whether the channel can be set as the default channel for new back office reservations etc. or not. Can only be specified on creation.
——— requires_cancellation_originator body boolean false false Whether the channel requires the originator of reservation cancellations to be known or not. Can only be specified on creation.
——— requires_restitution_after_cancellation body boolean false false Whether the channel requires mandatory restitution after a reservation cancellation or not. Can only be specified on creation.
——— uses_remote_reservation_key body boolean false false Whether the channel uses a remote reservation key or not. Can only be specified on creation.
—— relationships body object false [object Object] Relationships
——— administration body object false [object Object] none
———— data body object false [object Object] none
————— id body string false string administration ID
————— type body string false administrations none
————— meta body object false [object Object] none
—————— temp_id body string false string UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method body string false string Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_payment_policy body object false [object Object] none
———— data body object false [object Object] none
————— id body string false string guest_payment_policy ID
————— type body string false payment_policy none
————— meta body object false [object Object] none
—————— temp_id body string false string UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method body string false string Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel_payment_policy body object false [object Object] none
———— data body object false [object Object] none
————— id body string false string channel_payment_policy ID
————— type body string false payment_policy none
————— meta body object false [object Object] none
—————— temp_id body string false string UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method body string false string Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— excluded_costs body object false [object Object] none
———— data body [object] false [object Object] none
————— id body string false string excluded_costs ID
————— type body string false none
————— meta body object false [object Object] none
—————— temp_id body string false string UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method body string false string Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta body object false [object Object] Metadata
——— temp_id body string false string UUID for internal resource linking. Should be omitted when the relationship ID is known.

Detailed descriptions

— data: Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on. Administrations can customize the following aspects for each Channel:

——— administration: null

——— guest_payment_policy: null

——— channel_payment_policy: null

——— excluded_costs: null

Enumerated Values

Parameter Value
——— kind reseller
——— kind tour_operator
——— rent_invoiced_to guest
——— rent_invoiced_to channel
——— costs_invoiced_to guest
——— costs_invoiced_to channel

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "channel",
    "attributes": {
      "name": "Tours Inc.",
      "email": "info@tours.inc",
      "kind": "reseller",
      "available_currencies": [
        "EUR",
        "USD"
      ],
      "pricing_type": "string",
      "archivable": false,
      "synchronizes_costs": false,
      "allows_costs_with_multiple_price_periods": true,
      "allows_costs_with_negative_amounts": true,
      "determines_price": false,
      "rent_invoiced_to": "guest",
      "costs_invoiced_to": "guest",
      "use_costs_invoiced_to": true,
      "behave_as_own_site": false,
      "confirm_reservations": true,
      "confirm_by_email": false,
      "customer_invoice_payable_on_park": false,
      "fixed_attributes": [
        "kind",
        "pricing_type"
      ],
      "can_be_set_as_default_channel": false,
      "requires_cancellation_originator": false,
      "requires_restitution_after_cancellation": false,
      "uses_remote_reservation_key": false,
      "archived": true,
      "debtor_code": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "relationships": {
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "excluded_costs": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK ChannelResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Channel](#schemachannel) false none Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on.
Administrations can customize the following aspects for each Channel:

* Extras
* Costs
* Availability
* Rent prices
* Invoicing
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name string false none Name of the channel. This name is also shown in the back-office.
——— email string false none Contact email address of the channel. This email address is also shown in the back-office.
——— kind string false none Channel kind.
——— available_currencies [string] false none Lists the currencies that are available for this channel. One or more of: EUR, USD, CHF, CZK, TRY, CVE, ANG, GBP.
——— pricing_type string false none Type of pricing that applies to this channel. One of: night_prices, complex_prices.
——— archivable boolean false none Whether the channel can be archived or not.
——— synchronizes_costs boolean false none Whether the channel synchronizes costs or not.
——— allows_costs_with_multiple_price_periods boolean false none Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— allows_costs_with_negative_amounts boolean false none Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— determines_price boolean false none Whether the channel determines the price or not.
——— rent_invoiced_to string false none Whether the channel invoices rent to the guest or the channel.
——— costs_invoiced_to string false none Whether the channel invoices costs to the guest or the channel.
——— use_costs_invoiced_to boolean false none Whether the channel should use the costs_invoiced_to setting to determine invoicing or not. Setting this to false allows overriding the invoicing for individual costs.
——— behave_as_own_site boolean false none Whether the channel behaves as the own site channel or not. Must be false when kind is set to tour_operator.
——— confirm_reservations boolean false none Whether the channel automatically confirms reservations or not
——— confirm_by_email boolean false none Whether the channel sends the channel invoice to the specified email or not
——— customer_invoice_payable_on_park boolean false none Whether the guest invoice can be paid on arrival or not
——— fixed_attributes [string] false none Lists the attributes of the channel that cannot be freely edited in the back-office. One or more of: name, pricing_type, kind, rent_invoiced_to, costs_invoiced_to, use_costs_invoiced_to, behave_as_own_site, confirm_reservations, confirm_by_email, customer_invoice_payable_on_park, available_currencies, email.
——— can_be_set_as_default_channel boolean false none Whether the channel can be set as the default channel for new back office reservations etc. or not. Can only be specified on creation.
——— requires_cancellation_originator boolean false none Whether the channel requires the originator of reservation cancellations to be known or not. Can only be specified on creation.
——— requires_restitution_after_cancellation boolean false none Whether the channel requires mandatory restitution after a reservation cancellation or not. Can only be specified on creation.
——— uses_remote_reservation_key boolean false none Whether the channel uses a remote reservation key or not. Can only be specified on creation.
——— archived boolean false read-only Whether this channel has been archived or not.
——— debtor_code string false read-only A system wide unique identifier for this debtor
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_payment_policy object false none none
———— data object false none none
————— id string false none guest_payment_policy ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel_payment_policy object false none none
———— data object false none none
————— id string false none channel_payment_policy ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— excluded_costs object false none none
———— data [object] false none none
————— id string false none excluded_costs ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Enumerated Values

Property Value
kind reseller
kind tour_operator
rent_invoiced_to guest
rent_invoiced_to channel
costs_invoiced_to guest
costs_invoiced_to channel

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

GET channel

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/channels/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/channels/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/channels/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/channels/string");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/channels/{id}

Returns a channel

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
id path string true string Resource ID
fields[channel] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[email] query string false string Filter on email
filter[kind] query string false string Filter on kind
filter[rent_invoiced_to] query string false string Filter on rent_invoiced_to
filter[costs_invoiced_to] query string false string Filter on costs_invoiced_to
filter[use_costs_invoiced_to] query string false string Filter on use_costs_invoiced_to
filter[behave_as_own_site] query string false string Filter on behave_as_own_site
filter[confirm_reservations] query string false string Filter on confirm_reservations
filter[confirm_by_email] query string false string Filter on confirm_by_email
filter[customer_invoice_payable_on_park] query string false string Filter on customer_invoice_payable_on_park
filter[archived] query string false string Filter on archived
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[administration] query string false string Filter on administration. Specify a comma separated list of IDs to filter on.
filter[guest_payment_policy] query string false string Filter on guest_payment_policy. Specify a comma separated list of IDs to filter on.
filter[channel_payment_policy] query string false string Filter on channel_payment_policy. Specify a comma separated list of IDs to filter on.
filter[excluded_costs] query string false string Filter on excluded_costs. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "channel",
    "attributes": {
      "name": "Tours Inc.",
      "email": "info@tours.inc",
      "kind": "reseller",
      "available_currencies": [
        "EUR",
        "USD"
      ],
      "pricing_type": "string",
      "archivable": false,
      "synchronizes_costs": false,
      "allows_costs_with_multiple_price_periods": true,
      "allows_costs_with_negative_amounts": true,
      "determines_price": false,
      "rent_invoiced_to": "guest",
      "costs_invoiced_to": "guest",
      "use_costs_invoiced_to": true,
      "behave_as_own_site": false,
      "confirm_reservations": true,
      "confirm_by_email": false,
      "customer_invoice_payable_on_park": false,
      "fixed_attributes": [
        "kind",
        "pricing_type"
      ],
      "can_be_set_as_default_channel": false,
      "requires_cancellation_originator": false,
      "requires_restitution_after_cancellation": false,
      "uses_remote_reservation_key": false,
      "archived": true,
      "debtor_code": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "relationships": {
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "excluded_costs": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK ChannelResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Channel](#schemachannel) false none Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on.
Administrations can customize the following aspects for each Channel:

* Extras
* Costs
* Availability
* Rent prices
* Invoicing
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name string false none Name of the channel. This name is also shown in the back-office.
——— email string false none Contact email address of the channel. This email address is also shown in the back-office.
——— kind string false none Channel kind.
——— available_currencies [string] false none Lists the currencies that are available for this channel. One or more of: EUR, USD, CHF, CZK, TRY, CVE, ANG, GBP.
——— pricing_type string false none Type of pricing that applies to this channel. One of: night_prices, complex_prices.
——— archivable boolean false none Whether the channel can be archived or not.
——— synchronizes_costs boolean false none Whether the channel synchronizes costs or not.
——— allows_costs_with_multiple_price_periods boolean false none Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— allows_costs_with_negative_amounts boolean false none Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— determines_price boolean false none Whether the channel determines the price or not.
——— rent_invoiced_to string false none Whether the channel invoices rent to the guest or the channel.
——— costs_invoiced_to string false none Whether the channel invoices costs to the guest or the channel.
——— use_costs_invoiced_to boolean false none Whether the channel should use the costs_invoiced_to setting to determine invoicing or not. Setting this to false allows overriding the invoicing for individual costs.
——— behave_as_own_site boolean false none Whether the channel behaves as the own site channel or not. Must be false when kind is set to tour_operator.
——— confirm_reservations boolean false none Whether the channel automatically confirms reservations or not
——— confirm_by_email boolean false none Whether the channel sends the channel invoice to the specified email or not
——— customer_invoice_payable_on_park boolean false none Whether the guest invoice can be paid on arrival or not
——— fixed_attributes [string] false none Lists the attributes of the channel that cannot be freely edited in the back-office. One or more of: name, pricing_type, kind, rent_invoiced_to, costs_invoiced_to, use_costs_invoiced_to, behave_as_own_site, confirm_reservations, confirm_by_email, customer_invoice_payable_on_park, available_currencies, email.
——— can_be_set_as_default_channel boolean false none Whether the channel can be set as the default channel for new back office reservations etc. or not. Can only be specified on creation.
——— requires_cancellation_originator boolean false none Whether the channel requires the originator of reservation cancellations to be known or not. Can only be specified on creation.
——— requires_restitution_after_cancellation boolean false none Whether the channel requires mandatory restitution after a reservation cancellation or not. Can only be specified on creation.
——— uses_remote_reservation_key boolean false none Whether the channel uses a remote reservation key or not. Can only be specified on creation.
——— archived boolean false read-only Whether this channel has been archived or not.
——— debtor_code string false read-only A system wide unique identifier for this debtor
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_payment_policy object false none none
———— data object false none none
————— id string false none guest_payment_policy ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel_payment_policy object false none none
———— data object false none none
————— id string false none channel_payment_policy ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— excluded_costs object false none none
———— data [object] false none none
————— id string false none excluded_costs ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Enumerated Values

Property Value
kind reseller
kind tour_operator
rent_invoiced_to guest
rent_invoiced_to channel
costs_invoiced_to guest
costs_invoiced_to channel

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

PATCH channel

Code samples

curl --request PATCH \
  --url https://api.bookingexperts.nl/v3/administrations/1/channels/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-API-KEY: API_KEY' \
  --data '{"data":{"id":"1","type":"channel","attributes":{"name":"Tours Inc.","email":"info@tours.inc","kind":"reseller","available_currencies":["EUR","USD"],"pricing_type":"string","archivable":false,"synchronizes_costs":false,"allows_costs_with_multiple_price_periods":true,"allows_costs_with_negative_amounts":true,"determines_price":false,"rent_invoiced_to":"guest","costs_invoiced_to":"guest","use_costs_invoiced_to":true,"behave_as_own_site":false,"confirm_reservations":true,"confirm_by_email":false,"customer_invoice_payable_on_park":false,"fixed_attributes":["kind","pricing_type"],"can_be_set_as_default_channel":false,"requires_cancellation_originator":false,"requires_restitution_after_cancellation":false,"uses_remote_reservation_key":false},"relationships":{"administration":{"data":{"id":null,"type":null,"meta":null}},"guest_payment_policy":{"data":{"id":null,"type":null,"meta":null}},"channel_payment_policy":{"data":{"id":null,"type":null,"meta":null}},"excluded_costs":{"data":[{}]}},"meta":{"temp_id":"string"}}}'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/channels/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/vnd.api+json'
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'
request.body = "{\"data\":{\"id\":\"1\",\"type\":\"channel\",\"attributes\":{\"name\":\"Tours Inc.\",\"email\":\"info@tours.inc\",\"kind\":\"reseller\",\"available_currencies\":[\"EUR\",\"USD\"],\"pricing_type\":\"string\",\"archivable\":false,\"synchronizes_costs\":false,\"allows_costs_with_multiple_price_periods\":true,\"allows_costs_with_negative_amounts\":true,\"determines_price\":false,\"rent_invoiced_to\":\"guest\",\"costs_invoiced_to\":\"guest\",\"use_costs_invoiced_to\":true,\"behave_as_own_site\":false,\"confirm_reservations\":true,\"confirm_by_email\":false,\"customer_invoice_payable_on_park\":false,\"fixed_attributes\":[\"kind\",\"pricing_type\"],\"can_be_set_as_default_channel\":false,\"requires_cancellation_originator\":false,\"requires_restitution_after_cancellation\":false,\"uses_remote_reservation_key\":false},\"relationships\":{\"administration\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"guest_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"channel_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"excluded_costs\":{\"data\":[{}]}},\"meta\":{\"temp_id\":\"string\"}}}"

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/channels/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "{\"data\":{\"id\":\"1\",\"type\":\"channel\",\"attributes\":{\"name\":\"Tours Inc.\",\"email\":\"info@tours.inc\",\"kind\":\"reseller\",\"available_currencies\":[\"EUR\",\"USD\"],\"pricing_type\":\"string\",\"archivable\":false,\"synchronizes_costs\":false,\"allows_costs_with_multiple_price_periods\":true,\"allows_costs_with_negative_amounts\":true,\"determines_price\":false,\"rent_invoiced_to\":\"guest\",\"costs_invoiced_to\":\"guest\",\"use_costs_invoiced_to\":true,\"behave_as_own_site\":false,\"confirm_reservations\":true,\"confirm_by_email\":false,\"customer_invoice_payable_on_park\":false,\"fixed_attributes\":[\"kind\",\"pricing_type\"],\"can_be_set_as_default_channel\":false,\"requires_cancellation_originator\":false,\"requires_restitution_after_cancellation\":false,\"uses_remote_reservation_key\":false},\"relationships\":{\"administration\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"guest_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"channel_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"excluded_costs\":{\"data\":[{}]}},\"meta\":{\"temp_id\":\"string\"}}}",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "Content-Type: application/vnd.api+json",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = "{\"data\":{\"id\":\"1\",\"type\":\"channel\",\"attributes\":{\"name\":\"Tours Inc.\",\"email\":\"info@tours.inc\",\"kind\":\"reseller\",\"available_currencies\":[\"EUR\",\"USD\"],\"pricing_type\":\"string\",\"archivable\":false,\"synchronizes_costs\":false,\"allows_costs_with_multiple_price_periods\":true,\"allows_costs_with_negative_amounts\":true,\"determines_price\":false,\"rent_invoiced_to\":\"guest\",\"costs_invoiced_to\":\"guest\",\"use_costs_invoiced_to\":true,\"behave_as_own_site\":false,\"confirm_reservations\":true,\"confirm_by_email\":false,\"customer_invoice_payable_on_park\":false,\"fixed_attributes\":[\"kind\",\"pricing_type\"],\"can_be_set_as_default_channel\":false,\"requires_cancellation_originator\":false,\"requires_restitution_after_cancellation\":false,\"uses_remote_reservation_key\":false},\"relationships\":{\"administration\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"guest_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"channel_payment_policy\":{\"data\":{\"id\":null,\"type\":null,\"meta\":null}},\"excluded_costs\":{\"data\":[{}]}},\"meta\":{\"temp_id\":\"string\"}}}";

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.bookingexperts.nl/v3/administrations/1/channels/string");
xhr.setRequestHeader("Content-Type", "application/vnd.api+json");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

PATCH /v3/administrations/{administration_id}/channels/{id}

Update a channel. Restricted to channels that are associated with your own subscription.

Body parameter

{
  "data": {
    "id": "1",
    "type": "channel",
    "attributes": {
      "name": "Tours Inc.",
      "email": "info@tours.inc",
      "kind": "reseller",
      "available_currencies": [
        "EUR",
        "USD"
      ],
      "pricing_type": "string",
      "archivable": false,
      "synchronizes_costs": false,
      "allows_costs_with_multiple_price_periods": true,
      "allows_costs_with_negative_amounts": true,
      "determines_price": false,
      "rent_invoiced_to": "guest",
      "costs_invoiced_to": "guest",
      "use_costs_invoiced_to": true,
      "behave_as_own_site": false,
      "confirm_reservations": true,
      "confirm_by_email": false,
      "customer_invoice_payable_on_park": false,
      "fixed_attributes": [
        "kind",
        "pricing_type"
      ],
      "can_be_set_as_default_channel": false,
      "requires_cancellation_originator": false,
      "requires_restitution_after_cancellation": false,
      "uses_remote_reservation_key": false
    },
    "relationships": {
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "excluded_costs": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
id path string true string Resource ID
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.
body body object true [object Object] none
— data body object false [object Object] Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on.
—— id body string false 1 ID
—— type body string false channel Type
—— attributes body object false [object Object] Attributes
——— name body string false Tours Inc. Name of the channel. This name is also shown in the back-office.
——— email body string false info@tours.inc Contact email address of the channel. This email address is also shown in the back-office.
——— kind body string false reseller Channel kind.
——— available_currencies body [string] false EUR,USD Lists the currencies that are available for this channel. One or more of: EUR, USD, CHF, CZK, TRY, CVE, ANG, GBP.
——— pricing_type body string false string Type of pricing that applies to this channel. One of: night_prices, complex_prices.
——— archivable body boolean false false Whether the channel can be archived or not.
——— synchronizes_costs body boolean false false Whether the channel synchronizes costs or not.
——— allows_costs_with_multiple_price_periods body boolean false true Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— allows_costs_with_negative_amounts body boolean false true Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— determines_price body boolean false false Whether the channel determines the price or not.
——— rent_invoiced_to body string false guest Whether the channel invoices rent to the guest or the channel.
——— costs_invoiced_to body string false guest Whether the channel invoices costs to the guest or the channel.
——— use_costs_invoiced_to body boolean false true Whether the channel should use the costs_invoiced_to setting to determine invoicing or not. Setting this to false allows overriding the invoicing for individual costs.
——— behave_as_own_site body boolean false false Whether the channel behaves as the own site channel or not. Must be false when kind is set to tour_operator.
——— confirm_reservations body boolean false true Whether the channel automatically confirms reservations or not
——— confirm_by_email body boolean false false Whether the channel sends the channel invoice to the specified email or not
——— customer_invoice_payable_on_park body boolean false false Whether the guest invoice can be paid on arrival or not
——— fixed_attributes body [string] false kind,pricing_type Lists the attributes of the channel that cannot be freely edited in the back-office. One or more of: name, pricing_type, kind, rent_invoiced_to, costs_invoiced_to, use_costs_invoiced_to, behave_as_own_site, confirm_reservations, confirm_by_email, customer_invoice_payable_on_park, available_currencies, email.
——— can_be_set_as_default_channel body boolean false false Whether the channel can be set as the default channel for new back office reservations etc. or not. Can only be specified on creation.
——— requires_cancellation_originator body boolean false false Whether the channel requires the originator of reservation cancellations to be known or not. Can only be specified on creation.
——— requires_restitution_after_cancellation body boolean false false Whether the channel requires mandatory restitution after a reservation cancellation or not. Can only be specified on creation.
——— uses_remote_reservation_key body boolean false false Whether the channel uses a remote reservation key or not. Can only be specified on creation.
—— relationships body object false [object Object] Relationships
——— administration body object false [object Object] none
———— data body object false [object Object] none
————— id body string false string administration ID
————— type body string false administrations none
————— meta body object false [object Object] none
—————— temp_id body string false string UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method body string false string Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_payment_policy body object false [object Object] none
———— data body object false [object Object] none
————— id body string false string guest_payment_policy ID
————— type body string false payment_policy none
————— meta body object false [object Object] none
—————— temp_id body string false string UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method body string false string Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel_payment_policy body object false [object Object] none
———— data body object false [object Object] none
————— id body string false string channel_payment_policy ID
————— type body string false payment_policy none
————— meta body object false [object Object] none
—————— temp_id body string false string UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method body string false string Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— excluded_costs body object false [object Object] none
———— data body [object] false [object Object] none
————— id body string false string excluded_costs ID
————— type body string false none
————— meta body object false [object Object] none
—————— temp_id body string false string UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method body string false string Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta body object false [object Object] Metadata
——— temp_id body string false string UUID for internal resource linking. Should be omitted when the relationship ID is known.

Detailed descriptions

— data: Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on. Administrations can customize the following aspects for each Channel:

——— administration: null

——— guest_payment_policy: null

——— channel_payment_policy: null

——— excluded_costs: null

Enumerated Values

Parameter Value
——— kind reseller
——— kind tour_operator
——— rent_invoiced_to guest
——— rent_invoiced_to channel
——— costs_invoiced_to guest
——— costs_invoiced_to channel

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "channel",
    "attributes": {
      "name": "Tours Inc.",
      "email": "info@tours.inc",
      "kind": "reseller",
      "available_currencies": [
        "EUR",
        "USD"
      ],
      "pricing_type": "string",
      "archivable": false,
      "synchronizes_costs": false,
      "allows_costs_with_multiple_price_periods": true,
      "allows_costs_with_negative_amounts": true,
      "determines_price": false,
      "rent_invoiced_to": "guest",
      "costs_invoiced_to": "guest",
      "use_costs_invoiced_to": true,
      "behave_as_own_site": false,
      "confirm_reservations": true,
      "confirm_by_email": false,
      "customer_invoice_payable_on_park": false,
      "fixed_attributes": [
        "kind",
        "pricing_type"
      ],
      "can_be_set_as_default_channel": false,
      "requires_cancellation_originator": false,
      "requires_restitution_after_cancellation": false,
      "uses_remote_reservation_key": false,
      "archived": true,
      "debtor_code": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "relationships": {
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "excluded_costs": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK ChannelResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Channel](#schemachannel) false none Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on.
Administrations can customize the following aspects for each Channel:

* Extras
* Costs
* Availability
* Rent prices
* Invoicing
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name string false none Name of the channel. This name is also shown in the back-office.
——— email string false none Contact email address of the channel. This email address is also shown in the back-office.
——— kind string false none Channel kind.
——— available_currencies [string] false none Lists the currencies that are available for this channel. One or more of: EUR, USD, CHF, CZK, TRY, CVE, ANG, GBP.
——— pricing_type string false none Type of pricing that applies to this channel. One of: night_prices, complex_prices.
——— archivable boolean false none Whether the channel can be archived or not.
——— synchronizes_costs boolean false none Whether the channel synchronizes costs or not.
——— allows_costs_with_multiple_price_periods boolean false none Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— allows_costs_with_negative_amounts boolean false none Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false.
——— determines_price boolean false none Whether the channel determines the price or not.
——— rent_invoiced_to string false none Whether the channel invoices rent to the guest or the channel.
——— costs_invoiced_to string false none Whether the channel invoices costs to the guest or the channel.
——— use_costs_invoiced_to boolean false none Whether the channel should use the costs_invoiced_to setting to determine invoicing or not. Setting this to false allows overriding the invoicing for individual costs.
——— behave_as_own_site boolean false none Whether the channel behaves as the own site channel or not. Must be false when kind is set to tour_operator.
——— confirm_reservations boolean false none Whether the channel automatically confirms reservations or not
——— confirm_by_email boolean false none Whether the channel sends the channel invoice to the specified email or not
——— customer_invoice_payable_on_park boolean false none Whether the guest invoice can be paid on arrival or not
——— fixed_attributes [string] false none Lists the attributes of the channel that cannot be freely edited in the back-office. One or more of: name, pricing_type, kind, rent_invoiced_to, costs_invoiced_to, use_costs_invoiced_to, behave_as_own_site, confirm_reservations, confirm_by_email, customer_invoice_payable_on_park, available_currencies, email.
——— can_be_set_as_default_channel boolean false none Whether the channel can be set as the default channel for new back office reservations etc. or not. Can only be specified on creation.
——— requires_cancellation_originator boolean false none Whether the channel requires the originator of reservation cancellations to be known or not. Can only be specified on creation.
——— requires_restitution_after_cancellation boolean false none Whether the channel requires mandatory restitution after a reservation cancellation or not. Can only be specified on creation.
——— uses_remote_reservation_key boolean false none Whether the channel uses a remote reservation key or not. Can only be specified on creation.
——— archived boolean false read-only Whether this channel has been archived or not.
——— debtor_code string false read-only A system wide unique identifier for this debtor
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_payment_policy object false none none
———— data object false none none
————— id string false none guest_payment_policy ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel_payment_policy object false none none
———— data object false none none
————— id string false none channel_payment_policy ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— excluded_costs object false none none
———— data [object] false none none
————— id string false none excluded_costs ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Enumerated Values

Property Value
kind reseller
kind tour_operator
rent_invoiced_to guest
rent_invoiced_to channel
costs_invoiced_to guest
costs_invoiced_to channel

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

DELETE channel

Code samples

curl --request DELETE \
  --url https://api.bookingexperts.nl/v3/administrations/1/channels/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/channels/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/channels/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.bookingexperts.nl/v3/administrations/1/channels/string");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

DELETE /v3/administrations/{administration_id}/channels/{id}

Destroy a channel. Restricted to channels that are associated with your own subscription.

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
id path string true string Resource ID
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

default Response

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
204 No Content Success None
default Default Error Inline

Response Schema

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

Administrations

GET administrations

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations

Returns all administrations accessible for the current subscription

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
page[number] query string false string Page number
page[size] query string false string Page size
sort query string false string Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \- to sort in descending order
fields[administration] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[phone] query string false string Filter on phone
filter[website] query string false string Filter on website
filter[native_locale] query string false string Filter on native_locale
filter[native_currency] query string false string Filter on native_currency
filter[description] query string false string Filter on description
filter[surroundings_description] query string false string Filter on surroundings_description
filter[available_locales] query string false string Filter on available_locales
filter[timezone] query string false string Filter on timezone
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[payment_handlers] query string false string Filter on payment_handlers. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "administration",
      "attributes": {
        "name": "string",
        "phone": "string",
        "website": "string",
        "native_locale": [
          "string"
        ],
        "native_currency": "string",
        "description": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "surroundings_description": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "available_locales": [
          "string"
        ],
        "timezone": "string",
        "available_currencies": [
          "string"
        ],
        "map_available": true,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "payment_handlers": {
          "data": [
            null
          ]
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AdministrationCollectionResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [[Administration](#schemaadministration)] false none [An organization can have multiple administrations, usually a holiday park or camping.]
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name string false none none
——— phone string false none none
——— website string false none none
——— native_locale [string] false none The default locale used by the administration internally, and which should be used for communication with the administration
——— native_currency string false none none
——— description object false none A description of the administration
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— surroundings_description object false none A description of the surroundings
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— available_locales [string] false none Enabled locales
——— timezone string false none The timezone of the administration, for example: Europe/Amsterdam
——— available_currencies [string] false read-only Enabled currencies
——— map_available boolean false read-only If a map is available. The map can be used to pick a specific accommodation or pitch.
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— links object false none Links
——— self string false none Link to self
—— relationships object false none Relationships
——— payment_handlers object false none none
———— data [object] false read-only none
————— id string false none payment_handlers ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.
— meta object false none none
—— pagination object false none none
——— total_records integer false none none
——— page integer false none none
——— size integer false none none

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

GET administration

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/string");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{id}

Returns an administration of the current organization

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
id path string true string Resource ID
fields[administration] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[phone] query string false string Filter on phone
filter[website] query string false string Filter on website
filter[native_locale] query string false string Filter on native_locale
filter[native_currency] query string false string Filter on native_currency
filter[description] query string false string Filter on description
filter[surroundings_description] query string false string Filter on surroundings_description
filter[available_locales] query string false string Filter on available_locales
filter[timezone] query string false string Filter on timezone
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[payment_handlers] query string false string Filter on payment_handlers. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "administration",
    "attributes": {
      "name": "string",
      "phone": "string",
      "website": "string",
      "native_locale": [
        "string"
      ],
      "native_currency": "string",
      "description": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "surroundings_description": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "available_locales": [
        "string"
      ],
      "timezone": "string",
      "available_currencies": [
        "string"
      ],
      "map_available": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "links": {
      "self": "string"
    },
    "relationships": {
      "payment_handlers": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AdministrationResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Administration](#schemaadministration) false none An organization can have multiple administrations, usually a holiday park or camping.
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name string false none none
——— phone string false none none
——— website string false none none
——— native_locale [string] false none The default locale used by the administration internally, and which should be used for communication with the administration
——— native_currency string false none none
——— description object false none A description of the administration
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— surroundings_description object false none A description of the surroundings
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— available_locales [string] false none Enabled locales
——— timezone string false none The timezone of the administration, for example: Europe/Amsterdam
——— available_currencies [string] false read-only Enabled currencies
——— map_available boolean false read-only If a map is available. The map can be used to pick a specific accommodation or pitch.
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— links object false none Links
——— self string false none Link to self
—— relationships object false none Relationships
——— payment_handlers object false none none
———— data [object] false read-only none
————— id string false none payment_handlers ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

AgendaPeriods

GET agenda_periods

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/agenda_periods \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/agenda_periods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/agenda_periods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/agenda_periods");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/agenda_periods

Returns agenda periods the administration

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
page[number] query string false string Page number
page[size] query string false string Page size
sort query string false string Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \- to sort in descending order
fields[agenda_period] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[type] query string false string Filter on type
filter[start_date] query string false string Filter on start_date
filter[end_date] query string false string Filter on end_date
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[rentable] query string false string Filter on rentable. Specify a comma separated list of IDs to filter on.
filter[reservation] query string false string Filter on reservation. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "agenda_period",
      "attributes": {
        "label": "string",
        "ical_uid": "string",
        "type": "MaintenanceAgendaPeriod",
        "start_date": "2019-08-24",
        "end_date": "2019-08-24",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "relationships": {
        "rentable": {
          "data": {}
        },
        "reservation": {
          "data": {}
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AgendaPeriodCollectionResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [[AgendaPeriod](#schemaagendaperiod)] false none [A blocking event on the calendar of a Rentable. This includes Reservations and maintenance events.]
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— label string false none none
——— ical_uid string false none none
——— type string false none none
——— start_date string(date) false none none
——— end_date string(date) false none none
——— created_at string(date-time) false none none
——— updated_at string(date-time) false none none
—— relationships object false none Relationships
——— rentable object false none none
———— data object false none none
————— id string false none rentable ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— reservation object false none none
———— data object false none none
————— id string false none reservation ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.
— meta object false none none
—— pagination object false none none
——— total_records integer false none none
——— page integer false none none
——— size integer false none none

Enumerated Values

Property Value
type MaintenanceAgendaPeriod
type OwnerMaintenanceAgendaPeriod
type BlockedByGroupedCategoryAgendaPeriod
type ReservationAgendaPeriod
type ExternalBlockedAgendaPeriod
type NotEnoughStockAgendaPeriod

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

Agreements

GET agreements

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/agreements \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/agreements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/agreements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/agreements");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/agreements

Returns agreements of the administration

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
page[number] query string false string Page number
page[size] query string false string Page size
sort query string false string Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \- to sort in descending order
fields[agreement] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[active_from] query string false string Filter on active_from
filter[active_till] query string false string Filter on active_till
filter[owner_reservable] query string false string Filter on owner_reservable
filter[owner_can_make_reservation_on_irregular_price_periods] query string false string Filter on owner_can_make_reservation_on_irregular_price_periods
filter[owner_can_view_availability] query string false string Filter on owner_can_view_availability
filter[owner_can_view_reservations] query string false string Filter on owner_can_view_reservations
filter[owner_can_view_reservation_details] query string false string Filter on owner_can_view_reservation_details
filter[owner_should_check_reservations] query string false string Filter on owner_should_check_reservations
filter[owner_can_edit_agenda_periods] query string false string Filter on owner_can_edit_agenda_periods
filter[owner_can_view_rentable_details] query string false string Filter on owner_can_view_rentable_details
filter[owner_can_create_pricing_change_request] query string false string Filter on owner_can_create_pricing_change_request
filter[can_promote] query string false string Filter on can_promote
filter[can_view_reviews] query string false string Filter on can_view_reviews
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[owner] query string false string Filter on owner. Specify a comma separated list of IDs to filter on.
filter[rentable_identity] query string false string Filter on rentable_identity. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "agreement",
      "attributes": {
        "name": "string",
        "active_from": "2019-08-24",
        "active_till": "2019-08-24",
        "frequency": "anytime",
        "settlement_method": "end_date",
        "owner_reservable": true,
        "owner_can_make_reservation_on_irregular_price_periods": true,
        "owner_can_view_availability": true,
        "owner_can_view_reservations": true,
        "owner_can_view_reservation_details": true,
        "owner_should_check_reservations": true,
        "owner_can_edit_agenda_periods": true,
        "owner_can_view_rentable_details": true,
        "owner_can_create_pricing_change_request": true,
        "can_promote": true,
        "can_view_reviews": true,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "relationships": {
        "owner": {
          "data": {}
        },
        "rentable_identity": {
          "data": {}
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AgreementCollectionResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [[Agreement](#schemaagreement)] false none [An agreement with an Owner for a given RentableIdentity]
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name string false none none
——— active_from string(date) false none none
——— active_till string(date) false none none
——— frequency string false none Frequency of settlement.
——— settlement_method string false none Defines which date to look at when rent turnover is calculated.
——— owner_reservable boolean false none none
——— owner_can_make_reservation_on_irregular_price_periods boolean false none none
——— owner_can_view_availability boolean false none none
——— owner_can_view_reservations boolean false none none
——— owner_can_view_reservation_details boolean false none none
——— owner_should_check_reservations boolean false none none
——— owner_can_edit_agenda_periods boolean false none none
——— owner_can_view_rentable_details boolean false none none
——— owner_can_create_pricing_change_request boolean false none none
——— can_promote boolean false none none
——— can_view_reviews boolean false none none
——— created_at string(date-time) false none none
——— updated_at string(date-time) false none none
—— relationships object false none Relationships
——— owner object false none none
———— data object false none none
————— id string false none owner ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— rentable_identity object false none none
———— data object false none none
————— id string false none rentable_identity ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.
— meta object false none none
—— pagination object false none none
——— total_records integer false none none
——— page integer false none none
——— size integer false none none

Enumerated Values

Property Value
frequency anytime
frequency monthly
frequency quarterly
frequency halfyearly
frequency yearly
settlement_method end_date
settlement_method start_date
settlement_method overlapping
settlement_method confirmed_date

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

GET agreement

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/agreements/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/agreements/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/agreements/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/agreements/string");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/agreements/{id}

Returns the agreement for the given ID

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
id path string true string Resource ID
fields[agreement] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[active_from] query string false string Filter on active_from
filter[active_till] query string false string Filter on active_till
filter[owner_reservable] query string false string Filter on owner_reservable
filter[owner_can_make_reservation_on_irregular_price_periods] query string false string Filter on owner_can_make_reservation_on_irregular_price_periods
filter[owner_can_view_availability] query string false string Filter on owner_can_view_availability
filter[owner_can_view_reservations] query string false string Filter on owner_can_view_reservations
filter[owner_can_view_reservation_details] query string false string Filter on owner_can_view_reservation_details
filter[owner_should_check_reservations] query string false string Filter on owner_should_check_reservations
filter[owner_can_edit_agenda_periods] query string false string Filter on owner_can_edit_agenda_periods
filter[owner_can_view_rentable_details] query string false string Filter on owner_can_view_rentable_details
filter[owner_can_create_pricing_change_request] query string false string Filter on owner_can_create_pricing_change_request
filter[can_promote] query string false string Filter on can_promote
filter[can_view_reviews] query string false string Filter on can_view_reviews
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[owner] query string false string Filter on owner. Specify a comma separated list of IDs to filter on.
filter[rentable_identity] query string false string Filter on rentable_identity. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "agreement",
    "attributes": {
      "name": "string",
      "active_from": "2019-08-24",
      "active_till": "2019-08-24",
      "frequency": "anytime",
      "settlement_method": "end_date",
      "owner_reservable": true,
      "owner_can_make_reservation_on_irregular_price_periods": true,
      "owner_can_view_availability": true,
      "owner_can_view_reservations": true,
      "owner_can_view_reservation_details": true,
      "owner_should_check_reservations": true,
      "owner_can_edit_agenda_periods": true,
      "owner_can_view_rentable_details": true,
      "owner_can_create_pricing_change_request": true,
      "can_promote": true,
      "can_view_reviews": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "relationships": {
      "owner": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "rentable_identity": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AgreementResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Agreement](#schemaagreement) false none An agreement with an Owner for a given RentableIdentity
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name string false none none
——— active_from string(date) false none none
——— active_till string(date) false none none
——— frequency string false none Frequency of settlement.
——— settlement_method string false none Defines which date to look at when rent turnover is calculated.
——— owner_reservable boolean false none none
——— owner_can_make_reservation_on_irregular_price_periods boolean false none none
——— owner_can_view_availability boolean false none none
——— owner_can_view_reservations boolean false none none
——— owner_can_view_reservation_details boolean false none none
——— owner_should_check_reservations boolean false none none
——— owner_can_edit_agenda_periods boolean false none none
——— owner_can_view_rentable_details boolean false none none
——— owner_can_create_pricing_change_request boolean false none none
——— can_promote boolean false none none
——— can_view_reviews boolean false none none
——— created_at string(date-time) false none none
——— updated_at string(date-time) false none none
—— relationships object false none Relationships
——— owner object false none none
———— data object false none none
————— id string false none owner ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— rentable_identity object false none none
———— data object false none none
————— id string false none rentable_identity ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Enumerated Values

Property Value
frequency anytime
frequency monthly
frequency quarterly
frequency halfyearly
frequency yearly
settlement_method end_date
settlement_method start_date
settlement_method overlapping
settlement_method confirmed_date

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

Amenities

GET amenities

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/amenities \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/amenities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/amenities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/amenities");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/amenities

Returns amenities of the organization

Parameters

Name In Type Required Example Description
page[number] query string false string Page number
page[size] query string false string Page size
sort query string false string Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \- to sort in descending order
fields[amenity] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[type] query string false string Filter on type
filter[position] query string false string Filter on position
filter[semantic_amenity_type] query string false string Filter on semantic_amenity_type
filter[amenity_group] query string false string Filter on amenity_group. Specify a comma separated list of IDs to filter on.
filter[amenity_options] query string false string Filter on amenity_options. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "amenity",
      "attributes": {
        "name": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "type": "Amenity",
        "position": 0,
        "semantic_amenity_type": "string"
      },
      "relationships": {
        "amenity_group": {
          "data": {}
        },
        "amenity_options": {
          "data": [
            null
          ]
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AmenityCollectionResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [[Amenity](#schemaamenity)] false none [Amenities are for external and internal use. They can be used to signify amenities of a Category or Rentable that are important to the guest.
For example:

* With sauna
* Free wi-fi

An Amenity can optionally be numerical or multiple choice. When an Amenity is numerical, the values of linked amenities (CategoryAmenity, RentableAmenity, ReservationAmenity and RoomAmenity)
denote the numerical value belonging to the amenity. When an Amenity is multiple choice, the values of linked amenities denote the ID of the AmenityOption that applies.
]
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name object false none Name of the amenity
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— type string false none Type of the amenity
——— position integer false none none
——— semantic_amenity_type string false none none
—— relationships object false none Relationships
——— amenity_group object false none none
———— data object false none none
————— id string false none amenity_group ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— amenity_options object false none none
———— data [object] false none none
————— id string false none amenity_options ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.
— meta object false none none
—— pagination object false none none
——— total_records integer false none none
——— page integer false none none
——— size integer false none none

Enumerated Values

Property Value
type Amenity
type Amenities::NumericalAmenity
type Amenities::MultipleChoiceAmenity

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

GET amenity

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/amenities/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/amenities/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/amenities/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/amenities/string");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/amenities/{id}

Returns the amenity for the given ID

Parameters

Name In Type Required Example Description
id path string true string Resource ID
fields[amenity] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[type] query string false string Filter on type
filter[position] query string false string Filter on position
filter[semantic_amenity_type] query string false string Filter on semantic_amenity_type
filter[amenity_group] query string false string Filter on amenity_group. Specify a comma separated list of IDs to filter on.
filter[amenity_options] query string false string Filter on amenity_options. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "amenity",
    "attributes": {
      "name": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "type": "Amenity",
      "position": 0,
      "semantic_amenity_type": "string"
    },
    "relationships": {
      "amenity_group": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "amenity_options": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AmenityResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Amenity](#schemaamenity) false none Amenities are for external and internal use. They can be used to signify amenities of a Category or Rentable that are important to the guest.
For example:

* With sauna
* Free wi-fi

An Amenity can optionally be numerical or multiple choice. When an Amenity is numerical, the values of linked amenities (CategoryAmenity, RentableAmenity, ReservationAmenity and RoomAmenity)
denote the numerical value belonging to the amenity. When an Amenity is multiple choice, the values of linked amenities denote the ID of the AmenityOption that applies.
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name object false none Name of the amenity
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— type string false none Type of the amenity
——— position integer false none none
——— semantic_amenity_type string false none none
—— relationships object false none Relationships
——— amenity_group object false none none
———— data object false none none
————— id string false none amenity_group ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— amenity_options object false none none
———— data [object] false none none
————— id string false none amenity_options ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Enumerated Values

Property Value
type Amenity
type Amenities::NumericalAmenity
type Amenities::MultipleChoiceAmenity

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

App Availabilities

Perform availability search over all organizations subscribed to your app

GET availabilities

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/app/availabilities \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-APP-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/app/availabilities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-APP-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/app/availabilities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-APP-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/app/availabilities");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-APP-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/app/availabilities

Returns availability & prices

Parameters

Name In Type Required Example Description
fields[availability] query string false string Fieldset. Specify a comma separated list of attributes to return
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.
channel_ids query string false string Specify a comma separated list of channel IDs to be used for searching availability. By default, all accessible channels associated to your app will be used. Overriding this may be useful when you have access to multiple channels of the same administration.
include_rentable_type_counts query boolean false true When true, the amount of results per rentable type will be added to the metadata
include_amenity_counts query boolean false true When true, the amount of results per amenity will be added to the metadata
referrer query string false string Referrer name
filter[start_date] query string false 2010-01-01..2040-01-01 Filter on start date. Expects a date range. Note: date ranges have an exclusive end date.
filter[overlaps_date] query string false 2010-01-01..2040-01-01 Filter availabilities that (partially) overlap these dates.
filter[includes_date] query string false string Filter availabilities that contain the specified date range.
filter[arrangement] query string false string Filter on availabilities that exactly match the supplied date range.
filter[los] query string false 1..21 Filter on length of stay.
filter[wday] query integer false 0 Filter on a particular week day. 0 = sunday.
filter[administration_ids] query string false string Filter on administrations. Specify a comma separated list.
filter[category_ids] query string false string Filter on categories. Specify a comma separated list.
filter[-category_ids] query string false string Exclude categories. Specify a comma separated list.
filter[region_ids] query string false string Filter on regions. Specify a comma separated list.
filter[-region_ids] query string false string Exclude regions. Specify a comma separated list.
filter[accommodation_subtype_ids] query string false string Filter on accommodation subtypes. Specify a comma separated list.
filter[-accommodation_subtype_ids] query string false string Exclude accommodation subtypes. Specify a comma separated list.
filter[amenity_ids] query string false string Filter on amenities. Specify a comma separated list.
filter[package_id] query string false string Filter on package ID.
filter[discount_campaign_id] query string false string Filter on discount campaign ID.
filter[country_codes] query string false string Filter on country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes. For example: NL,EN,DE.
filter[-country_codes] query string false string Exclude country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes.
filter[rentable_types] query string false bungalow,camping Filter on rentable_types. Specify a comma separated list. Available rentable types: bungalow, camping, hotelroom, berth, apartment, accommodation, year_site.
filter[-rentable_types] query string false string Exclude rentable types. Specify a comma separated list. Available rentable types: bungalow, camping, hotelroom, berth, apartment, accommodation, year_site.
filter[guest_group][seniors] query integer false 0 Filter on number of seniors.
filter[guest_group][adults] query integer false 2 Filter on number of adults.
filter[guest_group][adolescents] query integer false 0 Filter on number of adolescents.
filter[guest_group][children] query integer false 0 Filter on number of children.
filter[guest_group][babies] query integer false 0 Filter on number of babies.
filter[guest_group][pets] query integer false 0 Filter on number of pets.
filter[price] query string false 0.0..5000.00 Filter on a price range
filter[currency] query string false EUR Filter on a specific ISO 4217 currency code. By default the prices are returned in the administration's native currency. Results can differ per currency.
filter[number_of_bedrooms] query integer false 0 Filter on category number of bedrooms
filter[number_of_beds] query integer false 0 Filter on category number of beds
filter[number_of_showers] query integer false 0 Filter on category number of showers
filter[number_of_toilets] query integer false 0 Filter on category number of toilets
filter[number_of_bathrooms] query integer false 0 Filter on category number of bathrooms
filter[number_of_parking_spots] query integer false 0 Filter on category number of parking spots
filter[number_of_child_beds] query integer false 0 Filter on category number of child beds
filter[number_of_child_chairs] query integer false 0 Filter on category number of child chairs
sorters query string false all_in_amount Specify a comma separated list of sorters to apply. There are 10 possible sorters:
sorter[los][desc] query boolean false true Boolean specifying the sort direction for the `los` sorter. When unspecified, ascending order is implied.
sorter[los_distance][desc] query boolean false true Boolean specifying the sort direction for the `los_distance` sorter. When unspecified, ascending order is implied.
sorter[los_distance][los] query integer false 7 Length of stay for the `los_distance` sorter
sorter[start_date][desc] query boolean false true Boolean specifying the sort direction for the `start_date` sorter. When unspecified, ascending order is implied.
sorter[start_date_distance][desc] query boolean false true Boolean specifying the sort direction for the `start_date_distance` sorter. When unspecified, ascending order is implied.
sorter[start_date_distance][start_date] query string false 2017-07-01 Start date for the `start_date_distance` sorter
sorter[arrangement_distance][desc] query boolean false true Boolean specifying the sort direction for the `arrangement_distance` sorter. When unspecified, ascending order is implied.
sorter[arrangement_distance][arrangement] query string false 2017-07-01..2017-07-08 Arrangement for the `arrangement_distance` sorter
sorter[max_guests][desc] query boolean false true Boolean specifying the sort direction for the `max_guests` sorter. When unspecified, ascending order is implied.
sorter[highlighted][desc] query boolean false true Boolean specifying the sort direction for the `highlighted` sorter. When unspecified, ascending order is implied.
sorter[all_in_amount][desc] query boolean false true Boolean specifying the sort direction for the `all_in_amount` sorter. When unspecified, ascending order is implied.
sorter[amenity_ids_match_score][desc] query boolean false true Boolean specifying the sort direction for the `amenity_ids_match_score` sorter. When unspecified, ascending order is implied.
sorter[amenity_ids_match_score][amenity_ids] query string false 1,2 Amenity IDs for the `amenity_ids_match_score` sorter
sorter[avg_score][desc] query boolean false true Boolean specifying the sort direction for the `avg_score` sorter. When unspecified, ascending order is implied.
limit query string false availabilities Specify a limiter here. There are 4 different limiters:
limiter[availabilities][limit] query integer false 10 Return `limit` availabilities
limiter[start_dates][limit] query integer false 10 Limit to the `limit` best arrival dates
limiter[start_dates][availabilities] query integer false 10 Number of availabilities to return
limiter[categories][limit] query integer false 10 Limit to the `limit` best categories
limiter[categories][offset] query integer false 0 Result offset for the `categories` limiter, useful for pagination
limiter[categories][availabilities] query integer false 10 Number of availabilities to return
limiter[administrations][limit] query integer false 10 Limit to the `limit` best administrations
limiter[administrations][categories] query integer false 3 Limit to the `limit` best categories
limiter[administrations][availabilities] query integer false 10 Number of availabilities to return

Detailed descriptions

sorters: Specify a comma separated list of sorters to apply. There are 10 possible sorters:

Configuration for each applied sorter (for example descending order) must be passed separately, see the options below.

limit: Specify a limiter here. There are 4 different limiters:

Configuration for the chosen limiter (for example the number of availabilities to return) must be passed separately, see the options below.

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "availability",
    "attributes": {
      "start_date": "2019-08-24",
      "los": 7,
      "checkin_time": "14:00",
      "checkout_time": "10:00",
      "price": {
        "currency": "string",
        "value": "string"
      },
      "original_price": {
        "currency": "string",
        "value": "string"
      },
      "rent_price": {
        "currency": "string",
        "value": "string"
      },
      "original_rent_price": {
        "currency": "string",
        "value": "string"
      },
      "stock": 2
    },
    "relationships": {
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "category": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "discount_campaign": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "missing_amenities": {
        "data": [
          {}
        ]
      },
      "available_rentables": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AvailabilityResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Availability](#schemaavailability) false none Availabilities represent a stay in or at a Rentable (mostly a holiday house, room or campsite).
It includes an exact (all-in) price for the supplied guest group and other filters.
For example, the search can give you a list of availabilities for 2 adults, 2 children, 1 pet, scoped on The Netherlands and Belgium with
preference for a Rentable with sea view for a specific price range including all-in prices. This allows the guest to really compare
Rentables because there will be no fees that are added during the reservation process.

*Note: Users can explicitly exclude costs from the all-in price. This is not standard behaviour.*
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— start_date string(date) false none Date of arrival
——— los integer false none Length of stay in nights
——— checkin_time string false none none
——— checkout_time string false none none
——— price object false none All-in price considering rent, extras and discounts. Will be null when no guest group supplied
———— currency string false none none
———— value string false none none
——— original_price object false none Price considering rent, extras but without discounts. Will be null when no guest group supplied
———— currency string false none none
———— value string false none none
——— rent_price object false none Rent-only price. Does not include extra costs. Includes applicable discount
———— currency string false none none
———— value string false none none
——— original_rent_price object false none Rent-only price without applicable discount
———— currency string false none none
———— value string false none none
——— stock integer false none The number of units of this category available in this period. Takes filters and allotments into account
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— category object false none none
———— data object false none none
————— id string false none category ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— discount_campaign object false none none
———— data object false none none
————— id string false none discount_campaign ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— missing_amenities object false none none
———— data [object] false none none
————— id string false none missing_amenities ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— available_rentables object false none none
———— data [object] false none none
————— id string false none available_rentables ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

Availabilities

GET availabilities

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/availabilities \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/availabilities")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/availabilities",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/availabilities");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/availabilities

Returns availability & prices

Parameters

Name In Type Required Example Description
fields[availability] query string false string Fieldset. Specify a comma separated list of attributes to return
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.
channel_ids query string false string Specify a comma separated list of channel IDs to be used for searching availability. By default, all accessible channels associated to your app will be used. Overriding this may be useful when you have access to multiple channels of the same administration.
include_rentable_type_counts query boolean false true When true, the amount of results per rentable type will be added to the metadata
include_amenity_counts query boolean false true When true, the amount of results per amenity will be added to the metadata
referrer query string false string Referrer name
filter[start_date] query string false 2010-01-01..2040-01-01 Filter on start date. Expects a date range. Note: date ranges have an exclusive end date.
filter[overlaps_date] query string false 2010-01-01..2040-01-01 Filter availabilities that (partially) overlap these dates.
filter[includes_date] query string false string Filter availabilities that contain the specified date range.
filter[arrangement] query string false string Filter on availabilities that exactly match the supplied date range.
filter[los] query string false 1..21 Filter on length of stay.
filter[wday] query integer false 0 Filter on a particular week day. 0 = sunday.
filter[administration_ids] query string false string Filter on administrations. Specify a comma separated list.
filter[category_ids] query string false string Filter on categories. Specify a comma separated list.
filter[-category_ids] query string false string Exclude categories. Specify a comma separated list.
filter[region_ids] query string false string Filter on regions. Specify a comma separated list.
filter[-region_ids] query string false string Exclude regions. Specify a comma separated list.
filter[accommodation_subtype_ids] query string false string Filter on accommodation subtypes. Specify a comma separated list.
filter[-accommodation_subtype_ids] query string false string Exclude accommodation subtypes. Specify a comma separated list.
filter[amenity_ids] query string false string Filter on amenities. Specify a comma separated list.
filter[package_id] query string false string Filter on package ID.
filter[discount_campaign_id] query string false string Filter on discount campaign ID.
filter[country_codes] query string false string Filter on country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes. For example: NL,EN,DE.
filter[-country_codes] query string false string Exclude country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes.
filter[rentable_types] query string false bungalow,camping Filter on rentable_types. Specify a comma separated list. Available rentable types: bungalow, camping, hotelroom, berth, apartment, accommodation, year_site.
filter[-rentable_types] query string false string Exclude rentable types. Specify a comma separated list. Available rentable types: bungalow, camping, hotelroom, berth, apartment, accommodation, year_site.
filter[guest_group][seniors] query integer false 0 Filter on number of seniors.
filter[guest_group][adults] query integer false 2 Filter on number of adults.
filter[guest_group][adolescents] query integer false 0 Filter on number of adolescents.
filter[guest_group][children] query integer false 0 Filter on number of children.
filter[guest_group][babies] query integer false 0 Filter on number of babies.
filter[guest_group][pets] query integer false 0 Filter on number of pets.
filter[price] query string false 0.0..5000.00 Filter on a price range
filter[currency] query string false EUR Filter on a specific ISO 4217 currency code. By default the prices are returned in the administration's native currency. Results can differ per currency.
filter[number_of_bedrooms] query integer false 0 Filter on category number of bedrooms
filter[number_of_beds] query integer false 0 Filter on category number of beds
filter[number_of_showers] query integer false 0 Filter on category number of showers
filter[number_of_toilets] query integer false 0 Filter on category number of toilets
filter[number_of_bathrooms] query integer false 0 Filter on category number of bathrooms
filter[number_of_parking_spots] query integer false 0 Filter on category number of parking spots
filter[number_of_child_beds] query integer false 0 Filter on category number of child beds
filter[number_of_child_chairs] query integer false 0 Filter on category number of child chairs
sorters query string false all_in_amount Specify a comma separated list of sorters to apply. There are 10 possible sorters:
sorter[los][desc] query boolean false true Boolean specifying the sort direction for the `los` sorter. When unspecified, ascending order is implied.
sorter[los_distance][desc] query boolean false true Boolean specifying the sort direction for the `los_distance` sorter. When unspecified, ascending order is implied.
sorter[los_distance][los] query integer false 7 Length of stay for the `los_distance` sorter
sorter[start_date][desc] query boolean false true Boolean specifying the sort direction for the `start_date` sorter. When unspecified, ascending order is implied.
sorter[start_date_distance][desc] query boolean false true Boolean specifying the sort direction for the `start_date_distance` sorter. When unspecified, ascending order is implied.
sorter[start_date_distance][start_date] query string false 2017-07-01 Start date for the `start_date_distance` sorter
sorter[arrangement_distance][desc] query boolean false true Boolean specifying the sort direction for the `arrangement_distance` sorter. When unspecified, ascending order is implied.
sorter[arrangement_distance][arrangement] query string false 2017-07-01..2017-07-08 Arrangement for the `arrangement_distance` sorter
sorter[max_guests][desc] query boolean false true Boolean specifying the sort direction for the `max_guests` sorter. When unspecified, ascending order is implied.
sorter[highlighted][desc] query boolean false true Boolean specifying the sort direction for the `highlighted` sorter. When unspecified, ascending order is implied.
sorter[all_in_amount][desc] query boolean false true Boolean specifying the sort direction for the `all_in_amount` sorter. When unspecified, ascending order is implied.
sorter[amenity_ids_match_score][desc] query boolean false true Boolean specifying the sort direction for the `amenity_ids_match_score` sorter. When unspecified, ascending order is implied.
sorter[amenity_ids_match_score][amenity_ids] query string false 1,2 Amenity IDs for the `amenity_ids_match_score` sorter
sorter[avg_score][desc] query boolean false true Boolean specifying the sort direction for the `avg_score` sorter. When unspecified, ascending order is implied.
limit query string false availabilities Specify a limiter here. There are 4 different limiters:
limiter[availabilities][limit] query integer false 10 Return `limit` availabilities
limiter[start_dates][limit] query integer false 10 Limit to the `limit` best arrival dates
limiter[start_dates][availabilities] query integer false 10 Number of availabilities to return
limiter[categories][limit] query integer false 10 Limit to the `limit` best categories
limiter[categories][offset] query integer false 0 Result offset for the `categories` limiter, useful for pagination
limiter[categories][availabilities] query integer false 10 Number of availabilities to return
limiter[administrations][limit] query integer false 10 Limit to the `limit` best administrations
limiter[administrations][categories] query integer false 3 Limit to the `limit` best categories
limiter[administrations][availabilities] query integer false 10 Number of availabilities to return

Detailed descriptions

sorters: Specify a comma separated list of sorters to apply. There are 10 possible sorters:

Configuration for each applied sorter (for example descending order) must be passed separately, see the options below.

limit: Specify a limiter here. There are 4 different limiters:

Configuration for the chosen limiter (for example the number of availabilities to return) must be passed separately, see the options below.

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "availability",
    "attributes": {
      "start_date": "2019-08-24",
      "los": 7,
      "checkin_time": "14:00",
      "checkout_time": "10:00",
      "price": {
        "currency": "string",
        "value": "string"
      },
      "original_price": {
        "currency": "string",
        "value": "string"
      },
      "rent_price": {
        "currency": "string",
        "value": "string"
      },
      "original_rent_price": {
        "currency": "string",
        "value": "string"
      },
      "stock": 2
    },
    "relationships": {
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "category": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "discount_campaign": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "missing_amenities": {
        "data": [
          {}
        ]
      },
      "available_rentables": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK AvailabilityResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Availability](#schemaavailability) false none Availabilities represent a stay in or at a Rentable (mostly a holiday house, room or campsite).
It includes an exact (all-in) price for the supplied guest group and other filters.
For example, the search can give you a list of availabilities for 2 adults, 2 children, 1 pet, scoped on The Netherlands and Belgium with
preference for a Rentable with sea view for a specific price range including all-in prices. This allows the guest to really compare
Rentables because there will be no fees that are added during the reservation process.

*Note: Users can explicitly exclude costs from the all-in price. This is not standard behaviour.*
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— start_date string(date) false none Date of arrival
——— los integer false none Length of stay in nights
——— checkin_time string false none none
——— checkout_time string false none none
——— price object false none All-in price considering rent, extras and discounts. Will be null when no guest group supplied
———— currency string false none none
———— value string false none none
——— original_price object false none Price considering rent, extras but without discounts. Will be null when no guest group supplied
———— currency string false none none
———— value string false none none
——— rent_price object false none Rent-only price. Does not include extra costs. Includes applicable discount
———— currency string false none none
———— value string false none none
——— original_rent_price object false none Rent-only price without applicable discount
———— currency string false none none
———— value string false none none
——— stock integer false none The number of units of this category available in this period. Takes filters and allotments into account
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— category object false none none
———— data object false none none
————— id string false none category ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— discount_campaign object false none none
———— data object false none none
————— id string false none discount_campaign ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— missing_amenities object false none none
———— data [object] false none none
————— id string false none missing_amenities ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— available_rentables object false none none
———— data [object] false none none
————— id string false none available_rentables ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

Bookings

GET bookings

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/bookings \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/bookings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/bookings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/bookings");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/bookings

Returns all bookings of the administration

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
page[number] query string false string Page number
page[size] query string false string Page size
sort query string false string Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \- to sort in descending order
fields[booking] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[after_payment_return_url] query string false string Filter on after_payment_return_url
filter[option_validity] query string false string Filter on option_validity
filter[remote_booking_nr] query string false string Filter on remote_booking_nr
filter[locale] query string false string Filter on locale
filter[memo] query string false string Filter on memo
filter[cancel_date] query string false string Filter on cancel_date
filter[cancel_reason] query string false string Filter on cancel_reason
filter[state] query string false string Filter on state
filter[token] query string false string Filter on token
filter[confirmed_at] query string false string Filter on confirmed_at
filter[booking_nr] query string false string Filter on booking_nr
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[customer] query string false string Filter on customer. Specify a comma separated list of IDs to filter on.
filter[traffic_source] query string false string Filter on traffic_source. Specify a comma separated list of IDs to filter on.
filter[administration] query string false string Filter on administration. Specify a comma separated list of IDs to filter on.
filter[channel] query string false string Filter on channel. Specify a comma separated list of IDs to filter on.
filter[reservations] query string false string Filter on reservations. Specify a comma separated list of IDs to filter on.
filter[payments] query string false string Filter on payments. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "booking",
      "attributes": {
        "after_payment_return_url": "string",
        "redeemable_codes": [
          "string"
        ],
        "option_validity": 3,
        "remote_booking_nr": "string",
        "locale": "nl",
        "memo": "string",
        "currency": "EUR",
        "cancel_date": "2019-08-24",
        "cancel_reason": "string",
        "state": "concept",
        "token": "string",
        "confirmed_at": "2019-08-24T14:15:22Z",
        "paid_by_customer": true,
        "deposit_completed": false,
        "booking_nr": "string",
        "owner_reservation": true,
        "total": {
          "currency": "string",
          "value": "string"
        },
        "total_without_vat": {
          "currency": "string",
          "value": "string"
        },
        "guest_payment_due": {
          "currency": "string",
          "value": "string"
        },
        "deposit": {
          "currency": "string",
          "value": "string"
        },
        "rent_turnover": {
          "currency": "string",
          "value": "string"
        },
        "rent_turnover_without_vat": {
          "currency": "string",
          "value": "string"
        },
        "provision": {
          "currency": "string",
          "value": "string"
        },
        "payment_deadlines": [
          {
            "date": null,
            "open_amount": null,
            "paid_amount": null
          }
        ],
        "pending_vouchers": [
          {
            "code": null,
            "balance": null,
            "amount": null
          }
        ],
        "created_at": "string",
        "updated_at": "string"
      },
      "links": {
        "self": "string",
        "pay_url": "string"
      },
      "relationships": {
        "customer": {
          "data": {}
        },
        "traffic_source": {
          "data": {}
        },
        "administration": {
          "data": {}
        },
        "channel": {
          "data": {}
        },
        "guest_invoice": {
          "data": {}
        },
        "customer_invoice": {
          "data": {}
        },
        "channel_invoice": {
          "data": {}
        },
        "reservations": {
          "data": [
            null
          ]
        },
        "payments": {
          "data": [
            null
          ]
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK BookingCollectionResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [[Booking](#schemabooking)] false none [A Booking consists of one or more reservations.
It should be considered a shopping cart.
The Booking defines the total amount that needs to be paid.
]
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— after_payment_return_url string false none none
——— redeemable_codes [string] false none none
——— option_validity integer false none Returns the option validity in days when this is an option. Specify this attribute on create to make an option.
——— remote_booking_nr string false none External booking number
——— locale string false none Locale of customer. Is used for communication.
——— memo string false none Returns the current content of the memo. Can be specified as input to set an initial memo.
——— currency string false read-only none
——— cancel_date string(date) false none Date on which the reservation has been cancelled
——— cancel_reason string false none Reason why the reservation is cancelled
——— state string false read-only Marks the state of the reservation.
——— token string false read-only Unique token which is used to prevent tampering. Token is mostly used for all customer facing urls.
——— confirmed_at string(date-time) false read-only Moment at which the reservation has been confirmed.
——— paid_by_customer boolean false read-only Indicates if the customer has fully paid.
——— deposit_completed boolean false read-only Marks if the deposit fulfilled.
——— booking_nr string false read-only Unique number to identify the booking.
——— owner_reservation boolean false read-only Indicates if this is a reservation of the owner of the accommodation.
——— total object false read-only none
———— currency string false none none
———— value string false none none
——— total_without_vat object false read-only none
———— currency string false none none
———— value string false none none
——— guest_payment_due object false read-only none
———— currency string false none none
———— value string false none none
——— deposit object false read-only none
———— currency string false none none
———— value string false none none
——— rent_turnover object false read-only none
———— currency string false none none
———— value string false none none
——— rent_turnover_without_vat object false read-only none
———— currency string false none none
———— value string false none none
——— provision object false read-only none
———— currency string false none none
———— value string false none none
——— payment_deadlines [object] false read-only none
———— date string(date) false none none
———— open_amount object false none none
————— currency string false none none
————— value string false none none
———— paid_amount object false none none
————— currency string false none none
————— value string false none none
——— pending_vouchers [object] false read-only none
———— code string false none none
———— balance object false none none
————— currency string false none none
————— value string false none none
———— amount object false none none
————— currency string false none none
————— value string false none none
——— created_at string false read-only none
——— updated_at string false read-only none
—— links object false none Links
——— self string false none Link to self
——— pay_url string false none Link to pay_url
—— relationships object false none Relationships
——— customer object false none Returns the customer of the booking. This relationship can be managed via sideposting.
———— data object false none none
————— id string false none customer ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— traffic_source object false none none
———— data object false none none
————— id string false none traffic_source ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— administration object false none none
———— data object false read-only none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel object false none none
———— data object false read-only none
————— id string false none channel ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_invoice object false none DEPRECATED use customer_invoice instead
———— data object false read-only none
————— id string false none guest_invoice ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— customer_invoice object false none none
———— data object false read-only none
————— id string false none customer_invoice ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel_invoice object false none none
———— data object false read-only none
————— id string false none channel_invoice ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— reservations object false none none
———— data [object] false read-only none
————— id string false none reservations ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— payments object false none none
———— data [object] false read-only none
————— id string false none payments ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.
— meta object false none none
—— pagination object false none none
——— total_records integer false none none
——— page integer false none none
——— size integer false none none

Enumerated Values

Property Value
locale nl
locale en
locale de
locale fr
locale da
locale cs
locale es
locale tr
locale pt
locale it
currency EUR
currency USD
currency CHF
currency CZK
currency TRY
currency CVE
currency ANG
currency GBP
state concept
state concept_to_be_accepted
state concept_option
state concept_to_be_accepted_option
state temporary
state temporary_to_be_accepted
state temporary_to_be_checked
state temporary_to_be_accepted_and_checked
state temporary_option
state temporary_to_be_accepted_option
state to_be_accepted
state to_be_accepted_option
state to_be_checked
state to_be_accepted_and_checked
state option
state rejected
state confirmed
state imported
state cancelled

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

GET booking

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/bookings/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/bookings/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/bookings/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/bookings/string");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/bookings/{id}

Returns a booking

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
id path string true string Resource ID
fields[booking] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[after_payment_return_url] query string false string Filter on after_payment_return_url
filter[option_validity] query string false string Filter on option_validity
filter[remote_booking_nr] query string false string Filter on remote_booking_nr
filter[locale] query string false string Filter on locale
filter[memo] query string false string Filter on memo
filter[cancel_date] query string false string Filter on cancel_date
filter[cancel_reason] query string false string Filter on cancel_reason
filter[state] query string false string Filter on state
filter[token] query string false string Filter on token
filter[confirmed_at] query string false string Filter on confirmed_at
filter[booking_nr] query string false string Filter on booking_nr
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[customer] query string false string Filter on customer. Specify a comma separated list of IDs to filter on.
filter[traffic_source] query string false string Filter on traffic_source. Specify a comma separated list of IDs to filter on.
filter[administration] query string false string Filter on administration. Specify a comma separated list of IDs to filter on.
filter[channel] query string false string Filter on channel. Specify a comma separated list of IDs to filter on.
filter[reservations] query string false string Filter on reservations. Specify a comma separated list of IDs to filter on.
filter[payments] query string false string Filter on payments. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "booking",
    "attributes": {
      "after_payment_return_url": "string",
      "redeemable_codes": [
        "string"
      ],
      "option_validity": 3,
      "remote_booking_nr": "string",
      "locale": "nl",
      "memo": "string",
      "currency": "EUR",
      "cancel_date": "2019-08-24",
      "cancel_reason": "string",
      "state": "concept",
      "token": "string",
      "confirmed_at": "2019-08-24T14:15:22Z",
      "paid_by_customer": true,
      "deposit_completed": false,
      "booking_nr": "string",
      "owner_reservation": true,
      "total": {
        "currency": "string",
        "value": "string"
      },
      "total_without_vat": {
        "currency": "string",
        "value": "string"
      },
      "guest_payment_due": {
        "currency": "string",
        "value": "string"
      },
      "deposit": {
        "currency": "string",
        "value": "string"
      },
      "rent_turnover": {
        "currency": "string",
        "value": "string"
      },
      "rent_turnover_without_vat": {
        "currency": "string",
        "value": "string"
      },
      "provision": {
        "currency": "string",
        "value": "string"
      },
      "payment_deadlines": [
        {
          "date": "2019-08-24",
          "open_amount": {},
          "paid_amount": {}
        }
      ],
      "pending_vouchers": [
        {
          "code": "string",
          "balance": {},
          "amount": {}
        }
      ],
      "created_at": "string",
      "updated_at": "string"
    },
    "links": {
      "self": "string",
      "pay_url": "string"
    },
    "relationships": {
      "customer": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "traffic_source": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "channel": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "guest_invoice": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "customer_invoice": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "channel_invoice": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "reservations": {
        "data": [
          {}
        ]
      },
      "payments": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK BookingResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Booking](#schemabooking) false none A Booking consists of one or more reservations.
It should be considered a shopping cart.
The Booking defines the total amount that needs to be paid.
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— after_payment_return_url string false none none
——— redeemable_codes [string] false none none
——— option_validity integer false none Returns the option validity in days when this is an option. Specify this attribute on create to make an option.
——— remote_booking_nr string false none External booking number
——— locale string false none Locale of customer. Is used for communication.
——— memo string false none Returns the current content of the memo. Can be specified as input to set an initial memo.
——— currency string false read-only none
——— cancel_date string(date) false none Date on which the reservation has been cancelled
——— cancel_reason string false none Reason why the reservation is cancelled
——— state string false read-only Marks the state of the reservation.
——— token string false read-only Unique token which is used to prevent tampering. Token is mostly used for all customer facing urls.
——— confirmed_at string(date-time) false read-only Moment at which the reservation has been confirmed.
——— paid_by_customer boolean false read-only Indicates if the customer has fully paid.
——— deposit_completed boolean false read-only Marks if the deposit fulfilled.
——— booking_nr string false read-only Unique number to identify the booking.
——— owner_reservation boolean false read-only Indicates if this is a reservation of the owner of the accommodation.
——— total object false read-only none
———— currency string false none none
———— value string false none none
——— total_without_vat object false read-only none
———— currency string false none none
———— value string false none none
——— guest_payment_due object false read-only none
———— currency string false none none
———— value string false none none
——— deposit object false read-only none
———— currency string false none none
———— value string false none none
——— rent_turnover object false read-only none
———— currency string false none none
———— value string false none none
——— rent_turnover_without_vat object false read-only none
———— currency string false none none
———— value string false none none
——— provision object false read-only none
———— currency string false none none
———— value string false none none
——— payment_deadlines [object] false read-only none
———— date string(date) false none none
———— open_amount object false none none
————— currency string false none none
————— value string false none none
———— paid_amount object false none none
————— currency string false none none
————— value string false none none
——— pending_vouchers [object] false read-only none
———— code string false none none
———— balance object false none none
————— currency string false none none
————— value string false none none
———— amount object false none none
————— currency string false none none
————— value string false none none
——— created_at string false read-only none
——— updated_at string false read-only none
—— links object false none Links
——— self string false none Link to self
——— pay_url string false none Link to pay_url
—— relationships object false none Relationships
——— customer object false none Returns the customer of the booking. This relationship can be managed via sideposting.
———— data object false none none
————— id string false none customer ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— traffic_source object false none none
———— data object false none none
————— id string false none traffic_source ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— administration object false none none
———— data object false read-only none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel object false none none
———— data object false read-only none
————— id string false none channel ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_invoice object false none DEPRECATED use customer_invoice instead
———— data object false read-only none
————— id string false none guest_invoice ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— customer_invoice object false none none
———— data object false read-only none
————— id string false none customer_invoice ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— channel_invoice object false none none
———— data object false read-only none
————— id string false none channel_invoice ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— reservations object false none none
———— data [object] false read-only none
————— id string false none reservations ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— payments object false none none
———— data [object] false read-only none
————— id string false none payments ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Enumerated Values

Property Value
locale nl
locale en
locale de
locale fr
locale da
locale cs
locale es
locale tr
locale pt
locale it
currency EUR
currency USD
currency CHF
currency CZK
currency TRY
currency CVE
currency ANG
currency GBP
state concept
state concept_to_be_accepted
state concept_option
state concept_to_be_accepted_option
state temporary
state temporary_to_be_accepted
state temporary_to_be_checked
state temporary_to_be_accepted_and_checked
state temporary_option
state temporary_to_be_accepted_option
state to_be_accepted
state to_be_accepted_option
state to_be_checked
state to_be_accepted_and_checked
state option
state rejected
state confirmed
state imported
state cancelled

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

Categories

GET categories

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/categories \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/categories",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/categories");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/categories

Returns categories of the administration

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
page[number] query string false string Page number
page[size] query string false string Page size
sort query string false string Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \- to sort in descending order
fields[category] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[description] query string false string Filter on description
filter[short_description] query string false string Filter on short_description
filter[usps] query string false string Filter on usps
filter[type] query string false string Filter on type
filter[highlighted] query string false string Filter on highlighted
filter[reference] query string false string Filter on reference
filter[maximum_number_of_nights] query string false string Filter on maximum_number_of_nights
filter[minimum_number_of_nights] query string false string Filter on minimum_number_of_nights
filter[number_of_bedrooms] query string false string Filter on number_of_bedrooms
filter[number_of_beds] query string false string Filter on number_of_beds
filter[number_of_showers] query string false string Filter on number_of_showers
filter[number_of_toilets] query string false string Filter on number_of_toilets
filter[number_of_bathrooms] query string false string Filter on number_of_bathrooms
filter[number_of_parking_spots] query string false string Filter on number_of_parking_spots
filter[number_of_child_beds] query string false string Filter on number_of_child_beds
filter[number_of_child_chairs] query string false string Filter on number_of_child_chairs
filter[summer_video_id] query string false string Filter on summer_video_id
filter[winter_video_id] query string false string Filter on winter_video_id
filter[whole_year_video_id] query string false string Filter on whole_year_video_id
filter[master_price_list_price_factor] query string false string Filter on master_price_list_price_factor
filter[master_price_list_fixed_rate] query string false string Filter on master_price_list_fixed_rate
filter[archived] query string false string Filter on archived
filter[max_number_of_people] query string false string Filter on max_number_of_people
filter[max_number_of_babies] query string false string Filter on max_number_of_babies
filter[max_number_of_pets] query string false string Filter on max_number_of_pets
filter[prices_updated_at] query string false string Filter on prices_updated_at
filter[prices_indexed_at] query string false string Filter on prices_indexed_at
filter[stock_updated_at] query string false string Filter on stock_updated_at
filter[stock_indexed_at] query string false string Filter on stock_indexed_at
filter[costs_updated_at] query string false string Filter on costs_updated_at
filter[extras_updated_at] query string false string Filter on extras_updated_at
filter[bookable_discounts_changed_at] query string false string Filter on bookable_discounts_changed_at
filter[last_date_with_price] query string false string Filter on last_date_with_price
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[administration] query string false string Filter on administration. Specify a comma separated list of IDs to filter on.
filter[city] query string false string Filter on city. Specify a comma separated list of IDs to filter on.
filter[terms] query string false string Filter on terms. Specify a comma separated list of IDs to filter on.
filter[accommodation_type] query string false string Filter on accommodation_type. Specify a comma separated list of IDs to filter on.
filter[accommodation_subtype] query string false string Filter on accommodation_subtype. Specify a comma separated list of IDs to filter on.
filter[master_price_list] query string false string Filter on master_price_list. Specify a comma separated list of IDs to filter on.
filter[images] query string false string Filter on images. Specify a comma separated list of IDs to filter on.
filter[guest_group_limits] query string false string Filter on guest_group_limits. Specify a comma separated list of IDs to filter on.
filter[rooms] query string false string Filter on rooms. Specify a comma separated list of IDs to filter on.
filter[category_amenities] query string false string Filter on category_amenities. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.
include_archived query boolean false true When true, archived types are included in the response

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "category",
      "attributes": {
        "name": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "description": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "short_description": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "usps": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "type": "Category",
        "highlighted": true,
        "reference": "string",
        "maximum_number_of_nights": 0,
        "minimum_number_of_nights": 0,
        "number_of_bedrooms": 0,
        "number_of_beds": 0,
        "number_of_showers": 0,
        "number_of_toilets": 0,
        "number_of_bathrooms": 0,
        "number_of_parking_spots": 0,
        "number_of_child_beds": 0,
        "number_of_child_chairs": 0,
        "summer_video_id": "string",
        "winter_video_id": "string",
        "whole_year_video_id": "string",
        "master_price_list_price_factor": 0,
        "master_price_list_fixed_rate": 0,
        "archived": true,
        "rentable_type": "string",
        "max_number_of_people": 0,
        "max_number_of_seniors": 0,
        "max_number_of_adults": 0,
        "max_number_of_adolescents": 0,
        "max_number_of_children": 0,
        "max_number_of_babies": 0,
        "max_number_of_pets": 0,
        "prices_updated_at": "2019-08-24T14:15:22Z",
        "prices_indexed_at": "2019-08-24T14:15:22Z",
        "stock_updated_at": "2019-08-24T14:15:22Z",
        "stock_indexed_at": "2019-08-24T14:15:22Z",
        "costs_updated_at": "2019-08-24T14:15:22Z",
        "extras_updated_at": "2019-08-24T14:15:22Z",
        "bookable_discounts_changed_at": "2019-08-24T14:15:22Z",
        "max_baby_age": 0,
        "max_child_age": 0,
        "max_adolescent_age": 0,
        "min_senior_age": 0,
        "pets_allowed": "all",
        "host_image_url": "string",
        "same_day_bookings_allowed": true,
        "same_day_booking_closing_time": "14:15:22Z",
        "last_date_with_price": "2019-08-24",
        "address": "string",
        "postal_code": "string",
        "city": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "region": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "country_code": "string",
        "latitude": 0,
        "longitude": 0,
        "location_is_exact": true,
        "checkin_times_for_week": [
          "string"
        ],
        "checkout_times_for_week": [
          "string"
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "links": {
        "parkcms_url": "string"
      },
      "relationships": {
        "administration": {
          "data": {}
        },
        "city": {
          "data": {}
        },
        "terms": {
          "data": {}
        },
        "accommodation_type": {
          "data": {}
        },
        "accommodation_subtype": {
          "data": {}
        },
        "master_price_list": {
          "data": {}
        },
        "images": {
          "data": [
            null
          ]
        },
        "guest_group_limits": {
          "data": [
            null
          ]
        },
        "rooms": {
          "data": [
            null
          ]
        },
        "category_amenities": {
          "data": [
            null
          ]
        },
        "optional_amenities": {
          "data": [
            null
          ]
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK CategoryCollectionResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [[Category](#schemacategory)] false none [A Category represents a type of accommodation and thus can have multiple underlying Rentables.
The specific Rentables are not advertised to the guest. The exact Rentable is hidden
from the guest so that the organization is flexible in assigning guests to different accommodations.
]
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— description object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— short_description object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— usps object false none Translated unique selling points
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— type string false none Type of the category
——— highlighted boolean false none Whether this category should be highlighted on the website
——— reference string false none none
——— maximum_number_of_nights integer false none none
——— minimum_number_of_nights integer false none none
——— number_of_bedrooms integer false none none
——— number_of_beds integer false none none
——— number_of_showers integer false none none
——— number_of_toilets integer false none none
——— number_of_bathrooms integer false none none
——— number_of_parking_spots integer false none none
——— number_of_child_beds integer false none none
——— number_of_child_chairs integer false none none
——— summer_video_id string false none none
——— winter_video_id string false none none
——— whole_year_video_id string false none none
——— master_price_list_price_factor number(float) false none The prices in the price list are multiplied by this value. For example, if the factor is 1.1, 10% is added to the prices. Values below 1.0 are also possible.
——— master_price_list_fixed_rate number(float) false none This rate is added to (or subtracted from if negative) the prices of the price list. The value is per night, so a midweek price for monday to friday, gets this value added times four.
——— archived boolean false read-only none
——— rentable_type string false read-only none
——— max_number_of_people integer false read-only none
——— max_number_of_seniors integer false read-only none
——— max_number_of_adults integer false read-only none
——— max_number_of_adolescents integer false read-only none
——— max_number_of_children integer false read-only none
——— max_number_of_babies integer false read-only none
——— max_number_of_pets integer false read-only none
——— prices_updated_at string(date-time) false read-only Timestamp when the prices of this category were last updated
——— prices_indexed_at string(date-time) false read-only Timestamp when the prices of this category were last indexed for availability search
——— stock_updated_at string(date-time) false read-only Timestamp when the stock of this category was last updated
——— stock_indexed_at string(date-time) false read-only Timestamp when the stock of this category was last indexed for availability search
——— costs_updated_at string(date-time) false read-only Timestamp when the costs of this category were last updated
——— extras_updated_at string(date-time) false read-only Timestamp when the extras of this category were last updated
——— bookable_discounts_changed_at string(date-time) false read-only Timestamp when the bookable discounts of this category were last updated
——— max_baby_age integer false read-only none
——— max_child_age integer false read-only none
——— max_adolescent_age integer false read-only none
——— min_senior_age integer false read-only none
——— pets_allowed string false read-only Whether pets are allowed on all, some or none of the accommodations of this type
——— host_image_url string false read-only none
——— same_day_bookings_allowed boolean false read-only none
——— same_day_booking_closing_time string(time) false read-only none
——— last_date_with_price string(date) false read-only none
——— address string false read-only none
——— postal_code string false read-only none
——— city object false read-only none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— region object false read-only none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— country_code string false read-only none
——— latitude number(float) false read-only none
——— longitude number(float) false read-only none
——— location_is_exact boolean false read-only none
——— checkin_times_for_week [string] false read-only none
——— checkout_times_for_week [string] false read-only none
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— links object false none Links
——— parkcms_url string false none Link to parkcms_url
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— city object false none none
———— data object false none none
————— id string false none city ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— terms object false none none
———— data object false none none
————— id string false none terms ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— accommodation_type object false none none
———— data object false none none
————— id string false none accommodation_type ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— accommodation_subtype object false none none
———— data object false none none
————— id string false none accommodation_subtype ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— master_price_list object false none none
———— data object false none none
————— id string false none master_price_list ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— images object false none none
———— data [object] false none none
————— id string false none images ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_group_limits object false none none
———— data [object] false none none
————— id string false none guest_group_limits ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— rooms object false none none
———— data [object] false none none
————— id string false none rooms ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— category_amenities object false none none
———— data [object] false none none
————— id string false none category_amenities ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— optional_amenities object false none none
———— data [object] false none none
————— id string false none optional_amenities ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.
— meta object false none none
—— pagination object false none none
——— total_records integer false none none
——— page integer false none none
——— size integer false none none

Enumerated Values

Property Value
type Category
type ClusterCategory
type GroupedCategory
pets_allowed all
pets_allowed some
pets_allowed none

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

GET category

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/administrations/1/categories/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/administrations/1/categories/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/administrations/1/categories/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/administrations/1/categories/string");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/administrations/{administration_id}/categories/{id}

Returns the category for the given ID

Parameters

Name In Type Required Example Description
administration_id path string true 1 Administration ID
id path string true string Resource ID
fields[category] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[description] query string false string Filter on description
filter[short_description] query string false string Filter on short_description
filter[usps] query string false string Filter on usps
filter[type] query string false string Filter on type
filter[highlighted] query string false string Filter on highlighted
filter[reference] query string false string Filter on reference
filter[maximum_number_of_nights] query string false string Filter on maximum_number_of_nights
filter[minimum_number_of_nights] query string false string Filter on minimum_number_of_nights
filter[number_of_bedrooms] query string false string Filter on number_of_bedrooms
filter[number_of_beds] query string false string Filter on number_of_beds
filter[number_of_showers] query string false string Filter on number_of_showers
filter[number_of_toilets] query string false string Filter on number_of_toilets
filter[number_of_bathrooms] query string false string Filter on number_of_bathrooms
filter[number_of_parking_spots] query string false string Filter on number_of_parking_spots
filter[number_of_child_beds] query string false string Filter on number_of_child_beds
filter[number_of_child_chairs] query string false string Filter on number_of_child_chairs
filter[summer_video_id] query string false string Filter on summer_video_id
filter[winter_video_id] query string false string Filter on winter_video_id
filter[whole_year_video_id] query string false string Filter on whole_year_video_id
filter[master_price_list_price_factor] query string false string Filter on master_price_list_price_factor
filter[master_price_list_fixed_rate] query string false string Filter on master_price_list_fixed_rate
filter[archived] query string false string Filter on archived
filter[max_number_of_people] query string false string Filter on max_number_of_people
filter[max_number_of_babies] query string false string Filter on max_number_of_babies
filter[max_number_of_pets] query string false string Filter on max_number_of_pets
filter[prices_updated_at] query string false string Filter on prices_updated_at
filter[prices_indexed_at] query string false string Filter on prices_indexed_at
filter[stock_updated_at] query string false string Filter on stock_updated_at
filter[stock_indexed_at] query string false string Filter on stock_indexed_at
filter[costs_updated_at] query string false string Filter on costs_updated_at
filter[extras_updated_at] query string false string Filter on extras_updated_at
filter[bookable_discounts_changed_at] query string false string Filter on bookable_discounts_changed_at
filter[last_date_with_price] query string false string Filter on last_date_with_price
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[administration] query string false string Filter on administration. Specify a comma separated list of IDs to filter on.
filter[city] query string false string Filter on city. Specify a comma separated list of IDs to filter on.
filter[terms] query string false string Filter on terms. Specify a comma separated list of IDs to filter on.
filter[accommodation_type] query string false string Filter on accommodation_type. Specify a comma separated list of IDs to filter on.
filter[accommodation_subtype] query string false string Filter on accommodation_subtype. Specify a comma separated list of IDs to filter on.
filter[master_price_list] query string false string Filter on master_price_list. Specify a comma separated list of IDs to filter on.
filter[images] query string false string Filter on images. Specify a comma separated list of IDs to filter on.
filter[guest_group_limits] query string false string Filter on guest_group_limits. Specify a comma separated list of IDs to filter on.
filter[rooms] query string false string Filter on rooms. Specify a comma separated list of IDs to filter on.
filter[category_amenities] query string false string Filter on category_amenities. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.

Example responses

200 Response

{
  "data": {
    "id": "1",
    "type": "category",
    "attributes": {
      "name": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "description": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "short_description": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "usps": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "type": "Category",
      "highlighted": true,
      "reference": "string",
      "maximum_number_of_nights": 0,
      "minimum_number_of_nights": 0,
      "number_of_bedrooms": 0,
      "number_of_beds": 0,
      "number_of_showers": 0,
      "number_of_toilets": 0,
      "number_of_bathrooms": 0,
      "number_of_parking_spots": 0,
      "number_of_child_beds": 0,
      "number_of_child_chairs": 0,
      "summer_video_id": "string",
      "winter_video_id": "string",
      "whole_year_video_id": "string",
      "master_price_list_price_factor": 0,
      "master_price_list_fixed_rate": 0,
      "archived": true,
      "rentable_type": "string",
      "max_number_of_people": 0,
      "max_number_of_seniors": 0,
      "max_number_of_adults": 0,
      "max_number_of_adolescents": 0,
      "max_number_of_children": 0,
      "max_number_of_babies": 0,
      "max_number_of_pets": 0,
      "prices_updated_at": "2019-08-24T14:15:22Z",
      "prices_indexed_at": "2019-08-24T14:15:22Z",
      "stock_updated_at": "2019-08-24T14:15:22Z",
      "stock_indexed_at": "2019-08-24T14:15:22Z",
      "costs_updated_at": "2019-08-24T14:15:22Z",
      "extras_updated_at": "2019-08-24T14:15:22Z",
      "bookable_discounts_changed_at": "2019-08-24T14:15:22Z",
      "max_baby_age": 0,
      "max_child_age": 0,
      "max_adolescent_age": 0,
      "min_senior_age": 0,
      "pets_allowed": "all",
      "host_image_url": "string",
      "same_day_bookings_allowed": true,
      "same_day_booking_closing_time": "14:15:22Z",
      "last_date_with_price": "2019-08-24",
      "address": "string",
      "postal_code": "string",
      "city": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "region": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "country_code": "string",
      "latitude": 0,
      "longitude": 0,
      "location_is_exact": true,
      "checkin_times_for_week": [
        "string"
      ],
      "checkout_times_for_week": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "links": {
      "parkcms_url": "string"
    },
    "relationships": {
      "administration": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "city": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "terms": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "accommodation_type": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "accommodation_subtype": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "master_price_list": {
        "data": {
          "id": null,
          "type": null,
          "meta": null
        }
      },
      "images": {
        "data": [
          {}
        ]
      },
      "guest_group_limits": {
        "data": [
          {}
        ]
      },
      "rooms": {
        "data": [
          {}
        ]
      },
      "category_amenities": {
        "data": [
          {}
        ]
      },
      "optional_amenities": {
        "data": [
          {}
        ]
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK CategoryResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [Category](#schemacategory) false none A Category represents a type of accommodation and thus can have multiple underlying Rentables.
The specific Rentables are not advertised to the guest. The exact Rentable is hidden
from the guest so that the organization is flexible in assigning guests to different accommodations.
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— description object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— short_description object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— usps object false none Translated unique selling points
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— type string false none Type of the category
——— highlighted boolean false none Whether this category should be highlighted on the website
——— reference string false none none
——— maximum_number_of_nights integer false none none
——— minimum_number_of_nights integer false none none
——— number_of_bedrooms integer false none none
——— number_of_beds integer false none none
——— number_of_showers integer false none none
——— number_of_toilets integer false none none
——— number_of_bathrooms integer false none none
——— number_of_parking_spots integer false none none
——— number_of_child_beds integer false none none
——— number_of_child_chairs integer false none none
——— summer_video_id string false none none
——— winter_video_id string false none none
——— whole_year_video_id string false none none
——— master_price_list_price_factor number(float) false none The prices in the price list are multiplied by this value. For example, if the factor is 1.1, 10% is added to the prices. Values below 1.0 are also possible.
——— master_price_list_fixed_rate number(float) false none This rate is added to (or subtracted from if negative) the prices of the price list. The value is per night, so a midweek price for monday to friday, gets this value added times four.
——— archived boolean false read-only none
——— rentable_type string false read-only none
——— max_number_of_people integer false read-only none
——— max_number_of_seniors integer false read-only none
——— max_number_of_adults integer false read-only none
——— max_number_of_adolescents integer false read-only none
——— max_number_of_children integer false read-only none
——— max_number_of_babies integer false read-only none
——— max_number_of_pets integer false read-only none
——— prices_updated_at string(date-time) false read-only Timestamp when the prices of this category were last updated
——— prices_indexed_at string(date-time) false read-only Timestamp when the prices of this category were last indexed for availability search
——— stock_updated_at string(date-time) false read-only Timestamp when the stock of this category was last updated
——— stock_indexed_at string(date-time) false read-only Timestamp when the stock of this category was last indexed for availability search
——— costs_updated_at string(date-time) false read-only Timestamp when the costs of this category were last updated
——— extras_updated_at string(date-time) false read-only Timestamp when the extras of this category were last updated
——— bookable_discounts_changed_at string(date-time) false read-only Timestamp when the bookable discounts of this category were last updated
——— max_baby_age integer false read-only none
——— max_child_age integer false read-only none
——— max_adolescent_age integer false read-only none
——— min_senior_age integer false read-only none
——— pets_allowed string false read-only Whether pets are allowed on all, some or none of the accommodations of this type
——— host_image_url string false read-only none
——— same_day_bookings_allowed boolean false read-only none
——— same_day_booking_closing_time string(time) false read-only none
——— last_date_with_price string(date) false read-only none
——— address string false read-only none
——— postal_code string false read-only none
——— city object false read-only none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— region object false read-only none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— country_code string false read-only none
——— latitude number(float) false read-only none
——— longitude number(float) false read-only none
——— location_is_exact boolean false read-only none
——— checkin_times_for_week [string] false read-only none
——— checkout_times_for_week [string] false read-only none
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— links object false none Links
——— parkcms_url string false none Link to parkcms_url
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— city object false none none
———— data object false none none
————— id string false none city ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— terms object false none none
———— data object false none none
————— id string false none terms ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— accommodation_type object false none none
———— data object false none none
————— id string false none accommodation_type ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— accommodation_subtype object false none none
———— data object false none none
————— id string false none accommodation_subtype ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— master_price_list object false none none
———— data object false none none
————— id string false none master_price_list ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— images object false none none
———— data [object] false none none
————— id string false none images ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_group_limits object false none none
———— data [object] false none none
————— id string false none guest_group_limits ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— rooms object false none none
———— data [object] false none none
————— id string false none rooms ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— category_amenities object false none none
———— data [object] false none none
————— id string false none category_amenities ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— optional_amenities object false none none
———— data [object] false none none
————— id string false none optional_amenities ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.

Enumerated Values

Property Value
type Category
type ClusterCategory
type GroupedCategory
pets_allowed all
pets_allowed some
pets_allowed none

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

Channel Categories

List categories for the channels that are linked to your subscription

GET categories

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/categories \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/channels/1/categories")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/categories",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/channels/1/categories");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/channels/{channel_id}/categories

Returns the categories that are available to the current channel

Parameters

Name In Type Required Example Description
channel_id path string true 1 Channel ID
page[number] query string false string Page number
page[size] query string false string Page size
sort query string false string Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a \- to sort in descending order
fields[category] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[description] query string false string Filter on description
filter[short_description] query string false string Filter on short_description
filter[usps] query string false string Filter on usps
filter[type] query string false string Filter on type
filter[highlighted] query string false string Filter on highlighted
filter[reference] query string false string Filter on reference
filter[maximum_number_of_nights] query string false string Filter on maximum_number_of_nights
filter[minimum_number_of_nights] query string false string Filter on minimum_number_of_nights
filter[number_of_bedrooms] query string false string Filter on number_of_bedrooms
filter[number_of_beds] query string false string Filter on number_of_beds
filter[number_of_showers] query string false string Filter on number_of_showers
filter[number_of_toilets] query string false string Filter on number_of_toilets
filter[number_of_bathrooms] query string false string Filter on number_of_bathrooms
filter[number_of_parking_spots] query string false string Filter on number_of_parking_spots
filter[number_of_child_beds] query string false string Filter on number_of_child_beds
filter[number_of_child_chairs] query string false string Filter on number_of_child_chairs
filter[summer_video_id] query string false string Filter on summer_video_id
filter[winter_video_id] query string false string Filter on winter_video_id
filter[whole_year_video_id] query string false string Filter on whole_year_video_id
filter[master_price_list_price_factor] query string false string Filter on master_price_list_price_factor
filter[master_price_list_fixed_rate] query string false string Filter on master_price_list_fixed_rate
filter[archived] query string false string Filter on archived
filter[max_number_of_people] query string false string Filter on max_number_of_people
filter[max_number_of_babies] query string false string Filter on max_number_of_babies
filter[max_number_of_pets] query string false string Filter on max_number_of_pets
filter[prices_updated_at] query string false string Filter on prices_updated_at
filter[prices_indexed_at] query string false string Filter on prices_indexed_at
filter[stock_updated_at] query string false string Filter on stock_updated_at
filter[stock_indexed_at] query string false string Filter on stock_indexed_at
filter[costs_updated_at] query string false string Filter on costs_updated_at
filter[extras_updated_at] query string false string Filter on extras_updated_at
filter[bookable_discounts_changed_at] query string false string Filter on bookable_discounts_changed_at
filter[last_date_with_price] query string false string Filter on last_date_with_price
filter[created_at] query string false string Filter on created_at
filter[updated_at] query string false string Filter on updated_at
filter[administration] query string false string Filter on administration. Specify a comma separated list of IDs to filter on.
filter[city] query string false string Filter on city. Specify a comma separated list of IDs to filter on.
filter[terms] query string false string Filter on terms. Specify a comma separated list of IDs to filter on.
filter[accommodation_type] query string false string Filter on accommodation_type. Specify a comma separated list of IDs to filter on.
filter[accommodation_subtype] query string false string Filter on accommodation_subtype. Specify a comma separated list of IDs to filter on.
filter[master_price_list] query string false string Filter on master_price_list. Specify a comma separated list of IDs to filter on.
filter[images] query string false string Filter on images. Specify a comma separated list of IDs to filter on.
filter[guest_group_limits] query string false string Filter on guest_group_limits. Specify a comma separated list of IDs to filter on.
filter[rooms] query string false string Filter on rooms. Specify a comma separated list of IDs to filter on.
filter[category_amenities] query string false string Filter on category_amenities. Specify a comma separated list of IDs to filter on.
include query string false string Includes list. Specify a comma separated list of resources to include.
Accept-Language header string false en,nl Supported languages. A comma separated list with one or more of the following locales: nl, en, de, fr, da, cs, es, tr, pt, it. Default: 'en'.
include_archived query boolean false true When true, archived types are included in the response

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "category",
      "attributes": {
        "name": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "description": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "short_description": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "usps": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "type": "Category",
        "highlighted": true,
        "reference": "string",
        "maximum_number_of_nights": 0,
        "minimum_number_of_nights": 0,
        "number_of_bedrooms": 0,
        "number_of_beds": 0,
        "number_of_showers": 0,
        "number_of_toilets": 0,
        "number_of_bathrooms": 0,
        "number_of_parking_spots": 0,
        "number_of_child_beds": 0,
        "number_of_child_chairs": 0,
        "summer_video_id": "string",
        "winter_video_id": "string",
        "whole_year_video_id": "string",
        "master_price_list_price_factor": 0,
        "master_price_list_fixed_rate": 0,
        "archived": true,
        "rentable_type": "string",
        "max_number_of_people": 0,
        "max_number_of_seniors": 0,
        "max_number_of_adults": 0,
        "max_number_of_adolescents": 0,
        "max_number_of_children": 0,
        "max_number_of_babies": 0,
        "max_number_of_pets": 0,
        "prices_updated_at": "2019-08-24T14:15:22Z",
        "prices_indexed_at": "2019-08-24T14:15:22Z",
        "stock_updated_at": "2019-08-24T14:15:22Z",
        "stock_indexed_at": "2019-08-24T14:15:22Z",
        "costs_updated_at": "2019-08-24T14:15:22Z",
        "extras_updated_at": "2019-08-24T14:15:22Z",
        "bookable_discounts_changed_at": "2019-08-24T14:15:22Z",
        "max_baby_age": 0,
        "max_child_age": 0,
        "max_adolescent_age": 0,
        "min_senior_age": 0,
        "pets_allowed": "all",
        "host_image_url": "string",
        "same_day_bookings_allowed": true,
        "same_day_booking_closing_time": "14:15:22Z",
        "last_date_with_price": "2019-08-24",
        "address": "string",
        "postal_code": "string",
        "city": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "region": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "country_code": "string",
        "latitude": 0,
        "longitude": 0,
        "location_is_exact": true,
        "checkin_times_for_week": [
          "string"
        ],
        "checkout_times_for_week": [
          "string"
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "links": {
        "parkcms_url": "string"
      },
      "relationships": {
        "administration": {
          "data": {}
        },
        "city": {
          "data": {}
        },
        "terms": {
          "data": {}
        },
        "accommodation_type": {
          "data": {}
        },
        "accommodation_subtype": {
          "data": {}
        },
        "master_price_list": {
          "data": {}
        },
        "images": {
          "data": [
            null
          ]
        },
        "guest_group_limits": {
          "data": [
            null
          ]
        },
        "rooms": {
          "data": [
            null
          ]
        },
        "category_amenities": {
          "data": [
            null
          ]
        },
        "optional_amenities": {
          "data": [
            null
          ]
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status Meaning Description Schema
200 OK CategoryCollectionResponse Inline
default Default Error Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
— data [[Category](#schemacategory)] false none [A Category represents a type of accommodation and thus can have multiple underlying Rentables.
The specific Rentables are not advertised to the guest. The exact Rentable is hidden
from the guest so that the organization is flexible in assigning guests to different accommodations.
]
—— id string false none ID
—— type string false none Type
—— attributes object false none Attributes
——— name object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— description object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— short_description object false none none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— usps object false none Translated unique selling points
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— type string false none Type of the category
——— highlighted boolean false none Whether this category should be highlighted on the website
——— reference string false none none
——— maximum_number_of_nights integer false none none
——— minimum_number_of_nights integer false none none
——— number_of_bedrooms integer false none none
——— number_of_beds integer false none none
——— number_of_showers integer false none none
——— number_of_toilets integer false none none
——— number_of_bathrooms integer false none none
——— number_of_parking_spots integer false none none
——— number_of_child_beds integer false none none
——— number_of_child_chairs integer false none none
——— summer_video_id string false none none
——— winter_video_id string false none none
——— whole_year_video_id string false none none
——— master_price_list_price_factor number(float) false none The prices in the price list are multiplied by this value. For example, if the factor is 1.1, 10% is added to the prices. Values below 1.0 are also possible.
——— master_price_list_fixed_rate number(float) false none This rate is added to (or subtracted from if negative) the prices of the price list. The value is per night, so a midweek price for monday to friday, gets this value added times four.
——— archived boolean false read-only none
——— rentable_type string false read-only none
——— max_number_of_people integer false read-only none
——— max_number_of_seniors integer false read-only none
——— max_number_of_adults integer false read-only none
——— max_number_of_adolescents integer false read-only none
——— max_number_of_children integer false read-only none
——— max_number_of_babies integer false read-only none
——— max_number_of_pets integer false read-only none
——— prices_updated_at string(date-time) false read-only Timestamp when the prices of this category were last updated
——— prices_indexed_at string(date-time) false read-only Timestamp when the prices of this category were last indexed for availability search
——— stock_updated_at string(date-time) false read-only Timestamp when the stock of this category was last updated
——— stock_indexed_at string(date-time) false read-only Timestamp when the stock of this category was last indexed for availability search
——— costs_updated_at string(date-time) false read-only Timestamp when the costs of this category were last updated
——— extras_updated_at string(date-time) false read-only Timestamp when the extras of this category were last updated
——— bookable_discounts_changed_at string(date-time) false read-only Timestamp when the bookable discounts of this category were last updated
——— max_baby_age integer false read-only none
——— max_child_age integer false read-only none
——— max_adolescent_age integer false read-only none
——— min_senior_age integer false read-only none
——— pets_allowed string false read-only Whether pets are allowed on all, some or none of the accommodations of this type
——— host_image_url string false read-only none
——— same_day_bookings_allowed boolean false read-only none
——— same_day_booking_closing_time string(time) false read-only none
——— last_date_with_price string(date) false read-only none
——— address string false read-only none
——— postal_code string false read-only none
——— city object false read-only none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— region object false read-only none
———— nl string false none none
———— en string false none none
———— de string false none none
———— fr string false none none
———— da string false none none
———— cs string false none none
———— es string false none none
———— tr string false none none
———— pt string false none none
———— it string false none none
——— country_code string false read-only none
——— latitude number(float) false read-only none
——— longitude number(float) false read-only none
——— location_is_exact boolean false read-only none
——— checkin_times_for_week [string] false read-only none
——— checkout_times_for_week [string] false read-only none
——— created_at string(date-time) false read-only none
——— updated_at string(date-time) false read-only none
—— links object false none Links
——— parkcms_url string false none Link to parkcms_url
—— relationships object false none Relationships
——— administration object false none none
———— data object false none none
————— id string false none administration ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— city object false none none
———— data object false none none
————— id string false none city ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— terms object false none none
———— data object false none none
————— id string false none terms ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— accommodation_type object false none none
———— data object false none none
————— id string false none accommodation_type ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— accommodation_subtype object false none none
———— data object false none none
————— id string false none accommodation_subtype ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— master_price_list object false none none
———— data object false none none
————— id string false none master_price_list ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— images object false none none
———— data [object] false none none
————— id string false none images ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— guest_group_limits object false none none
———— data [object] false none none
————— id string false none guest_group_limits ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— rooms object false none none
———— data [object] false none none
————— id string false none rooms ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— category_amenities object false none none
———— data [object] false none none
————— id string false none category_amenities ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
——— optional_amenities object false none none
———— data [object] false none none
————— id string false none optional_amenities ID
————— type string false none none
————— meta object false none none
—————— temp_id string false none UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known.
—————— method string false none Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update.
—— meta object false none Metadata
——— temp_id string false none UUID for internal resource linking. Should be omitted when the relationship ID is known.
— meta object false none none
—— pagination object false none none
——— total_records integer false none none
——— page integer false none none
——— size integer false none none

Enumerated Values

Property Value
type Category
type ClusterCategory
type GroupedCategory
pets_allowed all
pets_allowed some
pets_allowed none

Status Code default

Name Type Required Restrictions Description
— errors [object] false none none
—— status string false none HTTP response code
—— code string false none Internal error code
—— title string false none Error title
—— detail string false none Error details
—— source object false none none
——— pointer string false none Pointer to error in resource

GET category

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/categories/string \
  --header 'Accept: application/vnd.api+json' \
  --header 'Accept-Language: en,nl' \
  --header 'X-API-KEY: API_KEY'
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.bookingexperts.nl/v3/channels/1/categories/string")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/vnd.api+json'
request["Accept-Language"] = 'en,nl'
request["X-API-KEY"] = 'API_KEY'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/categories/string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: application/vnd.api+json",
    "Accept-Language: en,nl",
    "X-API-KEY: API_KEY"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.bookingexperts.nl/v3/channels/1/categories/string");
xhr.setRequestHeader("Accept", "application/vnd.api+json");
xhr.setRequestHeader("Accept-Language", "en,nl");
xhr.setRequestHeader("X-API-KEY", "API_KEY");

xhr.send(data);

GET /v3/channels/{channel_id}/categories/{id}

Returns the category for the given ID

Parameters

Name In Type Required Example Description
channel_id path string true 1 Channel ID
id path string true string Resource ID
fields[category] query string false string Fieldset. Specify a comma separated list of attributes to return
filter[id] query string false string Filter on ID
filter[name] query string false string Filter on name
filter[description] query string false string Filter on description
filter[short_description] query string false string Filter on short_description
filter[usps] query string false string Filter on usps
filter[type] query string false string Filter on type
filter[highlighted] query string false string Filter on highlighted
filter[reference] query string false string Filter on reference
filter[maximum_number_of_nights] query string false string Filter on maximum_number_of_nights
filter[minimum_number_of_nights] query string false string Filter on minimum_number_of_nights
filter[number_of_bedrooms] query string false string Filter on number_of_bedrooms
filter[number_of_beds] query string false string Filter on number_of_beds
filter[number_of_showers] query string false string Filter on number_of_showers
filter[number_of_toilets] query string false string Filter on number_of_toilets
filter[number_of_bathrooms] query string false string Filter on number_of_bathrooms
filter[number_of_parking_spots] query string false string Filter on number_of_parking_spots
filter[number_of_child_beds] query string false string Filter on number_of_child_beds
filter[number_of_child_chairs] query string false string Filter on number_of_child_chairs
filter[summer_video_id] query string false string Filter on summer_video_id
filter[winter_video_id] query string false string Filter on winter_video_id
filter[whole_year_video_id] query string false string Filter on whole_year_video_id
filter[master_price_list_price_factor] query string false string Filter on master_price_list_price_factor
filter[master_price_list_fixed_rate] query string false string Filter on master_price_list_fixed_rate
filter[archived] query string false string Filter on archived
filter[max_number_of_people] query string false string Filter on max_number_of_people
filter[max_number_of_babies] query string false string Filter on max_number_of_babies
filter[max_number_of_pets] query string false string Filter on max_number_of_pets
filter[prices_updated_at] query string false string Filter on prices_updated_at
filter[prices_indexed_at] query string false string Filter on prices_indexed_at
filter[stock_updated_at] query string false string Filter on stock_updated_at
filter[stock_indexed_at] query string false string Filter on stock_indexed_at
filter[costs_updated_at] query string false string Filter on costs_updated_at
filter[extras_updated_at] query string false string Filter on extras_updated_at
filter[bookable_discounts_changed_at] query string false string Filter on bookable_discounts_changed_at
filter[last_date_with_price] query string false string Filter on last_date_with_price
filter[created_at] query string false string