Connector API
Search
K

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": [
"9b59b50d-bd32-4ce5-add8-09ea0e1300e7"
],
"ServiceIds": [
"ae8da28c-e8a4-4141-9df0-8c998976c691",
"6b02d015-47ac-4c41-8e9f-5b4db61d4284"
],
"AccountIds": [
"94843f6f-3be3-481b-a1c7-06458774c3df"
],
"ReservationGroupIds": [
"94843f6f-3be3-481b-a1c7-06458774c3df"
],
"UpdatedUtc": {
"StartUtc": "2023-04-01T00:00:00Z",
"EndUtc": "2023-05-05T00:00:00Z"
},
"Limitation":{
"Cursor": "819e3435-7d5e-441f-bc68-76d89c69b8f5",
"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.
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.
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.
ReservationGroupIds
array of string
optional, max 1000 items
Unique identifiers of Reservation groups.
States
array of string Service order state
optional
A list of service order states to filter by.
UpdatedUtc
optional, max length 3 months
Interval in which the Reservations were updated.
CollidingUtc
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.
Limitation
required
Limitation on the quantity of data returned.

Response

{
"Reservations": [
{
"Id": "9b59b50d-bd32-4ce5-add8-09ea0e1300e7",
"ServiceId": "ae8da28c-e8a4-4141-9df0-8c998976c691",
"AccountId": "94843f6f-3be3-481b-a1c7-06458774c3df",
"AccountType": "Customer",
"CreatorProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
"UpdaterProfileId": "3cd637ef-4728-47f9-8fb1-afb900c9cdcf",
"BookerId": "ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72",
"StartUtc": "2023-04-23T14:00:00Z",
"ScheduledStartUtc": "2023-04-23T14:00:00Z",
"ActualStartUtc": null,
"EndUtc": "2023-04-24T14:00:00Z",
"Number": "52",
"State": "Confirmed",
"Origin": "Connector",
"CommanderOrigin": null,
"OriginDetails": null,
"CreatedUtc": "2023-04-23T14:58:02Z",
"UpdatedUtc": "2023-04-23T14:58:02Z",
"ReleasedUtc": null,
"CancelledUtc": null,
"VoucherId": null,
"BusinessSegmentId": null,
"Options": {
"OwnerCheckedIn": true,
"AllCompanionsCheckedIn": true,
"AnyCompanionCheckedIn": true,
"ConnectorCheckIn": true
},
"QrCodeData": null,
"RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda",
"CreditCardId": null,
"GroupId": null,
"RequestedResourceCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f",
"AssignedResourceId": "20e00c32-d561-4008-8609-82d8aa525714",
"AvailabilityBlockId": null,
"PartnerCompanyId": null,
"TravelAgencyId": null,
"AssignedResourceLocked": false,
"ChannelNumber": "TW48ZP",
"ChannelManagerNumber": "",
"CancellationReason": null,
"Purpose": "Leisure",
"PersonCounts": [
{
"AgeCategoryId": "1f67644f-052d-4863-acdf-ae1600c60ca0",
"Count": 2
},
{
"AgeCategoryId": "ab58c939-be30-4a60-8f75-ae1600c60c9f",
"Count": 2
}
]
}
],
"Cursor": "9b59b50d-bd32-4ce5-add8-09ea0e1300e7"
}
Property
Type
Contract
Description
Reservations
array of Reservations
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 againts.
AccountId
string
required
Unique identifier of the Customer or a Company who owns the reservation.
AccountType
string
required
A discriminator specifying the type of account, 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 Customer on whose behalf the reservation was made.
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.
ScheduledStartUtc
string
required
Scheduled start time of reservation in UTC timezone in ISO 8601 format.
ActualStartUtc
string
optional
Actual customer check-in time of reservation in UTC timezone in ISO 8601 format.
EndUtc
string
required
Scheduled end time of reservation in UTC timezone in ISO 8601 format.
Number
string
required
Confirmation number of the reservation in Mews.
State
required
State of the reservation.
Origin
required
Origin of the reservation.
CommanderOrigin
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 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.
VoucherId
string
optional
Unique identifier of the Voucher that has been used to create reservation.
BusinessSegmentId
string
optional
Identifier of the reservation Business segment.
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 Company that mediated the reservation.
AssignedResourceLocked
bool
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
optional
Cancellation reason of the reservation.
ReleasedUtc
string
optional
Date when the optional reservation is released in UTC timezone in ISO 8601 format.
Purpose
optional
Purpose of the reservation.
Options
optional
Options of the reservations.
QrCodeData
string
optional
Reservation data for QR code generation.
PersonCounts
array of Person count
required
Number of people per age category the reservation was booked for.

Person count

Property
Type
Contract
Description
AgeCategoryId
string
required
Unique identifier of the Age category.
Count
integer
required
Number of people of a given age category. Only positive value is accepted.

Reservation state

  • Enquired - Confirmed neither by the customer nor enterprise.
  • Requested - Confirmed by the customer but not by the enterprise (waitlist).
  • Optional - Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest).
  • Confirmed - Confirmed by both parties, before check-in.
  • Started - Checked in.
  • Processed - Checked out.
  • Canceled - Canceled.

