Get all reservations (ver 2023-06-06)
POST /api/connector/v1/reservations/getAll/2023-06-06
Returns all reservations within scope of the Access Token, filtered according to the specified parameters. This operation uses Pagination and supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of the Reservations.
Unique identifiers of the Services. If not provided, all bookable services are used.
Unique identifiers of Reservation groups.
Unique identifiers of the Companies on behalf of which the reservations were made.
Identifier of the Travel Agencies (Company) that mediated the reservations.
Reservation confirmation numbers.
Numbers or references used by a Channel (OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers.
Unique identifiers of the Resources assigned to the reservations.
Unique identifiers of the Availability blocks assigned to the reservations.
Interval in which the Reservation was created.
object
Interval in which the Reservations were updated.
object
Interval in which the reservations are active. This is defined for a Reservation as the period between the reservation’s scheduled start time ScheduledStartUtc and its scheduled end time EndUtc. Reservation is selected if any part of its interval intersects with the interval specified in `CollidingUtc
object
Interval filtering Reservations by their scheduled start time. Cannot be used with ActualStartUtc.
object
Interval filtering Reservations by their actual start (check-in) time. Cannot be used with ScheduledStartUtc. Note that the filter applies only to started or processed reservations.
object
Interval filtering Reservations by their actual end (check-out) time. Cannot be used with ScheduledEndUtc.
object
Interval filtering Reservations by their scheduled end time. Cannot be used with ActualEndUtc.
object
A list of service order states to filter by.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ReservationIds": [ "0f515589-99b4-423d-b83a-b237009f0509", "9b59b50d-bd32-4ce5-add8-09ea0e1300e7" ], "ServiceIds": [ "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "8c1bd738-a505-4b29-aa71-9ecc2982b843" ], "ReservationGroupIds": [ "94843f6f-3be3-481b-a1c7-06458774c3df" ], "AccountIds": [ "fadd5bb6-b428-45d5-94f8-fd0d89fece6d" ], "PartnerCompanyIds": [ "c021013e-4930-4592-8e32-91b0b1fc9663" ], "TravelAgencyIds": [ "a793d381-65a2-4fa6-9514-00c4c5bfe607" ], "Numbers": [ "50", "51", "52", "53" ], "AssignedResourceIds": [ "5ee074b1-6c86-48e8-915f-c7aa4702086f", "c32386aa-1cd2-414a-a823-489325842fbe" ], "AvailabilityBlockIds": [ "5ee074b1-6c86-48e8-915f-c7aa4702086f", "c32386aa-1cd2-414a-a823-489325842fbe" ], "CreatedUtc": { "StartUtc": "2023-04-01T00:00:00Z", "EndUtc": "2023-05-05T00:00:00Z" }, "UpdatedUtc": { "StartUtc": "2023-04-01T00:00:00Z", "EndUtc": "2023-05-05T00:00:00Z" }, "CollidingUtc": { "StartUtc": "2023-04-01T00:00:00Z", "EndUtc": "2023-05-05T00:00:00Z" }, "ScheduledStartUtc": { "StartUtc": "2023-04-01T00:00:00Z", "EndUtc": "2023-05-05T00:00:00Z" }, "ScheduledEndUtc": { "StartUtc": "2023-04-01T00:00:00Z", "EndUtc": "2023-05-05T00:00:00Z" }, "States": [ "Inquired", "Confirmed" ], "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "Limitation": { "Count": 10 }}Responses
Section titled “ Responses ”OK
object
The reservations of the enterprise.
object
Unique identifier of the reservation.
Unique identifier of the Service that reservation is made against.
Unique identifier of the Customer or Company who owns the reservation, i.e. the main guest linked to the reservation.
Unique identifier of the user who created the reservation.
Unique identifier of the user who updated the reservation.
Unique identifier of the booker who made the reservation on behalf of the reservation owner, in the special case where the booker is also a registered customer in Mews.
Confirmation number of the reservation in Mews.
State of the reservation.
Inquired (Confirmed neither by the customer nor enterprise.)
Confirmed (Confirmed by both parties, before check-in.)
Started (Checked in.)
Processed (Checked out.)
Canceled (Canceled.)
Optional (Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest).)
Requested (Confirmed by the customer but not by the enterprise (waitlist).)
Origin of the reservation.
Distributor (From the Mews Booking Engine or Booking Engine API.)
ChannelManager (From a channel manager.)
Commander (From Mews Operations.)
Import (From an import process.)
Connector (From the Mews Connector API.)
Navigator (From Mews Guest Services.)
Further detail about origin in case of Origin Commander.
InPerson
Channel
Phone
Website
Message
CallCenter
Details about the reservation Origin.
Creation date and time of the reservation in UTC timezone.
Last update date and time of the reservation in UTC timezone.
Cancellation date and time in UTC timezone.
Unique identifier of the Voucher that has been used to create reservation.
Identifier of the reservation BusinessSegment.
Options of the reservation.
object
Owner of the reservation checked in.
All companions of the reservation checked in.
Any of the companions of the reservation checked in.
Check in was done via Connector API.
Identifier of the reservation Rate.
Unique identifier of the Credit card.
Unique identifier of the Reservation group.
Unique identifier of the Resource category.
Identifier of the assigned Resource.
Unique identifier of the Availability block the reservation is assigned to.
Identifier of the Company on behalf of which the reservation was made.
Identifier of the Travel Agency (Company) that mediated the reservation.
Whether the reservation is locked to the assigned Resource and cannot be moved.
Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number).
Unique number of the reservation within the reservation group.
Cancellation reason of the reservation.
Other
ConfirmationMissed
BookedElsewhere
ForceMajeure
GuestComplaint
NoShow
PriceTooHigh
ServiceNotAvailable
InputError
InvalidPayment
TravelAgency
RequestedByGuest
Update
BookingAbandoned
RequestedByBooker
Date when the optional reservation is released in UTC timezone.
Reservation start or check-in time (if it’s earlier than scheduled start) in UTC timezone in ISO 8601 format.
Scheduled end time of reservation in UTC timezone in ISO 8601 format
Scheduled start time of reservation in UTC timezone.
Actual customer check-in time of reservation in UTC timezone.
Scheduled end time of reservation in UTC timezone in ISO 8601 format.
Actual end time of reservation in UTC timezone in ISO 8601 format.
Purpose of the reservation.
Leisure
Business
Student
QR code data of the reservation.
Number of people per age category the reservation was booked for.
object
Unique identifier of the Age category.
Number of people of a given age category. Only positive value is accepted.
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Example
{ "Reservations": [ { "Id": "0f515589-99b4-423d-b83a-b237009f0509", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "AccountId": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d", "AccountType": "Customer", "CreatorProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf", "UpdaterProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf", "BookerId": "ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72", "Number": "52", "State": "Confirmed", "Origin": "Connector", "CommanderOrigin": null, "OriginDetails": null, "CreatedUtc": "2023-03-23T16:00:00Z", "UpdatedUtc": "2023-04-22T17:00:00Z", "CancelledUtc": null, "VoucherId": null, "BusinessSegmentId": null, "Options": { "OwnerCheckedIn": true, "AllCompanionsCheckedIn": true, "AnyCompanionCheckedIn": true, "ConnectorCheckIn": true }, "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda", "CreditCardId": null, "GroupId": "94843f6f-3be3-481b-a1c7-06458774c3df", "RequestedResourceCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f", "AssignedResourceId": "20e00c32-d561-4008-8609-82d8aa525714", "AvailabilityBlockId": "5ee074b1-6c86-48e8-915f-c7aa4702086f", "PartnerCompanyId": "c021013e-4930-4592-8e32-91b0b1fc9663", "TravelAgencyId": "a793d381-65a2-4fa6-9514-00c4c5bfe607", "AssignedResourceLocked": false, "ChannelNumber": "TW48ZP", "ChannelManagerNumber": "", "CancellationReason": null, "ReleasedUtc": null, "StartUtc": "2023-04-23T14:00:00Z", "EndUtc": "2023-04-25T12:00:00Z", "ScheduledStartUtc": "2023-04-23T14:00:00Z", "ActualStartUtc": null, "ScheduledEndUtc": "2023-04-25T12:00:00Z", "ActualEndUtc": null, "Purpose": "Leisure", "QrCodeData": null, "PersonCounts": [ { "AgeCategoryId": "1f67644f-052d-4863-acdf-ae1600c60ca0", "Count": 2 }, { "AgeCategoryId": "ab58c939-be30-4a60-8f75-ae1600c60c9f", "Count": 2 } ] } ], "Cursor": "9b59b50d-bd32-4ce5-add8-09ea0e1300e7"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.