Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Billing automations
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Enterprise information
  • Rates and availability
  • Managing billing
  • Paymaster accounts
  • Adding revenue and payment items
  • Recording external payments
  • Further automation possibilities
  • Managing group reservations with availability blocks
  • Creating availability blocks
  • Allocating inventory to an availability block
  • Adding reservations to an availability block
  • Managing reservations and guests
  • Managing availability block inventory and pickup
  • Testing your integration
  • Additional help for working with the demo environment

Was this helpful?

  1. Use cases

Events

PreviousDevice integrationNextGuest technology

Last updated 2 months ago

Was this helpful?

Event management systems streamline the planning, organization and execution of events such as weddings or conferences. An Events integration can pull live information about rates and availability, create availability blocks (also known as room blocks or group blocks), affect property inventory, push contracted revenue to the relevant guest’s profile in Mews, and allow users to manage the group reservations already pushed into Mews.

Enterprise information

To automate the onboarding of a new property as much as possible, use a combination of operations, operations and operations to pull information about a property or enterprise, including, but not limited to, resources configuration (including rooms and other spaces), applicable tax rates, services and products, and company profiles.

'How to' use case

API Operations

How to get property configuration

How to get rooms and resources configuration

How to get applicable tax rates

How to get the list of services offered

How to get the list of products linked to services

How to get company profiles

How to get the list of supported countries

How to get the list of supported currencies

How to get the list of supported languages

Rates and availability

Use and to pull data about rates offered in the property or enterprise. Use to pull resource category availability and related adjustments from Mews.

'How to' use case

API Operations

How to get rates

How to get the price for a given rate

How to get availability

Managing billing

'How to' use case

API Operations

How to add a new company

How to find an existing company

Paymaster accounts

'How to' use case

API Operations

How to create a Paymaster profile

How to update a profile to be a Paymaster

How to remove the Paymaster classification

How to get a list of profiles created over a period of time

Adding revenue and payment items

Linking orders to reservations

'How to' use case

API Operations

How to add a product order item to a customer profile

How to get the list of available products

How to get accounting categories

How to link an order to a reservation

Recording external payments

Further automation possibilities

'How to' use case

API Operations

How to review already posted items

How to create a new bill

How to add accounting items to a bill

How to close a bill against change

Managing group reservations with availability blocks

Availability blocks are used for reserving a certain portion of resource category availability in Mews for a specific group of reservations, as well as the subsequent management of reservations that are created in Mews for such groups.

Creating availability blocks

'How to' use case

API Operations

How to create an availability block

Allocating inventory to an availability block

  • Example: If you wish to reserve 10 units of availability for certain dates, send -10 in the UnitCountAdjustment parameter.

  • Example: Original adjustment was -5 to reserve 5 units of availability for 1st of May. User now wishes to increase inventory for the availability block for that date by 2 (to 7 total). In this case, send adjustment -7 to override the original adjustment.

'How to' use case

API Operations

How to update or amend service availability

Overbooking: Note it is possible to allow overbooking by allocating more inventory than there are resources physically available at the property, e.g. an adjustment of -10 when there are 9 units.

Adding reservations to an availability block

'How to' use case

API Operations

How to push a reservation to Mews

How to place an existing reservation into an availability block

Managing reservations and guests

'How to' use case

API Operations

How to add a guest to a reservation

How to remove a guest from a reservation

Managing availability block inventory and pickup

'How to' use case

API Operations

How to get existing availability blocks

How to listen for changes to reservations

How to delete an availability block

How to remove a reservation from an availability block

Testing your integration

Additional help for working with the demo environment

Help Guides:

,

Availability blocks: The Availabilities array returned by refers to inventory that is available to the general public and therefore does not include inventory that has been reserved for Availability Blocks. Likewise, the array of adjustments are those not associated with Availability Blocks.

In Mews, billing is managed at the customer/guest profile level, instead of being charged to a specific room or reservation. If applicable, create a new company via or find an existing company via and attach the company to both the reservation(s) and the customer bill(s) for more accurate billing and reporting.

Use a customer profile to centrally manage charges and billing related to the company/event. This also allows any additional orders (e.g. F&B spending) to be added via the POS system, if needed. If the relevant customer profile does not already exist in Mews, first use to create a profile.

Mews tip: Make sure that only active profiles exist in Mews.

In order to keep data clean in the Mews system, only mark a profile with the classification when the event management system starts posting charges to the customer profile. Use to mark the profile as a account. Similar to the concept of fake rooms in traditional Property Management Systems that are deleted at the end of an event, remove the classification from the customer profile once the relevant event has concluded, e.g. event ended, all billing settled, and/or the event is canceled. Use the operation to remove the classification. Refer to the section on how to change or remove a value. You can also use to amend other customer profile details.

Should you need to retrieve a list of all customer profiles created within a certain interval, use the operation with the relevant time filters.

One of the expected functions of an Events integration is to push product order items to the correct customer profile in Mews. This can be done using the operation . If the product item that is being posted already exists in Mews, use . If the product is a custom item that does not exist in Mews then use . Note that in order to use , the property must first set up products under an Additional Service. Then, you will need to retrieve the products by calling . To ensure correct reporting, all revenue items posted into Mews using must be associated with their correct accounting category by sending the unique identifier of the accounting category in the request. Information about all the categories configured at each property can be retrieved using .

