'How to' use cases

This page summarises all of our 'how to' use cases, together with the main use cases in which they are referenced. Search here for the task you want to perform with the API, it will take you to the appropriate API Operation or API Operations, and also link to higher level use cases for context and further information.

Can't find what you're looking for? 'How to' use cases are expressed in common terminology, but often different terms are used to mean the same thing. Try searching using alternative terms. We created the Mews Glossary for Open API users to explain the particular terminology used in Mews. If you still can't find what you're looking for, contact support.

Configuration

'How to' use case	API Operations	Use cases
How to get enterprise or property configuration	Get configuration	Events, Kiosk
How to get the list of supported countries	Get all countries	Events
How to get the list of supported currencies	Get all currencies	Events
How to get the list of supported languages	Get all languages	Events, Kiosk
How to get applicable tax rates	Get all tax environments, Get all taxations	Events
How to get editable history window	Get configuration	Accounting

Finance

'How to' use case	API Operations	Use cases
How to get configured accounting categories	Get all accounting categories	Accounting, Events, Point of sale
How to get the list of accounting categories	Get all accounting categories	Upsell, Guest technology, Kiosk
How to add accounting items to a bill	Update accounting items	Events
How to move bill items to a new bill	Update accounting items	Kiosk
How to get accounting items consumed over a period	Get all payments, Get all order items	Accounting
How to get payment items paid over a period	Get all payments	Accounting
How to get order items consumed over a period	Get all order items	Accounting
How to get a list of revenue items for a reservation	Get all order items	Accounting
How to get order items linked to a reservation	Get all order items	Revenue management
How to find the original order item for a rebate item	Get all order items	Accounting
How to get outlet items consumed over a period	Get all outlet items	Accounting
How to get bills and invoices	Get all bills	Accounting
How to get the customer or guest bill	Get all bills	Kiosk
How to create a new bill	Add bill	Events, Kiosk
How to close a bill against change	Close bill	Events, Kiosk
How to get a printable bill	Get bill PDF	Kiosk
How to charge a guest credit card using Mews Payments	Charge credit card	Kiosk, Payment automation
How to add a credit card to the guest profile	Add tokenized credit card	Kiosk
How to get details of stored credit cards	Get all credit cards	Kiosk, Payment automation
How to check if a credit card is stored against a guest profile	Get all credit cards	Kiosk, Payment automation
How to record a general external payment	Add external payment	Kiosk
How to record an alternative external payment	Add alternative payment	Kiosk
How to post end-of-day accounting items	Add outlet bill	Point of sale
How to get payouts over a period	Get all payouts	Accounting
How to break a payout down into its transactions	Get all payout transactions	Accounting

Allowances

