BookingDetail

The BookingDetail operation allows to retrieve a booking with all its details from the booking reference locator.

BookingDetail Request

Endpoint

GET https://api.test.hotelbeds.com/transfer-api/1.0/booking/{{language}}/reference/{{booking_reference}}
TIMEOUT: 120 seconds

 

Request parameters

Parameter

Type

Mandatory

Description

language

String

Y

Requested language code

booking_reference

String

Y

Booking reference number taken from the confirmation response or from the booking list function
Format: XXX.XXXXXX

Request Example

https://api.test.hotelbeds.com/transfer-api/1.0/booking/en/reference/1.4133975

 

BookingDetail Response

The response of BookingDetail provides key information of the booking in the same format as Booking response, including:

  • Transfer confirmed
  • Rate confirmed with the confirmed amounts and dates
  • Holder and passengers

Information of cancelled bookings can also be retrieved with BookingDetail, although names and surnames of passengers of cancelled bookings are not shown, as cancellation process deletes names of passengers and only passanger types remain in the passenger list of each room.

Response Parameters

Node/Attribute Type Description
bookingDetailRS Element Top level
bookingDetailRS/bookings Array of booking elements List of bookings.
NOTE: in confirmation step you'll always will receive only one booking in this array.
bookingDetailRS/bookings/booking Element Booking information
bookingDetailRS/bookings/booking/reference String

Booking reference.
Format: XXX.XXXXXX

bookingDetailRS/bookings/booking/creationDate Date Booking creation date.
Format: YYYY-MM-DD
bookingDetailRS/bookings/booking/status

Booking status.

  • CONFIRMED
  • CANCELLED
  • MODIFIED
bookingDetailRS/bookings/booking/modificationsPolicies Element Information regarding the allowed modifications to the booking
bookingDetailRS/bookings/booking/modificationsPolicies/cancellation Boolean Indicates if the booking can be cancelled
bookingDetailRS/bookings/booking/modificationsPolicies/modification Boolean Indicates if the booking can be modified
bookingDetailRS/bookings/booking/leadPax Element Booking lead passenger/holder information
bookingDetailRS/bookings/booking/leadPax/title String Given title of the lead passenger
bookingDetailRS/bookings/booking/leadPax/name String First name of the lead passenger
bookingDetailRS/bookings/booking/leadPax/surname String Last name of the lead passenger
bookingDetailRS/bookings/booking/leadPax/email String Lead passenger contact email
bookingDetailRS/bookings/booking/leadPax/phone String Lead passenger contact phone number
bookingDetailRS/bookings/booking/leadPax/type String

Passenger type. Possible values:

  • ADULT
  • CHILD
  • INFANT
bookingDetailRS/bookings/booking/leadPax/age String Passenger age
bookingDetailRS/bookings/booking/transfers Array of transfer elements List of reserved transfer services
bookingDetailRS/bookings/booking/transfers/transfer Element Information of one reserved transfer service
bookingDetailRS/bookings/booking/transfers/transfer/id Int Transfer service id code
bookingDetailRS/bookings/booking/transfers/transfer/direction String

Direction of travel. Possible values:

  • DEPARTURE
  • RETURN
bookingDetailRS/bookings/booking/transfers/transfer/transferType String

Transfer type. Possible values:

  • SHARED
  • PRIVATE
bookingDetailRS/bookings/booking/transfers/transfer/vehicle Element Information of the vehicle
bookingDetailRS/bookings/booking/transfers/transfer/vehicle/code String Vehicle code id
bookingDetailRS/bookings/booking/transfers/transfer/vehicle/name String Vehicle name
bookingDetailRS/bookings/booking/transfers/transfer/category Element Service category information
bookingDetailRS/bookings/booking/transfers/transfer/category/code String Category code
bookingDetailRS/bookings/booking/transfers/transfer/category/name String Category name
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation Element Information regarding the pickUp locations
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/from Element Information regarding the pickUp origin location
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/from/code String Code of the pickUp origin location
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/from/description String Description of the pickUp origin location
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/from/type String

