Reservations
Process group
[async
] Use this operation to push a group of reservations or bookings to Mews. The operation is called Process Group because it supports multiple options for processing on multiple groups of reservations. As well as creating new reservations in Mews, you can modify existing reservations and make cancellations, all using the same endpoint. Mews will process the requests and confirm back the reservations asynchronously.
Rules to followThere are certain rules that need to be followed in order for Mews to process the group correctly:
It is required to send multiple related reservations in one group as part of one message.
The whole group is uniquely identified by
channelManagerId
in Mews and in the channel manager extranet.Each reservation should have a unique code within the group. The same code for the reservation should be provided in any following modification message.
Each reservation in the group can have different
start
,end
,spaceTypeCode
,ratePlanCode
.Group total cost
group.totalAmount
is the sum of allreservation.totalAmount
objects in the group, which is the sum of all night amounts and total amounts of allextras
of thereservation
.
If for any reason the sum of the
reservation.totalAmount
objects is different, Mews will automatically distribute the missing/additional amount to the nights, so thegroup.totalAmount
is achieved.Reservation
group
amounts should be eithergross
ornet
. Either bothgross
andnet
amounts, or one of them should be sent.When modifying some reservations from a multi-reservation group, the whole group definition with all other unchanged reservations needs to be sent, i.e. Mews doesn't process diffs.
When cancelling a reservation from a multi-reservation group, all remaining reservations need to be present in the group definition as well.
There are two ways to cancel a reservation from a multi-reservation group:
If the
reservation.state
is set to Reservation State 'Canceled'.If the reservation is not included in the group definition message.
When cancelling a whole group, the
reservations
collection can be empty of all reservations provided as canceled (as per case 1 above).
Request
Demo Environment:
https://sandbox.pci-proxy.com/v1/push/0426f19b66715a93
Production Environment:
https://api.pci-proxy.com/v1/push/b2721c9a0351d553
The example shows a valid group definition with two space reservations plus cancellation of a third space reservation. The first reservation
definition shows all details, the second reservation
definition shows the minimal required details for creation / modification of a reservation
. The third reservation
definition shows the partial cancellation - canceling the third space reservation.
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Client token of the channel manager. |
|
| required | Token of a concrete connection. |
|
| required | Unique identification of the message. Used for asynchronous confirmations |
|
| required | Unique identification of the booking in the channel (i.e. OTA). |
|
| required | Unique identification of the booking in the channel manager. |
|
| optional | Unique identification of the availability block in the channel manager. |
|
| required (exc. Cancellation) | 3 letter code of currency of all prices within the booking. |
|
| required (exc. Cancellation) | Total amount of the whole booking. |
|
| required (exc. Cancellation) | Payment Type code - determines whether the booking is prepaid or not. |
|
| required (exc. Cancellation) | Represents the main booker. Does not necessarily mean that the person arrives to the property. |
|
| optional | Represents the payment card of the |
|
|
|
|
|
| optional | Represents the sources for the booking. |
|
| optional | Represents the company associated with the booking. |
|
| optional | Represents the travel agency associated with the booking. |
|
| optional | Each reservation within the booking. If the value is null or an empty collection, this implies that the whole group will be canceled. |
|
| optional | Represents any comments related to the booking. |
Customer
Property | Type | Contract | Description |
---|---|---|---|
|
| recommended | Email. |
|
| required | Last name. |
|
| optional | First name. |
|
| optional | Customer title, e.g. "Mister" |
|
| optional | Telephone. |
|
| optional | Loyalty code of the customer. Processed only for the main customer. |
|
| optional | Loyalty information of the customer. Processed only for the main customer or |
|
| optional | ISO 3166-1 alpha-2 country code - two letter country code or ISO 3166-1 alpha-3 country code - three letter country code. |
|
| optional | Language code of the communication language of the customer. This language will be used as the default for communication with the customer. |
|
| optional | Represents address. |
Loyalty Info
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Loyalty membership identifier of the Customer. |
|
| optional | Loyalty program code. |
|
| optional | Loyalty tier code. |
Title
Mister
Misses
Miss
Company
Property | Type | Contract | Description |
---|---|---|---|
|
| optional | Identifier of company. |
|
| optional | Name of company. |
|
|
|
|
|
| optional | Company contact information. |
Travel Agency
Property | Type | Contract | Description |
---|---|---|---|
|
| optional | IATA number of travel agency. |
|
| optional | Name of travel agency. |
|
| optional | Travel agency contact information. |
Contact
Property | Type | Contract | Description |
---|---|---|---|
|
| recommended | Contact email address. |
|
| optional | Contaact telephone number. |
|
| optional | Contact address. |
Payment card
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Payment Card Type code. |
|
| required | Payment card number. Only numbers allowed. |
|
| required | Expiration date of card in |
|
| optional | Card CVV code. The value cannot be |
|
| optional | Card holder name. |
Payment Card Types
Code | Description |
---|---|
| Visa |
| Master Card |
| American Express |
| Bank Card |
| Carte Bleu |
| Carte Blanche |
| Diners Club |
| Discover Card |
| Eurocard |
| Japanese Credit Bureau |
| Universal Air Travel |
| China Unionpay |
| Maestro |
Source
Property | Type | Contract | Description |
---|---|---|---|
|
| required (exc. new unknown sources) | Code number of the source or channel. |
|
| required | Name of the source or channel. |
|
| required | Source Type code. |
|
| required | Indicates which source is the primary source for the booking. |
Source Types
Code | Description |
---|---|
| Online Travel Agency |
| Central Reservation System |
| Global Distribution System |
| Alternative Distribution System |
| Sales And Catering System |
| Property Management System |
| Tour Operator System |
| Online Booking Engine |
| Kiosk |
| Agent |
Reservation
Property | Type | Contract | Description |
---|---|---|---|
|
| required (exc. Mews to ChM.) | Unique code of the reservation within the whole booking. Any value but |
|
| required (exc. ChM to Mews.) | Unique code of the reservation within the whole booking in Mews. No characters limit. |
|
| required (exc. Cancellation) | Space type code of the reservation. |
|
| required (exc. Cancellation) | Rate type code of the reservation. |
|
| required (exc. Cancellation) | Start date in format |
|
| required (exc. Cancellation) | End date (exclusive) in format |
|
| required (exc. Cancellation) | Total amount of the reservation. |
| array of | required | Number of guests in the reservation for each age category. |
|
| optional | Reservation State code of reservation state. If not provided, Mews will handle the reservation as |
|
| required (exc. Cancellation) | Collection of amounts for each night of the reservation. The count of amounts in this collection has to correspond with number of nights in the reservation. |
|
| optional | Collection of extra ordered products for the reservation (e.g. Breakfast). Their total amount is included in the |
|
| optional | Collection of guests that will arrive to the property. |
|
| required (used only in CHM: Process group operation) | Reservation Time State code of reservation state. |
|
| optional (used only in CHM: Process group operation) | Represents the payment card of the |
|
|
|
|
|
|
|
|
Codes: It is required that
code
remains the same within each booking modification message and partial modification message. If this can't be achieved because the channel doesn't provide it, simple generation of codes "01", "02", ... will suffice as long as those codes are generated in the same way for each message regarding that one booking.
From/To: This represents the reservation arrival,
from
is arrival date,to
is departure date. So reservation for 2 nights (e.g. 2021-12-24/25 and 2021-12-25/26 is represented as"from": "2021-12-24", "to": "2021-12-26"
).
Payment Card Data
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Payment Card Type code. |
|
| required | Obfuscated payment card number. |
|
| required | Expiration date of card in |
|
| required | Mews identifier of the payment card. |
|
| optional | Card holder name. |
Guest Count
Property | Type | Contract | Description |
---|---|---|---|
|
| required | |
|
| required | Number of persons for specified age category. |
Age Category Code
Infant
Child
Teenager
Adult
SeniorCitizen
Reservation States
Code | Description |
---|---|
| Created |
| Modified |
| Canceled |
Reservation Time States
Code | Description |
---|---|
| Optional - any tentative reservation that has not been confirmed yet. By default Mews does not synchronize such reservations to Channel Managers. |
| Confirmed - reservation with arrival date in the future. |
| CheckedIn - reservation that is currently checked-in. |
| CheckedOut - reservation that is already checked out (i.e. past reservation) |
| Canceled - reservation that is canceled. |
| NoShow - reservation that is canceled with |
Extra
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Mapping code of the extra product. |
|
| required | Total amount of the extra product. |
|
| required | Count of extra products ordered. |
|
| optional (exc. Cancellation) | Start date in format |
|
| optional (exc. Cancellation) | End date in format |
|
| required |
|
Extra product cost
The total cost of the extra product should be sent in
amount
.
amount
can include onlygross
, onlynet
, or bothgross
andnet
.
from
andto
can define any interval within the reservation dates, but they cannot be the same date. For example, if a reservation is from 2025-10-12 to 2025-10-15, then the extrafrom
andto
cannot be specified as 2025-10-12 to 2025-10-12.
Negative amounts
The cost for an extra product can be negative, i.e. less than zero.
If a reservation night price is negative, the reservation will fail.
If extra product costs are negative, their value will be deducted from the reservation night price.
As long as the resulting reservation price (after deducting the cost of the extra products) is positive, all is well.
If the resulting reservation price (after deducting the cost of the extra products) is negative, the reservation will still pass and be processed, however this can create complications for the property and they may have to re-price it.
It is recommended to send extras per room or space, because it is less likely that the resulting reservation price will fall below zero.
Amount
Property | Type | Contract | Description |
---|---|---|---|
|
| optional | Price with taxes excluded. |
|
| optional | Price with taxes included. |
Extra Pricing Types
Code | Description |
---|---|
| Once per reservation. |
| Per person - for each guest of reservation. |
| Per night - for each night of reservation. |
| Per person per night - for each guest for each night of reservaion. |
Response
Synchronous simple response will determine whether the reservations or bookings were accepted for processing or not. Confirmation will be sent asynchronously using the Confirm booking operation.
Confirm group confirmation
Request
[PlatformAddress]/api/channelManager/v1/processGroupConfirmation
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Client token of the channel manager. |
|
| required | Token of a concrete connection. |
|
| required | Id of message which requests relates to. |
|
| required | Determinines the result of the operation. |
| array of | optional | In case of |
|
| required | Unique reference code from external system for the group. Will be sent with every group changes. |
|
| optional | Confirmation details for each individual reservation in the group. |
Reservation Confirmation
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Unique reference code for the individual reservation. Will be sent back with group changes. |
|
| required | Mews confirmation number for the individual reservation. |
Response
Synchronous simple response is expected.
Last updated