API Operations

This section describes all operations supported by the API, organised here by theme.

Accounts

Operation	Description
Merge accounts	Merges two or more accounts of the same account type together
Update accounts	Updates one or more existing accounts, i.e. customer, company
Upload and link file to account	Uploads a file and links it to the specified account
Get all addresses	Returns all addresses associated with the specified accounts within the enterprise
Add addresses	Adds a new address to the system and assigns it to a specified account
Update addresses	Updates an existing address in the system assigned to a specified account
Delete addresses	Deletes selected addresses
Get all account notes	Returns all the account notes associated with the specified accounts within the chain
Add account notes	Adds new account notes to the system and assigns it to specified accounts
Update account notes	Updates existing account notes
Delete account notes	Deletes selected account notes

Configuration

Operation	Description
Get configuration	Returns configuration of the enterprise and the client
Get all countries	Returns all countries supported by the API
Get all currencies	Returns all currencies supported by the API
Get all tax environments	Returns all tax environments supported by the API
Get all taxations	Returns all taxations supported in tax environments
Get all languages	Returns all languages supported by the API
Get language texts	Returns translations of texts in the specified languages
Get image URLs	Returns URLs of the specified images

Customers

Operation	Description
Get all customers	Returns all customers filtered by identifiers, emails, names and other filters
Search customers	Searches for customers that are active at the moment in the enterprise, e.g. companions of checked-in reservations or paymasters
Get customers open items	Deprecated! Use Get all payments and Get all order items instead.
Add customer	Adds a new customer to the system and returns details of the added customer
Update customer	Updates personal information of a customer
Merge customers	Deprecated! Please use Merge accounts instead.
Add customer file	Attaches the specified file to the customer profile
Get all identity documents	Returns all identity documents for the specified customers
Adds identity documents	Adds new identity documents
Update identity documents	Updates specified identity documents
Delete identity documents	Deletes specified identity documents
Clear identity documents	Deletes all identity documents for the specified customers

Device integration

Operation	Description
Get all devices	Returns all devices in the enterprise
Get all commands	Returns all commands the are still active from the client application point of view
Get all commands by ids	Returns all commands by their identifiers
Add printer command	Adds a new printer command representing printing of the specified document on a printer
Add key cutter command	Adds a new key cutter command representing cutting of a key for the specified reservation
Add payment command	Restricted! Adds a new Mews Payment Terminal command
Update command	Updates state of a command

Enterprises

Operation	Description
Get all enterprises	Returns all enterprises accessible to a supplied access token
Get all companies	Returns all company profiles of the enterprise, possibly filtered by identifiers, names or other filters
Add company	Adds a new company to the enterprise
Update company	Updates information of the company
Delete companies	Deletes selected companies
Get all company contracts	Returns all contracts between the enterprise and other companies
Add company contracts	Adds new company contracts to the enterprise
Update company contracts	Updates selected company contracts
Delete company contracts	Deletes selected company contracts
Get all departments	Returns all departments of an enterprise associated with the connector integration
Get all counters	Returns all counters of an enterprise associated with the connector integration
Get all outlets	Returns all outlets of an enterprise associated with the connector integration
Get all resources	Returns all resources of an enterprise associated with the connector integration
Update resources	Updates details of the resources
Get all resource blocks	Returns all resource blocks (out of order blocks or internal use blocks)
Add resource block	Adds a new resource block to the specified resource for a defined period of time
Delete resource blocks	Removes specified resource blocks from the resources
Add task	Adds a new task to the enterprise, optionally to a specified department
Get all tasks	Returns all tasks of the enterprise, filtered by identifiers or other filters
Get all resource categories	Returns all resource categories of an enterprise associated with the connector integration
Get all resource category assignments	Returns all resource category assignments of an enterprise associated with the connector integration
Get all resource category image assignments	Returns all resource category image assignments of an enterprise associated with the connector integration
Get all resource features	Returns all resource features of an enterprise associated with the connector integration
Get all resource feature assignments	Returns all resource feature assignments of an enterprise associated with the connector integration

Exports

