Booking

The Booking operation requests a reservation confirmation for the specified ratekey or ratekeys.

BookingAPI does not support on-request confirmations. All bookings are instant confirmations.

Booking Request

Endpoint

POST https://api.test.hotelbeds.com/transfer-api/1.0/booking DEPRECATED 
POST https://api.test.hotelbeds.com/transfer-api/1.0/bookings NEW
TIMEOUT: 60 seconds

 

Holder and pax names

The booking holder's name and surname are mandatory. Regarding the passenger names we recommend at least one adult name (and surname) per room. Please remember that some destinations (for example Las Vegas or some cities in Russia) require all the names to avoid check in problems.

Request parameters

Node/Attribute

Type

Mandatory

Description

bookingRQ

Element

Y

Top level

bookingRQ/language

String

Y

Requested language code

bookingRQ/holder

Element

Y

Booking holder/lead passenger information

bookingRQ/holder/title

String

Y

DEPRECATED: Given title of the lead passenger

bookingRQ/holder/name

String

Y

Lead passenger first name

bookingRQ/holder/surname

String

Y

Lead passenger last name

bookingRQ/holder/email

String

Y

Lead passenger contact email

bookingRQ/holder/phone

String

Y

Passenger phone number

bookingRQ/holder/type

String

Y

DEPRECATED: Passenger type. Possible values:

  • ADULT
  • CHILD
  • INFANT

bookingRQ/holder/age

String

Y

DEPRECATED: Passenger age

bookingRQ/transfers

Array of transfer elements

Y

List of requested transfer services

bookingRQ/transfers/transfer

Element

Y

Information of one requested transfer service

bookingRQ/transfers/transfer/rateKey

String

Y

Rate key to be confirmed taken from the availability step

bookingRQ/transfers/transfer/pickupInformation Element N NEW: Custom information used to override default pickup information for the confirmation of GPS services
bookingRQ/transfers/transfer/pickupInformation/name String Y NEW:  Pickup address information. NOTE: Mandatory field if the pickupInformation element is sent in the request
bookingRQ/transfers/transfer/pickupInformation/address String Y NEW:  Pickup address information. NOTE: Mandatory field if the pickupInformation element is sent in the request
bookingRQ/transfers/transfer/pickupInformation/town String Y NEW: Pickup address information. NOTE: Mandatory field if the pickupInformation element is sent in the request
bookingRQ/transfers/transfer/pickupInformation/country String Y NEW: Pickup address information. NOTE: Mandatory field if the pickupInformation element is sent in the request
bookingRQ/transfers/transfer/pickupInformation/zip String Y NEW: Pickup address information. NOTE: Mandatory field if the pickupInformation element is sent in the request
bookingRQ/transfers/transfer/dropoffInformation String N NEW: Custom information used to override default dropoff information for the confirmation of GPS services
bookingRQ/transfers/transfer/dropoffInformation/name String Y NEW: Dropoff address information.  NOTE: Mandatory field if the dropoffInformation element is sent in the request
bookingRQ/transfers/transfer/dropoffInformation/address String Y NEW:  Dropoff address information. NOTE: Mandatory field if the dropoffInformation element is sent in the request
bookingRQ/transfers/transfer/dropoffInformation/town String Y NEW:  Dropoff address information. NOTE: Mandatory field if the dropoffInformation element is sent in the request
bookingRQ/transfers/transfer/dropoffInformation/country String Y NEW:  Dropoff address information. NOTE: Mandatory field if the dropoffInformation element is sent in the request
bookingRQ/transfers/transfer/dropoffInformation/zip String Y NEW:  Dropoff address information.  NOTE: Mandatory field if the dropoffInformation element is sent in the request

bookingRQ/transfers/transfer/detail

Element

Y

DEPRECATED: Information about the ride from which the transfer will pick up passengers.

bookingRQ/transfers/transfer/detail/departureFlightNumber

String

N

DEPRECATED: Flight number of the departure flight. NOTE: use it only for flight numbers

bookingRQ/transfers/transfer/detail/departureShipName

String

N

DEPRECATED: Name of the ship on the departure trip. NOTE: use it only for ship names.

bookingRQ/transfers/transfer/detail/departureTrainInfo

