.. _Workflow-Samples:

****************
Workflow samples
****************

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   :hidden:


   samples/Sample_Create-simple-booking.rst
   samples/Sample_Create-booking-with-ancillaries.rst
   samples/Sample_Pay-after-booking.rst
   samples/Sample_Update-booking-Add-flight.rst
   samples/Sample_Update-booking-Change-flight.rst
   samples/Sample_Update-booking-Delete-flight.rst
   samples/Sample_Update-booking-Add-passenger.rst
   samples/Sample_Update-booking-Change-passenger-name.rst
   samples/Sample_Update-booking-Delete-passenger.rst
   samples/Sample_Update-booking-Add-service.rst
   samples/Sample_Update-booking-Change-service.rst
   samples/Sample_Update-booking-Delete-service.rst
   samples/Sample_Cancel-booking.rst
   samples/Sample_Create-booking-with-3DS.rst
   samples/Sample_Create-booking-with-3DS-inclRef.rst
   samples/Sample_Create-booking-with-cash.rst
   samples/Sample_Create-option-booking.rst
   samples/Sample_Create-booking-with-promotion-code.rst
   samples/Sample_Create-booking-with-ApiData.rst
   samples/Sample_Create-booking-with-Voucher.rst
   samples/Sample_Update-booking-with-Voucher.rst
   samples/Sample_Update-booking-Change-RedressNumber.rst

.. raw:: html

   <h3>Create simple booking</h3>

This workflow features the easiest way to create a booking by searching flights, retrieving a final price and then creating a booking.
The parameters for this workflow are:

- 3 Passengers (ADT, CHD, INF)
- Existing booking with outbound and inbound flight
- Tariff: SPO
- CabinType: Y

Messages:

- :ref:`Sample_Create-simple-booking_JSON`

.. raw:: html

   <h3>Create booking with ancillaries</h3>

This workflow shows how to create a booking by searching flights, retrieving seatmaps and service catalogues for these flights and bundle them all together in one pricing/creation step.

The parameters for this workflow are:

- 1 ADT Passenger
- Only direct flights
- Tariff: SPO
- CabinType: Y
- Seat for ADT passenger on outbound flight
- Meal for ADT passenger on outbound flight

Messages:

- :ref:`Sample_Create-booking-with-ancillaries_JSON`

.. raw:: html

   <h3>Pay after booking</h3>

This workflow shows how to add a payment to a booking, that has been created before without payment information

The parameters for this workflow are:

- Existing booking with outbound flight
- 1 ADT Passenger
- Only direct flight

Messages:

- :ref:`Sample_Pay-after-booking_JSON`

.. raw:: html

   <h3>Update booking - Add flight</h3>

This workflow shows how to add a flight to an existing booking.

The parameters for this workflow are:

- Existing booking with outbound flight
- 3 Passengers (ADT, CHD, INF)
- Only direct flights
- Tariff: SPO
- CabinType: Y
- add inbound flight

Messages:

- :ref:`Sample_Update-booking-Add-flight_JSON`

.. raw:: html

   <h3>Update booking - Change flight</h3>

This workflow shows how to change the flight of an existing booking

The parameters for this workflow are:

- Existing booking with outbound and inbound flight
- 3 Passengers (ADT, CHD, INF)
- Only direct flights
- Tariff: SPO
- CabinType: Y
- change inbound flight

Messages:

- :ref:`Sample_Update-booking-Change-flight_JSON`

.. raw:: html

   <h3>Update booking - Delete flight</h3>

This workflow shows how to delete a flight of an existing booking

The parameters for this workflow are:

- Existing booking with outbound and inbound flight
- 3 Passengers (ADT, CHD, INF)
- Tariff: SPO
- CabinType: Y
- delete inbound flight

Messages:

- :ref:`Sample_Update-booking-Delete-flight_JSON`

.. raw:: html

   <h3>Update booking - Add passenger</h3>

This workflow shows how to add a passenger to an existing booking,

The parameters for this workflow are:

- Existing booking with outbound and inbound flight
- 2 Passengers (ADT, CHD)
- add infant passenger

Messages:

- :ref:`Sample_Update-booking-Add-passenger_JSON`

.. raw:: html

   <h3>Update booking - Change passenger name</h3>

This workflow shows how to change the name of a passenger on an existing booking.

The parameters for this workflow are:

- Existing with outbound and inbound flight
- 3 Passengers (ADT, CHD, INF)
- change name of CHD passenger

Messages:

- :ref:`Sample_Update-booking-Change-passenger-name_JSON`

.. raw:: html

   <h3>Update booking - Delete passenger</h3>

