Supplier Integration API
The Supplier Integration API is a SaaS-based service that connects suppliers to the Inntopia Commerce platform. The two-way integration uses JSON messaging to transmit availability, rates, and inventory (ARI), product information and reservations and payment postings between Inntopia and a third-party remote system.
The integration supports lodging and non-lodging products and can be used by third-party property management systems (PMS) and point-of-sale (POS) systems. It can also be leveraged to create Inntopia third-party adapters used for instances where real-time ARI is needed.

Benefits of using the Supplier Integration API include:
- Full ownership of the customers who book through the Inntopia Commerce platform
- Ability to ensure the Commerce system and your supplier system stay in sync by:
- Pushing ARI messages as things change in your system
- Pushing products and product content
- New, modified, and cancelled reservation pick-up by your system, which can optionally include payment and refund postings.

- Integration Flow –
- Products and ARI created in the third-party system flow to Inntopia.
- Products are searched for and reserved in Inntopia.
- Reservations and payments are pulled from Inntopia by the third-party system.
- All communication to the Inntopia web service is initiated by the third-party system.
- Communication frequency is determined by the third-party vendor.
- Full ARI updates are sent from the third-party system to Inntopia on a regular basis.
- Changes or deltas occurring since the prior update are sent at regular intervals.
- Delivery of new, modified, and cancelled reservations is achieved using a pull method.
Note: Post-arrival modifications and cancellations are not supported through the integration; therefore, they must be completed directly in the PMS.
- All lodging and non-lodging product categories are supported.
- Product customer requirements can be posted to Inntopia post-sale. For example, a print media company provides media card ID after printing.
- The API can be used to support one-way (reservation only) or two-way (ARI and reservation) integrations.
- Access to the API calls requires basic authentication via username and password.

The following chart shows the required and optional features supported in the integration. Required features must be set up for the integration to function correctly.
Feature | Required | Description |
---|---|---|
ARI | No | Availability (aka booking restrictions), Rates, Inventory. |
Reservations | Yes | Confirmed reservations. |
Modifications | No | Modified reservations. |
Cancellations | Yes | Cancelled reservations. |
Product and Product Content | No | Product and product content can be integrated from the third-party vendor to Inntopia. |
Payments | No | Payment details can be posted to the third-party system. |

The Supplier Integration API supports the following booking restrictions:
- Lodging Only –
- Closed to arrival
- Closed to departure
- Minimum stay
- Lodging and Non-Lodging –
- Close out

The following are supported in the rate message sent to Inntopia by the third-party system:
- RACK (default) rates –
- The default rate code is not required to be RACK.
- Each supplier must identify their default rate code, and that rate code will be configured by Inntopia when adding the supplier to the remote system. If the supplier has no preference, RACK should be used.
- NET rates – If a supplier chooses to send NET rates to one or more sales channels rather than RACK rates, the supplier can send NET rates through the integration using their preferred rate code (including RACK) and then 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)
- Only ONE extra person charge can be defined per category per rate name/amount.
- RACK Rates must be sent before non-RACK rates can be sent
- Multiple Rates – While not required, multiple rates can be supported through promotion cross-reference codes. When used, these codes must be entered on the promotion in Inntopia RMS and configured as rate codes in the third-party system.

The Supplier Integration API supports inventory updates for Inventory Pool products.
- Supported for all Inventoried product categories.
- Supported for single- and multi-day products.
- Not supported for time-based inventory pools.
- Product/product content must be managed in both Inntopia and the third-party integrated system for inventory pool products.

Reservation messages will include the following:
- Product Customer Requirements – Any product customer requirements including guest profile photo URL.
Note: Images are supported through the integration via a shared URL only. Both systems must have access to the URL location.
- Daily rate
- Guest Data – Name, address, email address, phone number, date of birth