Element

N

DEPRECATED: Information about the train the transfer is supposed to pick the passengers from on the departure trip.NOTE: use it only for train info.

 

bookingRQ/transfers/transfer/detail/departureTrainInfo/trainCompanyName

String

N

DEPRECATED: Train company name

bookingRQ/transfers/transfer/detail/departureTrainInfo/trainNumber

String

N

DEPRECATED: Train number

bookingRQ/transfers/transfer/detail/arrivalFlightNumber

String

N

DEPRECATED: Flight number of the arrival flight. NOTE: use it only for flight numbers

bookingRQ/transfers/transfer/detail/arrivalShipName

String

N

DEPRECATED: Name of the ship on the arrival trip. NOTE: use it only for ship names.

bookingRQ/transfers/transfer/detail/arrivalTrainInfo

String

N

DEPRECATED: Information about the train the transfer is supposed to pick the passengers from on the arrival trip

bookingRQ/transfers/transfer/detail/arrivalTrainInfo/trainCompanyName

String

N

DEPRECATED: Train company name

bookingRQ/transfers/transfer/detail/arrivalTrainInfo/trainNumber

String

N

DEPRECATED: Train number

bookingRQ/transfers/transfer/transferDetails Array of transfer details elements Y NEW:  Information about the ride from which the transfer will pick up passengers.
bookingRQ/transfers/transfer/transferDetails/transferDetail Element Y NEW:  Ride information
bookingRQ/transfers/transfer/transferDetails/transferDetail/type String Y NEW:  Ride type. Possible values:
  • FLIGHT
  • CRUISE
  • TRAIN
bookingRQ/transfers/transfer/transferDetails/transferDetail/direction String Y NEW:  Ride direction. Possible values:
  • ARRIVAL
  • DEPARTURE
bookingRQ/transfers/transfer/transferDetails/transferDetail/code String Y NEW:  Ride identification number(e.g., flight number)
bookingRQ/transfers/transfer/transferDetails/transferDetail/companyName String N NEW:  Indicates the name of the company which operates the ride transport. NOTE: Normally used in ship transports.

bookingRQ/clientReference

String

N

Client internal booking reference

bookingRQ/welcomeMessage

String

N

DEPRECATED: Message the transfer will show to the passenger upon pickup

bookingRQ/remark

String

N

Comments. NOTE: The character limit in this field is 2000 characters.

Request JSON Example

{
	"language": "en",
    "holder": {
        "title": "Mr",
        "name": "John",
        "surname": "Doe",
        "email": "john.doe@hotelbeds.com",
        "phone": "+16543245812"
    },
    "transfers": [
        {
            "rateKey": "DEPARTURE|ATLAS~GPS|278943~21.07784,-86.77478|ATLAS~GPS|411378~21.162052,-86.830677|2019-11-13|18:39|2019-11-13|18:39|2~0~0|7|51731|PRITABCUNRMDM|51731|PRITABCUNRMDM|69|PRVT|V|MV|PRM|17.62|CANCUN|CANCUN|13497|1129|CUN|SIMPLE|f1e0019b7ccac21c43ecf38620caa626",
            "pickupInformation": {
            	"name": "The Pyramid at Grand Oasis",
            	"address": "Blvd. Kukulcan 5",
            	"town": "CUN",
            	"country": "MX",
            	"zip": "77500"
            },
            "dropoffInformation": {
            	"name": "Ikaro Suites Cancun",
            	"address": "Av Sunyaxchen 16",
            	"town": "CUN",
            	"country": "MX",
            	"zip": "77500"
            }
        }
    ],

    "clientReference": "BOSTON#12-203#456754",
    "welcomeMessage": "Welcome Mr. John Doe",
    "remark": "Booking remarks go here."
}

 

Booking Response

When the confirmation of a rateKey is successful; the booking reference is provided, along with key information of the booking, which includes:

  • Transfer service confirmed, with its locator
  • Holder and pax confirmed
  • Rate confirmed with the confirmed amounts and dates

Please make sure to keep the booking reference of all bookings performed with your credentials, as they are needed for post booking operations such as modification or cancellation.

Response parameters


Node/Attribute

Type

Description

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

Booking reference.
Format: XXX-XXXXXX

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

