Reservations

Get all reservations (ver 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

[PlatformAddress]/api/connector/v1/reservations/getAll/2023-06-06

{
  "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
  }
}

Property	Type	Contract	Description
ClientToken	string	required	Token identifying the client application.
AccessToken	string	required	Access token of the client application.
Client	string	required	Name and version of the client application.
EnterpriseIds	array of string	optional, max 1000 items	Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
ReservationIds	array of string	optional, max 1000 items	Unique identifiers of the Reservations.
ServiceIds	array of string	optional, max 1000 items	Unique identifiers of the Services. If not provided, all bookable services are used.
ReservationGroupIds	array of string	optional, max 1000 items	Unique identifiers of Reservation groups.
AccountIds	array of string	optional, max 1000 items	Unique identifiers of accounts (currently only Customers, in the future also Companies) the reservation is associated with.
PartnerCompanyIds	array of string	optional, max 100 items	Unique identifiers of the Companies on behalf of which the reservations were made.
TravelAgencyIds	array of string	optional, max 100 items	Identifier of the Travel Agencies (Company) that mediated the reservations.
Numbers	array of string	optional, max 1000 items	Reservation confirmation numbers.
ChannelNumbers	array of string	optional, max 100 items	Numbers or references used by a Channel (OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers.
AssignedResourceIds	array of string	optional, max 1000 items	Unique identifiers of the Resources assigned to the reservations.
AvailabilityBlockIds	array of string	optional, max 100 items	Unique identifiers of the Availability blocks assigned to the reservations.
CreatedUtc	Time interval	optional, max length 3 months	Interval in which the Reservation was created.
UpdatedUtc	Time interval	optional, max length 3 months	Interval in which the Reservations were updated.
CollidingUtc	Time interval	optional, max length 3 months	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
ScheduledStartUtc	Time interval	optional, max length 3 months	Interval filtering Reservations by their scheduled start time. Cannot be used with ActualStartUtc.
ActualStartUtc	Time interval	optional, max length 3 months	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.
ActualEndUtc	Time interval	optional, max length 3 months	Interval filtering Reservations by their actual end (check-out) time. Cannot be used with ScheduledEndUtc.
ScheduledEndUtc	Time interval	optional, max length 3 months	Interval filtering Reservations by their scheduled end time. Cannot be used with ActualEndUtc.
States	array of Service order state	optional	A list of service order states to filter by.
Limitation	Limitation	required	Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

Property	Type	Contract	Description
Reservations	array of Reservation (ver 2023-06-06)	required	The reservations of the enterprise.
Cursor	string	optional	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.

Reservation (ver 2023-06-06)

Property	Type	Contract	Description
Id	string	required	Unique identifier of the reservation.
ServiceId	string	required	Unique identifier of the Service that reservation is made against.
AccountId	string	required	Unique identifier of the Customer or Company who owns the reservation, i.e. the main guest linked to the reservation.
AccountType	Account type	required	A discriminator specifying the account type, e.g. Customer or Company
CreatorProfileId	string	required	Unique identifier of the user who created the reservation.
UpdaterProfileId	string	required	Unique identifier of the user who updated the reservation.
BookerId	string	optional	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.
Number	string	required	Confirmation number of the reservation in Mews.
State	Service order state	required	State of the reservation.
Origin	Service order origin	required	Origin of the reservation.
CommanderOrigin	Commander origin	optional	Further detail about origin in case of Origin Commander.
OriginDetails	string	optional	Details about the reservation Origin.
CreatedUtc	string	required	Creation date and time of the reservation in UTC timezone.
UpdatedUtc	string	required	Last update date and time of the reservation in UTC timezone.
CancelledUtc	string	optional	Cancellation date and time in UTC timezone.
VoucherId	string	optional	Unique identifier of the Voucher that has been used to create reservation.
BusinessSegmentId	string	optional	Identifier of the reservation BusinessSegment.
Options	Service Order Options	required	Options of the reservation.
RateId	string	required	Identifier of the reservation Rate.
CreditCardId	string	optional	Unique identifier of the Credit card.
GroupId	string	required	Unique identifier of the Reservation group.
RequestedResourceCategoryId	string	required	Unique identifier of the Resource category.
AssignedResourceId	string	optional	Identifier of the assigned Resource.
AvailabilityBlockId	string	optional	Unique identifier of the Availability block the reservation is assigned to.
PartnerCompanyId	string	optional	Identifier of the Company on behalf of which the reservation was made.
TravelAgencyId	string	optional	Identifier of the Travel Agency (Company) that mediated the reservation.
AssignedResourceLocked	boolean	required	Whether the reservation is locked to the assigned Resource and cannot be moved.
ChannelNumber	string	optional	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).
ChannelManagerNumber	string	optional	Unique number of the reservation within the reservation group.
CancellationReason	Reservation cancellation reason	optional	Cancellation reason of the reservation.
ReleasedUtc	string	optional	Date when the optional reservation is released in UTC timezone.
ScheduledStartUtc	string	required	Scheduled start time of reservation in UTC timezone.
ActualStartUtc	string	optional	Actual customer check-in time of reservation in UTC timezone.
ScheduledEndUtc	string	required	Scheduled end time of reservation in UTC timezone in ISO 8601 format.
ActualEndUtc	string	optional	Actual end time of reservation in UTC timezone in ISO 8601 format.
Purpose	Reservation purpose	optional	Purpose of the reservation.
QrCodeData	string	optional	QR code data of the reservation.
PersonCounts	array of Age category parameters	required	Number of people per age category the reservation was booked for.
StartUtc	string	required	Reservation start or check-in time (if it's earlier than scheduled start) in UTC timezone in ISO 8601 format. Deprecated! Use ScheduledStartUtc and ActualStartUtc instead.
EndUtc	string	required	Scheduled end time of reservation in UTC timezone in ISO 8601 format Deprecated! Use ScheduledEndUtc and ActualEndUtc instead.

Service order state

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

Service order origin

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

Commander origin

• InPerson
• Channel
• Phone
• Email
• Website
• Message
• CallCenter
• RoomingList

Service Order Options

Property	Type	Contract	Description
OwnerCheckedIn	boolean	required	Owner of the reservation checked in.
AllCompanionsCheckedIn	boolean	required	All companions of the reservation checked in.
AnyCompanionCheckedIn	boolean	required	Any of the companions of the reservation checked in.
ConnectorCheckIn	boolean	required	Check in was done via Connector API.

Reservation cancellation reason

• Other
• ConfirmationMissed
• BookedElsewhere
• ForceMajeure
• GuestComplaint
• NoShow
• PriceTooHigh
• ServiceNotAvailable
• InputError
• InvalidPayment
• TravelAgency
• RequestedByGuest
• Update
• BookingAbandoned
• RequestedByBooker

Reservation purpose

• Leisure
• Business
• Student

Get all reservations (ver 2017-04-12)

Deprecated!

This operation is deprecated. Use Get all reservations (ver 2023-06-06).

Request

[PlatformAddress]/api/connector/v1/reservations/getAll

Property	Type	Contract	Description
ClientToken	string	required	Token identifying the client application.
AccessToken	string	required	Access token of the client application.
Client	string	required	Name and version of the client application.
ServiceIds	array of string	required, max 1000 items	Unique identifiers of the Services from which the reservations are requested.
GroupIds	array of string	optional, max 1000 items	Unique identifiers of the requested Reservation groups.
ReservationIds	array of string	optional, max 1000 items	Unique identifiers of the requested Reservations.
CustomerIds	array of string	optional, max 1000 items	Unique identifiers of the Customers which own the reservations.
AssignedResourceIds	array of string	optional, max 1000 items	Unique identifiers of Resources assigned to the reservations.
RateIds	array of string	optional, max 1000 items	Unique identifiers of Rates assigned to the reservations.
BusinessSegmentIds	array of string	optional, max 1000 items	Unique identifiers of Business segments assigned to the reservations.
ChannelNumbers	array of string	optional, max 1000 items	Set of numbers or references used by the Channel (i.e. OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers.
Numbers	array of string	optional, max 1000 items	Confirmation numbers of Reservations.
StartUtc	string	optional	Start of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.
EndUtc	string	optional	End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.
TimeFilter	Reservation time filter	optional	Time filter of the interval. If not specified, reservations Colliding with the interval are returned.
Currency	string	optional	ISO-4217 code of the Currency the item costs should be converted to.
States	array of Service order state (ver 2017-04-12)	optional	States the reservations should be in. If not specified, reservations in Confirmed, Started or Processed states or reservations specified by ReservationIds regardless of state are returned.
Extent	Reservation extent	required	Extent of data to be returned. E.g. it is possible to specify that together with the reservations, customers, groups and rates should be also returned.
Limitation	Limitation	required	Limitation on the quantity of data returned.
ServiceId	string	optional	Deprecated!

Reservation time filter

• Colliding - Reservations whose intervals collide with the specified interval.
• Created - Reservations created within the specified interval.
• Updated - Reservations updated within the specified interval.
• Start - Reservations starting (arriving) within the specified interval.
• End - Reservations ending (departing) within the specified interval.
• Overlapping - Reservations whose intervals contain the specified interval.
• Canceled - Reservations canceled within the specified interval.

Reservation extent

Extent of data to be returned. E.g. it is possible to specify that together with the reservations, customers, groups and rates should be also returned.

Property	Type	Contract	Description
Reservations	boolean	optional	Whether the response should contain reservations.
ReservationGroups	boolean	optional	Whether the response should contain groups of the reservations.
Customers	boolean	optional	Whether the response should contain customers of the reservations.
CustomerAdresses	boolean	optional	Whether the response should contain addresses of the customers.
CustomerIdentityDocuments	boolean	optional	Whether the response should contain identity documents of the customers.
Services	boolean	optional	Whether the response should contain services reserved by the reservations.
Products	boolean	optional	Whether the response should contain products orderable with the reservations.
BusinessSegments	boolean	optional	Whether the response should contain business segmentation.
Resources	boolean	optional	Whether the response should contain resources.
ResourceCategories	boolean	optional	Whether the response should contain resource categories.
ResourceCategoryAssignments	boolean	optional	Whether the response should contain assignments of the resources to categories.
Rates	boolean	optional	Whether the response should contain rates and rate groups.
Items	boolean	optional	Whether the response should contain accounting items.
OrderItems	boolean	optional	Whether the response should contain reservation items.
Notes	boolean	optional	Whether the response should contain notes.
QrCodeData	boolean	optional	Whether the response should contain QR code data.
Companies	boolean	optional	Whether the response should contain companies.
AccountingStates	array of Order item accounting state	optional	States the items should be in. If not specified, items in Open or Closed states are returned.

Response

Property	Type	Contract	Description
Reservations	array of Reservation (ver 2017-04-12)	optional	The reservations that collide with the specified interval.
ReservationGroups	array of Reservation groups (ver 2017-04-12)	optional	Reservation groups that the reservations are members of.
Customers	array of Customer	optional	Customers that are members of the reservations.
Services	array of Service	optional	Services that have been reserved.
Products	array of Product	optional	Products orderable with reservations.
Resources	array of Resource	optional	Assigned resources of the reservations.
ResourceCategories	array of Resource category	optional	Resource categories of the resources.
ResourceCategoryAssignments	array of Resource category assignment	optional	Assignments of the resources to categories.
BusinessSegments	array of Business segment	optional	Business segments of the reservations.
Rates	array of Rate for extent	optional	Rates of the reservations.
RateGroups	array of Rate group (ver 2017-04-12)	optional	Rate groups of the reservation rates.
Items	array of Accounting item	optional	Accounting items that are part of the reservations.
OrderItems	array of Order item	optional	Revenue items of the reservations.
Notes	array of Service order note	optional	Notes of the reservations.
QrCodeData	array of Reservation QR code data	optional	QR code data of the reservations.
Companies	array of Company	optional	Companies related to the reservations.
ResourceAccessTokens	array of Resource access token	optional	Resource access tokens for the reservations.
Cursor	string	optional	Unique identifier of the last and hence oldest reservation returned. This can be used in Limitation in a subsequent request to fetch the next batch of older reservations.

Reservation (ver 2017-04-12)

Property	Type	Contract	Description
Id	string	required	Unique identifier of the reservation.
ServiceId	string	required	Unique identifier of the Service that is reserved.
GroupId	string	required	Unique identifier of the Reservation group.
Number	string	required	Confirmation number of the reservation in Mews.
ChannelNumber	string	optional	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).
ChannelManagerNumber	string	optional	Unique number of the reservation within the reservation group.
ChannelManagerGroupNumber	string	optional	Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews.
ChannelManager	string	optional	Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc).
State	Service order state (ver 2017-04-12)	required
Origin	Reservation origin (ver 2017-04-12)	required
OriginDetails	string	optional	Details about the reservation origin.
Purpose	Reservation purpose	optional	Purpose of the reservation.
CreatedUtc	string	required	Creation date and time of the reservation in UTC timezone in ISO 8601 format.
UpdatedUtc	string	required	Last update date and time of the reservation in UTC timezone in ISO 8601 format.
CancelledUtc	string	optional	Cancellation date and time in UTC timezone in ISO 8601 format.
StartUtc	string	required	Start of the reservation in UTC timezone in ISO 8601 format. This is either the scheduled reservation start time, or the actual customer check-in time if this is earlier than the scheduled start time.
EndUtc	string	required	End of the reservation (departure) in UTC timezone in ISO 8601 format.
ReleasedUtc