Add reservations
POST /api/connector/v1/reservations/add
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 Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
Unique identifier of the Service to be reserved.
Unique identifier of the ReservationGroup where the reservations are added. If not specified, a new group is created.
Name of the ReservationGroup where the reservations are added to. If GroupId is specified, this field is ignored. If not specified, the group name is automatically created.
Parameters of the new reservations.
object
Identifier of the reservation within the transaction.
Reservation start in UTC timezone in ISO 8601 format.
Reservation end in UTC timezone in ISO 8601 format.
Release date and time of an unconfirmed reservation in UTC timezone in ISO 8601 format.
Number of people per age category the reservation was booked for. At least one category with valid count must be provided.
object
Unique identifier of the Age category.
Number of people of a given age category. Only positive value is accepted.
Unique identifier of the Customer who owns the reservation.
Unique identifier of the Customer on whose behalf the reservation was made.
Identifier of the requested ResourceCategory.
Identifier of the reservation Rate.
Voucher code value providing access to specified private Rate applied to this reservation.
Identifier of CreditCard belonging either to the Customer who owns the reservation or to the Booker.
Identifier of the Company that mediated the reservation.
Identifier of the Company on behalf of which the reservation was made.
Identifier of the reservation BusinessSegment.
Additional notes.
Amount of each night of the reservation.
object
Prices for time units of the reservation. E.g. prices for the first or second night.
object
Index of the unit. Indexing starts with 0. E.g. the first night of the reservation has index 0.
Amount of the unit.
object
Parameters of the products ordered together with the reservation.
object
Price of the product that overrides the price defined in Mews.
object
Unique identifier of the AvailabilityBlock the reservation is assigned to.
Indicates whether the system will check and prevent a booking being made using a restricted rate, e.g. a private rate. The default is true, i.e. the system will normally check for this unless the property is set to false.
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 true, i.e. the system will normally check for this unless the property is set to false.
Whether the confirmation email is sent. Default value is true.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "GroupId": null, "GroupName": null, "SendConfirmationEmail": true, "Reservations": [ { "Identifier": "1234", "State": "Confirmed", "StartUtc": "2021-01-01T14:00:00Z", "EndUtc": "2021-01-03T10:00:00Z", "ReleasedUtc": null, "CustomerId": "e465c031-fd99-4546-8c70-abcf0029c249", "BookerId": "e465c031-fd99-4546-8c70-abcf0029c249", "RequestedCategoryId": "0a5da171-3663-4496-a61e-35ecbd78b9b1", "RateId": "a39a59fa-3a08-4822-bdd4-ab0b00e3d21f", "TravelAgencyId": null, "CompanyId": null, "Notes": "Test reservation", "TimeUnitAmount": null, "PersonCounts": [ { "AgeCategoryId": "1f67644f-052d-4863-acdf-ae1600c60ca0", "Count": 2 }, { "AgeCategoryId": "ab58c939-be30-4a60-8f75-ae1600c60c9f", "Count": 2 } ], "TimeUnitPrices": [ { "Index": 0, "Amount": { "Currency": "GBP", "GrossValue": 20, "TaxCodes": [ "UK-S" ] } }, { "Index": 1, "Amount": { "Currency": "GBP", "GrossValue": 30, "TaxCodes": [ "UK-S" ] } } ], "ProductOrders": [ { "ProductId": "2e9eb3fc-8a77-466a-9cd9-abcf002a2a01", "StartUtc": "2021-01-02T00:00:00Z", "EndUtc": "2021-01-03T00:00:00Z" } ], "AvailabilityBlockId": null, "VoucherCode": "SpringSale2021" } ]}Responses
Section titled “ Responses ”OK
object
The added reservations.
object
Identifier of the reservation within the transaction.
The added reservation.
object
Unique identifier of the reservation.
Unique identifier of the Service that is reserved.
Unique identifier of the Reservation group.
Confirmation number of the reservation in Mews.
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.
Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews.
Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc).
Details about the reservation origin.
Creation date and time of the reservation in UTC timezone in ISO 8601 format.
Last update date and time of the reservation in UTC timezone in ISO 8601 format.
Cancellation date and time in UTC timezone in ISO 8601 format.
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.
End of the reservation (departure) in UTC timezone in ISO 8601 format.
Date when the optional reservation is released in UTC timezone in ISO 8601 format.
Identifier of the requested Resource category.
Identifier of the assigned Space.
Whether the reservation is locked to the assigned Space and cannot be moved.
Identifier of the assigned Resource.
Whether the reservation is locked to the assigned Resource and cannot be moved.
Identifier of the reservation Business segment.
Identifier of the Company on behalf of which the reservation was made.
Identifier of the Company that mediated the reservation.
Unique identifier of the Availability block the reservation is assigned to.
Identifier of the reservation Rate.
Unique identifier of the Voucher that has been used to create reservation.
Unique identifier of the Credit card.
Count of adults the reservation was booked for.
Count of children the reservation was booked for.
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 Customer or Company who owns the reservation.
Unique identifier of the Customer who owns the reservation.
Unique identifier of the Customer on whose behalf the reservation was made.
Unique identifiers of the Customers that will use the resource.
Channel Manager number.
Options of the reservation.
object
Owner of the reservation checked in.
All companions of the reservation checked in.
Any companion of the reservation checked in.
Example
{ "Reservations": [ { "Identifier": "1234", "Reservation": { "Id": "bfee2c44-1f84-4326-a862-5289598f6e2d", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "GroupId": "94843f6f-3be3-481b-a1c7-06458774c3df", "Number": "52", "ChannelManager": "", "ChannelManagerGroupNumber": null, "ChannelManagerNumber": null, "ChannelNumber": null, "State": "Processed", "Origin": "Connector", "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": null, "RequestedCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f", "AssignedResourceId": "20e00c32-d561-4008-8609-82d8aa525714", "AssignedResourceLocked": false, "BusinessSegmentId": null, "CompanyId": null, "TravelAgencyId": null, "AvailabilityBlockId": null, "RateId": "ed4b660b-19d0-434b-9360-a4de2ea42eda", "VoucherId": null, "CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98", "CompanionIds": [ "b22bf671-ccdf-40aa-a7e6-b20a4f91d79a" ] } } ]}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.