Commerce Supplier API

The Commerce Supplier API is a SaaS-based service that allows suppliers to establish a connection to the Inntopia Commerce System using XML messaging. The Commerce Supplier API supports receiving rates, availability, and booking restrictions and sends new, modified, and cancelled reservations.

The basic Commerce Supplier API information applies to most of the third-party vendors with which Inntopia has a working integration. However, many of those third-party vendors have exceptions to the standard information. The exceptions and website link for each third-party vendor are listed below.

  • Full ownership of the customers who book through the Inntopia Commerce platform
  • Ensure the Commerce system and your supplier system stay in sync by pushing ARI messages as things change in your system
  • Reservation pick-up by your system
  • Distribution of inventory for further online reservation, reach, and revenue but completely controlled by you

To configure any of the following features in the Commerce Supplier API, contact your Strategic Account Manager.

Feature Description
Multi Rate Multiple rates can be supported through promotion cross-reference codes. These codes must be entered on the promotion in Inntopia RMS and configured as rate codes in the third-party system.
Daily Rate Inntopia supports sending the daily rate breakdown in the reservation message. The default setup is to send one RoomRate node containing the average nightly rate for the stay.
POS Node This node indicates the Inntopia sales channel that booked the reservation.
Other Items Booked (non-lodging) Adds non-lodging itinerary items (e.g. – activities) within the reservation message’s Comments.
Group Code A code associated with a promotion booked in Inntopia. This code is typically leveraged by a resort to update a group block within the remote system. The Group Code value is sent in the reservation message's InvBlockCode attribute.
Promotion Code A code associated with a promotion booked in Inntopia.
Additional Guests Provides the name(s) of all guests associated with a reservation when guest names are submitted in Inntopia via the Customer Name customer requirement.
Modification Type Provides description of the modification type in the modification message thus enabling the POS to identify modification type and determine the correct actions to take with the message. Requires action from POS to treat message differently based on modification type.

The Commerce Supplier API supports the following booking restrictions:

  • Closed to arrival
  • Closed to departure
  • Minimum stay
  • Close out

    Note: Setting Quantity Available equal to zero does not close out a room type. When a room type is NOT closed out and a reservation is cancelled for that room type, one unit goes back into availability.

The following rules are supported in the rate message:

  • RACK rates
    • Rate name set to numeric rate amount submitted by interface.
    • NET rates: If a supplier needs to send net rates to one or more sales channel, the supplier can send RACK rates through the integration from the third-party vendor to Inntopia (the integration supports multiple rates). However, once the rate is transmitted through the integration as RACK, the supplier can set the rate optimizer to send out NET rates for the given sales channel.
  • Rates that vary by day (Sunday – Saturday flags)
  • Extra person charges (adult and child)
    • Can only define ONE extra person charge per category per rate name/amount.

All communication to the Inntopia web service is initiated by the third-party vendor.

  • Full updates are sent on a regular basis.
  • Changes occurring since the last update are sent at regular intervals. The frequency is determined by the vendor.
  • Reservation delivery is achieved using a pull method. The third-party vendor integration polls the Inntopia web service at regular intervals to retrieve new, modified, and cancelled reservations.
  • Products with derived inventory are not eligible to be integrated and cannot be added to the product list.
  • To give guest service agents visibility into all items that are included in a reservation, any non-lodging items can be included in the reservation message. To activate this feature, contact your Strategic Account Manager.

Inntopia suppliers maintain the following information in Inntopia:

  • Product information – descriptions, images, policies, fees, taxes, etc.
    • Rates, availability, and booking restrictions should not be maintained in Inntopia once the supplier has been integrated.
  • Cross reference codes – Inntopia product/third-party-system room-type cross reference codes.
    • The interface requires a one-to-one relationship between PMS room types and Inntopia products.

