These are the operations that we will deprecate in 2021. While we are not yet enforcing these changes, and are yet to finalise a date for these deprecations, we strongly advise you to review these and if you are using them in your API calls, to update them accordingly.
Following legacy operations to be completely removed:
companies/getAllByName(replaced by Get all companies)bills/getAllByIds(replaced by Get all bills)bills/getAllByCustomers(replaced by Get all bills)bills/getAllClosed(replaced by Get all bills)creditCards/getAllByIds(replaced by Get all credit cards)creditCards/getAllByCustomers(replaced by Get all credit cards)reservations/getAllByIds(replaced by Get all reservations)reservations/getAllByCustomers(replaced by Get all reservations)reservations/getAllByNumbers(replaced by Get all reservations)customers/getAllByIds(replaced by Get all customers)customers/getAllByEmails(replaced by Get all customers)customers/getAllByName(replaced by Get all customers)
Properties TimeFilter, StartUtc and EndUtc to be removed on operations:
- Get all customers
- Get all bills
- Get all companies
- Get all restrictions
- Get all outlet items
- Get all cashier transactions
Use properties CreatedUtc, UpdatedUtc, etc. as per operation description.
Following properties to be removed from output and/or ignored on input:
| Object | Property | Replaced by |
|---|---|---|
| Company | TaxIdentificationNumber |
TaxIdentifier |
| Reservation | ChannelManagerId |
ChannelManagerNumber |
| Reservation | TimeUnitCost |
TimeUnitPrices |
| Reservation | TraveAgencyId |
TravelAgencyId |
| Reservation | ApplyCancelationFee |
ApplyCancellationFee |
| Reservation | CompanionIds |
Operation Get all companionships |
| Reservation price | Total |
TotalAmount |
| Customer | Gender |
Sex |
| Customer | BirthDateUtc |
BirthDate |
| Customer | CategoryId |
--- |
| Customer | Passport |
Document object in Documents part of response |
| Customer | IdentityCard |
Document object in Documents part of response |
| Customer | Visa |
Document object in Documents part of response |
| Customer | DriversLicense |
Document object in Documents part of response |
| Document | ExpirationUtc |
Expiration |
| Document | IssuanceUtc |
Issuance |
| Currency value | Net |
--- |
| Currency value | Tax |
--- |
| Currency value | TaxRate |
--- |
Whole UnitCost object |
--- | Amount |
Changed Websocket authentication from being passed via URL query parameters to cookies.
- Added new type
ResourceUpdatedof webhook Event.
- For demo environment, platform URL changed to
https://api.mews-demo.com. - For demo environment, web socket URL changed to
wss://ws.mews-demo.com.
- Removed obsolete property
CompanionIdsfrom Reservation surpassed by operation Get all companionships.
- Added Get all resource access tokens, Add resource access tokens, Update resource access tokens, Delete resource access tokens.
- Added Add availability blocks, Delete availability blocks.
- Extended Update service availability with
AvailabilityBlockId. - Split Get all tax environments and Get all taxations.
- Extended Tax Rate discriminator with
Dependent.
- Specified limitations on operation parameters (generally 1000 items in collection and maximum time filter length of 3 months).
- Changed the websocket authentication method to use cookies instead of URL query parameters.
- Extended Space resource data with
LocationNotes. - Extended Space resource data update with
LocationNotes.
- Added Request limits and Taxations to Guidelines
- Extended operation Get all customers with property
LoyaltyCodes.
- Added operation Get all vouchers and extended Reservation with property
VoucherId.
- Extended response of operation Get all tax environments with validity interval of taxation.
- Extended response of operation Get all rates with property
IsEnabledspecifying the rate is currently available to customers. - Extended operation Update reservation with parameter
AssignedResourceLocked. - Extended operation Get service availability with list of active availability adjustments.
- Added operation Update service availability.
- Replaced
Genderproperty withSexfor operations Add customer, Update customer, Get all customers, Search customers and Get all reservations and all other usages.
- Extended operations Add reservations, Add reservation product and Add order with possibility to specify consumption date for products charged
OnceandPer Person.
- Replaced Space websocket event by Resource event
- Extended Reservation event with
AssignedResourceId - Extended Price update event with
ResourceCategoryId
- Added new operation Get all rules.
- Added new operation Add alternative payment.
- Extended operation Get all accounting items with filter
ItemIdsand response withSubState.
- Extended Travel agency contract with
ServiceId. - Extended Bill object with Bill assignee data.
- Extended Promotions object with
DuringCheckOutproperty. - Extended Resource with
CreatedUtcandUpdatedUtc. - Extended Resource category assignment with
Id,IsActive,CreatedUtcandUpdatedUtc. - Extended Resource category image assignment with
Id,IsActive,CreatedUtcandUpdatedUtc. - Extended Resource feature assignment with
Id,IsActive,CreatedUtcandUpdatedUtc.
- Fixed spelling mistake in parameter
TravelAgencyIdin operation Update reservation. - Extended operations Get all products with property
ExternalName. - Extended Get configuration response with Service.
- Extended Integration created data with Service.
- Extended Product order parameters with consumption dates.
- Added new operations Update accounting items, Add bill and Delete bill.
- Added new operations Get all counters, Close bill, Get bill PDF
- Extended operations Get all products with property
ExternalName. - Extended operations Add customer and Update customer with optional parameters
ItalianFiscalCodeandItalianDestinationCode. - Removed value of Tax rate.
- Fixed filtering by
ReservationIdsin Get all reservations operation.
A month ago we announced the project Spacetime whose main objective is to generalize the notion of services and spaces. And later, also the time units. We're pleased to announce that the first phase is now available in the Connector API. We are generalizing spaces into resources, we're introducing the possibility to have multiple "visit" services, not just a single one. The resources might be offered via multiple services which also means that a few entities like rates, restrictions or resource features are no longer defined on enterprise level, they're defined on service level and apply only to specified service.
There are no immediate breaking changes in the API, all of the previous endpoints and capabilities are still working and will be working until the end of the deprecation period which is scheduled for 15 Jan 2021.
However we'd like to ask you to update your clients as soon as possible, we're not able to roll out the new possibilities to our clients if you are not ready. Therefore we rely on you and your timely cooperation because we want to give this new opportunity to the hotels as soon as we can. We acknowledge it's a lot of changes, we're prepared to monitor the situation and help you with any questions or concerns, feel free to contact us at integrations@mews.com.
- Added Resource that is replacing the Space. It can have multiple categories through multiple services. Note that Resource does not need to be assigned to any category.
- Added Resource category that is replacing the Space category.
- Added Resource category image assignment that links an image to a category.
- Added Resource category assignment that links a resource to a category. Note that resource can be assigned only to a single category within the same service.
- Added Resource feature that is replacing the Space feature and now is within the service context.
- Added Resource feature assignment that is replacing the Space feature assignment.
- Added Resource block that is replacing the Space block. Note that a resource without any category can be assigned to a block.
- Added Get all resources that is replacing Get all spaces.
- Added Update resources.
- Added Get all resource blocks that is replacing Get all space blocks.
- Added Add resource blocks that is replacing Add space block.
- Added Delete resource blocks that is replacing Delete space blocks.
- Extended Get all reservations parameters with required
ServiceIdsandAssignedResourceIdsthat is replacingSpaceIds. - Extended Get all reservations response with
Resources,ResourceCategoriesthat is replacingSpaces,SpaceCategoriesandResourceCategoryAssignments. - Extended Reservation extent with
ResourceCategories,ResourceCategoryAssignmentsandResourcesthat is replacing theSpaces. - Extended Reservation with
AssignedResourceIdandAssignedResourceLockedthat is replacingAssignedSpaceIdandAssignedSpaceLocked. - Extended Update reservation parameters with
AssignedResourceIdthat is replacing Update reservation space. - Extended Search customers parameters with
ResourceIdthat is replacingSpaceId. - Extended Get all business segments parameters with required
ServiceIds. - Extended Get all rates parameters with required
ServiceIds. - Extended Get all restrictions parameters with required
ServiceIdsandResourceCategoryIdsthat is replacingSpaceCategoryIds. - Extended Add restrictions parameters with required
ServiceId. - Extended Restriction with
ServiceIdandResourceCategoryId,ResourceCategoryTypethat is replacingSpaceCategoryId,SpaceType. - Extended Restriction conditions with
ResourceCategoryId,ResourceCategoryTypethat is replacingSpaceCategoryId,SpaceType, - Extended Business segment with
ServiceId. - Extended Rate with
ServiceId. - Extended Rate group with
ServiceId. - Renamed
Space category availabilityto Resource category availability. - Renamed
Space category pricingto Resource category pricing. - Renamed
Space category adjustmentto Resource category adjustment. - Removed
Update space statewhich is replaced by general Update resources. - Removed
Update reservation requested category. Update reservation should be used instead.
- Extended Add restrictions and Get all restrictions parameters with
ExternalIdentifier. - Extended Get all reservations parameters with
ReservationIds,GroupIds,CustomerIds,SpaceIds,RateIds,BusinessSegmentIdsandNumbers. - Updated Add reservations, Update reservation, Confirm reservation and Cancel reservation by allowing an array of reservations to be specified in each request.
- Extended Get all tax environments with new
Discriminatorto allow bothFlatandRelativeTax rate strategy. - Extents changed from optional to required for Space extent, Accounting item extent, Bill extent, Rate extent and Companionship extent.
- Added Webhooks.
- Extended Add company parameters with
InvoiceDueInterval,Telephone,ContactPerson,Contact,NotesandIata. - Extended Update company parameters with
InvoiceDueInterval,Telephone,ContactPerson,Contact,NotesandIata. - Extended Get all cashier transactions parameters with
CreatedUtc. - Extended Get all outlet items parameters with
ClosedUtcandConsumedUtc. - Extended Get all restrictions parameters with
CollidingUtc,CreatedUtcandUpdatedUtc. - Extended Get all space blocks parameters with
CollidingUtc,CreatedUtcandUpdatedUtc. - Added Get all tasks.
- Extended Get all customers with
CustomerIds,Emails,FirstNames,LastNames,CreatedUtc,UpdatedUtc,Extent.
- Updated Update rate price operation to accept only updates for the future for up to 5 years.
- Extended Get all bills parameters with
ClosedUtc,CreatedUtc,DueDateUtcandPaidUtc. - Updated Add reservations parameters with
Enquiredstate. - Added Address parameters.
- Extended Address with
LatitudeandLongitude.
- Extended Get all reservation items with
AccountingStates.
- Extended Get all products result with
Classifications.
- Extended Add task parameters with
ServiceOrderId.
- Extended Get all companies parameters with
Ids,Names,CreatedUtcandUpdatedUtc.
- Added Get all credit cards operation.
- Extended Add reservations parameters with
CreditCardId. - Extended Update Reservation parameters with
CreditCardId.
- Added Delete space blocks operation.
- Extended Product with
Posting.
- Added Add tokenized credit card operation.
- Extended Get configuration with PaymentCardStorage.
- Added Update company operation.
- Added Add space block operation.
- Extended Customer with
BillingCodeandAccountingCode.
- Extended Bill with
TaxedUtc.
- Extended Request body with
Client.
- Added Get all companionships operation.
- Added Get all bills operation.
- Extended websocket events with Price update event.
- Extended Get all restrictions parameters with
StartUtc,EndUtc,TimeFilter,SpaceCategoryIdsandRateIds.
- Extended Add reservations parameters with
BookerId. - Extended Update Reservation parameters with
BookerId.
- Extended External payment type with
Invoice,WireTransferandBacs.
- Extended Add reservations parameters with
TimeUnitPrices. - Extended Update Reservation parameters with
TimeUnitPrices.
- Added Get all tax environments operation.
- Added Amount.
- Added Amount Parameters.
- Extended Fiscal machine command data with
FiscalMachineDataandApiUrl. - Extended Get all accounting items response with
SubType. - Extended Enterprise with
Pricing.
- Added Update Reservation operation.
- Extended Add reservations parameters with
GroupName.
- Added Add Company operation.
- Extended Add Customer parameters with
CarRegistrationNumberandTaxIdentificationNumber. - Extended Update Customer parameters with
CarRegistrationNumberandTaxIdentificationNumber. - Extended Confirm reservation parameters with
SendConfirmationEmail. - Extended Get all accounting items parameters with
States. - Extended Reservation extent with
AccountingStates. - Extended Get rate pricing response with
RelativeAdjustment,AbsoluteAdjustment,EmptyUnitAdjustmentandExtraUnitAdjustment.
- Added Get all reservations by numbers operation.
- Extended Add reservations parameters with
SendConfirmationEmail.
- Extended Add restriction parameters with
Identifier. - Extended Company with
BillingCode.
- Extended Get all space blocks parameters with
Extent. - Extended Space block with
IsActive.
- Added Get all restrictions operation.
- Added Add restrictions operation.
- Added Delete restrictions operation.
- Extended Company with
IsActive.
- Extended Add reservations parameters with
CompanyId.
- Added Charge credit card operation.
- Added Get all companies by name operation.
- Extended Add customer parameters with
Options. - Extended Update customer parameters with
Options.
- Extended Bill with
VariableSymbol.
- Extended Add reservations parameters with
TravelAgencyId.
- Extended Add reservations parameters with
TimeUnitCost.
- Extended Reservation extent with
QrCodeData. - Extended Space feature with
Names,ShortName,ShortNamesandDescriptions.
- Extended Add credit card payments parameters with
AccountingCategoryId. - Extended Add external payment parameters with
AccountingCategoryId. - Extended Add outlet bills parameters with
AccountingCategoryId. - Extended Add order parameters with
AccountingCategoryId.
- Extended Reservation event with
AssignedSpaceId. - Extended Service with
Type.
- Extended Space category with
ExtraUnitCount.
- Extended Add reservations parameters with
GroupId. - Extended Payment terminal command data with
PaymentTerminalData. - Added Confirm reservation operation.
- Extended Get all countries response with
CountrySubdivisionsandCountryAlliances. - Extended Get all space blocks parameters with
TimeFilter. - Extended Get all accounting items parameters with
Extentand response withCreditCardTransactions. - Extended Key cutter command data with
Email.
- Extended Add reservations parameters with
CheckOverbooking. - Added Get all outlet items operation.
- Extended Add reservations parameters with
CheckRateApplicability.
- Added Get all customers by name operation.
- Extended Get all reservations with possibility to retrieve notes.
- Added Get all outlets operation.
- Added Add outlet bills operation.
- Extended Bill with
CounterId. - Extended Key cutter command data with
TelephoneandReservationNumber. - Extended Space category with
Names,ShortNamesandDescriptions.
- Mimimal required TLS version updated to
TLS 1.2.
- Extended request Body with optional
LanguageandCulture. - Extended Accounting item with
CreditCardId. - Extended Update reservation requested category with
Overbook. - Extended Add reservation product with
UnitCost. - Extended Product charging with
PerPerson. - Updated
Expirationin Credit card parameters to be optional. - Added Get all credit cards by ids operation.
- Added Get all credit cards by customers operation.
- Extended Company with
TaxIdentifier,TaxIdentificationNumberis deprecated. - Extended Product with
CategoryId. - Extended Company with
AccountingCode. - Extended Add customer and Update customer with
Identity card,VisaandDrivers license. - Added Update reservation customer operation.
- Added Get all preauthorizations by customers operation.
- Extended Customer with
Options.
- Extended Company with
AdditionalTaxIdentifier.
- Added Get all commands by ids operation.
- Extended and generalized Rate restrictions.
- Extended Command event with
State. - Extended Reservation event with
State,StartUtc,EndUtc. - Extended Space event with
State.
- Extended Enterprise with
ChainId,DefaultLanguageCode,LegalEnvironmentCode,LogoImageIdandCoverImageId. - Extended Language with
FallbackLanguageCode. - Extended Customer with
TaxIdentificationCode. - Extended Accounting item with
ClosedUtc. - Extended Product with
Description. - Extended Space and Space category with
IsActive. - Extended Space extent with
Inactive. - Extended Update rate price with possibility to remove adjustments (using unspecified
Value). - Extended Get rate pricing response with
CategoryAdjustments. - Extended websocket events with Space event.
- Added Get all bills by customers operation.
- Extended
Product order parameterswithUnitCost. - Extended parameters of
Get all accounting itemswithTimeFilter. - Added
Get all bills by idsoperation. - Added
Get all customers by emailsoperation.
- Extended
Accounting itemwithInvoiceId. - Extended
Space categorywithDescriptionandImageIds. - Extended
CustomerwithNotes. - Extended
Key cutter command datawithReservationId. - Extended parameters of
Add customerandUpdate customerwithClassificationsandNotes. - Extended parameters of
Add reservationswithIdentifier. - Added
Get all reservations by customersoperation. - Added
Price reservationsoperation. - Added
Add customer fileoperation. - Added
Get image URLsoperation.
- Extended
ReservationwithOrigin. - Extended
EnterprisewithCurrencies. - Extended
SpacewithFloorNumberandBuildingNumber. - Added
Get all countriesoperation. - Added
Get all currenciesoperation. - Added
Get all exchange ratesoperation. - Made
Typein parameters ofAdd external paymentoptional.
- Extended
CompanywithAddress. - Extended
Space categorywithUnitCount. - Extended parameters of
Add reservationswithState. - Added
Add printer commandoperation. - Added
Add key cutter commandoperation. - Added
Get all devicesoperation.
- Extended
EnterprisewithEmailandPhone. - Extended parameters of
Get all reservations by idswithExtent. - Added
Add external paymentoperation.
- Extended
CompanywithIdentifierandElectronicInvoiceIdentifier. - Extended
RatewithIsPublic. - Extended
EnterprisewithTimeZoneIdentifier. - Added
Get all departmentsoperation.
- Extended
CustomerwithNumber.
- Renamed
Charge CustomertoAdd order, the old endpoint still works. - Extended parameters of
Add orderwithProductOrders. - Extended
BillwithCustomerId,CompanyIdandDueUtc. - Extended
EnterprisewithCreatedUtc,EditableHistoryInterval. - Extended
ProductwithPrice. - Extended
Key cutter command datawithKeyCutterData. - Added
Passport scanner command data.
- Added
Get all company contractsoperation. - Added
Get all cashiersoperation. - Added
Get all cashier transactionsoperation.
- Added
Get service availabilityoperation. - Added
Add reservationsoperation. - Extended
CompanywithTaxIdentificationNumber. - Extended
Accounting itemwithCustomerId. - Extended parameters of
Add customerwithOverwriteExistingand updated behaviour to return error in case of duplicate customer, unlessOverwriteExistingis set totrue. - Updated behaviour of
Update customerto return error in case of duplicate customer.
- Extended
CustomerwithLoyaltyCodeand added it as a parameter to theAdd customerandUpdate customer. - Added
Get all closed billsoperation. - Extended
billwithType. - Extended
Key cutter command datawithKeyCount. - Added
Merge customersoperation. - Extended
EnterprisewithWebsiteUrlandAddress. - Extended
Currency valuewithNet.
- Added
Fiscal machine command data.
- Added optional
ConsumptionUtcparameter toCharge customeroperation. - Extended response of
Get Rate Pricingoperation withCurrency. - Added
ClassificationstoCustomer. - Added
OrderingtoSpace category. - Added
CancelledUtctoReservation. - Added optional
AllowOpenBalanceandNotesparameters toProcess Reservationoperation. - Extended websocket events with
Reservation event.
- Extended
ReservationwithAssignedSpaceLocked. - Added
Rate ExtenttoGet All Rates, addedRate Restrictionsto the result. - Added
Space ExtenttoGet All Spaces, added andSpace Features andSpace Feature Assignments to the result. - Added
Update Reservation Intervaloperation. - Added optional
ServiceIdparameter toCharge Customeroperation, so any service can be charged. - Added
PromotionstoServiceandProduct. - Extended
CustomerwithSecondLastNameand added it as a parameter to theAdd CustomerandUpdate Customer.
- Introduced
Websocketsand first use case for command events.
- Deprecated
BirthDateUtconCustomerand inUpdate Customerparameters.BirthDatewithout time specified should be used instead. - Deprecated
IssuanceUtcandExpirationUtconDocument.IssuanceandExpirationwithout time should be used instead.
- Added
ServiceIdtoAccounting Item.
- Added
Update Space Stateoperation. - Added
Add Reservation Productoperation. - Extended
ProductwithShortName. - Extended
Reservation Time FilterwithCancelledoption.
- Extended
Get All Reservationsoperation withExtentparameter. This simplifies some of integrations, since now it is possible to fetch both reservations and their items at the same time. It is no longer necessary to first get all reservations and then obtain their items usingGet All Reservation Items. Also clients that do not use reservation groups or reservation customers should specify theExtentto be onlyReservationsand nothing else in order to reduce unnecessary network traffic. On the other hand, if the client makes many successive calls toGet All Reservations, it is not recommended to include things that do not vary intoExtent. E.g.SpacesorRatesshould still be fetched once, not together with every reservation fetch. - Added
Overlappingtime filter toGet All Reservationsoperation. - Added
Get Configurationoperation. - Added
Update Reservation Spaceoperation. - Added
Update Reservation Requested Categoryoperation.
- Extended
Update Customeroperation parameters withEmail. - Extended
Accounting CategorywithClassification.
- Added
Delete Reservation Companionoperation. - Added
Get All Customersoperation. - Extended
CustomerwithCreatedUtcandUpdatedUtc.
- Extended
CustomerwithBirthPlace. - Extended
DocumentwithIssuance.
- Extended
Accounting categorywithLedgerAccountCode,PostingAccountCodeandCostCenterCode. - Extended
CustomerwithLanguageCode.
- Added
Get All Customers By Idsoperation. - Extended
ReservationwithChannelManagerNumber,ChannelManagerGroupNumberandChannelManager. - Extended
Get All Productsto return products of mulitple services at once. - Extended
Accounting CategorywithCodeandExternalCode.
- Added
NotestoAccounting Item. - Deprecated response of
Add Credit Card Payment.
- Added
BaseRateIdandShortNametoRate. - Added
Get All Reservations By Idsoperation.
- Removed the deprecated data fields and operations.
- Added
StartandEndReservation Time Filter. - Added
ProductId,BillIdandTypetoAccounting Item. - Added
ServiceIdtoReservation. - Added optional
BillIdparameter toAdd Credit Card Payment. - Added
Get All Servicesoperation. - Added
Get All Productsoperation. - Added
Get Rate Pricingoperation. - Generalized
Update Rate Base PricetoUpdate Rate Price.
- Added operation
Update Rate Base Pricethat allows e.g. revenue management systems to provide recommended rates to MEWS. - Added operation
Get All Reservation Itemsthat returns revenue items of selected reservations. - Added
Currencyparameter to operationsGet Customers Open ItemsandGet All Accounting Items. - Deprecated operation
Get Customer Balance. OperationGet Customer Open Itemsshould be used instead, since it provides more complete information. - Deprecated properties
CustomerandCompanionsonReservation.CustomerIdanCompanionIdsshould be used instead. The customer data are part of the result ofGet All Reservations. This removes redundancy in the response data, especially in hostels where the customer is mostly the only companion and currently the customer data were twice in the result. - We plan to make
AddressonCustomeroptional in order to reduce response sizes, in many cases the customers do not have address details filled in.