Operation	Description
Get all exports	Restricted! Returns all exports filtered by their unique identifiers
Add export	Restricted! Create a pending export

Finance

Operation	Description
Get all exchange rates	Returns all available exchange rates among currencies of the enterprise
Get all cashiers	Returns all cashiers in the enterprise
Get all cashier transactions	Returns all cashier transactions created within the specified interval
Get all accounting categories	Returns all accounting categories of the enterprise associated with the connector integration
Get all accounting items	Deprecated! Please use Get all payments and Get all order items instead.
Update accounting items	Updates specified accounting item
Get all bills	Returns all bills, possibly filtered by customers, identifiers and other filters
Add bill	Creates new empty bill assigned to specified account
Update bills	Restricted! Updates account assignments of one or more open bills
Delete bill	Removes selected bills
Close bill	Closes a bill so no further modification to it is possibles
Get bill PDF	Creates a PDF version of the specified bill
Get all outlet items	Returns all outlet items of the enterprise that were consumed (posted) or will be consumed within the specified interval
Get all credit cards	Returns all credit cards, possibly filtered by identifiers, customers or other filters
Charge credit card	Creates payment for specified customer credit card and charges the credit card via a gateway
Add tokenized credit card	Adds a new tokenized credit card to the specified customer
Disable gateway credit card	Restricted! Disables a credit card from being used for payments
Get all preauthorizations by customers	Returns all preauthorizations of specified customers
Add credit card payment	Adds a new credit card payment to a bill of the specified customer
Add external payment	Adds a new external payment to a bill of the specified customer
Add alternative payment	Adds a new alternative payment to a specified customer
Get all payments	Returns all payments, filtered by various parameters
Get all payment requests	Returns all payment requests
Add payment requests	Adds new payment requests for specified customers
Cancel payment requests	Cancels specified pending payment requests
Add outlet bills	Adds new outlet bills with their items
Get all order items	Returns all order items
Cancel order items	Restricted! Cancels specified order items
Refund payment	Refunds a specified payment

Loyalty

Operation	Description
Get all loyalty programs	Returns all loyalty programs of the enterprise
Add loyalty programs	Adds new loyalty programs
Update loyalty programs	Updates selected loyalty programs
Delete loyalty programs	Deletes selected loyalty programs
Get all loyalty memberships	Returns all loyalty memberships of the enterprise
Add loyalty memberships	Adds new loyalty memberships
Update loyalty memberships	Updates selected loyalty memberships
Delete loyalty memberships	Deletes selected loyalty memberships
Get all loyalty tiers	Returns all loyalty tiers of the enterprise
Add loyalty tiers	Adds new loyalty tiers
Update loyalty tiers	Updates selected loyalty tiers
Delete loyalty tiers	Deletes selected loyalty tiers

Customer messaging

Operation	Description
Get all message threads	Get all message threads that you have created
Add message thread	Creates a new message thread on behalf of the specified customer
Get all messages	Get all messages belonging to the specified message threads
Add messages	Add the specified messages to the specified message threads

Reservations

Operation	Description
Get all reservations (ver 2023-06-06)	Returns all reservations specified by filters
Get all reservations (ver 2017-04-12)	Deprecated! Please use Get all reservations (ver 2023-06-06) instead.
Get all reservation items	Deprecated! Please use Get all order items instead.
Price reservations	Returns prices of reservations with the specified parameters
Add reservations	Adds the specified reservations as a single group
Update reservations	Updates information about the specified reservations
Confirm reservations	Marks all specified reservations as Confirmed
Start reservation	Marks a reservation as Started (checked in)
Process reservation	Marks a reservation as Processed (checked out)
Cancel reservation	Cancels all reservation with specified identifiers
Update reservation customer	Updates customer of a reservation
Update reservation interval	Updates reservation interval (start, end or both)
Add reservation companion	Adds a customer as a companion to the reservation
Delete reservation companion	Removes customer companionship from the reservation
Add reservation product	Adds a new product order of the specified product to the reservation
Get all source assignments (ver 2024-09-20)	Restricted! Returns all sources associated with a reservation
Get all source assignments	Returns all sources associated with a reservation group
Get all sources	Returns all possible reservation sources
Get all reservation groups	Returns all reservation groups, filtered by unique identifiers and other filters
Get reservations channel manager details	Restricted! Gets requested rate codes for the reservation

