How can we help?
Follow
GetPackages

*NEW: Postman API Examples

GetPackages request is used to fetch updated information about a room, such as images, descriptions, amenities, price, taxes, etc.

In order to use the request, the Hotels Search request that came before that must be one of the following 'DetailLevels': Meta, MetaNoTax, MetaAdvanced, MetaExtended, NoPackages or NoPackagesNoTax.

Use this request in the following scenarios:

  • Sending a ‘Search Hotels’ request where ‘DetailLevel’ value is Meta or ‘NoPackages’ and you want to receive a more detailed price breakdown and room information. 
  • Sending a search request when DetailLevel value is Meta or NoPackages and you have received rooms info in the response from some of the suppliers, yet no rooms info retrieved from some other suppliers. In order to receive room info from the rest of the suppliers, you will need to use the ‘GetPackages’ API call.
  • You would like to get the applicable payment option for the packages under a certain hotel ID. This is only relevant for Gross suppliers' accounts that support different payment types: Deposit / Guarantee / Immediate Payment / Etc.

Please note:

  1. Refrain from sending parallel requests in the same session for the same HotelID, this will lead to instability/inconsistency in the response. You must wait until a response is returned before sending a new request with the same HotelID.
  2. The usage of the GetPackages API call needs to be enabled in Travolutionary for the affiliate.
  3. The room details as appear in the voucher & confirmations templates and in the back-office will be replaced with the RoomName that was returned in this API call response and as was saved in our database when the segment was created.
  4. For GetPackages call to work properly, do not use the GetDetails call in the same Session.
  5. OrderService, GetOrder & GetOrders methods were adjusted to return the RoomName as returned in this API call response and as was saved in our database when the segment was created.

The request must be directed to the following service (unless you are using a dedicated endpoint):

https://cert-services.travolutionary.com/bookingservices/dynamicdataservice.svc

*Please note, this is a link to the cert environment, if you've already been certified, please use the endpoint you're familiar with.

 

Request Headers

In order to successfully send the request, please specify the following headers:

XML headers:

Method: POST

Content-Length: 628

Expect: 100-continue

Accept-Encoding: gzip, deflate

SOAPAction: "http://tempuri.org/IDynamicDataService/ServiceRequest"

Content-Type: text/xml; charset=utf-8

 

JSON headers:

Method: POST

Content-Type: application/json; charset=utf-8

Content-Length: 257

Expect: 100-continue

Accept-Encoding: gzip, deflate

 

Request body

Field Name Field Type Description Mandatory
HotelID Integer The HotelID that was returned in the search response of the specified SessionID (see below) and for which the GetPackages should return a result. Yes
ReturnTaxesAndFees

 Boolean

false - Taxes and fees details will not return in the response.
true - The result will include full taxes and fees breakdown, only if the below two conditions are met:

1. The supplier returned Taxes and Fees information.

2. The implementation of reading this information is part of the supplier integration in the system.

Currently, the following suppliers' integrations are implemented to support this functionality:

Amadeus, Bonotel, Booking.com, Expedia, ExpediaSite, GetARoom, GRNConnect, Hotelbeds (V2 - APItude), Priceline, Tourico

 No
TimeoutSeconds

Integer

Specify the maximum wait time for the results to be returned.

No
ReturnSRSP Boolean

Also known as "RSP" - Recommended Selling Price.

If specified as True, the Supplier Recommended Selling Price (As a Double Type) will be returned under the HotelRoomPackage, above the "SimplePrice" field.

The SRSP is returned by the following suppliers: TotalStay (TTS), HotelBeds (HB2), WelcomeBeds (WLC) and AbreuOnlline (ABR), RateHawk (RTH)-"min_price" in the SRSP tag, GetARoom (GTR) - "reference-amount" as SRSP, BedToYou (SHT) - "minAmount" as SRSP.

No
ReturnProfit Boolean

If set to 'true', the tag TotalProfit will be returned in the response, it will give an indication for the expected profit.

The currency will be shown in the search currency.
Please note that the profit is the total profit of the affiliate and not the profit of the actual user or node.

No
 SessionID String The SessionID as returned in the Search Response and in which the HotelID was returned. Yes
RequestType ServiceRequestType Specify: GetPackages Yes
TypeOfService ServiceTypeEnum Specify: Hotels Yes

 

Response body

Please be advised: This information is being returned as is, based on the supplier response, without any calculations or other logic applied.

Field Name

Field Type

Description

ContractId

Integer

The contract ID from which the rate originated

 

 

 

HotelId

Integer

The hotel's ID from our hotel/property list (that can be retrieved from our Mapping.Works lite tool)

PackageId

String

The unique package ID of the rate

PackagePrice

Object

Contains information about the pricing, i.e. original price, price after taxes applied, etc.

Refundability

Refundable/Nonrefundable

