Skip to content

Latest commit

 

History

History
718 lines (496 loc) · 42.2 KB

File metadata and controls

718 lines (496 loc) · 42.2 KB

Changelog

Operations we are planning to deprecate in 2021

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.

Deprecated operations

Following legacy operations to be completely removed:

Deprecated time filters

Properties TimeFilter, StartUtc and EndUtc to be removed on operations:

Use properties CreatedUtc, UpdatedUtc, etc. as per operation description.

Other deprecated properties

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

Websocket authentication

Changed Websocket authentication from being passed via URL query parameters to cookies.

29th March 2021 8:20 UTC

  • Added new type ResourceUpdated of webhook Event.

18th March 2021 8:20 UTC

  • 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.

3rd March 2021 12:30 UTC

22nd February 2021 11:30 UTC

21st January 2021 11:30 UTC

6th January 20201 11:30 UTC

  • 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.

16th December 2020 11:30 UTC

27th November 2020 11:30 UTC

3th November 2020 11:30 UTC

29th September 2020 11:30 UTC

24th September 2020 11:30 UTC

21st September 2020 11:30 UTC

1st September 2020 11:30 UTC

19th August 2020 11:30 UTC

5th August 2020 11:30 UTC

23rd July 2020 11:30 UTC

21st July 2020 11:30 UTC

2nd July 2020 11:30 UTC

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.

6th June 2020 11:30 UTC

17th March 2020 11:30 UTC

16th March 2020 19:55 UTC

13th March 2020 11:45 UTC

13th March 2020 11:35 UTC

13th February 2020 11:33 UTC

15th January 2020 14:00 UTC

  • Extended Add task parameters with ServiceOrderId.

9th January 2020 14:00 UTC

12th December 2019 14:00 UTC

28th November 2019 08:30 UTC

21st November 2019 08:30 UTC

6th November 2019 14:30 UTC

15th October 2019 16:00 UTC

9th October 2019 09:00 UTC

8th October 2019 09:00 UTC

7th October 2019 13:10 UTC

  • Extended Bill with TaxedUtc.

7th October 2019 10:00 UTC

25th September 2019 08:08 UTC

9th September 2019 15:50 UTC

6th September 2019 18:00 UTC

18th August 2019 18:00 UTC

  • Extended Get all restrictions parameters with StartUtc, EndUtc, TimeFilter, SpaceCategoryIds and RateIds.

13th August 2019 16:55 UTC

12th August 2019 16:55 UTC

17th July 2019 18:00 UTC

26th June 2019 19:00 UTC

21st June 2019 19:00 UTC

10th June 2019 19:00 UTC

15th May 2019 19:00 UTC

13th March 2019 19:00 UTC

27th February 2019 22:00 UTC

19th February 2019 18:00 UTC

6th February 2019 17:00 UTC

5th February 2019 9:20 UTC

29th January 2019 19:00 UTC

26th January 2019 15:40 UTC

4nd January 2019 18:00 UTC

2nd January 2019 16:00 UTC

19th December 2018 18:00 UTC

  • Extended Bill with VariableSymbol.

12th December 2018 18:00 UTC

28th November 2018 22:00 UTC

21st Nov 2018 18:00 UTC

14th Nov 2018 17:00 UTC

19th Sep 2018 18:00 UTC

29th Aug 2018 17:00 UTC

16th Aug 2018 22:00 UTC

8th Aug 2018 17:00 UTC

1st Aug 2018 16:00 UTC

25th Jul 2018 16:20 UTC

27th Jun 2018 16:30 UTC

20th Jun 2018 16:15 UTC

13th Jun 2018 21:30 UTC

7th Jun 2018 22:00 UTC

5th Jun 2018 15:00 UTC

  • Mimimal required TLS version updated to TLS 1.2.

31st May 2018 22:30 UTC

25th May 2018 23:00 UTC

17th May 2018 22:00 UTC

9th May 2018 21:00 UTC

28th April 2018 22:00 UTC

  • Extended Company with AdditionalTaxIdentifier.

