Holds, Bookings & Cancellations
Holds
The implementation of the hold request is mandatory prior to a booking request where the the rate is set to holdable= true. There are some rates that might have set holdable = false for which the hold request is not required. The Reseller can implement some logic to only send the hold request if it is required or send it irrespective, in which case Redeam can apply the logic not to pass it to the Supplier.
The Hold is placed to ensure the product stays available until the customer is ready to check out the cart or commit to the booking. The hold request includes the supplierId, productId, rateId, priceId and travelerType of the pricing and availability responses to ensure that the hold is placed only on a product that is in fact available for the requested rate, price and number of guests.
When the Hold is placed on the product, it gets assigned a holdId and will remain active until it is released automatically according to the configured hold expires time. It is best practice to issue a hold release when the guest abandons the cart or closes the browser. Some Reseller systems also have the functionality to ask for an extension of the hold time, this request can either be accepted or declined by the Supplier.
Please note that the hold times vary between the Supplier and Reseller systems. It is important to discuss the hold times prior to binding the channels and determine a time that suits both the Supplier and the Reseller.
{ "hold": { "expires": "2022-08-30T14:16:19Z", "items": [ { "at": "2022-10-25T14:00:00Z", "availabilityId": "f52ab94d-bcce-43bc-81ef-735c370d2cec", "priceId": "4545add2-179f-424e-9343-ba5908ba9166", "productId": "82381393-02c8-43cd-8ea1-0ccd92cb701a", "quantity": 1, "rateId": "87840e8e-53f9-43ed-98b3-cf792b89aeee", "supplierId": "a7e9c6eb-1479-4099-a06f-f85cbb98d4c7", "travelerType": "ANY" } ] }}Bookings
Whenever Redeam receives a Booking request from the Reseller, it checks the holdable attribute, If holdable = true the booking request needs to include the holdId, without it, the booking request fails. If holdable = false, the holdId is not required and Redeam cross-reference the supplierId, rateId, priceId and travellerType fields to ensure that the booking request is for the same number of travelers, rate and price that was requested in the hold. The details of the booking cannot be modified from the hold. This will cause the booking to fail, even if the requested product etc is available.
When the booking request data matches the hold request data, the booking request is successful and a booking_id is returned.
{ "booking": { "customer": { "email": "apisupport@redeam.com", "firstName": "test", "lastName": "test" }, "holdId": "e5effe9c-938c-4ee5-9f82-856feb10987d", "items": [ { "availabilityId": "f52ab94d-bcce-43bc-81ef-735c370d2cec", "productId": "82381393-02c8-43cd-8ea1-0ccd92cb701a", "priceId": "4545add2-179f-424e-9343-ba5908ba9166", "quantity": 1, "rateId": "87840e8e-53f9-43ed-98b3-cf792b89aeee", "startTime": "2022-10-25T14:00:00Z",- "supplierId": "a7e9c6eb-1479-4099-a06f-f85cbb98d4c7", "traveler": { "age": 21, "country": "USA", "email": "apisupport@redeam.com", "firstName": "string", "gender": "FEMALE", "isLead": true, "lang": "ENG", "lastName": "string", "type": "ANY" } } ], "partnerId": "jotestbooking" }}Cancellations
In order to cancel a booking, the booking_id is required.
Please note that some Suppliers do not accept cancellations initiated by the customer or Reseller for products via the API, their products or rates are set to cancelable = false. In this case if reservations need to be cancelled anyway, a manual business process between Supplier and Reseller needs to be agreed. However, if an Supplier cancels an event and a Reseller needs to cancel multiple reservations, Redeam can help to find a solution to let the Reseller cancel via the API so that the guest refunds can be carried out between Supplier and Reseller and reported.
Please remember to implement extension maps to the Hold, Booking and Cancellation requests.