.. _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-Delete-flight-OrderChange.rst
samples/Sample_Update-booking-Add-passenger.rst
samples/Sample_Update-booking-Change-passenger-name.rst
samples/Sample_Update-booking-Change-passenger-loyalty-number.rst
samples/Sample_Update-booking-Delete-passenger.rst
samples/Sample_Update-booking-Add-service.rst
samples/Sample_Update-booking-Add-service-with-3DS.rst
samples/Sample_Update-booking-Change-one-service.rst
samples/Sample_Update-booking-Change-multiple-services.rst
samples/Sample_Update-booking-Delete-service.rst
samples/Sample_Cancel-booking.rst
samples/Sample_Cancel-booking-OrderChange.rst
samples/Sample_Create-booking-with-3DS.rst
samples/Sample_Create-booking-with-3DS-inclRef.rst
samples/Sample_Create-option-booking.rst
samples/Sample_Convert-optional-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
Create simple booking
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)
- Only direct flights
- Tariff: SPO
- CabinType: Y
Messages:
- :ref:`Sample_Create-simple-booking`
.. raw:: html
Create booking with ancillaries
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:
- 3 Passengers (ADT, CHD, INF)
- 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`
.. raw:: html
Pay after booking
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`
.. raw:: html
Update booking - Add flight
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`
.. raw:: html
Update booking - Change flight
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`
.. raw:: html
Update booking - Delete flight
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)
- Only direct flights
- Tariff: SPO
- CabinType: Y
- delete inbound flight
Messages:
- :ref:`Sample_Update-booking-Delete-flight`
.. raw:: html
Update booking - Delete flight using OrderChange
This workflow shows how to delete a flight of an existing booking using the OrderChangeRQ
The parameters for this workflow are:
- Existing booking with outbound and inbound flight
- 1 ADT Passengers
- Only direct flights
- Tariff: SPO
- CabinType: Y
- delete inbound flight
Messages:
- :ref:`Sample_Update-booking-Delete-flight-OrderChange`
.. raw:: html
Update booking - Add passenger
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`
.. raw:: html
Update booking - Change passenger name
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`
.. raw:: html
Update booking - Change passenger loyalty number
This workflow shows how to change the loyalty number of a passenger on an existing booking.
The parameters for this workflow are:
- Existing with outbound flight
- 1 Passenger (ADT)
- change loyalty number of ADT passenger
Messages:
- :ref:`Sample_Update-booking-Change-passenger-loyalty-number`
.. raw:: html
Update booking - Delete passenger
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`
.. raw:: html
Update booking - Add service
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`
.. raw:: html
Update booking - Add service with 3DS
This workflow shows how to add a service of an existing booking with 3DS
The parameters for this workflow are:
- Existing with outbound flight
- 1 ADT Passenger
- Rail & Fly for ADT on outbound flight
- add RFDB1 Rail&Fly to outbound flight
Messages:
- :ref:`Sample_Update-booking-Add-service-with-3DS`
.. raw:: html
Update booking - Change one service
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-one-service`
.. raw:: html
Update booking - Change multiple services
This workflow shows how to change multiple services of an existing booking
The parameters for this workflow are:
- Existing with outbound and inbound flight
- 2 Passengers (2 x ADT)
- Extra baggage's for all ADT passenger on outbound and inbound flight
- remove old extra baggage's from outbound and inbound flight and add new ones to outbound and inbound flight
Messages:
- :ref:`Sample_Update-booking-Change-multiple-services`
.. raw:: html
Update booking - Delete service
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)
- Meal for ADT on inbound and meal for CHD passenger on outbound flight
- remove all meals
Messages:
- :ref:`Sample_Update-booking-Delete-service`
.. raw:: html
Cancel booking
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)
- workflow uses :ref:`IATA_OrderCancelRQ/RS`
Messages:
- :ref:`Sample_Cancel-booking`
.. raw:: html
Cancel booking using OrderChange
This workflow shows how to cancel a booking using an IATA_OrderChangeRQ including the optional pricing step
The parameters for this workflow are:
- Existing with outbound and inbound flight
- 1 ADT Passenger
- workflow uses :ref:`IATA_OrderChangeRQ`
Messages:
- :ref:`Sample_Cancel-booking-OrderChange`
.. raw:: html
Create booking with 3DS
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`
.. raw:: html
Create booking with 3DS including a reserved booking reference
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:
- 3 Passengers (ADT, CHD, IND)
- direct flights
- 3DS-enrolled test credit card
Messages:
- :ref:`Sample_Create-booking-with-3DS-inclRef`
.. raw:: html
Create option booking
This workflow shows how to create an option booking. This booking has to be confirmed later (Not yet implemented)
The parameters for this workflow are:
- 1 ADT Passenger
- direct flights
Messages:
- :ref:`Sample_Create-option-booking`
.. raw:: html
Create booking with promotion code
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`
.. raw:: html
Create booking with ApiData
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`
.. raw:: html
Create booking with Voucher
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`
.. raw:: html
Update booking with Voucher
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`
.. raw:: html
Change RedressNumber
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`