28th March 2018 23:00 UTC

22nd March 2018 22:00 UTC

8th March 2018 22:30 UTC

21st February 2018 22:00 UTC

6th December 2017 21:00 UTC

  • Extended Product order parameters with UnitCost.
  • Extended parameters of Get all accounting items with TimeFilter.
  • Added Get all bills by ids operation.
  • Added Get all customers by emails operation.

30th November 2017 22:30 UTC

  • Extended Accounting item with InvoiceId.
  • Extended Space category with Description and ImageIds.
  • Extended Customer with Notes.
  • Extended Key cutter command data with ReservationId.
  • Extended parameters of Add customer and Update customer with Classifications and Notes.
  • Extended parameters of Add reservations with Identifier.
  • Added Get all reservations by customers operation.
  • Added Price reservations operation.
  • Added Add customer file operation.
  • Added Get image URLs operation.

9th November 2017 21:30 UTC

  • Extended Reservation with Origin.
  • Extended Enterprise with Currencies.
  • Extended Space with FloorNumber and BuildingNumber.
  • Added Get all countries operation.
  • Added Get all currencies operation.
  • Added Get all exchange rates operation.
  • Made Type in parameters of Add external payment optional.

19th October 2017 22:00 UTC

  • Extended Company with Address.
  • Extended Space category with UnitCount.
  • Extended parameters of Add reservations with State.
  • Added Add printer command operation.
  • Added Add key cutter command operation.
  • Added Get all devices operation.

21st September 2017 21:00 UTC

  • Extended Enterprise with Email and Phone.
  • Extended parameters of Get all reservations by ids with Extent.
  • Added Add external payment operation.

13th September 2017 21:00 UTC

  • Extended Company with Identifier and ElectronicInvoiceIdentifier.
  • Extended Rate with IsPublic.
  • Extended Enterprise with TimeZoneIdentifier.
  • Added Get all departments operation.

31st August 2017 16:00 UTC

  • Extended Customer with Number.

24th August 2017 20:00 UTC

  • Renamed Charge Customer to Add order, the old endpoint still works.
  • Extended parameters of Add order with ProductOrders.
  • Extended Bill with CustomerId, CompanyId and DueUtc.
  • Extended Enterprise with CreatedUtc, EditableHistoryInterval.
  • Extended Product with Price.
  • Extended Key cutter command data with KeyCutterData.
  • Added Passport scanner command data.

16th August 2017 22:00 UTC

  • Added Get all company contracts operation.
  • Added Get all cashiers operation.
  • Added Get all cashier transactions operation.

2nd August 2017 21:00 UTC

  • Added Get service availability operation.
  • Added Add reservations operation.
  • Extended Company with TaxIdentificationNumber.
  • Extended Accounting item with CustomerId.
  • Extended parameters of Add customer with OverwriteExisting and updated behaviour to return error in case of duplicate customer, unless OverwriteExisting is set to true.
  • Updated behaviour of Update customer to return error in case of duplicate customer.

19th July 2017 22:00 UTC

  • Extended Customer with LoyaltyCode and added it as a parameter to the Add customer and Update customer.
  • Added Get all closed bills operation.
  • Extended bill with Type.
  • Extended Key cutter command data with KeyCount.
  • Added Merge customers operation.
  • Extended Enterprise with WebsiteUrl and Address.
  • Extended Currency value with Net.

12th July 2017 20:00 UTC

  • Added Fiscal machine command data.

3rd July 2017 22:00 UTC

  • Added optional ConsumptionUtc parameter to Charge customer operation.
  • Extended response of Get Rate Pricing operation with Currency.
  • Added Classifications to Customer.
  • Added Ordering to Space category.
  • Added CancelledUtc to Reservation.
  • Added optional AllowOpenBalance and Notes parameters to Process Reservation operation.
  • Extended websocket events with Reservation event.