Booking status.

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

DEPRECATED: Passenger type. Possible values:

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

DEPRECATED: Direction of travel. Possible values:

  • DEPARTURE
  • RETURN
bookingRS/bookings/booking/transfers/transfer/status String

Transfer service status.

  • CONFIRMED
  • CANCELLED
  • MODIFIED
bookingRS/bookings/booking/transfers/transfer/transferType String

Transfer type. Possible values:

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

PickUp origin location code type. Possible values:

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

PickUp destination location code type. Possible values:

  • GIATA
  • ATLAS
  • IATA
  • PORT
  • STATION
  • NEW: GPS
bookingRS/bookings/booking/transfers/transfer/pickupInformation/date String Pickup date
bookingRS/bookings/booking/transfers/transfer/pickupInformation/time String Pickup time
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup Element Information of the pickup
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/address String Physical address of the pickup
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/number String Number of the address of the pickup
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/town String City name of the address of the pickup
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/zip String Postal code of the address of the pickup
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/description String Pickup description an instrucctions to reach the place
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/altitude String Elevation from sea level
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/latitude String Latitude data for geolocation
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/longitude String Longitude data for geolocation
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/order String DEPRECATED: Order of the pickUp
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/useWebCheckpickup Boolean DEPRECATED: Indicates if the provider offers website for checkin
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/checkPickup Element NEW: Further instructions in order to confirm the exact pickup time

bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/checkPickup/mustCheckPickupTime

Boolean

NEW: Indicates whether the user needs to confirm exact pickup time on external website

bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/checkPickup/url String

NEW: URL the user needs to visit in order to confirm pickup time

 bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/checkPickup/hoursBeforeConsulting Int

NEW: Indicates how many hours before the service, the pickup time will be available on the website

bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/pickupId Int Id of the pickup
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/stopName String Name of the stop where the pickup takes place
bookingRS/bookings/booking/transfers/transfer/pickupInformation/pickup/image String Image/map to help locate the pickup
bookingRS/bookings/booking/transfers/transfer/minPaxCapacity Int DEPRECATED: Mininum number of passengers needed to book the transfer service
bookingRS/bookings/booking/transfers/transfer/maxPaxCapacity Int DEPRECATED: Passenger limit of the transfer service
bookingRS/bookings/booking/transfers/transfer/paxes Array of pax elements Collection of passengers in the reservation
bookingRS/bookings/booking/transfers/transfer/paxes/pax Element Passenger information
bookingRS/bookings/booking/transfers/transfer/paxes/pax/title String DEPRECATED: Given title of the lead passenger
bookingRS/bookings/booking/transfers/transfer/paxes/pax/name String DEPRECATED: Passenger first name
bookingRS/bookings/booking/transfers/transfer/paxes/pax/surname String DEPRECATED: Passenger last name
bookingRS/bookings/booking/transfers/transfer/paxes/pax/email String DEPRECATED: Passenger contact email
bookingRS/bookings/booking/transfers/transfer/paxes/pax/phone String DEPRECATED:Passenger contact phone number
bookingRS/bookings/booking/transfers/transfer/paxes/pax/type String

Passenger type. Possible values:

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

Type name of the picture. Possible values:

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

Transfer detail info type. Possible values:

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

Transfer time info type. Possible values:

  • DEPRECATED: MAX_WAIT_TIME
  • DEPRECATED: MAX_WAIT_TIME_SUP_DOM
  • DEPRECATED: MAX_WAIT_TIME_SUP_INT
  • NEW: CUSTOMER_MAX_WAITING_TIME
  • NEW: SUPPLIER_MAX_WAITING_TIME_DOMESTIC
  • NEW: SUPPLIER_MAX_WAITING_TIME_INTERNATIONAL
bookingRS/bookings/booking/transfers/transfer/content/customerTransferTimeInfo/TransferTimeInfo/value Int Number of units
bookingRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo Array of supplierTransferTimeInfo elements Information of the supplier transfer time
bookingRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo Element Transfer time details
bookingRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/metric String Time unit type
bookingRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/type String