This workflow shows how to delete a passenger from an existing booking.

The parameters for this workflow are:

- Existing with outbound and inbound flight
- 3 Passengers (ADT, CHD, INF)
- remove INF passenger

Messages:

- :ref:`Sample_Update-booking-Delete-passenger_JSON`

.. raw:: html

   <h3>Update booking - Add service</h3>

This workflow shows how to add a service to an existing booking

The parameters for this workflow are:

- Existing with outbound and inbound flight
- 3 Passengers (ADT, CHD, INF)
- Add Meals for ADT + CHD passenger on outbound flight

Messages:

- :ref:`Sample_Update-booking-Add-service_JSON`

.. raw:: html

   <h3>Update booking - Change service</h3>

This workflow shows how to change a service of an existing booking

The parameters for this workflow are:

- Existing with outbound and inbound flight
- 3 Passengers (ADT, CHD, INF)
- Meals for ADT and CHD passenger on outbound flight
- remove ADT meal from outbound flight and put it on inbound flight

Messages:

- :ref:`Sample_Update-booking-Change-service_JSON`

.. raw:: html

   <h3>Update booking - Delete service</h3>

This workflow shows how to delete a service of an existing booking

The parameters for this workflow are:

- Existing with outbound and inbound flight
- 3 Passengers (ADT, CHD, INF)
- Meals for ADT and CHD passenger on outbound flight
- remove all meals

Messages:

- :ref:`Sample_Update-booking-Delete-service_JSON`

.. raw:: html

   <h3>Cancel booking</h3>

This workflow shows how to cancel a booking including the optional pricing step

The parameters for this workflow are:

- Existing with outbound and inbound flight
- 3 Passengers (ADT, CHD, INF)

Messages:

- :ref:`Sample_Cancel-booking_JSON`

.. raw:: html

   <h3>Create booking with 3DS</h3>

This workflow shows how to create a booking using the 3DS authentication version 1

The parameters for this workflow are:

- 1 ADT passenger
- direct flights
- 3DS-enrolled test credit card

Messages:

- :ref:`Sample_Create-booking-with-3DS_JSON`

.. raw:: html

   <h3>Create booking with 3DS including a reserved booking reference</h3>

This workflow shows how to create a booking using the 3DS authentication version 1.
This is a special workflow, where the inventory already reserves a booking reference, 
which then has to be transmitted again in the following request.

The parameters for this workflow are:

- 1 ADT Passenger
- direct flights
- 3DS-enrolled test credit card

Messages:

- :ref:`Sample_Create-booking-with-3DS-inclRef_JSON`

.. raw:: html

   <h3>Create booking with cash</h3>

This workflow shows how to create a booking with cash payment.

The parameters for this workflow are:

- 1 ADT Passenger
- direct flights

Messages:

- :ref:`Sample_Create-booking-with-cash_JSON`

.. raw:: html

   <h3>Create option booking</h3>

This workflow shows how to create an option booking. This booking has to be confirmed later

The parameters for this workflow are:

- 1 ADT Passenger
- direct flights

Messages:

- :ref:`Sample_Create-option-booking_JSON`

.. raw:: html

   <h3>Create booking with promotion code</h3>

This workflow shows how to create a booking including a promotion code

The parameters for this workflow are:

- 1 ADT Passenger
- direct flights
- test promotion code

Messages:

- :ref:`Sample_Create-booking-with-promotion-code_JSON`

.. raw:: html

   <h3>Create booking with ApiData</h3>

This workflow shows how to create a booking including ApiData, such as redress number and passport information

The parameters for this workflow are:

- 1 ADT Passenger
- direct flights

Messages:

- :ref:`Sample_Create-booking-with-ApiData_JSON`

.. raw:: html

   <h3>Create booking with Voucher</h3>

This workflow shows how to create a booking including a voucher code

The parameters for this workflow are:

- 1 ADT Passenger
- direct flights
- test voucher code

Messages:

- :ref:`Sample_Create-booking-with-Voucher_JSON`

.. raw:: html

   <h3>Update booking with Voucher</h3>

This workflow shows how to update a booking and adding a voucher code

The parameters for this workflow are:

- Existing booking with outbound and inbound flight
- 1 ADT Passenger
- test voucher code

Messages:

- :ref:`Sample_Update-booking-with-Voucher_JSON`

.. raw:: html

   <h3>Change RedressNumber</h3>

This workflow shows how to update a booking and change an existing redress number

The parameters for this workflow are:

- Existing booking with outbound and inbound flight
- 1 ADT Passenger with redress number

Messages:

- :ref:`Sample_Update-booking-Change-RedressNumber_JSON`