1 11.1. BOOKING WITH SERVICES
2 11.2. ADDITIONAL QUESTIONS
3 11.3. BOOKING WITH DEPARTURE ELEMENT
- 3.1 11.3.1. MEETING POINT
- 3.2 11.3.2. PICKUP
4 11.4. SEE PRICE FOR CANCELLATION ON RETRIEVE
5 11.5. BOOKING WITH SPECIFIC PAX TYPES

11.1. BOOKING WITH SERVICES

Services that can be booked are contained in <Services> elements on Excursion Availability response.
There is <Services> element in <ExcursionRate> for the specific offer with the unique identifier of the service ServiceRPH:

<Services>
   <Service Inclusive="false" RequiredInd="true" ServiceRPH="2" />
</Services>

GP_ExcursionAvailRS/Excursions/Excursion/Services contains detailed information about possible Services options. Possible values: DeliveryToHotel, DeliveryToAddress, SelfPickUp, E-Delivery, Supplement.

<Services>
   <Service ServiceRPH="1" SpecialServiceType="SelfPickUp">
      <Price>
         <Base AmountAfterTax="10.00" CurrencyCode="EUR" />
      </Price>
      <ServiceDetails ShortName="Hotel Delivery (might change to E-Ticket / Collection point)">
         <ServiceDescription>
            <Text>Usually, the tickets will arrive on the night prior to the event at the address you have provided. However there may be a change in the delivery method to E-delivery / Self pick up - we will update the end customer by email if needed.</Text>
         </ServiceDescription>
      </ServiceDetails>
   </Service>
   <Service ServiceRPH="2" SpecialServiceType="E-Delivery">
      <Price>
         <Base AmountAfterTax="5.00" CurrencyCode="EUR" />
      </Price>
      <ServiceDetails ShortName="E-Ticket">
         <ServiceDescription>
            <Text>E-Tickets: Print your eTickets and take them with you to the venue.</Text>
         </ServiceDescription>
      </ServiceDetails>
   </Service>
</Services>

It is mandatory to set Address element with the information about Guest Full Name, Guest home Address (Incl. zip code, City, Province, Country) on Reservation for DeliveryToAddress service type.

<Services>
   <Service ServiceRPH="1" SpecialServiceType="DeliveryToAddress">
      <Address>
         <AddressLine>Ivan Ivanov, Zheleznodorozhnaya 99-15, 220123, Minsk, Minsk, Belarus</AddressLine>
      </Address>
   </Service>
</Services>

It is mandatory to set Address element with the information about Guest Full Name, Hotel name, Check-in date, Hotel Address (Incl. zip code) on Reservation for DeliveryToHotel service type.

SelfPickUp, E-Delivery and Supplement do not require additional information in <Services> element:

Flow with E-Delivery service type:

11.2. ADDITIONAL QUESTIONS

AdditionalQuestions element contains remarks in the form of questions which are important to the supplier.

GP HUB shows these remarks in AdditionalQuestions element on Excursion Descriptive Info Response or Reservation Initiate Response depending on supplier:

Answers to the questions should be specified on Reservation Confirmation Request If supplier returns additional questions on Reservation Initiate Response:

Flow with AdditionalQuestions from Reservation Initiate Response:

AdditionalQuestions element should be specified on Reservation Initiate Request and Reservation Confirmation Request If supplier returns AdditionalQuestions on Excursion Descriptive Info Response.

Flow with AdditionalQuestions from Excursion Descriptive Info Response:

Possible AnswerValues for different TypeDescription you can see at Remarks Type in Glossary.

11.3. BOOKING WITH DEPARTURE ELEMENT

If Departure elements were returned in Availability response, then you must specify the departure point in booking requests. Information about possible Departure points should be taken from Excursion Availability response. Departure point is identified by RPH attribute that corresponds to Departure/@RPH value from Availability response.

11.3.1. MEETING POINT

MeetingPoint that can be booked are contained in <Departures> elements on Excursion Availability response:

In order to book a MeetingPoint, it have to be specified on Reservation Initiate Request and Reservation Confirmation request in <Departure> element. It is enough to submit Departure/@RPH in booking request, and a StartTime element if it was displayed in Excursion Availability response:

Flow with MeetingPoint:

11.3.2. PICKUP

PickUp point that can be booked are contained in <Departures> elements on Excursion Availability response:

If the DeparturePoint/@Type is "PickUp", then the *Departure/@RP*H is required along with pick up details:

PickUpAddress element must be specified in case there was a "PickUp departure point with @AddressSupported="true" in Availability response:

Hotel element must be specified in case there was a "PickUp" departure point with @HotelCodeSupported="true" in Availability response. If there was a list of hotels supported as pick-up points in Availability response, then one of the hotels must be specified in the reservation request. If the DeparturePoint/@HotelCodeSupported="true", but none Hotel listed in Availability response, then user must specify any hotel code supported by this supplier:

If there was a list of locations with their addresses specified as pick-up points in Availability response, then one of the location must be specified in the reservation request.

In order to book a PickUp point, it have to be specified on Reservation Initiate Request and Reservation Confirmation request in <Departure> element:

PickUpAddress:

PickUp hotel:

PickUp location:

Flow with PickUpAddress:

Flow with PickUp hotel:

Flow with PickUp location:

11.4. SEE PRICE FOR CANCELLATION ON RETRIEVE

On Retrieve after Cancellation you can see the total price of the booking and the total price of the cancellation.

ExcursionRates/ExcursionRate/Rates/Rate/Total/@AmountAfterTax - is the total price of the booking (even if the reservation has already been cancelled for free). This Amount has the same value that we show on Reservation.

Excursion/Total/@AmountAfterTax - is the actual total price for the booking. This Amount is the price of the cancellation.

11.5. BOOKING WITH SPECIFIC PAX TYPES

2. EXCURSION SEARCH

This step provides you with the opportunity to search for excursions in the requested city. In the response we don’t show any availability and prices information, we just return a list of excursions in the specified city and basic information about them (pax types are also returned).
The main purpose of this message is to get excursion codes that can be used in further steps and their pax types.

Here is how pax types will look like in our response:

To get the pax types for the excursion before the availability step you can also use our Excursion Descriptive Info message 5. EXCURSION DESCRIPTIVE INFO

(specifying city code + excursion code). In our response along with the pax types you’ll receive full information about the excursion provided by the supplier.

Then you can proceed to the Excursion Availability step specifying pax types you received in the Excursion Search response.

4. EXCURSION AVAILABILITY

Here is how pax type need to be specified in the availability request https://gp-team.atlassian.net/wiki/spaces/GTHEUG/pages/779223332/2.2.+EXCURSION+AVAILABILITY+REQUEST:

If the supplier doesn’t support Availability request by date interval, you can use our Excursion Schedule message 3. EXCURSION SCHEDULE. You need to specify a date interval and excursion code in the request 3.1. EXCURSION SCHEDULE REQUEST and you’ll receive a list of dates that are available for this excursion with prices for each pax type, for example:

After the Excursion Availability step you can proceed to the Excursion Reservation step. In 7.1. RESERVATION INITIATE REQUEST and 7.5. RESERVATION CONFIRMATION REQUEST you’ll need to specify pax types for each guest:

GP Travel HUB Excursion User Guide

11. USE CASES

Analytics