Get Booking List Reporting Endpoint#
The following section describes how to retrieve the list of all bookings made by a user.
Path
GET /reporting/v1/bookings
Input parameters
Field |
Mandatory |
Data Type |
Format |
Description |
Example |
|---|---|---|---|---|---|
status |
N |
Status of the booking (PENDING_CONFIRM, CONFIRMED, REJECTED, CANCELLED, REDEEMED) |
CONFIRMED |
||
cancelledEndDate |
N |
Date |
yyyy-MM-dd |
Filter to include the bookings which were cancelled until a specific date |
2024-11-12 |
cancelledStartDate |
N |
Date |
yyyy-MM-dd |
Filter to include the bookings which were cancelled from a specific date |
2024-11-11 |
confirmedEndDate |
N |
Date |
yyyy-MM-dd |
Filter to include the bookings which were confirmed until a specific date |
2024-11-15 |
confirmedStartDate |
N |
Date |
yyyy-MM-dd |
Filter to include the booking which were confirmed from a specific date |
2024-11-14 |
testMode |
N |
This is a flag to filter the bookings by identifying any test bookings that were made. this could be true/false/empty |
FALSE |
||
bookedStartDate |
N |
Date |
yyyy-MM-dd |
This refers to the date when the booking is made. It filteres the bookings which were booked from the specified date. By default - results ordered by booking creation date |
2024-11-12 |
bookedEndDate |
N |
Date |
yyyy-MM-dd |
Filter to include all bookings performed until a specific date |
2024-11-13 |
bookingCode |
N |
Only applicable to Holibob: user friendly booking code from Holibob |
PSMEX9 |
||
bookingExternalId |
N |
Booking Id as provided by the supplier |
fe6feb42-ec26-4625-835c-03a25e54a0e2 |
||
bookingEngineName |
N |
Supplier name of the activity |
HOLIBOB_VIATOR |
||
page[offset] |
N |
Long |
The start index of the requested page. Default value is ‘0’ |
||
page[limit] |
N |
Integer |
page[limit]: the maximum items in one page. Default value = 100, max = 500 |
Output
Field |
Data Type |
format |
Description |
Example |
|---|---|---|---|---|
partnerChannelName |
varchar |
N/A |
Name of the partner channel used for the booking |
AmadeusAPI |
priceCurrency |
varchar |
N/A |
Currency of the price for the activity booked |
EUR |
activityStartDate |
timestamp |
yyyy-MM-dd’T’HH:mm:ss’Z’ |
Date and time when the activity is booked for. Dates are in UTC |
2024-12-01T09:00:00Z |
priceGross |
numeric |
N/A |
Gross Price for the activity booked |
119.4 |
status |
varchar |
N/A |
Status of the booking (PENDING_CONFIRM, CONFIRMED, REJECTED, CANCELLED, REDEEMED) |
CONFIRMED/CANCELLED |
bookedAt |
timestamp |
yyyy-MM-dd’T’HH:mm:ss’Z’ |
Date and time when the activity is booked. Dates are in UTC |
2024-11-03T21:15:19Z |
voucherCreatedAt |
timestamp |
yyyy-MM-dd’T’HH:mm:ss’Z’ |
Date and time when the voucher is created. Dates are in UTC |
2024-11-03T22:10:19Z |
cancelledAt |
timestamp |
yyyy-MM-dd’T’HH:mm:ss’Z’ |
Date and time when the booking is cancelled (if so). Dates are in UTC |
2024-11-03T23:00:19Z |
confirmedAt |
timestamp |
yyyy-MM-dd’T’HH:mm:ss’Z’ |
Date and time when the booking is confirmed. Dates are in UTC |
2024-11-03T22:00:19Z |
testMode |
boolean |
N/A |
True/false/empty flag to identify if a booking is made in a testing environment |
FALSE |
bookingCode |
varchar |
N/A |
Only applicable to Holibob user friendly booking code |
PSMEX9 |
bookingExternalId |
varchar |
N/A |
Booking Id provided by the supplier |
fe6feb42-ec26-4625-835c-03a25e54a0e2 |
id |
uuid |
N/A |
Unique booking id from Amadeus |
df08ebb8-ffd4-420e-8d84-c72b2e0ae29b |
bookingEngineName |
varchar |
N/A |
Name of the supplier |
HOLIBOB_VIATOR |
productId |
Long |
N/A |
Amadeus unique id of the product booked |
57933276 |
meta.count |
Long |
N/A |
meta.count: total number of elements |
781 |
meta.page.count |
Integer |
N/A |
meta.page.count: number of elements in the current page |
5 |
meta.page.offset |
Long |
N/A |
meta.page.offset: current offset |
200 |
meta.page.limit |
Integer |
N/A |
meta.page.limit: max number of elements per page |
5 |
Response Body
{
"meta": {
"count": 781,
"page": {
"count": 5,
"offset": 200,
"limit": 5
},
"sort": [],
"links": {
"self": "http://<host>/reporting/v1/bookings?bookedStartDate=2025-01-01&page%5Blimit%5D=5&page%5Boffset%5D=200",
"next": "http://<host>/reporting/v1/bookings?bookedStartDate=2025-01-01&page%5Blimit%5D=5&page%5Boffset%5D=205",
"last": "http://<host>/reporting/v1/bookings?bookedStartDate=2025-01-01&page%5Blimit%5D=5&page%5Boffset%5D=780"
}
},
"data": [
{
"id": "1b28687e-9c87-46fe-bc21-7dce6715dab8",
"bookingCode": "XR2BWK",
"bookingExternalId": "cf3a0b2b-9fa8-4d03-bcf6-b89925e85ffe",
"bookingEngineName": "HOLIBOB",
"testMode": true,
"status": "CONFIRMED",
"bookedAt": "2025-01-13T13:48:15Z",
"confirmedAt": "2025-01-13T13:48:39Z",
"voucherCreatedAt": "2025-01-13T13:48:32Z",
"activityStartDate": "2025-01-24T23:00:00Z",
"priceGross": 1110,
"priceCurrency": "EUR"
},
{
"id": "9a17ffdc-a3d8-414d-b911-fa54e8b9c852",
"bookingCode": "6A5N9X",
"bookingExternalId": "0ce783d9-a7e7-40b4-bdf9-bfa2e5355e2d",
"bookingEngineName": "HOLIBOB_VIATOR",
"testMode": false,
"status": "CONFIRMED",
"bookedAt": "2025-01-13T17:18:50Z",
"confirmedAt": "2025-01-13T17:20:26Z",
"voucherCreatedAt": "2025-01-13T17:20:17Z",
"activityStartDate": "2025-04-10T22:00:00Z",
"priceGross": 584,
"priceCurrency": "NZD"
},
{
"id": "2bd710e5-820c-4848-8765-47147a3938de",
"bookingCode": "0DTVK8",
"bookingExternalId": "619deeaa-5222-4717-8945-f95c1f0b8842",
"bookingEngineName": "HOLIBOB_VIATOR",
"testMode": false,
"status": "CONFIRMED",
"bookedAt": "2025-01-13T17:49:47Z",
"confirmedAt": "2025-01-13T17:51:35Z",
"voucherCreatedAt": "2025-01-13T17:51:28Z",
"activityStartDate": "2025-06-28T22:00:00Z",
"priceGross": 167.4,
"priceCurrency": "NZD"
},
{
"id": "5a9c6ec2-79dc-4fc6-bc63-804909123649",
"bookingCode": "83CXSF",
"bookingExternalId": "8616b08d-2f12-418d-82a1-e9a2bbe5a834",
"bookingEngineName": "HOLIBOB_VIATOR",
"testMode": false,
"status": "CONFIRMED",
"bookedAt": "2025-01-13T17:52:07Z",
"confirmedAt": "2025-01-13T17:53:08Z",
"voucherCreatedAt": "2025-01-13T17:53:05Z",
"activityStartDate": "2025-06-29T22:00:00Z",
"priceGross": 223.2,
"priceCurrency": "NZD"
},
{
"id": "b6dd67c2-e3b2-4356-86b9-52fb985bfdfe",
"bookingExternalId": "1234567",
"bookingEngineName": "GURUWALK",
"status": "CONFIRMED",
"bookedAt": "2025-01-13T17:53:36Z",
"priceGross": 0.0,
"priceCurrency": "EUR"
}
]
}
Status Codes
HTTP Code |
Code Description |
|---|---|
200 |
Successful retrieval of bookings |
400 |
Wrong filter expression |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Internal server error |