Booking
2-stepbooking process through: reserving availability and making the booking.
When making a reservation for availability this is performed in 2 steps:
Check Availability: Check for availability using the POST /availability endpoint to retrieve the
availabilityId
.Booking Reservation: Create the booking which reserves that availability. The booking will keep the status
ON_HOLD
until the booking is confirmed or the reservationexpirationMinutes
expires. A reservation can be extended by calling the POST /bookings/:uuid/extend endpoint.
We have described the possible Booking calls here:
Booking Endpoints
Reserve - stage 1 reserves the availability by providing the
availabilityId
. The Availability ID comes from checking inventory.Confirm - stage 2 finalizes the booking. You will store the
supplierReferenceNumber
.Cancel (Optional) - allows cancelling a confirmed booking.
Update (Optional) - allows updating of an existing booking.
Extend (Optional) - allows extending the
expirationMinutes
or hold time.
Access to Existing Bookings
Get Booking - this end point will retrieve a single valid booking associated with your reseller account
List Bookings - this end point will retrieve a list of bookings associated with your reseller account
Bookings - Reserve
POST
https://api.zaui.io/octo/bookings
This endpoint reserves the availability for a product and creates a pending booking.
Request Body
{
"id": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"uuid": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"testMode": true,
"supplierReference": "14XY29Z",
"status": "ON_HOLD",
"resellerReference": null,
"utcCreatedAt": "2021-04-10T09:00:52-07:00",
"utcUpdatedAt": "2021-04-10T09:00:52-07:00",
"utcExpiresAt": "2021-04-10T09:05:52-07:00",
"utcRedeemedAt": null,
"utcConfirmedAt": null,
"productId": "846c36a4-8cb7-4abb-afff-944be62aa312",
"product": {
"id": "846c36a4-8cb7-4abb-afff-944be62aa312",
"internalName": "Wilderness Tour",
"reference": null,
"locale": "en",
"timeZone": "America/Vancouver",
"allowFreesale": false,
"instantConfirmation": true,
"instantDelivery": true,
"availabilityRequired": true,
"availabilityType": "OPENING_HOURS",
"deliveryFormats": [
"PDF_URL",
"QRCODE"
],
"deliveryMethods": [
"TICKET",
"VOUCHER"
],
"redemptionMethod": "DIGITAL",
"options": [
{
"id": "DEFAULT",
"default": true,
"internalName": "Standard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
}
]
},
"optionId": "DEFAULT",
"option": {
"id": "DEFAULT",
"default": true,
"internalName": "Standard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582"]
}
}
]
},
"cancellable": true,
"cancellation": null,
"freesale": false,
"availabilityId": "2021-07-05T10:00:00-07:00",
"availability": {
"id": "2021-07-05T10:00:00-07:00",
"localDateTimeStart": "2021-07-05T10:00:00-07:00",
"localDateTimeEnd": "",
"allDay": true,
"openingHours": [
{
"from": "10:00",
"to": "17:00",
}
]
},
"contact": {
"fullName": "Chris Smith",
"firstName": "Chris",
"lastName": "Smith",
"emailAddress": "zaui@test.com",
"phoneNumber": "+1 604 404 3841",
"locales": [],
"country": null,
"notes": null
},
"notes": null,
"deliveryMethods": "VOUCHER",
"voucher": {
"redemptionMethod": "DIGITAL",
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"utcRedeemedAt": null
},
"unitItems": [
{
"uuid": "cfd3968e-b820-4c47-b8da-7912d65eac03",
"unitId": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"resellerReference": null,
"supplierReference": null,
"unit": {
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
},
"status": "ON_HOLD",
"utcRedeemedAt": null,
"contact": {
"fullName": "Chris Smith",
"firstName": "Chris",
"lastName": "Smith",
"emailAddress": "zaui@test.com",
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"ticket": {
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"redemptionMethod": "DIGITAL",
"utcRedeemedAt": null
}
}
]
}
Example Request:
{
"productId": "846c36a4-8cb7-4abb-afff-944be62aa312",
"optionId": "DEFAULT",
"availabilityId": "2021-07-05T10:00:00-07:00",
"expirationMinutes": 10,
"notes": "Optional notes that can be passed to the supplier system",
"unitItems": [
{ "unitId": "adults_0e064227-c793-426b-857c-2d1fcba62582" }
]
}
Bookings - Confirm
POST
https://api.zaui.io/octo/bookings/{id}/confirm
This endpoint confirms the reserved availability and the booking is finalized.
Path Parameters
Request Body
{
"id": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"uuid": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"testMode": true,
"supplierReference": "X4CJGE6",
"status": "CONFIRMED",
"resellerReference": null,
"utcCreatedAt": "2021-04-10T09:00:52-07:00",
"utcUpdatedAt": "2021-04-10T09:00:52-07:00",
"utcExpiresAt": "2021-04-10T09:05:52-07:00",
"utcRedeemedAt": null,
"utcConfirmedAt": null,
"productId": "846c36a4-8cb7-4abb-afff-944be62aa312",
"product": {
"id": "846c36a4-8cb7-4abb-afff-944be62aa312",
"internalName": "Wilderness Tour",
"reference": null,
"locale": "en",
"timeZone": "America/Vancouver",
"allowFreesale": false,
"instantConfirmation": true,
"instantDelivery": true,
"availabilityRequired": true,
"availabilityType": "OPENING_HOURS",
"deliveryFormats": [
"PDF_URL",
"QRCODE"
],
"deliveryMethods": [
"TICKET",
"VOUCHER"
],
"redemptionMethod": "DIGITAL",
"options": [
{
"id": "DEFAULT",
"default": true,
"internalName": "Standard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba6258",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba6258" ]
}
}
]
}
]
},
"optionId": "DEFAULT",
"option": {
"id": "DEFAULT",
"default": true,
"internalName": "Standard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba6258",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba6258" ]
}
}
]
},
"cancellable": true,
"cancellation": null,
"freesale": false,
"availabilityId": "2021-07-05T10:00:00-07:00",
"availability": {
"id": "2021-07-05T10:00:00-07:00",
"localDateTimeStart": "2021-07-05T10:00:00-07:00",
"localDateTimeEnd": "",
"allDay": true,
"openingHours": [
{
"from": "10:00",
"to": "17:00",
}
]
},
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"notes": null,
"deliveryMethods": "VOUCHER",
"voucher": {
"redemptionMethod": "DIGITAL",
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"utcRedeemedAt": null
},
"unitItems": [
{
"uuid": "cfd3968e-b820-4c47-b8da-7912d65eac03",
"unitId": "adults_0e064227-c793-426b-857c-2d1fcba6258",
"resellerReference": null,
"supplierReference": "",
"unit": {
"id": "adults_0e064227-c793-426b-857c-2d1fcba6258",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba6258" ]
}
},
"status": "CONFIRMED",
"utcRedeemedAt": null,
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"ticket": {
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"redemptionMethod": "DIGITAL",
"utcRedeemedAt": null
}
}
]
}
Example Request:
{
"resellerReference": "VOUCHER-0123",
"contact": {
"fullName": "Muddy Waters",
"emailAddress": "info@zaui.com",
"phoneNumber": "+1604-566-9284",
"locales": ["en-GB", "en-US", "en"],
"country": "CA"
}
}
Bookings - Cancel
DELETE
https://api.zaui.io/octo/bookings/{uuid}/cancel
This endpoint will cancel a booking confirmed in the supplier system or release availability placed on hold.
Path Parameters
Request Body
{
"id": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"uuid": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"testMode": true,
"supplierReference": "X4CJGE6",
"status": "CANCELLED",
"resellerReference": null,
"utcCreatedAt": "2021-04-10T09:00:52-07:00",
"utcUpdatedAt": "2021-04-10T09:00:52-07:00",
"utcExpiresAt": null,
"utcRedeemedAt": null,
"utcConfirmedAt": null,
"productId": "846c36a4-8cb7-4abb-afff-944be62aa312",
"product": {
"id": "846c36a4-8cb7-4abb-afff-944be62aa312",
"internalName": "Wilderness Tour",
"reference": null,
"locale": "en",
"timeZone": "America/Vancouver",
"allowFreesale": false,
"instantConfirmation": true,
"instantDelivery": true,
"availabilityRequired": true,
"availabilityType": "OPENING_HOURS",
"deliveryFormats": [
"PDF_URL",
"QRCODE"
],
"deliveryMethods": [
"TICKET",
"VOUCHER"
],
"redemptionMethod": "DIGITAL",
"options": [
{
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
}
]
},
"optionId": "DEFAULT",
"option": {
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
},
"cancellable": true,
"cancellation": {
"refund": "FULL",
"reason": "Guest sickness",
"utcCancelledAt": "2021-04-10T09:00:52-07:00"
},
"freesale": false,
"availabilityId": "2021-07-05T10:00:00-07:00",
"availability": {
"id": "2021-07-05T10:00:00-07:00",
"localDateTimeStart": "2021-07-05T10:00:00-07:00",
"localDateTimeEnd": "",
"allDay": true,
"openingHours": [
{
"from": "10:00",
"to": "17:00",
}
]
},
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"notes": null,
"deliveryMethods": "VOUCHER",
"voucher": {
"redemptionMethod": "DIGITAL",
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": ""
}
],
"utcRedeemedAt": null
},
"unitItems": [
{
"uuid": "83af6d2c-1c35-4728-ac03-3418a75c5579",
"unitId": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"resellerReference": null,
"supplierReference": "",
"unit": {
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
},
"status": "CANCELLED",
"utcRedeemedAt": null,
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"ticket": {
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": ""
}
],
"redemptionMethod": "DIGITAL",
"utcRedeemedAt": null
}
}
]
}
Example Request:
{
"reason": "CUSTOMER_REQUESTED",
"reasonDetails": "Child came down with the flu the day before the activity."
}
Bookings - Extend Reservation
POST
https://api.zaui.io/octo/bookings/{uuid}/extend
This endpoint will extend the availability hold or expirationMinutes
if the booking status is ON_HOLD
.
Path Parameters
Request Body
{
"id": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"uuid": "e9f0e272-a966-4f74-bea2-c290218d4f83 ",
"testMode": true,
"supplierReference": "XY7N19VOU3",
"status": "ON_HOLD",
"resellerReference": null,
"utcCreatedAt": "2021-04-10T09:00:52-07:00",
"utcUpdatedAt": "2021-04-10T09:00:52-07:00",
"utcExpiresAt": "2021-04-10T09:05:52-07:00",
"utcRedeemedAt": null,
"utcConfirmedAt": null,
"productId": "846c36a4-8cb7-4abb-afff-944be62aa312",
"product": {
"id": "846c36a4-8cb7-4abb-afff-944be62aa312",
"internalName": "Wilderness Tour",
"reference": null,
"locale": "en",
"timeZone": "America/Vancouver",
"allowFreesale": false,
"instantConfirmation": true,
"instantDelivery": true,
"availabilityRequired": true,
"availabilityType": "OPENING_HOURS",
"deliveryFormats": [
"PDF_URL",
"QRCODE"
],
"deliveryMethods": [
"TICKET",
"VOUCHER"
],
"redemptionMethod": "DIGITAL",
"options": [
{
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
}
]
},
"optionId": "DEFAULT",
"option": {
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
},
"cancellable": true,
"cancellation": null,
"freesale": false,
"availabilityId": "2021-07-05T10:00:00-07:00",
"availability": {
"id": "2021-07-05T10:00:00-07:00",
"localDateTimeStart": "2021-07-05T10:00:00-07:00",
"localDateTimeEnd": "",
"allDay": true,
"openingHours": [
{
"from": "10:00",
"to": "17:00",
}
]
},
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"notes": null,
"deliveryMethods": "VOUCHER",
"voucher": {
"redemptionMethod": "DIGITAL",
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"utcRedeemedAt": null
},
"unitItems": [
{
"uuid": "83af6d2c-1c35-4728-ac03-3418a75c5579",
"unitId": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"resellerReference": null,
"supplierReference": "",
"unit": {
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
},
"status": "ON_HOLD",
"utcRedeemedAt": null,
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"ticket": {
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"redemptionMethod": "DIGITAL",
"utcRedeemedAt": null
}
}
]
}
Booking - Update
PATCH
https://api.zaui.io/octo/bookings/{uuid}
This endpoint allows updating an existing booking. The request parameters are the same as the POST /bookings reserve endpoint.
Path Parameters
Request Body
{
"id": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"uuid": "e9f0e272-a966-4f74-bea2-c290218d4f83 ",
"testMode": true,
"supplierReference": "XYN887FS",
"status": "ON_HOLD",
"resellerReference": null,
"utcCreatedAt": "2021-04-10T09:00:52-07:00",
"utcUpdatedAt": "2021-04-10T09:00:52-07:00",
"utcExpiresAt": "2021-04-10T09:05:52-07:00",
"utcRedeemedAt": null,
"utcConfirmedAt": null,
"productId": "846c36a4-8cb7-4abb-afff-944be62aa312",
"product": {
"id": "846c36a4-8cb7-4abb-afff-944be62aa312",
"internalName": "Wilderness Tour",
"reference": null,
"locale": "en",
"timeZone": "America/Vancouver",
"allowFreesale": false,
"instantConfirmation": true,
"instantDelivery": true,
"availabilityRequired": true,
"availabilityType": "OPENING_HOURS",
"deliveryFormats": [
"PDF_URL",
"QRCODE"
],
"deliveryMethods": [
"TICKET",
"VOUCHER"
],
"redemptionMethod": "DIGITAL",
"options": [
{
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
}
]
},
"optionId": "DEFAULT",
"option": {
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
},
"cancellable": true,
"cancellation": {
"refund": "FULL",
"reason": "Guest sickness",
"utcCancelledAt": ""
},
"freesale": false,
"availabilityId": "2021-07-05T10:00:00-07:00",
"availability": {
"id": "2021-07-05T10:00:00-07:00",
"localDateTimeStart": "2021-07-05T10:00:00-07:00",
"localDateTimeEnd": "",
"allDay": true,
"openingHours": [
{
"from": "10:00",
"to": "17:00",
}
]
},
"contact": {
"fullName": "Chris Smith",
"firstName": "Chris",
"lastName": "Smith",
"emailAddress": "csmith@zaui.com",
"phoneNumber": "+1 503 405 4920",
"locales": [],
"country": null,
"notes": null
},
"notes": null,
"deliveryMethods": "VOUCHER",
"voucher": {
"redemptionMethod": "DIGITAL",
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"utcRedeemedAt": null
},
"unitItems": [
{
"uuid": "83af6d2c-1c35-4728-ac03-3418a75c5579",
"unitId": "adults",
"resellerReference": null,
"supplierReference": "",
"unit": {
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
},
"status": "ON_HOLD",
"utcRedeemedAt": null,
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"ticket": {
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"redemptionMethod": "DIGITAL",
"utcRedeemedAt": null
}
}
]
}
Get Booking
GET
https://api.zaui.io/octo/bookings/{uuid}/
This endpoint will retrieve the booking object from Zaui, if the booking is associated with your reseller account
Path Parameters
{
"id": "e9f0e272-a966-4f74-bea2-c290218d4f83 ",
"uuid": "e9f0e272-a966-4f74-bea2-c290218d4f83 ",
"testMode": true,
"supplierReference": "XYNY58F",
"status": "CONFIRMED",
"resellerReference": null,
"utcCreatedAt": "2021-04-10T09:00:52-07:00",
"utcUpdatedAt": "2021-04-10T09:00:52-07:00",
"utcExpiresAt": null,
"utcRedeemedAt": null,
"utcConfirmedAt": null,
"productId": "846c36a4-8cb7-4abb-afff-944be62aa312",
"product": {
"id": "846c36a4-8cb7-4abb-afff-944be62aa312",
"internalName": "Wilderness Tour",
"reference": null,
"locale": "en",
"timeZone": "America/Vancouver",
"allowFreesale": false,
"instantConfirmation": true,
"instantDelivery": true,
"availabilityRequired": true,
"availabilityType": "OPENING_HOURS",
"deliveryFormats": [
"PDF_URL",
"QRCODE"
],
"deliveryMethods": [
"TICKET",
"VOUCHER"
],
"redemptionMethod": "DIGITAL",
"options": [
{
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
}
]
},
"optionId": "DEFAULT",
"option": {
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
},
"cancellable": true,
"cancellation": null,
"freesale": false,
"availabilityId": "2021-07-05T10:00:00-07:00",
"availability": {
"id": "2021-07-05T10:00:00-07:00",
"localDateTimeStart": "2021-07-05T10:00:00-07:00",
"localDateTimeEnd": "",
"allDay": true,
"openingHours": [
{
"from": "10:00",
"to": "17:00",
}
]
},
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"notes": null,
"deliveryMethods": ["VOUCHER"],
"voucher": {
"redemptionMethod": "DIGITAL",
"deliveryOptions": [
"deliveryFormat": "PDF_URL",
"deliveryValue": "https://api.zauimock.com/octo/pdf?booking=40472"
],
"utcRedeemedAt": null
},
"unitItems": [
{
"uuid": "83af6d2c-1c35-4728-ac03-3418a75c5579",
"unitId": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"resellerReference": null,
"supplierReference": "",
"unit": {
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
},
"status": "CONFIRMED",
"utcRedeemedAt": null,
"contact": {
"fullName": null,
"firstName": null,
"lastName": null,
"emailAddress": null,
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"ticket": {
"deliveryOptions": [
"deliveryFormat": "PDF_URL",
"deliveryValue": "https://api.zauimock.com/octo/pdf?booking=40472"
],
"redemptionMethod": "DIGITAL",
"utcRedeemedAt": null
}
}
]
}
{
"error": "INVALID_BOOKING_UUID",
"errorMessage": "Invalid booking UUID passed",
"bookingId": ""
}
List Bookings
GET
https://api.zaui.io/octo/bookings/
This endpoint will fetch the bookings you have made for the given filters. You must use one of the below query parameters. Note, localDateStart + localDateEnd must be used as a pair.
Query Parameters
{
"error": "BAD_REQUEST",
"errorMessage": "One or more required parameters are missing"
}
[
{
"id": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"uuid": "e9f0e272-a966-4f74-bea2-c290218d4f83",
"testMode": true,
"supplierReference": "X4CJGE6",
"status": "CONFIRMED",
"resellerReference": null,
"utcCreatedAt": "2021-04-14T13:42:27-07:00",
"utcUpdatedAt": "2021-04-14T13:42:27-07:00",
"utcExpiresAt": "2021-04-14T13:47:27-07:00",
"utcRedeemedAt": null,
"utcConfirmedAt": null,
"productId": "846c36a4-8cb7-4abb-afff-944be62aa312",
"product": {
"id": "846c36a4-8cb7-4abb-afff-944be62aa312",
"internalName": "Wilderness Tour",
"reference": null,
"locale": "en",
"timeZone": "America/Vancouver",
"allowFreesale": false,
"instantConfirmation": true,
"instantDelivery": true,
"availabilityRequired": true,
"availabilityType": "OPENING_HOURS",
"deliveryFormats": [
"PDF_URL",
"QRCODE"
],
"deliveryMethods": [
"TICKET",
"VOUCHER"
],
"redemptionMethod": "DIGITAL",
"options": [
{
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
}
]
},
"optionId": "DEFAULT",
"option": {
"id": "DEFAULT",
"default": true,
"internalName": "Stanard Tour 10:00",
"reference": null,
"availabilityLocalStartTimes": [
"10:00"
],
"cancellationCutoff": "24 hours",
"cancellationCutoffAmount": 24,
"cancellationCutoffUnit": "hour",
"requiredContactFields": [],
"restrictions": {
"minUnits": 0,
"maxUnits": null
},
"units": [
{
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": [ "adults_0e064227-c793-426b-857c-2d1fcba62582" ]
}
}
]
},
"cancellable": true,
"cancellation": null,
"freesale": false,
"availabilityId": "2021-07-05T10:00:00-07:00",
"availability": {
"id": "2021-07-05T10:00:00-07:00",
"localDateTimeStart": "2021-07-05T10:00:00-07:00",
"localDateTimeEnd": "",
"allDay": true,
"openingHours": [
{
"from": "10:00",
"to": "17:00"
}
]
},
"contact": {
"fullName": "Yuri Belcher",
"firstName": "Yuri",
"lastName": "Belcher",
"emailAddress": "info@zaui.com",
"phoneNumber": "",
"locales": [],
"country": null,
"notes": null
},
"notes": null,
"deliveryMethods": [
"TICKET",
"VOUCHER"
],
"voucher": {
"redemptionMethod": "DIGITAL",
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"utcRedeemedAt": null
},
"unitItems": [
{
"uuid": "83af6d2c-1c35-4728-ac03-3418a75c5579",
"unitId": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"resellerReference": null,
"supplierReference": null,
"unit": {
"id": "adults_0e064227-c793-426b-857c-2d1fcba62582",
"internalName": "adult",
"reference": "adult",
"type": "ADULT",
"requiredContactFields": [],
"restrictions": {
"minAge": 18,
"maxAge": 100,
"idRequired": false,
"minQuantity": null,
"maxQuantity": null,
"paxCount": 1,
"accompaniedBy": []
}
},
"status": "CONFIRMED",
"utcRedeemedAt": null,
"contact": {
"fullName": "Marlon Brando",
"firstName": "Marlon",
"lastName": "Brando",
"emailAddress": "test@zaui.com",
"phoneNumber": null,
"locales": [],
"country": null,
"notes": null
},
"ticket": {
"deliveryOptions": [
{
"deliveryFormat": "QRCODE",
"deliveryValue": "%^5bdcd3c0d4d24ae3e71b3b452a024c6324c7e4bb^58902_A2829|2022-04-30|10:00:00|^%"
}
],
"redemptionMethod": "DIGITAL",
"utcRedeemedAt": null
}
}
]
}
//... additional bookings returned here
]
When using this endpoint you must include one of the following parameters:
resellerReference
- The reference number from your platformsupplierReference
- The booking reference number from the supplierlocalDate
- Local travel datelocalDateStart
andlocalDateEnd
- local travel start/end dates
Additional optional parameters for further filtering include:
productId
- a single product ID bookedoptionId
- a single optionId as part of the booking
Last updated