PickUp origin location code type. Possible values:

  • GIATA
  • ATLAS
  • IATA
  • PORT
  • STATION
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/to Element Information regarding the pickUp destination location
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/to/code String Code of the pickUp destination location
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/to/description String Description of the pickUp destination location
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/to/type String

PickUp destination location code type. Possible values:

  • GIATA
  • ATLAS
  • IATA
  • PORT
  • STATION
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/date String Pickup date
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/time String Pickup time
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup Element Information of the pickup
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/address String Physical address of the pickup
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/number String Number of the address of the pickup
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/town String City name of the address of the pickup
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/zip String Postal code of the address of the pickup
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/description String Pickup description an instrucctions to reach the place
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/altitude String Elevation from sea level
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/latitude String Latitude data for geolocation
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/longitude String Longitude data for geolocation
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/order String Order of the pickUp
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/useWebCheckpickup Boolean Indicates if the provider offers website for checkin
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/pickupId Int Id of the pickup
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/stopName String Name of the stop where the pickup takes place
bookingDetailRS/bookings/booking/transfers/transfer/pickupInformation/pickup/image String Image/map to help locate the pickup
bookingDetailRS/bookings/booking/transfers/transfer/minPaxCapacity Int Mininum number of passengers needed to book the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/maxPaxCapacity Int Passenger limit of the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/paxes Array of pax elements Collection of passengers in the reservation
bookingDetailRS/bookings/booking/transfers/transfer/paxes/pax Element Passenger information
bookingDetailRS/bookings/booking/transfers/transfer/paxes/pax/title String Given title of the lead passenger
bookingDetailRS/bookings/booking/transfers/transfer/paxes/pax/name String Passenger first name
bookingDetailRS/bookings/booking/transfers/transfer/paxes/pax/surname String Passenger last name
bookingDetailRS/bookings/booking/transfers/transfer/paxes/pax/email String Passenger contact email
bookingDetailRS/bookings/booking/transfers/transfer/paxes/pax/phone String Passenger contact phone number
bookingDetailRS/bookings/booking/transfers/transfer/paxes/pax/type String

Passenger type. Possible values:

  • ADULT
  • CHILD
  • INFANT
bookingDetailRS/bookings/booking/transfers/transfer/paxes/pax/age String Passenger age
bookingDetailRS/bookings/booking/transfers/transfer/content Element Static information of the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/content/vehicle Element Information of the vehicle used in the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/content/vehicle/code String Vehicle code used in the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/content/vehicle/name String Name of the type of the vehicle used in the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/content/category Element Information of the category of the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/content/category/code String Category code of the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/content/category/name String Category name of the ttransfer service category
bookingDetailRS/bookings/booking/transfers/transfer/content/images Array of image elements List of transfer pictures
bookingDetailRS/bookings/booking/transfers/transfer/content/images/image Element Image information
bookingDetailRS/bookings/booking/transfers/transfer/content/images/image/url String Path of the picture file
bookingDetailRS/bookings/booking/transfers/transfer/content/images/image/type String

Type name of the picture. Possible values:

  • SMALL
  • MEDIUM
  • LARGE
  • EXTRALARGE
bookingDetailRS/bookings/booking/transfers/transfer/content/transferDetailInfos Array of transferDetailInfo elements Collection of detailed information about the transfer
bookingDetailRS/bookings/booking/transfers/transfer/content/transferDetailInfos/transferDetailInfo Element Transfer detailed information
bookingDetailRS/bookings/booking/transfers/transfer/content/transferDetailInfos/transferDetailInfo/id String Information id
bookingDetailRS/bookings/booking/transfers/transfer/content/transferDetailInfos/transferDetailInfo/name String Information name
bookingDetailRS/bookings/booking/transfers/transfer/content/transferDetailInfos/transferDetailInfo/description String Details and information on the transfer
bookingDetailRS/bookings/booking/transfers/transfer/content/transferDetailInfos/transferDetailInfo/type String

