'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, let us know.
Configuration
'How to' use case
API Operations
Use cases
How to get enterprise or property configuration
How to get the list of supported countries
How to get the list of supported currencies
How to get the list of supported languages
How to get applicable tax rates
How to get editable history window
Finance
'How to' use case
API Operations
Use cases
How to get configured accounting categories
How to get the list of accounting categories
How to add accounting items to a bill
How to move bill items to a new bill
How to get accounting items consumed over a period
How to get payment items paid over a period
How to get order items consumed over a period
How to get a list of revenue items for a reservation
How to get order items linked to a reservation
How to find the original order item for a rebate item
How to get outlet items consumed over a period
How to get bills and invoices
How to get the customer or guest bill
How to create a new bill
How to close a bill against change
How to get a printable bill
How to charge a guest credit card using Mews Payments
How to add a credit card to the guest profile
How to get details of stored credit cards
How to check if a credit card is stored against a guest profile
How to get the merchant ID for the Mews Payment Gateway
How to record an external card payment
How to record a general external payment
How to record an alternative external payment
How to post end-of-day accounting items
Enterprises & Resources
'How to' use case
API Operations
Use cases
How to get configured rooms and spaces
How to get resource categories or room types
How to update the state of a resource or room
How to get resource blocks (out of order, etc.)
How to get information about out-of-order blocks
How to add a resource block
How to delete resource blocks
How to get the configured outlets
How to get company profiles
How to find an existing company
How to add a new company
How to get information about departments
How to get the list of staff tasks
How to add a staff task
How to create staff reminders
Customer Profiles
'How to' use case
API Operations
Use cases
How to create a customer or guest profile
How to update a customer or guest profile
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
How to get checked in and checked out guests
How to search for a customer or guest
How to get only checked in guests
How to review already posted items
How to get the list of open revenue items for a guest
Reservations
'How to' use case
API Operations
Use cases
How to listen for changes to reservations
How to get reservation and customer details
How to get reservation details
How to get reservations updated over a time period
How to look up a guest reservation
How to get checked-out reservations
How to get historical reservations data
How to get a specific reservation
How to update the details of a reservation
How to add a guest to a reservation
How to remove a guest from a reservation
How to change the reservation owner
How to modify the date or time of a reservation
How to check in a guest reservation
How to check out a guest reservation
How to add a product to a reservation
How to add a product order to a reservation
How to push a reservation to Mews
How to make a new booking
How to place an existing reservation into an availability block
How to remove a reservation from an availability block
How to price a specific reservation
Data Export
'How to' use case
API Operations
Use cases
How to create a bulk data export
How to check on data export progress
Services & Products
'How to' use case
API Operations
Use cases
How to get the list of property services
How to get the list of services offered
How to get the list of products linked to services
How to get the list of available products
How to get configured rates
How to get configured rate groups
How to get rate pricing
How to get the price for a given rate
How to get the price for a specific rate and time period
How to listen for changes to rate prices
How to get rate package rules
How to get all configured business segments
How to get service restrictions
How to add or remove restrictions (old)
How to add or remove restrictions (new)
How to get availability
How to get room or resource availability
How to update or amend service availability
How to post an order for a guest
How to post an order item to a guest profile
How to add a product order item to a customer profile
How to add a product order to a guest profile
How to post a charge to a customer profile
Availability Blocks
'How to' use case
API Operations
Use cases
How to create an availability block
How to get existing availability blocks
How to delete an availability block
How to place an existing reservation into an availability block
How to remove a reservation from an availability block
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
How to get a list of Loyalty Programs
How to get the Chain identifier for a property
How to update a Loyalty Program
How to delete a Loyalty Program
How to add a Loyalty Tier
How to get a list of Loyalty Tiers
How to update a Loyalty Tier
How to delete a Loyalty Tier
How to add a Loyalty Membership
How to get a list of Loyalty Memberships
How to update a Loyalty Membership
How to delete a Loyalty Membership
Customer Messaging
'How to' use case
API Operations
Use cases
How to get your message threads
How to get messages for your message threads
How to create a new message thread
How to create a new message within a thread
How to listen for new customer messages
Device Commands
'How to' use case
API Operations
Use cases
How to listen for new device commands
How to get details of a device command
How to get all unprocessed device commands
How to update the state of a device command
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.
Last updated
Was this helpful?