======= TEAM AMERICA XML 5.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(Please request IPs white listed to use this endpoint) https://developers.teamamericany.com/taxml/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 [[start#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 * ResortFee * ResortFeeType * CancellationPolicies :!: //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 ProductInfo request. // :!: //**Default time zone for Cancellation Policy is EST / EDT** // **XML Request** ^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 [[start#listcities|ListCities]] to get City Codes from all available Cities| |1 |ProductCode |string |1 |N |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. In addition XML5+ supports an another occupancy convention with child age **+CH--**. For example, DBL+1CH-10 [given child age is 10], DBL+2CH-7-10 [1st child age is 7, 2nd child age is 10]| |1 |ArrivalDate |string |1 |Y |ISO YYYY-MM-DD| |1 |NumberOfNights |int |1 |Y |Must be a value between 1 and 21 | |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 | ***** ***** NYC NYCHMAXSUP Hotel Single 2020-08-10 1 1 AF Y Y 0 **XML Response** ^Level^Name^Type^Occurs^Required^Comments^ |0 |PriceSearchResponse | |1 | | |1 |WebPriority |int |1 |Y | Team America Preferred| |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| |2 |TaxInclusive |string |1 |N/A|All our rates are TaxInclusive. It should be "Y". **THIS IS AVAILABLE ONLY ON XML VERSION 5.1**| | 1 |ResortFee| String| 1 | Y | Either Integer, Float or Percentage | | 1 |ResortFeeType| int| 1 | Y | | 1 |CancellationPolicies| | 1 | N | | 2 |CancellationPolicy| | 1..3 | N | Default time zone is EST / EDT | | 3 |NumberDaysPrior| int | 1 | Y | Number of days prior to the travel date after which the cancellation policy applies | | 3 |PenaltyType| string | 1 | Y | There are 3 types of penalty types: Nights, Percent and Dollars | | 3 |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 |PenaltyDeadline| string | 1 |N/A| Penalty will be added from this Date. Format will look like "YYYY-MM-DD T00:00:00.000 -04:00". **THIS IS AVAILABLE ONLY ON XML VERSION 5.1**| **Resort Fee Values** ^ID^Type of Resort Fee^ |1|Paid Locally Per Person| |2|Paid Locally Per Room| |3|Paid Locally Per Day| |4|Paid Locally Plus Tax Per Person| |5|Paid Locally Plus Tax Per Room| |6|Paid Locally Plus Tax Per Day| |7|Waived For TeamAmerica| |8|Included In Rate| |9|Optional Resort Fee to be Paid Locally Plus Tax Per Day| |10|Paid Locally Per Room Per Day| |11|Paid Locally Plus Tax Per Person Per Day| |15|Plus Tax Per Room Per Day Included In Rate| |16|Plus Tax Paid Locally By Guests Per Room Per Day| |17|Paid Locally By Guests Per Room Per Day| |18|PER ROOM PER DAY WAIVED FOR PROMO (PERKS NOT RECEIVED)| |19|Plus Tax Per Room Per Day Paid Locally Upon Check In| |20|Escorted Fuel FEE Surcharge| |21|Resort Fee Percentage Based On Total Stay Paid Locally By Guest| 3 NYCHMAXSUP Hotel 62 2020-08-10 EP-NO MEALS SUPERIOR ONE BED ROOM ONLY 17 Y 0 2 2020-08-10 Available 0 0 Allowed Single 274.82 Single 274.82 Y 25 6 3 Nights 1.0 2020-08-07 T00:00:00.000 -04:00 **Errors** *Error - Login Invalid *Error - Invalid City Code Length *Error - Type ' 'is not supported at this time, please use Type `Hotel` *Error - Invalid date *Error - Number of Nights must be 1 to 21 *Error - Number of Rooms must be 1 to 3 ---- =====✔ ProductInfo===== **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 [[start#pricesearch|PriceSearch]] for dynamic updated Prices) ProductInfo Replace the following functions: ListVendorFull, ProductDetails, ProductVendorInfo, PropertyImages. :!: //This function should be used together with [[start#pricesearch|PriceSearch]]// **XML Request** ^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 |N | 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 | ***** ***** DCAHHILTW **XML Response** ^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 |VendorCity|string |1 |Y | |1 |WebPriority|int|1 |Y |Team America Preferred | |1 |MealPlan |string |1 |Y | From our list of MealPlans | |1 |MealPlanID|int|1 |Y | |1 |RoomType |string |1 |Y | From our list of RoomTypes | |1 |NorthStarCode |int |1 |Y | |1 |PropertyImage| |1... |Y | |2 |VendorID|int|1 |Y |Unique Vendor ID | |2 |Caption| |1 | | |2 |Thumbnail|string |1 |Y | |2 |ActualSize|string |1 |Y | |1 |VendorProtocol|String|1 |N/A |If "Y"= Vendor has COVID-19 safety Protocol, Or "N"= Vendor doesn't have COVID-19 safety Protocol. **THIS IS AVAILABLE ONLY ON XML VERSION 5.1** | |1 |ProtocolFile|String|1 |N/A |COVID-19 safety Protocol Downloadable link. **THIS IS AVAILABLE ONLY ON XML VERSION 5.1** | |1 |ProductDetails |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 | DCAHHILTW Hotel DCAH WASHINGTON HILTON-STANDARD KING OR DOUBLE/DOUBLE ROOM WASHINGTON HILTON 28 DCA-Washington, D.C. Y 17 4 4 38.916137 -77.046347 https://s3.amazonaws.com/tavendorimages/thumb/vendor_28_19434.jpg Impressive hotel with spectacular views The hotel is just blocks from DC business district, and the areas of Dupont Circle, Embassy Row, and Adams-Morgan.Spacious rooms feature cream-colored walls, blue-and-gold fabrics, handy workspace, and full-length mirrored doors. This hotel has a tour-service desk, outdoor tennis courts and pool, health club. 1919 CONNECTICUT AVE, N.W. DC WASHINGTON 3 EP-NO MEALS 1 STANDARD KING OR DOUBLE QUEEN ROOM 049891 28 https://s3.amazonaws.com/tavendorimages/thumb/vendor_28_19434.jpg https://s3.amazonaws.com/tavendorimages/large/vendor_28_19434.jpg 28 https://s3.amazonaws.com/tavendorimages/thumb/vendor_28_19435.jpg https://s3.amazonaws.com/tavendorimages/large/vendor_28_19435.jpg 28 https://s3.amazonaws.com/tavendorimages/thumb/vendor_28_19436.jpg https://s3.amazonaws.com/tavendorimages/large/vendor_28_19436.jpg Y https://static.teamamericany.com/supplier/protocol/HH_29375 BEDDING TYPE IS NOT GUARANTEED TILL CHECK IN! EARLY DEPARTURE FEE GOES TO GUESTS. FOLIO! ROLLAWAY IS AT AN ADDITIONAL CHARGE. 1 nights FEE FOR EARLY DEPARTURES. 0 USA 20009 **Errors** *Error - Login Invalid *You must specify at least one search parameter (ProductCode, VendorID, VendorName) ---- ===== ✔ 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 |DisplayClosedOut |string |1 |Y | |1 |DisplayOnRequest |string |1 |Y | ***** ***** NYC 2020-08-22 T Y Y **XML Response** NYCTOBSUV TRANSFER PRIVATE 0 NYCS PRIVATE OUTBOUND SUV SUBURBAN - 5 PAX 40% SUPPLEMENT TRFS DEC 25 & JAN 01 BFORE OR.AFTER 9:00AM DEC 31ST AFTER 7:00PM....SEE PRODUCT DESCRIPTION FOR DETAILS.. 1 NYC-.New York, NY OK 2020-08-22 196.0 0.0 12 Y 3 0 40.7566652 -73.9803778 http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCTOBSUV VOLATOUR-NYC/BOS/PHL AREAS 33 WEST 46 STREET FIRST FLOOR 2 Percent 100.0 2020-08-20 T00:00:00.000 -04:00 **Errors** *Error - Login Invalid *Error - Invalid City Code length *Error - Invalid Date =====✔ EscortedToursSearch ===== **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 | ***** ***** NYCETSAT5 NYC 2020-08-22 2 **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 |TaxInclusive|string|1 |N/A | All our rates are TaxInclusive. It should be "Y". **THIS IS AVAILABLE ONLY ON XML VERSION 5.1** | |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 |CancellationPolicies| | 1 | N | |2 |CancellationPolicy| | 1..3 | N | | 3 |NumberDaysPrior| int | 1 | Y | Number of days prior to the travel date after which the cancellation policy applies | | 3 |PenaltyType| string | 1 | Y | There are 3 types of penalty types: Nights, Percent and Dollars | | 3 |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 |PenaltyDeadline| string | 1 | N/A |Penalty will be added from this Date. Format will look like "YYYY-MM-DD T00:00:00.000 -04:00". **THIS IS AVAILABLE ONLY ON XML VERSION 5.1**| |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 | NYCETSAT5 EscortedTours THE NEWYORKER - SATURDAYS ARR. - 5nts NY Package 1080 NYC-.New York, NY AVAILABLE: 7+ 2020-08-22 965.0 309.0 Y 12 3 2 34 Percent 20.0 2020-07-19 T00:00:00.000 -04:00 21 Percent 50.0 2020-08-01 T00:00:00.000 -04:00 14 Percent 100.0 2020-08-08 T00:00:00.000 -04:00 0 0 1 NYCTEIB NYCE ESCORTED TOURS ONLY TIB 2020-08-22 0 0 5 NYCEHRPLA NYCE RIU PLAZA TIMES SQUARE - THE NEW YORKER ONLY 2020-08-22 0 0 1 NYCETSSBR NYCE CITY TOUR + BRUNCH (THE NEWYORKER ONLY) 2020-08-23 0 0 1 NYCETWALVE NYCE WALKING TOUR AND THE VESSEL* 2020-08-24 0 0 1 NYCETMOMA NYCE MOMA OR EQUIVALENT ATTRACTION 2020-08-25 0 0 1 NYCTEOB NYCE ESCORTED TOUR ONLY TOB 2020-08-27 2020-07-11 AVAILABLE: 6 965.0 2020-07-18 AVAILABLE: 3 965.0 2020-07-25 AVAILABLE: 7+ 965.0 2020-08-01 ON REQUEST 965.0 2020-08-08 AVAILABLE: 7+ 965.0 2020-08-15 AVAILABLE: 2 965.0 2020-08-22 AVAILABLE: 7+ 965.0 2020-08-29 AVAILABLE: 7+ 965.0 2020-09-05 AVAILABLE: 7+ 1039.0 2020-09-12 AVAILABLE: 7+ 1039.0 2020-09-19 AVAILABLE: 7+ 1039.0 2020-09-26 AVAILABLE: 7+ 1039.0 2020-10-03 AVAILABLE: 7+ 1039.0 40.7566652 -73.9803778 http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCETSAT5 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** ***** ***** **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 2016-03-07 17:28:13 0 9 ABB-FULL AMERICAN BUFFET BREAKFAST 2016-03-07 17:28:13 0 .... **Errors** * Error - Login Invalid ---- =====✔ ListRoomType===== **XML Request** ^Level^Name^Type^Occurs^Required^Comments^ |0 |ListRoomType | |1 | | |1 |Username |string |1 |Y | |1 |Password |string |1 |Y | ***** ***** **XML Response** ^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 | ***** ***** **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 ABQ Albuquerque, NM USA Albuquerque Area . . ZXR Carmel Valley USA **Errors** *Error - Login Invalid **Description:** Retrieve List of cities. The list includes City code, Country and Display Group. ---- =====✔ ListVendor===== **Description:** List Vendor returns id and number of all Vendors **XML Request** ^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 [[start#listcities|ListCities]] to get City Codes from all available Cities| |1 |Type |string |1 |Y |Use 'Service' or 'Hotel' as parameters | ***** ***** NYC Hotel **XML Response** ^Level^Name^Type^Occurs^Required^Comments^ |1 |VendorID | INT |1 | Unique Hotel ID | |1 |VendorName |string |1 |Y | |1 |City |int |1 |Y || 17569 11 HOWARD HOTEL NEW YORK 19043 AC HOTEL NEW YORK DOWNTOWN NEW YORK . . . 4407 YOTEL NEW YORK NEW YORK **Errors** *Error - Login Invalid *Error - Invalid City Code Length *Error - Invalid Type ---- =====✔ ListBookings===== **XML Request** ^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| ***** ***** 2018-12-12 2019-01-03 N **XML Response** ^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 | | 2018-12-12 2019-01-03 0TEAMTEST *TEAMTEST 33 West 46th st 3rd floor New York NY 10036 SPAIN 1044525 OK TEST TEST A 2019-02-05 1 NYCHPAULMD 1044526 OK TEST TEST A 2019-03-05 1 LASHTROP . . . . . 1044575 OK TESTERS TESTER 2019-02-28 1 EWRHXTEST1 ENG **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. * [[start#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 **XML Request** ^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 21. 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 ListVendor 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 |Y | Content can be empty, but the element must exist in the request| |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 |NationalityCode|string |1 |Y |2 Character ISO standard Country Code | |3 |BelongsToPackage |int |1 |Y | 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 . | **XML Blank Request** ***** ***** *TEAMTEST test@test.com ***** 2019-06-03 Single 3 ENG BOS 1230 TG340 1 Mr. S A ADULT 30 US 0 0 **XML Request With Rate Expected** ***** ***** *TEAMTEST test@test.com NYCHSETAEE 2019-06-03 Single 3 ENG BOS 1230 TG340 1 Mr. S A ADULT 30 US 0 1002.19 **XML Request for Multiple rooms with same product code** ***** ***** *TEAMTEST test@test.com NYCHSETAEE 2019-06-03 Single 3 ENG BOS 1230 TG340 1 Mr. S A ADULT 30 US 0 1002.19 NYCHSETAEE 2019-06-03 Double 3 ENG BOS 1230 TG340 1 Mr. S A ADULT 30 US 0 1002.19 :!: 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. **XML Response With Rate Expected** 1044809 2019-02-27 OK RW 10.5 *TEAMTEST 33 West 46th st 3rd floor New York NY 10036 SPAIN kadir 1857127 NYCHSETAEE 4268 THE LANGHAM NEW YORK, FIFTH AVENUE Add1: 400 FIFTH AVENUE, Add2: , City: NEW YORK, State: NY, Zip: 10018, Country: USA, Phone: 212 695 4005, Fax: 212 695 4045 2019-06-03 NYCH THE LANGHAM, NEW YORK, FIFTH AVENUE-JUNIOR EMPIRE SUITE Single 3 ENG TG340 1002.19 1002.19 1 RQ 1 12715787 S A ADULT 30 COMP IN ROOM BOTTLED WATER, REPLENISHED DAILY COMP HIGH SPEED INTERNET ACCESS EARLY CHECK OUT 1 NIGHT +TAX, NO SHOW PENALTY 2 NIGHTS + TAX APPLY 2690.88 EP-NO MEALS 1 JUNIOR EMPIRE SUITE 3 Nights 1.0 12715787 S A ADULT 30 2690.88 3006.57 0.0 3006.57 10.5 315.69 2690.88 0.0 0.0 0.0 0.0 0.0 315.69 **XML Response for Multiple rooms with same product code** 1044810 2019-02-27 OK RW 10.5 *TEAMTEST 33 West 46th st 3rd floor New York NY 10036 SPAIN kadir 1857128 NYCHSETAEE 4268 THE LANGHAM NEW YORK, FIFTH AVENUE Add1: 400 FIFTH AVENUE, Add2: , City: NEW YORK, State: NY, Zip: 10018, Country: USA, Phone: 212 695 4005, Fax: 212 695 4045 2019-06-03 NYCH THE LANGHAM, NEW YORK, FIFTH AVENUE-JUNIOR EMPIRE SUITE Single 3 ENG TG340 1002.19 1002.19 1 RQ 1 12715788 S A ADULT 30 COMP IN ROOM BOTTLED WATER, REPLENISHED DAILY COMP HIGH SPEED INTERNET ACCESS EARLY CHECK OUT 1 NIGHT +TAX, NO SHOW PENALTY 2 NIGHTS + TAX APPLY 2690.88 EP-NO MEALS 1 JUNIOR EMPIRE SUITE 3 Nights 1.0 1857129 NYCHSETAEE 4268 THE LANGHAM NEW YORK, FIFTH AVENUE Add1: 400 FIFTH AVENUE, Add2: , City: NEW YORK, State: NY, Zip: 10018, Country: USA, Phone: 212 695 4005, Fax: 212 695 4045 2019-06-03 NYCH THE LANGHAM, NEW YORK, FIFTH AVENUE-JUNIOR EMPIRE SUITE Double 3 ENG TG340 1002.19 1002.19 1 RQ 1 12715788 S A ADULT 30 COMP IN ROOM BOTTLED WATER, REPLENISHED DAILY COMP HIGH SPEED INTERNET ACCESS EARLY CHECK OUT 1 NIGHT +TAX, NO SHOW PENALTY 2 NIGHTS + TAX APPLY 2690.88 EP-NO MEALS 1 JUNIOR EMPIRE SUITE 3 Nights 1.0 12715788 S A ADULT 30 5381.76 6013.14 0.0 6013.14 10.5 631.38 5381.76 0.0 0.0 0.0 0.0 0.0 631.38 =====✔ Book Packages or Escorted Tours using NewMultiItemReservation Method===== **XML Request** ***** ***** *TEAMTEST test@test.com NYCETANY7N 2022-03-23 Single 1 ENG 1 Mr. S A AD 31 US 0 1415 NYCTEIB 2022-03-23 Single 1 ENG 1 Mr. S A AD 31 US 1 NYCETANY7N 0 NYCEHRPLA 2022-03-23 Single 1 ENG 1 Mr. S A AD 31 US 1 NYCETANY7N 0 NYCETSSBR 2022-03-24 Single 1 ENG 1 Mr. S A AD 31 US 1 NYCETANY7N 0 NYCETMOMA 2022-03-25 Single 1 ENG 1 Mr. S A AD 31 US 1 NYCETANY7N 0 NYCETWALVE 2022-03-24 Single 1 ENG 1 Mr. S A AD 31 US 1 NYCETANY7N 0 NYCTEOB 2022-03-30 Single 1 ENG 1 Mr. S A AD 31 US 1 NYCETANY7N 0 **XML Response** 1216438 2022-01-31 OK RW 0.0 ACCORD CONFERENCE CO WALLED HOUSE- KENILWORTH AVE BRACKNELL BERKSHIRE RG12 2JJ UNITED KINGDOM sharifulteam 2091353 NYCETANY7N 1080 TEAMAMERICA ET Add1: 33 WEST 46 STREET, Add2: , City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 697 7165, Fax: 2022-03-23 THE NEWYORKER - ANY DAYS 7 NIGHTS Single 1 ENG 1415.0 1415.0 1 CF 0 13112037 S A AD 31 7 NTS TOUR IN NYC, BREAKFAST INCLUDED