Reservation origin

  • Distributor - Reservation from the Mews Booking Engine or Booking Engine API
  • ChannelManager - Reservation from a channel integration
  • Commander - Reservation from Mews Operations
  • Import - Reservation from an import process
  • Connector - Reservation from the Mews Connector API
  • Navigator - Reservation from Mews Guest Services
  • ...

Reservation purpose

  • Leisure
  • Business
  • Student
  • ...

Reservation group

Property
Type
Contract
Description
Id
string
required
Unique identifier of the reservation group.
Name
string
optional
Name of the reservation group, might be empty or same for multiple groups.

Order note

Property
Type
Contract
Description
Id
string
required
Unique identifier of the note.
OrderId
string
required
Unique identifier of the order or Reservation.
Text
string
required
Value of the note.
Type
string Order note type
required
Type of the note.
CreatedUtc
string
required
Creation date and time of the note in UTC timezone in ISO 8601 format.

Order note type

  • General
  • ChannelManager
  • ...

QrCode data

Property
Type
Contract
Description
ReservationId
string
required
Unique identifier of the reservation.
Data
string
required
Reservation data for QR code generation.

Get all reservations (ver 2017-04-12)

Deprecated!

This operation is deprecated, please use Get all reservations (ver 2023-06-06) instead.
Returns all reservations specified by any identifier, customer or other filter. At least one filter must be present. Note this operation uses Pagination.

Request

[PlatformAddress]/api/connector/v1/reservations/getAll
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"StartUtc": "2016-01-01T00:00:00Z",
"EndUtc": "2016-01-07T00:00:00Z",
"ServiceIds": [
"bd26d8db-86da-4f96-9efc-e5a4654a4a94"
],
"ReservationIds": [
"db6cad34-9a91-448b-bea1-abbe01240d9c"
],
"CustomerIds": [
"8e1d0ca6-1dde-4be0-8566-aafc01866110"
],
"RateIds": [
"ed4b660b-19d0-434b-9360-a4de2ea42eda"
],
"ChannelNumbers": [
"TW48ZP"
],
"States": [
"Started"
],
"Extent": {
"Reservations": true,
"ReservationGroups": true,
"Customers": true
},
"Limitation": {
"Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7",
"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.
TimeFilter
optional
Time filter of the interval. If not specified, reservations Colliding with the interval are returned.
StartUtc
string
optional, max length 3 months
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, max length 3 months
End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.
ServiceIds
array of string
required, max 1000 items
Unique identifiers of the Services from which the reservations are requested.
ReservationIds
array of string
optional, max 1000 items
Unique identifiers of the requested Reservations.
GroupIds
array of string
optional, max 1000 items
Unique identifiers of the requested Reservation groups.
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.
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.
BusinessSegmentIds
array of string
optional, max 1000 items
Unique identifiers of Business segments assigned to the reservations.
Numbers
array of string
optional, max 1000 items
Confirmation numbers of Reservations.
States
array of string Reservation state
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
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.
Currency
string
optional
ISO-4217 code of the Currency the item costs should be converted to.
Limitation
required
Limitation on the quantity of reservation data returned.

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

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

Response

{
"BusinessSegments": null,
"Customers": [
{
"Address": null,
"BirthDate": null,
"BirthPlace": null,
"CategoryId": null,
"Classifications": [],
"CreatedUtc": "2016-01-01T00:00:00Z",
"Email": null,
"FirstName": "John",
"Sex": null,
"Id": "35d4b117-4e60-44a3-9580-c582117eff98",
"IdentityCard": null,
"LanguageCode": null,
"LastName": "Smith",
"LoyaltyCode": null,
"NationalityCode": "US",
"Notes": "",
"Number": "1",
"Passport": null,
"Phone": "00420123456789",
"SecondLastName": null,
"TaxIdentificationNumber": null,
"Title": null,
"UpdatedUtc": "2016-01-01T00:00:00Z",
"Visa": null
}
],
"OrderItems": null,
"Products": null,
"RateGroups": null,
"Rates": null,
"ReservationGroups": [
{
"Id": "c704dff3-7811-4af7-a3a0-7b2b0635ac59",
"Name": "13-12-Smith-F712"
}
],
"Reservations": [
{
"Id": "bfee2c44-1f84-4326-a862-5289598f6e2d",
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
"GroupId": "94843f6f-3be3-481b-a1c7-06458774c3df",
"Number": "52",
"ChannelNumber": "TW48ZP",
"ChannelManager": "",
"ChannelManagerGroupNumber": null,
"ChannelManagerNumber": null,
"State": "Processed",
"Origin": "Connector",
"OriginDetail": null,
"Purpose": "Student",
"CreatedUtc": "2016-02-20T14:58:02Z",
"UpdatedUtc": "2016-02-20T14:58:02Z",
"CancelledUtc": null,
"StartUtc": "2016-02-20T13:00:00Z",
"EndUtc": "2016-02-22T11:00:00Z",
"ReleasedUtc