Configuration
Get properties
This operation is used to get the list of available properties and their connection details, based on your Client Token
and an employee email address. A valid email address must be supplied which corresponds to an employee of the enterprise to which the properties belong. The system will verify the email address and return the list of properties and connections (including Connection Tokens
) for which the owner of the email address has access.
Request
[PlatformAddress]/api/channelManager/v1/getProperties
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Client token of the channel manager. |
|
| required | Verified email of an enterprise employee held on the Mews system. |
Response
This sample response shows that the owner of the email address has access to two properties: Sample Hostel and White House Hotel. Sample Hostel has two connections to this channel manager, whilst White House Hotel has no connections.
Property | Type | Contract | Description |
---|---|---|---|
|
| required | List of available properties. |
Property Info
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Name of the property. |
|
| required | Unique ID of the property. |
|
| optional | List of supported connections. |
Connection Info
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Connection Token for the connection. |
|
| optional | Name of the connection. |
Get configuration
This operation returns the configuration of the given property connection.
Request
[PlatformAddress]/api/channelManager/v1/getConfiguration
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Client token of the channel manager. |
|
| required | Connection token of a property connection. |
|
| optional | Specifies what to include in the return data. |
Configuration Extent
Property | Type | Contract | Description |
---|---|---|---|
|
| optional | If |
|
| optional | If |
|
| optional | If |
|
| optional | If |
|
| optional | If |
Response
This is an example of a successful response. In case an error occurred, the response will contain only the Error
object.
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Token of the connection. |
|
| required | Details of the property. |
|
| required | Rate plans of the property. |
|
| required | Space categories (space types) of the property. |
|
| required | Defines relations between rate plans and space categories. |
|
| optional | Age categories of the property. |
Property
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Name of the property. |
|
| optional | Description of the property. |
|
| required | Language code of the default language of the property. All names and descriptions are in this language. |
|
| required | Property time zone identifier. |
|
| optional | Website of the property. |
|
| optional | Email contact of the property. |
|
| optional | Phone contact of the property. |
|
| required | Total count of spaces sold/offered by the property. |
|
| required |
|
|
| optional | Address of the property. |
|
| optional | Images associated with the property, e.g. brand logos and exterior photographs. |
Pricing Mode types
Code | Description |
---|---|
| Gross |
| Net |
Address
Property | Type | Contract | Description |
---|---|---|---|
|
| optional | First line of the address. |
|
| optional | Second line of the address. |
|
| optional | City. |
|
| optional | Region. |
|
| optional | Zip code. |
|
| optional | ISO 3166-1 alpha-2 country code - two letter country code or ISO 3166-1 alpha-3 country code - three letter country code. |
|
| optional | Latitude - from range [-90, 90]. |
|
| optional | Longitude - from range [-180, 180]. |
Image
Property | Type | Contract | Description |
---|---|---|---|
|
| required |
|
|
| required | Public URL of the image. |
Image types
Code | Description |
---|---|
| Logo |
| Photo |
Rate Plan
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Mapping code of the rate plan. |
|
| required | Name of the rate plan. |
|
| required | Three-letter currency code of the rate plan price. |
|
| optional | Description of the rate plan. |
|
| required |
|
|
| optional | Cancellation policies of the rate plan. |
|
| required | Determines whether rate plan is synchronized, i.e. that Mews pushes prices and restrictions for the rate plan. Otherwise, unsynchronized rate plan is used just for mapping correct rate plan for incoming reservations (as well as sychronized rate plan). |
|
| required | Determines whether rate plan is private (available for channel reservations only) or public (bookable via Mews Distributor as well). |
Payment types
Code | Description | Notes |
---|---|---|
| Prepaid | When guest has already paid to the Channel (i.e. OTA). |
| Preauthorized | When the booking is covered by a guarantee (preauthorization or a payment card). |
| OnSite | When guest will pay on site. |
Rate types
Code | Description |
---|---|
| Private |
| Public |
Cancellation Policy
Property | Type | Contract | Description |
---|---|---|---|
|
| required | |
|
| optional | Offset specifying a "shift" from the moment given by |
|
| required | Defines penalty that applies based on the cancellation policy. |
Cancellation Policy Applicability
Code | Description | Notes |
---|---|---|
| Creation | Cancellation policy applies from the moment the booking is created. |
| Start | Cancellation policy applies from the moment the booking starts (i.e. time included). |
| Start Date | Cancellation policy applies from the 0:00 on the day when the booking starts (i.e. time is not included). |
Cancellation Penalty
Property | Type | Contract | Description |
---|---|---|---|
| required | Defines absolute fee penalty. | |
| required | Defines relative (i.e. %) fee penalty. |
Absolute Cancellation Penalty
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Defines the amount of the absolute fee. Sent in |
|
| required | 3 letter currency code of the absolute fee. |
Relative Cancellation Penalty
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Defines the % value of the relative fee (e.g |
|
| optional | Determines maximum number of nights included in the relative fee calculation, empty means "all nights". |
Space Categories
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Mapping code of the space type. |
|
| required | Name of the space type. |
|
| optional | Description of the space type. |
|
| required | Number of sold/offered spaces of the type. |
|
| optional | Number of beds of the space type - required if the type describes some room type. Represents default occupancy. |
|
| optional | Number of extra beds of the space type. |
|
| required |
|
|
| optional |
|
|
| optional | Images of the space type. These are always image |
Space Classifications
Code | Description |
---|---|
| Apartment |
|
|
|
|
| Double Room |
|
|
|
|
|
|
| Dormitory Bed |
| Single Room |
| Studio |
| Suite |
| Tent |
| Triple Room |
| Twin Room |
| Villa |
| Dormitory |
| Site |
| Office |
| MeetingRoom |
| ParkingSpot |
| Desk |
| TeamArea |
| CaravanOrRv |
| UnequippedCampsite |
Bed Types
Code | Description |
---|---|
| Single bed |
| Twin bed |
| Double bed |
| Queen bed |
| King bed |
| Sofa bed |
Inventory Mappings
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Mapping code of the rate plan |
|
| required | Mapping code of the space type related to the rate plan. |
Products
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Mapping code of the product. |
|
| required | Name of the product. |
|
| optional | Description of the product. |
|
| required | A product cost. |
|
| required | 3 letter currency code of the product. |
|
| required | Tax exclusive product cost. |
|
| required | Tax inclusive product cost. |
|
| optional | Cancellation policies of the rate plan. |
|
| required | Identifies legal environment specific taxes. |
|
| required | Tax code corresponding to legal environment. |
|
| required | Tax amount. |
|
| required | Identified in |
Product Mapping
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Mapping code of the rate plan. |
|
| required | Mapping code of the product related to the rate plan. |
Companies
Property | Type | Contract | Description |
---|---|---|---|
|
| optional |
|
|
| optional | Related to Travel Agencies only. |
|
| required | Company name. |
|
| optional | Company contact. |
|
| optional | Company phone number. |
|
| optional | Company address. |
| optional | Mapping channel of the company. |
Travel Agencies
Property | Type | Contract | Description |
---|---|---|---|
|
| optional |
|
|
| optional | IATA code. |
|
| required | Travel Agency name. |
|
| optional | Travel Agency contact. |
|
| optional | Travel Agency phone number. |
|
| optional | Travel Agency address. |
| optional | Mapping channel of the company. |
Age categories
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Mapping code of age category. |
|
| required | Display name. |
|
| optional | Minimal age for the age category. |
|
| optional | Maximal age for the age category. |
Get channels
Get the list of all supported channels (including OTAs or Online Travel Agents) plus their assigned mapping codes.
Note: The mapping code is not a continuous sequence of numbers, there are some gaps. Gaps arise because OTAs get merged over time or otherwise disappear. New Channels will always be added to the bottom of the list, so you can easily keep track. Please check the list periodically to update your channels list.
Request
[PlatformAddress]/api/channelManager/v1/getChannels
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Client token of the channel manager. |
Response
Property | Type | Contract | Description |
---|---|---|---|
|
| required | All mapped channels. |
Channel
Property | Type | Contract | Description |
---|---|---|---|
|
| required | Mapping code of channel. |
|
| required | Name of channel. |
Last updated