GENERAL CONDITIONS APPLY

BLACK OUT DATES APPLY

Desclaimer: If the SALUTATION for a passenger was not supplied, TeamAmerica provided 'MR' for it as default.

]]> 1415.0 EP-NO MEALS 1 12 Percent 100.0 2091354 NYCTEIB 1 VOLATOUR-NYC/BOS/PHL AREAS Add1: 33 WEST 46 STREET, Add2: FIRST FLOOR, City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 557 1654, Fax: 917 464 8489 2022-03-23 NYCE ESCORTED TOURS ONLY TIB Single 1 ENG 0.0 0.0 1 CF 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

Desclaimer: If the SALUTATION for a passenger was not supplied, TeamAmerica provided 'MR' for it as default.

]]> 0.0 EP-NO MEALS 1 2091355 NYCEHRPLA 15705 RIU PLAZA NEW YORK TIMES SQUARE - BREAKFAST BUFFET INCLUDED Add1: 305 WEST 46TH STREET, Add2: , City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 706 2860, Fax: 646 864 1105 2022-03-23 NYCE RIU PLAZA TIMES SQUARE - THE NEW YORKER ONLY Single 1 ENG 0.0 0.0 1 CF 0 BREAKFAST IS INCLUDED

ROOMS CAN BE BOOKED ONLY IF PART OF THE NEW YORKER

