Documentation

Booking Cancellation Transfers logo icon


BookingCancellation is a DELETE method operation that can be used in different cases:

  • To cancel the booking.

  • To simulate a booking cancellation.

  • To partially cancel booking (one service).


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

Booking Cancellation Request

DELETE https://api.test.hotelbeds.com/transfer-api/1.0/bookings/{{language}} /reference/ {{booking_reference}}
DELETE https://api.test.hotelbeds.com/transfer-api/1.0/bookings/{{language}} /reference/ {{booking_reference}}?simulation={{true/false}}
DELETE https://api.test.hotelbeds.com/transfer-api/1.0/bookings/{{language}} /reference/ {{booking_reference}} /id/ {{service_id}}

Request parameters

Parameter Type Mandatory Description
language String Y Response language
reference String Y

Locator of the booking to be cancelled.

simulation Boolean N

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

service_id Int N

Service id requesting partial cancellation. (returned in /bookings/booking/transfers/transfer/id)



Request examples:


Cancel :

DELETE https://api.test.hotelbeds.com/transfer-api/1.0/bookings/en/1-4135098

Will directly cancel the booking


Cancel Simulation :

DELETE https://api.test.hotelbeds.com/transfer-api/1.0/bookings/en/1-4135098?simulation=true

Will simulate the booking cancellation, so you can check if charges will be applied (amount returned).

Partial cancellation :

DELETE https://api.test.hotelbeds.com/transfer-api/1.0/bookings/en/1-4135098/id/2

Will directly cancel the requested service id of the provided booking.

Note: remember to make a booking details before in order to make sure you are cancelling the desired service id.

Cancellation response

The Cancellation response will be the same structure as the booking detail response with changed status.

Note: if booking status is “canceled” and “totalAmount” is not “0” the amount are cancellation charges.


Response parameters :

Node/Attribute

Type

Description

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

Booking reference. Format: XXX-XXXXXX

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

Booking status.

  • CONFIRMED
  • CANCELLED
  • MODIFIED
RS/bookings/booking/modificationsPolicies Element Information regarding the allowed modifications to the booking
RS/bookings/booking/modificationsPolicies/cancellation Boolean Indicates if the booking can be cancelled
RS/bookings/booking/modificationsPolicies/modification Boolean Indicates if the booking can be modified
RS/bookings/booking/holder Element Booking lead passenger/holder information
RS/bookings/booking/holder/name String First name of the lead passenger
RS/bookings/booking/holder/surname String Last name of the lead passenger
RS/bookings/booking/holder/email String Lead passenger contact email
RS/bookings/booking/holder/phone String Lead passenger contact phone number
RS/bookings/booking/transfers Array of transfer elements List of reserved transfer services
RS/bookings/booking/transfers/transfer Element Information of one reserved transfer service
RS/bookings/booking/transfers/transfer/id Int Transfer service id code
RS/bookings/booking/transfers/transfer/direction String

DEPRECATED: Direction of travel. Possible values:

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

Transfer service status.

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

Transfer type. Possible values:

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

PickUp origin location code type. Possible values:

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

PickUp destination location code type. Possible values:

  • GIATA
  • ATLAS
  • IATA
  • PORT
  • STATION
  • GPS
RS/bookings/booking/transfers/transfer/pickupInformation/date String Pickup date
RS/bookings/booking/transfers/transfer/pickupInformation/time String Pickup time
RS/bookings/booking/transfers/transfer/pickupInformation/pickup Element Information of the pickup
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/address String Physical address of the pickup
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/number String Number of the address of the pickup
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/town String City name of the address of the pickup
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/zip String Postal code of the address of the pickup
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/description String Pickup description an instrucctions to reach the place
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/altitude String Elevation from sea level
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/latitude String Latitude data for geolocation
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/longitude String Longitude data for geolocation
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/checkPickup Element Further instructions in order to confirm the exact pickup time

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

Boolean

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

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

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

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

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

RS/bookings/booking/transfers/transfer/pickupInformation/pickup/pickupId Int Id of the pickup
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/stopName String Name of the stop where the pickup takes place
RS/bookings/booking/transfers/transfer/pickupInformation/pickup/image String Image/map to help locate the pickup
RS/bookings/booking/transfers/transfer/paxes Array of pax elements Collection of passengers in the reservation
RS/bookings/booking/transfers/transfer/paxes/pax Element Passenger information
RS/bookings/booking/transfers/transfer/paxes/pax/type String

Passenger type. Possible values:

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

Type name of the picture. Possible values:

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

Transfer detail info type. Possible values:

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

Transfer time info type. Possible values:

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

Transfer time info type. Possible values:

  • CUSTOMER_MAX_WAITING_TIME
  • SUPPLIER_MAX_WAITING_TIME_DOMESTIC
  • SUPPLIER_MAX_WAITING_TIME_INTERNATIONAL
RS/bookings/booking/transfers/transfer/content/supplierTransferTimeInfo/TransferTimeInfo/value Int Number of units
RS/bookings/booking/transfers/transfer/content/transferRemarks Element  Transfer service remarks
RS/bookings/booking/transfers/transfer/content/transferRemarks/type String

Remark possible values:

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

RS/transfers/transfer/sourceMarketEmergencyNumber

String

Source market emergency number

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