{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"edba5898-7edc-495e-a247-8f2d1b5f601b","name":"Alliance Reservation Network Hotel API","description":"**Welcome to Alliance Reservation Network's Hotel API documentation. You can use this to access information on hundreds of thousands of hotels, their availability, inventory details, as well as create and cancel reservations.**\n\nPlease first read our [XML Web Services Support Guide](https://support.alliancereservations.com/xml-web-services.html) before proceeding with the documentation below.\n\n---\n\n# Environment Variables\n\n<p>Throughout this page you may see values referenced using curly braces. These relate to the selected postman environment and the below table contains descriptions of the available postman environment variables. These can be tweaked within the Postman application to ease testing and API familiarization. If you were provided a Postman environment file for testing, please install the Postman app and click the 'Run in Postman' link at the top right of this page. Once app is installed and Postman collection loaded, click the settings icon in the top-right corner of the Postman interface next to the Environment dropdown and select 'Manage Environments'. Next, click on the Import button at the bottom of the Manage Environments menu, and select the environment file provided by ARN.</p>\n\nVARIABLE AND DESCRIPTION\n\n---\n\n`Site-Id`  \nSite id to use for api requests. Site id's reference a particular set of settings that you would like to utilize. Default: {{Site-Id}}.\n\n`API-ClientUsername`  \nTripAuthority API username. Default: {{API-ClientUsername}}\n\n`API-ClientPassword`  \nTripAuthority API password. Default: {{API-ClientPassword}}\n\n`CheckIn`  \nDesired check-in date (format: YYYY-MM-DD based on UTC -7 (MST) time zone).\n\n`CheckOut`  \nDesired check-out date (format: YYYY-MM-DD based on UTC -7 (MST) time zone).\n\n`HotelIds`  \nComma-seperated values.\n\n`Rooms`  \nNumber of rooms needed. When searching for more than one room, responses are based on the same room type and occupancy for every room. Maximum: 9 (best results with no more than 4).\n\n`Adults`  \nTotal number of adults. For instance, if rooms=2 and adults=2, then the search is for 1 room per adult. Maximum 8 adults per room. Uneven/odd numbers of adults/rooms will be rounded up to support legacy providers.\n\n`Children`  \nTotal number of children. Maximum: 8. Note: Some legacy providers do not honor the children parameter.\n\n`Currency`  \nSupported currencies are located in our static database files. Request access if needed. Major 3-letter currency references (e.g., \"USD\", \"CNY\", \"CAD\", etc.) are supported.\n\n`Locale`  \nSpecifies the response localization. Default: \"US\"\n\n`UserAgent`  \nThe userAgent of the app/browser of the person browsing your website. This is used for fraud checking and preventing booking failures.\n\n`UserLanguage`  \nThe language of the browser of the person browsing your website. This is used for fraud checking and preventing booking failures.\n\n`Gateway`  \nThis should be either left empty to return all sources of supply or specified by a single integer or comma separated list of integers. [Full list of supported gateways](https://support.alliancereservations.com/gateways.html)\n\n`Timeout`  \nMaximum time to allow for searching gateways, measured in seconds. Default: 15\n\n`ReturnType`  \nFormat of API response. Formats available 'json', 'xml'. Default: {{ReturnType}}\n\n---\n\n# Basic Auth Credentials\n\nUsername  \n{{API-ClientUsername}}\n\nPassword  \n{{API-ClientPassword}}\n\n---\n\n# API Versions\n\nAPI versions can be controlled using the **'Accept-version'** header on each request. Version 1 is the default version returned but version 2 is the recommended version to use for new integrations.\n\n<table><tbody><tr><th>Version</th><th>Description</th></tr><tr><td><div>1</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Version 1 is the initial release of the Hotel API. Default version that is returned by API.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>2</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Version 2 introduces consistent array structures for Hotel, RatePlan, Room and NightlyRate in JSON responses.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>2.1</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Version 2.1 introduces the <i>DueOnArrival </i>element, with information related to fees that are due at property, and the <i>bestdeal </i>sort type option.<br><b>Version 2.1 is the recommended version to use for new integrations.</b><br><br><i><b>DueOnArrival </b></i><b>exemple:</b><br><br><code>\"Room\": {<br>&nbsp; \"DueOnArrival\": {<br>&nbsp; &nbsp; \"Total\": {<br>&nbsp; &nbsp; &nbsp; \"@Amount\": \"34.20\",<br>&nbsp; &nbsp; &nbsp; \"@CurrencyCode\": \"USD\"<br>&nbsp; &nbsp; },<br>&nbsp; &nbsp; \"Fee\": {<br>&nbsp; &nbsp; &nbsp; \"@Title\": \"Resort Fee\",<br>&nbsp; &nbsp; &nbsp; \"@Description\": \"$34.2 USD per room per stay\",<br>&nbsp; &nbsp; &nbsp; \"@Amount\": \"34.2\",<br>&nbsp; &nbsp; &nbsp; \"@CurrencyCode\": \"USD\",<br>&nbsp; &nbsp; &nbsp; \"@IsOptional\": \"false\"</code><code><br>&nbsp; &nbsp; }<br>&nbsp; }<br>}</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n---\n\n# Common Value Maps\n\n## Sort Types\n\n<table><tbody><tr><th>Sort Type</th><th>Description</th></tr><tr><td><div>bestvalue</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Default sort based on previous booking trends and manual sorting options.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>dealpercent</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sorts the hotel results based on prices last seen and returns the best percentage savings we have found in the city historically and for those dates.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>dealamount</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sorts the hotel results based on prices last seen and returns the best amount savings we have found in the city historically and for those dates.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>rebateamount</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sorts the hotel results based on best rebate dollar amount we have found in the city historically and for those dates. For use in conjunction with elective rebate percent configuration settings.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>bestdeal</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Sorts the hotel results based on largest/highest wholesale to retail margin. It also instructs our system on the backend to prioritize the supply returned.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n## Property Amenities\n\n<table><tbody><tr><th>Id</th><th>Description</th></tr><tr><td><div>1</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Airport shuttle</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>2</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Social hour</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>3</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Fitness center</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Internet access</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>5</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Free local calls</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>6</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Complimentary breakfast</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>7</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Pets allowed</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>8</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Pool</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>9</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Restaurant on-site</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>10</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Kitchen / kitchenette</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n## Property Classes\n\n<table><tbody><tr><th>Property Class</th><th>Star Rating</th><th>Description</th></tr><tr><td><div>1</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>1</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Economy</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>2</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>2</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Budget</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>3</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>3</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Moderate</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>4</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Premium</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>5</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>5</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Luxury</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n## Property Types\n\n<table><tbody><tr><th>Property Type ID</th><th>Property Type</th></tr><tr><td><div>1</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Hotel - Limited Service</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>2</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Hotel - Full Service</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>3</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Hotel/Conference Center</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Hotel/Casino</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>5</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Motel</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>6</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Resort</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>7</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Inn &amp; Suites</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>8</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Extended stay property</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>9</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Bed and breakfast</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>10</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Guest Ranch</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>11</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Boutique</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>12</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Condo/Vacation Rental</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n## Accepted Credit Card Types\n\n<table><tbody><tr><th>CCType</th><th>Credit Card</th></tr><tr><td><div>AX</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>American Express</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>CA</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Mastercard</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>VI</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Visa</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>DS</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Discover</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n## Test Credit Card Exception Triggers\n\n<table><tbody><tr><th>Credit Card Number</th><th>Exception Triggered on Booking</th></tr><tr><td><div>4111111111111111</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Generic test credit card to utilize for test bookings when API is in TEST MODE (Garbled room descriptions returned)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4321432143214327</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Trigger a Credit Card authorization Declined response from a booking</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4716712544170282</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Trigger a Credit Card Address Verification Check Declined response from a booking</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4164790589737550</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Trigger a Credit Card CVV Validation Check Declined response from a booking</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>5454545454545454</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Trigger exception due to the amount of the reservation authorization being different what needs to be booked.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4000000000000093</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Trigger exception when the Bookable Rate that returned from the supplier has gone UP from your requested booking rate amount.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4000000000000077</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Trigger exception when the Bookable Rate that returned from the supplier has gone DOWN from your requested booking rate amount.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n# Error Codes\n\n<table><tbody><tr><th>HTTP Error Code</th><th>Description</th></tr><tr><td><div>400</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Bad Request -- Your request is invalid.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>401</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Unauthorized -- Your API credentials are wrong.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>403</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Forbidden -- You are not allowed in there.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>404</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Not Found -- The specified hotel or endpoint could not be found.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>405</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Method Not Allowed -- You tried to access an endpoint with an invalid method.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>406</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Not Acceptable -- You requested a format that isn't json or xml.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>410</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Gone -- The hotel requested has been removed from our servers.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>429</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Too Many Requests -- You are sending requests too often! Slow down!</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>500</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Internal Server Error -- We had a problem with our server. Try again later.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>503</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Service Unavailable -- We're temporarily offline for maintenance. Please try again later.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<table><tbody><tr><th>Error Code</th><th>Example Response</th></tr><tr><td><div>CCAUTHD</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The credit card that you have supplied to us is not working. Please verify your credit card information and try again or, try another credit card.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>CCAUTHF</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The credit card that you have supplied to us is not working. Please verify your credit card information and try again or, try another credit card.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>CCAUTHA</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The credit card address that you have supplied to us is not working. Please verify your billing address information and try again or, try another credit card.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>CCAUTHX</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>We're sorry but American Express can only be used for US Dollar Transactions.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>CCAUTH27114</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>In order to confirm your reservation, please use your PayPal Extras or your eBay MasterCard.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>AUTHAMT</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>CreditCardFailedException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The credit card that you have supplied to us is not working. Please verify your credit card information including: your credit card number, verification code and billing address then, please try again. If that doesn't work, you may need to use a different credit card.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>CreditCardFraudException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The credit card that you have supplied to us is not working. Please verify your credit card information including: your credit card number, verification code and billing address then, please try again. If that doesn't work, you may need to use a different credit card.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>CCPossibleFraudException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>We are sorry but your selected accommodation failed to respond with a confirmation. Please call our customer service line at 602-761-9744 for assistance with your booking.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>PossibleReservationException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>There was an interruption in the communications with the hotel processing this reservation and we are not sure if your credit card was charged or if the reservation was made. Please contact one of our friendly customer service representatives to help you confirm this booking. In the meantime, please do not re-attempt this booking in order to avoid duplicate charges.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>DuplicateBookingException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Each room reservation must have a different name to avoid potential customer service problems during check-in. Please change the name on the highlighted reservations and then re-submit your request.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>NoCheckInException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Unfortunately, the hotel that you've selected does not allow check-in for the day or date that you selected. If you must stay at this hotel, please change your check-in date or, try one of the many other hotels nearby that we offer without this check-in restriction.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>PropertyUnavailableException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>It looks like this hotel's reservation system is currently down. You may choose to try this property again in a little while or, feel free to select from one of the many other properties nearby. Simply, click the back button on your browser. We're sorry for the inconvenience!</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>InvalidInputException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Something in the highlighted form field is causing validation errors with the hotel's system. Examples include: extra spaces, apostrophes, or numbers instead of letters in certain fields. Please remove any unusual characters from your form and try again.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>InvalidPostalCodeException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>It looks like the zip code or postal code that you entered is not working. Please double check your information and try again.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>RateNotAvailableException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>It looks like someone grabbed the last room at this rate. Please click return to property below to retry the failure with another room type, or you can try selecting another hotel nearby.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>SupplierUnavailableException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>It looks like this hotel's reservation system is currently down. You may choose to try this property again in a little while or, feel free to select from one of the many other properties nearby. Simply, click the back button on your browser. We're sorry for the inconvenience!</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>RateChangedHigherException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Due to changes in availability, the rate for the room you selected has gone up since your search began. You may confirm at the new rate, or redo your search.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>RateChangedLowerException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Due to changes in availability, the rate for the room you selected has gone down since your search began. You may confirm at the new rate, or redo your search.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n# Coupon Codes\n\nCoupon codes may be redeemed with the Hotel API. Coupon functionality must be enabled for your site, please contact [ARN Support](http://arn.support/) to request coupon functionality and access to provision coupons. To redeem on a reservation, pass coupon code as discountCard parameter on the [Rate Details](#f981ca01-3a72-4aa4-8d6b-2622de03ecae) request and also on the [Reservation Creation](#84f049d7-b04e-4bdf-b072-6e74f14969dd) request. Coupons can be managed with [ARN's Card Code Creator](https://support.alliancereservations.com/card-code-creator.html).\n\n# Testing Your Integration\n\nBy default your new account will be in test mode that will replace the live gateways and query results with fake test data that can be queried and booked using fake credit cards and absent any consequences. Test gateways are 28 and 29 and the room and rate descriptions for those test gateways will be obviously fake data gibberish; if you book a reservation on any other gateway, you are responsible for it as it is a real reservation with real charges and penalties.\n\nYou can use two fake card numbers to force credit card failures to ensure you handle them properly. 4321432143214327 will cause an authorization declined error and 5454545454545454 will cause an amount that must be charged is different from amount authorized error. 4111111111111111 can be used on the test gateways to book a successful reservation. Reference our [Test Credit Card Exception Triggers](#test-credit-card-exception-triggers) above.\n\nUpon request we will refund any booking fees that may have been charged during testing. For service fee credits, if any, email the cancellation acknowledgement to [customerservice@allresnet.com](https://mailto:customerservice@allresnet.com) with the subject line \"Credit for Service Fee of TEST Reservation\"\n\n# Webhook Integration\n\nWebhooks allow ARN to push data when certain events occur on the hotel platform, such as reservation creation and cancellation. Webhooks are sent as HTTP POST with raw XML body and Content-Type set to 'text/xml'. Further webhook details can be found in the [XML Web Services Support Guide](https://support.alliancereservations.com/web-hookstracking-parametersreporting-scripts.html).\n\n- [Reservation Webhook Example (TestMode)](https://docs.google.com/uc?export=download&id=1MeXxML6EdKca_jo05LAIyzzssouSV7gM)\n    \n- [Cancellation Webhook Example (TestMode)](https://docs.google.com/uc?export=download&id=1vWvw58FOWTHE6JS7rokCv0_wBHaFmgnw)\n    \n- [Reservation Webhook Example](http://static.reservetravel.com/documents/trip-examples/ReservationResponse.xml)\n    \n- [Cancellation Webhook Example](https://static.reservetravel.com/documents/trip-examples/CancellationResponse.xml)\n    \n\n# Contacting Support\n\nPlease submit all requests for support through the [Partner Request form](https://arn.support/). All problems can be solved through this channel.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10758950","team":17661067,"collectionId":"edba5898-7edc-495e-a247-8f2d1b5f601b","publishedId":"SzmfXHCg","public":true,"publicUrl":"https://documenter-api.postman.tech/view/10758950/SzmfXHCg","privateUrl":"https://go.postman.co/documentation/10758950-edba5898-7edc-495e-a247-8f2d1b5f601b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2020-07-02T17:04:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Public Hotels","id":"300383e6-2648-4250-8ae5-25ba8bf3e90f","owner":"10758950","values":[{"key":"Site-Id","value":"64","enabled":true},{"key":"API-ClientUsername","value":"publictest","enabled":true},{"key":"API-ClientPassword","value":"testme","enabled":true},{"key":"ReturnType","value":"json","enabled":true},{"key":"CheckIn","value":"","enabled":true},{"key":"CheckOut","value":"","enabled":true},{"key":"Rooms","value":"","enabled":true},{"key":"Adults","value":"","enabled":true},{"key":"Children","value":"","enabled":true},{"key":"Currency","value":"","enabled":true},{"key":"Locale","value":"","enabled":true},{"key":"UserAgent","value":"","enabled":true},{"key":"UserLanguage","value":"","enabled":true},{"key":"Timeout","value":"","enabled":true},{"key":"IpAddress","value":"","enabled":true},{"key":"RatePlanCode","value":"","enabled":true},{"key":"RoomCode","value":"","enabled":true},{"key":"Gateway","value":"","enabled":true},{"key":"LocationId","value":"","enabled":true},{"key":"CandidateSearch","value":"","enabled":true},{"key":"Page","value":"","enabled":true},{"key":"MaxResults","value":"","enabled":true},{"key":"HotelIds","value":"","enabled":true},{"key":"RefHotelId","value":"","enabled":true},{"key":"Latitude","value":"","enabled":true},{"key":"Longitude","value":"","enabled":true},{"key":"Radius","value":"","enabled":true},{"key":"SortType","value":"","enabled":true},{"key":"Name","value":"","enabled":true},{"key":"PropertyClasses","value":"","enabled":true},{"key":"PropertyAmenities","value":"","enabled":true},{"key":"PropertyTypes","value":"","enabled":true},{"key":"ReservationLocator","value":"","enabled":true},{"key":"GuestAddress","value":"123 Made Up Ln.","enabled":true},{"key":"GuestCity","value":"Example City","enabled":true},{"key":"GuestCountryCode","value":"US","enabled":true},{"key":"GuestAddressExtraInfo","value":"","enabled":true},{"key":"GuestPostalCode","value":"12345","enabled":true},{"key":"GuestRegion","value":"FL","enabled":true},{"key":"AgentId","value":"","enabled":true},{"key":"BookingFeeAmount","value":"","enabled":true},{"key":"CampaignCode","value":"","enabled":true},{"key":"BookingFeeCurrencyCode","value":"","enabled":true},{"key":"CreditCardAddress","value":"123 Made Up Ln.","enabled":true},{"key":"CreditCardCity","value":"Example City","enabled":true},{"key":"CreditCardCountryCode","value":"US","enabled":true},{"key":"CreditCardCVV2","value":"123","enabled":true},{"key":"CreditCardExpiration","value":"05/22","enabled":true},{"key":"CreditCardHolder","value":"Test Cardholder","enabled":true},{"key":"CreditCardNumber","value":"4111111111111111","enabled":true},{"key":"CreditCardPostalCode","value":"12345","enabled":true},{"key":"CreditCardRegion","value":"FL","enabled":true},{"key":"CreditCardType","value":"VI","enabled":true},{"key":"GuestEmail","value":"guest@example.com","enabled":true},{"key":"GuestFirstName","value":"Test","enabled":true},{"key":"GuestLastName","value":"Guest","enabled":true},{"key":"GuestPhoneArea","value":"123","enabled":true},{"key":"GuestPhoneCountry","value":"1","enabled":true},{"key":"GuestPhoneNumber","value":"1234567890","enabled":true},{"key":"RecordLocator","value":"","enabled":true},{"key":"RoomCostCurrencyCode","value":"","enabled":true},{"key":"RoomCostGatewayFee","value":"","enabled":true},{"key":"RoomCostPrice","value":"","enabled":true},{"key":"RoomCostTaxAmount","value":"","enabled":true},{"key":"RoomCostTotalAmount","value":"","enabled":true},{"key":"AgentRefNumber","value":"","enabled":true},{"key":"ConfirmationNumber","value":"","enabled":true},{"key":"ReservationId","value":"","enabled":true},{"key":"ItineraryId","value":"","enabled":true},{"key":"CouponCode","value":"","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/2fee9c80811bac96321494e36e21fdbd25cb6a2b9f5f88a189113ed18565572a","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Public Hotels","value":"10758950-300383e6-2648-4250-8ae5-25ba8bf3e90f"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SzmfXHCg"}