Get all reservations (ver 2017-04-12)
POST /api/connector/v1/reservations/getAll
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 identifiers of the Services from which the reservations are requested.
Unique identifiers of the requested Reservation groups.
Unique identifiers of the requested Reservations.
Unique identifiers of the Customers which own the reservations.
Unique identifiers of Resources assigned to the reservations.
Unique identifiers of Rates assigned to the reservations.
Unique identifiers of Business segments assigned to the reservations.
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.
Confirmation numbers of Reservations.
Start of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.
End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter.
ISO-4217 code of the Currency the item costs should be converted to.
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 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.
object
Whether the response should contain reservations.
Whether the response should contain groups of the reservations.
Whether the response should contain customers of the reservations.
Whether the response should contain addresses of the customers.
Whether the response should contain identity documents of the customers.
Whether the response should contain services reserved by the reservations.
Whether the response should contain products orderable with the reservations.
Whether the response should contain business segmentation.
Whether the response should contain resources.
Whether the response should contain resource categories.
Whether the response should contain assignments of the resources to categories.
Whether the response should contain rates and rate groups.
Whether the response should contain accounting items.
Whether the response should contain reservation items.
Whether the response should contain notes.
Whether the response should contain QR code data.
Whether the response should contain companies.
States the items should be in. If not specified, items in Open or Closed states are returned.
Limitation on the quantity of data returned.
object
Example
{ "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 }}Responses
Section titled “ Responses ”OK
object
The reservations that collide with the specified interval.
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.
Reservation groups that the reservations are members of.
object
Unique identifier of the reservation group.
Name of the reservation group.
Customers that are members of the reservations.
object
Unique identifier of the customer.
Unique identifier of the chain.
Number of the customer.
Title of the customer.
Mister (Mr.)
Miss (Ms.)
Misses (Mrs.)
Sex of the customer.
Male
Female
First name of the customer.
Last name of the customer.
Second last name of the customer.
ISO 3166-1 code of the Country.
Language and culture code of the customer’s preferred language, according to their profile. For example: en-GB, fr-CA.
Language and culture code of the customer’s language, based on multiple sources. These sources include the preferred language specified in internal data based on previous bookings, and the preferred language of the customer specified in their profile. If neither of these sources are present, we use the native language based on the customer’s nationality. The format is, for example, en-US or fr-FR.
Date of birth in ISO 8601 format.
Place of birth.
Occupation of the customer.
Email address of the customer.
Whether the customer’s email address is a temporary email address from an OTA. For more details, see the product documentation.
Phone number of the customer (possibly mobile).
Tax identification number of the customer.
Loyalty code of the customer.
Accounting code of the customer.
Billing code of the customer.
Internal notes about the customer.
Registration number of the customer’s car.
Customer’s dietary requirements, e.g. Vegan, Halal.
Creation date and time of the customer in UTC timezone in ISO 8601 format.
Last update date and time of the customer in UTC timezone in ISO 8601 format.
object
Unique identifier of the document.
Identifier of the Customer.
Type of the document.
IdentityCard
Passport
Visa
DriversLicense
Number of the document (e.g. passport number).
Expiration date in ISO 8601 format.
Date of issuance in ISO 8601 format.
ISO 3166-1 code of the Country.
City where the document was issued.
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
object
Unique identifier of the document.
Identifier of the Customer.
Type of the document.
IdentityCard
Passport
Visa
DriversLicense
Number of the document (e.g. passport number).
Expiration date in ISO 8601 format.
Date of issuance in ISO 8601 format.
ISO 3166-1 code of the Country.
City where the document was issued.
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
object
Unique identifier of the document.
Identifier of the Customer.
Type of the document.
IdentityCard
Passport
Visa
DriversLicense
Number of the document (e.g. passport number).
Expiration date in ISO 8601 format.
Date of issuance in ISO 8601 format.
ISO 3166-1 code of the Country.
City where the document was issued.
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
object
Unique identifier of the document.
Identifier of the Customer.
Type of the document.
IdentityCard
Passport
Visa
DriversLicense
Number of the document (e.g. passport number).
Expiration date in ISO 8601 format.
Date of issuance in ISO 8601 format.
ISO 3166-1 code of the Country.
City where the document was issued.
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
object
Unique identifier of the address.
First line of the address.
Second line of the address.
The city.
Postal code.
ISO 3166-1 code of the Country.
ISO 3166-2 code of the administrative division, e.g. DE-BW.
The latitude.
The longitude.
Unique identifier of the Address of the customer.
Classifications of the customer.
Options of the customer.
Value of Italian destination code.
Value of Italian fiscal code.
Unique identifier of Company the customer is associated with.
Unique identifier of the account (Customer) to which this customer is linked.
Activity State of customer record, i.e. whether active or deleted.
Whether the customer record is still active.
A list of room preferences, such as view type, bed type, and amenities.
Unique identifier of the user who created the customer.
Unique identifier of the user who last updated the customer.
Services that have been reserved.
object
Unique identifier of the service.
Unique identifier of the Enterprise.
Whether the service is still active.
Name of the service.
All translations of the name.
object
Options of the service.
object
Products should be displayed as a single package instead of individual items.
object
Whether it can be promoted before check-in.
Whether it can be promoted after check-in.
Whether it can be promoted during stay.
Whether it can be promoted before check-out.
Whether it can be promoted after check-out.
Whether it can be promoted during check-out.
Order value for presentation purposes.
Additional information about the specific service.
object
object
Offset from the start of the time unit which defines the default start of the service; expressed in ISO 8601 duration format.
Offset from the end of the time unit which defines the default end of the service; expressed in ISO 8601 duration format.
Offset from the start of the time unit which defines the occupancy start of the service; expressed in ISO 8601 duration format. ‘Occupancy start’ is used for availability and reporting purposes, it implies the time at which the booked resource is considered occupied.
Offset from the end of the time unit which defines the occupancy end of the service; expressed in ISO 8601 duration format. ‘Occupancy end’ is used for availability and reporting purposes, it implies the time at which the booked resource is no longer considered occupied.
Day
Month
Hour
The length of time or period represented by a time unit, for which the service can be booked.
Day
Month
Hour
object
Promotions of the service.
object
Whether it can be promoted before check-in.
Whether it can be promoted after check-in.
Whether it can be promoted during stay.
Whether it can be promoted before check-out.
Whether it can be promoted after check-out.
Whether it can be promoted during check-out.
Identifier of the service from external system.
Creation date and time of the service in UTC timezone in ISO 8601 format.
Last update date and time of the service in UTC timezone in ISO 8601 format.
Products orderable with reservations.
object
Unique identifier of the product.
Unique identifier of the Service.
Unique identifier of the Product category.
Unique identifier of Accounting Category.
Whether the product is still active.
Name of the product. Deprecated! Please use Names
All translations of the name.
object
Name of the product meant to be displayed to customer. Deprecated! Please use ExternalNames
All translations of external name.
object
Short name of the product. Deprecated! Please use ShortNames
All translations of short name.
object
Description of the product. Deprecated! Please use Descriptions
All translations of descriptions.
object
Once
PerTimeUnit
PerPersonPerTimeUnit
PerPerson
Charging mode of the product.
Once
PerTimeUnit
PerPersonPerTimeUnit
PerPerson
Once
Daily
Charging mode of the product.
Once
PerTimeUnit
Options of the product.
object
Product should be displayed as part of a package.
Promotions of the product.
object
Whether it can be promoted before check-in.
Whether it can be promoted after check-in.
Whether it can be promoted during stay.
Whether it can be promoted before check-out.
Whether it can be promoted after check-out.
Whether it can be promoted during check-out.
Classifications of the product.
object
Product is classified as food.
Product is classified as beverage.
Product is classified as wellness.
Product is classified as city tax.
Product is classified as fee.
Price representing price of the product.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
Unique identifier of the product image.
Order value for presentation purposes.
Identifier of the product from external system.
Specifies the reason a product is exempt from tax.
IT_N1 (N1 - Escluse ex art.15)
IT_N2_2 (N2.2 - Non soggette – altri casi)
IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento)
IT_N4 (N4 - Esenti)
IT_N5 (N5 - Regime del margine / IVA non esposta in fattura)
PL_ZW (ZW - Zwolniony)
PL_NP (NP - Nie podlega)
Legal reference that states why this product is exempt from tax.
Creation date and time of the product in UTC timezone in ISO 8601 format.
Last update date and time of the product in UTC timezone in ISO 8601 format.
Consumption moment of the product.
ServiceOrderEnd
ServiceOrderStart
PostingTimeUnit
NextTimeUnit
Assigned resources of the reservations.
object
Unique identifier of the resource.
Unique identifier of the Enterprise.
Whether the resource is still active.
Identifier of the parent Resource (e.g. room of a bed).
Name of the resource (e.g. room number).
State of the resource.
All translations of the description.
object
Creation date and time of the resource in UTC timezone in ISO 8601 format.
Last update date and time of the resource in UTC timezone in ISO 8601 format.
All translations of external name.
object
All translations of direction.
object
Resource categories of the resources.
object
Unique identifier of the category.
Unique identifier of the Enterprise.
Unique identifier of the Service of the resource category.
Whether the category is still active.
All translations of the name.
object
All translations of the short name.
object
All translations of the description.
object
Extra capacity that can be served (e.g. extra bed count).
Identifier of the resource category from external system.
Assignments of the resources to categories.
object
Unique identifier of the assignment.
Whether the assignment is still active.
Unique identifier of the Resource assigned to the Resource category.
Unique identifier of the Resource category.
Creation date and time of the assignment in UTC timezone in ISO 8601 format.
Last update date and time of the assignment in UTC timezone in ISO 8601 format.
Business segments of the reservations.
object
Unique identifier of the business segment.
Unique identifier of the Service.
Whether the business segment is still active.
Name of the business segment.
Creation date and time of the business segment in UTC timezone in ISO 8601 format.
Last update date and time of the business segment in UTC timezone in ISO 8601 format.
Rates of the reservations.
Rate entity, without some of the details, e.g. pricing.
object
Unique identifier of the rate.
Unique identifier of Rate Group where the rate belongs.
Unique identifier of the Service.
Unique identifier of the base Rate.
Whether the rate is a base rate.
Unique identifier of the Business Segment.
Whether the rate is still active.
Whether the rate is currently available to customers.
Whether the rate is publicly available.
Type of the rate.
Public
Private
AvailabilityBlock
Name of the rate (in the default language).
All translations of the name.
object
Short name of the rate (in the default language).
Interval in which the rates were updated.
All translations of the external name of the rate.
object
All translations of the description of the rate.
object
Identifier of the rate from external system.
Rate groups of the reservation rates.
object
Unique identifier of the rate group.
Unique identifier of the Service that the rate group belongs to.
Whether the rate group is still active.
Name of the rate group.
External identifier of the rate group.
Accounting items that are part of the reservations.
object
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Code of tax exemption reason. Restricted! This property is currently intended for Mews’ internal usage and may be subject to change.
Revenue items of the reservations.
object
Unique identifier of the item.
Unique identifier of the account (for example Customer) the item belongs to.
Unique identifier of the order (or Reservation which is a special type of order) the item belongs to.
Unique identifier of the Bill the item is assigned to.
Unique identifier of the Accounting category the item belongs to.
Unit count of item, i.e. the number of sub-items or units, if applicable.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Revenue type of the item.
Date and time of the item consumption in UTC timezone in ISO 8601 format.
Date and time of the item bill closure in UTC timezone in ISO 8601 format.
Accounting state of the item.
Additional data specific to particular order item.
object
object
object
Notes of the reservations.
object
Unique identifier of the service order note.
Unique identifier of the Service order to which the Service Order Note belongs.
Content of the service order note.
A discriminator specifying the type of service order note, e.g. general or channel manager.
General
ChannelManager
SpecialRequest
Creation date and time of the service order note in UTC timezone in ISO 8601 format.
Last update date and time of the service order note in UTC timezone in ISO 8601 format.
QR code data of the reservations.
object
Unique identifier of the reservation.
Reservation data for QR code generation.
Companies related to the reservations.
object
Unique identifier of the company.
Unique identifier of the chain.
Name of the company.
Unique identifier of mother company.
Email for issuing invoices to the company.
The website url of the company.
The maximum time, when the invoice has to be be paid in ISO 8601 duration format.
Options of the company.
object
Whether the company is invoiceable or not.
Whether the company has an additional fee applied for invoicing or not.
Whether tax-deducted payments should be automatically added to invoices.
Credit rating to define creditworthiness of the company.
object
Indicates the credit status of a company.
CreditOk (Company can book services.)
PaymentRequiredUpfront (Company must pay upfront.)
LocalDecisionRequired (Requires local approval.)
The internal segmentation of a company, e.g. sales department.
The Dun & Bradstreet unique 9-digit DUNS number.
External system identifier - custom identifier used by an external system such as an external database.
Accounting code of the company.
Additional tax identifier of the company.
Billing code of the company.
Other contact details, such as telephone, email or similar.
Contact person of the company.
Electronic invoice identifier of the company.
Fiscal or legal identifier of the company.
Iata of the company.
Whether the company is still active.
Additional notes.
Unique number of the company.
Tax identification number of the company.
Contact telephone number.
Date of Company creation date and time.
Date of Company last update date and time.
object
Unique identifier of the address.
First line of the address.
Second line of the address.
The city.
Postal code.
ISO 3166-1 code of the Country.
ISO 3166-2 code of the administrative division, e.g. DE-BW.
The latitude.
The longitude.
Unique identifier of the company Address.
Unique identifier of the account (Customer) to which this company is linked.
Identifier of company from external system.
Resource access tokens for the reservations.
object
Unique identifier of Resource access token.
Unique identifier of the Enterprise.
Unique identifier of a reservation.
Unique identifier of Companionship.
Unique identifier of Resource.
Value of resource access token
Serial number of Resource access token type.
Marks the start of interval in which the resource access token can be used.
Marks the end of interval in which the resource access token can be used.
Specify permissions of Resource access token.
object
Creation date and time of the resource access token in UTC timezone in ISO 8601 format.
Last update date and time of the resource access token in UTC timezone in ISO 8601 format.
Whether the resource access token is still active.
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.
Example
{ "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": 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"}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.