When using , specify parameter LinkedReservationId in order to link the order to a guest reservation. This will greatly assist the property when using billing automation.

(use LinkedReservationId)

In case payment was taken outside of Mews, or directly in the event management system, use to record the payment items in Mews, so that all accounting items are centralised in Mews for further reporting and/or exporting to the property's accounting system.

Call to review the revenue and payment items that have already been posted to a customer profile. You can then further automate the management of billing/invoicing by creating a specific bill using for a certain group of revenue and payment items. Use to redirect these items to the relevant bill and then use to finalise the financial document.

Attaching a company to a bill: Currently, attaching a company to a bill must be done manually in Mews Operations. If being able to do this via the API is important to your solution, please consider adding your vote to .

First call to add a new block with the relevant parameters. Note the returned availability block Id, which is used as the unique identifier in all interactions with Mews. There is no expectation to create availability blocks and allocate inventory in Mews straight away for events in the early, tentative, stages of a sales cycle. It is up to the integration partner to decide at which stage of an event order to create an availability block and start allocating inventory in Mews.

Now that you have created an availability block, you can allocate capacity for different dates and resource categories, i.e. create room night blocks. Use to push availability adjustments into Mews. Send a negative value for the UnitCountAdjustment parameter and include the aforementioned AvailabilityBlockId in the parameter to reserve units of availability for the availability block you have just created. The availability adjustments must fall within the StartUtc and EndUtc of the availability block.

When a new reservation is created within the event management system, it needs to be synced with Mews, and vice versa. Reservations can be pushed into Mews using the operation. To ensure that the reservations consume availability reserved for the availability block, instead of from the property's overall availability, include AvailabilityBlockId in the when you add reservations into an existing group block. It is also possible to place an existing reservation in Mews into an availability block with the operation, by including AvailabilityBlockId in the . If applicable, you can attach a company to a reservation when calling or .

Availability block capacity: Note that it is currently not possible to exceed the availability block capacity, i.e. the inventory allocated to an availability block through the operation. However, it is possible to add reservations with arrival or departure times that extend beyond the interval in a given availability block (see ). Should there be a need to accommodate more reservations in an availability block, you must first update the adjustments to increase the allocated inventory in that block.

To ensure that the property can further manage individual guests linked to the group reservation, via the integration, use or to assign or unassign guests to rooms.

Terminology: Note that the API uses the term customer rather than guest. The term companion is used to indicate a guest profile linked to a reservation. For an explanation of all terms, see the .

Call to retrieve information about existing availability blocks, as well as all associated reservations and availability adjustments. To avoid the need of regular polling, you can make use of for Service Order events to automatically receive information about reservation creation and reservation updates. Make a note of the AvailabilityBlockId in the reservation object to record pickup of the relevant availability block in your system and in Mews.

When a reservation no longer belongs to the availability block, follow the format described in to remove the AvailabilityBlockId. When an availability block is no longer needed, remove it from Mews by calling . The availability adjustments associated with the availability block will automatically be removed. Note that is it not possible to delete an availability block containing active reservations.

(ServiceOrderUpdated event)

Ensure you follow our general for testing integrations. If you'd like to double-check that you are correctly creating all the reservations you want to retrieve, you can do so by , or using the . To confirm you are relating any product that is not configured in Mews with the correct accounting category, you can review the . If done correctly, the product you've posted will appear under the relevant accounting category.

this feature request
Mews Glossary for Open API users
Usage guidelines
searching for the reservation or related customer profile
Reservation Report
Accounting Report
Availability blocks and reporting in Mews
How to create an accounting category
How to create rates
How to update rates
How to manage rate prices
Managing companions in a reservation
How to manage group billing
Manually add, move, or remove items from open bills
Finding bills and invoices assigned to a company
Create a Paymaster account
Create a company profile
Add bill
Update accounting items
Close bill
General Webhooks
Get all accounting categories
Add bill
Update accounting items
Close bill
Update values
Get service availability
Update service availability
availability update
Get all services
Get service availability
Update service availability
Get service availability
Update service availability
Webhooks
Finance operations
Configuration
Enterprises
Services
Get all rates
Get rate pricing
Get all rates
Get rate pricing
Add availability blocks
availability block parameters
Get all availability blocks
Add availability blocks
Get all availability blocks
Delete availability blocks
Add order
Add order
Add order
Delete availability blocks
Add order
Product order parameters
Item parameters
Product order parameters
Item parameters
Get all countries
Get configuration
Get all tax environments
Get all taxations
Get all languages
Get all currencies
Paymaster
Add customer
Paymaster
Paymaster
Update customer
Paymaster
Paymaster
Update customer
Paymaster
Update customer
Get all customers
Get customer open items
Add customer
Update customer
Update customer
Get all customers
Get customer open items
Get all accounting categories
Add company
Get all companies
Get all companies
Add company
Get all companies
Get all products
Get all products
Get all products
Get all resources
Add reservations
reservations parameters
Update reservations
reservations parameters
Add reservations
Update reservations
Add reservation companion
Delete reservation companion
Update reservation
Add reservations
Update reservations
Add reservation companion
Delete reservation companion
Update reservation