Transfer time info type. Possible values:

  • DEPRECATED: MAX_WAIT_TIME
  • DEPRECATED: MAX_WAIT_TIME_SUP_DOM
  • DEPRECATED: MAX_WAIT_TIME_SUP_INT
  • NEW: CUSTOMER_MAX_WAITING_TIME
  • NEW: SUPPLIER_MAX_WAITING_TIME_DOMESTIC
  • NEW: SUPPLIER_MAX_WAITING_TIME_INTERNATIONAL
bookingRS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/value Int Number of units
bookingRS/bookings/booking/transfers/transfer/content/transferRemarks Element NEW:  Transfer service remarks
bookingRS/bookings/booking/transfers/transfer/content/transferRemarks/type String

NEW:  Remark possible values:

  • CONTRACT
  • AGENCY
bookingRS/bookings/booking/transfers/transfer/content/transferRemarks/description String NEW:  Remark content
bookingRS/bookings/booking/transfers/transfer/content/transferRemarks/mandatory Boolean NEW:  Mandatory remark
bookingRS/bookings/booking/transfers/transfer/price Element Price information of the transfer service
bookingRS/bookings/booking/transfers/transfer/price/totalAmount Double Total amount of the booking
bookingRS/bookings/booking/transfers/transfer/price/netAmount Double Net amount of the booking
bookingRS/bookings/booking/transfers/transfer/price/currencyId String NEW: Currency
bookingRS/bookings/booking/transfers/transfer/rateKey String Does not apply on Booking response
bookingRS/bookings/booking/transfers/transfer/cancellationPolicies Array of cancellationPolicy elements List of cancellation policies applied to the transfer service
bookingRS/bookings/booking/transfers/transfer/cancellationPolicies/cancellationPolicy Element Information of the cancellation policy
bookingRS/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.
bookingRS/bookings/booking/transfers/transfer/cancellationPolicies/cancellationPolicy/from String Date from which the amount will be charged, format ISO 8601 (yyyy-MM-ddTHH:mm:ssZ)
bookingRS/bookings/booking/transfers/transfer/cancellationPolicies/cancellationPolicy/currencyId String NEW: Currency
bookingRS/bookings/booking/transfers/transfer/links Array of link elements Information on the navigation links available from the current operation
bookingRS/bookings/booking/transfers/transfer/links/link Element Link information
bookingRS/bookings/booking/transfers/transfer/links/link/rel String Specifies the relationship between the current document and the linked document/resource
bookingRS/bookings/booking/transfers/transfer/links/link/href String Specifies the path of the resource the link goes to
bookingRS/bookings/booking/transfers/transfer/links/link/method String NEW: HTTP method
bookingRS/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
bookingRS/bookings/booking/transfers/transfer/arrivalFlightNumber String DEPRECATED: Flight number of the arrival flight
bookingRS/bookings/booking/transfers/transfer/departureFlightNumber String DEPRECATED: Flight number of the departure flight
bookingRS/bookings/booking/transfers/transfer/arrivalShipName String DEPRECATED: Name of the ship on the arrival trip
bookingRS/bookings/booking/transfers/transfer/departureShipName String DEPRECATED: Name of the ship on the departure trip
bookingRS/bookings/booking/transfers/transfer/arrivalTrainInfo Element DEPRECATED: Information of the train on the arrival trip
bookingRS/bookings/booking/transfers/transfer/arrivalTrainInfo/trainCompanyName String DEPRECATED: Train company name
bookingRS/bookings/booking/transfers/transfer/arrivalTrainInfo/trainNumber String DEPRECATED: Train number
bookingRS/bookings/booking/transfers/transfer/departureTrainInfo Element DEPRECATED: Information of the train on the departure trip
bookingRS/bookings/booking/transfers/transfer/departureTrainInfo/trainCompanyName String DEPRECATED: Train company name
bookingRS/bookings/booking/transfers/transfer/departureTrainInfo/trainNumber String DEPRECATED: Train number
bookingRQ/transfers/transfer/transferDetails Array of transfer details elements NEW:  Information about the ride from which the transfer will pick up passengers.
bookingRQ/transfers/transfer/transferDetails/transferDetail Element NEW:  Ride information
bookingRQ/transfers/transfer/transferDetails/transferDetail/type String NEW:  Ride type. Possible values:
  • FLIGHT
  • CRUISE
  • TRAIN
