Guides for the ChannelRUSH Channel Manager, Booking Engine & CRS
Search for the articles here or browse the categories below.
Browse by topic
Find guides, tutorials, and answers organised by category.
Popular articles
What other people are reading right now.
Set up and implement the Channel Manager JSON API
Connect your PMS or software platform to ChannelRUSH to distribute availability, rates and restrictions to booking channels, and bring new, modified and cancelled reservations back into your system. This guide explains the implementation sequence for CM API v2. Use it alongside the interactive API reference (Swagger UI), which contains the request models, response models and endpoint details. The OpenAPI document is available for client generation, and ReDoc provides another reference view. The two core flows are: - Your system → ChannelRUSH → booking channels: send availability, rates and inventory, referred to below as ARI. - Booking channels → ChannelRUSH → your system: pick up reservations, save them in your system, then confirm that processing succeeded. This is a server-to-server integration. Keep API credentials on your server, not in a booking page or browser application. If your goal is to search availability and create bookings for a booking website, see the APIs overview for the CRS and OTA APIs instead. 1. Get your test account and connection details Contact your ChannelRUSH integration contact or support@channelrush.com and request access to the Channel Manager JSON API. Include your platform name, technical contact and the properties/channels you intend to connect. Before coding against a property, obtain or confirm: - Test access: the API bearer token and the test properties assigned to your integration. A website login is separate from an API token. - API server: the test API base is https://testcm.channelrush.net/api/v2. Use the server and credentials supplied for your environment; do not mix test and production. - Property and product mappings: the propertyId, room type IDs and rate plan IDs your integration must send. - Enabled processing: which properties can receive ARI from your platform and which are configured for reservation pickup. - Commercial rules: the property currency, pricing model, supported restrictions, intended booking channels and which system owns availability changes. - Operational expectations: the reservation polling interval, update volume/batch sizing, credential lifecycle and go-live procedure agreed for your integration. Your sandbox welcome email includes connection information and a first settings request. Use your assigned values rather than IDs copied from a documentation example. Do not treat a sandbox token as permission to access another test account. Start with one assigned test property and a small date range. Complete both ARI and reservation processing before expanding to additional properties. 2. Authenticate and make your first request Send this header on API requests: Authorization: Bearer YOUR_TOKEN Send JSON request bodies with Content-Type: application/json and use HTTPS throughout. Try it in Swagger UI 1. Open Swagger UI and select V2. 2. Click Authorize. 3. In Value, enter the complete value: the word Bearer, a space, then the token supplied for your integration. Click Authorize, then Close. 4. Expand GET /api/v2/connectioncheck, click Try it out, then Execute. 5. Check the HTTP status, the response's successful value and any messages. Swagger's Execute button sends a real request. Use only your assigned test property when trying write operations such as ariupdate, resconfirm or test_reservationscreate. The same check from your integration The following shell examples assume CM_TOKEN contains only the token, without the Bearer prefix. Set those through your normal secure local configuration; do not commit them to source control. CM_API_BASE='https://testcm.channelrush.net/api/v2' curl --silent --show-error --include \ "$CM_API_BASE/connectioncheck" \ --header "Authorization: Bearer $CM_TOKEN" \ --header 'Accept: application/json' HTTP 200 is not sufficient to mark a request successful. Many endpoints return HTTP 200 with successful: false and details in messages. A valid connection check also does not prove that a particular property's mappings or processing modes are enabled. 3. Read and validate the property's mappings Call POST /api/v2/settings with your assigned propertyId: { "propertyId": "YOUR_PROPERTY_ID" } You can save this body as settings-request.json, replace the placeholder and send it with: curl --silent --show-error --include \ "$CM_API_BASE/settings" \ --header "Authorization: Bearer $CM_TOKEN" \ --header 'Content-Type: application/json' \ --data-binary @settings-request.json Require successful: true, then inspect settings.propertyId, settings.propertyName and settings.roomTypes. Each room type includes its roomTypeId, name and available ratePlans. Build and validate your mapping before sending inventory: 1. Match each returned room type to the corresponding room type in your system. 2. Match rate plans within the correct room type. Do not assume every room offers the same plans. 3. Store the exact string IDs; do not substitute display names, convert codes to numbers or assume they are ChannelRUSH's internal database IDs. 4. Refresh and revalidate mappings when rooms or plans change, and before enabling a newly connected property. A plan appearing in settings is not proof that every underlying mapping required for an update is complete; validate your first update too. GET /api/v2/channels supplies channel names and numeric channel IDs. These channel IDs are consistent across properties, but the list is not proof that every channel is connected to your property. If settings returns “Settings not configured or enabled.”, confirm the environment, assigned property code and enabled connection with ChannelRUSH before sending updates. Do not guess another property ID. 4. Send a small ARI update Use POST /api/v2/ariupdate to update inventory. POST /api/v2/ari is a read/report operation, not an update. An update contains: - propertyId: the mapped property code. - channelIds: an optional destination selection. An empty list means all channels in scope, not none. The property's connection, mapping and send settings still determine what can be distributed. Use specific IDs only when deliberately targeting those channels. - items: the room/rate-plan updates, each with its own dateRange and values. Before changing inventory, read a baseline with POST /api/v2/ari using the property, products and dates you intend to update; an example appears below. The following is an illustrative request assembled from the API models, not a captured successful transaction. Replace the property/product IDs with settings returned for your test property, choose suitable test dates and confirm the currency. It sets room allocation and a rate-plan price separately. Its empty destination list deliberately uses all-channel scope; for a single-channel test, replace it with the specific numeric channel ID agreed for that property: { "propertyId": "YOUR_PROPERTY_ID", "channelIds": [], "items": [ { "roomTypeId": "YOUR_ROOM_TYPE_ID", "ratePlanId": "", "allocation": 5, "dateRange": { "startDate": "2027-01-10", "endDate": "2027-01-12", "mon": true, "tue": true, "wed": true, "thu": true, "fri": true, "sat": true, "sun": true } }, { "roomTypeId": "YOUR_ROOM_TYPE_ID", "ratePlanId": "YOUR_RATE_PLAN_ID", "currencyCode": "USD", "sellRate": 149.00, "dateRange": { "startDate": "2027-01-10", "endDate": "2027-01-12", "mon": true, "tue": true, "wed": true, "thu": true, "fri": true, "sat": true, "sun": true } } ] } Save the adjusted body as ari-update.json and send it to $CM_API_BASE/ariupdate with the same authorization and JSON headers, using --data-binary @ari-update.json. Important update semantics - The start and end dates are inclusive. The example includes January 10, 11 and 12. These are inventory dates, not a guest's check-in/check-out interval. Preserve the intended calendar dates when using date/time types in a generated client. - Weekday flags filter the range. A false flag excludes that weekday. The API defaults these flags to true; explicitly setting them avoids client-generator defaults accidentally suppressing updates. At least one weekday must remain true, and the end date cannot precede the start date. - Send the values you intend to change. Omitted/null update fields do not supply a new value; null is not a clear/reset command. Preserve nullable fields rather than turning every absent value into zero or false. allocation: 0 and stopSell: false are explicit instructions, not empty values. Each item needs at least one update value. - Use room-level and rate-plan-level scope deliberately. An empty ratePlanId is room-level scope; it is not a wildcard rate-plan ID. Use the mapped rate plan when sending a plan's price or restrictions. - Send decimal prices as JSON numbers. Do not include currency symbols or locale-formatted commas. currencyCode is required when setting sellRate or rateParams, and item-level sellRate: 0 is rejected. Use rateParams only when your agreed pricing model needs occupancy or supplemental rates; the RateParameterType reference defines their meanings, and each type must appear only once per item. - Restriction support varies by destination and setup. Confirm which fields each connected channel accepts before relying on them. Check the result Inspect the top-level successful and messages, and every entry in items, including its roomTypeId, ratePlanId, successful and messages. Top-level success can coexist with failed items. A batch must not be treated as an all-or-nothing operation or as successful merely because the HTTP request completed. Accepted updates are queued for background processing. An immediate readback can precede that processing; do not turn a delayed readback into an automatic duplicate send. Then use POST /api/v2/ari with the same property, products and dates to inspect stored ARI. For example: { "propertyId": "YOUR_PROPERTY_ID", "roomTypeId": "YOUR_ROOM_TYPE_ID", "ratePlanId": "YOUR_RATE_PLAN_ID", "dateRange": { "startDate": "2027-01-10", "endDate": "2027-01-12", "mon": true, "tue": true, "wed": true, "thu": true, "fri": true, "sat": true, "sun": true } } ari reads stored master inventory for your integration, not live OTA inventory. With no channelIds filter it can return both the shared all-channel scope and channel-specific stored scopes; inspect each returned day's channelId as well as its room/plan/date. Rows can be returned for dates without stored information, and some missing restriction values are displayed as defaults such as false, zero or one night. Do not copy an entire read response back as an update. Construct updates from the values your system actually intends to send. Readback is not an independent confirmation from every OTA. Separate API processing, stored inventory and downstream channel delivery in your monitoring. For operational investigation, use ChannelRUSH's update status guide or ask your integration contact to check the relevant destination. After validating the small update, agree the initial inventory horizon and load the required rooms/plans. Then send changes as your system's inventory changes. Keep the ability to reconcile and resend current intended values after an outage; do not replay stale prices over newer changes. 5. Receive reservations and confirm processing For a new polling integration, implement the paired res and resconfirm endpoints. Do not use a reservation search as a substitute for the pending-delivery workflow. Pick up pending reservations Call POST /api/v2/res for each enabled property: { "propertyId": "YOUR_PROPERTY_ID" } A successful response's items collection contains: - reservation: the booking details and its current status. - reservationConfirmationId: the identifier to return when confirming that specific reservation state. Handle new, modified and cancelled reservations. The JSON reservation status values are 0 = New, 1 = Modified and 2 = Canceled. Process every applicable room and rate entry, not only the first room. Keep the original channel identity and reservation ID alongside your own PMS booking ID. Do not confuse these identifiers: - reservation.reservationId identifies the source reservation; pair it with the property and reservation.channelId, which identifies the booking source. - reservation.reservationIdVersion identifies that reservation state/version. - reservationConfirmationId identifies the delivery/state you must acknowledge. - reservationIdClient is your system's reservation ID, supplied in the confirmation. Save first, confirm second For each returned item: 1. Validate its property/product mapping and reservation status. 2. Save or update the reservation durably in your system, including cancellations. 3. Record the delivery identifier and the resulting local booking ID so a repeated pickup does not create another booking. 4. Only after successful processing, send that item's confirmation to POST /api/v2/resconfirm. 5. Inspect the response's top-level outcome and each confirmation item's successful value. 6. Pick up again after confirming a batch to receive later states and remaining work. The API returns bounded batches and exposes successive states of the same booking in order. A short batch does not prove the backlog is exhausted. There is no page/cursor field in ResRequest. Illustrative confirmation body; use the actual ID returned by res, not this sample number: { "propertyId": "YOUR_PROPERTY_ID", "items": [ { "reservationConfirmationId": 12345678910, "reservationIdClient": "YOUR_PMS_RESERVATION_ID" } ] } A confirmed item no longer appears in the pending pickup collection. Do not confirm an item that failed to save or process. Alert your team and resolve the failure. Pickup marks pending deliveries as processing; it is not a passive reservation search. Unconfirmed processing items can be returned again. If a delivery remains unconfirmed for 60 minutes from its creation in ChannelRUSH, it becomes eligible for failure/backup processing—not 60 minutes from your first pickup. Repeated polling does not restart that deadline. Once marked unsuccessful, that delivery is no longer in the normal pending pickup set. Backup email depends on configured, verified recipients and does not mean the booking was imported into your PMS. Escalate missing/expired deliveries rather than relying on indefinite redelivery. Design for interrupted processing Your system can stop after saving a booking but before receiving a confirmation response. Persist enough state to recognize that delivery on the next pickup and retry its acknowledgement without creating the booking again. A later modification or cancellation is a new state to process, not a duplicate to discard because the source booking ID already exists. A repeated confirmation can return item-level successful: false after the original confirmation already succeeded. That result alone cannot distinguish an already-confirmed state from another unavailable delivery. Preserve your local record, reconcile the delivery with ChannelRUSH when necessary and never create another booking to resolve an acknowledgement error. A reservation lookup does not itself prove that delivery was acknowledged. Use property and source-channel context when matching source reservation IDs. Store confirmation IDs without losing 64-bit integer precision. Coordinate workers so the same property's deliveries are not being independently imported by overlapping pollers. Agree the polling cadence with ChannelRUSH. Monitor last successful pickup, oldest unprocessed delivery, processing failures and failed confirmations. An empty successful pickup means no pending items were returned; an unsuccessful response or timeout must not be recorded as “no bookings.” 6. Test the complete flow On the test server, POST /api/v2/test_reservationscreate creates test reservations for the configured delivery mode. For the polling workflow, use the same {"propertyId":"YOUR_PROPERTY_ID"} body as res, with only your assigned test property. Then pick up through res, process, confirm through resconfirm and pick up again. This endpoint creates data and notifies ChannelRUSH support; it is not a connection check. Verify the resulting deliveries, not only the creation response's success flag. Do not expect the creation response to contain the generated reservations, even though Swagger shows a shared reservation-response example. The available test cases depend on property/channel setup; coordinate any missing scenarios with your integration contact. Before go-live, exercise these scenarios with ChannelRUSH: - Authentication works, invalid credentials fail and a property with incomplete setup is handled clearly. - Settings resolve every room/rate-plan combination your system intends to use. - Allocation, rates and each agreed restriction reach the intended scope; zero, false, omitted values, date boundaries and weekday filters behave as intended. - A failed item does not hide successful items or cause a whole batch to be marked complete. - New reservations, modifications, cancellations and multi-room bookings are processed correctly. - Repeated pickup and a process restart after local save do not duplicate bookings. - Failed local processing does not send a successful confirmation. - Failed or uncertain confirmations are recovered without losing later reservation changes. - An outage recovery uses current intended inventory and drains reservation work without silently dropping it. Keep sanitized request/response captures from these tests and use them as regression fixtures. Documentation examples are a starting point, not evidence that your own mappings or workflow have passed. 7. Add optional functions only when needed - POST /api/v2/reservations: retrieve existing reservations using the filters in ReservationsRequest. An exact reservationId lookup also requires the booking source's channelId. Without a reservation ID, the search starts with departure dates 28 days ago, not reservations created in the last 28 days. Use it for agreed lookup/reconciliation work, not to acknowledge pending deliveries. - POST /api/v2/book: an optional operation for reservations created in the PMS, such as walk-ins or direct bookings from sources not managed by the channel manager. Do not use it to acknowledge or re-create an OTA booking already received through res. Agree the intended reservation and inventory workflow before enabling it. - POST /api/v2/resall: listed under the deprecated reservation operations. Use reservations for existing-reservation lookup and res plus resconfirm for pending delivery. If you need push delivery instead of polling, ChannelRUSH can send reservation details to an agreed endpoint on your server. This is not merely a notification to start a poll: your callback must return the agreed confirmation response after processing. Coordinate callback authentication, payload/response shape and retry behavior with ChannelRUSH before implementing it. Do not run overlapping push and polling consumers without agreement. 8. Handle errors and uncertain outcomes Keep transport errors separate from application results: - HTTP 400: inspect the validation response and correct the request shape/values. Do not retry an unchanged invalid request in a tight loop. - HTTP 401: verify the environment and complete Authorization: Bearer … header. Contact ChannelRUSH if the supplied credential is no longer accepted; do not log or email the token. - HTTP 200 with successful: false: inspect messages and any item-level results. Connection/setup/mapping failures need correction, not an assumption of successful delivery. - HTTP 500, network failure or timeout: the outcome of a write can be uncertain. Use bounded retry/backoff and your persisted operation state. Before replaying ARI, ensure it still represents the newest intended values; before importing or confirming a reservation again, check its recorded processing state. - Stored ARI differs from an OTA: check destination mapping, supported fields, configured transformations and delivery status. An accepted inbound request is not proof of downstream acceptance. - A reservation is picked up repeatedly: check whether local processing succeeded and whether the corresponding confirmation succeeded. Do not suppress it by confirming an unprocessed booking. For support, provide the environment, endpoint, property code, affected product/channel IDs, inventory dates or reservation delivery ID, request time with time zone, HTTP status and sanitized error details. Remove bearer tokens, card details and unnecessary guest data from logs and attachments. 9. Generate a client without losing API semantics You can generate a client from the OpenAPI document, or implement the endpoints directly. Keep a versioned copy of the specification used to generate your client and review changes before regeneration. Check the generated client's behavior before using it for inventory or bookings: - It sends the full bearer header and can switch environments without code changes. - Nullable values remain distinct from zero/false. - Date-only inventory examples are not shifted by automatic time-zone conversion. - Decimal amounts and 64-bit identifiers retain precision. - It handles messages, top-level success and item-level success rather than relying only on exceptions for non-2xx responses. - Enum handling and response parsing are verified against actual test responses as well as the models. Reservation statuses are numeric, while messages[].messageType is serialized as text such as Info, Warning or Error; a client generated with a numeric-only message-type parser needs adjustment. Do not assume every illustrative example is a literal successful response. 10. Prepare for production Coordinate production enablement with your ChannelRUSH integration contact. Confirm the production server/token, property/product mappings, destination channels, supported update fields, reservation delivery settings and operational contacts independently of the sandbox. Before enabling distribution: 1. Agree which system owns allocation and how bookings, cancellations and manual changes affect it, so availability is not adjusted twice. 2. Verify the complete initial inventory horizon, including prices and restrictions, for the intended rooms/plans. 3. Have reservation pickup, durable processing, confirmation and alerts running for every enabled property. 4. Review retry/reconciliation behavior and the support procedure for an uncertain update or delivery failure. 5. Validate a controlled production rollout with ChannelRUSH before expanding scope. Keep test and production configuration separate. Do not move sandbox tokens or sample mapping IDs into production.
Booking EngineBooking Engine
New Setup Add Channel - ChannelRUSH Booking Engine Admin -> Settings -> Channels -> Add New Click 'Add New' from the 'Channels' section, and add the 'ChannelRUSH Booking Engine'. CRS Settings Admin -> Settings -> Channels -> ChannelRUSH CRS If the 'ChannelRUSH CRS' link does not appear in 'Admin -> Settings -> Channels', make sure the channel 'ChannelRUSH Booking Engine' is added to the property's set of channels. You can also add the ChannelRUSH CRS as a channel directly in addition to the ChannelRUSH Booking Engine. Related Article - ChannelRUSH CRS Please complete the ChannelRUSH CRS Settings, which configure how your booking enigne will operate. Use the following article for guidance: 💡 ChannelRUSH CRS ChannelRUSH CRS Domain Setup To have the booking engine load under a subdomain of your primary domain - i.e. booking.yourdomain.com, in your DNS provider config, create a subdomain of your choice (i.e. booking), and set the following record. Record Type: CNAME Host: booking (or the subdomain of your choice) Points To: reservation.services TTL: 12 Hours (or something reasonable / greater than 12 hours)
API DocumentationCRS API
The CRS API lets a point of sale — a booking site, an agency portal, a metasearch connector — search ChannelRUSH properties, price a stay, and place, retrieve, modify and cancel reservations. This guide is the part the Swagger page does not tell you: how the calls fit together and what trips integrations up. A complete, runnable example accompanies this guide: a .NET booking site (reservation.services.crs) and a typed client library (reservation.services.crs.client). If you do not have it, ask ChannelRUSH for the CRS API example. Environments Base URL Swagger Test https://testcrs.channelrush.net https://testcrs.channelrush.net/ (UI), /v3/swagger.json Production https://crs.channelrush.net not served — generate clients from the test document All paths are /api/v3/.... (/api/v2/... still answers; v3 adds Params on a reserved room and is the version to build against.) JSON property names are camelCase as published in the Swagger document. Live documentation The test environment publishes the API's reference documentation: - Swagger UI: testcrs.channelrush.net/index.html (it opens on V2; pick V3 in the selector at the top right) - OpenAPI document: testcrs.channelrush.net/v3/swagger.json - ReDoc: testcrs.channelrush.net/api-docs/index.html All message transmission, sending or receiving, is over an encrypted TLS (HTTPS) connection. Authentication ChannelRUSH issues one bearer token per channel. Send it on every request: Authorization: Bearer <token> - One token covers every property mapped to your channel. It does not identify a property or a guest. - It does not expire; ChannelRUSH revokes it by changing the channel's credentials. Treat it like a password: server-side only, never in a browser or an app bundle, never in source control. - First call to make: GET /api/v3/connectioncheck. It succeeds as soon as the token is accepted. - PropertyId in every request is the hotel id ChannelRUSH gave you for that property on your channel. Success is in the body, not the status HTTP Meaning Body 200 The request was understood. Check successful . the response, with successful and messages[] 400 The request is malformed or fails validation ValidationProblemDetails with errors per field 401 Token missing or rejected { errorCode, errorMessage } 500 Server error { errorCode, errorMessage } Business outcomes — no availability, reservation not found — are 200 with successful: false. Each message has messageType (Info, Warning, Error), a code and English message text. A successful response can carry a Warning. code Meaning -1 The property is not set up or enabled for your channel 0 Unspecified error 3 Availability or price changed; what you asked for cannot be sold as sent 4 Reservation not found 5 Reservation is already cancelled 6 A reservation with that id already exists Enumerations (status, creditCardType, add-on type and rateType, …) travel as numbers; messageType is the exception and travels as text. The published document lists the numeric values only, so name them in your client (the example's enum-names.json has every name). The booking sequence propertysearch ─┐ ├─► bookingsearch ─► bookcheck ─► book settings ───────┘ ▲ │ └── on every cart change 1. POST propertysearch — availability across your channel for dates and occupancy; each result has the shape of a bookingsearch response. Without dates it lists properties. Only properties that have content mapped to your channel in the requested language are returned. A property without it can still be searched and booked by id. 2. GET settings/{propertyId}/{language} — room types, rate plans, add-ons, fees, taxes, booking policies and content. settings.content is null, not an error, when the property has no content in that language; settings.contentLanguages lists the languages it does have. 3. POST bookingsearch — what one property can sell for the stay: each room type with every rate plan, nightly rates (with ratePrePromo when a promotion applies) and add-ons. Treat a rate plan's totalAfterTax as an estimate for comparing options: the amount the guest pays is the one bookcheck returns, which can be higher (for example when tax also applies to fees). 4. POST bookcheck — send the reservation you intend to book. It comes back with one rate row per night at the live price, the fee and tax lines, and totalBeforeTax / totalAfterTax filled in. It books nothing. Call it whenever the cart changes and once more just before booking. - Naming the rate plan is enough: one rates row with the ratePlanId is replaced by a row per night. - A room or rate plan that cannot be sold returns successful: false, code 3, and reservation: null. 5. POST book — send the reservation exactly as bookcheck returned it, plus guest and card details. Totals you calculate yourself are compared with the server's and a mismatch is refused; the refusal message says which total differed. The response has the reservationId to show the guest and a reservationTransactionId that changes with every new/modified/cancelled transaction. A reservation needs at least one room, at least one person profile, personProfileIdBookedBy pointing at one of them, currencyCode, and status. Keep the currency the search used for the life of the reservation. Stay dates are dates (yyyy-MM-dd), not moments: send them without a time or offset. Modify and cancel - Modify — there is no modify endpoint. Post the whole reservation to book again with status: 1 (Modified) and the same reservationId. It replaces the reservation; it is not a patch. You do not resend the card: the API keeps the one it holds. The API does not return what was previously charged, so keep the old totalAfterTax if you show "amount due for this change". - Cancel — GET cancel/{propertyId}/{reservationId}, or book with status: 2 (Canceled). Cancelling twice is safe: successful: true with warning 5. Retrieving reservations POST reservations does two jobs: - One reservation — send reservationId (with or without propertyId; without, it is looked up across your channel). An id that does not exist is successful: true with an empty list. - A feed — send no reservationId, optionally propertyId and status[]. The window is fixed by the API: departures from 28 days ago onward for the whole channel, or from yesterday onward once a propertyId is sent. There is no paging and no "changed since" filter; timestamp on each reservation is its last change. ARI POST ari returns allocation, sell rate, taxes and restrictions (min/max nights, closed to arrival/departure) per room type, rate plan and day, for an inclusive date range with day-of-week switches. Days with nothing loaded come back blank rather than missing. Use it to fill your own availability cache or calendar; use bookingsearch and bookcheck when a guest is buying, because ARI carries no add-ons, fees or totals. Cards and payment - A reservation carries either card fields (creditCardNumber, creditCardExpirationMonth/Year, creditCardSecurityCode, holder name, postal code, creditCardType) or a token you already hold (creditCardTransactionToken). - The API does not charge the card. It passes the guarantee to the property. - If card numbers pass through your servers you are in PCI DSS scope. Do not store the number or the security code, do not log request bodies, and do not send them back to a browser. - Test card: 378282246310005, any future expiration, any 4 digit security code. The reservation is accepted and its note is prefixed with a "TEST RESERVATION, NOT REAL" warning for the property. - Whether a card is required, how much is due at booking and what is refundable come from the rate plan's booking policy in settings (creditCardRequired, amountDuePercentage, amountRefundablePercentage, cancellationAllowed, cancellationCutOffHours), and from its newer fields: Field Meaning depositRules { moreThanNights, moreThanDaysOut, amountDuePercentage } , first match wins: a stay of more than moreThanNights nights booked more than moreThanDaysOut days before arrival pays amountDuePercentage at booking instead of the policy's own. The rest is paid at the property. Empty: amountDuePercentage for every stay. cancellationFees The cancellation fee schedule, earliest first: { daysBeforeArrival, atTime, feePercent } . From atTime (property-local, HH:mm ) on the day daysBeforeArrival days before arrival ( 0 : the arrival day; null : from booking, i.e. non-refundable), a cancellation costs feePercent of the room price (the room's rates, no add-ons, no taxes or fees added on top). Free before the first fee. countsEveryNight The property's dates set to this policy apply to every stay that includes that night (a trade fair reaching the stays that run into it), not only to stays arriving on it; the strictest such policy applies. A policy with cancellationFees is described by them. For clients that read only the older fields, those carry a conservative summary: amountRefundablePercentage 100 (free before the cutoff), cancellationAllowed false when the fee applies from booking, and cancellationCutOffHours in whole days before the first fee — never a later free deadline than the real one. Example: free until 18:00 on the arrival day, then 90 %, reads as cancellationFees: [{ daysBeforeArrival: 0, atTime: "18:00", feePercent: 90 }] with cancellationCutOffHours: 0. The policy a stay is actually sold on (the rate plan's, or the property's calendar for those dates) is the one bookingsearch names in bookingPolicyId. Your responsibilities as the point of sale - Guests are yours to tell apart. The token can read and cancel every reservation on your channel. Never act on a reservation id taken from a URL or form alone; require something only the booker knows (the example asks for the last name and postal code) and rate limit the lookup. - Show the API's numbers. Display what bookcheck returned rather than recomputing prices. - Expect change between search and book. Handle code 3 by telling the guest and re-searching. Generating a client The published v3 document needs three corrections before a generator produces a usable client; the example's Generated/patch_swagger.py applies them: 1. enum member names (published as bare integers, so generators emit _0, _1, …), 2. decimal amounts (every number is published as double), 3. BookCheckResponse.reservation is published as required but is null when bookcheck refuses a reservation — an unpatched client throws on exactly that answer. With those corrections, any OpenAPI generator works. The example's client is generated with NSwag; Swagger Codegen (hosted at generator3.swagger.io) generates clients for most other languages.
API DocumentationChannel Manager API - XML Spec
Introduction This interface is designed to be used by a PMS, CRS, or a booking engine (or any other source for a hotel’s rate, availability, and restriction information) to incorporate channel management features by connecting to ChannelRUSH’s distribution services. This interface allows you to... - Retrieve property settings, including room types, rate plans, and a list of channels set up for the property. - Send rates, availability, and restrictions for a property for distribution to a set of channels a property is directly set up with. - Retrieve reservations created by those channels by either a ‘pickup’ method, where you poll our system every 5 minutes to check for new reservations, or we can push the reservations to you in real-time if you have a URL for us to connect to. This interface works as an access point to an already existing, fully functional, and completely set-up ChannelRUSH account. This does not mean the end user will ever need to actually login to the ChannelRUSH web application (https://www.channelrush.net) – although they can if you want to distribute that login information to them so they can take advantage of existing ChannelRUSH features and manage their channels in the case of a communication outage. This interface processes the information in real-time, there is no batch or interval processing done at certain times. This is said in the context that specific data is processed sequentially, which means if a property issues 10 updates for a channel (multiple requests for a single property and a single channel), updates 2-9 cannot being processing until update 1 is completed. If the user issued 1 update for 10 channels for a single hotel, they could all begin processing simultaneously because each channel operates independently of the others. The interface primarily uses standard OpenTravel Alliance (OTA) messages -http://www.opentravel.org This interface was developed using the 2007B message set. If you require or are already using a different version, please notify us as we can accommodate many different versions. SOAP Envelope All messages sent to our servers will use a SOAP Envelope (http://schemas.xmlsoap.org/soap/envelope/), using a HTNG v1.1 header, and the messageS stored in the envelope body. The envelope body node can contain multiple/different messages for the same property. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> [MESSAGE 1 HERE] [MESSAGE 2 HERE] [MESSAGE 3 HERE] </soap:Body> </soap:Envelope> SOAP Envelope - Authentication Header The SOAP Header uses the HTNG Version 1.1 format. The following fields need to be set for the system to successfully authenticate you and process your messages. HTNGHeader.From.Credential.SystemId This is the system ID that identifies your company. This can be provided by you and stored on our side, or provided by us to be stored on your side. HTNGHeader.From.Credential.Username This is the username provided by us for your group login. There are not separate usernames and passwords for each property, only one login which allows you to send messages for which you company is mapped for. HTNGHeader.From.Credential.Password This is the password provided by us for your group login. HTNGHeader.To.SystemId This is the ID of the property you are sending the messages for. Each envelope can contain multiple/different messages for only one property. This can be provided by you and stored on our side, or provided by us to be stored on your side. Settings Receive URL: https://[SERVERNAME]/channels/v2/settings?providerId=[PROVIDERID] The settings call brings back basic information regarding the property, such as mapped room types, rate plans, and channels. Example request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[USERNAME]</userName> <password>[PASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body/> </soap:Envelope> Successful response: This is a custom XML list of the room types, rate plans, and channels set up for the property. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <MessageAcknowledgementType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" "xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </MessageAcknowledgementType> <Hotel ID="[HOTELID]" Name="Test Hotel"> <RoomTypes> <RoomType ID="7718" Name="Single"/> <RoomType ID="7719" Name="Double"/> <RoomType ID="7720" Name="Triple"/> </RoomTypes> <RatePlans> <RatePlan ID="190" Name="RACK"/> <RatePlan ID="191" Name="NRF"/> </RatePlans> <Channels> <Channel ID="411" Name="ChannelRUSH - Test OTA"/> </Channels> </Hotel> </soap:Body> </soap:Envelope> Unsuccessful response: <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <MessageAcknowledgementType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Errors> <Error Code="11">Your company is not setup to deliver information to the hotel you specified at htngHeader.To[0].systemId=[HOTELID]</Error> </Errors> </MessageAcknowledgementType> </soap:Body> </soap:Envelope> Hotel A custom XML message that contains information about the property's setup. Hotel.ID The mapped ID of the property. String. Hotel.Name The name of the property. String. Hotel.RoomTypes A collection (0 to n) of RoomType objects. Hotel.RoomTypes.RoomType.ID The mapped ID of the room type. String. Hotel.RoomType.RoomType.Name The name of the room type. String. Hotel.RatePlans A collection (0 to n) of RatePlan objects. Hotel.RatePlans.RatePlan.ID The mapped ID of the rate plan. String. Hotel.RatePlans.RatePlan.Name The name of the rate plan. String. Hotel.Channels A collection (0 to n) of Channel objects. Hotel.Channels.Channel.ID The ID of the channel. Integer. Hotel.Channels.Channel.Name The name of the channel. String. Inventory URL: https://[SERVERNAME]/channels/v2/ariupdate?providerId=[PROVIDERID] This method allows for updating rate, availability, and restrictions using 3 separate messages. OTA_HotelRateAmountNotifRQ - Sell Rate OTA_HotelInvCountNotifRQ - Allocation OTA_HotelBookingRuleNotifRQ - Cut Off Days - Minimum Length of Stay - Maximum Length of Stay - Closed To Arrival - Closed To Departure - Stop Sell Rates - OTA_HotelRateAmountNotifRQ Updating rates. This is the message request you will send to us to update rates for room types or rate plans (depending on which level you want to support - room type or rate plan level - we support updating on both). <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> <OTA_HotelRateAmountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2007B/OTA_HotelRateAmountNotifRQ.xsd"> <RateAmountMessages> <RateAmountMessage> <StatusApplicationControl InvTypeCode="3429" RatePlanID="BAR"/> <Rates> <Rate Start="2014-06-29" End="2014-06-29" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"> <BaseByGuestAmts> <BaseByGuestAmt AmountAfterTax="44.00"/> </BaseByGuestAmts> </Rate> <Rate Start="2014-06-29" End="2014-06-29" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"> <BaseByGuestAmts> <BaseByGuestAmt AmountAfterTax="44.00"/> </BaseByGuestAmts> </Rate> </Rates> </RateAmountMessage> <RateAmountMessage> <StatusApplicationControl InvTypeCode="3428" RatePlanID="BAR"/> <Rates> <Rate Start="2014-06-29" End="2014-06-29" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"> <BaseByGuestAmts> <BaseByGuestAmt AmountAfterTax="41.00"/> </BaseByGuestAmts> </Rate> </Rates> </RateAmountMessage> <RateAmountMessage> <StatusApplicationControl InvTypeCode="4070" RatePlanID="BAR"/> <Rates> <Rate Start="2014-06-29" End="2014-06-29" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"> <BaseByGuestAmts> <BaseByGuestAmt AmountAfterTax="49.00"/> </BaseByGuestAmts> </Rate> </Rates> </RateAmountMessage> </RateAmountMessages> </OTA_HotelRateAmountNotifRQ> </soap:Body> </soap:Envelope> RateAmountMessages A collection (1 to n) of RateAmountMessage messages. RateAmountMessages.RateAmountMessage.StatusApplicationControl.InvTypeCode This is the room type code. This can be provided by you and stored on our side, or provided by us to be stored on your side. String. RateAmountMessages.RateAmountMessage.StatusApplicationControl.RatePlanID This is the rate plan code. This can be provided by you and stored on our side, or provided by us to be stored on your side. String. Optional. RateAmountMessages.RateAmountMessage.Rates A collection (1 to n) of Rate messages. RateAmountMessages.RateAmountMessage.Rates.Rate.Start The start date of the date range to be updated. Date. RateAmountMessages.RateAmountMessage.Rates.Rate.End The end date of the date range to be updated. Date. Inclusive. RateAmountMessages.RateAmountMessage.Rates.Rate.Mon RateAmountMessages.RateAmountMessage.Rates.Rate.Tue RateAmountMessages.RateAmountMessage.Rates.Rate.Wed RateAmountMessages.RateAmountMessage.Rates.Rate.Thur RateAmountMessages.RateAmountMessage.Rates.Rate.Fri RateAmountMessages.RateAmountMessage.Rates.Rate.Sat RateAmountMessages.RateAmountMessage.Rates.Rate.Sun These mark which days of the week in the date range to be updated. Boolean. RateAmountMessages.RateAmountMessage.Rates.Rate.BaseByGuestAmts A collection (1 to n) of BaseByGuestAmt messages. RateAmountMessages.RateAmountMessage.Rates.Rate.BaseByGuestAmts.BaseByGuestAmt.AmountAfterTax The sell rate including tax. Decimal. Optional/Conditional - AmountAfterTax or AmountBeforeTax must be listed. RateAmountMessages.RateAmountMessage.Rates.Rate.BaseByGuestAmts.BaseByGuestAmt.AmountBeforeTax The sell rate not including tax. Decimal. Optional/Conditional - AmountAfterTax or AmountBeforeTax must be listed. Response Message - OTA_HotelRateAmountNotifRS This is the successful response message to the OTA_HotelRateAmountNotifRQ request. The first message always returned is MessageAcknowledgementType, pertains to your successful login. If you have any general errors or login errors, they would be in this MessageAcknowledgementType message. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <MessageAcknowledgementType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </MessageAcknowledgementType> <OTA_HotelRateAmountNotifRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </OTA_HotelRateAmountNotifRS> </soap:Body> </soap:Envelope> This is an response message with warnings and errors to the OTA_HotelRateAmountNotifRQ request. Again, notice the first message always returned is MessageAcknowledgementType, which lists <Success /> as your login was successful. The warnings or errors per message are contained in each message's Warnings and/or Errors collections. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <MessageAcknowledgementType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </MessageAcknowledgementType> <OTA_HotelRateAmountNotifRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Warnings> <Warning Code="##">Warning Message 1</Warning> <Warning Code="##">Warning Message 2</Warning> <Warning Code="##">Warning Message 3</Warning> </Warnings> <Errors> <Error Code="##">Error Message 1</Error> <Error Code="##">Error Message 2</Error> <Error Code="##">Error Message 3</Error> </Errors> </OTA_HotelRateAmountNotifRS> </soap:Body> </soap:Envelope> Allocation - OTA_HotelInvCountNotifRQ This is the message request you will send to update allocation for room types (only updating allocation at the room type level is supported, not rate plan level, you can mark a rate plan open or closed using stop sell true/false found in the OTA_HotelBookingRuleNotifRQ message). While unnecessary, this example shows two OTA_HotelInvCountNotifRQ messages in the soap envelope body node and both would be processed. It is unnecessary as the second inventory update could just be added to Inventories collection of the first message. Normally you would see different messages in the soap envelope body node. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> <OTA_HotelInvCountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2007B/OTA_HotelInvCountNotifRQ.xsd"> <Inventories> <Inventory> <StatusApplicationControl Start="2013-06-30" End="2013-06-30" InvTypeCode="3407" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <InvCounts> <InvCount ActionType="Allocation" Count="12"/> </InvCounts> </Inventory> <Inventory> <StatusApplicationControl Start="2013-06-30" End="2013-06-30" InvTypeCode="3408" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <InvCounts> <InvCount ActionType="Allocation" Count="21"/> </InvCounts> </Inventory> <Inventory> <StatusApplicationControl Start="2013-07-01" End="2013-07-01" InvTypeCode="3408" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <InvCounts> <InvCount ActionType="Allocation" Count="32"/> </InvCounts> </Inventory> </Inventories> </OTA_HotelInvCountNotifRQ> <OTA_HotelInvCountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2007B/OTA_HotelInvCountNotifRQ.xsd"> <Inventories> <Inventory> <StatusApplicationControl Start="2013-08-30" End="2013-08-30" InvTypeCode="3407" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <InvCounts> <InvCount ActionType="Allocation" Count="12"/> </InvCounts> </Inventory> </Inventories> </OTA_HotelInvCountNotifRQ> </soap:Body> </soap:Envelope> Inventories A collection (1 to n) of Inventory messages. Inventories.Inventory.StatusApplicationControl.InvTypeCode This is the room type code. This can be provided by you and stored on our side, or provided by us to be stored on your side. String. Inventories.Inventory.StatusApplicationControl.Start The start date of the date range to be updated. Date. Inventories.Inventory.StatusApplicationControl.End The end date of the date range to be updated. Date. Inclusive. Inventories.Inventory.StatusApplicationControl.Mon Inventories.Inventory.StatusApplicationControl.Tue Inventories.Inventory.StatusApplicationControl.Wed Inventories.Inventory.StatusApplicationControl.Thur Inventories.Inventory.StatusApplicationControl.Fri Inventories.Inventory.StatusApplicationControl.Sat Inventories.Inventory.StatusApplicationControl.Sun These mark which days of the week in the date range to be updated. Boolean. Inventories.Inventory.InvCounts A collection (1 to n) of InvCount messages. Inventories.Inventory.InvCounts.InvCount.ActionType Only "Allocation" is supported at the moment, which represents the number of rooms available to be sold (not an offset, not plus/minus). String. Inventories.Inventory.InvCounts.InvCount.Count The number of rooms available to be sold for the specified room type. Integer. Response Message - OTA_HotelInvCountNotifRS This is the successful response message to the OTA_HotelInvCountNotifRQ request. The first message always returned is MessageAcknowledgementType, which pertains to your successful login. If you have any general errors or login errors, they would be in this MessageAcknowledgementType message. Since we sent two messages in the request, two separate OTA_HotelInvCountNotifRS messages are in the reply. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <MessageAcknowledgementType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </MessageAcknowledgementType> <OTA_HotelInvCountNotifRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </OTA_HotelInvCountNotifRS> <OTA_HotelInvCountNotifRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </OTA_HotelInvCountNotifRS> </soap:Body> </soap:Envelope> This is a response message with a success message for the first request and only errors for the second OTA_HotelInvCountNotifRQ request. Again, the first message always returned is MessageAcknowledgementType, which lists <Success /> as your login was successful. The warnings or errors per message are contained in each message's Warnings and/or Errors collections. Since we sent two messages in the request, two separate OTA_HotelInvCountNotifRS messages are in the reply. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <MessageAcknowledgementType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </MessageAcknowledgementType> <OTA_HotelInvCountNotifRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </OTA_HotelInvCountNotifRS> <OTA_HotelInvCountNotifRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Errors> <Error Code="##">Error Message 1</Error> <Error Code="##">Error Message 2</Error> <Error Code="##">Error Message 3</Error> </Errors> </OTA_HotelInvCountNotifRS> </soap:Body> </soap:Envelope> Restrictions - OTA_HotelBookingRuleNotifRQ This is the message request you will send to update cutoff days, min length of stay, max length of stay, closed to arrival, closed to departure, and/or stop sell. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> <OTA_HotelBookingRuleNotifRQ xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.opentravel.org/OTA/2003/05"> <RuleMessages> <RuleMessage> <StatusApplicationControl Start="2014-09-24" End="2014-09-26" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true" RatePlanID="BAR" InvTypeCode="7170"/> <BookingRules> <BookingRule AbsoluteCutoff="2"> <LengthsOfStay> <LengthOfStay Time="1" TimeUnit="Day" MinMaxMessageType="MinLOS"/> <LengthOfStay Time="10" TimeUnit="Day" MinMaxMessageType="MaxLOS"/> </LengthsOfStay> <DOW_Restrictions> <AvailableDaysOfWeek Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <ArrivalDaysOfWeek Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <DepartureDaysOfWeek Mon="true" Tue="true" Weds="true" Thur="true" Fri="true" Sat="true" Sun="true"/> </DOW_Restrictions> </BookingRule> </BookingRules> </RuleMessage> </RuleMessages> </OTA_HotelBookingRuleNotifRQ> </soap:Body> </soap:Envelope> RuleMessages A collection (1 to n) of RuleMessage messages. RuleMessages.StatusApplicationControl.InvTypeCode This is the room type code. This can be provided by you and stored on our side, or provided by us to be stored on your side. String. RuleMessages.StatusApplicationControl.RatePlanID This is the rate plan code. This can be provided by you and stored on our side, or provided by us to be stored on your side. String. Optional. RuleMessages.StatusApplicationControl.Start The start date of the date range to be updated. Date. RuleMessages.StatusApplicationControl.End The end date of the date range to be updated. Date. Inclusive. RuleMessages.RuleMessage.StatusApplicationControl.Mon RuleMessages.RuleMessage.StatusApplicationControl.Tue RuleMessages.RuleMessage.StatusApplicationControl.Wed RuleMessages.RuleMessage.StatusApplicationControl.Thur RuleMessages.RuleMessage.StatusApplicationControl.Fri RuleMessages.RuleMessage.StatusApplicationControl.Sat RuleMessages.RuleMessage.StatusApplicationControl.Sun These mark which days of the week in the date range to be updated. Boolean. RuleMessages.RuleMessage.BookingRules A collection (1 to n) of BookingRule messages. RuleMessages.RuleMessage.BookingRules.BookingRule.AbsoluteCutoff The number of days before the arrival date, the room is no longer available for sale. Integer. Optional. RuleMessages.RuleMessage.BookingRules.BookingRule.LengthsOfStay A collection (0 to n) of LengthOfStay messages. Optional. RuleMessages.RuleMessage.BookingRules.BookingRule.LengthsOfStay.ArrivalDateBased If true, the MinMaxMessageType is arrival date based, vs false for 'through' based - i.e. True for Min Nights (Arrival), vs False for Min Nights Through. True for Max Nights (Arrival) vs False for Max Nights Through. Optional. Boolean. Default value is True if not specified. RuleMessages.RuleMessage.BookingRules.BookingRule.LengthsOfStay.LengthOfStay.TimeUnit The only time unit currently supported is "Day". RuleMessages.RuleMessage.BookingRules.BookingRule.LengthsOfStay.LengthOfStay.Time The number of days for the minimum or maximum length of stay. Integer. RuleMessages.RuleMessage.BookingRules.BookingRule.LengthsOfStay.LengthOfStay.MinMaxMessageType "MinLOS" = Minimum Length Of Stay, or "MaxLOS" = Maximum Length Of Stay RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions A collection (0 to 3) of either one AvailableDaysOfWeek, ArrivalDaysOfWeek, or DepartureDaysOfWeek messages. Optional. RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.AvailableDaysOfWeek.Mon RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.AvailableDaysOfWeek.Tue RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.AvailableDaysOfWeek.Wed RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.AvailableDaysOfWeek.Thur RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.AvailableDaysOfWeek.Fri RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.AvailableDaysOfWeek.Sat RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.AvailableDaysOfWeek.Sun Controls stop sell. If "true" the day of the week is open, or available for sale. If "false" the day of the week is closed, or not available for sale. RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.ArrivalDaysOfWeek.Mon RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.ArrivalDaysOfWeek.Tue RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.ArrivalDaysOfWeek.Wed RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.ArrivalDaysOfWeek.Thur RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.ArrivalDaysOfWeek.Fri RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.ArrivalDaysOfWeek.Sat RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.ArrivalDaysOfWeek.Sun Controls closed to arrival. If "true" the day of the week is available for the customer to begin their stay. If "false" the day of the week is not available for arrival. RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.DepartureDaysOfWeek.Mon RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.DepartureDaysOfWeek.Tue RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.DepartureDaysOfWeek.Wed RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.DepartureDaysOfWeek.Thur RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.DepartureDaysOfWeek.Fri RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.DepartureDaysOfWeek.Sat RuleMessages.RuleMessage.BookingRules.BookingRule.DOW_Restrictions.DepartureDaysOfWeek.Sun Controls closed to departure. If "true" the day of the week is available for the customer to depart on to end their stay. If "false" the day of the week is not available for departure, or for a trip to end on. Response Message - OTA_HotelBookingRuleNotifRS This is the successful response message to the OTA_HotelBookingRuleNotifRQ request. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <MessageAcknowledgementType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </MessageAcknowledgementType> <OTA_HotelBookingRuleNotifRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </OTA_HotelBookingRuleNotifRS> </soap:Body> </soap:Envelope> This is a response that shows successful, but has warning messages with it. A message with a <Success /> node means some information was processed and is considered a successful message. The warnings are just that - notifications to you that possibly a specific room type you are sending to is not set up for a specific channel (although all other channels were processed, hence the <Success /> message). <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <MessageAcknowledgementType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> </MessageAcknowledgementType> <OTA_HotelBookingRuleNotifRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <Warnings> <Warning Code="19">statusApplicationControlType.RatePlanID=BARRO for channelId=92 is not setupin ChannelRUSH to deliver data to.</Warning> </Warnings> </OTA_HotelBookingRuleNotifRS> </soap:Body> </soap:Envelope> Updating Specific Channels Only Each channel set up for the property has a standard numeric ID. For example, Expedia.com set up for Property A would have ID 123, and Expedia.com set up for Property B would have the same channel ID of 123. You can set the UniqueID node to a specific Channel ID on each message, which means the message will only update that specific channel. If the UniqueID node is not set, all channels will be updated. Example: Notice the <UniqueID ID="123" /> right under the OTA_HotelInvCountNotifRQ. This can be set for all messages - OTA_HotelInvCountNotifRQ, OTA_HotelBookingRuleNotifRQ, OTA_HotelRateAmountNotifRQ. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> <OTA_HotelInvCountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2007B/OTA_HotelInvCountNotifRQ.xsd"> <UniqueID ID="123"/> <Inventories> <Inventory> <StatusApplicationControl Start="2013-06-30" End="2013-06-30" InvTypeCode="3407" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <InvCounts> <InvCount ActionType="Allocation" Count="12"/> </InvCounts> </Inventory> <Inventory> <StatusApplicationControl Start="2013-06-30" End="2013-06-30" InvTypeCode="3408" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <InvCounts> <InvCount ActionType="Allocation" Count="21"/> </InvCounts> </Inventory> <Inventory> <StatusApplicationControl Start="2013-07-01" End="2013-07-01" InvTypeCode="3408" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <InvCounts> <InvCount ActionType="Allocation" Count="32"/> </InvCounts> </Inventory> </Inventories> </OTA_HotelInvCountNotifRQ> <OTA_HotelInvCountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2007B/OTA_HotelInvCountNotifRQ.xsd"> <Inventories> <Inventory> <StatusApplicationControl Start="2013-08-30" End="2013-08-30" InvTypeCode="3407" Mon="true" Tue="true" Wed="true" Thur="true" Fri="true" Sat="true" Sun="true"/> <InvCounts> <InvCount ActionType="Allocation" Count="12"/> </InvCounts> </Inventory> </Inventories> </OTA_HotelInvCountNotifRQ> </soap:Body> </soap:Envelope> Reservations There are two ways to receive reservations - Reservation Pickup & Confirm or Direct Reservation Delivery. Reservation Pickup & Confirm You can poll our system every few minutes to check for pending reservations. If there are reservations, you would receive the information and then "confirm" the reservations in a separate confirmation message. Once the reservations are confirmed, the next time you poll or check for reservations those reservations would not appear. URL: https://[SERVERNAME]/channels/v2/reservationreceive?providerId=[PROVIDERID] Direct Reservation Delivery You can provide us a URL hosted on your system where we can post the reservations as they arrive. This method is preferred as there is no continuous polling and reservations are transmitted as soon as they are received. Regardless of the two options, the reservation information and response is in the same message/xml format. New Reservations - OTA_HotelResNotifRQ New reservations will have <HotelReservation ResStatus="0">. This is an example of an OTA_HotelResNotifRQ message that you would either 'pick up' or send directly to your system's URL. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <OTA_HotelResNotifRQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <HotelReservations> <HotelReservation ResStatus="0"> <RoomStays> <RoomStay IndexNumber="0"> <RoomTypes> <RoomType RoomTypeCode="RT1"> <RoomDescription Name="Room Type 1"/> <AdditionalDetails> <AdditionalDetail> <DetailDescription> <Text>Room Type 1 Description</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> <Amenities> <Amenity RoomAmenity="Room Type 1 Amenity 1"/> </Amenities> </RoomType> </RoomTypes> <RatePlans> <RatePlan> <Commission> <CommissionPayableAmount Amount="135.00"/> </Commission> </RatePlan> </RatePlans> <RoomRates> <RoomRate EffectiveDate="2017-10-23"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-24"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-25"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-26"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-27"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-28"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> </RoomRates> <GuestCounts> <GuestCount Count="2"/> </GuestCounts> <Total AmountBeforeTax="900.00"/> <ResGuestRPHs> <ResGuestRPH RPH="0"/> </ResGuestRPHs> <SpecialRequests> <SpecialRequest> <Text>Room Type 1 Note 1</Text> </SpecialRequest> <SpecialRequest> <Text>Room Type 1 Note 2</Text> </SpecialRequest> </SpecialRequests> <ServiceRPHs> <ServiceRPH RPH="48013"/> </ServiceRPHs> </RoomStay> <RoomStay IndexNumber="1"> <RoomTypes> <RoomType RoomTypeCode="RT2"> <RoomDescription Name="Room Type 2"/> <AdditionalDetails> <AdditionalDetail> <DetailDescription> <Text>Room Type 2 Description</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> <Amenities> <Amenity RoomAmenity="Room Type 2 Amenity 1"/> <Amenity RoomAmenity="Room Type 2 Amenity 2"/> </Amenities> </RoomType> </RoomTypes> <RatePlans> <RatePlan> <Commission> <CommissionPayableAmount Amount="189.00"/> </Commission> </RatePlan> </RatePlans> <RoomRates> <RoomRate EffectiveDate="2017-10-23"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-24"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-25"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-26"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-27"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-28"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> </RoomRates> <GuestCounts> <GuestCount Count="2"/> </GuestCounts> <Total AmountBeforeTax="1260.00"/> <ResGuestRPHs> <ResGuestRPH RPH="1"/> </ResGuestRPHs> <SpecialRequests> <SpecialRequest> <Text>Room Type 2 Note 1</Text> </SpecialRequest> </SpecialRequests> <ServiceRPHs> <ServiceRPH RPH="48168"/> <ServiceRPH RPH="48169"/> <ServiceRPH RPH="48185"/> <ServiceRPH RPH="48186"/> </ServiceRPHs> </RoomStay> <RoomStay IndexNumber="2"> <RoomTypes> <RoomType RoomTypeCode="RT3"> <RoomDescription Name="Room Type 3"/> <AdditionalDetails> <AdditionalDetail> <DetailDescription> <Text>Room Type 3 Description</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> <Amenities> <Amenity RoomAmenity="Room Type 3 Amenity 1"/> </Amenities> </RoomType> </RoomTypes> <RatePlans> <RatePlan> <Commission> <CommissionPayableAmount Amount="243.00"/> </Commission> </RatePlan> </RatePlans> <RoomRates> <RoomRate EffectiveDate="2017-10-23"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-24"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-25"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-26"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-27"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-28"> <Rates> <Rate> <Total RateTypeCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> </RoomRates> <GuestCounts> <GuestCount Count="4"/> </GuestCounts> <Total AmountBeforeTax="1620.00"/> <ResGuestRPHs> <ResGuestRPH RPH="2"/> </ResGuestRPHs> <SpecialRequests> <SpecialRequest> <Text>Room Type 3 Note 1</Text> </SpecialRequest> <SpecialRequest> <Text>Room Type 3 Note 2</Text> </SpecialRequest> <SpecialRequest> <Text>Room Type 3 Note 3</Text> </SpecialRequest> </SpecialRequests> <ServiceRPHs> <ServiceRPH RPH="48187"/> <ServiceRPH RPH="48188"/> <ServiceRPH RPH="48189"/> <ServiceRPH RPH="48190"/> </ServiceRPHs> </RoomStay> </RoomStays> <Services> <Service ServiceRPH="48013"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Arrival Happy Hour</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48168"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 2 Addon #1</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48169"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 2 Addon #2</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48185"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 2 Addon #1</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48186"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 2 Addon #2</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48187"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 3 Addon #1</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48188"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 3 Addon #2</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48189"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 3 Addon #3</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48190"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 3 Addon #4</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> </Services> <ResGuests> <ResGuest ResGuestRPH="0"> <Profiles> <ProfileInfo> <Profile> <Customer> <PersonName> <GivenName>Karys</GivenName> <Surname>Brown</Surname> </PersonName> <Telephone PhoneNumber="079 5588 6392"/> <Email>KarysBrown@gustr.com</Email> <Address> <AddressLine>Address Line 1</AddressLine> <AddressLine>Address Line 2</AddressLine> <AddressLine>Address Line 3</AddressLine> <AddressLine>Address Line 4</AddressLine> <CityName>NETHERTON</CityName> <PostalCode>NE65 9EB</PostalCode> <StateProv>GB</StateProv> </Address> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGuest> <ResGuest ResGuestRPH="1"> <Profiles> <ProfileInfo> <Profile> <Customer> <PersonName> <GivenName>Karys</GivenName> <Surname>Brown</Surname> </PersonName> <Telephone PhoneNumber="079 5588 6392"/> <Email>KarysBrown@gustr.com</Email> <Address> <AddressLine>Address Line 1</AddressLine> <AddressLine>Address Line 2</AddressLine> <AddressLine>Address Line 3</AddressLine> <AddressLine>Address Line 4</AddressLine> <CityName>NETHERTON</CityName> <PostalCode>NE65 9EB</PostalCode> <StateProv>GB</StateProv> </Address> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGuest> <ResGuest ResGuestRPH="2"> <Profiles> <ProfileInfo> <Profile> <Customer> <PersonName> <GivenName>Karys</GivenName> <Surname>Brown</Surname> </PersonName> <Telephone PhoneNumber="079 5588 6392"/> <Email>KarysBrown@gustr.com</Email> <Address> <AddressLine>Address Line 1</AddressLine> <AddressLine>Address Line 2</AddressLine> <AddressLine>Address Line 3</AddressLine> <AddressLine>Address Line 4</AddressLine> <CityName>NETHERTON</CityName> <PostalCode>NE65 9EB</PostalCode> <StateProv>GB</StateProv> </Address> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGuest> </ResGuests> <ResGlobalInfo> <Comments> <Comment> <Text>Reservation Note 1</Text> <Text>Guest requests a late checkout on departure day.</Text> </Comment> </Comments> <Guarantee> <GuaranteesAccepted> <GuaranteeAccepted> <PaymentCard CardCode="UseCreditCardDescrip" CardNumber="5277433010308656" SeriesCode="348" ExpireDate="1117"> <CardHolderName>Karys J Brown</CardHolderName> </PaymentCard> </GuaranteeAccepted> </GuaranteesAccepted> </Guarantee> <Total AmountBeforeTax="782.00" CurrencyCode="GBP"/> <HotelReservationIDs> <HotelReservationID ResID_Value="58741236" ResID_Source="PickupConfirmationId"/> <HotelReservationID ResID_Value="N48PK3O61S" ResID_Source="292@Expedia.com"/> </HotelReservationIDs> <Profiles/> </ResGlobalInfo> </HotelReservation> </HotelReservations> </OTA_HotelResNotifRQ> </soap:Body> </soap:Envelope> HotelReservations A collection (1 to n) of HotelReservation messages. HotelReservations.HotelReservation.HotelReservation.ResStatus 0 = New, 1 = Modified, 2 = Cancelled HotelReservations.HotelReservation.HotelReservation Has collections of RoomStays, Services, ResGuests, and ResGlobalInfo. HotelReservations.HotelReservation.RoomStays A collection (1 to n) of RoomStay messages. HotelReservations.HotelReservation.RoomStays.RoomStay Contains information of that room - a reservation can have multiple rooms or RoomStay messages. Contains a single node Total, and collections RoomTypes, RatePlans, RoomRates, and GuestCounts. HotelReservations.HotelReservation.RoomStays.RoomStay.IndexNumber The index of the order of the rooms (i.e. 0, 1, 2, 3). Integer. HotelReservations.HotelReservation.RoomStays.RoomStay.TimeSpan The arrival date, departure date, and the duration of this room's stay. HotelReservations.HotelReservation.RoomStays.RoomStay.TimeSpan.Start The arrival date of this room's stay. String. HotelReservations.HotelReservation.RoomStays.RoomStay.TimeSpan.End The departure date of room's stay. String. HotelReservations.HotelReservation.RoomStays.RoomStay.TimeSpan.Duration The duration of room's stay. P1D = 1 night stay, P3D = 3 night stay. String. HotelReservations.HotelReservation.RoomStays.RoomStay.Total.AmountBeforeTax The total amount for the room and charges affiliated for this room only. If the amount is before tax, this field is populated. Decimal. Optional/Conditional. HotelReservations.HotelReservation.RoomStays.RoomStay.Total.AmountAfterTax The total amount for the room and charges affiliated for this room only. If the amount is tax included, this field is populated. Decimal. Optional/Conditional. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomTypes A collection (1 to n) of RoomType messages. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomTypes.RoomType.RoomTypeCode The room type identifying code. String. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomTypes.RoomType.RoomDescription.Name The name of the room type. String. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomTypes.RoomType.AdditionalDetails A collection (1 to 1) of AdditionalDetail messages. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomTypes.RoomType.AdditionalDetail.DetailDescription.Text A description of the room type. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomTypes.RoomType.Amenities A collection (0 to n) of Amenity messages. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomTypes.RoomType.Amenities.Amenity.RoomAmenity Room amenity description. HotelReservations.HotelReservation.RoomStays.RoomStay.RatePlans A collection (0 to n) of RatePlan messages. HotelReservations.HotelReservation.RoomStays.RoomStay.RatePlans.RatePlan.Comission.CommissionPayableAmount.Amount The commission amount due to the channel for this reservation. Decimal. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomRates A collection (1 to n) of RoomRate messages. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomRates.RoomRate.EffectiveDate This rate is for the date during the stay of this reservation. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomRates.RoomRate.Rates A collection (1 to 1) of Rate messages. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomRates.RoomRate.Rates.Rate.Total.RateTypeCode This is the rate plan code for this rate amount. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomRates.RoomRate.Rates.Rate.Total.AmountBeforeTax The rate for this day before tax. If AmountBeforeTax is not set AmountAfterTax is. Decimal. Optional/Conditional. HotelReservations.HotelReservation.RoomStays.RoomStay.RoomRates.RoomRate.Rates.Rate.Total.AmountAfterTax The rate for this day including tax. If AmountBeforeTax is not set AmountAfterTax is. Decimal. Optional/Conditional. HotelReservations.HotelReservation.RoomStays.RoomStay.GuestCounts A collection (1 to n) of GuestCount messages. HotelReservations.HotelReservation.RoomStays.RoomStay.GuestCounts.GuestCount.Count The number of people staying in this room. Integer. HotelReservations.HotelReservation.RoomStays.RoomStay.ResGuestsRPHs A collection (1 to 1) of ResGuestRPH messages. HotelReservations.HotelReservation.RoomStays.RoomStay.ResGuestsRPHs.ResGuestRPHs.ResGuestRPH.RPH This is the ResGuestRPH value found on HotelReservations.HotelReservation.ResGuests.ResGuest node, which links that guest information to this room type. Integer. HotelReservations.HotelReservation.RoomStays.RoomStay.SpecialRequests A collection (0 to n) of SpecialRequest messages. HotelReservations.HotelReservation.RoomStays.RoomStay.SpecialRequests.SpecialRequest.Text The description of a special request by the guest. HotelReservations.HotelReservation.RoomStays.RoomStay.ServiceRPHs A collection (0 to n) of ServiceRPH messages. HotelReservations.HotelReservation.RoomStays.RoomStay.ServiceRPHs.ServiceRPH.RPH This is the ServiceRPH value found on HotelReservations.HotelReservation.Services.Service node. It links which extra services the guest has ordered for this room. HotelReservations.HotelReservation.Services A collection (0 to n) of Service messages. HotelReservations.HotelReservation.Services.ServiceDetails.GuestCounts A collection (1 to 1) of GuestCount messages. HotelReservations.HotelReservation.Services.ServiceDetails.GuestCounts.GuestCount.Count The number of guests signed up for this service. HotelReservations.HotelReservation.Services.ServiceDetails.Comments A collection (0 to n) of Comment messages. HotelReservations.HotelReservation.Services.ServiceDetails.Comments.Comment.Text The description of the service the guest bought. HotelReservations.HotelReservation.Services.ServiceDetails.Fees A collection (1 to 1) of Fee messages. HotelReservations.HotelReservation.Services.ServiceDetails.Fees.Fee.TaxInclusive True if the tax is included in the price. Boolean. HotelReservations.HotelReservation.Services.ServiceDetails.Fees.Fee.Amount The price of the service the guest ordered. Decimal. HotelReservations.HotelReservation.ResGuests A collection (0 to n) of ResGuest messages. HotelReservations.HotelReservation.ResGuests.ResGuest.ResGuestRPH The ID for this ResGuest message. Integer. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles A collection (1 to 1) of ProfileInfo messages. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.PersonName.GivenName Guest's first name. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.PersonName.Surname Guest's last name. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Telephone.PhoneNumber The phone number for the guest. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Email The email for the guest. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Address.AddressLine Up to 4 lines of text for the address for the guest. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Address.CityName The name of the city in the guest's address. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Address.PostalCode The postal code of the guest's address. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Address.StateProv The state or province of the guest's address. HotelReservations.HotelReservation.ResGlobalInfo.Comments A collection (0, 1) of Comment messages. HotelReservations.HotelReservation.ResGlobalInfo.Comments.Comment A collection (0 to n) of Text messages HotelReservations.HotelReservation.ResGlobalInfo.Comments.Comment.Text Comments from the guest or comments regarding the reservation from the channel. HotelReservations.HotelReservation.ResGlobalInfo.Guarantee.GuaranteesAccepted A collection (1 to 1) of GuaranteeAccepted messages. HotelReservations.HotelReservation.ResGlobalInfo.Guarantee.GuaranteeAccepted.PaymentCard Credit card information. HotelReservations.HotelReservation.ResGlobalInfo.Guarantee.GuaranteeAccepted.PaymentCard.CardCode The type of credit card - Master Card = MC, Visa = VI, Amex = AX, Discover = DS, DinersClub = DC, JCB International = "JCB" Misc = "Description Listed. String." HotelReservations.HotelReservation.ResGlobalInfo.Guarantee.GuaranteeAccepted.PaymentCard.CardNumber The credit card number. HotelReservations.HotelReservation.ResGlobalInfo.Guarantee.GuaranteeAccepted.PaymentCard.SeriesCode The credit card series code. HotelReservations.HotelReservation.ResGlobalInfo.Guarantee.GuaranteeAccepted.PaymentCard.ExpireDate The credit card expiration date. HotelReservations.HotelReservation.ResGlobalInfo.Guarantee.GuaranteeAccepted.PaymentCard.CardHolderName The name of the cardholder. HotelReservations.HotelReservation.ResGlobalInfo.Total.AmountBeforeTax The total price of the reservation, not including tax. If this reservation is a cancellation, the AmountBeforeTax will equal 0. Decimal. HotelReservations.HotelReservation.ResGlobalInfo.Total.AmountAfterTax The total price of the reservation, including tax. If this reservation is a cancellation, the AmountAfterTax will equal 0. Decimal. HotelReservations.HotelReservation.ResGlobalInfo.Total.CurrencyCode The three-letter currency of the reservation. All price amounts listed on the reservation are in this currency. String. HotelReservations.HotelReservation.ResGlobalInfo.HotelReservationIDs A collection (2 to 2) of HotelReservationID messages. HotelReservations.HotelReservation.ResGlobalInfo.HotelReservationIDs.HotelReservationID.ResID_Source The source of the ID. "PickupConfirmationId" is your confirmation number once you confirm the reservation has been received Otherwise it is a combined string with an "@" separator, the first ID is the numeric ID for the channel in our system, the second is a string that is the name of the channel. HotelReservations.HotelReservation.ResGlobalInfo.Profiles A collection (1 to 1) of ProfileInfo messages. HotelReservations.HotelReservation.ResGlobalInfo.Profiles.ProfileInfo.Profile.Customer.PersonName.GivenName The first name of the person who booked the reservation, not necessarily the same person as the card holder, or the guests in each room. HotelReservations.HotelReservation.ResGlobalInfo.Profiles.ProfileInfo.Profile.Customer.PersonName.Surname The last name of the person who booked the reservation, not necessarily the same person as the cardholder, or the guests in each room. HotelReservations.HotelReservation.ResGlobalInfo.Profiles.ProfileInfo.Profile.Customer.PersonName.Email The email address of the person who booked the reservation, not necessarily the same person as the cardholder or the guests in each room. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Address.AddressLine Up to 4 lines of text for the address. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Address.CityName The name of the city for the address. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Address.PostalCode The postal code of the address. HotelReservations.HotelReservation.ResGuests.ResGuest.Profiles.ProfileInfo.Profile.Customer.Address.StateProv The state or province of the address. Response Message - OTA_HotelResNotifRS Once you have received and stored the reservations, the following message will be sent in reply to confirm your processing. The body contains a <Success /> message, and both the OTA_HotelResNotifRS and the OTA_HotelResModifyNotifRS messages, even if one message or the other does not contain any IDs to confirm. OTA_HotelResNotifRS is for confirming new reservations, while OTA_HotelResModifyNotifRS is for confirming modifications or cancellations. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> <OTA_HotelResNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <HotelReservations> <HotelReservation> <ResGlobalInfo> <HotelReservationIDs> <HotelReservationID ResID_Value="66132"/> <HotelReservationID ResID_Value="66133"/> <HotelReservationID ResID_Value="66134"/> <HotelReservationID ResID_Value="66135"/> <HotelReservationID ResID_Value="66136"/> <HotelReservationID ResID_Value="66137"/> <HotelReservationID ResID_Value="66138"/> <HotelReservationID ResID_Value="66139"/> </HotelReservationIDs> </ResGlobalInfo> </HotelReservation> </HotelReservations> </OTA_HotelResNotifRS> <OTA_HotelResModifyNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <HotelResModifies> <HotelResModify> <ResGlobalInfo> <HotelReservationIDs/> </ResGlobalInfo> </HotelResModify> </HotelResModifies> </OTA_HotelResModifyNotifRS> </soap:Body> </soap:Envelope> If you wish to include a reservation ID from your system that identifies and links it to this reservation, you can set that value in the ResID_Source field. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> <OTA_HotelResNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <HotelReservations> <HotelReservation> <ResGlobalInfo> <HotelReservationIDs> <HotelReservationID ResID_Value="66132" ResID_Source="YourPmsId123"/> <HotelReservationID ResID_Value="66133" ResID_Source="YourPmsId124"/> <HotelReservationID ResID_Value="66134" ResID_Source="YourPmsId125"/> <HotelReservationID ResID_Value="66135" ResID_Source="YourPmsId126"/> <HotelReservationID ResID_Value="66136" ResID_Source="YourPmsId127"/> <HotelReservationID ResID_Value="66137" ResID_Source="YourPmsId128"/> <HotelReservationID ResID_Value="66138" ResID_Source="YourPmsId129"/> <HotelReservationID ResID_Value="66139" ResID_Source="YourPmsId130"/> </HotelReservationIDs> </ResGlobalInfo> </HotelReservation> </HotelReservations> </OTA_HotelResNotifRS> <OTA_HotelResModifyNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <HotelResModifies> <HotelResModify> <ResGlobalInfo> <HotelReservationIDs/> </ResGlobalInfo> </HotelResModify> </HotelResModifies> </OTA_HotelResModifyNotifRS> </soap:Body> </soap:Envelope> Modified or Cancelled Reservations - OTA_HotelResModifyNotifRQ This is an example OTA_HotelResModifyNotifRQ message used for modified or cancelled reservations. It is mainly identical to the OTA_HotelResNotifRQ message, with the document element and early collections being named differently. OTA_HotelResModifyNotifRQ.HotelResModifies.HotelResModify instead of OTA_HotelResNotifRQ.HotelReservations.HotelReservation. Reservations that are modified will have <HotelResModify ResStatus="1">. Reservations that are cancelled will have <HotelResModify ResStatus="2">. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <OTA_HotelResModifyNotifRQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <HotelResModifies> <HotelResModify ResStatus="1"> <RoomStays> <RoomStay IndexNumber="0"> <RoomTypes> <RoomType RoomTypeCode="RT1"> <RoomDescription Name="Room Type 1"/> <AdditionalDetails> <AdditionalDetail> <DetailDescription> <Text>Room Type 1 Description</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> <Amenities> <Amenity RoomAmenity="Room Type 1 Amenity 1"/> </Amenities> </RoomType> </RoomTypes> <RatePlans> <RatePlan> <Commission> <CommissionPayableAmount Amount="135.00"/> </Commission> </RatePlan> </RatePlans> <RoomRates> <RoomRate EffectiveDate="2017-10-23"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-24"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-25"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-26"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-27"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-28"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="150.00"/> </Rate> </Rates> </RoomRate> </RoomRates> <GuestCounts> <GuestCount Count="2"/> </GuestCounts> <Total AmountBeforeTax="900.00"/> <ResGuestRPHs> <ResGuestRPH RPH="0"/> </ResGuestRPHs> <SpecialRequests> <SpecialRequest> <Text>Room Type 1 Note 1</Text> </SpecialRequest> <SpecialRequest> <Text>Room Type 1 Note 2</Text> </SpecialRequest> </SpecialRequests> <ServiceRPHs> <ServiceRPH RPH="48013"/> </ServiceRPHs> </RoomStay> <RoomStay IndexNumber="1"> <RoomTypes> <RoomType RoomTypeCode="RT2"> <RoomDescription Name="Room Type 2"/> <AdditionalDetails> <AdditionalDetail> <DetailDescription> <Text>Room Type 2 Description</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> <Amenities> <Amenity RoomAmenity="Room Type 2 Amenity 1"/> <Amenity RoomAmenity="Room Type 2 Amenity 2"/> </Amenities> </RoomType> </RoomTypes> <RatePlans> <RatePlan> <Commission> <CommissionPayableAmount Amount="189.00"/> </Commission> </RatePlan> </RatePlans> <RoomRates> <RoomRate EffectiveDate="2017-10-23"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-24"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-25"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-26"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-27"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-28"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="210.00"/> </Rate> </Rates> </RoomRate> </RoomRates> <GuestCounts> <GuestCount Count="2"/> </GuestCounts> <Total AmountBeforeTax="1260.00"/> <ResGuestRPHs> <ResGuestRPH RPH="1"/> </ResGuestRPHs> <SpecialRequests> <SpecialRequest> <Text>Room Type 2 Note 1</Text> </SpecialRequest> </SpecialRequests> <ServiceRPHs> <ServiceRPH RPH="48168"/> <ServiceRPH RPH="48169"/> <ServiceRPH RPH="48185"/> <ServiceRPH RPH="48186"/> </ServiceRPHs> </RoomStay> <RoomStay IndexNumber="2"> <RoomTypes> <RoomType RoomTypeCode="RT3"> <RoomDescription Name="Room Type 3"/> <AdditionalDetails> <AdditionalDetail> <DetailDescription> <Text>Room Type 3 Description</Text> </DetailDescription> </AdditionalDetail> </AdditionalDetails> <Amenities> <Amenity RoomAmenity="Room Type 3 Amenity 1"/> </Amenities> </RoomType> </RoomTypes> <RatePlans> <RatePlan> <Commission> <CommissionPayableAmount Amount="243.00"/> </Commission> </RatePlan> </RatePlans> <RoomRates> <RoomRate EffectiveDate="2017-10-23"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-24"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-25"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-26"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-27"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> <RoomRate EffectiveDate="2017-10-28"> <Rates> <Rate> <Total RatePlanCode="BAR" AmountBeforeTax="270.00"/> </Rate> </Rates> </RoomRate> </RoomRates> <GuestCounts> <GuestCount Count="4"/> </GuestCounts> <Total AmountBeforeTax="1620.00"/> <ResGuestRPHs> <ResGuestRPH RPH="2"/> </ResGuestRPHs> <SpecialRequests> <SpecialRequest> <Text>Room Type 3 Note 1</Text> </SpecialRequest> <SpecialRequest> <Text>Room Type 3 Note 2</Text> </SpecialRequest> <SpecialRequest> <Text>Room Type 3 Note 3</Text> </SpecialRequest> </SpecialRequests> <ServiceRPHs> <ServiceRPH RPH="48187"/> <ServiceRPH RPH="48188"/> <ServiceRPH RPH="48189"/> <ServiceRPH RPH="48190"/> </ServiceRPHs> </RoomStay> </RoomStays> <Services> <Service ServiceRPH="48013"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Arrival Happy Hour</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48168"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 2 Addon #1</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48169"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 2 Addon #2</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48185"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 2 Addon #1</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48186"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 2 Addon #2</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48187"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 3 Addon #1</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48188"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 3 Addon #2</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48189"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 3 Addon #3</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> <Service ServiceRPH="48190"> <ServiceDetails> <GuestCounts> <GuestCount Count="1"/> </GuestCounts> <Comments> <Comment> <Text>Room Type 3 Addon #4</Text> </Comment> </Comments> <Fees> <Fee TaxInclusive="false" Amount="14.00"/> </Fees> </ServiceDetails> </Service> </Services> <ResGuests> <ResGuest ResGuestRPH="0"> <Profiles> <ProfileInfo> <Profile> <Customer> <PersonName> <GivenName>Karys</GivenName> <Surname>Brown</Surname> </PersonName> <Telephone PhoneNumber="079 5588 6392"/> <Email>KarysBrown@gustr.com</Email> <Address> <AddressLine>Address Line 1</AddressLine> <AddressLine>Address Line 2</AddressLine> <AddressLine>Address Line 3</AddressLine> <AddressLine>Address Line 4</AddressLine> <CityName>NETHERTON</CityName> <PostalCode>NE65 9EB</PostalCode> <StateProv>GB</StateProv> </Address> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGuest> <ResGuest ResGuestRPH="1"> <Profiles> <ProfileInfo> <Profile> <Customer> <PersonName> <GivenName>Karys</GivenName> <Surname>Brown</Surname> </PersonName> <Telephone PhoneNumber="079 5588 6392"/> <Email>KarysBrown@gustr.com</Email> <Address> <AddressLine>Address Line 1</AddressLine> <AddressLine>Address Line 2</AddressLine> <AddressLine>Address Line 3</AddressLine> <AddressLine>Address Line 4</AddressLine> <CityName>NETHERTON</CityName> <PostalCode>NE65 9EB</PostalCode> <StateProv>GB</StateProv> </Address> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGuest> <ResGuest ResGuestRPH="2"> <Profiles> <ProfileInfo> <Profile> <Customer> <PersonName> <GivenName>Karys</GivenName> <Surname>Brown</Surname> </PersonName> <Telephone PhoneNumber="079 5588 6392"/> <Email>KarysBrown@gustr.com</Email> <Address> <AddressLine>Address Line 1</AddressLine> <AddressLine>Address Line 2</AddressLine> <AddressLine>Address Line 3</AddressLine> <AddressLine>Address Line 4</AddressLine> <CityName>NETHERTON</CityName> <PostalCode>NE65 9EB</PostalCode> <StateProv>GB</StateProv> </Address> </Customer> </Profile> </ProfileInfo> </Profiles> </ResGuest> </ResGuests> <ResGlobalInfo> <Comments> <Comment> <Text>Reservation Note 1</Text> <Text>Guest requests a late checkout on departure day.</Text> </Comment> </Comments> <Guarantee> <GuaranteesAccepted> <GuaranteeAccepted> <PaymentCard CardCode="UseCreditCardDescrip" CardNumber="5277433010308656" SeriesCode="348" ExpireDate="1117"> <CardHolderName>Karys J Brown</CardHolderName> </PaymentCard> </GuaranteeAccepted> </GuaranteesAccepted> </Guarantee> <Total AmountBeforeTax="782.00" CurrencyCode="GBP"/> <HotelReservationIDs> <HotelReservationID ResID_Value="874521" ResID_Source="PickupConfirmationId"/> <HotelReservationID ResID_Value="N48PK3O61S" ResID_Source="292@Expedia.com"/> </HotelReservationIDs> <Profiles/> </ResGlobalInfo> </HotelReservation> </HotelReservations> </OTA_HotelResModifyNotifRQ> </soap:Body> </soap:Envelope> Response Message - OTA_HotelResModifyNotifRS Once you have received and stored the reservation modifications or cancellations, the following message will be sent to in replly to confirm your processing. The body contains a <Success /> message, and both the OTA_HotelResNotifRS and the OTA_HotelResModifyNotifRS messages, even if one message or the other does not contain any IDs to confirm. OTA_HotelResNotifRS is for confirming new reservations, while OTA_HotelResModifyNotifRS is for confirming modifications or cancellations. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> <OTA_HotelResNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <HotelReservations> <HotelReservation> <ResGlobalInfo> <HotelReservationIDs/> </ResGlobalInfo> </HotelReservation> </HotelReservations> </OTA_HotelResNotifRS> <OTA_HotelResModifyNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <HotelResModifies> <HotelResModify> <ResGlobalInfo> <HotelReservationIDs> <HotelReservationID ResID_Value="66132"/> <HotelReservationID ResID_Value="66133"/> <HotelReservationID ResID_Value="66134"/> <HotelReservationID ResID_Value="66135"/> <HotelReservationID ResID_Value="66136"/> <HotelReservationID ResID_Value="66137"/> <HotelReservationID ResID_Value="66138"/> <HotelReservationID ResID_Value="66139"/> </HotelReservationIDs> </ResGlobalInfo> </HotelResModify> </HotelResModifies> </OTA_HotelResModifyNotifRS> </soap:Body> </soap:Envelope> Reservation Pickup Polling Message URL: https://[SERVERNAME]/channels/v2/reservationreceive?providerId=[PROVIDERID] You would send the following message to check for reservations pending for pickup. The message is just the envelope with the credentials and an empty body. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body/> </soap:Envelope> In response, you would get the reservation messages found in section 5.1, and your separate confirmation call would include the response messages found in 5.3, but with your login information in the SOAP header as shown below. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body> <OTA_HotelResNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <HotelReservations> <HotelReservation> <ResGlobalInfo> <HotelReservationIDs/> </ResGlobalInfo> </HotelReservation> </HotelReservations> </OTA_HotelResNotifRS> <OTA_HotelResModifyNotifRS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05"> <Success/> <HotelResModifies> <HotelResModify> <ResGlobalInfo> <HotelReservationIDs> <HotelReservationID ResID_Value="66132"/> <HotelReservationID ResID_Value="66133"/> <HotelReservationID ResID_Value="66134"/> <HotelReservationID ResID_Value="66135"/> <HotelReservationID ResID_Value="66136"/> <HotelReservationID ResID_Value="66137"/> <HotelReservationID ResID_Value="66138"/> <HotelReservationID ResID_Value="66139"/> </HotelReservationIDs> </ResGlobalInfo> </HotelResModify> </HotelResModifies> </OTA_HotelResModifyNotifRS> </soap:Body> </soap:Envelope> Test Reservations URL: https://[SERVERNAME]/channels/v2/reservationreceivetestreservationscreate?providerId=[PROVIDERID] To create test reservations (new reservations, modifications, and cancellations), you will send the following message: Each time the message is sent, the test environment is completely reset (i.e., previous test reservations will not exist). The message is just the envelope with the credentials and an empty body. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body/> </soap:Envelope> Reservation Sync / All Reservations URL: https://[SERVERNAME]/channels/v2/reservationreceiveall?providerId=[PROVIDERID] This is so you can pick up ALL reservations in the system for a specific property, sync them, and/or view all reservations. This will return the final (or most recent) version of all reservations with a departure date of today or in the future. So a reservation with an arrival three days ago and a departure two days from now will be included. A reservation with a departure date of yesterday will not be included. Reservations that have been cancelled will be included and listed as cancelled (versus just having cancelled reservations not be included). The message is just the envelope with the credentials and an empty body. <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"> <soap:Header> <HTNGHeader xmlns="http://htng.org/1.1/Header/"> <From> <systemId>[PROVIDERID]</systemId> <Credential> <userName>[PROVIDERUSERNAME]</userName> <password>[PROVIDERPASSWORD]</password> </Credential> </From> <To> <systemId>[HOTELID]</systemId> </To> </HTNGHeader> </soap:Header> <soap:Body/> </soap:Envelope> Warning & Error Codes Any message that returns a <Success /> element is to be assumed the message transmission and processing is successful. If the message also contains a <Warnings> collection and a <Success /> element, the message is to be assumed the message transmission and processing is successful, although a channel for a room type, or a specific channel might not have been updated due to certain conditions (i.e., it is listed but not set up). Any message that contains <Errors> is to be assumed the message was not processed. There will never be a partially processed message that has <Errors> in its response message. Each error or warning has a numeric "Code" attribute, with a text description for its value. Code Message -1 Failure / Config Not Setup 0 HTNGHeader From not provided - htngHeader.From collection has a length of 0. 1 Multiple HTNGHeader From provided - only 1 required - htngHeader.From collection has a length greater than 1. 2 HTNGHeader From Credential not provided - htngHeader.From.Credential collection has a length of 0. 3 Multiple HTNGHeader From Credential provided - only 1 required - htngHeader.From.Credential collection has a length greater than 1. 4 SystemId not provided - htngHeader.From[0].systemId is null or empty. 5 Username not provided - htngHeader.From[0].Credential[0].userName is null or empty. 6 Interface company password not provided - htngHeader.From[0].Credential[0].password is null or empty. 7 Hotel id not provided - htngHeader.To[0].systemId is null or empty. 8 Non-integer found in url for a channel id: {0} 9:Your company htngHeader.From[0].systemId={0} is not currently setup to interface with ChannelRUSH. 10 Invalid login htngHeader.From[0].Credential[0].userName and htngHeader.From[0].Credential[0].password combination. 11 Your company is not setup to deliver information to the hotel you specified at htngHeader.To[0].systemId={0} 12 This hotel htngHeader.To[0].systemId={0} is not mapped to the following channel id {1} 13 The soap envelope body node does not contain any messages. 14 The channelId {0} is not setup in ChannelRUSH to deliver data to any room types. 15 statusApplicationControlType.InvTypeCode={0} not mapped to deliver data to. 16 statusApplicationControlType.InvTypeCode={0} for channelId={1} is not setup in ChannelRUSH to deliver data to. 17 statusApplicationControlType.RatePlanID={0} not mapped to send data to. 18 statusApplicationControlType.RatePlanID={0} for channelId={1} is not setup in ChannelRUSH to deliver data to. Getting Started Email ChannelRUSH at contact@mail.channelrush.com, and we will create your company in our system and create a test account so you can begin testing messages and log in to see how they are processed. The setup account will also include all the URLs needed to post your messages against. OpenTravel Alliance Message XSDs An "XSD" file, or "XML Schema Definition," ensures that XML adheres to a specific format. These will help build your XML messages to send and receive from our system. The OpenTravel Alliance messages we use are standard, as in we do not add any extra "magic" to them to make them work. You can download all of the OpenTravel Alliance XSD files here -http://opentravelmodel.net/pubs/specifications/Specifications.html?spec=2007B. Frequently Asked Questions Where is the WSDL file? There is no WSDL file. This is a basic passing of messages in a SOAP envelope via an HTTP POST. We have found this to be the most platform agnostic approach. We do recommend you verify your XML messages via the XSD files available, as this will ensure your XML is correctly formatted. It is fine to parse all of our reply messages using XSD files as well, as they will pass as they are standard message sets. [SERVERNAME]? [PROVIDERID]? The urls do not work when I post them to channelrush.com? Correct - once you contact us to get your test environment setup, we will provide the server name and provider IDs for the URLs to post the messages to. Notes - All message transmission, either sending or receiving, is done over an encrypted SSL connection. - It is very important that you condense the amount of data you send into the smallest number of transactions possible, using the smallest number of messages possible. This let’s our systems update the information faster once the data has been delivered. Document Versions & Change Log - Document Version: 2025-Sep-11 - Document Version: 2024-May-14
Channel ManagerConfigure OTA and PMS channel settings
Connect the correct property, rooms and rate plans, then choose how inventory and reservations move between ChannelRUSH, your online travel agencies (OTAs) and your property management system (PMS). This guide covers the shared Channel Settings page. An OTA connection sends rates, availability and restrictions out to a sales channel. A PMS Inventory Receive connection brings inventory into ChannelRUSH. Reservation delivery has its own controls and can run in the opposite direction. The fields shown depend on the selected connection, its supported features and your permissions. The examples use Expedia and Viewpoint PMS; use your own provider's identifiers and agreed connection settings, not the example values. Before you start - Select the correct organization and property. Confirm the channel name at the top of the editor before changing anything. - You need Channel Settings permission to save. The login section requires the separate Channel Settings - Login Info permission. You may be asked to verify your password before opening the page. - Have the provider-confirmed property ID, room IDs, rate-plan IDs and connection details. A familiar room name does not prove that its ID is correct. - Confirm who controls rates, allocation and restrictions: your PMS, manual ChannelRUSH updates, or a combination using overrides. - Agree changes to credentials, reservation delivery, pricing model or inventory source with your implementation contact before saving. These can interrupt an active connection. Saving is an operational change, not a preview. It can refresh mappings from a supported provider, save the configuration and send mappings/settings to a supported provider. It can also notify connection monitoring; turning reservation handling off can notify support. Do not save merely to inspect a field or obtain a fresh screenshot. Open the connection 1. Select your property in the property selector. 2. Open Admin → Settings - CM. 3. In Channel Manager → Channels, select the OTA or the entry marked [PMS]. 4. Confirm the channel name and ID at the top of Channel Settings. 5. Use Additional Settings within the property, room or rate-plan section to reveal its optional controls. Expand All and Collapse All change the display; they do not save the form. Expedia connection header with Mappings, Login, Expand All, Collapse All and Menu links. Help opens this shared guide. Channel Support opens provider-specific instructions when available. Mappings opens the channel mapping comparison in another tab. Login, when shown, opens the provider's extranet; it does not save this form. Configure the connection in a safe order 1. Check the shared connection details Review Username, Password and Channel Property ID against the provider's setup instructions. If API URL appears, verify the approved endpoint as well. Do not replace an established connection login with your personal extranet login unless the provider requires that change. Use Notes for non-sensitive operational context. Do not paste passwords, payment details or guest information into notes or support screenshots. Additional username/password fields are protected login information; use them only as directed for your connection. Choose Channel Currency to match the currency configured for this connection. Confirm any conversion requirements before changing it. Rounding Setting controls rounding used in rate processing; it is not a currency selector. Channel Currency set to USD and Rounding Setting set to Do Nothing. 2. Check every room mapping Each room card is headed by the property's standard room type. Inside that card: 1. Set Channel Room Type Name to a recognizable description of the provider's room. 2. Enter the provider's exact Channel Room Type ID. The ID, not the display name, establishes the external mapping. 3. Where shown, check OccupancyMin and OccupancyMax against the provider's occupancy pricing setup. 4. On an OTA, review that room's Updating Enabled and its supported feature controls. 5. Repeat for every room you intend to manage. PMS Garden View Two Queens room mapping with Channel Room Type Name, ID and occupancy fields. PMS example: the standard room is Garden View Two Queens; the provider-facing room name and ID are separate fields. These demo mappings are examples of the form, not recommended mappings for your property. An OTA room header can also show PMS: name (ID) or PMS: [UNMAPPED]. This is a reference to the associated PMS room mapping, not a field that you edit on the OTA card. If it is unexpected, check the PMS connection and any inventory-group assignment before changing the OTA ID. 3. Check the rate plans under each room 1. Find the intended rate plan under the correct room card. 2. Review Rate Plan Name and enter the external Channel Rate Plan ID. 3. Select the corresponding Standard Rate Plan Mapping, where available. 4. On an OTA, review the rate plan's Updating Enabled, feature controls and rate calculations. 5. Repeat for each room/rate-plan combination. Do not assume a rate-plan ID is interchangeable between rooms. Standard rate plan for Garden View Two Queens: name and Standard Rate Plan Mapping. Standard rate plan: Channel Rate Plan ID and Updating Enabled. A blank Standard Rate Plan Mapping leaves that selection unassigned; it does not automatically choose a standard plan. For a PMS receive connection, avoid assigning multiple incoming rate plans under the same room to the same standard rate plan: duplicate standard mappings can prevent saving. 4. Apply the OTA or PMS controls below Review the appropriate section before saving. Updating Enabled, Inventory Receive and Reservation Handling are different switches; enabling one does not enable the others. OTA: control inventory sent to the sales channel Updating Enabled and feature groups An OTA can have Updating Enabled at connection, room and rate-plan level. No disables inventory updating at that scope. Yes permits it, subject to the channel being available, the product being set up, and the relevant feature controls. A room or rate-plan switch is not a reservation-delivery switch. Under Additional Settings, distinguish these groups: Group What it controls When unchecked Standard Features - On/Off Whether a supported inventory feature is enabled for this product. That feature is disabled for the product's updating workflow. Checking another group does not override this master feature switch. Standard Features - On/Off - Populate Automatic population from broader controls on manual update screens. A broader manual edit does not automatically populate this product's feature. A permitted channel-specific edit may still be available. This is not the PMS switch. Standard Features - On/Off - PMS Whether PMS-generated inventory can update this OTA product's feature. The PMS-generated path does not apply that feature to this OTA product. This does not switch off the entire PMS connection. Room-type Standard Features: Allocation and Stop Sell for On/Off, Populate and PMS. Room-level example: Allocation and Stop Sell have separate On/Off, Populate and PMS controls. Rate-plan Standard Features: complete On/Off, Populate and PMS controls for Rates, Stop Sell, CTA and CTD (left side). Rate-plan Standard Features: complete Min Nights and Max Nights controls for On/Off, Populate and PMS, in the same top-to-bottom order (right side). Rate-plan groups continue across the page. The right-hand screenshot shows Min Nights and Max Nights in the same top-to-bottom order: On/Off, Populate, PMS. The available features vary by provider and by level. Expedia's room-level allocation controls and rate-plan restrictions are not a template for every other channel. Review both levels rather than assuming a checkbox on one controls every field on the other. Net, sell, markup and margin Net, Sell, Markup, Margin Settings appears only for supported OTA connections. Use the pricing model agreed with that provider; do not use this section as a general substitute for product rate calculations. Net, Sell, Markup, Margin Settings: Markup and Margin values. Net, Sell, Markup, Margin Settings: Type and Minimum Markup Dollars. Field How to use it Markup The adjustment used to calculate the sell/net relationship. With % Percentage , markup is measured against the net amount. Margin The corresponding percentage of the selling amount. Changing a percentage markup or margin updates the companion value on screen. They are not two independent percentage additions. Type % Percentage uses a percentage. $ Flat Fee , or the displayed currency equivalent, uses an amount. The margin control is hidden for flat-fee calculation. Minimum Markup Dollars A minimum monetary markup for the supported net/sell calculation. Use only if required by the connection's pricing agreement. Per Date Range Lists dated markup settings. Add New opens a separate date-range editor; existing entries are maintained separately from this form. Save or discard pending work here before leaving for that editor. For illustration, a net amount of 80 with a 25% markup gives a selling amount of 100. The corresponding margin is 20%, not 25%. Confirm whether the provider expects net or sell rates before applying either figure. Provider-specific Additional Settings These controls are not universal. Required fields carry an asterisk, and provider-supplied mapping differences may be highlighted. Expedia Additional Settings showing RateAcquisitionType and Rate Type selectors. For the Expedia example: - RateAcquisitionType offers NetRate and SellRate. Choose the acquisition basis configured for your property with Expedia. - Rate Type offers PerDay, PerOccupancy and PerPerson. Match Expedia's pricing setup rather than choosing whichever makes an individual rate look correct. Other providers can have different required property, room and rate-plan parameters. Use Channel Support and the provider's confirmed mapping details. Do not copy Expedia's selections into a different connection. PMS: receive inventory and protect selected manual updates Inventory Receive modes PMS Inventory Receive and Connection Monitoring controls. Inventory Receive Effect Off Disables receiving/storing inventory through the connection's enabled receive workflow. The page warns that inventory will not be received/stored. On Processes incoming inventory and creates automatic outbound channel updates for eligible mapped destinations. It does not guarantee those destinations accept the updates. On - Queued Stores the incoming inventory changes without automatically creating outbound channel updates in that receive-processing path. Do not treat this as normal automatic distribution with a promised delay. On - Delta Only Processes incoming inventory and generates updates while suppressing unchanged product/date snapshots. It is not a promise that every outgoing request contains only individually changed fields; a changed day can include existing values populated into that day's snapshot. Do not turn a second PMS source On without checking inventory groups. If another active inventory-receive source already exists outside the required group configuration, saving can be refused. Resolve the source-to-destination design rather than disabling the existing source to bypass the warning. Connection Monitoring and receive timestamp PMS Connection Monitoring Hours and informational Inventory Receive Timestamp. - Connection Monitoring enables or disables the connection's inactivity monitoring setting. - Connection Monitoring Hours is an inactivity threshold in hours, not how often the PMS is polled. Monitoring also has eligibility and system checks; setting a number is not a guarantee of an alert at exactly that elapsed time. - Inventory Receive Timestamp is informational. For a push receive connection it comes from the latest recorded inbound inventory-message creation time. For a monitored/pull connection it comes from the inventory monitor's recorded activity. A dash means no corresponding timestamp is available. The timestamp is not proof that a particular room/date was updated or that an OTA accepted its inventory. Use it as a starting point for investigation, together with PMS ARI Log and outbound Updates Status. User PMS Override The User PMS Override section determines which types of saved manual updates can take precedence over later PMS inventory for the affected products and dates. User PMS Override checkboxes for allocation, restrictions, rates and Stop Sell. - Checked: an existing applicable manual override can block replacement by the corresponding PMS field. - Unchecked: that override protection is not enabled for the field; later PMS inventory can overwrite manual values. - Checking a box does not create an override value. A manual value must also have been saved for the relevant product/date through the update workflow. Stop Sell has a special rule. Protection applies to a saved manual closure, Stop Sell = Yes. It can also prevent positive PMS allocation from reopening that closure. Do not assume a saved manual reopening, Stop Sell = No, is protected against a later PMS closure in the same way. Review each field independently: Allocation, CTA, CTD, Cut Off Days, Max Nights, Max Nights Through, Min Nights, Min Nights Through, Rates and Stop Sell. Decide which system should own each value before changing these switches. Unchecking a switch does not by itself establish that a new PMS value has arrived or been sent onward. PMS product sections can also show Standard Features - On/Off and rate calculations. Their supported fields relate to that PMS connection. The OTA-only Populate and PMS groups are not the same as this property-level override policy. Reservation controls: separate from inventory For an OTA, Reservation Handling concerns reservations received from that channel. For a PMS delivery connection, it concerns reservations delivered to the PMS. The property-level reservation configuration and the provider's capabilities must also support the intended flow. PMS Reservation Handling, Reservation CC Info and Reservation Retry controls. Field Meaning and precautions Reservation Handling On enables the connection's supported reservation workflow; Off disables it. Turning OTA inventory updating off is not a substitute for turning reservation handling off. Coordinate changes with support/provider, especially when stopping delivery. Reservation Send Type Shown when both delivery methods are supported. Push sends through the provider's push integration. Pickup / Confirm uses the pickup/confirmation integration. Match the receiving system's setup. Reservations - Send Email Notifications A separate On/Off option shown for connections supporting this email override. Email notification is not confirmation of PMS delivery. Reservation Retry Enables or disables the PMS connection's automatic reservation retry setting. It is not a manual resend button and does not prove a failed reservation has been delivered. Reservation CC Info Controls the payment-card information prepared for the supported PMS delivery. Select the least information required by the approved integration. Token options require an appropriate token-capable setup. Guest Messaging Connection-level On/Off control when the feature, property and permissions make it available. It is separate from inventory and reservation handling. Guest Reviews Connection-level On/Off control when the review feature is available. Its absence is not a room-mapping error. Reservation CC Info options - Off: removes the card number, security code and expiry from the PMS-bound reservation preparation. Do not interpret this as deleting every card-related field or the original reservation. - On: does not apply that stripping/abbreviation step; the actual information available still depends on the reservation and integration. - On - Abbreviated: keeps only the last four characters of the card number, removes the security code and retains expiry information. - On - CC Token Only: uses the token workflow and strips raw number, security code and expiry from the PMS-bound preparation. - On - CC Token - Abbreviated: uses the token workflow with abbreviated card details. Never include card numbers, security codes, tokens or connection passwords in a support request or screenshot. Shared field reference Identity, scope and required values Field or indicator Reference Username / Password Provider connection credentials. Required markers are not proof that the credentials have been accepted remotely. Keep established managed connection values unless instructed to replace them. Channel Property ID The provider's property identifier. It is distinct from the ChannelRUSH property ID in the property selector. Preserve significant characters and remove accidental leading/trailing spaces. Extra Username 1 / 2; Extra Password 1 / 2 Additional login fields shown with the login-info permission. Use only according to the connection's requirements; do not use them as general notes. API URL Provider-specific endpoint where supported. Editable with login-info permission; it can be shown read-only otherwise. A wrong endpoint can direct connection traffic incorrectly. Notes Notes about this property's selected connection. Keep them non-sensitive. Channel Room Type Name / Rate Plan Name Descriptive local labels for the channel products. Editing a label does not substitute for correcting its external ID. Channel Room Type ID / Channel Rate Plan ID Exact external product identifiers. A rate plan belongs to its displayed room context. Blank or incorrect IDs can leave the product not set up or wrongly mapped. Standard Rate Plan Mapping Associates the connection product with a property standard rate plan. A blank selection is unassigned. Some channels expose this at room level instead of rate-plan level. OccupancyMin / OccupancyMax Occupancy bounds used for occupancy-based rate setup where supported. Match the provider. On this form a blank minimum is read as 1, while a blank maximum is unset; neither means “copy the provider's current value.” Occupancy Room Rate Mapping Appears for applicable occupancy-based PMS mappings. Identifies the occupancy used for that mapping; agree it with the PMS setup rather than guessing from the room name. [NOT SETUP] The product lacks an external ID or has not met setup requirements. Saving a display name alone does not establish setup. [INVALID MAPPING] The external product ID was not found in the available channel mapping data. Review the provider and mapping comparison before replacing the ID. [ X ] / INCORRECT SETTING - Correct: … A difference against available channel mapping information. Inspect the specific field; this is not a confirmation that a send failed or that automatic replacement is safe. Inventory feature names These checkboxes enable or route a feature; they do not enter a nightly value themselves. Feature Inventory value it concerns Rates The product's monetary rate. Occupancy/additional-rate settings may have their own controls. Allocation Rooms or units available for sale. Stop Sell Whether selling is closed. CTA / CTD Closed to arrival / closed to departure. Min Nights / Max Nights Minimum / maximum length-of-stay restrictions for the supported channel model. Min Nights Through / Max Nights Through Stay-through length-of-stay restrictions, where supported, rather than assuming the arrival-based fields cover the same rule. Cut Off Days The supported advance-booking cutoff. Additional Features - On/Off Provider-specific inventory features. Follow their displayed names and channel instructions. A Property Level Standard Features - On/Off group can appear for providers that support property-level fields. Room and rate-plan feature groups apply to their displayed product. Do not infer that every provider exposes or interprets every feature at all three levels. Currency, rounding and rate calculations Control Reference Channel Currency Currency configured for the connection. Do not assume every integration or incoming amount is automatically converted merely because this field is selected. Rounding Setting: Do Nothing No rounding by this setting. Round To Nearest Dollar / Round Up / Round Down Round to the nearest whole monetary unit, upward, or downward respectively where this rounding setting is used. The displayed label can say “Dollar” even when another currency is selected. Rate Settings — Calculation 1 through 6 Ordered product-level adjustments. Each has an amount and a percentage/flat-fee type. Use zero for an unused adjustment; blank numeric calculation inputs are read as zero when that calculation is saved. Rate Settings - [occupancy/additional rate] Separate controls for the displayed occupancy or additional-rate component, where supported. Its On/Off and available Populate/PMS controls belong to that component, not every rate in the room. Calculations are sequential, so order matters. For example, 100 increased by 10% and then by a flat 5 becomes 115. Review the full chain, including other property or channel calculations, before adding a second adjustment. Saving configuration is not a command to resend every previously distributed date. Save and check the result 1. Review the entire connection, including expanded room and rate-plan settings. The top and bottom save controls submit the same form, not only the nearest card. 2. Choose Save & Refresh from the arrow beside Save if you want to remain in this editor for verification. Save normally returns to the originating administration page after an existing connection saves without warnings/errors. If warnings remain, the editor can stay open. 3. Read all success, warning and error messages. A settings-saved message and a settings-send result describe different stages. 4. Reopen or refresh the saved editor and verify the intended IDs, modes, feature switches and calculations. 5. Where supported, open Mappings and review the provider comparison. A successful local save is not proof that the provider accepted the mapping/settings send. 6. For inventory delivery, open Menu → Updates Status. Select the intended outbound OTA destination and relevant dates, then click Search. If you opened this from the PMS editor, change the channel filter from the PMS to the destination you are checking. Inspect the actual request and its result; an empty result or a receive timestamp is not proof of delivery. 7. For PMS inventory, also inspect Admin → PMS ARI Log for incoming messages. For reservations, use Menu → Reservations - Delivery Status and its Search action to investigate delivery separately. Cancel leaves this editor without submitting the pending form. It does not undo a previous save or any downstream work already triggered. A new connection may instead show Save & Continue so that setup can continue after its first save. If a save reports an error after configuration was saved, do not assume everything was rolled back. Reopen the connection and inspect the current values and status before repeating an action. Do not resend inventory or reservations solely to test whether a setting worked. Common problems and safe next actions Symptom Check and safe next action This channel is not set up or [NOT SETUP] Check the required connection/product fields and provider-specific Additional Settings. Verify external IDs with the provider. Ask support if correct confirmed values still leave setup incomplete. [INVALID MAPPING] , UNMAPPED ROOM TYPES or a mapping difference Compare the saved IDs with Mappings and the provider's actual inventory. Mapping data may not contain the expected product. Do not change IDs based on names alone or bulk-import blindly. Duplicate room/rate-plan mapping error Check repeated external IDs and PMS standard-rate-plan assignments. A duplicate can involve another property. Ask support to resolve ownership if the error identifies a property you cannot inspect. A second PMS cannot be enabled Review inventory-group membership and which source feeds which channels. Do not switch off an established source merely to make the new one save. Virtual room type cannot be saved for PMS Inventory-receive connections do not allow virtual room types. The presence of Add Virtual Room Type in navigation is not proof that the selected PMS supports it. No automatic OTA updates from PMS Check Inventory Receive is not Off or On - Queued , then inspect mappings, OTA Updating Enabled, supported feature/PMS switches, override values and request status. Avoid changing several controls at once. Manual values are replaced by PMS Check the applicable User PMS Override switch and whether an override value was saved for those exact products/dates. Apply the special Stop Sell rule rather than assuming all Yes/No values behave identically. Manual close does not reopen after PMS allocation arrives A protected manual Stop Sell closure can block reopening. Review the saved closure and override policy before changing inventory. Reservation warning although Updating Enabled is Yes Inventory and reservations are independent. Check Reservation Handling and property-level reservation configuration. Coordinate any delivery shutdown with the provider/support. Settings saved but settings send failed Reopen to confirm local persistence, record the message and investigate the provider connection. A second save can repeat remote work; confirm the safe retry with support. Missing or disabled controls Check edit/login-info permissions, provider capabilities and property feature availability. Do not use another channel's settings as a workaround. Unexpected rates Check currency, pricing model, rounding, net/sell settings, all ordered calculations and the exact product mapping. Compare the generated request before changing prices again. When escalating, provide the property name/ID, channel name, affected room/rate-plan IDs, stay dates if relevant, action time and time zone, and the exact warning/error. Exclude passwords, payment details and unnecessary guest information. Related guides - Channel Settings - Review Mapping Changes - PMS Overrides - Expedia
API DocumentationAPIs - Overview
Channel Manager APIs This API is for adding channel manager capabilities to your software platform. These include… - Connecting your software platform to distribute ARI (availability, rates, and inventory) to points of sale like Booking.com and Expedia.com - Retrieving reservations created on these points of sale for storage back in your software platform We have two versions of this API. If you don't have a preference, we recommend developing the JSON API. Channel Manager API - JSON Spec Channel Manager API - XML Spec This API provides the same functionality as the JSON API above, but is designed and developed using the OpenTravel.org XML specification. OTA (Online Travel Agent) APIs There are two models to book reservations, the CRS model or the OTA model. CRS API This API is for booking reservations on your platform in real-time: - Pulling all property content to create a booking page and book a reservation – room type descriptions, photos, etc. - Querying against live rate / availability / restriction information, and placing reservations. - Searching for available properties by location. OTA API With this API you create an API endpoint on your side to receive and process our rate / availability / restriction messages, setup call messages, reservation actions (optional), and either send to our endpoint (or allow us to poll for reservations created) (new / modified / cancelled). Document Versions & Change Log Document Version: 2026-October-06