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
}

No matter which implementation you use, the hash signature starts with sha256=, using the key of your Client Secret and your payload body.
Using a plain == operator is not advised. A method like secure_compare performs a "constant time" string comparison, which renders it safe from certain timing attacks against regular equality operators.
Note that this approach has been taken from the Github webhook docs. There might be more examples on the web for this solution that can be used as inspiration.

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:

filter[attr]=term: attr = 'term'
filter[attr]=~term: attr ILIKE '%term%'
filter[attr]=term,term: attr IN ('term', 'term')
filter[attr]=a..b: attr1 BETWEEN 'a' AND 'b'

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:

filter[attr1|attr2]=term: attr1 = 'term' OR attr2 = 'term'
filter[attr1|attr2]=~term: attr1 ILIKE '%term%' OR attr2 ILIKE '%term%'
filter[attr1|attr2]=term,term: attr1 IN ('term', 'term') OR attr2 IN ('term', 'term')
filter[attr1|attr2]=a..b: attr1 BETWEEN 'a' AND 'b' OR attr2 BETWEEN 'a' AND 'b'

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):

availability|read
reservation|read
category|read
payment|write

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:

channel::reservation|read
channel::order|read
channel::customer|read

Authorization scopes

Scope	Scope Description
accommodation_subtype	read
administration	read
agenda_period	read
area_type	read
arrival_checkout_date	read
availability	read
category_group	read
category	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
debtor	read
discount_action	read
discount_card	read
executor	read
extra_order_item	read
extra_order_item	write
extra	read
guest	read
internal_message	write
invoice	read
journal_transaction	read
label	read
ledger_account	read
main_order_item	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
period	read
receipt	read
region	read
rentable_identity	read
rentable	read
reservation	read
reservation	write
review_form	read
review	read
room_type	read
room	read
signature	read
signature	write
tag	read
terms	read
todo_image	delete
todo_image	write
todo_list	read
todo	delete
todo	read
todo	write
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, array(
  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 => array(
    "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;
}

var data = null;

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

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,
        "created_at": "2021-07-27T18:52:56Z",
        "updated_at": "2021-07-27T18:52:56Z"
      },
      "relationships": {
        "administration": {
          "data": {
            "id": "string",
            "type": "administrations",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        },
        "guest_payment_policy": {
          "data": {
            "id": "string",
            "type": "payment_policy",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        },
        "channel_payment_policy": {
          "data": {
            "id": "string",
            "type": "payment_policy",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        },
        "excluded_costs": {
          "data": [
            {
              "id": "string",
              "type": "",
              "meta": {
                "temp_id": "string",
                "method": "string"
              }
            }
          ]
        }
      },
      "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]	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.
——— 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":"string","type":"administrations","meta":{"temp_id":"string","method":"string"}}},"guest_payment_policy":{"data":{"id":"string","type":"payment_policy","meta":{"temp_id":"string","method":"string"}}},"channel_payment_policy":{"data":{"id":"string","type":"payment_policy","meta":{"temp_id":"string","method":"string"}}},"excluded_costs":{"data":[{"id":"string","type":"","meta":{"temp_id":"string","method":"string"}}]}},"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\":\"string\",\"type\":\"administrations\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"guest_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"channel_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"excluded_costs\":{\"data\":[{\"id\":\"string\",\"type\":\"\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}]}},\"meta\":{\"temp_id\":\"string\"}}}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  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\":\"string\",\"type\":\"administrations\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"guest_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"channel_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"excluded_costs\":{\"data\":[{\"id\":\"string\",\"type\":\"\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}]}},\"meta\":{\"temp_id\":\"string\"}}}",
  CURLOPT_HTTPHEADER => array(
    "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;
}

var 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\":\"string\",\"type\":\"administrations\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"guest_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"channel_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"excluded_costs\":{\"data\":[{\"id\":\"string\",\"type\":\"\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}]}},\"meta\":{\"temp_id\":\"string\"}}}";

var 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": "string",
          "type": "administrations",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "excluded_costs": {
        "data": [
          {
            "id": "string",
            "type": "",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      }
    },
    "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:

Extras
Costs
Availability
Rent prices
Invoicing

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,
      "created_at": "2021-07-27T18:52:56Z",
      "updated_at": "2021-07-27T18:52:56Z"
    },
    "relationships": {
      "administration": {
        "data": {
          "id": "string",
          "type": "administrations",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "excluded_costs": {
        "data": [
          {
            "id": "string",
            "type": "",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      }
    },
    "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	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.
——— 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, array(
  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 => array(
    "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;
}

var data = null;

var 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,
      "created_at": "2021-07-27T18:52:56Z",
      "updated_at": "2021-07-27T18:52:56Z"
    },
    "relationships": {
      "administration": {
        "data": {
          "id": "string",
          "type": "administrations",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "excluded_costs": {
        "data": [
          {
            "id": "string",
            "type": "",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      }
    },
    "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	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.
——— 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":"string","type":"administrations","meta":{"temp_id":"string","method":"string"}}},"guest_payment_policy":{"data":{"id":"string","type":"payment_policy","meta":{"temp_id":"string","method":"string"}}},"channel_payment_policy":{"data":{"id":"string","type":"payment_policy","meta":{"temp_id":"string","method":"string"}}},"excluded_costs":{"data":[{"id":"string","type":"","meta":{"temp_id":"string","method":"string"}}]}},"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\":\"string\",\"type\":\"administrations\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"guest_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"channel_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"excluded_costs\":{\"data\":[{\"id\":\"string\",\"type\":\"\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}]}},\"meta\":{\"temp_id\":\"string\"}}}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  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\":\"string\",\"type\":\"administrations\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"guest_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"channel_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"excluded_costs\":{\"data\":[{\"id\":\"string\",\"type\":\"\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}]}},\"meta\":{\"temp_id\":\"string\"}}}",
  CURLOPT_HTTPHEADER => array(
    "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;
}

var 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\":\"string\",\"type\":\"administrations\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"guest_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"channel_payment_policy\":{\"data\":{\"id\":\"string\",\"type\":\"payment_policy\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}},\"excluded_costs\":{\"data\":[{\"id\":\"string\",\"type\":\"\",\"meta\":{\"temp_id\":\"string\",\"method\":\"string\"}}]}},\"meta\":{\"temp_id\":\"string\"}}}";

var 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": "string",
          "type": "administrations",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "excluded_costs": {
        "data": [
          {
            "id": "string",
            "type": "",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      }
    },
    "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:

Extras
Costs
Availability
Rent prices
Invoicing

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,
      "created_at": "2021-07-27T18:52:56Z",
      "updated_at": "2021-07-27T18:52:56Z"
    },
    "relationships": {
      "administration": {
        "data": {
          "id": "string",
          "type": "administrations",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "guest_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "channel_payment_policy": {
        "data": {
          "id": "string",
          "type": "payment_policy",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "excluded_costs": {
        "data": [
          {
            "id": "string",
            "type": "",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      }
    },
    "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	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.
——— 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, array(
  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 => array(
    "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;
}

var data = null;

var 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, array(
  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 => array(
    "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;
}

var data = null;

var 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
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[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": "2021-07-27T18:52:56Z",
        "updated_at": "2021-07-27T18:52:56Z"
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "payment_handlers": {
          "data": [
            {
              "id": "string",
              "type": "payment_handler",
              "meta": {
                "temp_id": "string",
                "method": "string"
              }
            }
          ]
        }
      },
      "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]	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, array(
  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 => array(
    "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;
}

var data = null;

var 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
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[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": "2021-07-27T18:52:56Z",
      "updated_at": "2021-07-27T18:52:56Z"
    },
    "links": {
      "self": "string"
    },
    "relationships": {
      "payment_handlers": {
        "data": [
          {
            "id": "string",
            "type": "payment_handler",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      }
    },
    "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	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, array(
  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 => array(
    "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;
}

var data = null;

var 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[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": "2021-07-27",
        "end_date": "2021-07-27"
      },
      "relationships": {
        "rentable": {
          "data": {
            "id": "string",
            "type": "rentable",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        },
        "reservation": {
          "data": {
            "id": "string",
            "type": "reservation",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        }
      },
      "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]	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
—— 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

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, array(
  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 => array(
    "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;
}

var data = null;

var 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'.
include_rentable_type_counts	query	boolean	false	true	When true, the amount of results per rentable type will be added to the metadata
include_tag_counts	query	boolean	false	true	When true, the amount of results per tag 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[tag_ids]	query	string	false	string	Filter on tags. 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[tag_ids_match_score][desc]	query	boolean	false	true	Boolean specifying the sort direction for the `tag_ids_match_score` sorter. When unspecified, ascending order is implied.
sorter[tag_ids_match_score][tag_ids]	query	string	false	1,2	Tag IDs for the `tag_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:

los Order by length of stay
los_distance Order by the distance of a particular length of stay
start_date Order by start dates
start_date_distance Order by the distance of a particular start date
arrangement_distance Order by the distance of a particular arrangement
max_guests Order by maximum guests of the category
highlighted Order by availabilities that have a category that is highlighted
all_in_amount Order by price
tag_ids_match_score Order by whether the tags match
avg_score Order by average review score of the category

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:

availabilities Return limit availabilities
start_dates Limit to the limit best arrival dates
categories Limit to the limit best categories
administrations Limit to the limit best administrations

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": "2021-07-27",
      "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": "string",
          "type": "administration",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "category": {
        "data": {
          "id": "string",
          "type": "category",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "discount_campaign": {
        "data": {
          "id": "string",
          "type": "discount_campaign",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "missing_tags": {
        "data": [
          {
            "id": "string",
            "type": "tag",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      },
      "available_rentables": {
        "data": [
          {
            "id": "string",
            "type": "rentable",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      }
    },
    "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	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(time)	false	none	none
——— checkout_time	string(time)	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_tags	object	false	none	none
———— data	[object]	false	none	none
————— id	string	false	none	missing_tags 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

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, array(
  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 => array(
    "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;
}

var data = null;

var 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[type]	query	string	false	string	Filter on type
filter[archived]	query	string	false	string	Filter on archived
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[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[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[last_date_with_price]	query	string	false	string	Filter on last_date_with_price
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[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_subtype]	query	string	false	string	Filter on accommodation_subtype. 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[custom_attributes]	query	string	false	string	Filter on custom_attributes. Specify a comma separated list of IDs to filter on.
filter[tags]	query	string	false	string	Filter on tags. 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",
        "archived": true,
        "highlighted": true,
        "reference": "string",
        "rentable_type": "string",
        "maximum_number_of_nights": 0,
        "minimum_number_of_nights": 0,
        "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": "2021-07-27T18:52:56Z",
        "prices_indexed_at": "2021-07-27T18:52:56Z",
        "stock_updated_at": "2021-07-27T18:52:56Z",
        "stock_indexed_at": "2021-07-27T18:52:56Z",
        "costs_updated_at": "2021-07-27T18:52:56Z",
        "extras_updated_at": "2021-07-27T18:52:56Z",
        "bookable_discounts_changed_at": "2021-07-27T18:52:56Z",
        "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,
        "max_baby_age": 0,
        "max_child_age": 0,
        "max_adolescent_age": 0,
        "min_senior_age": 0,
        "pets_allowed": true,
        "host_image_url": "string",
        "same_day_bookings_allowed": true,
        "same_day_booking_closing_time": "string",
        "last_date_with_price": "2021-07-27",
        "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,
        "summer_video_id": "string",
        "winter_video_id": "string",
        "whole_year_video_id": "string",
        "checkin_times_for_week": [
          "string"
        ],
        "checkout_times_for_week": [
          "string"
        ],
        "created_at": "string",
        "updated_at": "string"
      },
      "relationships": {
        "administration": {
          "data": {
            "id": "string",
            "type": "administrations",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        },
        "city": {
          "data": {
            "id": "string",
            "type": "city",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        },
        "terms": {
          "data": {
            "id": "string",
            "type": "terms",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        },
        "accommodation_subtype": {
          "data": {
            "id": "string",
            "type": "accommodation_subtype",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        },
        "images": {
          "data": [
            {
              "id": "string",
              "type": "image",
              "meta": {
                "temp_id": "string",
                "method": "string"
              }
            }
          ]
        },
        "guest_group_limits": {
          "data": [
            {
              "id": "string",
              "type": "guest_group_limit",
              "meta": {
                "temp_id": "string",
                "method": "string"
              }
            }
          ]
        },
        "rooms": {
          "data": [
            {
              "id": "string",
              "type": "room",
              "meta": {
                "temp_id": "string",
                "method": "string"
              }
            }
          ]
        },
        "custom_attributes": {
          "data": [
            {
              "id": "string",
              "type": "custom_attribute",
              "meta": {
                "temp_id": "string",
                "method": "string"
              }
            }
          ]
        },
        "tags": {
          "data": [
            {
              "id": "string",
              "type": "tag",
              "meta": {
                "temp_id": "string",
                "method": "string"
              }
            }
          ]
        },
        "optional_tags": {
          "data": [
            {
              "id": "string",
              "type": "tag",
              "meta": {
                "temp_id": "string",
                "method": "string"
              }
            }
          ]
        }
      },
      "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]	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
——— archived	boolean	false	none	none
——— highlighted	boolean	false	none	Whether this category should be highlighted on the website
——— reference	string	false	none	none
——— rentable_type	string	false	none	none
——— maximum_number_of_nights	integer	false	none	none
——— minimum_number_of_nights	integer	false	none	none
——— max_number_of_people	integer	false	none	none
——— max_number_of_seniors	integer	false	none	none
——— max_number_of_adults	integer	false	none	none
——— max_number_of_adolescents	integer	false	none	none
——— max_number_of_children	integer	false	none	none
——— max_number_of_babies	integer	false	none	none
——— max_number_of_pets	integer	false	none	none
——— prices_updated_at	string(date-time)	false	none	Timestamp when the prices of this category were last updated
——— prices_indexed_at	string(date-time)	false	none	Timestamp when the prices of this category were last indexed for availability search
——— stock_updated_at	string(date-time)	false	none	Timestamp when the stock of this category was last updated
——— stock_indexed_at	string(date-time)	false	none	Timestamp when the stock of this category was last indexed for availability search
——— costs_updated_at	string(date-time)	false	none	Timestamp when the costs of this category were last updated
——— extras_updated_at	string(date-time)	false	none	Timestamp when the extras of this category were last updated
——— bookable_discounts_changed_at	string(date-time)	false	none	Timestamp when the bookable discounts of this category were last updated
——— 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
——— max_baby_age	integer	false	none	none
——— max_child_age	integer	false	none	none
——— max_adolescent_age	integer	false	none	none
——— min_senior_age	integer	false	none	none
——— pets_allowed	boolean	false	none	none
——— host_image_url	string	false	none	none
——— same_day_bookings_allowed	boolean	false	none	none
——— same_day_booking_closing_time	string(time)	false	none	none
——— last_date_with_price	string(date)	false	none	none
——— address	string	false	none	none
——— postal_code	string	false	none	none
——— city	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
——— region	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
——— country_code	string	false	none	none
——— latitude	number(float)	false	none	none
——— longitude	number(float)	false	none	none
——— location_is_exact	boolean	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
——— checkin_times_for_week	[string]	false	none	none
——— checkout_times_for_week	[string]	false	none	none
——— created_at	string	false	read-only	none
——— updated_at	string	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.
——— 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_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.
——— 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.
——— custom_attributes	object	false	none	none
———— data	[object]	false	none	none
————— id	string	false	none	custom_attributes 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.
——— tags	object	false	none	none
———— data	[object]	false	none	none
————— id	string	false	none	tags 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_tags	object	false	none	none
———— data	[object]	false	none	none
————— id	string	false	none	optional_tags 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

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, array(
  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 => array(
    "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;
}

var data = null;

var 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[type]	query	string	false	string	Filter on type
filter[archived]	query	string	false	string	Filter on archived
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[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[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[last_date_with_price]	query	string	false	string	Filter on last_date_with_price
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[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_subtype]	query	string	false	string	Filter on accommodation_subtype. 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[custom_attributes]	query	string	false	string	Filter on custom_attributes. Specify a comma separated list of IDs to filter on.
filter[tags]	query	string	false	string	Filter on tags. 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",
      "archived": true,
      "highlighted": true,
      "reference": "string",
      "rentable_type": "string",
      "maximum_number_of_nights": 0,
      "minimum_number_of_nights": 0,
      "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": "2021-07-27T18:52:56Z",
      "prices_indexed_at": "2021-07-27T18:52:56Z",
      "stock_updated_at": "2021-07-27T18:52:56Z",
      "stock_indexed_at": "2021-07-27T18:52:56Z",
      "costs_updated_at": "2021-07-27T18:52:56Z",
      "extras_updated_at": "2021-07-27T18:52:56Z",
      "bookable_discounts_changed_at": "2021-07-27T18:52:56Z",
      "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,
      "max_baby_age": 0,
      "max_child_age": 0,
      "max_adolescent_age": 0,
      "min_senior_age": 0,
      "pets_allowed": true,
      "host_image_url": "string",
      "same_day_bookings_allowed": true,
      "same_day_booking_closing_time": "string",
      "last_date_with_price": "2021-07-27",
      "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,
      "summer_video_id": "string",
      "winter_video_id": "string",
      "whole_year_video_id": "string",
      "checkin_times_for_week": [
        "string"
      ],
      "checkout_times_for_week": [
        "string"
      ],
      "created_at": "string",
      "updated_at": "string"
    },
    "relationships": {
      "administration": {
        "data": {
          "id": "string",
          "type": "administrations",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "city": {
        "data": {
          "id": "string",
          "type": "city",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "terms": {
        "data": {
          "id": "string",
          "type": "terms",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "accommodation_subtype": {
        "data": {
          "id": "string",
          "type": "accommodation_subtype",
          "meta": {
            "temp_id": "string",
            "method": "string"
          }
        }
      },
      "images": {
        "data": [
          {
            "id": "string",
            "type": "image",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      },
      "guest_group_limits": {
        "data": [
          {
            "id": "string",
            "type": "guest_group_limit",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      },
      "rooms": {
        "data": [
          {
            "id": "string",
            "type": "room",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      },
      "custom_attributes": {
        "data": [
          {
            "id": "string",
            "type": "custom_attribute",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      },
      "tags": {
        "data": [
          {
            "id": "string",
            "type": "tag",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      },
      "optional_tags": {
        "data": [
          {
            "id": "string",
            "type": "tag",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        ]
      }
    },
    "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	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
——— archived	boolean	false	none	none
——— highlighted	boolean	false	none	Whether this category should be highlighted on the website
——— reference	string	false	none	none
——— rentable_type	string	false	none	none
——— maximum_number_of_nights	integer	false	none	none
——— minimum_number_of_nights	integer	false	none	none
——— max_number_of_people	integer	false	none	none
——— max_number_of_seniors	integer	false	none	none
——— max_number_of_adults	integer	false	none	none
——— max_number_of_adolescents	integer	false	none	none
——— max_number_of_children	integer	false	none	none
——— max_number_of_babies	integer	false	none	none
——— max_number_of_pets	integer	false	none	none
——— prices_updated_at	string(date-time)	false	none	Timestamp when the prices of this category were last updated
——— prices_indexed_at	string(date-time)	false	none	Timestamp when the prices of this category were last indexed for availability search
——— stock_updated_at	string(date-time)	false	none	Timestamp when the stock of this category was last updated
——— stock_indexed_at	string(date-time)	false	none	Timestamp when the stock of this category was last indexed for availability search
——— costs_updated_at	string(date-time)	false	none	Timestamp when the costs of this category were last updated
——— extras_updated_at	string(date-time)	false	none	Timestamp when the extras of this category were last updated
——— bookable_discounts_changed_at	string(date-time)	false	none	Timestamp when the bookable discounts of this category were last updated
——— 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
——— max_baby_age	integer	false	none	none
——— max_child_age	integer	false	none	none
——— max_adolescent_age	integer	false	none	none
——— min_senior_age	integer	false	none	none
——— pets_allowed	boolean	false	none	none
——— host_image_url	string	false	none	none
——— same_day_bookings_allowed	boolean	false	none	none
——— same_day_booking_closing_time	string(time)	false	none	none
——— last_date_with_price	string(date)	false	none	none
——— address	string	false	none	none
——— postal_code	string	false	none	none
——— city	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
——— region	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
——— country_code	string	false	none	none
——— latitude	number(float)	false	none	none
——— longitude	number(float)	false	none	none
——— location_is_exact	boolean	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
——— checkin_times_for_week	[string]	false	none	none
——— checkout_times_for_week	[string]	false	none	none
——— created_at	string	false	read-only	none
——— updated_at	string	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.
——— 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_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.
——— 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.
——— custom_attributes	object	false	none	none
———— data	[object]	false	none	none
————— id	string	false	none	custom_attributes 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.
——— tags	object	false	none	none
———— data	[object]	false	none	none
————— id	string	false	none	tags 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_tags	object	false	none	none
———— data	[object]	false	none	none
————— id	string	false	none	optional_tags 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

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 Category Availability

GET category availability

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/categories/1/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/channels/1/categories/1/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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/categories/1/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 => array(
    "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;
}

var data = null;

var 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/1/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/channels/{channel_id}/categories/{category_id}/availabilities

List availability of a category you have access to

Parameters

Name	In	Type	Required	Example	Description
category_id	path	string	true	1	Category ID
channel_id	path	string	true	1	Channel ID
fields[category_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'.
date_range	query	string	false	2010-01-01..2040-01-01	Yield availability for the given date range. Will be capped to 2 years in the future. Max LOS is capped to 30.

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "category_availability",
      "attributes": {
        "date": "2014-01-01",
        "stock": 10,
        "capacity": 10,
        "min_length_of_stay": 1,
        "max_length_of_stay": 30,
        "closed_to_departure": true,
        "closed_to_arrival": false
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ]
}

Responses

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	[CategoryAvailability]	false	none	[Defines the availability of a Category on a given date.]
—— id	string	false	none	ID
—— type	string	false	none	Type
—— attributes	object	false	none	Attributes
——— date	string(date)	false	none	none
——— stock	integer	false	none	none
——— capacity	integer	false	none	none
——— min_length_of_stay	integer	false	none	none
——— max_length_of_stay	integer	false	none	none
——— closed_to_departure	boolean	false	none	none
——— closed_to_arrival	boolean	false	none	none
—— 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

Channel Category Costs

GET costs

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/categories/1/costs \
  --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/1/costs")

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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/categories/1/costs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "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;
}

var data = null;

var 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/1/costs");
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/{category_id}/costs

Returns the costs that are available to a category you have access to.

Parameters

Name	In	Type	Required	Example	Description
category_id	path	string	true	1	Category ID
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[cost]	query	string	false	string	Fieldset. Specify a comma separated list of attributes to return
filter[id]	query	string	false	string	Filter on ID
filter[counts_seniors]	query	string	false	string	Filter on counts_seniors
filter[counts_adults]	query	string	false	string	Filter on counts_adults
filter[counts_adolescents]	query	string	false	string	Filter on counts_adolescents
filter[counts_children]	query	string	false	string	Filter on counts_children
filter[counts_babies]	query	string	false	string	Filter on counts_babies
filter[counts_pets]	query	string	false	string	Filter on counts_pets
filter[counts_from]	query	string	false	string	Filter on counts_from
filter[counts_till]	query	string	false	string	Filter on counts_till
filter[administration]	query	string	false	string	Filter on administration. 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": "cost",
      "attributes": {
        "is_excluded": true,
        "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"
        },
        "invoiced_as": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "calculation": "per_person",
        "is_percentage": "string",
        "is_hidden": true,
        "is_rent": true,
        "cost_type": "string",
        "maximum_quantity": 0,
        "counts_seniors": true,
        "counts_adults": true,
        "counts_adolescents": true,
        "counts_children": true,
        "counts_babies": true,
        "counts_pets": true,
        "counts_from": 0,
        "counts_till": 0,
        "vat_rate": 0,
        "if_stay_starts_in": "string",
        "prices": [
          {
            "date": "2021-07-27",
            "price": {
              "currency": "string",
              "value": "string"
            },
            "price_without_vat": {
              "currency": "string",
              "value": "string"
            }
          }
        ],
        "percentages": [
          {
            "date": "2021-07-27",
            "percentage": 0,
            "percentage_without_vat": 0
          }
        ]
      },
      "relationships": {
        "administration": {
          "data": {
            "id": "string",
            "type": "administrations",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	[Cost]	false	none	[A cost is a surcharge that may apply to a certain Reservation.]
—— id	string	false	none	ID
—— type	string	false	none	Type
—— attributes	object	false	none	Attributes
——— is_excluded	boolean	false	none	Whether this cost should be excluded from synchronization or not.
——— 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
——— invoiced_as	object	false	none	Translated name under which this cost is invoiced
———— 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
——— calculation	string	false	none	none
——— is_percentage	string	false	none	none
——— is_hidden	boolean	false	none	none
——— is_rent	boolean	false	none	none
——— cost_type	string	false	none	none
——— maximum_quantity	integer	false	none	Maximum amount per reservation, will be blank when unlimited
——— counts_seniors	boolean	false	none	none
——— counts_adults	boolean	false	none	none
——— counts_adolescents	boolean	false	none	none
——— counts_children	boolean	false	none	none
——— counts_babies	boolean	false	none	none
——— counts_pets	boolean	false	none	none
——— counts_from	integer	false	none	none
——— counts_till	integer	false	none	none
——— vat_rate	number(float)	false	none	none
——— if_stay_starts_in	string	false	none	none
——— prices	[object]	false	none	none
———— date	string(date)	false	none	none
———— price	object	false	none	none
————— currency	string	false	none	none
————— value	string	false	none	none
———— price_without_vat	object	false	none	none
————— currency	string	false	none	none
————— value	string	false	none	none
——— percentages	[object]	false	none	none
———— date	string(date)	false	none	none
———— percentage	number(float)	false	none	none
———— percentage_without_vat	number(float)	false	none	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.
—— 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
calculation	per_person
calculation	per_person_per_day
calculation	per_pet
calculation	per_pet_per_day
calculation	fixed
calculation	per_day
calculation	per_piece
calculation	per_piece_per_day
calculation	percentage_over_default_costs
calculation	percentage_over_total
calculation	percentage_over_default_rent
calculation	percentage_over_rent

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 Category Extras

GET extras

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/categories/1/extras \
  --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/1/extras")

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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/categories/1/extras",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "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;
}

var data = null;

var 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/1/extras");
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/{category_id}/extras

Returns the extras that are available to a category you have access to.

Parameters

Name	In	Type	Required	Example	Description
category_id	path	string	true	1	Category ID
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[extra]	query	string	false	string	Fieldset. Specify a comma separated list of attributes to return
filter[id]	query	string	false	string	Filter on ID
filter[selectable]	query	string	false	string	Filter on selectable
filter[available_for_customer]	query	string	false	string	Filter on available_for_customer
filter[confirm_by_guest]	query	string	false	string	Filter on confirm_by_guest
filter[extra_type]	query	string	false	string	Filter on extra_type
filter[counts_seniors]	query	string	false	string	Filter on counts_seniors
filter[counts_adults]	query	string	false	string	Filter on counts_adults
filter[counts_adolescents]	query	string	false	string	Filter on counts_adolescents
filter[counts_children]	query	string	false	string	Filter on counts_children
filter[counts_babies]	query	string	false	string	Filter on counts_babies
filter[counts_pets]	query	string	false	string	Filter on counts_pets
filter[counts_from]	query	string	false	string	Filter on counts_from
filter[counts_till]	query	string	false	string	Filter on counts_till
filter[administration]	query	string	false	string	Filter on administration. 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": "extra",
      "attributes": {
        "is_excluded": true,
        "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"
        },
        "question_for_guest": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "invoiced_as": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "selectable": "string",
        "available_for_customer": "always",
        "calculation": "per_person",
        "is_percentage": "string",
        "is_hidden": true,
        "is_rent": true,
        "confirm_by_guest": true,
        "extra_type": "other",
        "quantity_required": true,
        "guest_answer_required": true,
        "maximum_quantity": 0,
        "counts_seniors": true,
        "counts_adults": true,
        "counts_adolescents": true,
        "counts_children": true,
        "counts_babies": true,
        "counts_pets": true,
        "counts_from": 0,
        "counts_till": 0,
        "vat_rate": 0,
        "price": {
          "currency": "string",
          "value": "string"
        },
        "require_stay_overlaps": "string",
        "prices": [
          {
            "date": "2021-07-27",
            "price": {
              "currency": "string",
              "value": "string"
            },
            "price_without_vat": {
              "currency": "string",
              "value": "string"
            }
          }
        ],
        "percentages": [
          {
            "date": "2021-07-27",
            "percentage": 0,
            "percentage_without_vat": 0
          }
        ]
      },
      "relationships": {
        "administration": {
          "data": {
            "id": "string",
            "type": "administrations",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	[Extra]	false	none	[An Extra is an option that can be added to a reservation, for example a child chair, tickets etc. They can have prices that change over time. Will yield a price when returned within the context of a Reservation. ]
—— id	string	false	none	ID
—— type	string	false	none	Type
—— attributes	object	false	none	Attributes
——— is_excluded	boolean	false	none	Whether this extra is excluded from synchronization.
——— 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
——— question_for_guest	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
——— invoiced_as	object	false	none	Translated name under which this extra is invoiced
———— 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
——— selectable	string	false	none	One of: important, customer, backoffice. Important extras are opt-out extras while customer extras are opt-in extras.
——— available_for_customer	string	false	none	none
——— calculation	string	false	none	none
——— is_percentage	string	false	none	none
——— is_hidden	boolean	false	none	none
——— is_rent	boolean	false	none	none
——— confirm_by_guest	boolean	false	none	When set, guests should explicitly confirm the terms mentioned in the description
——— extra_type	string	false	none	none
——— quantity_required	boolean	false	none	none
——— guest_answer_required	boolean	false	none	none
——— maximum_quantity	integer	false	none	Maximum amount per reservation, will be blank when unlimited
——— counts_seniors	boolean	false	none	none
——— counts_adults	boolean	false	none	none
——— counts_adolescents	boolean	false	none	none
——— counts_children	boolean	false	none	none
——— counts_babies	boolean	false	none	none
——— counts_pets	boolean	false	none	none
——— counts_from	integer	false	none	none
——— counts_till	integer	false	none	none
——— vat_rate	number(float)	false	none	none
——— price	object	false	none	When returned as an include of the reservation#available_extras relationship, this will yield the (unit) price of the extra
———— currency	string	false	none	none
———— value	string	false	none	none
——— require_stay_overlaps	string	false	none	none
——— prices	[object]	false	none	none
———— date	string(date)	false	none	none
———— price	object	false	none	none
————— currency	string	false	none	none
————— value	string	false	none	none
———— price_without_vat	object	false	none	none
————— currency	string	false	none	none
————— value	string	false	none	none
——— percentages	[object]	false	none	none
———— date	string(date)	false	none	none
———— percentage	number(float)	false	none	none
———— percentage_without_vat	number(float)	false	none	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.
—— 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
available_for_customer	always
available_for_customer	during_booking
available_for_customer	during_upgrade
calculation	per_person
calculation	per_person_per_day
calculation	per_pet
calculation	per_pet_per_day
calculation	fixed
calculation	per_day
calculation	per_piece
calculation	per_piece_per_day
calculation	percentage_over_default_costs
calculation	percentage_over_total
calculation	percentage_over_default_rent
calculation	percentage_over_rent
extra_type	other
extra_type	tourist_taxes
extra_type	environmental_charges
extra_type	energy
extra_type	deposit
extra_type	bath_linen
extra_type	bed_linen
extra_type	cleaning
extra_type	childs_bed
extra_type	childs_chair
extra_type	sauna
extra_type	pets
extra_type	preference_costs
extra_type	provision
extra_type	cancellation_insurance
extra_type	parking
extra_type	early_checkin
extra_type	late_checkout
extra_type	food
extra_type	labour
extra_type	heating
extra_type	internet
extra_type	gas
extra_type	water
extra_type	drinking_water
extra_type	electricity
extra_type	wood
extra_type	toiletries
extra_type	transportation
extra_type	laundry
extra_type	additional_bed
extra_type	airco

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 Category LOS Prices

GET LOS prices

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/categories/1/los_prices \
  --header 'accept: application/vnd.api+json' \
  --header 'accept-language: en,nl' \
  --header 'if-modified-since: Wed, 01 Jan 2014 11:00:02 GMT' \
  --header 'x-api-key: API_KEY'

require 'uri'
require 'net/http'
require 'openssl'

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

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["if-modified-since"] = 'Wed, 01 Jan 2014 11:00:02 GMT'
request["x-api-key"] = 'API_KEY'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/categories/1/los_prices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/vnd.api+json",
    "accept-language: en,nl",
    "if-modified-since: Wed, 01 Jan 2014 11:00:02 GMT",
    "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;
}

var data = null;

var 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/1/los_prices");
xhr.setRequestHeader("accept", "application/vnd.api+json");
xhr.setRequestHeader("accept-language", "en,nl");
xhr.setRequestHeader("if-modified-since", "Wed, 01 Jan 2014 11:00:02 GMT");
xhr.setRequestHeader("x-api-key", "API_KEY");

xhr.send(data);

GET /v3/channels/{channel_id}/categories/{category_id}/los_prices

List LOS prices of a category you have access to.

Parameters

Name	In	Type	Required	Example	Description
category_id	path	string	true	1	Category ID
channel_id	path	string	true	1	Channel ID
page[number]	query	string	false	string	Page number
page[size]	query	string	false	string	Page size
fields[los_price]	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'.
If-Modified-Since	header	string	false	Wed, 01 Jan 2014 11:00:02 GMT	The API will send back the requested resource, with a 200 status, only if it has been last modified after the given datetime. If the request has not been modified since, the response will be a 304 without any body. The Last-Modified response header of a previous request will contain the date of last modification.
date_range	query	string	false	2010-01-01..2040-01-01	Yield LOS prices for the given date range. Will be capped to 2 years in the future.
currency	query	string	false	EUR	Set a custom currency for price calculation
max_los	query	string	false	21	Specify the max LOS to return.
guest_group[seniors]	query	integer	false	0	Sets the number of seniors for price calculation.
guest_group[adults]	query	integer	false	2	Sets the number of adults for price calculation.
guest_group[adolescents]	query	integer	false	0	Sets the number of adolescents for price calculation.
guest_group[children]	query	integer	false	0	Sets the number of children for price calculation.
guest_group[babies]	query	integer	false	0	Sets the number of babies for price calculation.
guest_group[pets]	query	integer	false	0	Sets the number of pets for price calculation.

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "los_price",
      "attributes": {
        "arrival_date": "2014-01-01",
        "length_of_stay": 7,
        "vat_rate": 25,
        "rent_price": {
          "currency": "EUR",
          "value": "15.00"
        },
        "rent_price_without_vat": {
          "currency": "EUR",
          "value": "12.00"
        },
        "price": {
          "currency": "EUR",
          "value": "10.00"
        },
        "price_without_vat": {
          "currency": "EUR",
          "value": "8.00"
        },
        "all_in_price": {
          "currency": "EUR",
          "value": "10.00"
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	LosPriceCollectionResponse	Inline
304	Not Modified	Not modified	None
default	Default	Error	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	[LosPrice]	false	none	[Yields the price for a given arrival date and length of stay (LOS).]
—— id	string	false	none	ID
—— type	string	false	none	Type
—— attributes	object	false	none	Attributes
——— arrival_date	string(date)	false	none	none
——— length_of_stay	integer	false	none	none
——— vat_rate	number(float)	false	none	none
——— rent_price	object	false	none	The rent price without discount subtraction
———— currency	string	false	none	none
———— value	string	false	none	none
——— rent_price_without_vat	object	false	none	The rent price without discount subtraction and without VAT
———— currency	string	false	none	none
———— value	string	false	none	none
——— price	object	false	none	Rent price subtracted with discount (if any)
———— currency	string	false	none	none
———— value	string	false	none	none
——— price_without_vat	object	false	none	Rent price subtracted with discount (if any) and without VAT
———— currency	string	false	none	none
———— value	string	false	none	none
——— all_in_price	object	false	none	All in price. Includes rent price, discounts and non-optional costs. For performance reasons, this field will only be included when explicitly defined in a sparse fieldset.
———— currency	string	false	none	none
———— value	string	false	none	none
—— 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

Channel Category Night Prices

GET night prices

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/categories/1/night_prices \
  --header 'accept: application/vnd.api+json' \
  --header 'accept-language: en,nl' \
  --header 'if-modified-since: Wed, 01 Jan 2014 11:00:02 GMT' \
  --header 'x-api-key: API_KEY'

require 'uri'
require 'net/http'
require 'openssl'

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

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["if-modified-since"] = 'Wed, 01 Jan 2014 11:00:02 GMT'
request["x-api-key"] = 'API_KEY'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/categories/1/night_prices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/vnd.api+json",
    "accept-language: en,nl",
    "if-modified-since: Wed, 01 Jan 2014 11:00:02 GMT",
    "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;
}

var data = null;

var 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/1/night_prices");
xhr.setRequestHeader("accept", "application/vnd.api+json");
xhr.setRequestHeader("accept-language", "en,nl");
xhr.setRequestHeader("if-modified-since", "Wed, 01 Jan 2014 11:00:02 GMT");
xhr.setRequestHeader("x-api-key", "API_KEY");

xhr.send(data);

GET /v3/channels/{channel_id}/categories/{category_id}/night_prices

List night prices of a category you have access to.

Parameters

Name	In	Type	Required	Example	Description
category_id	path	string	true	1	Category ID
channel_id	path	string	true	1	Channel ID
fields[night_price]	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'.
If-Modified-Since	header	string	false	Wed, 01 Jan 2014 11:00:02 GMT	The API will send back the requested resource, with a 200 status, only if it has been last modified after the given datetime. If the request has not been modified since, the response will be a 304 without any body. The Last-Modified response header of a previous request will contain the date of last modification.
date_range	query	string	false	2010-01-01..2040-01-01	Yield night prices for the given date range. Will be capped to 2 years in the future.

Example responses

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "night_price",
      "attributes": {
        "date": "2014-01-01",
        "stock": 10,
        "price": {
          "currency": "EUR",
          "value": "10.00"
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	NightPriceCollectionResponse	Inline
304	Not Modified	Not modified	None
default	Default	Error	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	[NightPrice]	false	none	[Yields the night price for a given date.]
—— id	string	false	none	ID
—— type	string	false	none	Type
—— attributes	object	false	none	Attributes
——— date	string(date)	false	none	none
~~——— stock~~	integer	false	none	Returns stock for the given date
——— price	object	false	none	none
———— currency	string	false	none	none
———— value	string	false	none	none
—— 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

Channel Discount Cards

List discount cards available for the channels that are linked to your subscription

GET discount cards

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/discount_cards \
  --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/discount_cards")

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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/discount_cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "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;
}

var data = null;

var 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/discount_cards");
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}/discount_cards

Returns the discount cards 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[discount_card]	query	string	false	string	Fieldset. Specify a comma separated list of attributes to return
filter[id]	query	string	false	string	Filter on 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

200 Response

{
  "data": [
    {
      "id": "1",
      "type": "discount_card",
      "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"
        },
        "logo": {
          "original": "string",
          "banner": "string",
          "thumb": "string"
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	[DiscountCard]	false	none	[Discount cards (for example the ASCI camping card) implicitly represent a package, usually with a custom price per night or a discount depending on the time of stay. ]
—— 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
——— logo	object	false	none	none
———— original	string	false	none	none
———— banner	string	false	none	none
———— thumb	string	false	none	none
—— 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 discount card

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/discount_cards/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/discount_cards/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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/discount_cards/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 => array(
    "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;
}

var data = null;

var 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/discount_cards/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}/discount_cards/{id}

Returns the discount card 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[discount_card]	query	string	false	string	Fieldset. Specify a comma separated list of attributes to return
filter[id]	query	string	false	string	Filter on 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

200 Response

{
  "data": {
    "id": "1",
    "type": "discount_card",
    "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"
      },
      "logo": {
        "original": "string",
        "banner": "string",
        "thumb": "string"
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	DiscountCard	false	none	Discount cards (for example the ASCI camping card) implicitly represent a package, usually with a custom price per night or a discount depending on the time of stay.
—— 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
——— logo	object	false	none	none
———— original	string	false	none	none
———— banner	string	false	none	none
———— thumb	string	false	none	none
—— 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

Channel Extra Packages

List extra packages available for the channels that are linked to your subscription

GET extra packages

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/extra_packages \
  --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/extra_packages")

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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/extra_packages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "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;
}

var data = null;

var 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/extra_packages");
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}/extra_packages

Returns the extra packages 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[extra_package]	query	string	false	string	Fieldset. Specify a comma separated list of attributes to return
filter[id]	query	string	false	string	Filter on ID
filter[confirm_by_guest]	query	string	false	string	Filter on confirm_by_guest
filter[available_as_upgrade]	query	string	false	string	Filter on available_as_upgrade
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": "extra_package",
      "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"
        },
        "confirm_by_guest": true,
        "available_as_upgrade": true,
        "price": {
          "currency": "string",
          "value": "string"
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	[ExtraPackage]	false	none	[An ExtraPackage is a Package that can be user selected. They can have prices that change over time. Will yield a price when returned within the context of a Reservation. ]
—— 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
——— confirm_by_guest	boolean	false	none	When set, guests should explicitly confirm the terms mentioned in the description
——— available_as_upgrade	boolean	false	none	When set, indicates that the packages is available as an upgrade after booking
——— price	object	false	none	When returned as an include of the reservation#available_extras relationship, this will yield the (unit) price of the extra package
———— currency	string	false	none	none
———— value	string	false	none	none
—— 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 extra package

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/extra_packages/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/extra_packages/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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/extra_packages/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 => array(
    "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;
}

var data = null;

var 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/extra_packages/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}/extra_packages/{id}

Returns the extra package 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[extra_package]	query	string	false	string	Fieldset. Specify a comma separated list of attributes to return
filter[id]	query	string	false	string	Filter on ID
filter[confirm_by_guest]	query	string	false	string	Filter on confirm_by_guest
filter[available_as_upgrade]	query	string	false	string	Filter on available_as_upgrade
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": "extra_package",
    "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"
      },
      "confirm_by_guest": true,
      "available_as_upgrade": true,
      "price": {
        "currency": "string",
        "value": "string"
      }
    },
    "meta": {
      "temp_id": "string"
    }
  }
}

Responses

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	ExtraPackage	false	none	An ExtraPackage is a Package that can be user selected. They can have prices that change over time. Will yield a price when returned within the context of a Reservation.
—— 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
——— confirm_by_guest	boolean	false	none	When set, guests should explicitly confirm the terms mentioned in the description
——— available_as_upgrade	boolean	false	none	When set, indicates that the packages is available as an upgrade after booking
——— price	object	false	none	When returned as an include of the reservation#available_extras relationship, this will yield the (unit) price of the extra package
———— currency	string	false	none	none
———— value	string	false	none	none
—— 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

Channel Extras

List extras available for the channels that are linked to your subscription

GET extras

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/extras \
  --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/extras")

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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/extras",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "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;
}

var data = null;

var 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/extras");
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}/extras

Returns the extras 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[extra]	query	string	false	string	Fieldset. Specify a comma separated list of attributes to return
filter[id]	query	string	false	string	Filter on ID
filter[selectable]	query	string	false	string	Filter on selectable
filter[available_for_customer]	query	string	false	string	Filter on available_for_customer
filter[confirm_by_guest]	query	string	false	string	Filter on confirm_by_guest
filter[extra_type]	query	string	false	string	Filter on extra_type
filter[counts_seniors]	query	string	false	string	Filter on counts_seniors
filter[counts_adults]	query	string	false	string	Filter on counts_adults
filter[counts_adolescents]	query	string	false	string	Filter on counts_adolescents
filter[counts_children]	query	string	false	string	Filter on counts_children
filter[counts_babies]	query	string	false	string	Filter on counts_babies
filter[counts_pets]	query	string	false	string	Filter on counts_pets
filter[counts_from]	query	string	false	string	Filter on counts_from
filter[counts_till]	query	string	false	string	Filter on counts_till
filter[administration]	query	string	false	string	Filter on administration. 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": "extra",
      "attributes": {
        "is_excluded": true,
        "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"
        },
        "question_for_guest": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "invoiced_as": {
          "nl": "string",
          "en": "string",
          "de": "string",
          "fr": "string",
          "da": "string",
          "cs": "string",
          "es": "string",
          "tr": "string",
          "pt": "string",
          "it": "string"
        },
        "selectable": "string",
        "available_for_customer": "always",
        "calculation": "per_person",
        "is_percentage": "string",
        "is_hidden": true,
        "is_rent": true,
        "confirm_by_guest": true,
        "extra_type": "other",
        "quantity_required": true,
        "guest_answer_required": true,
        "maximum_quantity": 0,
        "counts_seniors": true,
        "counts_adults": true,
        "counts_adolescents": true,
        "counts_children": true,
        "counts_babies": true,
        "counts_pets": true,
        "counts_from": 0,
        "counts_till": 0,
        "vat_rate": 0,
        "price": {
          "currency": "string",
          "value": "string"
        },
        "require_stay_overlaps": "string",
        "prices": [
          {
            "date": "2021-07-27",
            "price": {
              "currency": "string",
              "value": "string"
            },
            "price_without_vat": {
              "currency": "string",
              "value": "string"
            }
          }
        ],
        "percentages": [
          {
            "date": "2021-07-27",
            "percentage": 0,
            "percentage_without_vat": 0
          }
        ]
      },
      "relationships": {
        "administration": {
          "data": {
            "id": "string",
            "type": "administrations",
            "meta": {
              "temp_id": "string",
              "method": "string"
            }
          }
        }
      },
      "meta": {
        "temp_id": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_records": 0,
      "page": 0,
      "size": 0
    }
  }
}

Responses

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
— data	[Extra]	false	none	[An Extra is an option that can be added to a reservation, for example a child chair, tickets etc. They can have prices that change over time. Will yield a price when returned within the context of a Reservation. ]
—— id	string	false	none	ID
—— type	string	false	none	Type
—— attributes	object	false	none	Attributes
——— is_excluded	boolean	false	none	Whether this extra is excluded from synchronization.
——— 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
——— question_for_guest	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
——— invoiced_as	object	false	none	Translated name under which this extra is invoiced
———— 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
——— selectable	string	false	none	One of: important, customer, backoffice. Important extras are opt-out extras while customer extras are opt-in extras.
——— available_for_customer	string	false	none	none
——— calculation	string	false	none	none
——— is_percentage	string	false	none	none
——— is_hidden	boolean	false	none	none
——— is_rent	boolean	false	none	none
——— confirm_by_guest	boolean	false	none	When set, guests should explicitly confirm the terms mentioned in the description
——— extra_type	string	false	none	none
——— quantity_required	boolean	false	none	none
——— guest_answer_required	boolean	false	none	none
——— maximum_quantity	integer	false	none	Maximum amount per reservation, will be blank when unlimited
——— counts_seniors	boolean	false	none	none
——— counts_adults	boolean	false	none	none
——— counts_adolescents	boolean	false	none	none
——— counts_children	boolean	false	none	none
——— counts_babies	boolean	false	none	none
——— counts_pets	boolean	false	none	none
——— counts_from	integer	false	none	none
——— counts_till	integer	false	none	none
——— vat_rate	number(float)	false	none	none
——— price	object	false	none	When returned as an include of the reservation#available_extras relationship, this will yield the (unit) price of the extra
———— currency	string	false	none	none
———— value	string	false	none	none
——— require_stay_overlaps	string	false	none	none
——— prices	[object]	false	none	none
———— date	string(date)	false	none	none
———— price	object	false	none	none
————— currency	string	false	none	none
————— value	string	false	none	none
———— price_without_vat	object	false	none	none
————— currency	string	false	none	none
————— value	string	false	none	none
——— percentages	[object]	false	none	none
———— date	string(date)	false	none	none
———— percentage	number(float)	false	none	none
———— percentage_without_vat	number(float)	false	none	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.
—— 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
available_for_customer	always
available_for_customer	during_booking
available_for_customer	during_upgrade
calculation	per_person
calculation	per_person_per_day
calculation	per_pet
calculation	per_pet_per_day
calculation	fixed
calculation	per_day
calculation	per_piece
calculation	per_piece_per_day
calculation	percentage_over_default_costs
calculation	percentage_over_total
calculation	percentage_over_default_rent
calculation	percentage_over_rent
extra_type	other
extra_type	tourist_taxes
extra_type	environmental_charges
extra_type	energy
extra_type	deposit
extra_type	bath_linen
extra_type	bed_linen
extra_type	cleaning
extra_type	childs_bed
extra_type	childs_chair
extra_type	sauna
extra_type	pets
extra_type	preference_costs
extra_type	provision
extra_type	cancellation_insurance
extra_type	parking
extra_type	early_checkin
extra_type	late_checkout
extra_type	food
extra_type	labour
extra_type	heating
extra_type	internet
extra_type	gas
extra_type	water
extra_type	drinking_water
extra_type	electricity
extra_type	wood
extra_type	toiletries
extra_type	transportation
extra_type	laundry
extra_type	additional_bed
extra_type	airco

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 extra

Code samples

curl --request GET \
  --url https://api.bookingexperts.nl/v3/channels/1/extras/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/extras/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, array(
  CURLOPT_URL => "https://api.bookingexperts.nl/v3/channels/1/extras/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 => array(
    "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;
}

var data = null;

var 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/extras/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}/extras/{id}

Returns the extra 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[extra]	query	string	false	string	Fieldset. Specify a comma separated list of attributes to return
filter[id]	query	string	false	string	Filter on ID
filter[selectable]	query	string	false	string	Filter on selectable
filter[available_for_customer]	query	string	false	string	Filter on available_for_customer
filter[confirm_by_guest]	query	string	false	string	Filter on confirm_by_guest
filter[extra_type]	query	string	false	string	Filter on extra_type
filter[counts_seniors]	query	string	false	string	Filter on counts_seniors
filter[counts_adults]	query	string	false	string	Filter on counts_adults
filter[counts_adolescents]	query	string	false	string	Filter on counts_adolescents
filter[counts_children]	query	string	false	string	Filter on counts_children
filter[counts_babies]	query	string	false	string	Filter on counts_babies
filter[counts_pets]	query	string	false	string	Filter on counts_pets
filter[counts_from]	query	string	false	string	Filter on counts_from
filter[counts_till]	query	string	false	string	Filter on counts_till
filter[administration]	query	string	false	string	Filter on administration. 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": "extra",
    "attributes": {
      "is_excluded": true,
      "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"
      },
      "question_for_guest": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt": "string",
        "it": "string"
      },
      "invoiced_as": {
        "nl": "string",
        "en": "string",
        "de": "string",
        "fr": "string",
        "da": "string",
        "cs": "string",
        "es": "string",
        "tr": "string",
        "pt"