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. |
| 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 | |
| array of string | optional, max 1000 items | Unique identifiers of Reservation groups. |
| array of string Service order state | optional | A list of service order states to filter by. |
| optional, max length 3 months | Interval in which the Reservations were updated. | |
| optional, max length 3 months | Interval filtering Reservations by their scheduled start time. | |
| optional, max length 3 months | Interval in which the reservations are active. This is defined for a reservation as the period between the reservation's scheduled start time | |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Reservations | 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 Service that reservation is made againts. |
| string | required | |
| string | required | A discriminator specifying the type of account, e.g. customer or company. |
| 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 | Scheduled start time of reservation in UTC timezone in ISO 8601 format. |
| string | optional | Actual customer check-in time of reservation in UTC timezone in ISO 8601 format. |
|
|
|
|
| string | required | Scheduled end time of reservation in UTC timezone in ISO 8601 format. |
| string | optional | Actual customer check-out time of reservation in UTC timezone in ISO 8601 format. |
| string | required | Confirmation number of the reservation in Mews. |
| string Service order state | required | State of the reservation. |
| string Service order origin | required | Origin of the reservation. |
| string Commander origin | optional | Further detail about origin in case of Origin |
| string | optional | Details about the reservation Origin. |
| 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 | optional | Unique identifier of the Voucher that has been used to create reservation. |
| string | optional | Identifier of the reservation Business segment. |
| string | required | Identifier of the reservation Rate. |
| 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 Company on behalf of which the reservation was made. |
| string | optional | Identifier of the Company that mediated the reservation. |
| bool | 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. |
| string Cancellation reason | optional | Cancellation reason of the reservation. |
| string | optional | Date when the optional reservation is released in UTC timezone in ISO 8601 format. |
| string Reservation purpose | optional | Purpose of the reservation. |
| string Service order options | optional | Options of the reservations. |
| string | optional | Reservation data for QR code generation. |
| array of Person count | required | Number of people per age category the reservation was booked for. |
Person count
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. |
Reservation state
Enquired
- Confirmed neither by the customer nor enterprise.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
- Reservation from the Mews Booking Engine or Booking Engine APIChannelManager
- Reservation from a channel integrationCommander
- Reservation from Mews OperationsImport
- Reservation from an import processConnector
- Reservation from the Mews Connector APINavigator
- Reservation from Mews Guest Services...
Reservation purpose
Leisure
Business
Student
...
Reservation group
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the reservation group. |
| string | optional | Name of the reservation group, might be empty or same for multiple groups. |
Order note
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the note. |
| string | required | Unique identifier of the order or Reservation. |
| string | required | Value of the note. |
| string Order note type | required | Type of the note. |
| 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 |
---|---|---|---|
| string | required | Unique identifier of the reservation. |
| string | required | Reservation data for QR code generation. |
Get all reservations (ver 2017-04-12)
Deprecated!This operation is deprecated, please use Get all reservations (ver 2023-06-06) instead.
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
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 Reservation time filter | optional | Time filter of the interval. If not specified, reservations |
| string | optional, max length 3 months | Start of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the |
| string | optional, max length 3 months | End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the |
| 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 Reservations. |
| 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 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 | 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 | Unique identifiers of Business segments assigned to the reservations. |
| array of string | optional, max 1000 items | Confirmation numbers of Reservations. |
| array of string Reservation state | optional | States the reservations should be in. If not specified, reservations in |
| 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. | |
| string | optional | ISO-4217 code of the Currency the item costs should be converted to. |
| 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 |
---|---|---|---|
| bool | optional | Whether the response should contain business segmentation. |
| bool | optional | Whether the response should contain customers of the reservations. |
| bool | optional | Whether the response should contain reservation items. |
| bool | optional | Whether the response should contain products orderable with the reservations. |
| bool | optional | Whether the response should contain rates and rate groups. |
| bool | optional | Whether the response should contain reservations. |
| bool | optional | Whether the response should contain groups of the reservations. |
| bool | optional | Whether the response should contain services reserved by the reservations. |
| bool | optional | Whether the response should contain resources. |
| bool | optional | Whether the response should contain resource categories. |
| bool | optional | Whether the response should contain assignments of the resources to categories. |
| bool | optional | Whether the response should contain notes. |
| bool | optional | Whether the response should contain QR code data. |
| bool | optional | Whether the response should contain companies. |
| array of string Accounting item state | optional | States the items should be in. If not specified, items in |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Business segment | optional | Business segments of the reservations. |
| array of Customer | optional | Customers that are members of the reservations. |
| array of Order item | optional | Revenue items of the reservations. |
| array of Product | optional | Products orderable with reservations. |
| array of Rate group | optional | Rate groups of the reservation rates. |
| array of Rate | optional | Rates of the reservations. |
| array of Reservation group | optional | Reservation groups that the reservations are members of. |
| array of Reservation | optional | The reservations that collide with the specified interval. |
| array of Service | optional | Services that have been reserved. |
| 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 Order note | optional | Notes of the reservations. |
| array of QrCode data | optional | QR code data of the reservations. |
| 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 (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). |
| string Reservation state | required | State of the reservation. |
| string Reservation origin | required | Origin of the reservation. |
| string | optional | Details about the reservation origin. |
| string Reservation purpose | optional | 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. |
| bool | 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 | required | Unique identifier of the Customer who owns the reservation. |
| array of Age category | required | Number of people per age category the reservation was booked for. |
Get all reservation items
Deprecated!This operation is deprecated, please use Get all order items instead.
Returns all revenue items associated with the specified reservations.
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 Accounting item state | optional | States the items should be in. If not specified, items in |
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 Order item | required | The items associated with the reservation. |
Price reservations
Returns prices of reservations with the specified parameters. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/reservations/price
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 a Portfolio Access Token, ignored otherwise. |
| string | required | Unique identifier of the Service to be priced. |
| array of Reservation parameters | required | Parameters of the reservations to price. Note that |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Reservation price | required | The reservation prices. |
Reservation price
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | Identifier of the reservation within the transaction. |
| 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
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 | required | Unique identifier of the Service to be reserved. |
| string | optional | Unique identifier of the Reservation group where the reservations are added. If not specified, a new group is created. |
| string | optional | Name of the Reservation group which the reservations are added to. If |
| array of Reservation parameters | required | Parameters of the new reservations. |
| bool | optional | Whether the confirmation email is sent. Default value is |
| 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 |
| 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 |
*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 |
---|---|---|---|
| string | optional | Identifier of the reservation within the transaction. |
| string Reservation state | optional | State of the newly created reservation (either |
| string | required | Reservation start in UTC timezone in ISO 8601 format. |
| string | required | Reservation end in UTC timezone in ISO 8601 format. |
| string | optional | Release date and time of an unconfirmed reservation in UTC timezone in ISO 8601 format. |
| string | required | Unique identifier of the Customer who owns the reservation. |
| string | optional | Unique identifier of the Customer on whose behalf the reservation was made. |
| string | required | Identifier of the requested Resource category. |
| string | required | Identifier of the reservation Rate. |
| string | optional | Identifier of the Company that mediated the reservation. |
| string | optional | Identifier of the Company on behalf of which the reservation was made. |
| string | optional | Additional notes. |
| optional | Amount of each night of the reservation. | |
| array of Time unit amount parameters | optional | Prices for time units of the reservation. E.g. prices for the first or second night. |
| array of Product order parameters | optional | Parameters of the products ordered together with the reservation. |
| array of Age category parameters | required | Number of people per age category the reservation was booked for. At least one category with valid count must be provided. |
| string | optional | Identifier of Credit card belonging to Customer who owns the reservation. |
| string | optional | Unique identifier of the Availability block the reservation is assigned to. |
| string | optional | Voucher code value providing access to specified private Rate applied to this reservation. |
Age category parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Age category. |
| string | required | Number of people of a given age category. Only positive value is accepted. |
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 a Portfolio Access Token, ignored otherwise. |
| string | optional | Reason for updating the reservation. Required when updating the price of the reservation. |
| 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 |
| 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 |
| bool | optional | Whether the price should be updated to latest value for date/rate/category combination set in Mews. If not specified, the reservation price is updated. |
| bool | optional | Whether the cancellation fees should be applied according to rate cancellation policies. If not specified, the cancellation fees are applied. |
| array of Reservation updates | required, max 1000 items | Array of properties to be updated in each reservation specified. |
*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 updates
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the reservation. |
| optional | Reservation start in UTC timezone in ISO 8601 format. (or | |
| optional | Reservation end in UTC timezone in ISO 8601 format. (or | |
| optional | Identifier of the assigned Resource. | |
| optional | ||
| 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 | Identifier of the requested Resource category (or | |
| optional | Identifier of the Company that mediated the reservation (or | |
| optional | Identifier of the Company on behalf of which the reservation was made (or | |
| optional | Identifier of the reservation Business segment (or | |
| optional | Purpose of the reservation (or | |
| optional | Identifier of the reservation Rate (or | |
| optional | Identifier of the Customer on whose behalf the reservation was made. (or | |
| optional | Prices for time units of the reservation. E.g. prices for the first or second night. (or | |
| array of Person counts update value | optional | Number of people per age category the reservation is for. Is supplied the person counts will be replaced. (or |
| optional | Identifier of Credit card belonging to Customer who owns the reservation. (or | |
| optional | Unique identifier of the Availability block the reservation is assigned to. | |
| optional | Options of the reservations. |
Reservations options parameters
Property | Type | Contract | Description |
---|---|---|---|
| required | True if the owner of the reservation is checked in. |
Time unit amount update value
Property | Type | Contract | Description |
---|---|---|---|
| array of Time unit amount parameters | required | Value which is to be updated. |
Time unit amount parameters
Property | Type | Contract | Description |
---|---|---|---|
| integer | required | Index of the unit. Indexing starts with |
| required | Amount of the unit. |
Person counts update value
Property | Type | Contract | Description |
---|---|---|---|
| array of Age category parameters | required | Value which is to be updated. |
Response
Same structure as in Get all reservations operation.
Confirm reservation
Marks all specified reservations as Confirmed
. Succeeds only if all confirmation conditions are met (the reservations have the Optional
state).
Request
[PlatformAddress]/api/connector/v1/reservations/confirm
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 | Unique identifier of the reservations to confirm. |
| bool | optional | Wheter the confirmation email is sent. Default value is |
Response
Start reservation
Marks a reservation as Started
(= checked in). Succeeds only if all starting conditions are met (the reservation has the Confirmed
state, does not have start set to future, has an inspected room assigned etc). Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/reservations/start
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 a Portfolio Access Token, ignored otherwise. |
| string | required | Unique identifier of the reservation to start. |
Response
Process reservation
Marks a reservation as Processed
(= checked out). Succeeds only if all processing conditions are met (the reservation has the Started
state, balance of all reservation members is zero etc). Note this operation supports Portfolio Access Tokens.
Conditions
Reservation has already been checked in.
Reservation isn't alredy in
Processed
state.Reservation can't be checked out sooner than last day of planned stay.
The companion profiles of reservation are complete (details can be found in error message).
If
AllowOpenBalance
set tofalse
, all bills have to be closable (items on bills are either paid by current customer, or set to be paid by other customer). WithCloseBills
option set totrue
they can be automatically closed, when set tofalse
they must be closed manually.If
AllowOpenBalance
set totrue
,Notes
must be filled in.
Request
[PlatformAddress]/api/connector/v1/reservations/process
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 a Portfolio Access Token, ignored otherwise. |
| string | required | Unique identifier of the reservation to process. |
| bool | optional | Whether closable bills of the reservation members should be automatically closed. |
| bool | optional | Whether non-zero consumed balance of all reservation members is allowed. |
| string | optional | Required if |
Response
Cancel reservation
Cancels all reservation with specified identifiers. Succeeds only if the reservations are cancellable. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/reservations/cancel
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 a Portfolio Access Token, ignored otherwise. |
| array of string | required | Unique identifiers of the reservation to cancel. |
| boolean | required | Whether cancellation fees should be charged according to rate conditions. |
| string | required | Additional notes describing the reason for the cancellation. |
Response
Update reservation customer
Updates customer of a reservation. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/reservations/updateCustomer
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 a Portfolio Access Token, ignored otherwise. |
| string | required | Unique identifier of the reservation to be updated. |
| string | required | Unique identifier of the Customer. |
Response
Update reservation interval
Updates reservation interval (start, end or both). Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/reservations/updateInterval
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 a Portfolio Access Token, ignored otherwise. |
| string | required | Unique identifier of the reservation to be updated. |
| string | optional | New reservation start in UTC timezone in ISO 8601 format. |
| string | optional | New reservation end in UTC timezone in ISO 8601 format. |
| boolean | required | Whether cancellation fee should be charged for potentially canceled nights. |
Response
Add reservation companion
Adds a customer as a companion to the reservation. Succeeds only if there is space for the new companion (count of current companions is less than AdultCount + ChildCount
).
Request
[PlatformAddress]/api/connector/v1/reservations/addCompanion
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 | required | Unique identifier of the reservation. |
| string | required | Unique identifier of the Customer. |
Response
Delete reservation companion
Removes customer companionship from the reservation. Note that the customer profile stays untouched, only the relation between the customer and reservation is deleted.
Request
[PlatformAddress]/api/connector/v1/reservations/deleteCompanion
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 | required | Unique identifier of the reservation. |
| string | required | Unique identifier of the Customer. |
Response
Add reservation product
Adds a new product order of the specified product to the reservation.
Request
[PlatformAddress]/api/connector/v1/reservations/addProduct
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 | required | Unique identifier of the reservation. |
| string | required | Unique identifier of the Product. |
| int | required | The amount of the products to be added. Note that if the product is charged e.g. per night, count 1 means a single product every night. Count 2 means two products every night. |
| string | optional | Product start in UTC timezone in ISO 8601 format. For products with charging |
| string | optional | Product end in UTC timezone in ISO 8601 format. For products with charging |
| optional | Price of the product that overrides the price defined in Mews. |
Response
Commander origin
InPerson
Channel
Phone
Email
Website
Message
CallCenter
...
Last updated