Get all companionships
POST /api/connector/v1/companionships/getAll
Returns all companionships based on customers, reservations or reservation groups. One of them must be specified in the request. Note this operation uses Pagination and supports Portfolio Access Tokens.
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.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of Companionship.
Extent of data to be returned. E.g. it is possible to specify that together with the companionships, customers, reservations, and reservation groups should be also returned.
object
Unique identifiers of reservations.
Unique identifiers of Customers.
Unique identifiers of Reservation groups.
object
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "CompanionshipIds": [ "72d4b117-1f84-44a3-1f84-8b2c0635ac60" ], "CustomerIds": [ "35d4b117-4e60-44a3-9580-c582117eff98" ], "ReservationIds": [ "bfee2c44-1f84-4326-a862-5289598f6e2d" ], "ReservationGroupIds": [ "c704dff3-7811-4af7-a3a0-7b2b0635ac59" ], "UpdatedUtc": { "StartUtc": "2020-02-05T00:00:00Z", "EndUtc": "2020-02-10T00:00:00Z" }, "Limitation": { "Count": 10 }}Responses
Section titled “ Responses ”OK
object
Companionships.
object
Unique identifier of Companionship.
Unique identifier of Customer.
Unique identifier of Reservation group.
Unique identifier of reservation.
The accompanied reservations.
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.
The accompanied reservation groups.
object
Unique identifier of the reservation group.
Name of the reservation group.
Customers that belong to the companionships.
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.
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.
Example
{ "Companionships": [ { "Id": "72d4b117-1f84-44a3-1f84-8b2c0635ac60", "CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98", "ReservationGroupId": "c704dff3-7811-4af7-a3a0-7b2b0635ac59", "ReservationId": "bfee2c44-1f84-4326-a862-5289598f6e2d" } ], "Customers": null, "Reservations": null, "ReservationGroups": null, "Cursor": "72d4b117-1f84-44a3-1f84-8b2c0635ac60"}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.