RetrieveReservationList

Method Goals

This method aims to return a list of bookings for a given time period being that either booking date or the travelling date, among other filters available.

Request Format

The filter can be set between two time periods, search by email, origin, destination, agency, passenger name/surname, etc.

Response Format

The result return a briefing of the basic information of the bookings that match the query’s filters.

Remarks

Not implemented by all suppliers

RetrieveReservationListRQ Description

Element Number Type Description
RetrieveReservationListRQ 1 Root node.
ReservationDate 0..1 Date Reservation date.
DepartureDate 0..1 Date First journey departure date.
ReservationDateFrom 0..1 Date Search by reservation date range: form reservation’s date. Example: 2019-04-15T18:25:00
ReservationDateTo 0..1 Date Search by reservation date range: to reservation’s date. Example: 2019-04-15T18:25:00
DepartureDateFrom 0..1 Date Search by departure date range: form departure’s date. Example: 2019-04-15T18:25:00
DepartureDateTo 0..1 Date Search by departure date range: to departure’s date. Example: 2019-04-15T18:25:00
ClientEmail 0..1 String Email.
OriginCode 0..1 String First journey origin code (IATA).
DestinationCode 0..1 String First journey destination code (IATA).
AgencyCode 0..1 String Agency code.
TransportationId 0..1 String The id of transportation. Ex: FR2022
Passenger 0..1 Contains information of the Passenger.
@id 0..1 Integer Unique identifier of the passenger.
@title 0..1 Title type Title type
@name 1 String Name of the Passenger.
@surname 1 String Surname/s of the Passenger.
@birthDate 0..1 Date Date of birth. Example: 2019-04-15T18:25:00
@codeDCO 0..1 Integer Consolidate document number.
@documentType 0..1 Document type Document type.
@documentId 0..1 String Unique identifier of the documentation.
@documentExpiration 0..1 Date Expiration date of the documentation. Example: 2019-04-15T18:25:00
@documentExpedition 0..1 Date Expedition date of the documentation. Example: 2019-04-15T18:25:00
@nationality 0..1 String Nationality. ISO 3166-1 Alpha-2 Code
@gender 0..1 Char Gender.
@language 0..1 String Language. ISO 3166-1 alpha-2 format lowercase.

RetrieveReservationListRS Description

Element Number Type Description
RetrieveReservationListRS 1 Root node.
ReservationList 1 Contains a list of Reservations.
ReservationList/PaymentInfo 1..n Contains some basic information of the booking.
@locator 1 String Booking locator.
@totalAmount 0..1 Decimal Total amount.
@currency 0..1 String Currency code of the fare.
ReservationList/PaymentInfo
/ReservationStatus
1 Current status of the reservation.
ReservationList/PaymentInfo
/ReservationStatus/ReservationStatusType
1 String Reservation Status type: CONFIRMED, CANCELLED.
ReservationList/PaymentInfo
/OriginCode
0..1 String First journey origin code.
ReservationList/PaymentInfo
/DestinationCode
0..1 String First journey destination code.
ReservationList/PaymentInfo
/ReservationDate
0..1 Date Reservation date.
ReservationList/PaymentInfo
/DepartureDate
0..1 Date First journey departure date.
ReservationList/PaymentInfo
/MainPaxName
0..1 String Name and surname of the main passenger of the reservation.
ReservationList/PaymentInfo
/HolderName
0..1 String Name of the holder of the reservation.
Locators 0..n Contains details of the locator.
Locators/Locator/Id 1 String Unique identifier of the locator.
Locators/Locator/Type 1 Locator type The locator’s type
Version 0..1 String Booking version.

Comments