ROOMS CONFIRMED ONLY IF THE ENTIRE PACKAGE

THE NEW YORKER SATURDAYS ARR. IS CONFIRMED

Desclaimer: If the SALUTATION for a passenger was not supplied, TeamAmerica provided 'MR' for it as default.

]]> 0.0 BK-BREAKFAST 31 2091356 NYCETSSBR 1080 TEAMAMERICA ET Add1: 33 WEST 46 STREET, Add2: , City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 697 7165, Fax: 2022-03-24 MEAL (THE NEWYORKER ONLY) Single 1 ENG 0.0 0.0 1 CF 0 DINNER @ HOTEL (OR BRUNCH ON ROOFTOP - AVAILABLE

ONLY SAT/SUN AND IF SPECIFIED AT TIME OF BOOKING

THAT CLIENTS WANT BRUNCH INSTEAD OF DINNER)

**CAN BE BOOKED ONLY AS PACKAGE **

Desclaimer: If the SALUTATION for a passenger was not supplied, TeamAmerica provided 'MR' for it as default.

]]> 0.0 EP-NO MEALS 1 2091358 NYCETWALVE 1 VOLATOUR-NYC/BOS/PHL AREAS Add1: 33 WEST 46 STREET, Add2: FIRST FLOOR, City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 557 1654, Fax: 917 464 8489 2022-03-24 NYCE WALKING TOUR AND COFFEE ON US Single 1 ENG 0.0 0.0 1 CF 0 WALKING TOUR OF THE HUDSON YARD NEIGHBORHOOD

