======= TEAM AMERICA XML 3.0 J =======
Dear valuable partner,
Welcome to the Teamamerica Hotels XML Interface Guide.
We hope you will have a smooth and successful integration to our system.
Should you have any question or need any assistance, please contact:
it@teamamericany.com
TLS Secured Development Doclit WSDL https://javatest.teamamericany.com:8443/TADoclit/services/TADoclit?wsdl\\
{{:documentation:xmlschema.gif?nolink|}}
* **STEP 1: SEARCH**
When you search for a product each one of the results might be either "Available" or "On Request".
When you book an "Available" the item will become CF (Confirmed)
When you book a "On Request" the item will become RQ
Cancellation is possible in this step. The system will cancel and disappear the item from the reservation. If there are Cancellation fees, the system will create a new item in the reservation with the total balance.
* **STEP 2: BOOKING**
//PROCESSING// →
During this step we send a message to the hotel with the new Item
CF becomes PK during this process
RQ becomes PR during this process
Important: Cancellation during this step is not possible. If a cancellation request is sent to our system regarding an item which is in PK or PR, the function will return an Error Message
//CONFIRMATION// →
The hotel answers with their Confirmation Number
PK becomes BK
PR becomes BK if the request gets approved and UC if it is not approved
* **STEP 3: INFORMATION RETRIEVAL**
Retrieve any information of existing bookings.
* **STEP 4: CANCELLATION AFTER CONFIRMATION** (Just if needed)
When an item has been confirmed and it needs to be cancelled we send a request of cancellation to the hotel. The item can not be considered cancelled until the hotel confirms the cancellation
BK becomes XB when we receive your cancellation request
XB becomes PX when we send the cancellation request
PX becomes CX when the Hotel confirms the cancellation
If there are Cancellation fees, the system will create a new item in the reservation with the total balance.
----
======1.SEARCH======
**SEARCH FUNCTIONS:** Everything needed to search and build a result is under this set of Functions. to enhance the response time we recommend having everything cached on a regular basis and only the newly designed [[documentation:team3#pricesearch|PriceSearch]] function looking dynamically for prices within our system.
(v3)This newly designed Functions are the Core of the Version 3. We Guarantee Speed Increase if applied as specified.
----
=====✔ PriceSearch=====
**Description:**
PriceSearch is a new version price search .
The request is exactly the same as in PriceSearch but it returns the following additional parameters:
* MealPlan
* RoomType
* ChildAge
* FamilyPlan
* NonRefundable
* MaxOccupancy
* WebPriority
:!: //Web Priority shows Team America Special Products, those with Exclusive Promotions like TeamPlayers //
:!: //Our PriceSearch functions are built to return prices as **quickly** as possible, but may lack important information and restrictions which is visible in a ProductInfoV2 request. //
** Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |PriceSearch | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |CityCode |string |1 |Y |Use [[documentation:team3#listcities|ListCities]] to get City Codes from all available Cities|
|1 |ProductCode |string |1 |Y |for all products in that city leave it blank|
|1 |Type |string |1 |Y | ‘Hotel’ as default for searching hotels|
|1 |Occupancy |string |1 |Y |Accepts only 1 Occupancy type per request. Single, Double, Triple, Quad, SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH|
|1 |ArrivalDate |string |1 |Y |ISO YYYY-MM-DD|
|1 |NumberOfNights |int |1 |Y |Must be a value between 1 and 23. |
|1 |NumberOfRooms |int |1 |Y |1 to max 3 rooms |
|1 |NationalityCode | string | 1 | N | 2 Character ISO standard Country Code |
|1 |DisplayCloseOut |string |1 |N | Y/N |
|1 |DisplayOnRequest |string |1 |N | Y/N |
|1 |VendorIDs | |1 |N |
|2 |VendorID |int |1 |N | in this block you may enter 1 or more specific vendor ID’s (Hotels), and narrow the search results to only your preferred hotels |
username
password
NYC
Hotel
Single
2017-12-12
2
1
US
N
N
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |PriceSearchResponse | |1 | |
|1 |ProductCode |string |1 |Y |
|1 |TeamVendorID |int |1 |Y |Unique Hotel ID|
|1 |ProductDate |string |1 |Y | Check In date|
|1 |MealPlan |string |1 |Y | |
|1 |RoomType |string |1 |Y | |
|1 |ChildAge |int |1 |Y | |
|1 |FamilyPlan |string |1 |Y | Y if Family Plan Available, N if not|
|1 |NonRefundable |int |1 |Y | |
|1 |MaxOccupancy |int |1 |Y | |
|1 |NightlyInfo | | |N |
|2 |Dates |string |1 |Y |Specific night|
|2 |Status |string |1 |Y | Available/OnRequest/ClosedOut|
|2 |PromoMessage |string |1 |N | Text with promo offers, if exists |
|2 |MinStay |int |1 |Y |
|2 |MaxStay |int |1 |Y |
|2 |ArrivalRestriction |string |1 |N |
|2 |Prices | |1 |N | Per Room, Per night, divided by Occupancy|
|3 |Occupancy |int |1 |Y | Single/Double/Triple/Quad |
|3 |AdultPrice |float |1 |Y | Total price of the Room for the specific night|
|1 |AverageRate | |1 |N | Per Room, divided by Occupancy|
|2 |Occupancy |int |1 |Y | Single/Double/Triple/Quad|
|2 |**AverageNightlyRate ** |float |1 |Y | Average nightly price of the occupancy, use this value for RateExpected when booking|
|1 |WebPriority |int |1 |Y | Team America Preferred|
BKLHALOFTD
Hotel
5174
2013-02-20
CP-CONTINENTAL BREAKFAST
STANDARD
12
Y
0
4
2013-02-20
Available
0
0
Allowed
Single
166
Single
166
3
. . . .
**Errors**
*Error - Login Invalid
*Error - Invalid City Code Length
*Error - Invalid date
*Error - Number of Nights must be 1 to 12
*Error - Number of Rooms must be 1 to 3
*Error - Type `` is not supported at this time, please use Type `Hotel`
----
** Doclit Request XML**
username
password
NYC
Hotel
Double
2017-10-31
2
1
N
N
*** Doclit response ***
NYCHROY
Hotel
107
2014-10-31
EP-NO MEALS
STANDARD
17
Y
0
2
2014-10-31
Available
0
0
Allowed
Double
423
2014-11-01
Available
0
0
Allowed
Double
423
Double
423
3
----
=====✔ ProductInfoV2=====
**Description:**
ProductInfo returns not-dynamic, not-sensitive, stable information that should be cached in the client side on a regular basis (ideally every day, but once a week is acceptable).This function should not be included everytime a new request for new prices is made. (See [[documentation:team3#pricesearch|PriceSearch]] for dynamic updated Prices)
ProductInfoV2 Replace the following functions: ListVendorFull, ProductDetails, ProductVendorInfo, PropertyImages.
:!: //This function should be used together with [[documentation:team3#pricesearch|PriceSearch]]//
:!: //It is **your** responsibility to call ProductInfoV2 before booking a product!// TeamAmerica reserves the right to NOT amend bookings without your copy of this function's response.
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ProductInfo | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ProductCode |string |1 |Y | Mandatory if VendorName is blank, Product code or part of it|
|1 |VendorName |string |1 |N | Mandatory if ProductCode is blank, Vendor (hotel) name or part of it |
|1 |VendorID |INT |1 |Y | Mandatory if ProductCode is blank, Vendor (hotel) name or part of it. If you do not have a Vendor ID , use 0 as a value |
username
password
NYCHPCEPR
0
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ProductInfoResponse | |1 | | You may find several products for the same Vendor (Hotel)|
|1 |ProductCode |string |1 |Y |
|1 |ProductType |string |1 |N |
|1 |ProductName |string |1 |N |
|1 |VendorName |string |1 |N | The Hotel name |
|1 |TeamVendorID |int |1 |Y | Unique Hotel ID |
|1 |CityName |string |1 |Y |
|1 |FamilyPlan |string |1 |Y | Y/N
|1 |ChildAge |int |1 |Y | Max pax age that can be declared as a child |
|1 |MaximumOccupancy |int |1 |Y | Max pax per room (including children) |
|1 |HotelRating |int |1 |Y |
|1 |Latitude |string |1 |Y |
|1 |Longitude |string |1 |Y |
|1 |VendorImage |string |1 |Y | Main thumbnail |
|1 |VendorDescription |string |1 |Y |
|1 |VendorAddress1 |string |1 |Y |
|1 |VendorAddress2 |string |1 |Y |
|1 |VendorState |string |1 |Y |
|1 |MealPlan |string |1 |Y | From our list of MealPlans |
|1 |RoomType |string |1 |Y | From our list of RoomTypes |
|1 |NorthStarCode |int |1 |Y |
|1 |ProductDetail |string |1 |Y |
|1 |PermRoomCode |string |1 |Y |
|1 |ResortFee |float |1 |Y |
|1 |ResortFeeType |string |1 |Y |
|1 |NonRefundable |int |1 |Y | “1” if this is a Non Refundable room, “0” if refundable |
|1 |VendorCountryISO |string |1 |Y | Hotel’s country code |
|1 |VendorZip |string |1 |Y |
NYCHPCEPR
Hotel
NYCH PARK CENTRAL HOTEL 1 BED
PARK CENTRAL HOTEL
131
NYC-.New York, NY
Y
18
2
4
40.764696
-73.981022
http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCHPCEPR
Full-service Midtown hotel close to Central Park,Broadway shows, Carnegie Hall,and chic shops are near-neighbors to this centrally located 25-story hotel. Spacious, refurbished rooms have high ceilings, soundproof walls, smart tan-and-black color schemes, dual-line speakerphones, and modernized bathrooms with marble sinks. Fresh from a $65-million renovation in 2000, the hotel includes a popular bar and cafe, and a fitness center. Convenient Internet access is available just off the lobby.
870 7TH AVENUE /56TH ST
NY
NEW YORK
EP-NO MEALS
STANDARD ONE BED
135224
131
Cityhouse
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/711/189/cityhouse2_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/711/189/cityhouse2_H.jpg
131
Lobby View
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/781/PROP1-20100430-020608-968_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/781/PROP1-20100430-020608-968_H.jpg
131
Th Ave
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/710/655/7th_ave_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/710/655/7th_ave_H.jpg
131
Park Central
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/20/106/554/1094424cdmssabrevfm_img_pho_000_nc__673709_Park_Central___A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/20/106/554/1094424cdmssabrevfm_img_pho_000_nc__673709_Park_Central___H.jpg
131
Bar/Lounge
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/785/PROP2-20100430-020608-462_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/785/PROP2-20100430-020608-462_H.jpg
131
Bar/Lounge
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/794/PROP4-20100430-020608-884_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/794/PROP4-20100430-020608-884_H.jpg
NO SHOWS 100% PENALTY WILL APPLY. NON-SMOKING HOTEL. HTL UNDER RENOVATIONS (GUEST ROOMS & LOBBY). JAN-AUG 2013. F & B SERVICES FALL 2013.
1
0
0
USA
10019
**Errors**
*Error - Login Invalid
*Error - Invalid City Code Length
----
**Doclit Request XML**
username
password
131
**Doclit Response XML**
NYCHROY
Hotel
NYCH ROYALTON -STANDARD ROOM
ROYALTON HOTEL
107
NYC-.New York, NY
Y
17
2
4
40.754892
-73.980521
http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCHROY
Sleek, Midtown trendsetter hotel. Fifth Avenue is just a half-block away, Broadway 2 blocks, and Grand Central 4 blocks from this hip, centrally located, 16-story hotel.The 205 trim rooms have all-white fabrics, wood accents, built-in shelves and window seats, VCRs, and stereo cassette decks. Guests enjoy 24-hour concierge service, room service, a fitness room, and a trendy bar and restaurant.
44 WEST 44 STREET
NY
NEW YORK
3
EP-NO MEALS
STANDARD
C02082
107
44
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/440/ROY.44A_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/440/ROY.44A_H.jpg
107
PENTHOUSE
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/360/215/ROY.PENTHOUSE_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/360/215/ROY.PENTHOUSE_H.jpg
107
Interior
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/360/59/ROY.LOBBY5_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/360/59/ROY.LOBBY5_H.jpg
107
Bathroom
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/827/ROY.BATHROOM_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/827/ROY.BATHROOM_H.jpg
107
Guest Room
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/811/ROY.GUESTROOM1_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/811/ROY.GUESTROOM1_H.jpg
107
Guest Room
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/795/ROY.GUESTROOM_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/795/ROY.GUESTROOM_H.jpg
107
Interior
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/723/ROY.LOBBY3_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/723/ROY.LOBBY3_H.jpg
107
Bar/Lounge
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/492/ROY.BAR44.1_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/492/ROY.BAR44.1_H.jpg
107
FACADE
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/464/ROY.FACADE_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/464/ROY.FACADE_H.jpg
STANDARD ROOM. ROOMS HAVE 1 BED. EARLY DEPARTURE FEE $50.00.
0
0
USA
10036
===== ✔ ServiceSearch=====
**Description:** Search for services for a particular date. Services are Sightseeing, Restaurant , Transfer, Tranfer /Tours .
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ServiceSearch | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |CityCode |string |1 |Y | Use City Codes from ListCities |
|1 |ServiceDate |string |1 |Y |
|1 |ServiceType |string |1 |Y |S = Sightseeing / Tour, R = Restaurant, T = Transfer, P = Packages |
|1 |DisplayClodeOut |string |1 |Y |
|1 |DisplayOnRequest |string |1 |Y |
username
password
NYC
2017-10-17
T
Y
Y
**XML response**
NYCRBHD
Service
NOT SET
NYCR BENIHANA STEAK&CHICKEN DINNER
NYC-.New York, NY
2015-07-15
0
44
25
Available
NYCRPLA
Service
NOT SET
NYCR PLANET HOLLYWOOD-LUNCH OR DINNER-
NYC-.New York, NY
2015-07-15
0
29
29
Available
NYCRVIE
Service
NOT SET
NYCR THE VIEW RESTAURANT DINNER
NYC-.New York, NY
2015-07-15
0
93
12
OnRequest
...
**Errors**
*Error - Login Invalid
*Error - Invalid length for City Code - Use LiStCities City Code
*Error - Invalid date
=====✔ Escorted Tours Search =====
=== XML Request: ===
^Level^Name^Type^Occurs^Required^Comments^
|0 |EscortedToursSearch | |1 | | Search for escorted tours availability for specified dates |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ProductCode |string |1 |N | Not mandatory but helpful if you know the exact code you are looking for |
|1 |CityCode |string |1 |Y | This is a 3 character code (e.g. 'NYC' for New York City) |
|1 |ArrivalDate|date|1 |Y | Format must be in YYYY-MM-DD (e.g. 2018-10-15) |
|1 |Occupancy |int |1 |Y | Only integer applicable, for Single => 1, Double => 2, Triple => 3, Quad => 4 |
username
password
NYC
2018-10-15
3
=== XML Response: ===
^Level^Name^Type^Occurs^Required^Comments^
|0 |EscortedToursSearchResponse||1 | | Shows available tours for given dates |
|1 |ProductCode|string |1 |Y | Unique Product Code |
|1 |ProductType|string |1 |N | EscortedTours |
|1 |ProductName|string |1 |Y | Product Name with little description |
|1 |VendorID|int|1 |Y | Unique Vendor ID |
|1 |CityName|string |1 |Y | Full City Name |
|1 |Status|string|1 |Y | Availability Status |
|1 |ProductDate|date|1 |Y | Service Date or Arrival Date of the service |
|1 |Price|float|1 |Y | Adult Price
|1 |ChildPrice|float|1 |N | If child price is not defined, it'd take adult price (conditional*) |
|1 |ChildAge|int|1 |N |
|1 |WebPriority|int|1 |N | Optional (to identify the hotel ratings, if there's any) |
|1 |NumPax|int |1 |Y | Number of passenger for each service |
|1 |PackageDetails||1 |Y | Array response with with package item details |
|2 |PullPriceFlag|int|1 |Y | Usually this flag is 0, unless any item has prices on |
|2 |DisplayNightsFlag|boolean|1 |N |
|2 |DefaultNights|int|1 |Y | Number of nights for the package item |
|2 |ProductCode|string|1 |Y | Package Item Code, could be hotel, service or another package |
|2 |Description|string|1 |Y | Brief description of the product |
|2 |PackageItemDate|date|1 |Y | Arrival Date for the package item |
|1 |AvailabilityDetails||1 | | Array response for next (3 months+) available services |
|2 |Date|date|1 |Y | Service or Arrival Date |
|2 |Availability|string |1 |N | Available Status |
|2 |Price|float|1 |Y | Adult Price |
|1 |Latitude|string |1 |Y | Vendor Location Map |
|1 |Longitude|string|1 |Y | Vendor Location Map |
|1 |VendorImage|string |1 |Y | Optional, if there's any image provided by vendor |
|1 |VendorName|string |1 |Y | Full vendor name |
|1 |VendorDescription|string |1 |N | Optional (if there's any description provided by Vendor) |
|1 |VendorAddress1|string |1 |Y | Vendor Address e.g. 33 WEST 46th St. 3rd Floor, NY-10036 |
|1 |VendorAddress2|string |1 |N |
NYCETMPLUS
EscortedTours
NYCE MULTIPLUS PACKAGE - Riu Plaza Times Square
1080
NYC-.New York, NY
ON REQUEST
2018-10-15
309.0
129.0
12
1
3
0
0
1
NYCTEIB
NYCE ESCORTED TOURS ONLY TIB
2018-10-15
0
0
2
NYCEHRIU
NYCE RIU PLAZA TIMES SQUARE PRE NIGHTS ONLY
2018-10-15
0
0
1
NYCSS
NYCS CITY TOUR (REG) ITAL. OR SPANISH
2018-10-16
0
0
1
NYCTEOB
NYCE ESCORTED TOUR ONLY TOB
2018-10-22
2018-09-03
AVAILABLE: 3
309.0
2018-09-10
AVAILABLE: 1
309.0
2018-09-17
ON REQUEST
309.0
2018-09-24
AVAILABLE: 3
309.0
2018-10-01
ON REQUEST
309.0
2018-10-08
ON REQUEST
309.0
2018-10-15
ON REQUEST
309.0
40.7566652
-73.9803778
http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCETMPLUS
TEAMAMERICA ET
33 WEST 46 STREET
**Errors**
* Error - Login Invalid
* Error - Invalid City Code Length
* Error - Invalid date
* Invalid Occupancy - must be between 1-4
----
===== ✔ ListMealPlan =====
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListMealPlan | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
**XML Request**
username
password
**XML Response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListMealPlanResponse | |1 | |
|1 |MealPlanID |string |1 |Y |
|1 |MealPlan |string |1 |Y |
|1 |DateUpdated |string |1 |Y |
|1 |Deleted |string |1 |Y |
16
A LA CARTE BREAKFAST
2012-09-18 16:29:00
0
9
ABB-FULL AMERICAN BUFFET BREAKFAST
2012-07-25 13:05:15
0
....
**Errors**
* Error - Login Invalid
----
=====✔ ListRoomType=====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListRoomType | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
username
password
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListRoomTypeResponse | |1 | |
|1 |RoomTypeID |int |1 |Y |
|1 |RoomType |string |1 |Y |
|1 |DateUpdated |string |1 |Y |
|1 |Deleted |int |1 |Y |
1
STANDARD
2011-03-15 14:42:59.0
0
2
SUPERIOR
2011-03-15 14:43:00.0
0
.
.
**Errors**
*Error - Login Invalid
**Description**
This function list all the room types for all the products.
----
=====✔ ListCities=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListCities | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
username
password
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListCitiesResponse | |1 |
|1 |CityCode |string |1 |Y |
|1 |CityName |string |1 |Y |
|1 |Country |string |1 |Y |
|1 |DisplayGroup |string |1 |N |
ABB
*Abbotsford, BC, CANADA
CANADA
.
.
ZXR
Carmel Valley
USA
**Errors**
*Error - Login Invalid
**Description:**
Retrieve List of cities.
the list includes City code , country and Display Group
----
=====✔ ListPickUpLocations=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListPickUpLocation | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
username
password
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListPickUpLocationResponse | |1 | |
|1 |PickUpLocation |string |1 |Y |
|1 |PickUpLocationDescription |string |1 |Y |
NYCG
.NYC G E N E R I C HOTEL
.
.
**Errors**
*Error - Login Invalid
*Error - Invalid length for City Code - Maximum of 4 allowed
**Description:**
List pick locations in a city.
----
=====✔ ListVendor=====
**Description:**
List Vendor returns id and number of all Vendors
** Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListVendor | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |CityCode |string |1 |Y |Use [[documentation:team3#listcities|ListCities]] to get City Codes from all available Cities|
|1 |Type |string |1 |Y |Use 'Service' or 'Hotel' as parameters |
username
password
NYC
Service
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|1 |VendorID | INT |1 | Unique Hotel ID |
|1 |VendorName |string |1 |Y |
|1 |City |int |1 |Y ||
158
ACADEMY BUS
HOBOKEN
1
VOLATOUR-NEW YORK
NEW YORK
**Errors**
*Error - Login Invalid
*Error - Invalid City Code Length
*Error - Invalid Type
----
=====✔ BookingReport=====
** Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |BookingReport | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |FromDate |string |1 |Y |ISO YYYY-MM-DD|
|1 |ToDate |string |1 |Y |ISO YYYY-MM-DD|
2016-12-12
2017-12-13
** Response XML **
^Level^Name^Type^Occurs^Required^Comments^
|0 |BookingReportResponse | |1 | |
|1 |FromDate |string |1 |Y |ISO YYYY-MM-DD|
|1 |ToDate |string |1 |Y |ISO YYYY-MM-DD|
|1 |AgentDetails |string |1 |Y |
|2 |AgCode |string |1 |Y | |
|2 |AgentName |string |1 |Y | |
|2 |Address1 |string |1 |Y | |
|2 |Address2 |string |1 |Y | |
|2 |City |string |1 |Y | |
|2 |State |string |1 |Y | |
|2 |Zip |string |1 |Y | |
|2 |Country |string |1 |Y | |
|1 |Reservations |string | |Y |
|2 |ReservationNumber |int |1 |Y |Unique Reservation Number |
|2 |LastName |string |1 |Y | |
|2 |FirstName |string |1 |Y | |
|2 |ClientRef |string |1 |Y | |
|2 |DepDate |string |1 |Y |ISO YYYY-MM-DD|
|2 |Quantity |int |1 |Y | |
|2 |ProductCode |string |1 |Y | |
|2 |PickUpLocation |string |1 |Y | |
|2 |Misc1|string |1 |Y | |
|2 |Misc2 |string |1 |Y | |
2016-12-12
2017-12-13
0TEAMTEST
*TEAMTEST
33 West 46th st 3rd floor
New York
NY
10036
USA
960572
1
**Errors**
*Error - Login Invalid
*Error - Invalid Fromdate
*Error - Invalid Todate
======2. BOOK======
**BOOKING FUNCTION:** NewMultiItemReservation is our new and easy to integrate booking solution. Instead of different functions for adding passengers, adding different items and confirming the booking we simplify the process in this all in one comprehensible function.
* [[documentation:team3#newmultiitemreservation|NewMultiItemReservation]] (v3)
----
=====✔ NewMultiItemReservation=====
**Description**
This Function allows to book multiple items under the same reservation with just one call
//**Placing a new Reservation**//
After choosing the desired product/products you wish to book, we allow you to call just 1 function and place multiple items booked under the same reservation.
The output of this call will be one reservation, with a unique reservation ID, and if you chose to place many items so each one of them will have a unique item ID.
Some explanations about the different occupancies you may use, when booking:
In PriceSearchExt () response, there are max 4 occupancies available for each product: Single/Double/Triple/Quad.
However, when adding items in NewMultiItemReservation(), you may put some more options.
The available Occupancies you may use in NewMultiItemReservation() request are as follow:
Single, Double, Triple, Quad, SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH
//**How do you choose between them?**//
Now, first we will check if the hotel is supporting family plan.
* If = Y, and the pax children age is lower than value, then child is included in the price, so if there are 2 adults and 1 child under these conditions, you will put DBL+1CH in the occupancy and pay the Double room price. If the child age is higher than value, then the child will be considered as adult and you will have to put Triple in the occupancy
* If = N then every pax, regardless if adult or child, is considered as an adult, and the only values you can put in the occupancy are Single, Double, Triple, Quad
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |NewMultiItemReservation | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |AgentName |string |1 |Y |
|1 |AgentEmail |string |1 |Y |
|1 |ClientReference |string |1 |Y |
|1 |Items | |1 |Y |
|2 |NewItem | |1 |Y | The element can be used for 1 or more repetitions You may book several different items under the same reservation. Every item can be a Hotel Room, a service, a transfer etc. |
|3 |ProductCode |string |1 |Y |
|3 |ProductDate |string |1 |Y | Check-in date |
|3 |Occupancy |string |1 |Y | Single, Double, Triple, Quad, SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH |
|3 |NumberOfNights |int |1 |Y | Must be a value between 1 and 14. It should always be 1 for services.|
|3 |Language |string |1 |N | Optional, ENG/ITA/GER/SPA/FRE/POR |
|3 |PickUpLocation |string |1 |N | Optional, for Transfers - You must use the ListPickUpLocations function for possible values |
|3 |PickUpTime |string |1 |N | Optional, for Transfers, in HH:MM format |
|3 |FlightInfo |string |1 |N | Optional, for Transfers. 10 Chars in AZ1234 format |
|3 |Quantity |int |1 |Y | Number of repetitions of the Room/Service. Please choose 1 for Hotel Rooms |
|3 |ItemRemarks |string |1 |N | Free text, remarks for the Hotel|
|3 |Passengers |string |1 |Y |The < Passengers > element can be used for 1 or more repetitions You may assign 1 or more pax per the specific item which you are currently booking|
|3 |NewPassenger |string |1 |Y |
|4 |Salutation |string |1 |Y |
|4 |FamilyName |string |1 |Y |
|4 |FirstName |string |1 |Y |
|4 |PassengerType |string |1 |Y | AD /CH|
|4 |PassengerAge |string |1 |Y |
|4 |PassengerNationality |string |1 |Y |2 Character ISO standard Country Code |
|3 |BelongsToPackage |int |1 |N | If it does not belong to package, use 0 |
|3 |PackageCode |string |1 |N |
|3 |RateExpected |float |1 |Y | Mandatory, AverageNightlyRate as returned by PriceSearch . |
**blank request**
username
password
2017-12-12
Single
1
ENG
1
Mr.
S
A
ADULT
29
US
0
0
0
**Sample Request With Rate Expected**
username
password
2017-12-12
Single
3
1
Mr.
S
A
AD
25
US
0
221.4
**Sample Request Multiple rooms with same product code**
username
password
2017-12-12
Single
3
1
Mr.
S
A
AD
25
US
0
221.4
2017-12-22
Double
3
1
Mr.
A
S
AD
38
US
0
221.4
:!: If you would like to add new items to an existing reservation, you may do it using AddItem() method. However it is not possible to add new passengers, but use only existing ones. So, if you would like to add new items to an existing reservation with new passengers, you first have to call the AddPassenger() method, and only then take the new passengers ID’s into the AddItem() method.
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |NewMultiItemReservationResponse | |1 | |
|1 |ReservationNumber |int |1 |Y |
|1 |BookingAgentReferenceNumber |string |1 |Y |
|1 |DateBooked |string |1 |Y |
|1 |ReservationStatus |string |1 |Y |
|1 |FaxStatus |string |1 |Y |
|1 |ReservationStatusDescription |string |1 |Y |
|1 |GeneralComments |string |1 |Y |
|1 |AgencyCommissionAmount |float |1 |Y |
**Errors**
**Description:**
**Doclit Request XmL**
username
password
2017-12-12
Single
1
Mr.
S
A
AD
29
0
0
0
====✔ Book Escorted Tours using NewMultiItemReservation Method: ====
**Request XML**
username
password
agentcode
agentemail@somedomain.com
NYCETMPLUS[**First NewItem should be start with PackageCode**]
2018-10-15
TPL+1CH
1
ENG
1
Mr.
S
A
ADULT
29
0> [**Item itself is a PackageCode, BelongsToPackage must be set as 0**]
[**Item itself is a Package, PackageCode should be set as blank**]
0
NYCTEIB[**Package Item Code 1**]
2018-10-15
Single
1
ENG
1
Mr.
S
A
ADULT
29
1[**this should be set as 1, since it is a package item**]
NYCETMPLUS[**it should be filled with PackageCode**]
0
NYCEHRIU[**Package Item Code 2**]
2018-10-15
Single
1
ENG
1
Mr.
S
A
ADULT
29
1[**this should be set as 1, since it is a package item**]
NYCETMPLUS[**it should be filled with PackageCode**]
0
NYCSS[**Package Item Code 3**]
2018-10-16
Single
1
ENG
1
Mr.
S
A
ADULT
29
1[**this should be set as 1, since it is a package item**]
NYCETMPLUS[**it should be filled with PackageCode**]
0
NYCTEOB[**Package Item Code 4**]
2018-10-22
Single
1
ENG
1
Mr.
S
A
ADULT
29
1[**this should be set as 1, since it is a package item**]
NYCETMPLUS[**it should be filled with PackageCode**]
0
**Response XML**
1039722
2018-08-09
OK
RW
0.0
*TEAMTEST
33 West 46th st 3rd floor
New York
NY
10036
USA
sharifulteam
1850755
NYCETMPLUS
2018-10-15
NYCE MULTIPLUS PACKAGE - Riu Plaza Times Square
Triple + 1 Child
1
309.0
927.0
3
RQ
1
THIS CAN BE ADDED ONLY TO TEAMTOUR EAST + TEAMTOUR MINI NIAGARA. MULTIPLUS PCKG CONFIRMED ONLY IF TEAMTOUR IS CONFIRMED. BLACK OUT DATES APPLY. PRE NTS NEED TO BE CONSECUTIVE TO TOUR DATE.
927.0
BK-BREAKFAST
31
1850756
NYCETMPLUS
2018-10-15
NYCE MULTIPLUS PACKAGE - Riu Plaza Times Square
Triple + 1 Child
1
129.0
129.0
1
RQ
1
THIS CAN BE ADDED ONLY TO TEAMTOUR EAST + TEAMTOUR MINI NIAGARA. MULTIPLUS PCKG CONFIRMED ONLY IF TEAMTOUR IS CONFIRMED. BLACK OUT DATES APPLY. PRE NTS NEED TO BE CONSECUTIVE TO TOUR DATE.
129.0
BK-BREAKFAST
31
1850757
NYCTEIB
2018-10-15
NYCE ESCORTED TOURS ONLY TIB
Single
1
0.0
0.0
1
RQ
0
MIN. 2 PAX. - seat-on-coach cfrmd only for tsfrs inbound for flights arriving between 6am and 10pm. Private service required for transfer in provided for flights scheduled to land btwn 10pm and 6am
0.0
EP-NO MEALS
1
1850758
NYCEHRIU
2018-10-15
NYCE RIU PLAZA TIMES SQUARE PRE NIGHTS ONLY
Single
1
0.0
0.0
1
RQ
0
PRE NIGHTS FOR TEAMTOUR MULTIPLUS ONLY CAN BE BOOKED AS PART OF THE MULTIPLUS ONLY BREAKFAST INCLUDED
0.0
EP-NO MEALS
1
1850759
NYCSS
2018-10-16
NYCS CITY TOUR (REG) ITAL. OR SPANISH
Single
1
0.0
0.0
1
CF
0
4HRS.,DAILY MEET@ 8:30AM DEPART@ 8:45AM FROM THE VOLATOUR OFFICE 33 WEST 46TH STREET BTWN 5TH & 6TH AVES. BLACKOUT 12/25 & 1/01 CALL EMERGENCY #1877 865 2868 DAY PRIOR TO REFONF
0.0
EP-NO MEALS
1
1850760
NYCTEOB
2018-10-22
NYCE ESCORTED TOUR ONLY TOB
Single
1
0.0
0.0
1
RQ
0
MIN. 2 PAX. - seat-on-coach cfrmd only for tsfrs out for flights departing between 7:30am and 11pm Private service required for transfer out provided flights scheduled to depart btwn 11pm and 7:30am
0.0
EP-NO MEALS
1
12704936
S
A
ADULT
29
1056.0
0.0
0.0
0.0
0.0
0.0
1056.0
0.0
0.0
0.0
0.0
0.0
0.0
**Errors**
* Error - Login Invalid
* Error - Occupancy is not valid
* Error - Invalid date
* Error - Quantity must be 1-12
* Error - Passenger type must be ADULT or CHILD
====✔ Book Services using NewMultiItemReservation Method: ====
**Request XML**
**Description** for the amount of people associated with this reservation please use Occupancy. Below how you match occupancy to number of people
Single = 1
Double = 2
Triple = 3
Quad = 4
username
password
2017-10-31
Double
1
1
test
Mr.
S
A
AD
29
Mr.
A
S
AD
30
0
0
0
**Sample Response**
673840
2015-07-23
OK
RW
0.0
*TEAMTEST
33 West 46th st 3rd floor
New York
NY
10036
SPAIN
achan
1369062
NYCTIB
2015-08-17
NYCT TRSFR IN-SEAT ON COACH MIN 2PAX
Double
1
39.96
79.91
2
CF
test
1
flights landing btwn 10:00 pm & 6:00 am must be BKD AS PVT TRFS. $110 FEE XTRF BFORE 9AM ON P/UP TIME /Flight # /M1 MIN. 2 PAX RATE $25 EACH 12/24; 12/25 & 1/1; 12/ 31 AFT 7P
79.91
EP-NO MEALS
1
11838419
TEST
A
AD
30
11838420
TEST
B
AD
30
79.91
0.0
0.0
0.0
0.0
0.0
79.91
0.0
0.0
0.0
0.0
0.0
0.0
----
======3. RETRIEVE======
**RETRIEVE FUNCTIONS:** This functions allows to get information regarding any existing reservation.
* [[documentation:team3#RetrieveReservation|RetrieveReservation]]
----
=====RetrieveReservation=====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveReservation | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ReservationNumber |INT |1 |Y |
username
password
950606
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveReservation | | | |
|1 |ReservationInformation | | | |
|2 |ReservationNumber | int | | |
|2 |BookingAgentReferenceNumber | string| | |
|2 |DateBooked | string | | |
|2 |ReservationStatus |string | | |
|2 |GeneralComments | string | | | |
|2 |AgencyCommissionAmount | float | | | |
|2 |BookingAgentInfo | | | | |
|3 |AgencyName | string | | | |
|3 |Address1 | string | | | |
|3 |Address2 | string | | | |
|3 |City | string | | | |
|3 |State | string | | | |
|3 |PostalCode | string | | | |
|3 |Country | string | | | |
|3 |AgentUserName | string | | | |
|3 |AgentEmail | string | | | |
|2 |Items | | | | |
|3 |UniqueItemID | int | | | |
|3 |ProductCode | string | | | |
|3 |ItemDate | string | | | |
|3 |Description | string | | | |
|3 |Occupancy | string | | | |
|3 |NumberOfNights | int | | | |
|3 |Language | string | | | |
|3 |PickUpLocation | string | | | |
|3 |PickUpTime | string | | | |
|3 |FlightInfo | string | | | |
|3 |AverageNetPricePerNight | float | | | |
|3 |TotalItemNetPrice | float | | | |
|3 |Quantity | int | | | |
|3 |ItemSupplierConfirmationNumber | string | | | |
|3 |ItemStatusCode | string | | | |
|3 |ItemStatusDescription | string | | | |
|3 |ItemRemarks | string | | | |
|3 |ItemInformation | string | | | |
|3 |ItemCommissionable | string | | | |
|3 |ItemPassengers | | | | |
|4 |UniquePassengerID | | | | |
|4 |FamilyName | string | | | |
|4 |FirstName | string | | | |
|4 |Type | string | | | |
|4 |Age | int | | | |
|3 |TotalResNetPrice | float | | | |
|3 |gross_total | float | | | |
|3 |paid | float | | | |
|3 |gross_due | float | | | |
|3 |ag_comm_level | float | | | |
|3 |ag_comm_amt | float | | | |
|3 |net_due | float | | | |
|3 |cc_fees | float | | | |
|3 |ttl_expenses | float | | | |
|3 |ttl_expenses_paid | float | | | |
|3 |commission_amt | float | | | |
|3 |commission_rcvd | float | | | |
|3 |amt_comm_amt | float | | | |
123456
0000000
2013-02-20
OK
RW
00
AGENCY NAME
CITY
COUNTRY
AGENTUSERNAME
0000
PRODUCTCODE
2013-03-07
ITEM DESCRIPTION
Single
3
0000
0000
1
0000
BK
0
0000
FAMILYNAME
FIRSTNAME
AD
30
0000
EP-NO MEALS
STANDARD
0000
FAMILYNAME
FIRSTNAME
AD
30
0000
0000
0000
00
000
000
-0
0
0000
0000
0
0
0000
**Errors**
*Error - Login Invalid
*Error – Invalid length for Client Reference – Maximum of 14 allowed
**Description**
----
=====RetrieveResByReference=====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveResByReference | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |Reference |string |1 |Y |
|1 |ShowCX |int |1 |Y | Show Ref, Max 14 |
username
password
test
4
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveResByReferenceResponse | |1 | |
|1 |ReservationNumber |int |1 |Y |
|1 |LastName |string |1 |Y |
|1 |FirstName |string |1 |Y |
|1 |DepDate |string |1 |Y |
|1 |ReservationStatus |string |1 |Y |
|1 |Product |string |1 |Y | |
286065
RICCI
RICCARDO
2013-03-01
OK
NYCSS
**Errors**
*Error - Login Invalid
*Error – Invalid length for Client Reference – Maximum of 14 allowed
**Description**
Retrieve Reservation Number and other Information based on your Client Reference Number.
----
======4. CANCEL======
**CANCEL FUNCTIONS:** Cancel existing reservations and show Cancellation Policies.
* [[documentation:team3#cancellationpolicy|CancellationPolicy]] (Just Show Information)
* [[documentation:team3#cancelreservation|CancelReservation]]
----
=====CancellationPolicy=====
**Description:**
This function returns the cancellation policy for a given product code and arrival date. Please always use this function and advise your users.
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |CancellationPolicy | | | | |
|1 |UserName |string |1 |Y | |
|1 |Password |string |1 |Y | |
|1 |ProductCode |string |1 |Y |e.g. BKLHALOFTD|
|1 |ArrivalDate |date |1 |Y |ISO YYYY-MM-DD|
username
password
2017-12-12
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |CancellationPolicyResponse | |1 | |
|1 |NumberDaysPrior |int |1 |Y |Number of days prior to the travel date after which the cancellation policy applies |
|1 |PenaltyType |string |1 |Y |There are 3 types of penalty types: Nights, Percent and Dollars. |
|1 |PenaltyAmount |float |1 |Y |Depending on the PenaltyType, it may return either a number of nights, a percentage or a cancellation fee in dollars |
3
Nights
1.00
**Errors**
*Error - Login Invalid
*Error - Invalid date
----
=====CancelReservation=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |CancelReservation | |1 | | |
|1 |Username |string |1 |Y | |
|1 |Password |string |1 |Y | |
|1 |ReservationNumber |int |1 |Y | |
username
password
950606
**XML response EXAMPLE 1** (when cancelling 7 days before, you pay 1 night cxl fee.)
*Please note that if your cancellation results in a cancellation fee, the reservation will remain open (Status OK) until cancellation fee (CXLFEE) has been paid*
OK
123456
NYCH WESTIN GRAND CENTRAL 1B NOT REFUNDA
CX
1202
2013-09-01
**Errors**
*Error - Login Invalid
*Error - Reservation not found
**Description:**
----
=====DeleteItem=====
Delete item from a reservation
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |DeleteItem | |1 | | |
|1 |Username |string |1 |Y | |
|1 |Password |string |1 |Y | |
|1 |ItemID |int |1 |Y | |
|1 |BKGSrc |int |1 |N | |
username
password
1199644
CX
Item has been deleted
**Description:**
Delete a Item from a Reservation . To retrieve item id in a reservation use retrieve reservation to get the item id.