Cancel

The booking Cancel is a PUT method operation that can be used in two different cases:

  • To simulate a booking cancellation
  • To cancel the booking

NOTE: Cancellations always take into account day and time of the destination in order to calculate what cancellation policy should be apply.

Cancel Request

Endpoint

PUT https://api.test.hotelbeds.com//transfer-api/1.0/booking/cancel
TIMEOUT: 120 seconds

 

Request parameters

Node/Attribute

Value

Description

CancelRequest

Element

Top level

CancelRequest/reference

String

Locator of the booking to be cancelled

CancelRequest/isSimulation

Boolean

Defines if the operation will be a simulation or an actual cancellation.

CancelRequest/language

String

Code of the requested language.

Request JSON Example

{
    "reference": "1.4133975",
    "isSimulation": false,
    "language": "en"
}

 

Cancel Response

When the booking is cancelled, details of the cancelled booking are returned with the following information:

  • The booking status: CANCELLED
  • Cancellation fees if applicable
  • Transfer service that was cancelled.

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
CancelResponse Element Top level
CancelResponse/bookings Array of booking elements List of bookings.
NOTE: in confirmation step you'll always will receive only one booking in this array.
CancelResponse/bookings/booking Element Booking information
CancelResponse/bookings/booking/reference String

Booking reference.
Format: XXX.XXXXXX

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

Booking status.

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

Passenger type. Possible values:

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

Direction of travel. Possible values:

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

Transfer type. Possible values:

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

PickUp origin location code type. Possible values:

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

PickUp destination location code type. Possible values:

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

Passenger type. Possible values:

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

Type name of the picture. Possible values:

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

Transfer detail info type. Possible values:

  • GENERAL_INFO
  • GENERIC_GUIDELINES
CancelResponse/bookings/booking/transfers/transfer/content/customerTransferTimeInfo Array of Information of the customer transfer time
CancelResponse/bookings/booking/transfers/transfer/content/customerTransferTimeInfo/TransferTimeInfo TransferTimeInfo element Transfer time details
CancelResponse/bookings/booking/transfers/transfer/content/customerTransferTimeInfo/TransferTimeInfo/metric String Time unit type
CancelResponse/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
CancelResponse/bookings/booking/transfers/transfer/content/customerTransferTimeInfo/TransferTimeInfo/value Int Number of units
CancelResponse/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo Array of supplierTransferTimeInfo elements Information of the supplier transfer time
CancelResponse/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo TransferTimeInfo element Transfer time details
CancelResponse/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/metric String Time unit type
CancelResponse/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
CancelResponse/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/value Int Number of units
CancelResponse/bookings/booking/transfers/transfer/price Element Price information of the transfer service
CancelResponse/bookings/booking/transfers/transfer/price/totalAmount Double Total amount of the booking
CancelResponse/bookings/booking/transfers/transfer/price/netAmount Double Net amount of the booking
CancelResponse/bookings/booking/transfers/transfer/rateKey String Does not apply on Booking response
CancelResponse/bookings/booking/transfers/transfer/cancellationPolicies Array of cancellationPolicy elements List of cancellation policies applied to the transfer service
CancelResponse/bookings/booking/transfers/transfer/cancellationPolicies/cancellationPolicy Element Information of the cancellation policy
CancelResponse/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.
CancelResponse/bookings/booking/transfers/transfer/cancellationPolicies/cancellationPolicy/from String Date from which the amount will be charged, format ISO 8601 (yyyy-MM-ddTHH:mm:ssZ)
CancelResponse/bookings/booking/transfers/transfer/links Array of link elements Information on the navigation links available from the current operation
CancelResponse/bookings/booking/transfers/transfer/links/link Element Link information
CancelResponse/bookings/booking/transfers/transfer/links/link/rel String Specifies the relationship between the current document and the linked document/resource
CancelResponse/bookings/booking/transfers/transfer/links/link/href String Specifies the path of the resource the link goes to
CancelResponse/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
CancelResponse/bookings/booking/transfers/transfer/arrivalFlightNumber String Flight number of the arrival flight
CancelResponse/bookings/booking/transfers/transfer/departureFlightNumber String Flight number of the departure flight
CancelResponse/bookings/booking/transfers/transfer/arrivalShipName String Name of the ship on the arrival trip
CancelResponse/bookings/booking/transfers/transfer/departureShipName String Name of the ship on the departure trip
CancelResponse/bookings/booking/transfers/transfer/arrivalTrainInfo Element Information of the train on the arrival trip
CancelResponse/bookings/booking/transfers/transfer/arrivalTrainInfo/trainCompanyName String Train company name
CancelResponse/bookings/booking/transfers/transfer/arrivalTrainInfo/trainNumber String Train number
CancelResponse/bookings/booking/transfers/transfer/departureTrainInfo Element Information of the train on the departure trip
CancelResponse/bookings/booking/transfers/transfer/departureTrainInfo/trainCompanyName String Train company name
CancelResponse/bookings/booking/transfers/transfer/departureTrainInfo/trainNumber String Train number
CancelResponse/bookings/booking/clientReference String Client internal booking reference
CancelResponse/bookings/booking/welcomeMessage String Message the transfer will show to the passenger upon pickup
CancelResponse/bookings/booking/remark String Comments.
NOTE:The character limit in this field is 2000 characters.
CancelResponse/bookings/booking/invoiceCompany Element Element that contains information about the invoice company
CancelResponse/bookings/booking/invoiceCompany/code String Code of the invoice company
CancelResponse/bookings/booking/invoiceCompany/name String Name of the invoice company
CancelResponse/bookings/booking/invoiceCompany/registrationNumber String Registration number of the invoice company
CancelResponse/bookings/booking/totalAmount String Registration number of the invoice company
CancelResponse/bookings/booking/totalNetAmount String Registration number of the invoice company
CancelResponse/bookings/booking/pendingAmount String Registration number of the invoice company
CancelResponse/bookings/booking/currency String Registration number of the invoice company

Response JSON example

{
    "bookings": [
        {
            "reference": "1.4135098",
            "creationDate": "2019-02-18T08:17:34",
            "status": "CANCELLED",
            "modificationsPolicies": {
                "cancellation": false,
                "modification": false
            },
            "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": null,
                            "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": 0,
                        "netAmount": 0
                    },
                    "rateKey": null,
                    "cancellationPolicies": [],
                    "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": "PMI",
                            "description": null,
                            "type": "IATA"
                        },
                        "to": {
                            "code": "1523",
                            "description": null,
                            "type": "ATLAS"
                        },
                        "date": "2019-12-30",
                        "time": "08:30:52",
                        "pickup": {
                            "address": null,
                            "number": null,
                            "town": null,
                            "zip": null,
                            "description": null,
                            "altitude": null,
                            "latitude": null,
                            "longitude": null,
                            "order": null,
                            "useWebCheckpickup": false,
                            "pickupId": null,
                            "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": 0,
                        "netAmount": 0
                    },
                    "rateKey": null,
                    "cancellationPolicies": [],
                    "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": 0,
            "totalNetAmount": 0,
            "pendingAmount": 0,
            "currency": "EUR"
        }
    ]
}

Docs Navigation