Transfer detail info type. Possible values:

  • GENERAL_INFO
  • GENERIC_GUIDELINES
bookingDetailRS/bookings/booking/transfers/transfer/content/customerTransferTimeInfo Array of Information of the customer transfer time
bookingDetailRS/bookings/booking/transfers/transfer/content/customerTransferTimeInfo/TransferTimeInfo TransferTimeInfo element Transfer time details
bookingDetailRS/bookings/booking/transfers/transfer/content/customerTransferTimeInfo/TransferTimeInfo/metric String Time unit type
bookingDetailRS/bookings/booking/transfers/transfer/content/customerTransferTimeInfo/TransferTimeInfo/type String

Transfer time info type. Possible values:

  • MAX_WAIT_TIME
  • MAX_WAIT_TIME_SUP_DOM
  • MAX_WAIT_TIME_SUP_INT
bookingDetailRS/bookings/booking/transfers/transfer/content/customerTransferTimeInfo/TransferTimeInfo/value Int Number of units
bookingDetailRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo Array of supplierTransferTimeInfo elements Information of the supplier transfer time
bookingDetailRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo TransferTimeInfo element Transfer time details
bookingDetailRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/metric String Time unit type
bookingDetailRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/type String

Transfer time info type. Possible values:

  • MAX_WAIT_TIME
  • MAX_WAIT_TIME_SUP_DOM
  • MAX_WAIT_TIME_SUP_INT
bookingDetailRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/value Int Number of units
bookingDetailRS/bookings/booking/transfers/transfer/price Element Price information of the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/price/totalAmount Double Total amount of the booking
bookingDetailRS/bookings/booking/transfers/transfer/price/netAmount Double Net amount of the booking
bookingDetailRS/bookings/booking/transfers/transfer/rateKey String Does not apply on Booking response
bookingDetailRS/bookings/booking/transfers/transfer/cancellationPolicies Array of cancellationPolicy elements List of cancellation policies applied to the transfer service
bookingDetailRS/bookings/booking/transfers/transfer/cancellationPolicies/cancellationPolicy Element Information of the cancellation policy
bookingDetailRS/bookings/booking/transfers/transfer/cancellationPolicies/cancellationPolicy/amount Double Amount to be charged in case booking is cancelled after the date specified in the '@from' field.
bookingDetailRS/bookings/booking/transfers/transfer/cancellationPolicies/cancellationPolicy/from String Date from which the amount will be charged, format ISO 8601 (yyyy-MM-ddTHH:mm:ssZ)
bookingDetailRS/bookings/booking/transfers/transfer/links Array of link elements Information on the navigation links available from the current operation
bookingDetailRS/bookings/booking/transfers/transfer/links/link Element Link information
bookingDetailRS/bookings/booking/transfers/transfer/links/link/rel String Specifies the relationship between the current document and the linked document/resource
bookingDetailRS/bookings/booking/transfers/transfer/links/link/href String Specifies the path of the resource the link goes to
bookingDetailRS/bookings/booking/transfers/transfer/factsheetId Int Content card number associated with the transfer, identifies the relationship between type of vehicle, type of service and type of transfer
bookingDetailRS/bookings/booking/transfers/transfer/arrivalFlightNumber String Flight number of the arrival flight
bookingDetailRS/bookings/booking/transfers/transfer/departureFlightNumber String Flight number of the departure flight
bookingDetailRS/bookings/booking/transfers/transfer/arrivalShipName String Name of the ship on the arrival trip
bookingDetailRS/bookings/booking/transfers/transfer/departureShipName String Name of the ship on the departure trip
bookingDetailRS/bookings/booking/transfers/transfer/arrivalTrainInfo Element Information of the train on the arrival trip
bookingDetailRS/bookings/booking/transfers/transfer/arrivalTrainInfo/trainCompanyName String Train company name
bookingDetailRS/bookings/booking/transfers/transfer/arrivalTrainInfo/trainNumber String Train number
bookingDetailRS/bookings/booking/transfers/transfer/departureTrainInfo Element Information of the train on the departure trip
bookingDetailRS/bookings/booking/transfers/transfer/departureTrainInfo/trainCompanyName String Train company name
bookingDetailRS/bookings/booking/transfers/transfer/departureTrainInfo/trainNumber String Train number
bookingDetailRS/bookings/booking/clientReference String Client internal booking reference
bookingDetailRS/bookings/booking/welcomeMessage String Message the transfer will show to the passenger upon pickup
bookingDetailRS/bookings/booking/remark String Comments.NOTE:The character limit in this field is 2000 characters.
bookingDetailRS/bookings/booking/invoiceCompany Element Element that contains information about the invoice company
bookingDetailRS/bookings/booking/invoiceCompany/code String Code of the invoice company
bookingDetailRS/bookings/booking/invoiceCompany/name String Name of the invoice company
bookingDetailRS/bookings/booking/invoiceCompany/registrationNumber String Registration number of the invoice company
bookingDetailRS/bookings/booking/totalAmount String Registration number of the invoice company
bookingDetailRS/bookings/booking/totalNetAmount String Registration number of the invoice company
bookingDetailRS/bookings/booking/pendingAmount String Registration number of the invoice company
bookingDetailRS/bookings/booking/currency String Registration number of the invoice company