Routing rules

Operation	Description
Get all routing rules	Returns all routing rules of the enterprise
Add routing rules	Adds new routing rules
Update routing rules	Updates selected routing rules
Delete routing rules	Deletes selected routing rules

Service orders

Operation	Description
Get all product service orders	Returns all product service orders
Get all service order notes	Returns all notes associated with the given service orders
Add service order notes	Adds service order notes to a given service order
Update service order notes	Updates content of given service order notes
Delete service order notes	Deletes given service order notes

Services

Operation	Description
Get all services	Returns all services offered by the enterprise
Get service availability (ver 2024-01-22)	Restricted! Returns selected availability and occupancy metrics of a bookable service in the specified time interval
Get service availability	Returns availability of a bookable service in the specified interval
Update service availability	Updates the number of available resources in the specified resource category by a certain amount
Get all availability blocks	Returns all availability blocks filtered by services, unique identifiers and other filter
Add availability blocks	Adds availability blocks which are used to group related availability updates
Update availability blocks	Updates information about the specified availability block
Delete availability blocks	Delete availability blocks
Get all availability adjustments	Get all availability adjustments
Get all rules	Returns all rules applied with the reservations
Get all business segments	Returns all business segments of the default service provided by the enterprise
Get all rates	Returns all rates (pricing setups) of the default service provided by the enterprise
Add rates	Adds new rates to the enterprise
Set rates	Restricted! Adds new or updates existing rates
Delete rates	Deletes specified rates
Get rate pricing	Returns prices of a rate in the specified interval
Update rate price	Updates price of a rate in the specified intervals
Get all rate groups	Returns all rate groups filtered by rate groups or other filters
Get all restrictions	Returns all restrictions of the default service provided by the enterprise
Add restrictions	Deprecated! Adds new restrictions with the specified conditions. Use Set restrictions instead.
Delete restrictions	Deprecated! Removes restrictions from the service. Use Clear restrictions instead.
Set restrictions	Adds new restrictions with the specified conditions
Clear restrictions	Clears restrictions which meet specified conditions over a specified time interval
Add order	Creates a new order with the specified products and items
Get all companionships	Returns all companionships based on customers, reservations or reservation groups
Get all resource access tokens	Returns all resource access tokens based on resource access tokens, reservations or interval
Add resource access tokens	Adds new resource access tokens with the specified data
Update resource access tokens	Updates resource access token validity intervals and permissions
Delete resource access tokens	Delete specified resource access tokens
Get all vouchers	Returns all rate vouchers filtered by service, voucher code or voucher identifier
Add vouchers	Adds new vouchers with the specified data
Update vouchers	Updates information about the specified vouchers
Delete vouchers	Delete vouchers
Get all voucher codes	Returns all voucher codes filtered by voucher or other filters
Add voucher codes	Adds new voucher codes to the voucher
Delete voucher codes	Delete voucher codes
Get all age categories	Returns all age categories filtered by service
Get all cancellation policies	Restricted! Returns all cancellation policies filtered by services, rate groups and other filters
Get cancellation policies by reservations	Restricted! Returns cancellation policies for enterprise grouped by reservation
Get cancellation policies by rates	Restricted! Returns cancellation policies for enterprise grouped by rate
Get all products	Returns all products filtered by services or product identifier
Delete products	Deletes specified products
Get product pricing	Restricted! Returns prices for a product for a specified time interval
Update product pricing	Updates product price for a given interval
Get all product categories	Returns all products filtered by services or product category identifier
Get all service overbooking limits	Restricted! Returns all service overbooking limits
Set service overbooking limits	Restricted! Adds new service overbooking limits with the specified conditions
Clear service overbooking limits	Restricted! Clears service overbooking limits which meet specified conditions over a specified time interval