Migration guide: Get all reservations
Last updated
Was this helpful?
Last updated
Was this helpful?
This guide is intended to assist API users to migrate away from the obsolete API Operation which is long deprecated and will be permanently discontinued.
Help us improve the migration experienceWe’re committed to ensuring a smooth transition from the old 2017 version of 'Get all reservations' to the newer 2023 version. To better support you, we’d love to hear about your migration plans and any potential blockers you may be facing.
Migration timeline – When do you plan to complete your migration?
Feature parity – Is there any missing functionality preventing your transition?
After consulting the details in this Migration Guide, please take a moment to fill out this and share your feedback. If you need further assistance or would like to discuss your migration plans, please contact our Technical Partnerships team at .
The new operation doesn't support extents
The new operation supports filtering by more time intervals
If you previously used extents, you will need to change your implementation to make additional calls to the API to get the same information.
You will need to change your implementation to support pagination, including supplying the mandatory Limitation parameter in your request.
Filtering by time intervals offers new opportunities to make your calls more efficient.
Portfolio Access Tokens again offers new opportunities to users taking advantage of the Mews Multi-Property feature.
Check the usage of request parameters and map the original request parameters to their new equivalents.
Replace extents in request parameters (if used) with calls to additional operations.
Map original response parameters to their new equivalents.
Ensure your implementation supports pagination.
ServiceIds
ServiceIds
No longer required
.
GroupIds
ReservationGroupIds
-
ReservationIds
ReservationIds
No change.
CustomerIds
AccountIds
Accounts are more general than Customers and include Companies as well.
AssignedResourceIds
AssignedResourceIds
No change.
RateIds
n/a
Currently not supported.
BusinessSegmentIds
n/a
Currently not supported.
ChannelNumbers
ChannelNumbers
Reduced to maximum of 100 items.
Numbers
Numbers
No change.
StartUtc
-
EndUtc
-
TimeFilter
-
Currency
n/a
Currently not supported.
States
States
No change.
Limitation
Limitation
Required for all requests.
The combination of the request properties TimeFilter
, StartUtc
and EndUtc
has been replaced by individual Time interval properties.
For example, instead of "TimeFilter":"Colliding"
use CollidingUtc
request property.
TimeFilter
value
Request property
Notes
Colliding
CollidingUtc
-
Created
CreatedUtc
-
Updated
UpdatedUtc
-
Start
ScheduledStartUtc
Clarified behavior of filtering by the scheduled time of reservation.
End
ScheduledEndUtc
-
Overlapping
n/a
Dropped due to low usage, use CollidingUtc
instead.
Canceled
n/a
Dropped due to low usage. Can be emulated with the combination of UpdatedUtc
and States set to [“Canceled"] filters.
Returns the following response with two reservations:
The following table links individual extents together with their replacement API Operations.
Reservations
n/a
Operation always returns reservations.
ReservationGroups
Use GroupId
response property in ReservationGroupIds
request parameter.
Customers
Use AccountId
response property where AccountType
is "Customer".
CustomerAdresses
(sic)
Use AccountId
response property where in AccountIds
parameter.
CustomerIdentityDocuments
Use AccountId
response property where AccountType
is "Customer"
Services
Use ServiceId
response property.
Products
Use ServiceId
response property.
BusinessSegments
Use BusinessSegmentId
response property.
Resources
Use AssignedResourceIds
response property.
ResourceCategories
Use RequestedResourceCategoryId
response property.
ResourceCategoryAssignments
Use AssignedResourceIds
property in ResourceIds
request parameter.
Rates
Use RateId
response property.
Items
Payments: Use Id
response property in ReservationIds
request parameter.
Order items: Use Id
response property in ServiceOrderIds
request parameter.
OrderItems
Use Id
response property in ServiceOrderIds
request parameter.
Notes
Use Id
response property in ServiceOrderIds
request parameter.
QrCodeData
n/a
Use QrCodeData
response property.
Companies
Use AccountId
response property where AccountType
is "Company"
.
AccountingStates
Use AccountingStates
request parameter for both operations.
ChannelManagerGroupNumber
n/a
No longer supported.
ChannelManager
n/a
Origin
Origin
Operations-specific values moved to CommanderOrigin
(see Commander origin).
Purpose
Purpose
No longer required.
StartUtc
ScheduledStartUtc
ActualStartUtc
Early check-ins changed StartUtc
value. Check-in time and scheduled start time are now provided in separate properties.
EndUtc
ScheduledEndUtc
ActualEndUtc
Check-outs changed EndUtc value. Check-out time and scheduled end time are now provided in separate properties.
RequestedCategoryId
RequestedResourceCategoryId
-
CompanyId
PartnerCompanyId
-
CancellationReason
CancellationReason
Optional, previously incorrectly marked as required.
OwnerId
AccountId
-
Options
Options
Uses Service order options.
AssignedSpaceId
AssignedResourceId
Previously deprecated.
AssignedSpaceLocked
AssignedResourceLocked
Previously deprecated.
AdultCount
PersonCounts
Previously deprecated.
ChildCount
PersonCounts
Previously deprecated.
CustomerId
AccountId
Previously deprecated.
CompanionIds
n/a
ChannelManagerId
ChannelManagerNumber
Previously deprecated.
API Operation is replaced by . The original operation became increasingly complex and the combination of extents along with backward compatibility requirements resulted in unpredictable performance and frequent timeouts. The new operation performs the same basic function to fetch reservations from Mews, however there are substantial differences that you need to be aware of. The major differences are as follows:
The new operation requires
The new operation supports
Extents: Extents are a way to fetch related entities with a single API request. For example, when fetching reservations in the original Get all reservations operation, you were able to receive data about related customers and resources in the same resources. While this simplified some use cases, it frequently resulted in request timeouts and overfetching of rarely updated data. Furthermore, contract changes in related entities complicated tracking changes to the operation. See also .
The following table maps request parameters from to the equivalent request parameters in .
See
See
See
Original request to :
Migrated request to :
The following table maps the original TimeFilter
value to the equivalent properties for :
The new operation doesn’t support extents. Instead, separate API Operations to retrieve respective entities should be used.
The following example request to uses extents to retrieve Reservations, Customers, and Resources in a single request:
With the request needs to be broken down into 3 separate requests:
to retrieve reservations including AccountId
and AssignedResourceIds
properties of individual reservations.
to retrieve customers' details using the CustomerIds
filter with AccountId
values retrieved in the first step (where AccountType
is "Customer"
).
to retrieve resources' details using the ResourceIds
filter with AssignedResourceIds
values retrieved in the first step. Alternatively, can be regularly requested without filters and cached, since resources' details don’t change frequently.
First request to :
Second request to passes value of AccountId
to CustomerIds
filter only from the first reservation as AccountType
is "Customer"
:
Third request to uses values from AssignedResourceId
in ResourceIds
filter from both reservations:
The following table maps the response properties from the original entity to the properties of . Only the changed properties are listed.
Replaced by .
Previously deprecated, replaced by .
The and operations work with older versions of request and response properties corresponding to entity. An updated versions of these operations will be published in H2/2025.