Reservations

Search…
Reservations
Get all reservations
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"
    ],
    "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
string Reservation time filter​
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.
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
​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.
Currency
string
optional
ISO-4217 code of the Currency the item costs should be converted to.
Limitation
​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",
            "ChannelManager": "",
            "ChannelManagerGroupNumber": null,
            "ChannelManagerNumber": null,
            "ChannelNumber": 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": 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"
            "PersonCounts": [
                {
                    "AgeCategoryId": "1f67644f-052d-4863-acdf-ae1600c60ca0",
                    "Count": 2
                },
                {
                    "AgeCategoryId": "ab58c939-be30-4a60-8f75-ae1600c60c9f",
                    "Count": 2
                }
            ]
        }
    ],
    "Services": null,
    "Resources": null,
    "ResourceCategories": null,
    "ResourceCategoryAssignments": null,
    "Notes": null,
    "Cursor": "8d02142f-31cf-4115-90bf-ae5200c7a1ba"
}
Property
Type
Contract
Description
BusinessSegments
array of Business segment​
optional
Business segments of the reservations.
Customers
array of Customer​
optional
Customers that are members of the reservations.
OrderItems
array of Order item​
optional
Revenue items of the reservations.
Products
array of Product​
optional
Products orderable with reservations.
RateGroups
array of Rate group​
optional
Rate groups of the reservation rates.
Rates
array of Rate​
optional
Rates of the reservations.
ReservationGroups
array of Reservation group​
optional
Reservation groups that the reservations are members of.
Reservations
array of Reservation​
optional
The reservations that collide with the specified interval.
Services
array of Service​
optional
Services that have been reserved.
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.
Notes
array of Order note​
optional
Notes of the reservations.
QrCodeData
array of QrCode data​
optional
QR code data of the reservations.
Cursor
string
required
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
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
string Reservation state​
required
State of the reservation.
Origin
string Reservation origin​
required
Origin of the reservation.
OriginDetail
string
optional
Details about the reservation origin.
Purpose
string 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 (arrival) in UTC timezone in ISO 8601 format.
EndUtc
string
required
End of the reservation (departure) in UTC timezone in ISO 8601 format.
ReleasedUtc
string
optional
Date when the optional reservation is released in UTC timezone in ISO 8601 format.
RequestedCategoryId
string
required
Identifier of the requested Resource category.
AssignedResourceId
string
optional
Identifier of the assigned Resource.
AssignedResourceLocked
bool
required
Whether the reservation is locked to the assigned Resource and cannot be moved.
BusinessSegmentId
string
optional
Identifier of the reservation Business segment.
CompanyId
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.
AvailabilityBlockId
string
optional
Unique identifier of the Availability block the reservation is assigned to.
RateId
string
required
Identifier of the reservation Rate.
VoucherId
string
optional
Unique identifier of the Voucher that has been used to create reservation.
CustomerId
string
required
Unique identifier of the Customer who owns the reservation.
PersonCounts
array of Age category​
required
Number of people per age category the reservation was booked for.
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
ChannelManager
Commander
Import
Connector
Navigator
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 reservation items
Returns all revenue items associated with the specified reservations.
Request
[PlatformAddress]/api/connector/v1/reservations/getAllItems
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ReservationIds": [
        "e6ea708c-2a2a-412f-a152-b6c76ffad49b"
    ],
    "Currency": "EUR",
    "AccountingStates": [
        "Closed"
    ]
}
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.
ReservationIds
array of string
required, max 1000 items
Unique identifiers of the Reservations.
Currency
string
optional
ISO-4217 code of the Currency the item costs should be converted to.
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
{
    "Reservations": [
        {
            "ReservationId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
            "OrderItems": [
                {
                    "Id": "784a29df-6196-4402-96a0-58695a881239",
                    "AccountId": "d73a087a-00c7-40cf-9372-314d0296334d",
                    "OrderId": "e6ea708c-2a2a-412f-a152-b6c76ffad49b",
                    "BillId": "7fdc2957-bc08-44d3-ba2a-1c1760a84894",
                    "AccountingCategoryId": "0cf7aa90-736f-43e9-a7dc-787704548d86",
                    "Amount": {
                        "Currency": "EUR",
                        "NetValue": 19.38,
                        "GrossValue": 23.26,
                        "TaxValues": [
                            {
                                "Code": "UK-S",
                                "Value": 3.88
                            }
                        ],
                        "Breakdown": {
                            "Items": [
                                {
                                    "TaxRateCode": "UK-S",
                                    "NetValue": 19.38,
                                    "TaxValue": 3.88
                                }
                            ]
                        }
                    },
                    "RevenueType": "Service",
                    "ConsumedUtc": "2016-03-10T13:00:00Z",
                    "ClosedUtc": "2016-04-06T06:41:44Z",
                    "AccountingState": "Closed",
                    "Data": {
                        "Discriminator": "ProductOrder",
                        "Value": {
                            "ProductId": "a3f4e006-b3e4-4485-8a00-ad11015ac494"
                        }
                    }
                }
            ]
        }
    ]
}
Property
Type
Contract
Description
Reservations
array of Reservation items​
required
The reservations with their items.
Reservation items
Property
Type
Contract
Description
ReservationId
string
required
Unique identifier of the Reservation.
OrderItems
array of Order item​
required
The items associated with the reservation.
Price reservations
Returns prices of reservations with the specified parameters.
Request
[PlatformAddress]/api/connector/v1/reservations/price
{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
    "Reservations": [
        {
            "Identifier": "1234",
            "StartUtc": "2018-01-01T14:00:00Z",
            "EndUtc": "2018-01-02T10:00:00Z",
            "RequestedCategoryId": "0a5da171-3663-4496-a61e-35ecbd78b9b1",
            "RateId": "33667cab-f17f-4089-ad07-c2cd50fa0df1",
            "Notes": "Test reservation",
            "ProductOrders": [
                {
                    "ProductId": "3dc5d79b-67ce-48ed-9238-47fcf5d1a59f"
                }
            ],
            "PersonCounts": [
                {
                    "AgeCategoryId": "1f67644f-052d-4863-acdf-ae1600c60ca0",
                    "Count": 2
                },
                {
                    "AgeCategoryId": "ab58c939-be30-4a60-8f75-ae1600c60c9f",
                    "Count": 2
                }
            ]
        }
    ]
}
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.
ServiceId
string
required
Unique identifier of the Service to be priced.
Reservations
array of Reservation parameters​
required
Parameters of the reservations to price. Note that CustomerId is not required when pricing reservations.
Response
{
    "ReservationPrices": [
        {
            "Identifier": "1234",
            "Total": {
                "Currency": "GBP",
                "NetValue": 20,
                "GrossValue": 23
                "TaxValues": [
                    {
                       "Code":"UK-S",
                       "Value": 3
                    }
                ],
            }
        }
    ]
}
Property
Type
Contract
Description
ReservationPrices
array of Reservation price​
required
The reservation prices.
Reservation price
Property
Type
Contract
Description
Identifier
string
optional
Identifier of the reservation within the transaction.
Total
​Currency value​
required
Total price of 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
{
    "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"
        }
    ]
}
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.
ServiceId
string
required
Unique identifier of the Service to be reserved.
GroupId
string
optional
Unique identifier of the Reservation group where the reservations are added. If not specified, a new group is created.
GroupName
string
optional
Name of the Reservation group which the reservations are added to. If GroupId is specified, this field is ignored. If not specified, the group name is automatically created.
Reservations
array of Reservation parameters​
required
Parameters of the new reservations.
SendConfirmationEmail
bool
optional
Whether the confirmation email is sent. Default value is true.
CheckRateApplicability
bool
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 true, i.e. the system will normally check for this unless the property is set to false.
CheckOverbooking
bool
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*1. The default is true, i.e. the system will normally check for this unless the property is set to false.
*1 Note that the calculation for whether there is sufficient resources or not depends on both the requested resource category and the setting configured for Availability calculation strategy - see Bookable Service Settings.
Reservation parameters
Property
Type
Contract
Description
Identifier
string
optional
Identifier of the reservation within the transaction.
State
string Reservation state​
optional
State of the newly created reservation (either Optional, Enquired or Confirmed). If not specified, Confirmed is used.
StartUtc
string
required
Reservation start in UTC timezone in ISO 8601 format.
EndUtc
string
required
Reservation end in UTC timezone in ISO 8601 format.
ReleasedUtc
string
optional
Release date and time of an unconfirmed reservation in UTC timezone in ISO 8601 format.
CustomerId
string
required
Unique identifier of the Customer who owns the reservation.
BookerId
string
optional
Unique identifier of the Customer on whose behalf the reservation was made.
RequestedCategoryId
string
required
Identifier of the requested Resource category.
RateId
string
required
Identifier of the reservation Rate.
TravelAgencyId
string
optional
Identifier of the Company that mediated the reservation.
CompanyId
string
optional
Identifier of the Company on behalf of which the reservation was made.
Notes
string