Customers
Get all customers
Returns all customers filtered by identifiers, emails, names and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customers/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. |
| array of string | optional, max 1000 items | Unique identifiers of Customers. Required if no other filter is provided. |
| array of string | optional, max 1000 items | Emails of the Customers. |
| array of string | optional, max 1000 items | First names of the Customers. |
| array of string | optional, max 1000 items | Last names of the Customers. |
| array of string | optional, max 1000 items | Loyalty codes of the Customers. |
| optional, max length 3 months | Interval in which Customer was created. | |
| optional, max length 3 months | Interval in which Customer was updated. | |
| optional, max length 3 months | Interval in which Customer was deleted. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Extent of data to be returned. | |
| required | Limitation on the quantity of customers returned. |
Customer extent
Property | Type | Contract | Description |
---|---|---|---|
| bool | required | Whether the response should contain information about customers. |
| bool | required | Whether the response should contain identity documents of customers. |
| bool | required | Whether the response should contain addresses of customers. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Customer | required | The customers. |
| array of Document | required | The identity documents of customers. |
| string | required | Unique identifier of the last and hence oldest customer item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older customers. If Limitation is specified in the request message, then |
Customer
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the customer. |
| string | optional | Unique identifier of the chain. |
| string | required | Number of the customer. |
| string | optional | First name of the customer. |
| string | required | Last name of the customer. |
| string | optional | Second last name of the customer. |
| string Title | optional | Title prefix of the customer. |
| string Sex | optional | Sex of the customer. |
| string | optional | ISO 3166-1 code of the Country. |
| string | optional | Language and culture code of the customer's preferred language, according to their profile. For example: |
| string | optional | 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, |
| string | optional | Date of birth in ISO 8601 format. |
| string | optional | Place of birth. |
| string | optional | Email address of the customer. |
| string | optional | Phone number of the customer (possibly mobile). |
| string | optional | Tax identification number of the customer. |
| string | optional | Loyalty code of the customer. |
| string | optional | Accounting code of the customer. |
| string | optional | Billing code of the customer. |
| string | optional | Internal notes about the customer. |
| string | optional | Registration number of the customer's car. |
| array of Customer classification | required | Classifications of the customer. |
| array of Customer option | required | Options of the customer. |
| optional | Address of the customer. | |
| string | required | Creation date and time of the customer in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the customer in UTC timezone in ISO 8601 format. |
| string | optional | Value of Italian destination code. |
| string | optional | Value of Italian fiscal code. |
| string | optional | Unique identifier of Company the customer is associated with. |
| string | optional | Unique identifier of the account (Customer) to which this customer is linked. |
| string | required | Activity State of customer record, i.e. whether active or deleted. |
Title
Mister
Miss
Misses
Sex
Male
Female
Document
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the document. |
| string | required | Identifier of the Customer. |
| string Document type | required | Type of the document. |
| string | optional | Number of the document (e.g. passport number). |
| string | optional | Expiration date in ISO 8601 format. |
| string | optional | Date of issuance in ISO 8601 format. |
| string | optional | ISO 3166-1 code of the Country. |
| string | optional | City from which document issued |
Document type
Passport
IdentityCard
Visa
DriversLicense
Customer classification
PaymasterAccount
Blacklist
Media
LoyaltyProgram
PreviousComplaint
Returning
Staff
FriendOrFamily
TopManagement
Important
VeryImportant
Problematic
Cashlist
DisabledPerson
Military
InRoom
WaitingForRoom
Student
...
Customer option
SendMarketingEmails
Invoiceable
BillAddressObjection
SendMarketingPostalMail
SendPartnerMarketingEmails
SendPartnerMarketingPostalMail
...
Activity State
Active
Deleted
Search customers
Searches for customers that are active at the moment in the enterprise (e.g. companions of checked-in reservations or paymasters).
Request
[PlatformAddress]/api/connector/v1/customers/search
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 | Name to search by (applies to first name, last name and full name). |
| string | optional | Identifier of Resource to search by (members of reservation assigned there will be returned). |
| required | Extent of data to be returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Customer search result | required | The customer search results. |
Customer search result
Property | Type | Contract | Description |
---|---|---|---|
| required | The found customer. | |
| optional | Reservation of the customer in case they are currently staying in the property. |
Get customers open items
Returns all open items of the specified customers, i.e. all unpaid items and all deposited payments. Sum of the open items is the balance of the customer. If the Currency
is specified, costs of the items are converted to that currency.
Request
[PlatformAddress]/api/connector/v1/customers/getOpenItems
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 Customers. |
| string | optional | ISO-4217 code of the Currency the item costs should be converted to. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Customer items | required | The customers with their items. |
Customer items
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Customer. |
| array of Order item | required | The open order items (consumed items such as nights or products). |
| array of Payment item | required | The open payment items (such as cash, credit card payments or invoices). |
Add customer
Adds a new customer to the system and returns details of the added customer. If a customer with the specified email already exists, and OverwriteExisting
is set to true
, then the existing customer profile information is overwritten and the existing customer data returned. If OverwriteExisting
is set to false
, an error response is returned. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customers/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 | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| bool | required | Whether an existing customer should be overwritten in case of duplicity. This applies only to basic personal information ( |
| string | optional | First name of the customer. |
| string | required | Last name of the customer. |
| string | optional | Second last name of the customer. |
| string Title | optional | Title prefix of the customer. |
| string Sex | optional | Sex of the customer. |
| string | optional | ISO 3166-1 code of the Country. |
| string | optional | Date of birth in ISO 8601 format. |
| string | optional | Place of birth. |
| string | optional | Email address of the customer. |
| string | optional | Phone number of the customer (possibly mobile). |
| string | optional | Loyalty code of the customer. |
| string | optional | Internal notes about the customer. |
| string | optional | Registration number of the customer's car. |
| string | optional | Tax identification number of the customer. |
| optional | Identity card details of the customer. | |
| optional | Passport details of the customer. | |
| optional | Visa details of the customer. | |
| optional | Drivers license details of the customer. | |
| optional | Address of the customer. | |
| array of Customer classification | optional | Classifications of the customer. |
| array of Customer option | optional | Options of the customer. |
| string | optional | Value of Italian destination code. |
| string | optional | Value of Italian fiscal code. |
Address parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | First line of the address. |
| string | optional | Second line of the address. |
| string | optional | The city. |
| string | optional | Postal code. |
| string | optional | ISO 3166-1 code of the [Countryconfiguration.md#country). |
| string | optional | ISO 3166-2 code of the administrative division, e.g. |
Response
The created Customer or an existing Customer with the specified email.
Update customer
Updates personal information of a customer. Note that if any of the fields is left blank, it won't clear the field in Mews. The field will be left intact. In case of email update, the email will change in Mews only if there is no other customer profile in the hotel with such email. Otherwise an error response is returned. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customers/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 chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| string | required | Unique identifier of the Customer. |
| string | optional | New first name. |
| string | optional | New last name. |
| string | optional | New second last name. |
| string Title | optional | New title. |
| string Sex | optional | Sex of the customer. |
| string | optional | New birth date in ISO 8601 format. |
| string | optional | New birth place. |
| string | optional | ISO 3166-1 code of the Country. |
| string | optional | New email address. |
| string | optional | New phone number. |
| string | optional | Loyalty code of the customer. |
| string | optional | Internal notes about the customer. Old value will be overwritten. |
| string | optional | New registration number of the customer's car. |
| string | optional | New tax identification number of the customer. |
| optional | New identity card details. | |
| optional | New passport details. | |
| optional | New visa details. | |
| optional | New drivers license details. | |
| optional | New address details. | |
| array of Customer classification | optional | New classifications of the customer. |
| array of Customer option | optional | Options of the customer. |
| optional | New Italian destination code of customer. | |
| optional | New Italian fiscal code of customer. |
Response
The updated Customer.
Merge customers
Deprecated!This operation is deprecated, please use Merge accounts instead.
Merges one customer to another. All entities attached to the source customer (e.g. orders, bills) are attached to the target customer. Profile information of the target customer are extended but not overwritten with profile information of the source customer.
Request
[PlatformAddress]/api/connector/v1/customers/merge
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 source Customer. |
| string | required | Unique identifier of the target Customer. |
Response
Add customer file
Attaches the specified file to the customer profile. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customers/addFile
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 Customer. |
| string | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| string | required | Name of the file. |
| string | required | MIME type of the file (e.g. |
| string | required | Base64-encoded data of the file. |
Response
Last updated