- New products are integrated from the third-party to Inntopia.
- New products are created in Inntopia with the product cross reference code.
- New products created in Inntopia are set to inactive.
- New products are created as Inventory Type “Inventoried” by default.
- Other inventory types (free sale, merchandise) can be specified if needed. When specifying other inventory types, be aware of dated and dateless product categories:
- Dateless product categories such as season passes or gift cards must use the Merchandise inventory type.
- Dated (date specific) product categories such as lessons, rentals, tickets, activities must use either Inventoried or Free Sale inventory types.
- Other inventory types (free sale, merchandise) can be specified if needed. When specifying other inventory types, be aware of dated and dateless product categories:
- New products are created with product details (name, policies/fulfillment instructions), product content (listed below), and product cross-reference codes.
- Deleting products in the third-party system removes the products from Inntopia RMS.
- Product content is included with new products coming from third-party.
- Product content modified or removed in the third-party is automatically modified or removed in Inntopia.
- Products include the following content:
- Product Attributes
- Customer Requirements
- Multi-Lingual
- Images – Product images are supported through the integration via a shared URL only. Both systems must have access to the URL location.
- For inventory pool products, product and product content must be managed in both Inntopia and the third-party integrated system.
Note: Product content does not include taxes and fees; taxes and fees must be maintained in both Inntopia and the third-party system.

The API supports transmitting advance deposit payments and customer refunds. Deposit/refund information is pulled and posted in the third-party system:
- Deposits – Initial or subsequent deposit amounts collected for products on an itinerary
- Modification Deposits – Deposit amounts collected upon modifying an itinerary
- Refund Amounts – Amounts refunded for cancellations or modifications
- Multiple Deposits – Multiple deposits on multiple products in the same itinerary are sent with the summed deposit amount on only one product.
- Single-Item Refunds – Refunding a single item on an itinerary containing multiple products requires cancelling all products, issuing a full refund, and rebooking the item(s) the guest wants to keep.

The following payment types are supported via the Payment Postings feature:
|
|
|
|
|
|
|
|
|
|
|
|
|

- Agent reserves item in Inntopia.
- The third-party system uses a batch-mode reservation process to pull reservations at their specified cadence. Payment amounts collected at the time of booking should be pulled by the third-party vendor in a separate message at the same cadence shortly after the reservation is confirmed.
- The third-party system responds to Inntopia immediately with its payment confirmation ID.

- Collecting funds outside of the specified Inntopia deposit policy transmits the full amount collected to the third-party system.
- Processing a refund on an item that has not been cancelled will not transmit the refund.
- Deposit/refund amounts processed AFTER the checkout date will not trigger a payment to be sent (if a refund is taken in Inntopia after checkout, you must manually post the refund).
- Although lodging suppliers are the typical users, deposit/refund postings can be enabled for any supplier.

If you have an abundance of integrated products, Inntopia recommends that you set up multiple supplier accounts to maintain optimal performance. If you set up multiple supplier accounts, each account must sell all items of a particular product category. You can have more than one Supplier account with the same Inntopia product category.
- Supplier A – Sells Lift Tickets
- Supplier B – Sells Ski School
- Supplier C – Sells Equipment Rental
- Supplier D – Sells Sleigh Rides, Snowshoeing, and Zipline

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.
- Supplier: Confirm with the third-party vendor that you plan to integrate with Inntopia.
- 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.
- Supplier: Contact Inntopia to request the initial integration setup. Provide the following information to Inntopia:
- Supplier account ID
- Supplier contact information
- Supplier: Verify cross-reference codes to ensure correct mapping between the two systems.
- Inntopia: Coordinate with third-party vendor for initial tests for supported features.
- Inntopia: Partner Services and third-party vendor verify the test.
- Inntopia: Confirm with the supplier that the communication of all supported features was successful.


- Supported features –
- Reservation Delivery – confirmations, modifications, and cancellations
- Any dateless products requiring modification must be cancelled and rebooked
- QR Codes –
- Inntopia ID is embedded behind the code
- Only supported for Commerce Confirmations
- Guest Data
- Customer Requirements – For a guest to be created in Paradox and to avoid duplicate guest records, Customer Name and Date of Birth customer requirements must be configured.
The table below shows the customer requirements that are mapped to transfer from Inntopia into Paradox:
- Reservation Delivery – confirmations, modifications, and cancellations
- Additional details – ARI and product integration coming soon
- Contact – support@paradocs.ca