Booking Modification

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

  • To simulate a booking modification
  • To modify the booking, cancellating one of the the included transfer services

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

Booking Modify Request

Endpoint

DELETE https://api.test.hotelbeds.com/transfer-api/1.0/booking/{{language}}/reference/{{reference}}/id/{{id}}?simulation={{true/false}} DEPRECATED
DELETE https://api.test.hotelbeds.com/transfer-api/1.0/bookings/{{language}}/reference/{{reference}}/id/{{id}}?simulation={{true/false}}
TIMEOUT: 120 seconds

 

Request parameters

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

Locator of the booking to be updated.

id String Y Locator of the transfer service to apply modification
simulation Boolean N

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

Request examples

FOR SIMULATION: https://api.hotelbeds.com/transfer-api/1.0/bookings/en/reference/1-4135098/id/2?simulation=True

FOR CANCELLATION: https://api.hotelbeds.com/transfer-api/1.0/bookings/en/reference/1-4135098/id/2?simulation=False

 

Booking Modification Response

When a booking is modificated, details of the booking with the updated transfer services are returned with the following information:

  • The booking status: MODIFIED
  • Cancellation fees if applicable
  • Transfer service that was updated with CANCELLED status value

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

Booking reference.
Format: XXX-XXXXXX

bookingModificationRS/bookings/booking/bookingFileId String Booking file id
bookingModificationRS/bookings/booking/creationDate Date Booking creation date.
Format: YYYY-MM-DD
bookingModificationRS/bookings/booking/status String

Booking status.

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

DEPRECATED: Passenger type. Possible values:

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

Booking status.

  • CONFIRMED
  • CANCELLED
  • MODIFIED
bookingModificationRS/bookings/booking/transfers/transfer/direction String

DEPRECATED: Direction of travel. Possible values:

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

Transfer type. Possible values:

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

PickUp origin location code type. Possible values:

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

PickUp destination location code type. Possible values:

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

Passenger type. Possible values:

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

DEPRECATED: Type name of the picture. Possible values:

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

DEPRECATED: Transfer detail info type. Possible values:

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

DEPRECATED: Transfer time info type. Possible values:

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

DEPRECATED: Transfer time info type. Possible values:

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

Response JSON example

{
  "bookings": [
    {
      "reference": "1-4537371",
      "bookingFileId": "456678", 
      "creationDate": "2019-11-18T14:03:16",
      "status": "CANCELLED",
      "modificationsPolicies": {
        "cancellation": false,
        "modification": false
      },
      "holder": {
        "name": "John",
        "surname": "Doe",
        "email": "john.doe@hotelbeds.com",
        "phone": "+16543245812"
      },
      "transfers": [
        {
          "id": 1,
          "status": "CANCELLED",
          "transferType": "PRIVATE",
          "vehicle": {
            "code": "CR",
            "name": "Car"
          },
          "category": {
            "code": "PRM",
            "name": "Premium"
          },
          "pickupInformation": {
            "from": {
              "code": "PMI",
              "description": "Palma Majorca, Son Sant Joan Airport",
              "type": "IATA"
            },
            "to": {
              "code": "1523",
              "description": "Visit Hotel Alexandra",
              "type": "ATLAS"
            },
            "date": "2019-12-14"
          },
          "paxes": [
            {
              "type": "ADULT"
            },
            {
              "type": "ADULT"
            },
            {
              "type": "CHILD"
            }
          ],
          "price": {
            "totalAmount": 0,
            "netAmount": null,
            "currencyId": "EUR"
          },
          "factsheetId": 2246
        }
      ],
      "clientReference": "BOSTON#12-203#456754",
      "remark": "",
      "invoiceCompany": {
        "code": "E14"
      },
      "supplier": {
        "name": "HOTELBEDS SPAIN, S.L.U",
        "vatNumber": "ESB28916765"
      },
      "totalAmount": 0,
      "totalNetAmount": 0,
      "pendingAmount": 0,
      "currency": "EUR",
      "links": [
        {
          "rel": "self",
          "href": "/booking/en/reference/1-4537371",
          "method": "GET"
        },
        {
          "rel": "bookingDetail",
          "href": "/booking/en/reference/1-4537371",
          "method": "GET"
        }
      ]
    }
  ]
}

Docs Navigation