Every integration implementation is unique; therefore, time lines and installations can vary. Typically, suppliers should allow a minimum of ten business days to complete the integration setup. Follow the steps below:

  1. Supplier: Confirm with the third-party vendor that you plan to integrate with Inntopia.
  2. Supplier: Contact Inntopia to determine whether to use your existing Supplier Account or create a new one. Consider the following when making the determination:
    • The current Supplier Account connection must be deactivated prior to enabling a new connection.
    • Some down time of the ability to book reservations will occur until the new connection is fully functional.
    • Existing Tape Chart data will remain and will not be overwritten until a full update of data from the new Supplier Account connection is complete.
    • Using remote inventory with any Commerce Supplier API connection is not supported. If previously connected to DHISCO, you must create a new supplier account.
  3. Supplier: Contact Inntopia to request the initial integration setup. Provide the following information to Inntopia:
    • Supplier account ID
    • Supplier contact information
    • Email address to receive integration warnings and errors
  4. Inntopia: Partner Services works with supplier to set up the product cross-reference codes.
  5. Inntopia: Coordinate with third-party vendor for an initial rate, availability, and test reservation.
  6. Inntopia: Partner Services and third-party vendor verify the test.
  7. Inntopia: Confirm with the supplier that the communication of rates, availability, and the test bookings were all successful.

Inntopia has implemented the following controls to ensure that the integration is working properly. Each control will email the supplier and Inntopia’s Partner Services team for follow-up.

Notes are supported if added via Inntopia CRS.

Original Message-----

From: Notifications Mailbox

Sent: <date and time stamp> To: <recipients>

Subject: Inntopia <Third Party Name specified> Interface Warning <session ID>

The following Inntopia reservation is waiting to be picked up. Please verify that your PMS interface to Inntopia is working properly. Supplier: <Inntopia Supplier Name> SupplierId: <######> Customer Last Name: <Name> Itinerary Id: <######> Arrival Date: <MM/DD/YYYY> RsysId: <######> Interface Name: <Vendor> Inntopia Product: <Product Name> Room Type Cross Reference: <alpha numeric code>

Original Message-----

From: Notification Mailbox

Sent: <date and time stamp> To: <recipients>

Subject: Inntopia <third party> Interface Warning <session ID>

Inntopia rate processing has generated the following warning messages for supplier <######>.

There is no cross reference setup in Inntopia for room type <alpha-numeric code>.

The following interface warning email is an example of those sent to the supplier when the cross-reference code for a particular product is not set up or is set up incorrectly.

Original Message-----

From: Notification Mailbox

Sent: <date and time stamp> To: <recipients>

Subject: Inntopia <third party> Interface Warning <session ID>

Inntopia rate processing has generated the following warning messages for supplier <######>.

There is no cross reference setup in Inntopia for room type <alpha numeric code>.

The following are supported:

  • Rack Rates
  • Modifications
  • Promo Rates
  • NET Rates
  • Inntopia does not support the “delta” and “full” load functions in Barefoot. Each rate message received results in an add or change to a rate for a room on a specific day(s).
  • Inntopia stores base occupancy and extra person charges past the base occupancy number. The base rate loaded into Inntopia is equal to the rate sent by Barefoot for up to and including the number of occupants defined in the base occupancy. Barefoot sends variable rates for number of adults and extra person charges.

In the following example, the base occupancy is 2 and the weekday rate is 299.

For extra person charges, we select the highest value from either:

  1. The difference between the base rate and the rate for the next adult, or
  2. The extra person charge sent from Barefoot.

Also in the example, the higher value is the difference between the base rate and rate for the next adult: (309 – 299 = $20.00 extra person charge).

Adults 1 2 3 4
Weekday Rate 299 299 309 319

Extra Adult Charge from Barefoot

    15 15

Extra Child Charge from Barefoot

    15 15

Inntopia communicates messaging issues to assistenza@bookingexpert.it and the supplier email address.

Web: www.bookingexpert.it

  • Integration supports cancellations but not modifications. To modify an itinerary, it must be canceled and re-booked.
  • Non-rack rates created in BookingPal are not supported.