18th June 2017 21:30 UTC

  • Extended Reservation with AssignedSpaceLocked.
  • Added Rate Extent to Get All Rates, added Rate Restrictions to the result.
  • Added Space Extent to Get All Spaces, added and Space Features and Space Feature Assignments to the result.
  • Added Update Reservation Interval operation.
  • Added optional ServiceId parameter to Charge Customer operation, so any service can be charged.
  • Added Promotions to Service and Product.
  • Extended Customer with SecondLastName and added it as a parameter to the Add Customer and Update Customer.

13th June 2017 21:00 UTC

  • Introduced Websockets and first use case for command events.

7th June 2017 11:00 UTC

  • Deprecated BirthDateUtc on Customer and in Update Customer parameters. BirthDate without time specified should be used instead.
  • Deprecated IssuanceUtc and ExpirationUtc on Document. Issuance and Expiration without time should be used instead.

10th May 2017 23:00 UTC

  • Added ServiceId to Accounting Item.

3rd May 2017 21:30 UTC

  • Added Update Space State operation.
  • Added Add Reservation Product operation.
  • Extended Product with ShortName.
  • Extended Reservation Time Filter with Cancelled option.

12th April 2017 22:30 UTC

  • Extended Get All Reservations operation with Extent parameter. 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 using Get All Reservation Items. Also clients that do not use reservation groups or reservation customers should specify the Extent to be only Reservations and nothing else in order to reduce unnecessary network traffic. On the other hand, if the client makes many successive calls to Get All Reservations , it is not recommended to include things that do not vary into Extent. E.g. Spaces or Rates should still be fetched once, not together with every reservation fetch.
  • Added Overlapping time filter to Get All Reservations operation.
  • Added Get Configuration operation.
  • Added Update Reservation Space operation.
  • Added Update Reservation Requested Category operation.

22nd February 2017 22:00 UTC

  • Extended Update Customer operation parameters with Email.
  • Extended Accounting Category with Classification.

9th February 2017 00:00 UTC

  • Added Delete Reservation Companion operation.
  • Added Get All Customers operation.
  • Extended Customer with CreatedUtc and UpdatedUtc.

26th January 2017 00:30 UTC

  • Extended Customer with BirthPlace .
  • Extended Document with Issuance.

18th January 2017 22:00 UTC

  • Extended Accounting category with LedgerAccountCode, PostingAccountCode and CostCenterCode.
  • Extended Customer with LanguageCode.

14th December 2016 21:50 UTC

  • Added Get All Customers By Ids operation.
  • Extended Reservation with ChannelManagerNumber, ChannelManagerGroupNumber and ChannelManager.
  • Extended Get All Products to return products of mulitple services at once.
  • Extended Accounting Category with Code and ExternalCode.

22nd November 2016 23:15 UTC

  • Added Notes to Accounting Item.
  • Deprecated response of Add Credit Card Payment.

15th November 2016 22:00 UTC

  • Added BaseRateId and ShortName to Rate.
  • Added Get All Reservations By Ids operation.

17th October 2016 23:00 UTC

  • Removed the deprecated data fields and operations.
  • Added Start and End Reservation Time Filter.
  • Added ProductId, BillId and Type to Accounting Item.
  • Added ServiceId to Reservation.
  • Added optional BillId parameter to Add Credit Card Payment.
  • Added Get All Services operation.
  • Added Get All Products operation.
  • Added Get Rate Pricing operation.
  • Generalized Update Rate Base Price to Update Rate Price.

1st September 2016 22:00 UTC

  • Added operation Update Rate Base Price that allows e.g. revenue management systems to provide recommended rates to MEWS.
  • Added operation Get All Reservation Items that returns revenue items of selected reservations.
  • Added Currency parameter to operations Get Customers Open Items and Get All Accounting Items.
  • Deprecated operation Get Customer Balance. Operation Get Customer Open Items should be used instead, since it provides more complete information.
  • Deprecated properties Customer and Companions on Reservation. CustomerId an CompanionIds should be used instead. The customer data are part of the result of Get 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 Address on Customer optional in order to reduce response sizes, in many cases the customers do not have address details filled in.