'How to' use case	API Operations	Use cases
How to get all order items for a reservation (including allowance items)	Get all order items (use ServiceOrderIds)	Allowances
How to get allowance discount items	Get all order items (use Types with AllowanceDiscount)	Allowances
How to get breakage items for reconciliation	Get all order items (use Types with AllowanceBreakage and AllowanceContraBreakage)	Allowances
How to get all allowance-related items on a bill	Get all order items (use BillIds)	Allowances
How to get allowance items over a period	Get all order items (use ClosedUtc or ConsumedUtc)	Allowances
How to identify allowance product items among order items	Get all order items (check Data.Product.ProductType = Allowance)	Allowances
How to find the original charge for an allowance discount	Get all order items (use OrderItemIds with DiscountedOrderItemId)	Allowances
How to find which allowance funded a discount	Get all order items (use OrderItemIds with AllowanceProductOrderItemId)	Allowances
How to find which allowance generated a breakage item	Get all order items (use OrderItemIds with AllowanceProductOrderItemId from breakage item's Data)	Allowances
How to post a charge that triggers an allowance discount	Add order	Allowances
How to post a custom item against an allowance	Add order (use Items with AccountingCategoryId)	Allowances
How to post an existing Mews product against an allowance	Add order (use ProductOrders)	Allowances

Enterprises & Resources

'How to' use case	API Operations	Use cases
How to get configured rooms and spaces	Get all resources	Point of sale, Housekeeping, Events
How to get resource categories or room types	Get all resources	Kiosk
How to update the state of a resource or room	Update resources	Housekeeping
How to get resource blocks (out of order, etc.)	Get all resource blocks	Kiosk, Housekeeping
How to get information about out-of-order blocks	Get all resource blocks	Revenue management
How to add a resource block	Add resource block	Housekeeping
How to delete resource blocks	Delete resource blocks	Housekeeping
How to get the configured outlets	Get all outlets	Point of sale
How to get company profiles	Get all companies	Events
How to find an existing company	Get all companies	Events
How to add a new company	Add company	Events
How to get information about departments	Get all departments	Housekeeping
How to get the list of staff tasks	Get all tasks	Housekeeping
How to add a staff task	Add task	Housekeeping
How to create staff reminders	Add task	Upsell

Customer Profiles

'How to' use case	API Operations	Use cases
How to create a customer or guest profile	Add customer	Kiosk
How to update a customer or guest profile	Update customer	Kiosk, Reputation management
How to create a Paymaster profile	Add customer	Events
How to update a profile to be a Paymaster	Update customer	Events
How to remove the Paymaster classification	Update customer	Events
How to get a list of profiles created over a period of time	Get all customers	Events
How to get checked in and checked out guests	Get all customers	Upsell
How to search for a customer or guest	Search customers	Point of sale
How to get only checked in guests	Search customers	Upsell
How to review already posted items	Get all payments, Get all order items	Events
How to get the list of open revenue items for a guest	Get all payments, Get all order items	Kiosk

Reservations

'How to' use case	API Operations	Use cases
How to listen for changes to reservations	General Webhooks (ServiceOrderUpdated event) or WebSockets (Reservation event)	Guest technology, Customer management, Housekeeping, Reputation management, Revenue management, Events
How to get reservation and customer details	Get all reservations	Guest technology, Customer management, Housekeeping
How to get reservation details	Get all reservations	Revenue management
How to get reservations updated over a time period	Get all reservations	Customer management
How to look up a guest reservation	Get all reservations	Kiosk
How to get checked-out reservations	Get all reservations	Reputation management
How to get historical reservations data	Get all reservations	Revenue management
How to get a specific reservation	Get all reservations	Upsell
How to update the details of a reservation	Update reservations	Kiosk
How to add a guest to a reservation	Add reservation companion	Kiosk, Events
How to remove a guest from a reservation	Delete reservation companion	Kiosk, Events
How to change the reservation owner	Update reservation customer	Kiosk
How to modify the date or time of a reservation	Update reservation interval	Kiosk
How to check in a guest reservation	Start reservation	Kiosk
How to check out a guest reservation	Process reservation	Kiosk
How to add a product to a reservation	Add reservation product	Kiosk
How to add a product order to a reservation	Add reservation product	Upsell
How to push a reservation to Mews	Add reservations	Events
How to make a new booking	Add reservations	Kiosk
How to place an existing reservation into an availability block	Update reservations	Events
How to remove a reservation from an availability block	Update reservation	Events
How to price a specific reservation	Price reservations	Kiosk

Data Export

'How to' use case	API Operations	Use cases
How to create a bulk data export	Add export	Data export, Revenue management
How to check on data export progress	Get all exports	Data export, Revenue management

Services & Products

'How to' use case	API Operations	Use cases
How to get the list of property services	Get all services	Guest technology
How to get the list of services offered	Get all services	Events, Upsell, Point of sale
How to get the list of products linked to services	Get all products	Events, Upsell
How to get the list of available products	Get all products	Events
How to get configured rates	Get all rates	Revenue management, Kiosk, Events
How to get configured rate groups	Get all rate groups	Revenue management
How to get rate pricing	Get rate pricing	Kiosk
How to get the price for a given rate	Get rate pricing	Events
How to get the price for a specific rate and time period	Get rate pricing	Revenue management
How to listen for changes to rate prices	WebSockets (PriceUpdate event)	Revenue management
How to get rate package rules	Get all rules	Kiosk
How to get all configured business segments	Get all business segments	Revenue management
How to get service restrictions	Get all restrictions	Revenue management
How to add or remove restrictions	Set restrictions, Clear restrictions	Revenue management
How to get availability	Get service availability	Events, Kiosk
How to get room or resource availability	Get service availability	Upsell
How to update or amend service availability	Update service availability	Events
How to post an order for a guest	Add order	Kiosk
How to post an order item to a guest profile	Add order	Guest technology
How to add a product order item to a customer profile	Add order	Events
How to add a product order to a guest profile	Add order	Upsell
How to post a charge to a customer profile	Add order	Point of sale
How to link an order to a reservation	Add order (use LinkedReservationId)	Events, Kiosk, Guest technology, Upsell, Point of sale, Allowances

Availability Blocks

'How to' use case	API Operations	Use cases
How to create an availability block	Add availability blocks	Events
How to get existing availability blocks	Get all availability blocks	Events
How to delete an availability block	Delete availability blocks	Events
How to place an existing reservation into an availability block	Update reservations	Events
How to remove a reservation from an availability block	Update reservation	Events

What is an Availability Block? Availability Blocks are fixed sets of inventory (rooms, spaces or resources) that are provisionally removed from public availability for use by private groups such as wedding parties, or for companies or travel agencies. For more information, see our Help Guide Creating availability blocks.

Customer Loyalty

'How to' use case	API Operations	Use cases
How to add a Loyalty Program	Add loyalty programs	Customer loyalty
How to get a list of Loyalty Programs	Get all loyalty programs	Customer loyalty
How to get the Chain identifier for a property	Get configuration	Customer loyalty
How to update a Loyalty Program	Update loyalty programs	Customer loyalty
How to delete a Loyalty Program	Delete loyalty programs	Customer loyalty
How to add a Loyalty Tier	Add loyalty tiers	Customer loyalty
How to get a list of Loyalty Tiers	Get all loyalty tiers	Customer loyalty
How to update a Loyalty Tier	Update loyalty tiers	Customer loyalty
How to delete a Loyalty Tier	Delete loyalty tiers	Customer loyalty
How to add a Loyalty Membership	Add loyalty memberships	Customer loyalty
How to get a list of Loyalty Memberships	Get all loyalty memberships	Customer loyalty
How to update a Loyalty Membership	Update loyalty memberships	Customer loyalty
How to delete a Loyalty Membership	Delete loyalty memberships	Customer loyalty

Customer Messaging

'How to' use case	API Operations	Use cases
How to get your message threads	Get all message threads	Customer messaging
How to get messages for your message threads	Get all messages	Customer messaging
How to create a new message thread	Add message thread	Customer messaging
How to create a new message within a thread	Add messages	Customer messaging
How to listen for new customer messages	General Webhooks (MessageAdded event)	Customer messaging

Device Commands

'How to' use case	API Operations	Use cases
How to listen for new device commands	WebSockets	Device integration
How to get details of a device command	Get all commands by ids	Device integration
How to get all unprocessed device commands	Get all commands	Device integration
How to update the state of a device command	Update command	Device integration

What is a Device Command? Device Commands are messages sent by Mews to on-premise devices such as printers and key encoders. For more information, see the Device integration use case.