Web: https://bookingpal.com/en/contact-us/

FKA Sunrise Campground Automation

  • Supported: Rack rates and Promo rates
  • Not supported: Modifications and NET rates

Web: www.getcamplife.com/contact/

No exceptions.

Web: https://www.cenium.com/contact/

Contact your PMS to confirm that connecting to Channex is possible.

  • Multi-rates and group codes are not supported.

Web: https://channex.io/contacts

Inntopia recommends incremental updates throughout the day; however, D-Edge does not automatically send updates.

Web:www.d-edge.com/contact/

Note: FastBooking and Availpro merged in 2019 to form D-Edge.

Inntopia communicates messaging issues to the supplier email address.

Web:www.followme2africa.com

Quantity changes will not be supported as the Guest Centrix system cancels the existing order and creates new orders, whereas the Inntopia system treats it as a modification.

Web: www.cmshospitality.com

  • Integration supports cancellations but not modifications.
  • By default, credit card numbers are not sent to Innquest. Upon request, Inntopia can send credit card numbers.
  • Supplier must be using Innquest IQ Link.
  • Does not support Minimum Length of Stay (MLOS). The MLOS restriction can be managed in the Inntopia RMS Tape Chart.

Inntopia does not support the concepts of “negative inventory values” and “Total Inventory" (refers to specific room type). Inventory quantities sent from roomMaster to Inntopia will only affect the Inntopia product which is mapped to the roomMaster room type.

Negative inventory values sent via the integration will result in the Inntopia product having a quantity of zero total inventory available for the day specified.

When reservations that are created in Inntopia do not integrate with roomMaster via IQWorldLink, suppliers must verify that IQWorldLink is up and running.

  1. If it is not running, launch IQWorldLink.
  2. If it is running, contact Innquest/roomMaster.

Email: support@innquest.com

Web: www.iqwareinc.com

All features are supported.

Web: www.lodgicalsolution.com/contact-us/

Supported modifications include dates and product.

Web: www.naturalretreats.com/us

As of September 2013, RNS only supports availability. They will not be pushing rates and booking rules, or pulling reservations from Inntopia. In the future, RNS may want to support the full integration specification.

Web: www.rental-network.com

RDP poses a charge to the supplier for the interface set up.

Web: www.resortdata.com

  • SiteMinder poses a charge to the supplier for the integration setup.
  • For each SiteMinder account, there should be one corresponding Inntopia account.

If the closed-to-arrival booking restriction is set on the Inntopia side, the SiteMinder interface will not override it.

Should the supplier prefer to manage rates within Inntopia (and only send availability and restriction updates via SiteMinder), the rate-update feature in SiteMinder can be disabled by contacting both SiteMinder and Inntopia.

If the Supplier is managing rates within Inntopia, the Supplier must enter their rates prior to sending availability and restrictions updates via SiteMinder.

For room types to be available in SiteMinder for mapping, the RMS channel restrictions must permit (or not deny) the supplier account.

Inntopia will communicate notifications of processing issues to SiteMinder at: Support@siteminder.com.au

Email: support.us@siteminder.com

  • Units booked in Inntopia are closed out in Streamline; quantity will not deprecate to zero. The Close Out tab in the Tape Chart must be used to determine if a room is available.
  • Cross reference codes are provided by Streamline.
  • Does not support modifications. To make changes, must cancel and rebook.

Web: www.streamlinevrs.com

  • Taxes, fees, and rates must match in both systems or reservations will fail when sent to the PMS.
  • Promotion Reservation are not currently supported.

Web: www.trackhs.com/contact-us/

Inntopia communicates messaging issues to cs@travelclick.com as well as to the supplier email address.

Web: www.travelclick.com

WebRezPro supports sending and receiving multiple rates, not just RACK.

Web: www.webrezpro.com

This is a one-way integration from Yield Planet to Inntopia. The integration does not include reservation delivery to Yield Planet at this time.

Support:support@yieldplanet.com