bookingRQ/transfers/transfer/transferDetails/transferDetail/direction String NEW:  Ride direction. Possible values:
  • ARRIVAL
  • DEPARTURE
bookingRQ/transfers/transfer/transferDetails/transferDetail/code String NEW:  Ride identification number(e.g., flight number)
bookingRQ/transfers/transfer/transferDetails/transferDetail/companyName String NEW:  Indicates the name of the company which operates the ride transport. NOTE: Normally used in ship transports.

bookingRQ/transfers/transfer/sourceMarketEmergencyNumber

String

NEW: Source market emergency number

ookingRS/bookings/booking/clientReference String Client internal booking reference
bookingRS/bookings/booking/welcomeMessage String DEPRECATED: Message the transfer will show to the passenger upon pickup
bookingRS/bookings/booking/remark String Comments.NOTE:The character limit in this field is 2000 characters.
bookingRS/bookings/booking/invoiceCompany Element Element that contains information about the invoice company
bookingRS/bookings/booking/invoiceCompany/code String Code of the invoice company
bookingRS/bookings/booking/invoiceCompany/name String DEPRECATED: Name of the invoice company
bookingRS/bookings/booking/invoiceCompany/registrationNumber String DEPRECATED: Registration number of the invoice company
bookingRS/bookings/booking/supplier Element NEW: Supplier information  
bookingRS/bookings/booking/name String NEW: Supplier name
bookingRS/bookings/booking/vatNumber String NEW: Supplier VAT number 
bookingRS/bookings/booking/totalAmount String Total amount
bookingRS/bookings/booking/totalNetAmount String Total net amount
bookingRS/bookings/booking/pendingAmount String Pending amount
bookingRS/bookings/booking/currency String Currency
bookingRS/bookings/booking/transfers/transfer/links Array of link elements NEW: Information on the navigation links available from the current operation
bookingRS/bookings/booking/transfers/transfer/links/link Element NEW: Link information
bookingRS/bookings/booking/transfers/transfer/links/link/rel String NEW: Specifies the relationship between the current document and the linked document/resource
bookingRS/bookings/booking/transfers/transfer/links/link/href String NEW: Specifies the path of the resource the link goes to
bookingRS/bookings/booking/transfers/transfer/links/link/method String NEW: HTTP method

Response JSON Example