Contains information the supplier provided regarding the package's refundability, please note, it is not final and should not be used to determine the final cancellation policy.
Please call 'CancellationPolicyRequest' in order to fetch the most updated data

Remarks

String

The supplier's remarks regarding the taxes and fees

AdultsCount

Integer

Number of adults to stay in a room

Availability

String

Available/On Request

BedType

String

Bed type as parsed from the room name.
Will return only if room name contains proper bed type.

ID

String

Room ID

RoomBasis

String

more information can be acquired at the Room Static Values documentation

RoomName

String

The room name we fetched from the supplier.
Includes the Roomtype and Bedding.

SpecialDeals

String

Special deals regarding the selected package we fetched from the supplier if any exist

SimplePrice

Integer

similar to FinalPrice in its meaning

SupplierId

Integer

Supplier's ID, as can be found in our Hotel Suppliers document

SupplierName

String

Supplier's name, as can be found in our Hotel Suppliers document

RoomsContent

ArrayOfRoomContent

an array of rooms content

RoomContent

RoomContent

Includes the Room Content: Amenities, Descriptions, Images and a reference point (RoomKey) to be used as a “Room Content Dictionary 

Amenities

ArrayOfstring

List of Room Amenities as retrieved from the source and processed by TV

Descriptions

ArrayOfstring

List of Room Descriptions as retrieved from the source and processed by TV

Images

ArrayOfstring

List of Room Images as retrieved from the source and processed by TV

Note: the images are sorted in a recommended display manner

TargetRoomKey

String

The room key of the room’s content source. The room’s TargetRoomKey that was retrieved in the result should be matched to this RoomKey in order to fetch the corresponding Room Content

The TargetRoomKey is fetched from specific most trusted suppliers

Sample format: 9528aaf7-50ba-4b9f-ab81-da59c1766b4c

 

if "ReturnTaxesAndFees" is set to true in the request body, the following fields will appear as well:

More information about Taxes & Feeds can be found here

Field Name Type Explanation
Currency string The taxes and fees currency as the supplier returned
FeeTitle string The taxes and fees title as the supplier returned

FrequencyType

string

Represents the tax repetitive type: Other, NotApplicable, NotSpecified, PerMinute, PerHour, PerHalfDay, PerNight, PerWeek, PerStay

IsIncludedInPrice 

boolean

Represents if the taxes and fees are included in the final price

IsMandatory

boolean

Represents if the taxes and fees are mandatory to be paid. For instance, 'resort fees' are typically mandatory, while 'wifi fee' might not.
IsValuePercentage  boolean Represents if the tax or fee is percentage value or an absolute value
UnitType string

Represents the taxes and fees categorization type: Other, NotApplicable, NotSpecified, PerChild, PerAdult, PerNight,
PerRoom, PerStay, PerPerson, PerOccurrence, PerItem, PerReservation

Other:
Happens when the supplier returns tax/fee amount, but didn't specified a title which we didn't recognize

NotApplicable:
Happens when the supplier returns tax/fee amount, and specified that this fee is not applicable for the selected room.

NotSpecified:
Happens when the supplier returns tax/fee amount, but didn't specify any title for it.

PerOccurrence:
of the fee title

PerItem:
for example - number of speedboats

PerReservation:
The tax will be applied per the entire reservation

Value string The decimal value of the taxes and fees

 

CreditCard Field

The value affects the payment method to be specified in the booking request. (The available payment methods will return also in Payment Preferences response).

 

The field indicates how the credit card will be charged or used at the booking step.
Please note that only gross feeds will have these values returned.

 

XML Response JSON Response Description
immediatePayment 0

Default value. In this case, the payment method on book request will be CreditCardExternal.

Guarantee 1

The payment method to be passed in the booking request is CreditCardExternal, but the supplier will not charge the credit card and the actual payment will be made by the hotel upon arrival, or in case of cancellation after the cancellation policy's deadline.

Deposit 2 The payment method to be sent in the booking request is CreditCardExternal.
Read more information below.
NotRequired 3 The payment is to be made at the hotel upon arrival. The payment method to be sent in the booking request is PayUponArrival. Credit card details are not required.


 

For Guarantee and Deposit, another value will also return in the package details in the price section (depending on the response from the supplier) -  PayOnArrivalFinal.
The credit card will be charged for the sum = FinalPrice - PayOnArrivalFinal. The PayOnArrivalFinal amount is to be paid at the hotel upon arrival.

The PayOnArrivalFinal tag is meant for helping clients calculate and display a price for payment at the booking stage.
The PayOnArrivalFinal is not guaranteed to be available as it depends on the response from the supplier.
In case this tag does not return for a rate with CreditCard = "Guarantee" or "Deposit", the client should display the full amount as the booking price, without calculating. 

 

Further information

More information about the request can be acquired through the .pdf implementation guide attached to this article, and example requests and responses are attached as well, in XML as well as JSON formats.

Was this article helpful?
1 out of 2 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk