Search K

Appearance

Get bookingorders ​

GET
/v1/bookingorders/list
Server

Gets a list with bookingorders without much nesting.

Authorizations​

api_key
TypeAPI Key (header: X-Api-Key)

Parameters​

Query Parameters

sorting
Typestring
default
page_size

Number of items per page

Typeinteger
default50
page

Current page

Typeinteger
default1
reservation_id
Typestring
Example
booking_id
Typestring
Example
query
Typestring
Example
booking_email
Typestring
Example
compare_mode

compare mode AND / OR

Typestring
ExampleAND
ticket_id
Typestring
Example
event_id
Typestring
Example
event_startdate

Filter bookingorders on their event startdate

Typestring
Example2025-05-01
event_stopdate

Filter bookingorders on their event stopdate

Typestring
Example2025-05-02
created
Typestring
Example
api_booking
Typeboolean
Exampletrue
guestdata_status

Enum: waitingfordistributor, waitingforprocessing, completed, waitingforendcustomer, notapplicable, waitingtosendtosupplier

Typestring
Examplecompleted
booking_code
Typestring
Example

Responses​

OK
application/json
JSON
{
"bookingorders": [
{
"booking_id": "1b97adfc8a3a4fe4ad13b58f40372cca_bkn",
"bookingorder_id": "3fa6eb7f123a4f5ab2c9d8e7a6b7c9d0_bor",
"event_id": "dd82ecd6931749819942c4aff9dd23cb_evt",
"created": "2025-04-20T12:00:00",
"distributor_id": "b05f667dcaa843bd8c171c522217eb81_dst",
"accepted_gt": true,
"marketing_optin": false,
"mass_booking_allowed": true,
"api_booking": true,
"offline_booking": false,
"booking_code": "CODE123",
"zip_sha": "string",
"guestdata_status": "waitingfordistributor",
"max_pdfs_per_ticket": 5,
"distributorfinancial_status": "paid",
"logistic_status": "processing",
"event_name": "Concert X",
"payment_method": "card",
"payment_reference": "8c4a2b9d123e4f5a876c5d4e3f2b1a09_pay",
"booking_reference": "9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a_ref",
"parent_id": "1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d_bkn",
"client_id": "5edec2b99b1b4c449a8ca2b1d6e4723e_cli",
"booking_email": "user@example.com",
"notify_client_status": "completed",
"invoices": [
"1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f_inv"
],
"items": [
],
"event_startdate": "2025-05-01",
"event_stopdate": "2025-05-02",
"booking_group": "Group A",
"supplier_id": "7acfed7b0d874c5e870b531e5a4f0e43_spp",
"deleted": "string",
"external_payment_reference": "ext_123",
"financial_status": "topurchase",
"general_terms_url": "https://.../terms.pdf",
"onbehalfclient_id": "a1b2c3d4e5f67890123456789abcdef0_cli"
}
],
"pagination": {
"total_size": 1,
"page_size": 50,
"next_page": "string",
"previous_page": "string"
}
}

Samples​

cURL
curl -X GET \
'https://api.xs2event.com/v1/bookingorders/list?compare_mode=AND&event_startdate=2025-05-01&event_stopdate=2025-05-02&api_booking=true&guestdata_status=completed' \
 -H "Content-Type: application/json"
JavaScript
fetch('https://api.xs2event.com/v1/bookingorders/list?compare_mode=AND&event_startdate=2025-05-01&event_stopdate=2025-05-02&api_booking=true&guestdata_status=completed', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://api.xs2event.com/v1/bookingorders/list';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];
$query = http_build_query([
    'compare_mode' => 'AND',
    'event_startdate' => '2025-05-01',
    'event_stopdate' => '2025-05-02',
    'api_booking' => 'true',
    'guestdata_status' => 'completed',
]);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . '?' . $query);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://api.xs2event.com/v1/bookingorders/list'
params = {
    'compare_mode': 'AND',
    'event_startdate': '2025-05-01',
    'event_stopdate': '2025-05-02',
    'api_booking': true,
    'guestdata_status': 'completed'
}
headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, params=params, headers=headers)
print(response.json())