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
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.
ChainIds
array of string
optional, max 1000 items
Unique identifiers of the chains. Required when using Portfolio Access Tokens, ignored otherwise.
CreatedUtc
optional, max length 3 months
Interval in which Customer was created.
UpdatedUtc
optional, max length 3 months
Interval in which Customer was updated.
Extent
required
Extent of data to be returned.
DeletedUtc
optional, max length 3 months
Interval in which Customer was deleted. ActivityStates
value Deleted
should be provided with this filter to get expected results.
ActivityStates
optional
Whether to return only active, only deleted or both records.
CustomerIds
array of string
optional, max 1000 items
Unique identifiers of Customers. Required if no other filter is provided.
CompanyIds
array of string
optional, max 1 item
Unique identifier of the Company the customer is associated with.
Emails
array of string
optional, max 1000 items
FirstNames
array of string
optional, max 1000 items
LastNames
array of string
optional, max 1000 items
LoyaltyCodes
array of string
optional, max 1000 items
Limitation
required
Limitation on the quantity of data returned.
Customer extent
Customers
boolean
optional
Whether the response should contain information about customers.
Documents
boolean
optional
Whether the response should contain identity documents of customers.
Addresses
boolean
optional
Whether the response should contain addresses of customers.
Response
Customers
required
The customers.
Documents
required
The identity documents of customers.
Cursor
string
optional
Customer
Id
string
required
Unique identifier of the customer.
ChainId
string
required
Unique identifier of the chain.
Number
string
required
Number of the customer.
Title
optional
Title of the customer.
Sex
optional
Sex of the customer.
FirstName
string
optional
First name of the customer.
LastName
string
required
Last name of the customer.
SecondLastName
string
optional
Second last name of the customer.
NationalityCode
string
optional
PreferredLanguageCode
string
optional
Language and culture code of the customer's preferred language, according to their profile. For example: en-GB
, fr-CA
.
LanguageCode
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, en-US
or fr-FR
.
BirthDate
string
optional
Date of birth in ISO 8601 format.
BirthPlace
string
optional
Place of birth.
Occupation
string
optional
Occupation of the customer.
Email
string
optional
Email address of the customer.
HasOtaEmail
boolean
required
Phone
string
optional
Phone number of the customer (possibly mobile).
TaxIdentificationNumber
string
optional
Tax identification number of the customer.
LoyaltyCode
string
optional
Loyalty code of the customer.
AccountingCode
string
optional
Accounting code of the customer.
BillingCode
string
optional
Billing code of the customer.
Notes
string
optional
Internal notes about the customer.
CarRegistrationNumber
string
optional, max length 255 characters
Registration number of the customer's car.
DietaryRequirements
string
optional, max length 255 characters
Customer's dietary requirements, e.g. Vegan, Halal.
CreatedUtc
string
required
Creation date and time of the customer in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the customer in UTC timezone in ISO 8601 format.
AddressId
string
optional
Unique identifier of the Address
of the customer.
Classifications
required
Classifications of the customer.
Options
required
Options of the customer.
ItalianDestinationCode
string
optional
Value of Italian destination code.
ItalianFiscalCode
string
optional
Value of Italian fiscal code.
CompanyId
string
optional
MergeTargetId
string
optional
IsActive
boolean
required
Whether the customer record is still active.
PreferredSpaceFeatures
required
A list of room preferences, such as view type, bed type, and amenities.
Passport
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
IdentityCard
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
Visa
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
DriversLicense
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
Address
optional
Deprecated! Use AddressId
instead.
ActivityState
string
optional
Title
Type of the title prefix of the customer.
Note that the value should not be used as-is, but localized. For example, the value Misses
should be displayed as Mrs.
in English and Fr.
in German.
Mister
- Mr.Miss
- Ms.Misses
- Mrs.
Sex
Male
Female
Identity document
Id
string
required
Unique identifier of the document.
CustomerId
string
required
Identifier of the Customer
.
Type
required
Type of the document.
Number
string
optional
Number of the document (e.g. passport number).
Expiration
string
optional
Expiration date in ISO 8601 format.
Issuance
string
optional
Date of issuance in ISO 8601 format.
IssuingCountryCode
string
optional
ISO 3166-1 code of the Country
.
IssuingCity
string
optional
City where the document was issued.
IdentityDocumentSupportNumber
string
optional
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
Get customers open items
Deprecated!This operation is deprecated. Use Get all payments and Get all order items instead.
Request
[PlatformAddress]/api/connector/v1/customers/getOpenItems
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.
CustomerIds
array of string
required, max 1000 items
Currency
string
optional
Response
Customers
optional
The customers with their items.
Customer items
CustomerId
string
required
Unique identifier of the Customer
.
OrderItems
required
The open order items (consumed items such as nights or products).
PaymentItems
required
The open payment items (such as cash, credit card payments or invoices).
Items
required
Deprecated! Use OrderItems
and PaymentItems
instead.
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
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.
Title
required
Title prefix of the customer.
FirstName
string
optional
First name of the customer.
LastName
string
required
Last name of the customer.
SecondLastName
string
optional
Second last name of the customer.
NationalityCode
string
optional
ISO 3166-1 code of the Country
.
Sex
required
Sex of the customer.
BirthDate
string
optional
Date of birth in ISO 8601 format.
BirthPlace
string
optional
Place of birth.
Occupation
string
optional
Occupation of the customer.
Email
string
optional
Email address of the customer.
Phone
string
optional
Phone number of the customer (possibly mobile).
LoyaltyCode
string
optional
Loyalty code of the customer.
Notes
string
optional
Internal notes about the customer.
CarRegistrationNumber
string
optional, max length 255 characters
Registration number of the customer's car.
DietaryRequirements
string
optional, max length 255 characters
Customer's dietary requirements, e.g. Vegan, Halal.
TaxIdentificationNumber
string
optional
Tax identification number of the customer.
CompanyId
string
optional
Unique identifier of Company
the customer is associated with.
Address
optional
Address of the customer.
IdentityCard
optional
Identity card details of the customer.
Passport
optional
Passport details of the customer.
Visa
optional
Visa details of the customer.
DriversLicense
optional
Drivers license details of the customer.
Classifications
optional
Classifications of the customer.
Options
optional
Options of the customer.
ChainId
string
optional
Unique identifier of the chain. Required when using PortfolioAccessTokens
, ignored otherwise.
OverwriteExisting
boolean
required
Whether an existing customer should be overwritten in case of duplicity. This applies only to basic personal information (Title
, FirstName
, LastName
, ...).
ItalianDestinationCode
string
optional
Value of Italian destination code.
ItalianFiscalCode
string
optional
Value of Italian fiscal code.
Sex
Male
Female
Identity document parameters
Number
string
optional
Number of the document (e.g. passport number).
Expiration
string
optional
Expiration date in ISO 8601 format.
Issuance
string
optional
Date of issuance in ISO 8601 format.
IssuingCountryCode
string
optional
ISO 3166-1 code of the Country
.
IssuingCity
string
optional
City from which document issued
Customer classification
PaymasterAccount
Blacklist
Media
LoyaltyProgram
PreviousComplaint
Returning
Staff
FriendOrFamily
TopManagement
Important
VeryImportant
Problematic
Cashlist
DisabledPerson
Military
Airline
HealthCompliant
InRoom
WaitingForRoom
Student
Customer option
SendMarketingEmails
Invoiceable
BillAddressObjection
SendMarketingPostalMail
SendPartnerMarketingEmails
SendPartnerMarketingPostalMail
WithdrawCardConsent
Response
Id
string
required
Unique identifier of the customer.
ChainId
string
required
Unique identifier of the chain.
Number
string
required
Number of the customer.
Title
optional
Title of the customer.
Sex
optional
Sex of the customer.
FirstName
string
optional
First name of the customer.
LastName
string
required
Last name of the customer.
SecondLastName
string
optional
Second last name of the customer.
NationalityCode
string
optional
PreferredLanguageCode
string
optional
Language and culture code of the customer's preferred language, according to their profile. For example: en-GB
, fr-CA
.
LanguageCode
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, en-US
or fr-FR
.
BirthDate
string
optional
Date of birth in ISO 8601 format.
BirthPlace
string
optional
Place of birth.
Occupation
string
optional
Occupation of the customer.
Email
string
optional
Email address of the customer.
HasOtaEmail
boolean
required
Phone
string
optional
Phone number of the customer (possibly mobile).
TaxIdentificationNumber
string
optional
Tax identification number of the customer.
LoyaltyCode
string
optional
Loyalty code of the customer.
AccountingCode
string
optional
Accounting code of the customer.
BillingCode
string
optional
Billing code of the customer.
Notes
string
optional
Internal notes about the customer.
CarRegistrationNumber
string
optional, max length 255 characters
Registration number of the customer's car.
DietaryRequirements
string
optional, max length 255 characters
Customer's dietary requirements, e.g. Vegan, Halal.
CreatedUtc
string
required
Creation date and time of the customer in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the customer in UTC timezone in ISO 8601 format.
AddressId
string
optional
Unique identifier of the Address
of the customer.
Classifications
required
Classifications of the customer.
Options
required
Options of the customer.
ItalianDestinationCode
string
optional
Value of Italian destination code.
ItalianFiscalCode
string
optional
Value of Italian fiscal code.
CompanyId
string
optional
MergeTargetId
string
optional
IsActive
boolean
required
Whether the customer record is still active.
PreferredSpaceFeatures
required
A list of room preferences, such as view type, bed type, and amenities.
Passport
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
IdentityCard
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
Visa
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
DriversLicense
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
Address
optional
Deprecated! Use AddressId
instead.
ActivityState
string
optional
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
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.
ChainId
string
optional
Unique identifier of the chain. Required when using PortfolioAccessTokens
, ignored otherwise.
CustomerId
string
required
Unique identifier of the Customer
to be updated.
Title
required
New title.
FirstName
string
optional
New first name.
LastName
string
optional
New last name.
SecondLastName
string
optional
New second last name.
NationalityCode
string
optional
New nationality code as ISO 3166-1 code of the Country
.
Sex
required
Sex of the customer.
BirthDate
string
optional
New birth date in ISO 8601 format.
BirthPlace
string
optional
New birth place.
Occupation
string
optional
Occupation of the customer.
Email
string
optional
New email address.
Phone
string
optional
New phone number.
LoyaltyCode
string
optional
Loyalty code of the customer.
Notes
string
optional
Internal notes about the customer. Old value will be overwritten.
CarRegistrationNumber
string
optional, max length 255 characters
New registration number of the customer's car.
DietaryRequirements
string
optional, max length 255 characters
Customer's dietary requirements, e.g. Vegan, Halal.
TaxIdentificationNumber
string
optional
New tax identification number of the customer.
CompanyId
string
optional
Unique identifier of Company
the customer is associated with.
Address
optional
New address details.
IdentityCard
optional
New identity card details.
Passport
optional
New passport details.
Visa
optional
New visa details.
DriversLicense
optional
New drivers license details.
Classifications
optional
New classifications of the customer.
Options
optional
Options of the customer.
ItalianDestinationCode
optional
New Italian destination code of customer.
ItalianFiscalCode
optional
New Italian fiscal code of customer.
Response
Id
string
required
Unique identifier of the customer.
ChainId
string
required
Unique identifier of the chain.
Number
string
required
Number of the customer.
Title
optional
Title of the customer.
Sex
optional
Sex of the customer.
FirstName
string
optional
First name of the customer.
LastName
string
required
Last name of the customer.
SecondLastName
string
optional
Second last name of the customer.
NationalityCode
string
optional
PreferredLanguageCode
string
optional
Language and culture code of the customer's preferred language, according to their profile. For example: en-GB
, fr-CA
.
LanguageCode
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, en-US
or fr-FR
.
BirthDate
string
optional
Date of birth in ISO 8601 format.
BirthPlace
string
optional
Place of birth.
Occupation
string
optional
Occupation of the customer.
Email
string
optional
Email address of the customer.
HasOtaEmail
boolean
required
Phone
string
optional
Phone number of the customer (possibly mobile).
TaxIdentificationNumber
string
optional
Tax identification number of the customer.
LoyaltyCode
string
optional
Loyalty code of the customer.
AccountingCode
string
optional
Accounting code of the customer.
BillingCode
string
optional
Billing code of the customer.
Notes
string
optional
Internal notes about the customer.
CarRegistrationNumber
string
optional, max length 255 characters
Registration number of the customer's car.
DietaryRequirements
string
optional, max length 255 characters
Customer's dietary requirements, e.g. Vegan, Halal.
CreatedUtc
string
required
Creation date and time of the customer in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the customer in UTC timezone in ISO 8601 format.
AddressId
string
optional
Unique identifier of the Address
of the customer.
Classifications
required
Classifications of the customer.
Options
required
Options of the customer.
ItalianDestinationCode
string
optional
Value of Italian destination code.
ItalianFiscalCode
string
optional
Value of Italian fiscal code.
CompanyId
string
optional
MergeTargetId
string
optional
IsActive
boolean
required
Whether the customer record is still active.
PreferredSpaceFeatures
required
A list of room preferences, such as view type, bed type, and amenities.
Passport
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
IdentityCard
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
Visa
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
DriversLicense
optional
Deprecated! Use record from Documents
with relevant CustomerId
instead.
Address
optional
Deprecated! Use AddressId
instead.
ActivityState
string
optional
Add customer file
Attaches the specified file to the customer profile.
Allowed MIME types: application/pdf
, image/bmp
, image/gif
, image/jpeg
, image/png
, image/tiff
.
Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/customers/addFile
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.
ChainId
string
optional
CustomerId
string
required
Name
string
required
Name of the file.
Type
string
required
MIME type of the file (e.g. application/pdf
).
Data
string
required
Base64-encoded data of the file.
Response
FileId
string
required
Unique identifier of the uploaded file.
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
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.
Name
string
optional
Name to search by (applies to first name, last name, and full name).
ResourceId
string
optional
Extent
optional
Extent of data to be returned.
Response
Customers
required
The customer search results.
Documents
optional
The identity documents of customers.
Customer search result
Customer
required
The found customer.
Reservation
optional
Reservation of the customer in case they are currently staying in the property.
Merge customers
Deprecated!This operation is deprecated. Use Merge accounts instead.
Request
[PlatformAddress]/api/connector/v1/customers/merge
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.
SourceCustomerId
string
required
TargetCustomerId
string
required
Response
Last updated