{
  "bookings": [
    {
      "reference": "69-3306028",
      "creationDate": "2019-11-06T17:04:10",
      "status": "CONFIRMED",
      "modificationsPolicies": {
        "cancellation": true,
        "modification": true
      },
      "holder": {
        "name": "John",
        "surname": "Doe",
        "email": "john.doe@hotelbeds.com",
        "phone": "+16543245812"
      },
      "transfers": [
        {
          "id": 1,
          "rateKey": "DEPARTURE|ATLAS~GPS|278943~21.07784,-86.77478|ATLAS~GPS|411378~21.162052,-86.830677|2019-11-13|18:39|2019-11-13|18:39|2~0~0|7|51731|PRITABCUNRMDM|51731|PRITABCUNRMDM|69|PRVT|V|MV|PRM|17.62|CANCUN|CANCUN|13497|1129|CUN|SIMPLE|f1e0019b7ccac21c43ecf38620caa626",
          "status": "CONFIRMED",
          "transferType": "PRIVATE",
          "vehicle": {
            "code": "MV",
            "name": "Minivan"
          },
          "category": {
            "code": "PRM",
            "name": "Premium"
          },
          "pickupInformation": {
            "from": {
              "code": "21.07784,-86.77478",
              "description": "The Pyramid at Grand Oasis, Blvd. Kukulcan 5, 77500 CUN, MX",
              "type": "GPS"
            },
            "to": {
              "code": "21.162052,-86.830677",
              "description": "Ikaro Suites Cancun, Av Sunyaxchen 16, 77500 CUN, MX",
              "type": "GPS"
            },
            "date": "2019-11-13",
            "time": "18:39:00",
            "pickup": {
              "address": "Blvd. Kukulcan 5",
              "number": "",
              "town": "CUN",
              "zip": "77500",
              "description": "The Pyramid at Grand Oasis",
              "altitude": null,
              "latitude": 21.07784,
              "longitude": -86.77478,
              "checkPickup": {
                "mustCheckPickupTime": false,
                "url": null,
                "hoursBeforeConsulting": null
              },
              "pickupId": 13497,
              "stopName": "Outside",
              "image": ""
            }
          },
          "paxes": [
            {
              "type": "ADULT"
            },
            {
              "type": "ADULT"
            }
          ],
          "content": {
            "vehicle": {
              "code": "MV",
              "name": "Minivan"
            },
            "category": {
              "code": "PRM",
              "name": "Premium"
            },
            "images": [
              {
                "url": "http://media.stage.activitiesbank.com/giata/transfers/TRD/small/prvt-prm-mv.png",
                "type": "SMALL"
              },
              {
                "url": "http://media.stage.activitiesbank.com/giata/transfers/TRD/medium/prvt-prm-mv.png",
                "type": "MEDIUM"
              },
              {
                "url": "http://media.stage.activitiesbank.com/giata/transfers/TRD/large/prvt-prm-mv.png",
                "type": "LARGE"
              },
              {
                "url": "http://media.stage.activitiesbank.com/giata/transfers/TRD/extralarge/prvt-prm-mv.png",
                "type": "EXTRALARGE"
              }
            ],
            "transferDetailInfo": [
              {
                "id": "ER",
                "name": "Exclusive ride for you",
                "description": null,
                "type": "GENERAL_INFO"
              },
              {
                "id": "DTDS",
                "name": "Door to door service",
                "description": null,
                "type": "GENERAL_INFO"
              },
              {
                "id": "AV247",
                "name": "Available 24/7",
                "description": null,
                "type": "GENERAL_INFO"
              },
              {
                "id": "M&GS",
                "name": "Meet & Greet service",
                "description": null,
                "type": "GENERAL_INFO"
              },
              {
                "id": "BAHB",
                "name": "1 item of hand baggage allowed per person",
                "description": null,
                "type": "GENERAL_INFO"
              },
              {
                "id": "BA",
                "name": "1 piece of baggage allowed per person ( max.dimensions 158cm) length+width+height=158cm",
                "description": null,
                "type": "GENERAL_INFO"
              },
              {
                "id": "VINT",
                "name": "INTERNATIONAL FLIGHTS",
                "description": "For International flights, you are advised to be at the airport 3 hours before the departure of the flight.",
                "type": "GENERIC_GUIDELINES"
              },
              {
                "id": "VDOM",
                "name": "DOMESTIC FLIGHTS",
                "description": "For domestic flights, you are advised to be at the airport 2 hours before the departure of the flight.",
                "type": "GENERIC_GUIDELINES"
              },
              {
                "id": "VOUC",
                "name": "VOUCHER ",
                "description": "Remember to bring a printed copy of this voucher and a valid photo ID with you.",
                "type": "GENERIC_GUIDELINES"
              },
              {
                "id": "CHAC",
                "name": "CHANGE OF ACCOMMODATION",
                "description": "If you change your accommodation during your holiday, you must inform us at least 48 hours before the departure of your flight so that we can update the details of your transfer.",
                "type": "GENERIC_GUIDELINES"
              },
              {
                "id": "SPLU",
                "name": "SPECIAL LUGGAGE",
                "description": "In the event of extra luggage or sport equipment being checked in, please contact us, as this may carry an extra charge.",
                "type": "GENERIC_GUIDELINES"
              },
              {
                "id": "STFF",
                "name": "CAN'T FIND STAFF ",
                "description": "In the event of being unable to locate a staff member, please call the emergency number indicated in this voucher.",
                "type": "GENERIC_GUIDELINES"
              },
              {
                "id": "LGPR",
                "name": "LUGGAGE PROBLEMS",
                "description": "In the event of a delay on your flight or a problem with customs or luggage,  please call the emergency number in order to advise of the delay and take the necessary steps.",
                "type": "GENERIC_GUIDELINES"
              },
              {
                "id": "CHFL",
                "name": "CHANGE OF FLIGHT ",
                "description": "If you change your return flight during your holiday, you must inform us at least 48 hours before the departure of your flight so that we can update the details of your transfer.",
                "type": "GENERIC_GUIDELINES"
              },
              {
                "id": "CBBS",
                "name": "CHILDBOOSTER / BABY SEAT",
                "description": "Child car seats and boosters are not included unless specified in your booking and can carry an extra cost. Should you need to book them, please contact your point of sale prior to travelling.",
                "type": "GENERIC_GUIDELINES"
              }
            ],
            "customerTransferTimeInfo": [
              {
                "value": 30,
                "type": "CUSTOMER_MAX_WAITING_TIME",
                "metric": "minutes"
              }
            ],
            "supplierTransferTimeInfo": [
              {
                "value": 15,
                "type": "SUPPLIER_MAX_WAITING_TIME_DOMESTIC",
                "metric": "minutes"
              }
            ],
            "transferRemarks": [
              {
                "type": "CONTRACT",
                "description": "Pick-up point:\nYou will be picked up outside the hotel entrance. If you are unable to locate the driver/agent, please call DESTINATION SERVICES on 0052 998 141 9568 (11pm – 5am) / 0052 998 283 0800 (Ext: 1037,1038, 1039). Languages spoken at the call centre: English, Spanish. Please do not leave the pick-up area without having contacted the agent/driver first.\n\nTransfer information:\n\n* Maximum client waiting time 30 minutes\n* Maximum waiting time for drivers in domestic arrivals 15 minutes\n\n* For International flights, you are advised to be at the airport 3 hours before the departure of the flight.\n* For domestic flights, you are advised to be at the airport 2 hours before the departure of the flight.\n* Remember to bring a printed copy of this voucher and a valid photo ID with you.\n* If you change your accommodation during your holiday, you must inform us at least 48 hours before the departure of your flight so that we can update the details of your transfer.\n* In the event of extra luggage or sport equipment being checked in, please contact us, as this may carry an extra charge.\n* In the event of being unable to locate a staff member, please call the emergency number indicated in this voucher.\n* In the event of a delay on your flight or a problem with customs or luggage,  please call the emergency number in order to advise of the delay and take the necessary steps.\n* If you change your return flight during your holiday, you must inform us at least 48 hours before the departure of your flight so that we can update the details of your transfer.\n* Child car seats and boosters are not included unless specified in your booking and can carry an extra cost. Should you need to book them, please contact your point of sale prior to travelling.\n\n",
                "mandatory": true
              }
            ]
          },
          "price": {
            "totalAmount": 17.62,
            "netAmount": null,
            "currencyId": "EUR"
          },
          "cancellationPolicies": [
            {
              "amount": 17.62,
              "from": "2019-11-12T00:00:00",
              "currencyId": "EUR"
            }
          ],
          "factsheetId": 1129,
          "arrivalFlightNumber": null,
          "departureFlightNumber": null,
          "arrivalShipName": null,
          "departureShipName": null,
          "arrivalTrainInfo": null,
          "departureTrainInfo": null,
          "transferDetails": [],
          "sourceMarketEmergencyNumber": "+52 55 959 684 15",
          "links": [
            {
              "rel": "transferCancel",
              "href": "/booking/en/reference/69-3306028",
              "method": "DELETE"
            }
          ]
        }
      ],
      "clientReference": "BOSTON#12-203#456754",
      "remark": "",
      "invoiceCompany": {
        "code": "E14"
      },
      "supplier": {
        "name": "CLUB TURAVIA SA DE CV",
        "vatNumber": "CTU940107CK8"
      },
      "totalAmount": 17.62,
      "totalNetAmount": 17.62,
      "pendingAmount": 17.62,
      "currency": "EUR",
      "links": [
        {
          "rel": "self",
          "href": "/booking/en/reference/69-3306028",
          "method": "GET"
        },
        {
          "rel": "bookingDetail",
          "href": "/booking/en/reference/69-3306028",
          "method": "GET"
        },
        {
          "rel": "bookingCancel",
          "href": "/booking/en/reference/69-3306028",
          "method": "DELETE"
        }
      ]
    }
  ]
}

 

Post Booking Operations

Once you have confirmed bookings, there's a series of operations that can be performed:

Bear in mind that you will need the booking reference of the bookings you carried out to perform this operations.

Docs Navigation