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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| 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. |
| array of string | optional, max 1000 items | Unique identifiers of the Reservations. |
| array of string | optional, max 1000 items | Unique identifiers of the Services. If not provided, all bookable services are used. |
| array of string | optional, max 1000 items | Unique identifiers of Reservation groups. |
| array of string | optional, max 1000 items | |
| array of string | optional, max 1000 items | Unique identifiers of the Resources assigned to the reservations. |
| optional, max length 3 months | Interval in which the Reservation was created. | |
| optional, max length 3 months | Interval in which the | |
| optional, max length 3 months | Interval in which the reservations are active. This is defined for a | |
| optional, max length 3 months | Interval filtering Reservations by their scheduled start time. | |
| array of Service order state | optional | A list of service order states to filter by. |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Reservation (ver 2023-06-06) | required | The reservations of the enterprise. |
| 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 |
---|---|---|---|
| string | required | Unique identifier of the reservation. |
| string | required | Unique identifier of the |
| string | required | Unique identifier of the Customer or a Company who owns the reservation. |
| required | ||
| string | required | Unique identifier of the user who created the reservation. |
| string | required | Unique identifier of the user who updated the reservation. |
| string | optional | Unique identifier of the Customer on whose behalf the reservation was made. |
| string | required | Confirmation number of the reservation in Mews. |
| required | State of the reservation. | |
| required | Origin of the reservation. | |
| optional | Further detail about origin in case of Origin | |
| string | optional | Details about the reservation |
| string | required | Creation date and time of the reservation in UTC timezone. |
| string | required | Last update date and time of the reservation in UTC timezone. |
| string | optional | Cancellation date and time in UTC timezone. |
| string | optional | Unique identifier of the |
| string | optional | Identifier of the reservation |
| required | Options of the reservation. | |
| string | required | Identifier of the reservation |
| string | optional | Unique identifier of the Credit card. |
| string | required | Unique identifier of the Reservation group. |
| string | required | Unique identifier of the Resource category. |
| string | optional | Identifier of the assigned Resource. |
| string | optional | Unique identifier of the Availability block the reservation is assigned to. |
| string | optional | Identifier of the |
| string | optional | Identifier of the Travel Agency ( |
| boolean | required | Whether the reservation is locked to the assigned Resource and cannot be moved. |
| 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). |
| string | optional | Unique number of the reservation within the reservation group. |
| optional | Cancellation reason of the reservation. | |
| string | optional | Date when the optional reservation is released in UTC timezone. |
| string | required | Scheduled start time of reservation in UTC timezone. |
| string | optional | Actual customer check-in time of reservation in UTC timezone. |
| string | required | Scheduled end time of reservation in UTC timezone in ISO 8601 format. |
| string | optional | Actual end time of reservation in UTC timezone in ISO 8601 format. |
| optional | Purpose of the reservation. | |
| string | optional | QR code data of the reservation. |
| array of Age category parameters | required | Number of people per age category the reservation was booked for. |
|
|
|
|
|
|
|
|
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
Service Order Options
Property | Type | Contract | Description |
---|---|---|---|
| boolean | required | Owner of the reservation checked in. |
| boolean | required | All companions of the reservation checked in. |
| boolean | required | Any of the companions of the reservation checked in. |
| 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
Age category parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Age category. |
| integer | required | Number of people of a given age category. Only positive value is accepted. |
Get all reservations (ver 2017-04-12)
Deprecated!This operation is deprecated. Use reservations/getAll/2023-06-06.
Request
[PlatformAddress]/api/connector/v1/reservations/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Unique identifiers of the Services from which the reservations are requested. |
| array of string | optional, max 1000 items | Unique identifiers of the requested Reservation groups. |
| array of string | optional, max 1000 items | Unique identifiers of the requested Reservations. |
| array of string | optional, max 1000 items | Unique identifiers of the Customers which own the reservations. |
| array of string | optional, max 1000 items | Unique identifiers of Resources assigned to the reservations. |
| array of string | optional, max 1000 items | Unique identifiers of Rates assigned to the reservations. |
| array of string | optional, max 1000 items | Unique identifiers of Business segments assigned to the reservations. |
| 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. |
| array of string | optional, max 1000 items | Confirmation numbers of Reservations. |
| 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. |
| 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. |
| required | Time filter of the interval. If not specified, reservations Colliding with the interval are returned. | |
| string | optional | ISO-4217 code of the Currency the item costs should be converted to. |
| 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. |
| 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. | |
| required | Limitation on the quantity of data returned. | |
|
|
| 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 |
---|---|---|---|
| boolean | optional | Whether the response should contain reservations. |
| boolean | optional | Whether the response should contain groups of the reservations. |
| boolean | optional | Whether the response should contain customers of the reservations. |
| boolean | optional | Whether the response should contain addresses of the customers. |
| boolean | optional | Whether the response should contain identity documents of the customers. |
| boolean | optional | Whether the response should contain services reserved by the reservations. |
| boolean | optional | Whether the response should contain products orderable with the reservations. |
| boolean | optional | Whether the response should contain business segmentation. |
| boolean | optional | Whether the response should contain resources. |
| boolean | optional | Whether the response should contain resource categories. |
| boolean | optional | Whether the response should contain assignments of the resources to categories. |
| boolean | optional | Whether the response should contain rates and rate groups. |
| boolean | optional | Whether the response should contain accounting items. |
| boolean | optional | Whether the response should contain reservation items. |
| boolean | optional | Whether the response should contain notes. |
| boolean | optional | Whether the response should contain QR code data. |
| boolean | optional | Whether the response should contain companies. |
| array of Order item accounting state | optional | States the items should be in. If not specified, items in |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Reservation (ver 2017-04-12) | optional | The reservations that collide with the specified interval. |
| array of Reservation groups (ver 2017-04-12) | optional | Reservation groups that the reservations are members of. |
| array of Customer | optional | Customers that are members of the reservations. |
| array of Service | optional | Services that have been reserved. |
| array of Product | optional | Products orderable with reservations. |
| array of Resource | optional | Assigned resources of the reservations. |
| array of Resource category | optional | Resource categories of the resources. |
| array of Resource category assignment | optional | Assignments of the resources to categories. |
| array of Business segment | optional | Business segments of the reservations. |
| array of Rate | optional | Rates of the reservations. |
| array of Rate group (ver 2017-04-12) | optional | Rate groups of the reservation rates. |
| array of Accounting item | optional | Accounting items that are part of the reservations. |
| array of Order item | optional | Revenue items of the reservations. |
| array of Service order note | optional | Notes of the reservations. |
| array of Reservation QR code data | optional | QR code data of the reservations. |
| array of Company | optional | Companies related to the reservations. |
| array of Resource access token | optional | Resource access tokens for the reservations. |
| 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 |
---|---|---|---|
| string | required | Unique identifier of the reservation. |
| string | required | Unique identifier of the Service that is reserved. |
| string | required | Unique identifier of the Reservation group. |
| string | required | Confirmation number of the reservation in Mews. |
| 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). |
| string | optional | Unique number of the reservation within the reservation group. |
| string | optional | Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews. |
| string | optional | Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc). |
| required | ||
| required | ||
| string | optional | Details about the reservation origin. |
| required | Purpose of the reservation. | |
| string | required | Creation date and time of the reservation in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the reservation in UTC timezone in ISO 8601 format. |
| string | optional | Cancellation date and time in UTC timezone in ISO 8601 format. |
| 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. |
| string | required | End of the reservation (departure) in UTC timezone in ISO 8601 format. |
| string | optional | Date when the optional reservation is released in UTC timezone in ISO 8601 format. |
| string | required | Identifier of the requested Resource category. |
| string | optional | Identifier of the assigned Resource. |
| boolean | required | Whether the reservation is locked to the assigned Resource and cannot be moved. |
| string | optional | Identifier of the reservation Business segment. |
| string | optional | Identifier of the Company on behalf of which the reservation was made. |
| string | optional | Identifier of the Company that mediated the reservation. |
| string | optional | Unique identifier of the Availability block the reservation is assigned to. |
| string | required | Identifier of the reservation Rate. |
| string | optional | Unique identifier of the Voucher that has been used to create reservation. |
| string | optional | Unique identifier of the Credit card. |
| required | Cancellation reason of the reservation. | |
| array of Age category parameters | required | Number of people per age category the reservation was booked for. |
| string | required | Unique identifier of the Customer or Company who owns the reservation. |
| string | optional | Unique identifier of the Customer on whose behalf the reservation was made. |
| required | Options of the reservation. | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Service order state (ver 2017-04-12)
Enquired
Confirmed
Started
Processed
Canceled
Optional
Requested
Reservation origin (ver 2017-04-12)
Distributor
- From the Mews Booking Engine or Booking Engine API.ChannelManager
- From a channel manager.Import
- From an import process.Connector
- From the Mews Connector API.Navigator
- From Mews Guest Services.CommanderInPerson
- From Mews Operations, in person.CommanderChannel
- From Mews Operations, via channel.CommanderPhone
- From Mews Operations, via telephone.CommanderEmail
- From Mews Operations, via email.CommanderWebsite
- From Mews Operations, via website.CommanderMessage
- From Mews Operations, via message person.CommanderCallCenter
- From Mews Operations, via call center.
Reservation purpose
Leisure
Business
Student
CancellationReason
Other
ConfirmationMissed
BookedElsewhere
ForceMajeure
GuestComplaint
NoShow
PriceTooHigh
ServiceNotAvailable
InputError
InvalidPayment
TravelAgency
RequestedByGuest
Update
BookingAbandoned
RequestedByBooker
Reservation options
Property | Type | Contract | Description |
---|---|---|---|
| boolean | required | Owner of the reservation checked in. |
| boolean | required | All companions of the reservation checked in. |
| boolean | required | Any companion of the reservation checked in. |
Reservation groups (ver 2017-04-12)
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the reservation group. |
| string | optional | Name of the reservation group. |
Reservation QR code data
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the reservation. |
| string | optional | Reservation data for QR code generation. |
Get all reservation items
Deprecated!This operation is deprecated. Use orderItems/getAll.
Request
[PlatformAddress]/api/connector/v1/reservations/getAllItems
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Unique identifiers of the reservation. |
| string | optional | ISO-4217 code of the Currency the item costs should be converted to. |
| array of string | optional | States the items should be in. If not specified, items in Open or Closed states are returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Reservation items | required | The reservations with their items. |
Reservation items
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the reservation. |
| array of Accounting item | required | Accounting items associated with the reservation. |
| array of Order item | required | Order items associated with the reservation. |
Add reservations
Adds the specified reservations as a single group. If GroupId
is specified, adds the reservations to an already existing group. Note that all reservations linked to an availability block must belong to the same reservation group.
Request
[PlatformAddress]/api/connector/v1/reservations/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. |
| string | required | Unique identifier of the |
| string | optional | Unique identifier of the |
| string | optional | Name of the |
| array of Reservation parameters | required, max 1000 items | Parameters of the new reservations. |
| boolean | optional | Indicates whether the system will check and prevent a booking being made using a restricted rate, e.g. a private rate. The default is |
| boolean | optional | Indicates whether the system will check and prevent a booking being made in the case of an overbooking, i.e. where there is an insufficient number of resources available to meet the request. The default is |
| boolean | optional | Whether the confirmation email is sent. Default value is |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Added reservation | required | The added reservations. |
Added reservation
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | Identifier of the reservation within the transaction. |
| required | The added reservation. |
Update reservations
Updates information about the specified reservations. Note that if any of the fields are sent as null
, it won't clear the field in Mews. If the Value
within the object is sent as null
, the field will be cleared in Mews. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/reservations/update
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. |
| string | required | Unique identifier of the reservation. |
| 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) (or | |
| optional | Reservation start in UTC timezone in ISO 8601 format. (or | |
| optional | Reservation end in UTC timezone in ISO 8601 format. (or | |
| optional | Date when the optional reservation is released in UTC timezone in ISO 8601 format. (or | |
| optional | Number of people per age category the reservation is for. If supplied, the person counts will be replaced. (or | |
| optional |