The following are examples of sample API invocations to carry out common tasks.
Note that the secretKey and apiKey parameters in the examples are fictional.
REQUEST:
GET https://api.bookeo.com/v2/settings/products
RESPONSE:
{
"data": [
{
"name": "New York City Tour",
"description": "<p>Make the most of your time in New York on a guided tour of the city that never sleeps. <br />Explore the very center of New York City with our expert guides and see New York City’s top attractions: 9/11 Memorial, Central Park, and more.</p>",
"images": [
{
"url": "https://www-85a.bookeo.com/bookeo/cfile/296UFFRJP12CCD9580DA/1607301746453_9JEATXRK37XYFTKRJ3ET3HTRU6XH7PX9_1000_666.jpg"
},
{
"url": "https://www-85a.bookeo.com/bookeo/cfile/296UFFRJP12CCD9580DA/1607301756008_LKCN6XRAUPMCHMU7RJ9ENWTN9ANPHTFJ_1000_666.jpg"
},
{
"url": "https://www-85a.bookeo.com/bookeo/cfile/296UFFRJP12CCD9580DA/1607301765836_XYRTEXJF49RAKTKH6WFJP6XK4XF6XWRE_1000_666.jpg"
}
],
"productId": "296PJ9JHM12EB2FFCF43",
"productCode": "296PJ9JHM12EB2FFCF43",
"bookingLimits": [
{
"min": 1,
"max": 10
},
{
"peopleCategoryId": "Cadults",
"min": 0,
"max": 10
},
{
"peopleCategoryId": "LTTUFJ",
"min": 0,
"max": 10
},
{
"peopleCategoryId": "Cchildren",
"min": 0,
"max": 9
},
{
"peopleCategoryId": "Cinfants",
"min": 0,
"max": 9
}
],
"defaultRates": [
{
"peopleCategoryId": "Cadults",
"price": {
"amount": "85",
"currency": "USD"
}
},
{
"peopleCategoryId": "LTTUFJ",
"price": {
"amount": "70",
"currency": "USD"
}
},
{
"peopleCategoryId": "Cchildren",
"price": {
"amount": "45",
"currency": "USD"
}
},
{
"peopleCategoryId": "Cinfants",
"price": {
"amount": "20",
"currency": "USD"
}
}
],
"duration": {
"days": 0,
"hours": 3,
"minutes": 0
},
"type": "fixed",
"membersOnly": false,
"prepaidOnly": false,
"acceptDeny": false,
"apiBookingsAllowed": true,
"dropInOnly": false,
"allowPrivateEvents": false,
"numberOptions": [
{
"minValue": 0,
"maxValue": 3,
"defaultValue": 0,
"id": "296PJ9JHM12EB2FFCF43_4WRK6KRU",
"name": "Lunch",
"index": 1,
"description": "<p>Prebook your lunch and save!</p>",
"shownToCustomers": true,
"enabled": true
},
{
"minValue": 0,
"maxValue": 100,
"defaultValue": 5,
"id": "296PJ9JHM12EB2FFCF43_3TLAHPN6",
"name": "number",
"index": 2,
"description": "",
"shownToCustomers": true,
"enabled": true
}
],
"onOffOptions": [
{
"defaultState": false,
"id": "296PJ9JHM12EB2FFCF43_J43LUY47",
"name": "Printed booklet",
"index": 0,
"description": "<p>Buy a printed color booklet that you can read while following the tour.</p>\n<p>Very useful to learn more about the history of the place.</p>\n<p>And a great memory to take home, too!</p>",
"shownToCustomers": true,
"enabled": true
}
]
},
{
"name": "Walking Tour of New York City Architecture",
"description": "<div class=\"clearfix xs-text-left zone xs-pb4 medium_list v5-zone md-pb0 md-mt6 xs-mb5 xs-border-bottom border-black xs-border-4\" data-track-view=\"{"pev2":"zone_1:medium_list:15_tiles","events":["event233"]}\">\n<div class=\"xs-flex xs-flex-wrap xs-flex-row tiles\" data-module=\"load_more_widget\" data-params=\"{"ajax_endpoint":"\/newyork\/en_US\/paginate","infinite":false}\" data-initialised=\"true\">\n<div class=\"card-content xs-col-12 sm-col-8\">\n<div class=\"info-wrapper xs-my2\" data-tracking-props=\"{"prop59":"medium_list::1::list item::8::::tile::false::0::0::7::false","eVar59":"D=c59","pev2":"list item","prop60":"Small Group Walking Tour of New York City Architecture","eVar60":"D=c60","prop61":null,"eVar61":"D=c61"}\">\n<div class=\"xs-text-7 xs-line-height-6 xs-text-charcoal description-wrapper xs-relative xs-flex xs-flex-column\">\n<div class=\"js-card-description xs-order-0 xs-height-fit xs-height-fit-transition\">\n<div class=\"js-card-desc-content\">\n<p>During this three-hour tour of Midtown, you will see world-famous architectural landmarks, including Times Square, the Chrysler Building, Grand Central Terminal, the New York Public Library, Tudor City.</p>\n<p>You will spot examples of different architectural styles: Art Deco, Beaux-Arts, and International Style architecture. Our professional guide will explain how each style ties into the city’s history.</p>\n</div>\n</div>\n</div>\n</div>\n</div>\n</div>\n</div>",
"images": [
{
"url": "https://www-85a.bookeo.com/bookeo/cfile/296UFFRJP12CCD9580DA/1607408229725_WYWH6RHFL9TJFHJ9UNXJCNRWFK3FJ6AN_640_427.jpg"
},
{
"url": "https://www-85a.bookeo.com/bookeo/cfile/296UFFRJP12CCD9580DA/1607487632375_PNAUCRFCFJFE6KNPAP6YK7RCCCLJC6A7_1000_667.jpg"
},
{
"url": "https://www-85a.bookeo.com/bookeo/cfile/296UFFRJP12CCD9580DA/1607487722219_6ARHNCNCMLU7C4LX9AFJNF463KCE99EP_1000_661.jpg"
}
],
"productId": "296K3TUYA12EB3196D6D",
"productCode": "296K3TUYA12EB3196D6D",
"bookingLimits": [
{
"min": 1,
"max": 4
},
{
"peopleCategoryId": "Cadults",
"min": 0,
"max": 4
},
{
"peopleCategoryId": "LTTUFJ",
"min": 0,
"max": 4
},
{
"peopleCategoryId": "Cchildren",
"min": 0,
"max": 2
}
],
"defaultRates": [
{
"peopleCategoryId": "Cadults",
"price": {
"amount": "70",
"currency": "USD"
}
},
{
"peopleCategoryId": "LTTUFJ",
"price": {
"amount": "70",
"currency": "USD"
}
},
{
"peopleCategoryId": "Cchildren",
"price": {
"amount": "50",
"currency": "USD"
}
}
],
"duration": {
"days": 0,
"hours": 2,
"minutes": 0
},
"type": "fixed",
"membersOnly": false,
"prepaidOnly": false,
"acceptDeny": false,
"apiBookingsAllowed": true,
"dropInOnly": false,
"allowPrivateEvents": false,
"choiceOptions": [
{
"values": [
{
"id": "296K3TUYA12EB3196D6D_9EACW4PH_YUKNKH",
"name": "English",
"description": ""
},
{
"id": "296K3TUYA12EB3196D6D_9EACW4PH_TPEPHL",
"name": "French",
"description": ""
},
{
"id": "296K3TUYA12EB3196D6D_9EACW4PH_ETWTFW",
"name": "Hilton",
"description": ""
},
{
"id": "296K3TUYA12EB3196D6D_9EACW4PH_UFUNNN",
"name": "Meridien",
"description": ""
}
],
"defaultValueId": "296K3TUYA12EB3196D6D_9EACW4PH_YUKNKH",
"id": "296K3TUYA12EB3196D6D_9EACW4PH",
"name": "Tour language",
"index": 0,
"description": "",
"shownToCustomers": true,
"enabled": true
}
],
"onOffOptions": [
{
"defaultState": false,
"id": "296K3TUYA12EB3196D6D_EJLFKUAC",
"name": "Printed booklet",
"index": 1,
"description": "<p>Buy a printed color booklet that you can read while following the tour.</p>\n<p>Very useful to learn more about the history of the place.</p>\n<p>And a great memory to take home, too!</p>\n<p> </p>",
"shownToCustomers": true,
"enabled": true
}
],
"textOptions": [
{
"required": false,
"id": "296K3TUYA12EB3196D6D_6NY9KPJU",
"name": "Notes/Special requirements",
"index": 2,
"description": "",
"shownToCustomers": true,
"enabled": true
}
]
},
{
"name": "Private Manhattan Tour",
"description": "<p>This New York city private tour is perfect for friends, family, corporate or social groups. Walk the streets of Manhattan, passing through Greenwich Village, Chinatown, Central Park and Little Italy. Learn more about the city from your experienced guide, take photos. During this private tour, you will see world-famous landmarks including One World Trade Center and Brooklyn Bridge.</p>",
"images": [
{
"url": "https://www-85a.bookeo.com/bookeo/cfile/296UFFRJP12CCD9580DA/1607409391962_RW7WYM4FAWAFH3N34LXFKHRYLCRRPFJ9_1000_667.jpg"
},
{
"url": "https://www-85a.bookeo.com/bookeo/cfile/296UFFRJP12CCD9580DA/1607409268721_WPK9KLKMPCH3MKE99WXUAACTYJXJ6H3F_1000_666.jpg"
}
],
"productId": "296KULL391492B80C35B",
"productCode": "296KULL391492B80C35B",
"bookingLimits": [
{
"min": 1,
"max": 2
},
{
"peopleCategoryId": "Cadults",
"min": 0,
"max": 2
},
{
"peopleCategoryId": "LTTUFJ",
"min": 0,
"max": 2
}
],
"duration": {
"days": 0,
"hours": 4,
"minutes": 0
},
"type": "flexibleTime",
"membersOnly": false,
"prepaidOnly": false,
"acceptDeny": false,
"apiBookingsAllowed": true,
"dropInOnly": false,
"allowPrivateEvents": false,
"choiceOptions": [
{
"values": [
{
"id": "296KULL391492B80C35B_RCFKXENH_HEHMWPNE",
"name": "a",
"description": ""
},
{
"id": "296KULL391492B80C35B_RCFKXENH_RWXHNFEK",
"name": "b",
"description": ""
}
],
"id": "296KULL391492B80C35B_RCFKXENH",
"name": "dropdown",
"index": 0,
"description": "",
"shownToCustomers": false,
"enabled": true
}
]
}
],
"info": {
"totalItems": 3,
"totalPages": 1,
"currentPage": 1
}
}
NB please note there is also an endpoint /availability/matchingslots. Use the one that best suits your application.
REQUEST:
GET https://api.bookeo.com/v2/availability/slots?startTime=2024-05-20T00:00:00Z&endTime=2024-05-20T23:59:59Z
RESPONSE:
{
"data": [
{
"productId": "296PJ9JHM12EB2FFCF43",
"eventId": "296PJ9JHM12EB2FFCF43_296FY3HNX12EB2FFCF44_2024-05-20",
"startTime": "2024-05-20T09:00:00-04:00",
"endTime": "2024-05-20T12:00:00-04:00",
"numSeatsAvailable": 10
},
{
"productId": "296PJ9JHM12EB2FFCF43",
"eventId": "296PJ9JHM12EB2FFCF43_2967Y7YEM12EB2FFCF44_2024-05-20",
"startTime": "2024-05-20T15:00:00-04:00",
"endTime": "2024-05-20T18:00:00-04:00",
"numSeatsAvailable": 10
},
{
"productId": "296K3TUYA12EB3196D6D",
"eventId": "296K3TUYA12EB3196D6D_296KH39PJ12EB3196D6E_2024-05-20",
"startTime": "2024-05-20T17:00:00-04:00",
"endTime": "2024-05-20T19:00:00-04:00",
"numSeatsAvailable": 10
},
{
"productId": "296PJ9JHM12EB2FFCF43",
"eventId": "296PJ9JHM12EB2FFCF43_296PT4TMY17607A7C448_2024-05-20",
"startTime": "2024-05-20T18:00:00-04:00",
"endTime": "2024-05-20T21:00:00-04:00",
"numSeatsAvailable": 10
}
],
"info": {
"totalItems": 4,
"totalPages": 1,
"currentPage": 1
}
}
REQUEST: POST https://api.bookeo.com/v2/holds { "eventId": "296PJ9JHM12EB2FFCF43_296FY3HNX12EB2FFCF44_2024-05-20", "customer": { "firstName": "Joe", "lastName": "Smith", "emailAddress": "test@nowhere.com", "phoneNumbers": [ { "number": "123456", "type": "mobile" } ] }, "participants": { "numbers": [ { "peopleCategoryId": "Cadults", "number": 1 }, { "peopleCategoryId": "Cchildren", "number": 1 } ] }, "productId": "296PJ9JHM12EB2FFCF43" } RESPONSE: { "id": "amIEGXwsA3onTKsS_6862108", "price": { "totalGross": { "amount": "162.75", "currency": "USD" }, "totalNet": { "amount": "155", "currency": "USD" }, "totalTaxes": { "amount": "7.75", "currency": "USD" }, "totalPaid": { "amount": "0", "currency": "USD" }, "taxes": [ { "taxId": "211H9KWPC134AC4B0136", "amount": { "amount": "7.75", "currency": "USD" } } ] }, "totalPayable": { "amount": "162.75", "currency": "USD" }, "expiration": "2024-05-19T21:23:00-04:00" }
Note this call also removes the hold previously created, and asks Bookeo to send relevant notifications to users and customer.
REQUEST:
POST https://api.bookeo.com/v2/bookings?previousHoldId=amIEGXwsA3onTKsS_6862108¬ifyUsers=true¬ifyCustomer=true
{
"eventId": "296PJ9JHM12EB2FFCF43_296FY3HNX12EB2FFCF44_2024-05-20",
"customer": {
"firstName": "Joe",
"lastName": "Smith",
"emailAddress": "test@nowhere.com",
"phoneNumbers": [
{
"number": "123456",
"type": "mobile"
}
]
},
"participants": {
"numbers": [
{
"peopleCategoryId": "Cadults",
"number": 1
},
{
"peopleCategoryId": "Cchildren",
"number": 1
}
]
},
"productId": "296PJ9JHM12EB2FFCF43",
"initialPayments": [
{
"reason": "Initial deposit",
"comment": "This is a custom comment",
"amount": {
"amount": "81.38",
"currency": "USD"
},
"paymentMethod": "creditCard"
}
]
}
RESPONSE:
{
"bookingNumber": "85405204099351",
"eventId": "296PJ9JHM12EB2FFCF43_296FY3HNX12EB2FFCF44_2024-05-20",
"startTime": "2024-05-20T09:00:00-04:00",
"endTime": "2024-05-20T12:00:00-04:00",
"customerId": "285WK7FMU18F939945C8",
"title": "Joe Smith",
"participants": {
"numbers": [
{
"peopleCategoryId": "Cadults",
"number": 1
},
{
"peopleCategoryId": "Cchildren",
"number": 1
}
]
},
"canceled": false,
"accepted": true,
"creationTime": "2024-05-19T21:24:00-04:00",
"creationAgent": "My Test App (application)",
"productName": "New York City Tour",
"productId": "296PJ9JHM12EB2FFCF43",
"options": [
{
"id": "296PJ9JHM12EB2FFCF43_J43LUY47",
"name": "Printed booklet",
"value": "false"
},
{
"id": "296PJ9JHM12EB2FFCF43_4WRK6KRU",
"name": "Lunch",
"value": "0"
},
{
"id": "296PJ9JHM12EB2FFCF43_3TLAHPN6",
"name": "number",
"value": "5"
}
],
"privateEvent": false,
"noShow": false,
"price": {
"totalGross": {
"amount": "162.75",
"currency": "USD"
},
"totalNet": {
"amount": "155",
"currency": "USD"
},
"totalTaxes": {
"amount": "7.75",
"currency": "USD"
},
"totalPaid": {
"amount": "81.38",
"currency": "USD"
},
"taxes": [
{
"taxId": "211H9KWPC134AC4B0136",
"amount": {
"amount": "7.75",
"currency": "USD"
}
}
]
}
}