Response JSON Example

{
    "bookings": [
        {
            "reference": "1.4135098",
            "creationDate": "2019-02-18T08:17:34",
            "status": "CONFIRMED",
            "modificationsPolicies": {
                "cancellation": true,
                "modification": true
            },
            "leadPax": {
                "title": "MR",
                "name": "John",
                "surname": "Doe",
                "email": "john.doe@hotelbeds.com",
                "phone": "+16543245812",
                "type": null,
                "age": null
            },
            "transfers": [
                {
                    "id": 1,
                    "direction": "RETURN",
                    "transferType": "PRIVATE",
                    "vehicle": {
                        "code": "CR",
                        "name": null
                    },
                    "category": {
                        "code": "STND",
                        "name": null
                    },
                    "pickupInformation": {
                        "from": {
                            "code": "1523",
                            "description": null,
                            "type": "ATLAS"
                        },
                        "to": {
                            "code": "PMI",
                            "description": null,
                            "type": "IATA"
                        },
                        "date": "2019-12-28",
                        "time": "12:15:11",
                        "pickup": {
                            "address": null,
                            "number": null,
                            "town": null,
                            "zip": null,
                            "description": null,
                            "altitude": null,
                            "latitude": null,
                            "longitude": null,
                            "order": null,
                            "useWebCheckpickup": false,
                            "pickupId": 13171,
                            "stopName": null,
                            "image": null
                        }
                    },
                    "minPaxCapacity": null,
                    "maxPaxCapacity": null,
                    "paxes": [
                        {
                            "title": null,
                            "name": null,
                            "surname": null,
                            "email": null,
                            "phone": null,
                            "type": "ADULT",
                            "age": 30
                        },
                        {
                            "title": null,
                            "name": null,
                            "surname": null,
                            "email": null,
                            "phone": null,
                            "type": "ADULT",
                            "age": 30
                        },
                        {
                            "title": null,
                            "name": null,
                            "surname": null,
                            "email": null,
                            "phone": null,
                            "type": "CHILD",
                            "age": 3
                        }
                    ],
                    "content": null,
                    "price": {
                        "totalAmount": 26.33,
                        "netAmount": 22.85
                    },
                    "rateKey": null,
                    "cancellationPolicies": [
                        {
                            "amount": 26.33,
                            "from": "2019-12-26T00:00:00"
                        }
                    ],
                    "links": null,
                    "factsheetId": 739,
                    "arrivalFlightNumber": null,
                    "departureFlightNumber": "IB4321",
                    "arrivalShipName": null,
                    "departureShipName": null,
                    "arrivalTrainInfo": null,
                    "departureTrainInfo": null
                },
                {
                    "id": 2,
                    "direction": "DEPARTURE",
                    "transferType": "PRIVATE",
                    "vehicle": {
                        "code": "DSBLD",
                        "name": null
                    },
                    "category": {
                        "code": "SPCL",
                        "name": null
                    },
                    "pickupInformation": {
                        "from": {
                            "code": "1523",
                            "description": null,
                            "type": "ATLAS"
                        },
                        "to": {
                            "code": "PMI",
                            "description": "AEROPUERTO",
                            "type": "IATA"
                        },
                        "date": "2019-12-28",
                        "time": "09:55:00",
                        "pickup": {
                            "address": null,
                            "number": null,
                            "town": null,
                            "zip": null,
                            "description": "You will be picked up outside the hotel entrance. If you are unable to locate the driver/agent, please call Destination Services on +34 971 922 694. Languages spoken at the call centre: English, Spanish. Please do not leave the pick-up area without having contacted the agent/driver first.",
                            "altitude": null,
                            "latitude": null,
                            "longitude": null,
                            "order": null,
                            "useWebCheckpickup": false,
                            "pickupId": 13171,
                            "stopName": "OUTSIDE",
                            "image": null
                        }
                    },
                    "minPaxCapacity": null,
                    "maxPaxCapacity": null,
                    "paxes": [
                        {
                            "title": null,
                            "name": null,
                            "surname": null,
                            "email": null,
                            "phone": null,
                            "type": "ADULT",
                            "age": 30
                        },
                        {
                            "title": null,
                            "name": null,
                            "surname": null,
                            "email": null,
                            "phone": null,
                            "type": "ADULT",
                            "age": 30
                        },
                        {
                            "title": null,
                            "name": null,
                            "surname": null,
                            "email": null,
                            "phone": null,
                            "type": "CHILD",
                            "age": 3
                        }
                    ],
                    "content": {
                        "vehicle": {
                            "code": "DSBLD",
                            "name": "Disabled"
                        },
                        "category": {
                            "code": "SPCL",
                            "name": "Special"
                        },
                        "images": [
                            {
                                "url": "http://media.stage.activitiesbank.com/giata/transfers/TRD/small/prvt-spcl-dsbld.png",
                                "type": "SMALL"
                            },
                            {
                                "url": "http://media.stage.activitiesbank.com/giata/transfers/TRD/medium/prvt-spcl-dsbld.png",
                                "type": "MEDIUM"
                            },
                            {
                                "url": "http://media.stage.activitiesbank.com/giata/transfers/TRD/large/prvt-spcl-dsbld.png",
                                "type": "LARGE"
                            },
                            {
                                "url": "http://media.stage.activitiesbank.com/giata/transfers/TRD/extralarge/prvt-spcl-dsbld.png",
                                "type": "EXTRALARGE"
                            }
                        ],
                        "transferDetailInfo": [],
                        "customerTransferTimeInfo": [],
                        "supplierTransferTimeInfo": [
                            {
                                "value": 15,
                                "type": "MAX_WAIT_TIME_SUP_INT",
                                "metric": "minutes"
                            }
                        ]
                    },
                    "price": {
                        "totalAmount": 47.36,
                        "netAmount": 41.11
                    },
                    "rateKey": null,
                    "cancellationPolicies": [
                        {
                            "amount": 47.36,
                            "from": "2019-12-29T00:00:00"
                        }
                    ],
                    "links": null,
                    "factsheetId": 220,
                    "arrivalFlightNumber": "XR1234",
                    "departureFlightNumber": null,
                    "arrivalShipName": null,
                    "departureShipName": null,
                    "arrivalTrainInfo": null,
                    "departureTrainInfo": null
                }
            ],
            "clientReference": "TESTBRUNO",
            "welcomeMessage": null,
            "remark": "Booking remarks go here.",
            "invoiceCompany": {
                "code": "HBD",
                "company": null,
                "registrationNumber": null
            },
            "totalAmount": 73.69,
            "totalNetAmount": 63.96,
            "pendingAmount": 63.96,
            "currency": "EUR"
        }
    ]
}

Docs Navigation