COFFEE ON US (STARBUCKS CARD THAT CAN BE USED

ANY DAY AT ANY STARBUCKS)

Desclaimer: If the SALUTATION for a passenger was not supplied, TeamAmerica provided 'MR' for it as default.

]]> 0.0 EP-NO MEALS 1 2091357 NYCETMOMA 1080 TEAMAMERICA ET Add1: 33 WEST 46 STREET, Add2: , City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 697 7165, Fax: 2022-03-25 NYCE MOMA OR EQUIVALENT ATTRACTION Single 1 ENG 0.0 0.0 1 CF 0 SEE PRODUCTS DESCRIPTION FOR INFO

Desclaimer: If the SALUTATION for a passenger was not supplied, TeamAmerica provided 'MR' for it as default.

]]> 0.0 EP-NO MEALS 1 2091359 NYCTEOB 1 VOLATOUR-NYC/BOS/PHL AREAS Add1: 33 WEST 46 STREET, Add2: FIRST FLOOR, City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 557 1654, Fax: 917 464 8489 2022-03-30 NYCE ESCORTED TOUR ONLY TOB Single 1 ENG 0.0 0.0 1 CF 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

Desclaimer: If the SALUTATION for a passenger was not supplied, TeamAmerica provided 'MR' for it as default.

]]> 0.0 EP-NO MEALS 1 13112037 S A AD 31 1415.0 0.0 0.0 0.0 0.0 0.0 1415.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===== **XML Request** **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 ***** ***** *TEAMTEST test@test.com NYCTOB 2019-06-03 Single 1 ENG BOS 1230 TG340 1 Mr. S A ADULT 30 US 0 41 **XML Response** 1106500 2019-03-18 OK RW 0.0 *TEAMTEST 33 West 46th st 3rd floor New York NY 10036 SPAIN sharifulteam 1942428 NYCTOB 1 VOLATOUR-NYC/BOS/PHL AREAS Add1: 33 WEST 46 STREET, Add2: FIRST FLOOR, City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 557 1654, Fax: 917 464 8489 2019-06-03 NYCT TRSF OUT-SEAT ON COACH Min 2px Single 1 ENG BOS AIRPORT 12:30 TG340 41.0 41.0 1 CF 0 PVT TRSFS REQUIRED BTWN 11PM & 7AM ON DOMESTIC PVT TRFS REQUIRED BTWN 11PM & 7:30AM ON INTL FEE XTRF BFORE 9AM 12/24, 25, 31 &1/1 90 mins wait after landing on Intl/30mins domestic 41.0 EP-NO MEALS 1 3 Percent 100.0 12863975 S A ADULT 30 41.0 0.0 0.0 0.0 0.0 0.0 41.0 0.0 0.0 0.0 0.0 0.0 0.0 ---- =====✔ Package booking using NewMultiItemReservation Method===== **XML Request** **Description** for the amount of people associated with this reservation please use Occupancy. Below how you match occupancy to number of people Single = 1 ***** ***** *TEAMTEST test@test.com NYCPBASIC 2019-12-12 Single 1 ENG 1 Mr S A AD 27 US 0 90 NYCTIB 2019-12-12 Single 1 ENG 1 Mr A S AD 28 US 1 NYCPBASIC 0 **XML Response** 1126910 2019-10-25 OK RW 0.0 *TEAMTEST 33 West 46th st 3rd floor New York NY 10036 SPAIN sharifulteam 1969636 NYCPBASIC 1 VOLATOUR-NYC/BOS/PHL AREAS Add1: 33 WEST 46 STREET, Add2: FIRST FLOOR, City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 557 1654, Fax: 917 464 8489 2019-12-12 NYCP BASIC TRNSF IN+CITY TOUR ITA MIN 2 PAX Single 1 ENG 90.0 90.0 1 CF 0 MINIMUN 2 PAXS. ARRIVALS BETWEEN 11PM/7AM MUST BE BOOKED AS PRVT.EXTRA CHARGE ON ALL TRANSFERS BEF 9:00 AM ON 12/25 AND 01/01,AFTER 7:00 PM 12/24 12/31.EXTRA CHARGE FOR TOURS BETW 12/27-01/02 90.0 0 3 Percent 100.0 1969637 NYCTIB 1 VOLATOUR-NYC/BOS/PHL AREAS Add1: 33 WEST 46 STREET, Add2: FIRST FLOOR, City: NEW YORK, State: NY, Zip: 10036, Country: USA, Phone: 212 557 1654, Fax: 917 464 8489 2019-12-12 NYCT TRSFR IN-SEAT ON COACH MIN 2PAX Single 1 ENG 0.0 0.0 1 CF 0 flights landing btwn 10pm & 6am must be BKD AS PVT TRFS. FEE XTRF BEFORE 9AM ON P/UP TIME /Flight # /M1 MIN. 2 PAX SEE PRODUCT DESCRIPTION FOR MORE DETAILS 0.0 0 3 Percent 100.0 12910590 S A AD 27 12910591 A S AD 28 90.0 0.0 0.0 0.0 0.0 0.0 90.0 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. * [[start#RetrieveReservation|RetrieveReservation]] =====✔ RetrieveReservation===== **XML Request** ^Level^Name^Type^Occurs^Required^Comments^ |0 |RetrieveReservation | |1 | | |1 |Username |string |1 |Y | |1 |Password |string |1 |Y | |1 |ReservationNumber |INT |1 |Y | ***** ***** 1099035 **XML Response** ^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 | | | | 1099035 2019-03-18 OK RW 9.5 *TEAMTEST 33 West 46th st 3rd floor New York NY 10036 USA sharifulteam 1932090 NYCHPENC1B 72 PENNSYLVANIA HOTEL Add1: 401 7TH AVE, Add2: , City: NEW YORK, State: NY, Zip: 10001, Country: USA, Phone: 212 736 5000, Fax: 212 502 8712 2019-06-03 NYCH HOTEL PENNSYLVANIA - CLASSIC 1 BED (ROOM ONLY) Single 1 ENG TG340 186.0 186.0 1 CF 1 12846446 S A ADULT 30 CLASSIC ROOM WITH 1 BED (ROOM ONLY) FACILITY FEE OF$35+TAX P/R P/D TO BE PAID DIRECT NCL WIFI (UP TO 3 DEVICES),LOCAL/LONG DIST CALLS GYM,2 WELCOME DRINKS,G&G BKF for 2p (AS OF 11/29) 168.33 EP-NO MEALS 1 CLASSIC 1 BED ROOM ONLY 40.16 6 Paid Locally Plus Tax Per Day 3 Nights 1.0 12846446 S A ADULT 30 168.33 186.0 0.0 186.0 9.5 17.67 168.33 0.0 0.0 0.0 0.0 0.0 17.67 **Errors** *Error - Login Invalid *Error – Invalid length for Client Reference – Maximum of 14 allowed ---- =====✔ RetrieveResByReference===== **XML Request** ^Level^Name^Type^Occurs^Required^Comments^ |0 |RetrieveResByReference | |1 | | |1 |Username |string |1 |Y | |1 |Password |string |1 |Y | |1 |Reference |string |1 |Y | ***** ***** test **XML Response** ^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 | | 784371 TEST A 2016-08-02 OK CXLFEE 784375 TEST A 2016-08-02 OK CXLFEE 784376 TEST A 2016-08-02 OK CXLFEE 784425 TEST A 2016-08-02 OK CXLFEE 784426 TEST A 2016-08-02 OK CXLFEE 784442 TEST A 2016-08-02 OK CXLFEE 784443 TEST A 2016-08-02 OK CXLFEE 784455 TEST A 2016-08-02 OK CXLFEE 784456 TEST A 2016-08-02 OK CXLFEE 784471 TEST A 2016-08-02 OK CXLFEE 784472 TEST A 2016-08-02 OK CXLFEE 784484 TEST A 2016-08-02 OK CXLFEE 784491 TEST A 2016-08-02 OK CXLFEE 784492 TEST A 2016-08-02 OK CXLFEE 784512 TEST A 2016-08-02 OK CXLFEE 784513 TEST A 2016-08-02 OK CXLFEE 784518 TEST A 2016-08-02 OK CXLFEE 784519 TEST A 2016-08-02 OK CXLFEE 784524 TEST A 2016-08-02 OK CXLFEE 784525 TEST A 2016-08-02 OK CXLFEE 784536 TEST A 2016-08-02 OK CXLFEE 784537 TEST A 2016-08-02 OK CXLFEE **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. * [[start#cancelreservation|CancelReservation]] =====✔ 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 | | ***** ***** 1099035 **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* CX 1932090 NYCH HOTEL PENNSYLVANIA - CLASSIC 1 BED (ROOM ONLY) CX 0.0 2019-06-03 **Note** - **Cancellation policy is based on EST / EDT** **Errors** *Error - Login Invalid *Error - Reservation not found ---- =====✔ 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 | | ***** ***** 1932091 **XML Response** 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.