The select method is called immediately after the Search method to select the products found during the search process. The method allows for the assignment of Product IDs, which will be selected to the request made by the select method.
¶ Parameters
SessionId: The session ID in the login response.
SessionToken: The session token required for authorization. It is taken from the login response.
ProductId: The ID of the product to be allocated. This should be set based on the Search method's results.
SelectedServiceFee: Defines the service fee amount for the product allocation.
Below is an example of a basic Allocate request using SOAP:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:trev="http://schemas.datacontract.org/2004/07/Trevoo.WS.Entities.Base" xmlns:trev1="http://schemas.datacontract.org/2004/07/Trevoo.WS.IO.Shopping" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soapenv:Header/>
<soapenv:Body xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<tem:Allocate>
<tem:request>
<trev:AuthenticationHeader>
<trev:SessionId>4947934</trev:SessionId>
<trev:SessionToken>v</trev:SessionToken>
</trev:AuthenticationHeader>
<trev1:Form>
<trev1:SelectedItems>
<trev1:IO_AllocationItem>
<trev1:ProductId>edb66a56-50a8-4938-912d-4c6383f9a7e0</trev1:ProductId>
<trev1:SelectedServiceFee>
<trev1:Amount>20</trev1:Amount>
</trev1:SelectedServiceFee>
</trev1:IO_AllocationItem>
</trev1:SelectedItems>
</trev1:Form>
</tem:request>
</tem:Allocate>
</soapenv:Body>
</soapenv:Envelope>|
Parameters |
Description |
Optional |
|---|---|---|
|
SessionId |
A unique identifier used to define a specific session in which a user is granted access to an API for a certain period. You should get this parameter from the response of the Login Method. |
M |
|
SessionToken |
Unique authentication used to represent a specific session in which a user has access to an API. You should get this parameter from the response of the Login Method. |
M |
|
Parameters |
Description |
Optional |
|---|---|---|
|
ProductId |
It refers to a unique product identifier (ID) defined for a specific flight or service. This ID enables the identification and processing of the flight or additional service by the system. |
M |
|
SelectedServiceFee/Amount |
This amount determines the seller's (client's) commission. The same amount will be reflected as LastSellerCommission in response. If no commission calculation is required, set to 0 (zero). |
M |
|
Field |
Description |
|---|---|
|
HasError |
It is a status used to indicate whether an error occurred during the process.
|
|
ServiceError |
ServiceError represents a technical or business-related error that occurs during the payment process. |
|
SystemLogs |
It typically contains information or error messages related to system events that occur during the transaction. This field provides details about the situations encountered by the API server during the payment process. |
| Index | Field | Description |
|---|---|---|
| 1 | Id | It is the unique identifier for the ShoppingFile. This ID is used to track transactions performed during the session. |
| 2 | IfFinalized | It is a value that indicates whether the reservation has been finalized or is in a state where no further changes can be made. This parameter specifies whether passenger information can still be updated or if the transaction is locked in its final stage. |
| 3 | IsFlightInfoChanged |
It indicates whether the flight details have changed (e.g., flight times, airline, departure/arrival airports).
|
| 4 | IsPriceChanged |
It indicates whether the price has changed between the initial shopping process and finalization.
|
| 5 | IsReservationCancelled |
It indicates whether the reservation has been canceled.
|
| 7 | Is_CC_Payment_Enabled |
It indicates whether the credit card payment option is available.
|
| 8 | Is_RA_Payment_Enabled |
It indicates whether payment can be made using the Running Account (RA), a method used for corporate or airline-agreement payments.
|
| 9 | MaxSc | It indicates the maximum 'Service Class' value for a specific reservation or ticket. This parameter specifies up to which service level the ticket or reservation can be updated or modified. |
| 10 | MinSc | It indicates the minimum 'Service Class' value for a specific reservation or ticket. This parameter specifies the lowest service level to which the ticket or reservation can be updated or modified. |
|
11 |
RemainingSum |
It represents the remaining amount to be paid during the purchase or update of the ticket. This amount shows the balance the passenger needs to pay to complete the transaction and is typically updated after changes or additional services are applied. |
|
Index |
Field |
Description |
|---|---|---|
| 1 | BaseFare | The fare represents the cost of the ticket. This cost refers exclusively to the flight itself and does not include any additional expenses such as taxes, fees, or extra services. |
| 2 | BookingCode | This field is used to retrieve or query the unique identifier of a flight reservation. Typically, this is an alphanumeric code generated at the time of booking, which is used to track your ticket, flight details, and reservation status. |
| 3 | Currency | This field is used to query or set the currency used for ticket prices, fees, and other financial transactions. It is typically employed in operations such as purchasing flight tickets, pricing additional services, or making payments for services, to determine the relevant currency. |
| 4 | ExchangeCurrencyCode | It is necessary to convert ticket prices, fees, or other services into the currency of the user's location or the local market where the transaction takes place. This field is typically used to determine or query the code of the target currency during currency conversions. This method is especially important for international flights or for airlines that accept different currencies. |
| 5 | IsRefundable | Whether a ticket is refundable. This field provides information on whether the ticket purchased by the passenger can be refunded under certain conditions. |
| 6 | LastSellerCommission | The commission amount/service fee determined by the seller (client). |
| 7 | NetFare | It refers to the base fare to be charged to a passenger for a flight. |
| 8 | ProductId | It refers to a unique product identifier (ID) defined for a specific flight or service. This ID enables the identification and processing of the flight or additional service by the system. |
| 9 | SystemServiceFee | This element represents the system service fee associated with a transaction or service. |
| 11 | ServiceFee |
This element represents the service fee associated with a transaction or service. For example, if the service fee amount is 3, it is indicated as 3 in this field.
|
| 12 | Status | It represents the current status of the reservation process. This field indicates whether the reservation has been successfully completed. |
| 13 | Taxes | This XML element is used to denote the total amount of taxes applicable to a transaction or service within the Trevoo.WS.Entities.Shopping schema. |
| 14 | TotalFare |
The TotalFare element represents the complete amount to be paid for a transaction or service.
|
| 15 | Type |
The Type field typically indicates the type of reservation made.
|
| 16 | CanBeReserved |
It indicates whether a specific flight is eligible for reservation. CanBeReserved = True CanBeReserved = False
|
| Index | Field | Description |
|---|---|---|
|
1 |
CreationDate |
It shows the date and time when the ticket was initially created. |
|
2 |
Prebooking_ExpiresAt |
This field represents the expiration date and time of a prebooking. In other words, it indicates the deadline by which the customer must complete the reservation before making the payment. |
|
3 |
ReservationDate |
It indicates the date when the reservation was made. |
|
4 |
Reservation_ExpiresAt |
This field specifies the date and time when a reservation's validity expires. It represents the time period during which the reservation remains valid before payment is made. |
| Index | Field | Description |
|---|---|---|
|
1 |
BaseFare |
The fare represents the cost of the ticket. This cost refers exclusively to the flight itself and does not include any additional expenses such as taxes, fees, or extra services. |
|
2 |
ProductItemId |
This element contains a unique identifier (UUID) corresponding to a specific product item within the Trevoo.WS.Entities.Shopping schema. For example, the value |
|
3 |
LastSellerCommission |
The commission amount/service fee determined by the seller (client). |
|
4 |
SystemServiceFee |
This element represents the system service fee associated with a transaction or service. |
|
5 |
ServiceFee |
This element represents the service fee associated with a transaction or service. For example, if the service fee amount is 3, it is indicated as 3 in this field.
|
|
6 |
Baggage |
It refers to the passenger's allocated baggage allowance for the flight. This field includes details and limitations regarding the baggage the passenger is permitted to carry. |
|
7 |
VQ |
It is a field that indicates additional fees or service charges related to the journey or ticket. |
|
8 |
YR |
It generally refers to a type of additional fee or surcharge applied during the ticketing process. |
| Index | Field | Description |
|---|---|---|
|
1 |
Age |
It typically represents the passenger's age. |
|
2 |
LocalPaxType |
It represents the passenger's local type and classifies passengers based on their age or special conditions. This parameter is used in aviation systems to ensure that passengers receive appropriate services and that fare classifications are correctly applied. Typically, the 'LocalPaxType' parameter includes the following categories: ADT (Adult): Adult passenger (generally 12 years and older). CNN (Child): Child passenger (between 2-12 years old). INF (Infant): Infant passenger (0-2 years old, usually traveling on lap). SRC (Senior Citizen): Senior passenger (passengers above a certain age, depending on the airline). STU (Student): Student passenger (may qualify for special student discounts). MIL (Military): Military personnel passenger. CHD: Unaccompanied child passenger. |
|
3 |
LocalSequenceNo |
It refers to the local sequence number of the passenger in a reservation or ticketing process. This parameter is used to identify multiple passengers within the same reservation record (PNR - Passenger Name Record) in a specific order. |
|
4 |
PassengerId |
It is a value that represents the passenger's unique identification number. |
|
5 |
PaxReferenceId |
It is a unique reference number assigned to the passenger. |
| Index | Field | Description |
|---|---|---|
| 1 | BrandedFareItemId | It uniquely identifies a specific "branded fare" option, providing a unique ID corresponding to each package. |
| Index | Field | Description |
|---|---|---|
| 1 | PassengerCount | It indicates the number of passengers included in the pricing for each Branded Fare. |
| 2 | PassengerType |
It is a field that specifies the passenger's category or type.
|
| Index | Field | Description |
|---|---|---|
| 1 | BrandId |
Identifier that represents the brand identity of a specific airline or scheduled flight. This identifier helps distinguish between different fare levels or service packages offered to passengers. For example, some airlines offer different classes and service packages such as economy, premium economy, and business class under different brand identities. BrandId is used to distinguish these different service packages and provide information about a specific class or service package.BrandId is an identifier that represents the brand identity of a specific airline or scheduled flight. This identifier helps distinguish between different fare levels or service packages offered to passengers. For example, some airlines offer different classes and service packages such as economy, premium economy, and business class under different brand identities. BrandId is used to distinguish these different service packages and provide information about a specific class or service package. |
| 2 | BookingClass | "BookingClass" refers to the reservation class of a specific branded fare item. This field determines the class in which the passenger will travel and the services, flexibilities, and advantages offered by that class. It is usually represented by a single letter or a combination of letters. |
| 3 | CabinClass | It specifies the cabin class in which the passenger will be seated during the flight. This field defines different cabin classes that passengers can choose from based on their flight experiences and level of service preferences. |
| 4 | FareBasisCode |
"FareBasisCode" refers to the basic fare code that determines the pricing rules and conditions of the ticket. This code defines the fare class applicable to a flight and the flexibility, change, and cancellation conditions of the ticket. It is usually presented as a combination of letters and numbers (e.g., Y26, QFL, or E14NR). The FareBasisCode field indicates the pricing rules and conditions under which the ticket is sold. |
| 5 | FreeBaggageAllowanceId | FreeBaggageAllowanceId is an identifier that defines the free baggage allowance offered for a specific flight or fare class. This identifier indicates how much free baggage allowance passengers have when traveling in a specific fare class. |
| 6 | SeatsAvailable | It refers to the number of seats available for booking on a flight. This indicates the occupancy rate and remaining capacity of the flight. |
| 7 | SegmentId | SegmentId is an identifier that represents the identity of a specific flight or flight segment. Particularly in cases of multi-stop or connecting flights, there are different SegmentIds for each flight section. This allows passengers and systems to understand which part of a particular flight is being referred to. |
| Index | Field | Description |
| 1 | BaseFare | The fare represents the cost of the ticket. This cost refers exclusively to the flight itself and does not include any additional expenses such as taxes, fees, or extra services. |
| 2 | Currency | It indicates the currency in which the specified amount (Amount) for a particular flight or reservation is expressed. This specifies in which currency the ticket prices, taxes, and other fees are calculated and will be paid. |
| 3 | PaxSequence | It is a field that specifies the sequence of passengers' reservations. It refers to the numbering of passengers in a specific order during the reservation process. |
| 4 | PaxType |
It refers to the classification of passengers based on their age and status. It is important for ticket pricing, baggage allowance, service level, and other passenger services. The PaxType field helps airlines and travel agencies accurately classify passenger information and develop appropriate service and pricing strategies for each passenger type. |
| 5 | Taxes | This XML element is used to denote the total amount of taxes applicable to a transaction or service within the Trevoo.WS.Entities.Shopping schema. |
| 6 | TotalFare |
The TotalFare element represents the complete amount to be paid for a transaction or service.
|
| Index | Field | Description |
|---|---|---|
|
1 |
Amount |
This field specifies the monetary value associated with the change policy of a flight. It indicates the cost that applies when a policy is changed. This ensures accurate and transparent management of fees related to policy Cancellation for flights. |
|
2 |
Applicability |
It is a field that specifies under which conditions a ticket can be canceled and in which situations the cancellation is valid.
|
|
3 |
MinutesToDeparture |
It indicates the amount of time remaining (in minutes) until a flight's departure and determines the impact of this duration on the cancellation of the ticket. It specifies the remaining time for a ticket to be canceled and describes the effect of this time on cancellation policies. This information helps passengers understand how much time they have in case of a flight cancellation and how the cancellation can be executed. |
|
4 |
Currency |
It indicates the currency in which the specified monetary values are denominated. This field specifies the currency used for calculating and displaying ticket prices, taxes, service fees, and other costs, such as TRY (Turkish Lira), USD (US Dollar), EUR (Euro), and GBP (British Pound). |
|
5 |
IsRefundable |
Whether a ticket is refundable. This field provides information on whether the ticket purchased by the passenger can be refunded under certain conditions. |
| Index | Field | Description |
|---|---|---|
| 1 | Amount | This field specifies the monetary value associated with the change policy of a flight. It indicates the cost that applies when a policy is changed. This ensBrandedFaresures accurate and transparent management of fees related to policy changes for flights. |
| 2 | Applicability |
It refers to a field that specifies under what conditions and in what manner ticket changes can be implemented.
|
| 3 | MinutesToDeparture | It expresses how much time (in minutes) is left until a flight's departure and specifies the impact of this time on ticket changes. It determines the permissible time frame for ticket changes and shows how long before the flight passengers can make changes to their tickets. |
| 4 | Currency | It indicates the currency in which the specified monetary values are denominated. This field specifies the currency used for calculating and displaying ticket prices, taxes, service fees, and other costs, such as TRY (Turkish Lira), USD (US Dollar), EUR (Euro), and GBP (British Pound). |
| 5 | IsChangeable | This field provides information on whether the ticket purchased by the passenger can be exchanged under certain conditions. |
| Index | Field | Description |
|---|---|---|
| 1 | TotalFare |
The TotalFare element represents the complete amount to be paid for a transaction or service.
|
| 2 | TotalTaxes | It includes the total amount of all taxes added to the passenger's ticket price. |
| Index | Field | Description |
|---|---|---|
| 1 |
BrandCode |
Is a code that represents the brand identity of a specific airline or flight. This code is used to distinguish between different fare levels or service packages. BrandCode helps passengers determine which services or benefits they will receive when making a reservation. Airlines typically offer various service packages under different brand identities, and these packages may include different features, benefits, or limitations. |
|
2 |
BrandId |
Identifier that represents the brand identity of a specific airline or scheduled flight. This identifier helps distinguish between different fare levels or service packages offered to passengers. For example, some airlines offer different classes and service packages such as economy, premium economy, and business class under different brand identities. BrandId is used to distinguish these different service packages and provide information about a specific class or service package.BrandId is an identifier that represents the brand identity of a specific airline or scheduled flight. This identifier helps distinguish between different fare levels or service packages offered to passengers. For example, some airlines offer different classes and service packages such as economy, premium economy, and business class under different brand identities. BrandId is used to distinguish these different service packages and provide information about a specific class or service package. |
| 3 | BrandName | BrandName refers to the name of a specific fare class or service package. BrandName is used to describe the different service levels or benefit packages offered by airline companies. |
| Index | Field | Description |
|---|---|---|
| 1 | Application |
That specifies the conditions and manner under which a particular fare class or service package is applied. This field explains the circumstances in which a specific fare or service package is valid and the restrictions that apply to it.
|
|
2 |
DisplayType |
DisplayType is a field that specifies how a particular fare or service package will be displayed to the user. DisplayType controls how this information is presented in the user interface. |
| 3 |
RuleDescription |
RuleDescription contains the description of the rules and conditions associated with a specific fare class or service package. This description aims to provide passengers with detailed information about a particular fare or service package. The RuleDescription field typically includes information such as: • Baggage Allowance: Free baggage allowance, carry-on baggage allowance, additional baggage fees, etc. • Change and Cancellation Policies: Reservation changes, cancellations, refund conditions, etc. • Services and Benefits: Included services (meal service, lounge access, extra legroom, etc.). • Other Conditions: Special situations, restrictions, additional fees, etc. |
| 4 | ServiceGroup | That categorizes the services and benefits associated with a specific fare class or service package. This field allows for the presentation of services and benefits offered to passengers under specific groups. |
| Index | Field | Description |
|---|---|---|
| 1 | Allowance | The "allowance" method is commonly used to access information about passengers' baggage entitlements, detailing how much luggage they can carry. This method may include specifics such as the maximum weight and dimensions allowed for both carry-on and checked baggage. Additionally, it can provide information on fees for excess baggage and regulations for special items, such as sports equipment or musical instruments. |
| 2 | Category |
Specifies the type of baggage.
|
| 3 | Type |
Defines how the quantity of the baggage is measured.
|
| 4 | Unit |
Indicates the unit of measurement for the baggage.
|
| 5 | PaxType |
It refers to the classification of passengers based on their age and status. It is important for ticket pricing, baggage allowance, service level, and other passenger services. The PaxType field helps airlines and travel agencies accurately classify passenger information and develop appropriate service and pricing strategies for each passenger type. |
| Index | Field | Description |
|---|---|---|
| 1 | SegmentId | SegmentId is an identifier that represents the identity of a specific flight or flight segment. Particularly in cases of multi-stop or connecting flights, there are different SegmentIds for each flight section. This allows passengers and systems to understand which part of a particular flight is being referred to. |
| 2 | ArrivalDay | It indicates the day when the airplane reaches its destination. This information provides users with details about the flight's arrival date and day. For example, knowing on which day the flight will arrive is particularly important for long-haul flights across different time zones. |
| 3 | ArrivalTime | "ArrivalTime" refers to the arrival time of the flight. This field indicates the time when the flight lands at the designated destination airport. It is usually presented in date and time format (e.g., YYYY-MM-DDTHH) and helps passengers know when the flight will arrive. |
| 4 | BookingClass |
"BookingClass" refers to the flight reservation class. This field indicates the class in which the passenger will travel during the flight and is usually represented by a single letter. For example:
|
| 5 | DepartureDay | "DepartureDay" refers to the departure day of the flight. This field indicates the scheduled departure date of the flight and is usually presented in date format (e.g., YYYY-MM-DD). |
| 6 | DepartureTime | "DepartureTime" refers to the departure time of the flight. This field indicates the scheduled departure time of the flight and is usually presented in hour and minute format (e.g., HH). |
| 7 | DestinationCode | "DestinationCode" refers to the destination of the flight. This field indicates the code of the airport where the flight will arrive. Usually, three-letter airport codes determined by IATA (International Air Transport Association) are used. For example: JFK: New York John F. Kennedy Airport LHR: London Heathrow Airport CDG: Paris Charles de Gaulle Airport |
| 8 | Duration | "Duration" refers to the total duration of the flight. This field indicates the time elapsed from the departure point to the arrival point and is presented in minutes. |
| 9 | Equipment | Refers to the type or model of aircraft used for the flight. This field indicates which aircraft model will be used for a specific flight segment and is usually presented in three-letter codes determined by IATA. |
| 10 | FareBasis |
"FareBasis" refers to the basic fare code that determines the pricing rules and conditions of the ticket. This code defines the fare class applicable to a flight and the flexibility, change, and cancellation conditions of the ticket. It is usually presented as a combination of letters and numbers (e.g., Y26, QFL, or E14NR). The FareBasis field indicates the pricing rules and conditions under which the ticket is sold. |
| 11 | FareType | It refers to the fare type or tariff of the booked ticket. The 'FareType' indicates which fare category or class the ticket belongs to. |
| 12 | FlightNumber | "FlightNumber" refers to the number that identifies a specific flight. This number is uniquely assigned to each flight by the airline and is usually used in conjunction with the airline code. For example, "BA123" denotes a British Airways flight, while "TK270" refers to a Turkish Airlines flight. |
| 13 | MarketingAirline |
Refers to the airline that markets and sells the flight. This airline is considered the brand that appears during the booking and ticketing process and is usually represented by a two-letter code assigned by IATA. For example:
|
| 14 | OD_DestinationCode | "OD_DestinationCode" refers to the final destination of the trip. |
| 15 | OD_OriginCode | "OD_OriginCode" refers to the origin point of the flight. |
| 16 | OperatingAirline |
"OperatingAirline" refers to the airline that actually operates the flight. This field may differ from the airline that markets or tickets the flight (MarketingAirline). The OperatingAirline field indicates the airline that physically operates the flight and is usually represented by a two-letter code assigned by IATA (International Air Transport Association). |
| 17 | OriginCode | "OriginCode" refers to the origin point of the flight. This field indicates the code of the airport where the flight begins and usually uses the three-letter airport codes determined by IATA (International Air Transport Association). |
| 18 | SelectedBrandedFareItemId | It is a unique identifier representing the selected branded fare type for a specific flight segment. |
| 19 | SequenceNo |
"SequenceNo" refers to the number that indicates the order or position of a specific segment in a flight search. This field is used to denote the sequence of each segment in cases where there are multiple flight segments. For example, a flight route might consist of multiple segments as follows:
In this example, the SequenceNo could be:
|
| Index | Field | Description |
|---|---|---|
| 1 | BusinessId | It refers to the unique identifier of the customer making the reservation or transaction (usually a company or business). This parameter is typically an identification number used for corporate clients. |
| 2 | BusinessName | It refers to the name of the commercial entity or company that makes the reservation or handles the ticketing process. This parameter is used to identify the company responsible for the booking, especially in corporate or business-related travel. |
| 3 | It refers to the email address of the customer who made the reservation or received information about the flight. This field is used to communicate with the customer, share reservation details, send e-tickets, and provide flight-related updates. | |
| 4 | Key | It refers to a unique identifier used to define or access customer information. This field is used to ensure that the information related to a customer or passenger is accurately processed and managed within the system. |
| 5 |
Phone
|
It refers to the phone number of the customer or passenger. This field is used to communicate with the customer, provide updates during the reservation process, or contact them in case of emergencies. |
| 6 | Username | It refers to the username of the customer who made the reservation or transaction. This username is used to identify and manage the customer's information and account. |
| Index | Field | Description |
|---|---|---|
|
1 |
GrandTotal |
It refers to the total final amount the passenger is required to pay for a reservation. |
| Index | Field | Description |
|---|---|---|
|
1 |
InCart |
It indicates whether the relevant fee or ticket is currently in the shopping cart. This parameter is used to determine the stage of the transaction process and the status of the ticket in the reservation workflow.
|
|
2 |
ProductId |
It refers to the unique identifier of a specific product or service that has been purchased or priced. This identifier is used to track and manage each product or service within the system. |
|
3 |
ProductType |
It refers to the type of the service or product being priced. |
|
4 |
Total |
It refers to the total amount to be paid for the reservation or ticket. |
| 1 | Guid | It is the unique identifier of the selected final product(s), enabling the tracking of related reservation or allocation processes within the system. |
|---|