Get Booking Details Reporting Endpoint#

The following section describes how to retrieve the booking details of a booking made by a user.


Path

GET /reporting/v1/bookings/{id}


Input parameters

Field

Mandatory

Data Type

Format

Description

Example

id

Y

UUID

Unique booking Id in a UUID format (path variable)

fe6feb42-ec26-4625-835c-03a25e54a0e2

Output

Field

Data Type

format

Description

Example

partnerChannelName

varchar

N/A

Name of the partner channel used for the booking

AmadeusAPI

partnerId

varchar

N/A

Partner id used for the booking

123ABCD

price.gross

numeric

N/A

Gross Price for the activity booked

119.4

price.net

numeric

N/A

Net Price for the activity booked

114.4

price.currency

varchar

N/A

Currency of the price for the activity booked

EUR

paxBooked

numeric

N/A

Number of participants booked for the activity

3

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

activityEndDate

timestamp

yyyy-MM-dd’T’HH:mm:ss’Z’

Date and time when the activity that was booked ends. Dates are in UTC

2024-12-01T11:00:00Z

status

varchar

N/A

Status of the booking (PENDING_CONFIRM, CONFIRMED, REJECTED, CANCELLED, REDEEMED)

CONFIRMED

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

flowType

varchar

N/A

Flow used to perform the booking (REDIRECTION/WIDGET, BOOKING_FLOW)

BOOKING_FLOW

isCancellable

boolean

N/A

Flag to identify if the booking is cancellable

TRUE

product.id

Long

N/A

Amadeus unique id of the activity booked

57933276

product.externalId

varchar

N/A

Supplier id of the activity booked

df08ebb8

product.title

varchar

N/A

Title of the activity booked

Entrance ticket to the Opéra Garnier

options

Map

N/A

Map of options

cancellationInformation.cancellationRequestDateTime

timestamp

yyyy-MM-dd’T’HH:mm:ss.SSS’Z’

Cancellation request date and time, in the case of a booking performed and cancelled through Amadeus Discover Platform’s booking flow

2024-11-03T22:00:19.123Z

cancellationInformation.cancellationReason

varchar

N/A

Reason for the cancellation, in the case of a booking performed and cancelled through Amadeus Discover Platform’s booking flow

The customer changed his mind

cancellationInformation.cancellation.cancellationPolicy

List

N/A

List of cancellation policies for the booking at booking time in the case of a booking performed and cancelled through Amadeus Discover Platform’s booking flow

cancellationInformation.cancellation.cancellationPolicy[0].label

varchar

N/A

Label of the cancellation policy

No refund is possible if you cancel less than 24 hours before the activity start time.

cancellationInformation.cancellation.cancellationPolicy[0].refundPrecentage

numeric

N/A

Refund percentage for the cancellation policy

0

cancellationInformation.cancellation.cancellationPolicy[0].duration

varchar

ISO8601 duration (P(n)Y(n)M(n)DT(n)H(n)M(n)S)

Duration of the cancellation policy from the activity start time

P1D

Response Body
{
    "id": "4b2d61c6-1f5c-4f9f-bdb7-cae5d2d4c746",
    "bookingCode": "BFZBDS",
    "bookingExternalId": "9cec2f26-1515-464d-9107-ab3103d5180f",
    "bookingEngineName": "HOLIBOB_VIATOR",
    "testMode": true,
    "status": "CONFIRMED",
    "bookedAt": "2025-03-19T07:14:17Z",
    "confirmedAt": "2025-03-19T07:14:48Z",
    "voucherCreatedAt": "2025-03-19T07:14:40Z",
    "activityStartDate": "2025-05-13T10:00:00Z",
    "partnerId": "4b2d61c6-1f5c-4f9f-bdb7-cae5d2d4c746",
    "isCancellable": true,
    "paxBooked": 4,
    "options": {
        "availabilityOptions": [
            {
                "id": "82dacae4-0716-4d9f-a94e-9259b65aae30",
                "label": "Start Time",
                "level": "0",
                "dataType": "OPTIONS",
                "optionChoices": {
                    "09:00": "09:00",
                    "10:00": "10:00",
                    "12:00": "12:00",
                    "14:00": "14:00",
                    "16:00": "16:00"
                },
                "selectedOptionId": "12:00",
                "selectedOptionValue": "12:00"
            },
            {
                "id": "c4b6c447-5a0b-44df-a9a9-9b6ecef91f7a",
                "label": "Guide language",
                "level": "1",
                "dataType": "OPTIONS",
                "optionChoices": {
                    "en-GUIDE": "EN - GUIDE"
                },
                "selectedOptionId": "en-GUIDE",
                "selectedOptionValue": "EN - GUIDE"
            }
        ]
    },
    "price": {
        "gross": 81.6,
        "net": 69.2,
        "currency": "EUR"
    },
    "product": {
        "externalId": "0a611416-16ad-4105-b3a8-f74518de968d",
        "title": "Berlin: Third Reich and Cold War Walking Tour"
    },
    "cancellationInformation": {
        "cancellation": {
            "cancellationPolicy": [
                {
                "label": "A full refund will apply if you cancel more than 24 hours before the activity start time.",
                "refundPercentage": 100
                },
                {
                "label": "No refund is possible if you cancel less than 24 hours before the activity start time.",
                "duration": "P1D",
                "refundPercentage": 0
                }
            ]
        }
    },
    "flowType": "BOOKING_FLOW",
    "partnerChannelName": "AmadeusAPI"
}

Status Codes

HTTP Code

Code Description

200

Successful retrieval of booking details

400

Wrong format for booking id

401

Unauthorized

403

Forbidden

404

Booking not found for specified booking id

500

Internal server error