Booking requests will be sent to the booking system when a customer has purchased the product through the
Website Travel platform.
curl --request POST \
--url https://api.example.com/cms/ebs/booking/{productIdentifier} \
--header 'Content-Type: application/json' \
--data '
{
"voucherNumber": "<string>",
"orderReference": "<string>",
"quantity": 123,
"bookingDate": "<string>",
"bookingTimeId": "<string>",
"pickupLocationId": "<string>",
"additionalFields": {},
"customers": [
{
"customerIndex": 123,
"customerTitle": "<string>",
"customerFirstName": "<string>",
"customerLastName": "<string>",
"customerPhone": "<string>",
"customerDateOfBirth": "2023-12-25",
"customerEmail": "<string>",
"customerCountry": "<string>",
"customerPostcode": "<string>",
"voucherComment": "<string>",
"additionalFields": {}
}
],
"agency": [
{
"branch": "<string>",
"agent": "<string>",
"phone": "<string>",
"branchCode": "<string>"
}
],
"rrp": 123,
"net": 123
}
'import requests
url = "https://api.example.com/cms/ebs/booking/{productIdentifier}"
payload = {
"voucherNumber": "<string>",
"orderReference": "<string>",
"quantity": 123,
"bookingDate": "<string>",
"bookingTimeId": "<string>",
"pickupLocationId": "<string>",
"additionalFields": {},
"customers": [
{
"customerIndex": 123,
"customerTitle": "<string>",
"customerFirstName": "<string>",
"customerLastName": "<string>",
"customerPhone": "<string>",
"customerDateOfBirth": "2023-12-25",
"customerEmail": "<string>",
"customerCountry": "<string>",
"customerPostcode": "<string>",
"voucherComment": "<string>",
"additionalFields": {}
}
],
"agency": [
{
"branch": "<string>",
"agent": "<string>",
"phone": "<string>",
"branchCode": "<string>"
}
],
"rrp": 123,
"net": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
voucherNumber: '<string>',
orderReference: '<string>',
quantity: 123,
bookingDate: '<string>',
bookingTimeId: '<string>',
pickupLocationId: '<string>',
additionalFields: {},
customers: [
{
customerIndex: 123,
customerTitle: '<string>',
customerFirstName: '<string>',
customerLastName: '<string>',
customerPhone: '<string>',
customerDateOfBirth: '2023-12-25',
customerEmail: '<string>',
customerCountry: '<string>',
customerPostcode: '<string>',
voucherComment: '<string>',
additionalFields: {}
}
],
agency: [
{
branch: '<string>',
agent: '<string>',
phone: '<string>',
branchCode: '<string>'
}
],
rrp: 123,
net: 123
})
};
fetch('https://api.example.com/cms/ebs/booking/{productIdentifier}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/cms/ebs/booking/{productIdentifier}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'voucherNumber' => '<string>',
'orderReference' => '<string>',
'quantity' => 123,
'bookingDate' => '<string>',
'bookingTimeId' => '<string>',
'pickupLocationId' => '<string>',
'additionalFields' => [
],
'customers' => [
[
'customerIndex' => 123,
'customerTitle' => '<string>',
'customerFirstName' => '<string>',
'customerLastName' => '<string>',
'customerPhone' => '<string>',
'customerDateOfBirth' => '2023-12-25',
'customerEmail' => '<string>',
'customerCountry' => '<string>',
'customerPostcode' => '<string>',
'voucherComment' => '<string>',
'additionalFields' => [
]
]
],
'agency' => [
[
'branch' => '<string>',
'agent' => '<string>',
'phone' => '<string>',
'branchCode' => '<string>'
]
],
'rrp' => 123,
'net' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/cms/ebs/booking/{productIdentifier}"
payload := strings.NewReader("{\n \"voucherNumber\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"quantity\": 123,\n \"bookingDate\": \"<string>\",\n \"bookingTimeId\": \"<string>\",\n \"pickupLocationId\": \"<string>\",\n \"additionalFields\": {},\n \"customers\": [\n {\n \"customerIndex\": 123,\n \"customerTitle\": \"<string>\",\n \"customerFirstName\": \"<string>\",\n \"customerLastName\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"customerDateOfBirth\": \"2023-12-25\",\n \"customerEmail\": \"<string>\",\n \"customerCountry\": \"<string>\",\n \"customerPostcode\": \"<string>\",\n \"voucherComment\": \"<string>\",\n \"additionalFields\": {}\n }\n ],\n \"agency\": [\n {\n \"branch\": \"<string>\",\n \"agent\": \"<string>\",\n \"phone\": \"<string>\",\n \"branchCode\": \"<string>\"\n }\n ],\n \"rrp\": 123,\n \"net\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/cms/ebs/booking/{productIdentifier}")
.header("Content-Type", "application/json")
.body("{\n \"voucherNumber\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"quantity\": 123,\n \"bookingDate\": \"<string>\",\n \"bookingTimeId\": \"<string>\",\n \"pickupLocationId\": \"<string>\",\n \"additionalFields\": {},\n \"customers\": [\n {\n \"customerIndex\": 123,\n \"customerTitle\": \"<string>\",\n \"customerFirstName\": \"<string>\",\n \"customerLastName\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"customerDateOfBirth\": \"2023-12-25\",\n \"customerEmail\": \"<string>\",\n \"customerCountry\": \"<string>\",\n \"customerPostcode\": \"<string>\",\n \"voucherComment\": \"<string>\",\n \"additionalFields\": {}\n }\n ],\n \"agency\": [\n {\n \"branch\": \"<string>\",\n \"agent\": \"<string>\",\n \"phone\": \"<string>\",\n \"branchCode\": \"<string>\"\n }\n ],\n \"rrp\": 123,\n \"net\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/cms/ebs/booking/{productIdentifier}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"voucherNumber\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"quantity\": 123,\n \"bookingDate\": \"<string>\",\n \"bookingTimeId\": \"<string>\",\n \"pickupLocationId\": \"<string>\",\n \"additionalFields\": {},\n \"customers\": [\n {\n \"customerIndex\": 123,\n \"customerTitle\": \"<string>\",\n \"customerFirstName\": \"<string>\",\n \"customerLastName\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"customerDateOfBirth\": \"2023-12-25\",\n \"customerEmail\": \"<string>\",\n \"customerCountry\": \"<string>\",\n \"customerPostcode\": \"<string>\",\n \"voucherComment\": \"<string>\",\n \"additionalFields\": {}\n }\n ],\n \"agency\": [\n {\n \"branch\": \"<string>\",\n \"agent\": \"<string>\",\n \"phone\": \"<string>\",\n \"branchCode\": \"<string>\"\n }\n ],\n \"rrp\": 123,\n \"net\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"bookingReferenceId": "<string>",
"bookingNotes": "<string>",
"errorMessage": "<string>"
}Version 1
Booking requests will be sent to the booking system when a customer has purchased the product through the Website Travel platform.
Each booking request will be for a single date only. If multiple dates are booked as part of the same order, one request will be made per date booked, and each request will have the same voucherNumber.
POST
/
cms
/
ebs
/
booking
/
{productIdentifier}
Booking requests will be sent to the booking system when a customer has purchased the product through the
Website Travel platform.
curl --request POST \
--url https://api.example.com/cms/ebs/booking/{productIdentifier} \
--header 'Content-Type: application/json' \
--data '
{
"voucherNumber": "<string>",
"orderReference": "<string>",
"quantity": 123,
"bookingDate": "<string>",
"bookingTimeId": "<string>",
"pickupLocationId": "<string>",
"additionalFields": {},
"customers": [
{
"customerIndex": 123,
"customerTitle": "<string>",
"customerFirstName": "<string>",
"customerLastName": "<string>",
"customerPhone": "<string>",
"customerDateOfBirth": "2023-12-25",
"customerEmail": "<string>",
"customerCountry": "<string>",
"customerPostcode": "<string>",
"voucherComment": "<string>",
"additionalFields": {}
}
],
"agency": [
{
"branch": "<string>",
"agent": "<string>",
"phone": "<string>",
"branchCode": "<string>"
}
],
"rrp": 123,
"net": 123
}
'import requests
url = "https://api.example.com/cms/ebs/booking/{productIdentifier}"
payload = {
"voucherNumber": "<string>",
"orderReference": "<string>",
"quantity": 123,
"bookingDate": "<string>",
"bookingTimeId": "<string>",
"pickupLocationId": "<string>",
"additionalFields": {},
"customers": [
{
"customerIndex": 123,
"customerTitle": "<string>",
"customerFirstName": "<string>",
"customerLastName": "<string>",
"customerPhone": "<string>",
"customerDateOfBirth": "2023-12-25",
"customerEmail": "<string>",
"customerCountry": "<string>",
"customerPostcode": "<string>",
"voucherComment": "<string>",
"additionalFields": {}
}
],
"agency": [
{
"branch": "<string>",
"agent": "<string>",
"phone": "<string>",
"branchCode": "<string>"
}
],
"rrp": 123,
"net": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
voucherNumber: '<string>',
orderReference: '<string>',
quantity: 123,
bookingDate: '<string>',
bookingTimeId: '<string>',
pickupLocationId: '<string>',
additionalFields: {},
customers: [
{
customerIndex: 123,
customerTitle: '<string>',
customerFirstName: '<string>',
customerLastName: '<string>',
customerPhone: '<string>',
customerDateOfBirth: '2023-12-25',
customerEmail: '<string>',
customerCountry: '<string>',
customerPostcode: '<string>',
voucherComment: '<string>',
additionalFields: {}
}
],
agency: [
{
branch: '<string>',
agent: '<string>',
phone: '<string>',
branchCode: '<string>'
}
],
rrp: 123,
net: 123
})
};
fetch('https://api.example.com/cms/ebs/booking/{productIdentifier}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/cms/ebs/booking/{productIdentifier}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'voucherNumber' => '<string>',
'orderReference' => '<string>',
'quantity' => 123,
'bookingDate' => '<string>',
'bookingTimeId' => '<string>',
'pickupLocationId' => '<string>',
'additionalFields' => [
],
'customers' => [
[
'customerIndex' => 123,
'customerTitle' => '<string>',
'customerFirstName' => '<string>',
'customerLastName' => '<string>',
'customerPhone' => '<string>',
'customerDateOfBirth' => '2023-12-25',
'customerEmail' => '<string>',
'customerCountry' => '<string>',
'customerPostcode' => '<string>',
'voucherComment' => '<string>',
'additionalFields' => [
]
]
],
'agency' => [
[
'branch' => '<string>',
'agent' => '<string>',
'phone' => '<string>',
'branchCode' => '<string>'
]
],
'rrp' => 123,
'net' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/cms/ebs/booking/{productIdentifier}"
payload := strings.NewReader("{\n \"voucherNumber\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"quantity\": 123,\n \"bookingDate\": \"<string>\",\n \"bookingTimeId\": \"<string>\",\n \"pickupLocationId\": \"<string>\",\n \"additionalFields\": {},\n \"customers\": [\n {\n \"customerIndex\": 123,\n \"customerTitle\": \"<string>\",\n \"customerFirstName\": \"<string>\",\n \"customerLastName\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"customerDateOfBirth\": \"2023-12-25\",\n \"customerEmail\": \"<string>\",\n \"customerCountry\": \"<string>\",\n \"customerPostcode\": \"<string>\",\n \"voucherComment\": \"<string>\",\n \"additionalFields\": {}\n }\n ],\n \"agency\": [\n {\n \"branch\": \"<string>\",\n \"agent\": \"<string>\",\n \"phone\": \"<string>\",\n \"branchCode\": \"<string>\"\n }\n ],\n \"rrp\": 123,\n \"net\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/cms/ebs/booking/{productIdentifier}")
.header("Content-Type", "application/json")
.body("{\n \"voucherNumber\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"quantity\": 123,\n \"bookingDate\": \"<string>\",\n \"bookingTimeId\": \"<string>\",\n \"pickupLocationId\": \"<string>\",\n \"additionalFields\": {},\n \"customers\": [\n {\n \"customerIndex\": 123,\n \"customerTitle\": \"<string>\",\n \"customerFirstName\": \"<string>\",\n \"customerLastName\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"customerDateOfBirth\": \"2023-12-25\",\n \"customerEmail\": \"<string>\",\n \"customerCountry\": \"<string>\",\n \"customerPostcode\": \"<string>\",\n \"voucherComment\": \"<string>\",\n \"additionalFields\": {}\n }\n ],\n \"agency\": [\n {\n \"branch\": \"<string>\",\n \"agent\": \"<string>\",\n \"phone\": \"<string>\",\n \"branchCode\": \"<string>\"\n }\n ],\n \"rrp\": 123,\n \"net\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/cms/ebs/booking/{productIdentifier}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"voucherNumber\": \"<string>\",\n \"orderReference\": \"<string>\",\n \"quantity\": 123,\n \"bookingDate\": \"<string>\",\n \"bookingTimeId\": \"<string>\",\n \"pickupLocationId\": \"<string>\",\n \"additionalFields\": {},\n \"customers\": [\n {\n \"customerIndex\": 123,\n \"customerTitle\": \"<string>\",\n \"customerFirstName\": \"<string>\",\n \"customerLastName\": \"<string>\",\n \"customerPhone\": \"<string>\",\n \"customerDateOfBirth\": \"2023-12-25\",\n \"customerEmail\": \"<string>\",\n \"customerCountry\": \"<string>\",\n \"customerPostcode\": \"<string>\",\n \"voucherComment\": \"<string>\",\n \"additionalFields\": {}\n }\n ],\n \"agency\": [\n {\n \"branch\": \"<string>\",\n \"agent\": \"<string>\",\n \"phone\": \"<string>\",\n \"branchCode\": \"<string>\"\n }\n ],\n \"rrp\": 123,\n \"net\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"bookingReferenceId": "<string>",
"bookingNotes": "<string>",
"errorMessage": "<string>"
}Path Parameters
Identifier for the fare/product being booked on the external booking system
Body
application/json
Booking Request Parameters
Booking Request Parameters
Website Travel voucher number for this booking
Website Travel reference for the order which contains the booking/voucher
The quantity of product being booked for this date
Date of booking in YYYY-MM-DD format
Identifier of booking time to make booking for
Identifier of pickup location to make booking for
Array of key-value pairs
List of customers included on this booking request
Show child attributes
Show child attributes
Details of agency that took the booking
Show child attributes
Show child attributes
The recommended retail price for the product on this booking
Your net rate for the product on the booking
Response
Returned when successful.