openapi: 3.0.4 info: title: BookingEngineApi Account notes Reservations API version: v1 servers: - url: https://api.mews.com tags: - name: Reservations paths: /api/connector/v1/reservations/getChannelManagerDetails: post: tags: - Reservations summary: Get reservation channel manager details description: Returns channel manager-related details for the specified reservations. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: reservations_getChannelManagerDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationsChannelManagerDetailsFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationsChannelManagerDetailsResult' example: ChannelManagerDetails: - ReservationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 RequestedRateCode: XyZ123AbC789 ChannelManagerName: HotelConnect ChannelNumber: HC1234 ChannelManagerGroupNumber: 9E5F7BC3B6F0102 ChannelManagerNumber: '1' CreatedUtc: '2025-03-10T15:30:00Z' - ReservationId: 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 RequestedRateCode: LmN456OpQ012 ChannelManagerName: GlobalRes ChannelNumber: GR5678 ChannelManagerGroupNumber: 461190401CD25FE ChannelManagerNumber: '1' CreatedUtc: '2025-03-11T09:45:00Z' '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' x-restricted: true /api/connector/v1/reservations/getAll/2023-06-06: post: tags: - Reservations summary: Get all reservations (ver 2023-06-06) description: 'Returns all reservations within scope of the Access Token, filtered according to the specified parameters. This operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). ' operationId: reservations_getAll_2023-06-06 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationServiceOrderFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - 0f515589-99b4-423d-b83a-b237009f0509 - 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 - 8c1bd738-a505-4b29-aa71-9ecc2982b843 ReservationGroupIds: - 94843f6f-3be3-481b-a1c7-06458774c3df AccountIds: - fadd5bb6-b428-45d5-94f8-fd0d89fece6d PartnerCompanyIds: - c021013e-4930-4592-8e32-91b0b1fc9663 TravelAgencyIds: - a793d381-65a2-4fa6-9514-00c4c5bfe607 Numbers: - '50' - '51' - '52' - '53' AssignedResourceIds: - 5ee074b1-6c86-48e8-915f-c7aa4702086f - c32386aa-1cd2-414a-a823-489325842fbe AvailabilityBlockIds: - 5ee074b1-6c86-48e8-915f-c7aa4702086f - c32386aa-1cd2-414a-a823-489325842fbe CreatedUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' UpdatedUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' CollidingUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' ScheduledStartUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' ScheduledEndUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' States: - Inquired - Confirmed EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationServiceOrderResult' example: Reservations: - Id: 0f515589-99b4-423d-b83a-b237009f0509 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d AccountType: Customer CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 Number: '52' State: Confirmed Origin: Connector CommanderOrigin: null OriginDetails: null CreatedUtc: '2023-03-23T16:00:00Z' UpdatedUtc: '2023-04-22T17:00:00Z' CancelledUtc: null VoucherId: null BusinessSegmentId: null Options: OwnerCheckedIn: true AllCompanionsCheckedIn: true AnyCompanionCheckedIn: true ConnectorCheckIn: true RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda CreditCardId: null GroupId: 94843f6f-3be3-481b-a1c7-06458774c3df RequestedResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f PartnerCompanyId: c021013e-4930-4592-8e32-91b0b1fc9663 TravelAgencyId: a793d381-65a2-4fa6-9514-00c4c5bfe607 AssignedResourceLocked: false ChannelNumber: TW48ZP ChannelManagerNumber: '' CancellationReason: null ReleasedUtc: null StartUtc: '2023-04-23T14:00:00Z' EndUtc: '2023-04-25T12:00:00Z' ScheduledStartUtc: '2023-04-23T14:00:00Z' ActualStartUtc: null ScheduledEndUtc: '2023-04-25T12:00:00Z' ActualEndUtc: null Purpose: Leisure QrCodeData: '{"Reservations":[{"Id":"0f515589-99b4-423d-b83a-b237009f0509","GroupId":"94843f6f-3be3-481b-a1c7-06458774c3df","CustomerId":"fadd5bb6-b428-45d5-94f8-fd0d89fece6d"}]}' PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 Cursor: 0f515589-99b4-423d-b83a-b237009f0509 '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/getAll: post: tags: - Reservations summary: Get all reservations (ver 2017-04-12) description: Use [Get all reservations (ver 2023-06-06)](https://mews-systems.gitbook.io/connector-api/operations/reservations#get-all-reservations-ver-2023-06-06). operationId: reservations_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 StartUtc: '2016-01-01T00:00:00Z' EndUtc: '2016-01-07T00:00:00Z' ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 ReservationIds: - db6cad34-9a91-448b-bea1-abbe01240d9c CustomerIds: - 8e1d0ca6-1dde-4be0-8566-aafc01866110 RateIds: - ed4b660b-19d0-434b-9360-a4de2ea42eda ChannelNumbers: - TW48ZP States: - Started Extent: Reservations: true ReservationGroups: true Customers: true Limitation: Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationResult' example: BusinessSegments: null Customers: - Address: null BirthDate: null BirthPlace: null CategoryId: null Classifications: [] CreatedUtc: '2016-01-01T00:00:00Z' Email: null FirstName: John Sex: null Id: 35d4b117-4e60-44a3-9580-c582117eff98 IdentityCard: null LanguageCode: null LastName: Smith LoyaltyCode: null NationalityCode: US Notes: '' Number: '1' Passport: null Phone: 00420123456789 SecondLastName: null TaxIdentificationNumber: null Title: null UpdatedUtc: '2016-01-01T00:00:00Z' Visa: null OrderItems: null Products: null RateGroups: null Rates: null ReservationGroups: - Id: c704dff3-7811-4af7-a3a0-7b2b0635ac59 Name: 13-12-Smith-F712 Reservations: - Id: bfee2c44-1f84-4326-a862-5289598f6e2d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 GroupId: 94843f6f-3be3-481b-a1c7-06458774c3df Number: '52' ChannelNumber: TW48ZP ChannelManager: '' ChannelManagerGroupNumber: null ChannelManagerNumber: null State: Processed Origin: Connector OriginDetail: null Purpose: Student CreatedUtc: '2016-02-20T14:58:02Z' UpdatedUtc: '2016-02-20T14:58:02Z' CancelledUtc: null StartUtc: '2016-02-20T13:00:00Z' EndUtc: '2016-02-22T11:00:00Z' ReleasedUtc: null RequestedCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 AssignedResourceLocked: false BusinessSegmentId: null CompanyId: null TravelAgencyId: null AvailabilityBlockId: null RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: null CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 Services: null Resources: null ResourceCategories: null ResourceCategoryAssignments: null Notes: null Cursor: 8d02142f-31cf-4115-90bf-ae5200c7a1ba '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' deprecated: true x-deprecatedMessage: Use [Get all reservations (ver 2023-06-06)](https://mews-systems.gitbook.io/connector-api/operations/reservations#get-all-reservations-ver-2023-06-06). /api/connector/v1/reservations/price: post: tags: - Reservations summary: Price reservations description: "Returns prices of reservations with the specified parameters.\r\nNote that the operation doesn't check the maximum capacity of requested resource category. Requesting person counts above the capacity will return prices for the maximum available capacity.\r\n\r\nThis operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/)." operationId: reservations_price requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationDataParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 Reservations: - Identifier: '1234' StartUtc: '2018-01-01T14:00:00Z' EndUtc: '2018-01-02T10:00:00Z' RequestedCategoryId: 0a5da171-3663-4496-a61e-35ecbd78b9b1 RateId: 33667cab-f17f-4089-ad07-c2cd50fa0df1 Notes: Test reservation ProductOrders: - ProductId: 3dc5d79b-67ce-48ed-9238-47fcf5d1a59f PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationPricingResult' example: ReservationPrices: - Identifier: '1234' Total: Currency: GBP NetValue: 20 GrossValue: 23 TaxValues: - Code: UK-S Value: 3 '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/add: post: tags: - Reservations summary: Add reservations description: 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. operationId: reservations_add requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationAdditionParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 GroupId: null GroupName: null SendConfirmationEmail: true Reservations: - Identifier: '1234' State: Confirmed StartUtc: '2021-01-01T14:00:00Z' EndUtc: '2021-01-03T10:00:00Z' ReleasedUtc: null CustomerId: e465c031-fd99-4546-8c70-abcf0029c249 BookerId: e465c031-fd99-4546-8c70-abcf0029c249 RequestedCategoryId: 0a5da171-3663-4496-a61e-35ecbd78b9b1 RateId: a39a59fa-3a08-4822-bdd4-ab0b00e3d21f TravelAgencyId: null CompanyId: null Notes: Test reservation TimeUnitAmount: null PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 TimeUnitPrices: - Index: 0 Amount: Currency: GBP GrossValue: 20 TaxCodes: - UK-S - Index: 1 Amount: Currency: GBP GrossValue: 30 TaxCodes: - UK-S ProductOrders: - ProductId: 2e9eb3fc-8a77-466a-9cd9-abcf002a2a01 StartUtc: '2021-01-02T00:00:00Z' EndUtc: '2021-01-03T00:00:00Z' AvailabilityBlockId: null VoucherCode: SpringSale2021 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationAdditionResult' example: Reservations: - Identifier: '1234' Reservation: Id: bfee2c44-1f84-4326-a862-5289598f6e2d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 GroupId: 94843f6f-3be3-481b-a1c7-06458774c3df Number: '52' ChannelManager: '' ChannelManagerGroupNumber: null ChannelManagerNumber: null ChannelNumber: null State: Processed Origin: Connector CreatedUtc: '2016-02-20T14:58:02Z' UpdatedUtc: '2016-02-20T14:58:02Z' CancelledUtc: null StartUtc: '2016-02-20T13:00:00Z' EndUtc: '2016-02-22T11:00:00Z' ReleasedUtc: null RequestedCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 AssignedResourceLocked: false BusinessSegmentId: null CompanyId: null TravelAgencyId: null AvailabilityBlockId: null RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: null CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 CompanionIds: - b22bf671-ccdf-40aa-a7e6-b20a4f91d79a '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/update: post: tags: - Reservations summary: Update reservations description: 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](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleReservationUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Client: Sample Client 1.0.0 Reason: Testing CheckOverbooking: true CheckRateApplicability: true Reprice: true ApplyCancellationFee: true ReservationUpdates: - ReservationId: 622605a9-2969-441f-9610-aa720099ae1c StartUtc: Value: '2019-10-01T14:00:00Z' EndUtc: Value: '2019-10-03T10:00:00Z' AssignedResourceId: Value: 16ce4335-2198-408b-8949-9722894a42fb AssignedResourceLocked: Value: 'false' ChannelNumber: null RequestedCategoryId: null TravelAgencyId: Value: null CompanyId: Value: 73ba34d1-f375-460c-bf2d-8a63e71677a6 BusinessSegmentId: null Purpose: Value: Business RateId: null BookerId: Value: 92923102-bf91-4a4a-8ee8-9dcb79c9d6de TimeUnitPrices: Value: - Index: 0 Amount: Currency: GBP GrossValue: 20 TaxCodes: - UK-S - Index: 1 Amount: Currency: GBP GrossValue: 30 TaxCodes: - UK-S PersonCounts: Value: - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 CreditCardId: Value: 5d802a8f-3238-42b2-94be-ab0300ab2b6c AvailabilityBlockId: Value: aaaa654a4a94-4f96-9efc-86da-bd26d8db Options: OwnerCheckedIn: Value: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationResult' example: BusinessSegments: null Customers: - Address: null BirthDate: null BirthPlace: null CategoryId: null Classifications: [] CreatedUtc: '2016-01-01T00:00:00Z' Email: null FirstName: John Sex: null Id: 35d4b117-4e60-44a3-9580-c582117eff98 IdentityCard: null LanguageCode: null LastName: Smith LoyaltyCode: null NationalityCode: US Notes: '' Number: '1' Passport: null Phone: 00420123456789 SecondLastName: null TaxIdentificationNumber: null Title: null UpdatedUtc: '2016-01-01T00:00:00Z' Visa: null OrderItems: null Products: null RateGroups: null Rates: null ReservationGroups: - Id: c704dff3-7811-4af7-a3a0-7b2b0635ac59 Name: 13-12-Smith-F712 Reservations: - Id: bfee2c44-1f84-4326-a862-5289598f6e2d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 GroupId: 94843f6f-3be3-481b-a1c7-06458774c3df Number: '52' ChannelNumber: TW48ZP ChannelManager: '' ChannelManagerGroupNumber: null ChannelManagerNumber: null State: Processed Origin: Connector OriginDetail: null Purpose: Student CreatedUtc: '2016-02-20T14:58:02Z' UpdatedUtc: '2016-02-20T14:58:02Z' CancelledUtc: null StartUtc: '2016-02-20T13:00:00Z' EndUtc: '2016-02-22T11:00:00Z' ReleasedUtc: null RequestedCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 AssignedResourceLocked: false BusinessSegmentId: null CompanyId: null TravelAgencyId: null AvailabilityBlockId: null RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: null CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 Services: null Resources: null ResourceCategories: null ResourceCategoryAssignments: null Notes: null Cursor: 8d02142f-31cf-4115-90bf-ae5200c7a1ba '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/confirm: post: tags: - Reservations summary: Confirm reservation description: Marks all specified reservations as `Confirmed`. Succeeds only if all confirmation conditions are met (the reservations have the `Optional` state). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: reservations_confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmReservationParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - 9af9d8b0-43ae-414d-80a8-abc1012a2a59 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MultipleReservationResult' example: ReservationIds: - 5ca70705-cbb7-48c4-8cc4-abb900aa278c '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/start: post: tags: - Reservations summary: Start reservation description: 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](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_start requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationStartParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/process: post: tags: - Reservations summary: Process reservation description: '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](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). ### 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 to `false`, all bills have to be closable (items on bills are either paid by current customer, or set to be paid by other customer). With `CloseBills` option set to `true` they can be automatically closed, when set to `false` they must be closed manually. - If `AllowOpenBalance` set to `true`, `Notes` must be filled in.' operationId: reservations_process requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationProcessingParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b CloseBills: false AllowOpenBalance: false Notes: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/cancel: post: tags: - Reservations summary: Cancel reservation description: Cancels all reservation with specified identifiers. Succeeds only if the reservations are cancellable. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationCancellationParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationIds: - 5ca70705-cbb7-48c4-8cc4-abb900aa278c PostCancellationFee: true Notes: Cancellation through Connector API responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MultipleReservationResult' example: ReservationIds: - 5ca70705-cbb7-48c4-8cc4-abb900aa278c '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/updateCustomer: post: tags: - Reservations summary: Update reservation customer description: Updates customer of a reservation. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_updateCustomer requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationsUpdateCustomerParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationId: 209d984d-4985-4efb-96ec-f6591fc597bf CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/updateInterval: post: tags: - Reservations summary: Update reservation interval description: Updates reservation interval (start, end or both). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_updateInterval requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationUpdateIntervalParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationId: 209d984d-4985-4efb-96ec-f6591fc597bf StartUtc: '2017-08-12T15:00:00Z' EndUtc: '2017-08-15T12:00:00Z' ChargeCancellationFee: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/addCompanion: post: tags: - Reservations summary: Add reservation companion description: 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`). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: reservations_addCompanion requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanionshipAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CompanionshipAddResult' '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/deleteCompanion: post: tags: - Reservations summary: Delete reservation companion description: Removes customer companionship from the reservation. Note that the customer profile stays untouched, only the relation between the customer and reservation is deleted. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: reservations_deleteCompanion requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanionshipDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/addProduct: post: tags: - Reservations summary: Add reservation product description: Adds a new product order of the specified product to the reservation. operationId: reservations_addProduct requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationProductParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationId: 4d2aa234-5d30-472c-899f-ab45008c3479 ProductId: 47312820-2268-4f5c-864d-aa4100ed82bc Count: 1 StartUtc: '2021-01-02T00:00:00Z' EndUtc: '2021-01-03T00:00:00Z' UnitAmount: Currency: GBP GrossValue: 10 TaxCodes: - UK-S responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddProductItemsResult' example: ItemIds: - ff81fd7a-29ba-4160-8e22-ab4300f67b23 '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/reservations/getAllItems: post: tags: - Reservations summary: Get all reservation items description: Use orderItems/getAll. operationId: reservations_getAllItems requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationItemParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - e6ea708c-2a2a-412f-a152-b6c76ffad49b Currency: EUR AccountingStates: - Closed responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationItemResult' example: Reservations: - ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b OrderItems: - Id: 784a29df-6196-4402-96a0-58695a881239 AccountId: d73a087a-00c7-40cf-9372-314d0296334d OrderId: e6ea708c-2a2a-412f-a152-b6c76ffad49b BillId: 7fdc2957-bc08-44d3-ba2a-1c1760a84894 AccountingCategoryId: 0cf7aa90-736f-43e9-a7dc-787704548d86 Amount: Currency: EUR NetValue: 19.38 GrossValue: 23.26 TaxValues: - Code: UK-S Value: 3.88 Breakdown: Items: - TaxRateCode: UK-S NetValue: 19.38 TaxValue: 3.88 RevenueType: Service ConsumedUtc: '2016-03-10T13:00:00Z' ClosedUtc: '2016-04-06T06:41:44Z' AccountingState: Closed Data: Discriminator: ProductOrder Value: ProductId: a3f4e006-b3e4-4485-8a00-ad11015ac494 '400': description: 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). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: 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. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: 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](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' deprecated: true x-deprecatedMessage: Use orderItems/getAll. components: schemas: ReservationServiceOrderResult: title: ReservationServiceOrderResult required: - Reservations type: object properties: Reservations: type: array items: $ref: '#/components/schemas/Reservation' description: The reservations of the enterprise. Cursor: type: string description: 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. format: uuid nullable: true additionalProperties: false x-schema-id: ReservationServiceOrderResult ResourceAccessTokenPermissions: title: Resource access token permissions type: object properties: Bed: type: boolean description: Specify whether the resource access token grants permission to access bed. Room: type: boolean description: Specify whether the resource access token grants permission to access room. Floor: type: boolean description: Specify whether the resource access token grants permission to access floor. Building: type: boolean description: Specify whether the resource access token grants permission to access building. additionalProperties: false description: '' x-schema-id: ResourceAccessTokenPermissions RateForExtent: title: Rate for extent required: - GroupId - Id - IsActive - IsBaseRate - IsEnabled - IsPublic - Names - ServiceId - Type - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the rate. format: uuid GroupId: type: string description: Unique identifier of `Rate Group` where the rate belongs. format: uuid ServiceId: type: string description: Unique identifier of the `Service`. format: uuid BaseRateId: type: string description: Unique identifier of the base `Rate`. format: uuid nullable: true IsBaseRate: type: boolean description: Whether the rate is a base rate. BusinessSegmentId: type: string description: Unique identifier of the `Business Segment`. format: uuid nullable: true IsActive: type: boolean description: Whether the rate is still active. IsEnabled: type: boolean description: Whether the rate is currently available to customers. IsPublic: type: boolean description: Whether the rate is publicly available. Type: title: Rate type allOf: - $ref: '#/components/schemas/RateTypeEnum' description: 'Type of the rate. Public Private AvailabilityBlock' x-enumNames: - Public - Private - AvailabilityBlock x-enumDescriptions: - '' - '' - '' Name: type: string description: Name of the rate (in the default language). nullable: true deprecated: true x-deprecatedMessage: Use `Names` instead Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings ShortName: type: string description: Short name of the rate (in the default language). nullable: true UpdatedUtc: minLength: 1 type: string description: Interval in which the rates were updated. format: date-time ExternalNames: title: Localized text type: object additionalProperties: type: string description: All translations of the external name of the rate. nullable: true x-schema-id: LocalizedStrings Description: title: Localized text type: object additionalProperties: type: string description: All translations of the description of the rate. nullable: true x-schema-id: LocalizedStrings ExternalIdentifier: maxLength: 255 type: string description: Identifier of the rate from external system. nullable: true additionalProperties: false description: '`Rate` entity, without some of the details, e.g. pricing.' x-schema-id: RateForExtent ConnectorApiExceptionResult: title: ConnectorApiExceptionResult type: object properties: Message: type: string nullable: true RequestId: type: string nullable: true Details: nullable: true additionalProperties: false x-schema-id: ConnectorApiExceptionResult TaxValue: title: Tax value required: - Value type: object properties: Code: type: string description: Code corresponding to tax type. nullable: true Value: type: number description: Amount of tax applied. format: double additionalProperties: false x-schema-id: TaxValue ReservationGroupOld: title: Reservation groups (ver 2017-04-12) type: object properties: Id: type: string description: Unique identifier of the reservation group. format: uuid Name: type: string description: Name of the reservation group. nullable: true additionalProperties: false x-schema-id: ReservationGroupOld ReservationQrCodeData: title: Reservation QR code data type: object properties: ReservationId: type: string description: Unique identifier of the reservation. format: uuid Data: type: string description: Reservation data for QR code generation. nullable: true additionalProperties: false x-schema-id: ReservationQrCodeData RebateOrderItemData: title: Rebate order item data required: - RebatedItemId type: object properties: RebatedItemId: type: string description: Unique identifier of `OrderItem` which has been rebated by current item. format: uuid additionalProperties: false x-schema-id: RebateOrderItemData ProductOrderItemData: title: Product order item data required: - ProductId type: object properties: ProductId: type: string description: Unique identifier of the `Product`. format: uuid AgeCategoryId: type: string description: Unique identifier of the `AgeCategory`. format: uuid nullable: true additionalProperties: false x-schema-id: ProductOrderItemData Customer: title: Customer required: - ChainId - Classifications - CreatedUtc - CreatorProfileId - Id - IsActive - LastName - Number - Options - PreferredSpaceFeatures - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the customer. format: uuid ChainId: type: string description: Unique identifier of the chain. format: uuid Number: maxLength: 19 minLength: 1 type: string description: Unique number of the customer (max 19 digits). Title: allOf: - $ref: '#/components/schemas/Title' description: 'Title of the customer. Mister (Mr.) Miss (Ms.) Misses (Mrs.)' nullable: true Sex: allOf: - $ref: '#/components/schemas/SexEnum' description: 'Sex of the customer. Male Female' nullable: true FirstName: type: string description: First name of the customer. nullable: true LastName: minLength: 1 type: string description: Last name of the customer. SecondLastName: type: string description: Second last name of the customer. nullable: true NationalityCode: type: string description: ISO 3166-1 code of the [Country](https://mews-systems.gitbook.io/connector-api/operations/countries/#country). nullable: true PreferredLanguageCode: type: string description: 'Language and culture code of the customer''s preferred language, according to their profile. For example: `en-GB`, `fr-CA`.' nullable: true LanguageCode: type: string description: 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`. nullable: true BirthDate: type: string description: Date of birth in ISO 8601 format. nullable: true BirthCountryCode: type: string description: ISO 3166-1 alpha-2 code of the birth country. nullable: true BirthCountrySubdivisionCode: type: string description: ISO 3166-2 code of the administrative division, e.g. ES-C. nullable: true BirthPlace: type: string description: Place of birth. nullable: true Occupation: type: string description: Occupation of the customer. nullable: true Email: type: string description: Email address of the customer. nullable: true HasOtaEmail: type: boolean description: Whether the customer's email address is a temporary email address from an OTA. For more details, see the [product documentation](https://help.mews.com/s/article/how-to-maintain-ota-guest-profiles-with-verified-email-addresses-obtained-from-the-guest-portal). Phone: type: string description: Phone number of the customer (possibly mobile). nullable: true TaxIdentificationNumber: type: string description: Tax identification number of the customer. nullable: true LoyaltyCode: type: string description: Loyalty code of the customer. nullable: true AccountingCode: type: string description: Accounting code of the customer. nullable: true BillingCode: type: string description: Billing code of the customer. nullable: true Notes: type: string description: Internal notes about the customer. nullable: true CarRegistrationNumber: maxLength: 255 type: string description: Registration number of the customer's car. nullable: true DietaryRequirements: maxLength: 255 type: string description: Customer's dietary requirements, e.g. Vegan, Halal. nullable: true CreatedUtc: minLength: 1 type: string description: Creation date and time of the customer in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the customer in UTC timezone in ISO 8601 format. format: date-time Passport: title: Identity document allOf: - $ref: '#/components/schemas/IdentityDocument' nullable: true deprecated: true x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents. IdentityCard: title: Identity document allOf: - $ref: '#/components/schemas/IdentityDocument' nullable: true deprecated: true x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents. Visa: title: Identity document allOf: - $ref: '#/components/schemas/IdentityDocument' nullable: true deprecated: true x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents. DriversLicense: title: Identity document allOf: - $ref: '#/components/schemas/IdentityDocument' nullable: true deprecated: true x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents. Address: title: Address allOf: - $ref: '#/components/schemas/OldAddress' description: '' nullable: true deprecated: true x-deprecatedMessage: Use `AddressId` instead. AddressId: type: string description: Unique identifier of the `Address` of the customer. format: uuid nullable: true Classifications: type: array items: $ref: '#/components/schemas/CustomerClassificationEnum' description: Classifications of the customer. Options: type: array items: $ref: '#/components/schemas/CustomerOptionsEnum' description: Options of the customer. ItalianDestinationCode: type: string description: Value of Italian destination code. nullable: true ItalianFiscalCode: type: string description: Value of Italian fiscal code. nullable: true ItalianLotteryCode: type: string description: Italian lottery code. nullable: true CompanyId: type: string description: Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) the customer is associated with. format: uuid nullable: true MergeTargetId: type: string description: Unique identifier of the account ([Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer)) to which this customer is linked. format: uuid nullable: true ActivityState: type: string description: '[Activity State](https://mews-systems.gitbook.io/connector-api/operations/#activity-state) of customer record, i.e. whether active or deleted.' nullable: true deprecated: true x-deprecatedMessage: Use `IsActive` instead. IsActive: type: boolean description: Whether the customer record is still active. PreferredSpaceFeatures: type: array items: $ref: '#/components/schemas/ResourceFeatureClassification' description: A list of room preferences, such as view type, bed type, and amenities. CreatorProfileId: type: string description: Unique identifier of the user who created the customer. format: uuid UpdaterProfileId: type: string description: Unique identifier of the user who last updated the customer. format: uuid additionalProperties: false x-schema-id: Customer ResourceCategoryType: title: Resource category type enum: - Room - Bed - Dorm - Apartment - Suite - Villa - Site - Office - MeetingRoom - ParkingSpot - Desk - TeamArea - Membership - Tent - CaravanOrRV - UnequippedCampsite - Bike - ExtraBed - Cot - Crib - ConferenceRoom - Rooftop - Garden - Restaurant - Amphitheater - PrivateSpaces type: string description: Type of the category. GuidUpdateValue: title: Guid update value type: object properties: Value: type: string description: Value which is to be updated. format: uuid additionalProperties: false x-schema-id: GuidUpdateValue ResourceState: title: Resource state enum: - Dirty - Clean - Inspected - OutOfService - OutOfOrder type: string description: 'State of the resource. Dirty Clean Inspected OutOfService OutOfOrder' x-enumNames: - Dirty - Clean - Inspected - OutOfService - OutOfOrder x-enumDescriptions: - '' - '' - '' - '' - '' x-schema-id: ResourceState ReservationFilterParameters: title: ReservationFilterParameters required: - AccessToken - Client - ClientToken - Extent - Limitation - ServiceIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service) from which the reservations are requested. ServiceId: type: string format: uuid nullable: true deprecated: true GroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested [Reservation groups](https://mews-systems.gitbook.io/connector-api/operations/#reservation-group). nullable: true ReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2017-04-12). nullable: true CustomerIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) which own the reservations. nullable: true AssignedResourceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Resources](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource) assigned to the reservations. nullable: true RateIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Rates](https://mews-systems.gitbook.io/connector-api/operations/rates/#rate) assigned to the reservations. nullable: true BusinessSegmentIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Business segments](https://mews-systems.gitbook.io/connector-api/operations/businesssegments/#business-segment) assigned to the reservations. nullable: true ChannelNumbers: maxItems: 1000 minItems: 1 type: array items: type: string description: 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. nullable: true Numbers: maxItems: 1000 minItems: 1 type: array items: type: string description: Confirmation numbers of [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2017-04-12). nullable: true StartUtc: type: string description: Start of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter. format: date-time nullable: true EndUtc: type: string description: End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter. format: date-time nullable: true TimeFilter: anyOf: - $ref: '#/components/schemas/ReservationTimeFilter' description: Time filter of the interval. If not specified, reservations Colliding with the interval are returned. nullable: true Currency: type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to. format: currency nullable: true States: type: array items: $ref: '#/components/schemas/ServiceOrderStateOld' description: States the reservations should be in. If not specified, reservations in Confirmed, Started or Processed states or reservations specified by ReservationIds regardless of state are returned. nullable: true Extent: title: Reservation extent allOf: - $ref: '#/components/schemas/ReservationExtent' description: 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. Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned. additionalProperties: false x-schema-id: ReservationFilterParameters OrderNote: title: Service order note type: object properties: Id: type: string description: Unique identifier of the service order note. format: uuid OrderId: type: string description: Unique identifier of the `Service order` to which the Service Order Note belongs. format: uuid Text: type: string description: Content of the service order note. nullable: true Type: title: Service order note type allOf: - $ref: '#/components/schemas/OrderNoteTypeEnum' description: 'A discriminator specifying the type of service order note, e.g. general or channel manager. General ChannelManager SpecialRequest' x-enumNames: - General - ChannelManager - SpecialRequest x-enumDescriptions: - '' - '' - '' CreatedUtc: type: string description: Creation date and time of the service order note in UTC timezone in ISO 8601 format. format: date-time nullable: true UpdatedUtc: type: string description: Last update date and time of the service order note in UTC timezone in ISO 8601 format. format: date-time nullable: true additionalProperties: false x-schema-id: OrderNote AddedReservation: title: Added reservation required: - Reservation type: object properties: Identifier: type: string description: Identifier of the reservation within the transaction. nullable: true Reservation: title: Reservation (ver 2017-04-12) allOf: - $ref: '#/components/schemas/ReservationOld' description: The added reservation. additionalProperties: false x-schema-id: AddedReservation ResourceDataDiscriminator: title: Resource data discriminator enum: - Space - Object - Person type: string description: Whether the resource is space, object, or person. ReservationsUpdateCustomerParameters: title: ReservationsUpdateCustomerParameters required: - AccessToken - Client - ClientToken - CustomerId - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationId: type: string description: Unique identifier of the reservation to be updated. format: uuid CustomerId: type: string description: Unique identifier of the [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer). format: uuid additionalProperties: false x-schema-id: ReservationsUpdateCustomerParameters Limitation: title: Limitation required: - Count type: object properties: Count: type: integer format: int32 Cursor: type: string format: uuid nullable: true additionalProperties: false description: Limitation on the quantity of data returned. x-schema-id: Limitation ServiceOrderStateOld: title: Service order state (ver 2017-04-12) enum: - Enquired - Confirmed - Started - Processed - Canceled - Optional - Requested type: string CancellationReason: enum: - Other - ConfirmationMissed - BookedElsewhere - ForceMajeure - GuestComplaint - NoShow - PriceTooHigh - ServiceNotAvailable - InputError - InvalidPayment - TravelAgency - RequestedByGuest - Update - BookingAbandoned - RequestedByBooker type: string RateTypeEnum: title: Rate type enum: - Public - Private - AvailabilityBlock type: string description: ' Public Private AvailabilityBlock' x-enumNames: - Public - Private - AvailabilityBlock x-enumDescriptions: - '' - '' - '' Service: title: Service required: - CreatedUtc - Data - EnterpriseId - Id - IsActive - Name - Names - Options - Ordering - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the service. format: uuid EnterpriseId: type: string description: Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise). format: uuid IsActive: type: boolean description: Whether the service is still active. Name: minLength: 1 type: string description: Name of the service. deprecated: true x-deprecatedMessage: Use `Names` instead Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings StartTime: type: string nullable: true deprecated: true EndTime: type: string nullable: true deprecated: true Options: title: Service options allOf: - $ref: '#/components/schemas/ServiceOptions' description: Options of the service. Promotions: allOf: - $ref: '#/components/schemas/Promotions' description: '' nullable: true deprecated: true x-deprecatedMessage: Use `Promotions` in `Data` instead. Type: type: string nullable: true deprecated: true Ordering: type: integer description: Order value for presentation purposes. format: int32 Data: title: Service data type: object properties: Discriminator: $ref: '#/components/schemas/ServiceDataDiscriminator' Value: oneOf: - $ref: '#/components/schemas/BookableServiceData' - $ref: '#/components/schemas/AdditionalServiceData' description: Additional information about the specific service. x-coproduct: true x-schema-id: ServiceDataCoproductOfServiceDataDiscriminator ExternalIdentifier: maxLength: 255 type: string description: Identifier of the service from external system. nullable: true CreatedUtc: minLength: 1 type: string description: Creation date and time of the service in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the service in UTC timezone in ISO 8601 format. format: date-time additionalProperties: false description: '' x-schema-id: Service OrderItemOld: title: Order item required: - AccountId - AccountingState - Amount - CreatedUtc - CreatorProfileId - Data - Id - OrderId - OriginalAmount - RevenueType - UnitAmount - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the item. format: uuid AccountId: type: string description: Unique identifier of the account (for example `Customer`) the item belongs to. format: uuid OrderId: type: string description: Unique identifier of the order (or `Reservation` which is a special type of order) the item belongs to. format: uuid BillId: type: string description: Unique identifier of the `Bill` the item is assigned to. format: uuid nullable: true AccountingCategoryId: type: string description: Unique identifier of the `AccountingCategory` the item belongs to. format: uuid nullable: true UnitCount: type: integer description: Unit count of item, i.e. the number of sub-items or units, if applicable. format: int32 UnitAmount: title: Amount allOf: - $ref: '#/components/schemas/Amount' description: Unit amount of item, i.e. the amount of each individual sub-item or unit, if applicable. Amount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Amount of item; note a negative amount represents a rebate or payment. OriginalAmount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain. RevenueType: minLength: 1 type: string description: Revenue type of the item. CreatorProfileId: type: string description: Unique identifier of the user who created the item. format: uuid UpdaterProfileId: type: string description: Unique identifier of the user who updated the item. format: uuid CreatedUtc: minLength: 1 type: string description: Creation date and time of the item in UTC timezone in ISO 8601 format. format: date UpdatedUtc: minLength: 1 type: string description: Last update date and time of the item in UTC timezone in ISO 8601 format. format: date ConsumedUtc: type: string description: Date and time of the item consumption in UTC timezone in ISO 8601 format. format: date nullable: true CanceledUtc: type: string description: Cancellation date and time of the item in UTC timezone in ISO 8601 format. format: date nullable: true ClosedUtc: type: string description: Date and time of the item bill closure in UTC timezone in ISO 8601 format. format: date nullable: true StartUtc: type: string description: Start date and time of the item in UTC timezone in ISO 8601 format. format: date nullable: true AccountingState: minLength: 1 type: string description: Accounting state of the item. Data: title: Order item data type: object properties: Discriminator: $ref: '#/components/schemas/OrderItemTypeOld' Value: oneOf: - $ref: '#/components/schemas/RebateOrderItemData' - $ref: '#/components/schemas/ProductOrderItemData' description: Based on order item discriminator or `null` for types without any additional data. nullable: true description: Additional data specific to particular order item. x-coproduct: true x-schema-id: OrderItemOldDataCoproductOfOrderItemTypeOld additionalProperties: false x-schema-id: OrderItemOld ResourceCategoryAssignment: title: Resource category assignment required: - CategoryId - CreatedUtc - Id - IsActive - ResourceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the assignment. format: uuid IsActive: type: boolean description: Whether the assignment is still active. ResourceId: type: string description: Unique identifier of the [Resource](https://mews-systems.gitbook.io/connector-api/operations/#resource) assigned to the Resource category. format: uuid CategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). format: uuid CreatedUtc: minLength: 1 type: string description: Creation date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time additionalProperties: false x-schema-id: ResourceCategoryAssignment CompanyOptions: title: Company Options type: object properties: Invoiceable: type: boolean description: Whether the company is invoiceable or not. AddFeesToInvoices: type: boolean description: Whether the company has an additional fee applied for invoicing or not. AddTaxDeductedPaymentToInvoices: type: boolean description: Whether tax-deducted payments should be automatically added to invoices. additionalProperties: false description: Options of the company. x-schema-id: CompanyOptions ReservationCancellationParameters: title: ReservationCancellationParameters required: - AccessToken - Client - ClientToken - ReservationIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the reservation to cancel. ReservationId: type: string format: uuid deprecated: true PostCancellationFee: type: boolean description: Whether the cancellation fees should be charged according to rate conditions. The default is `false`. nullable: true SendEmail: type: boolean description: Whether the cancellation email should be sent. The default is `true`. nullable: true Notes: type: string description: Additional notes describing the reason for the cancellation. additionalProperties: false x-schema-id: ReservationCancellationParameters ProductPostingEnum: title: Product posting enum: - Once - Daily type: string description: ' Once Daily' x-enumNames: - Once - Daily x-enumDescriptions: - '' - '' ExtendedAmount: title: Extended amount required: - Breakdown - Currency - GrossValue - NetValue - TaxValues type: object properties: Currency: minLength: 1 type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). format: currency NetValue: type: number description: Net value without taxes. format: double GrossValue: type: number description: Gross value including all taxes. format: double TaxValues: type: array items: $ref: '#/components/schemas/TaxValue' description: The tax values applied. Breakdown: title: Tax breakdown allOf: - $ref: '#/components/schemas/TaxBreakdown' description: Information about individual tax amounts. Value: type: number format: double nullable: true Net: type: number format: double nullable: true Tax: type: number format: double nullable: true TaxRate: type: number format: double nullable: true additionalProperties: false description: '' x-schema-id: ExtendedAmount SexEnum: title: Sex enum: - Male - Female type: string description: ' Male Female' x-enumNames: - Male - Female x-enumDescriptions: - '' - '' MultipleReservationUpdateParameters: title: Reservation updates required: - AccessToken - Client - ClientToken - ReservationId - ReservationUpdates type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationId: type: string description: Unique identifier of the reservation. format: uuid ChannelNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: 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 `null` if the channel number should not be updated). nullable: true StartUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reservation start in UTC timezone in ISO 8601 format. (or `null` if the start time should not be updated). nullable: true EndUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reservation end in UTC timezone in ISO 8601 format. (or `null` if the end time should not be updated). nullable: true ReleasedUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Date when the optional reservation is released in UTC timezone in ISO 8601 format. (or `null` if the release time should not be updated). nullable: true PersonCounts: title: Person counts update value allOf: - $ref: '#/components/schemas/ReservationUpdatePersonCountParameters' description: Number of people per age category the reservation is for. If supplied, the person counts will be replaced. (or `null` if the person counts should not be updated). nullable: true AssignedResourceId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the assigned `Resource`. If the assigned resource is locked, see `AssignedResourceLocked` for updating the assigned resource. (`null` if the assigned resource should not be updated) nullable: true RequestedCategoryId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Identifier of the requested `ResourceCategory` (or `null` if resource category should not be updated). nullable: true TravelAgencyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Company` that mediated the reservation (or `null` if travel agency should not be updated). nullable: true CompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Company` on behalf of which the reservation was made (or `null` if company should not be updated). nullable: true BusinessSegmentId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the reservation `BusinessSegment` (or `null` if the business segment should not be updated). nullable: true Purpose: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: '`Purpose` of the reservation (or `null` if the purpose should not be updated).' nullable: true RateId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Identifier of the reservation `Rate` (or `null` if the rate should not be updated). nullable: true CreditCardId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of `CreditCard` belonging to `Customer` who owns the reservation. (or `null` if the credit card should not be updated). nullable: true TimeUnitPrices: title: Time unit amount update value allOf: - $ref: '#/components/schemas/ReservationUpdatePerUnitPriceParameters' description: Prices for time units of the reservation. E.g. prices for the first or second night. (or `null` if the unit amounts should not be updated). nullable: true BookerId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Customer` on whose behalf the reservation was made. (or `null` if the booker should not be updated). nullable: true AssignedResourceLocked: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether the reservation should be locked to the assigned `Resource`. To reassign the reservation to a new `Resource`, first set `AssignedResourceLocked` to `false` to unlock the resource. Then, assign the reservation to a new `Resource` by setting `AssignedResourceId` to the new resource ID. (`null` if the lock should not be updated) nullable: true AvailabilityBlockId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the `AvailabilityBlock` the reservation is assigned to. nullable: true Options: title: Reservations options parameters update values allOf: - $ref: '#/components/schemas/ReservationUpdateOptionsParameters' description: Options of the reservations. nullable: true ReservationUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ReservationUpdateParameters' description: Array of properties to be updated in each reservation specified. Reprice: type: boolean description: 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. nullable: true ApplyCancellationFee: type: boolean description: Whether the cancellation fees should be applied according to rate cancellation policies. If not specified, the cancellation fees are applied. nullable: true Reason: type: string description: Reason for updating the reservation. Required when updating the price of the reservation. nullable: true additionalProperties: false x-schema-id: MultipleReservationUpdateParameters RelativeProductPrice: title: Relative product price type: object properties: Multiplier: type: number format: double deprecated: true Target: type: string nullable: true deprecated: true TaxRateCodes: type: array items: type: string nullable: true deprecated: true ProductIds: type: array items: type: string format: uuid nullable: true deprecated: true additionalProperties: false description: '' x-schema-id: RelativeProductPrice OrderNoteTypeEnum: title: Service order note type enum: - General - ChannelManager - SpecialRequest type: string description: ' General ChannelManager SpecialRequest' x-enumNames: - General - ChannelManager - SpecialRequest x-enumDescriptions: - '' - '' - '' ReservationsChannelManagerDetailsFilterParameters: title: Reservation channel manager details filter parameters required: - AccessToken - Client - ClientToken - ReservationIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. ReservationIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Reservations`. additionalProperties: false x-schema-id: ReservationsChannelManagerDetailsFilterParameters ServiceDataDiscriminator: title: Service data discriminator enum: - Bookable - Additional type: string IdentityDocument: title: Identity document type: object properties: Id: type: string description: Unique identifier of the document. format: uuid CustomerId: type: string description: Identifier of the `Customer`. format: uuid Type: title: Document type allOf: - $ref: '#/components/schemas/IdentityDocumentTypeEnum' description: 'Type of the document. IdentityCard Passport Visa DriversLicense' x-enumNames: - IdentityCard - Passport - Visa - DriversLicense x-enumDescriptions: - '' - '' - '' - '' Number: type: string description: Number of the document (e.g. passport number). nullable: true Expiration: type: string description: Expiration date in ISO 8601 format. format: date nullable: true Issuance: type: string description: Date of issuance in ISO 8601 format. format: date nullable: true IssuingCountryCode: type: string description: ISO 3166-1 code of the `Country`. nullable: true IssuingCountrySubdivisionCode: type: string description: Identifier of the country subdivision where the document was issued (province, state or region). nullable: true IssuingCity: type: string description: City where the document was issued. nullable: true IdentityDocumentSupportNumber: type: string description: Identity document support number. Only required for Spanish identity cards in Spanish hotels. nullable: true additionalProperties: false x-schema-id: IdentityDocument ProductOptions: title: Product options required: - BillAsPackage type: object properties: BillAsPackage: type: boolean description: Product should be displayed as part of a package. additionalProperties: false description: '' x-schema-id: ProductOptions ServiceOrderStateEnum: title: Service order state enum: - Inquired - Confirmed - Started - Processed - Canceled - Optional - Requested type: string description: ' Inquired (Confirmed neither by the customer nor enterprise.) Confirmed (Confirmed by both parties, before check-in.) Started (Checked in.) Processed (Checked out.) Canceled (Canceled.) Optional (Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest).) Requested (Confirmed by the customer but not by the enterprise (waitlist).)' x-enumNames: - Inquired - Confirmed - Started - Processed - Canceled - Optional - Requested x-enumDescriptions: - Confirmed neither by the customer nor enterprise. - Confirmed by both parties, before check-in. - Checked in. - Checked out. - Canceled. - Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest). - Confirmed by the customer but not by the enterprise (waitlist). ReservationProcessingParameters: title: ReservationProcessingParameters required: - AccessToken - Client - ClientToken - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationId: type: string description: Unique identifier of the reservation to process. format: uuid CloseBills: type: boolean description: Whether closable bills of the reservation members should be automatically closed. nullable: true AllowOpenBalance: type: boolean description: Whether non-zero consumed balance of all reservation members is allowed. nullable: true Notes: type: string description: Required if AllowOpenBalance set to true. Used to provide reason for closing with unbalanced bill. nullable: true additionalProperties: false x-schema-id: ReservationProcessingParameters GuidNullableUpdateValue: title: Guid update value type: object properties: Value: type: string description: Value which is to be updated. format: uuid nullable: true additionalProperties: false x-schema-id: GuidNullableUpdateValue ReservationUpdatePerUnitPriceParameters: title: Time unit amount update value type: object properties: Value: type: array items: $ref: '#/components/schemas/PerUnitPriceParameters' nullable: true additionalProperties: false x-schema-id: ReservationUpdatePerUnitPriceParameters ServiceOrderOriginEnum: title: Service order origin enum: - Distributor - ChannelManager - Commander - Import - Connector - Navigator type: string description: ' Distributor (From the Mews Booking Engine or Booking Engine API.) ChannelManager (From a channel manager.) Commander (From Mews Operations.) Import (From an import process.) Connector (From the Mews Connector API.) Navigator (From Mews Guest Services.)' x-enumNames: - Distributor - ChannelManager - Commander - Import - Connector - Navigator x-enumDescriptions: - From the Mews Booking Engine or Booking Engine API. - From a channel manager. - From Mews Operations. - From an import process. - From the Mews Connector API. - From Mews Guest Services. ReservationItems: title: Reservation items required: - Items - OrderItems type: object properties: ReservationId: type: string description: Unique identifier of the reservation. format: uuid Items: type: array items: $ref: '#/components/schemas/AccountingItem' description: Accounting items associated with the reservation. OrderItems: type: array items: $ref: '#/components/schemas/OrderItemOld' description: Order items associated with the reservation. additionalProperties: false x-schema-id: ReservationItems PerUnitPriceParameters: title: Time unit amount parameters type: object properties: Index: type: integer description: Index of the unit. Indexing starts with `0`. E.g. the first night of the reservation has index `0`. format: int32 Amount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Amount of the unit. nullable: true additionalProperties: false x-schema-id: PerUnitPriceParameters ReservationUpdateOptionsParameters: title: Reservations options parameters update values type: object properties: OwnerCheckedIn: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: True if the owner of the reservation is checked in. (or `null` if the value should not be updated). nullable: true additionalProperties: false x-schema-id: ReservationUpdateOptionsParameters ReservationUpdatePersonCountParameters: title: Person counts update value type: object properties: Value: type: array items: $ref: '#/components/schemas/ReservationPersonCount' nullable: true additionalProperties: false x-schema-id: ReservationUpdatePersonCountParameters AmountParameters: title: Amount parameters required: - Currency - TaxCodes type: object properties: Currency: minLength: 1 type: string format: currency TaxCodes: type: array items: type: string NetValue: type: number format: double nullable: true GrossValue: type: number format: double nullable: true additionalProperties: false description: Price of the product that overrides the price defined in Mews. x-schema-id: AmountParameters ResourceClassification: title: Resource classification enum: - StandardSingle - StandardDouble - SuperiorTwin - SuperiorDouble - JuniorSuite - SharedOrDorm - Other - SuperiorSingle - Triple - Family - StandardTwin - Studio - SuperiorTripleRoom - OneBedroomApartment - ThreeBedroomsApartment - TwoBedroomsApartment type: string description: Classification of the resource category. CompanionshipAddResult: title: CompanionshipAddResult required: - CompanionshipId type: object properties: CompanionshipId: type: string description: Identifier of the created `Companionship` entity. format: uuid additionalProperties: false x-schema-id: CompanionshipAddResult ReservationUpdateIntervalParameters: title: ReservationUpdateIntervalParameters required: - AccessToken - ChargeCancellationFee - Client - ClientToken - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationId: type: string description: Unique identifier of the reservation to be updated. format: uuid StartUtc: type: string description: New reservation start in UTC timezone in ISO 8601 format. format: date-time nullable: true EndUtc: type: string description: New reservation end in UTC timezone in ISO 8601 format. format: date-time nullable: true ChargeCancellationFee: type: boolean description: Whether cancellation fee should be charged for potentially canceled nights. additionalProperties: false x-schema-id: ReservationUpdateIntervalParameters ProductOrderAdditionData: title: Product order parameters required: - ProductId type: object properties: ProductId: type: string description: Unique identifier of the `Product` to be ordered. format: uuid Count: type: integer description: Count of products to be ordered, e.g. 10 in case of 10 beers. format: int32 nullable: true UnitAmount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Unit amount of the product that overrides the amount defined in Mews. nullable: true StartUtc: type: string description: Product start in UTC timezone in ISO 8601 format. For products with charging `Once` and `PerPerson` must be set to same value as `EndUtc`. Use only with operation [Add reservations](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservations) or [Add reservation product](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservation-product), can be omitted for [Add order](https://mews-systems.gitbook.io/connector-api/operations/orders#add-order) operation. format: date-time nullable: true EndUtc: type: string description: Product end in UTC timezone in ISO 8601 format. For products with charging `Once` and `PerPerson` must be set to same value as `StartUtc`. Use only with operation [Add reservations](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservations) or [Add reservation product](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservation-product), can be omitted for [Add order](https://mews-systems.gitbook.io/connector-api/operations/orders#add-order) operation. format: date-time nullable: true ExternalIdentifier: type: string description: External identifier of the product order. nullable: true additionalProperties: false x-schema-id: ProductOrderAdditionData BusinessSegment: title: Business segment required: - CreatedUtc - Id - IsActive - Name - ServiceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the business segment. format: uuid ServiceId: type: string description: Unique identifier of the `Service`. format: uuid IsActive: type: boolean description: Whether the business segment is still active. Name: minLength: 1 type: string description: Name of the business segment. CreatedUtc: minLength: 1 type: string description: Creation date and time of the business segment in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the business segment in UTC timezone in ISO 8601 format. format: date-time additionalProperties: false x-schema-id: BusinessSegment AccountingItem: title: Accounting item type: object properties: Id: type: string format: uuid AccountId: type: string format: uuid CustomerId: type: string format: uuid nullable: true deprecated: true x-deprecatedMessage: Use `AccountId` instead. OrderId: type: string format: uuid nullable: true ServiceId: type: string format: uuid nullable: true ProductId: type: string format: uuid nullable: true BillId: type: string format: uuid nullable: true InvoiceId: type: string format: uuid nullable: true AccountingCategoryId: type: string format: uuid nullable: true CreditCardId: type: string format: uuid nullable: true Type: type: string nullable: true SubType: type: string nullable: true Name: type: string nullable: true Notes: type: string nullable: true ConsumptionUtc: type: string nullable: true ClosedUtc: type: string nullable: true State: type: string nullable: true SubState: type: string nullable: true Amount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: '' nullable: true TaxExemptionReasonCode: type: string description: Code of tax exemption reason. **Restricted!** This property is currently intended for Mews' internal usage and may be subject to change. nullable: true additionalProperties: false x-schema-id: AccountingItem OldAddress: title: Address type: object properties: Id: type: string description: Unique identifier of the address. format: uuid Line1: type: string description: First line of the address. nullable: true Line2: type: string description: Second line of the address. nullable: true City: type: string description: The city. nullable: true PostalCode: type: string description: Postal code. nullable: true CountryCode: type: string description: ISO 3166-1 code of the `Country`. nullable: true CountrySubdivisionCode: type: string description: ISO 3166-2 code of the administrative division, e.g. `DE-BW`. nullable: true Latitude: type: number description: The latitude. format: double nullable: true Longitude: type: number description: The longitude. format: double nullable: true additionalProperties: false description: '' x-schema-id: OldAddress Unit: type: object additionalProperties: false ProductConsumptionMomentEnum: title: Product consumption moment enum: - ServiceOrderEnd - ServiceOrderStart - PostingTimeUnit - NextTimeUnit type: string description: ' ServiceOrderEnd ServiceOrderStart PostingTimeUnit NextTimeUnit' x-enumNames: - ServiceOrderEnd - ServiceOrderStart - PostingTimeUnit - NextTimeUnit x-enumDescriptions: - '' - '' - '' - '' ReservationPricingResult: title: ReservationPricingResult required: - ReservationPrices type: object properties: ReservationPrices: type: array items: $ref: '#/components/schemas/ReservationPrice' description: The reservation prices. additionalProperties: false x-schema-id: ReservationPricingResult ReservationUpdateParameters: title: Reservation updates required: - AccessToken - Client - ClientToken - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationId: type: string description: Unique identifier of the reservation. format: uuid ChannelNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: 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 `null` if the channel number should not be updated). nullable: true StartUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reservation start in UTC timezone in ISO 8601 format. (or `null` if the start time should not be updated). nullable: true EndUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reservation end in UTC timezone in ISO 8601 format. (or `null` if the end time should not be updated). nullable: true ReleasedUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Date when the optional reservation is released in UTC timezone in ISO 8601 format. (or `null` if the release time should not be updated). nullable: true PersonCounts: title: Person counts update value allOf: - $ref: '#/components/schemas/ReservationUpdatePersonCountParameters' description: Number of people per age category the reservation is for. If supplied, the person counts will be replaced. (or `null` if the person counts should not be updated). nullable: true AssignedResourceId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the assigned `Resource`. If the assigned resource is locked, see `AssignedResourceLocked` for updating the assigned resource. (`null` if the assigned resource should not be updated) nullable: true RequestedCategoryId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Identifier of the requested `ResourceCategory` (or `null` if resource category should not be updated). nullable: true TravelAgencyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Company` that mediated the reservation (or `null` if travel agency should not be updated). nullable: true CompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Company` on behalf of which the reservation was made (or `null` if company should not be updated). nullable: true BusinessSegmentId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the reservation `BusinessSegment` (or `null` if the business segment should not be updated). nullable: true Purpose: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: '`Purpose` of the reservation (or `null` if the purpose should not be updated).' nullable: true RateId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Identifier of the reservation `Rate` (or `null` if the rate should not be updated). nullable: true CreditCardId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of `CreditCard` belonging to `Customer` who owns the reservation. (or `null` if the credit card should not be updated). nullable: true TimeUnitPrices: title: Time unit amount update value allOf: - $ref: '#/components/schemas/ReservationUpdatePerUnitPriceParameters' description: Prices for time units of the reservation. E.g. prices for the first or second night. (or `null` if the unit amounts should not be updated). nullable: true BookerId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Customer` on whose behalf the reservation was made. (or `null` if the booker should not be updated). nullable: true AssignedResourceLocked: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether the reservation should be locked to the assigned `Resource`. To reassign the reservation to a new `Resource`, first set `AssignedResourceLocked` to `false` to unlock the resource. Then, assign the reservation to a new `Resource` by setting `AssignedResourceId` to the new resource ID. (`null` if the lock should not be updated) nullable: true AvailabilityBlockId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the `AvailabilityBlock` the reservation is assigned to. nullable: true Options: title: Reservations options parameters update values allOf: - $ref: '#/components/schemas/ReservationUpdateOptionsParameters' description: Options of the reservations. nullable: true additionalProperties: false x-schema-id: ReservationUpdateParameters ServiceOrderCancellationReasonEnum: title: Reservation cancellation reason enum: - Other - ConfirmationMissed - BookedElsewhere - ForceMajeure - GuestComplaint - NoShow - PriceTooHigh - ServiceNotAvailable - InputError - InvalidPayment - TravelAgency - RequestedByGuest - Update - BookingAbandoned - RequestedByBooker type: string description: ' Other ConfirmationMissed BookedElsewhere ForceMajeure GuestComplaint NoShow PriceTooHigh ServiceNotAvailable InputError InvalidPayment TravelAgency RequestedByGuest Update BookingAbandoned RequestedByBooker' x-enumNames: - Other - ConfirmationMissed - BookedElsewhere - ForceMajeure - GuestComplaint - NoShow - PriceTooHigh - ServiceNotAvailable - InputError - InvalidPayment - TravelAgency - RequestedByGuest - Update - BookingAbandoned - RequestedByBooker x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' TaxExemptionReasonTypeEnum: title: Tax exemption reason type enum: - Unknown - IT_N1 - IT_N2_2 - IT_N3_5 - IT_N4 - IT_N5 - PL_ZW - PL_NP - DE_NATO type: string description: ' Unknown (Unknown tax exemption reason) IT_N1 (N1 - Escluse ex art.15) IT_N2_2 (N2.2 - Non soggette – altri casi) IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento) IT_N4 (N4 - Esenti) IT_N5 (N5 - Regime del margine / IVA non esposta in fattura) PL_ZW (ZW - Zwolniony) PL_NP (NP - Nie podlega) DE_NATO (NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen)' x-enumNames: - Unknown - IT_N1 - IT_N2_2 - IT_N3_5 - IT_N4 - IT_N5 - PL_ZW - PL_NP - DE_NATO x-enumDescriptions: - Unknown tax exemption reason - N1 - Escluse ex art.15 - N2.2 - Non soggette – altri casi - N3.5 - Non imponibili – a seguito di dichiarazioni d’intento - N4 - Esenti - N5 - Regime del margine / IVA non esposta in fattura - ZW - Zwolniony - NP - Nie podlega - NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen ReservationOldOrigin: title: Reservation origin (ver 2017-04-12) enum: - Distributor - ChannelManager - Import - Connector - Navigator - CommanderInPerson - CommanderChannel - CommanderPhone - CommanderEmail - CommanderWebsite - CommanderMessage - CommanderCallCenter - CommanderRoomingList type: string x-enumDescriptions: - From the Mews Booking Engine or Booking Engine API. - From a channel manager. - From an import process. - From the Mews Connector API. - From Mews Guest Services. - From Mews Operations, in person. - From Mews Operations, via channel. - From Mews Operations, via telephone. - From Mews Operations, via email. - From Mews Operations, via website. - From Mews Operations, via message person. - From Mews Operations, via call center. - From Mews Operations, via rooming list. ResourceCategory: title: Resource category required: - Capacity - Classification - Descriptions - EnterpriseId - ExtraCapacity - Id - IsActive - Names - Ordering - ServiceId - ShortNames - Type type: object properties: Id: type: string description: Unique identifier of the category. format: uuid EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid ServiceId: type: string description: Unique identifier of the `Service` of the resource category. format: uuid IsActive: type: boolean description: Whether the category is still active. Type: $ref: '#/components/schemas/ResourceCategoryType' Classification: $ref: '#/components/schemas/ResourceClassification' Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings ShortNames: title: Localized text type: object additionalProperties: type: string description: All translations of the short name. x-schema-id: LocalizedStrings Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. x-schema-id: LocalizedStrings Ordering: type: integer description: Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed). format: int32 Capacity: type: integer description: Capacity that can be served (e.g. bed count). format: int32 ExtraCapacity: type: integer description: Extra capacity that can be served (e.g. extra bed count). format: int32 ExternalIdentifier: maxLength: 255 type: string description: Identifier of the resource category from external system. nullable: true AccountingCategoryId: type: string description: Unique identifier of the accounting category. format: uuid nullable: true additionalProperties: false x-schema-id: ResourceCategory CustomerClassificationEnum: title: Customer classification enum: - PaymasterAccount - Blacklist - Media - LoyaltyProgram - PreviousComplaint - Returning - Staff - FriendOrFamily - TopManagement - Important - VeryImportant - Problematic - Cashlist - DisabledPerson - Military - Airline - HealthCompliant - InRoom - WaitingForRoom - Student - Blocklist type: string description: ' PaymasterAccount Blacklist (Deprecated, use Blocklist instead.) Media LoyaltyProgram PreviousComplaint Returning Staff FriendOrFamily TopManagement Important VeryImportant Problematic Cashlist DisabledPerson Military Airline HealthCompliant InRoom WaitingForRoom Student Blocklist' x-enumNames: - PaymasterAccount - Blacklist - Media - LoyaltyProgram - PreviousComplaint - Returning - Staff - FriendOrFamily - TopManagement - Important - VeryImportant - Problematic - Cashlist - DisabledPerson - Military - Airline - HealthCompliant - InRoom - WaitingForRoom - Student - Blocklist x-enumDescriptions: - '' - Deprecated, use Blocklist instead. - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' ReservationExtent: title: Reservation extent type: object properties: Reservations: type: boolean description: Whether the response should contain reservations. nullable: true ReservationGroups: type: boolean description: Whether the response should contain groups of the reservations. nullable: true Customers: type: boolean description: Whether the response should contain customers of the reservations. nullable: true CustomerAdresses: type: boolean description: Whether the response should contain addresses of the customers. nullable: true CustomerIdentityDocuments: type: boolean description: Whether the response should contain identity documents of the customers. nullable: true Services: type: boolean description: Whether the response should contain services reserved by the reservations. nullable: true Products: type: boolean description: Whether the response should contain products orderable with the reservations. nullable: true BusinessSegments: type: boolean description: Whether the response should contain business segmentation. nullable: true Resources: type: boolean description: Whether the response should contain resources. nullable: true ResourceCategories: type: boolean description: Whether the response should contain resource categories. nullable: true ResourceCategoryAssignments: type: boolean description: Whether the response should contain assignments of the resources to categories. nullable: true Rates: type: boolean description: Whether the response should contain rates and rate groups. nullable: true Items: type: boolean description: Whether the response should contain accounting items. nullable: true OrderItems: type: boolean description: Whether the response should contain reservation items. nullable: true Notes: type: boolean description: Whether the response should contain notes. nullable: true QrCodeData: type: boolean description: Whether the response should contain QR code data. nullable: true Companies: type: boolean description: Whether the response should contain companies. nullable: true AccountingStates: type: array items: $ref: '#/components/schemas/AccountingState' description: States the items should be in. If not specified, items in `Open` or `Closed` states are returned. nullable: true additionalProperties: false description: 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. x-schema-id: ReservationExtent ProductPostingModeEnum: title: Product posting mode enum: - Once - PerTimeUnit type: string description: ' Once PerTimeUnit' x-enumNames: - Once - PerTimeUnit x-enumDescriptions: - '' - '' RateGroupOld: title: Rate group (ver 2017-04-12) type: object properties: Id: type: string description: Unique identifier of the rate group. format: uuid ServiceId: type: string description: Unique identifier of the Service that the rate group belongs to. format: uuid IsActive: type: boolean description: Whether the rate group is still active. Name: type: string description: Name of the rate group. nullable: true ExternalIdentifier: maxLength: 255 type: string description: External identifier of the rate group. nullable: true additionalProperties: false x-schema-id: RateGroupOld ResourceAccessToken: title: Resource access token required: - CreatedUtc - EnterpriseId - Id - IsActive - Permissions - ServiceOrderId - Type - UpdatedUtc - ValidityEndUtc - ValidityStartUtc - Value type: object properties: Id: type: string description: Unique identifier of the resource access token. format: uuid EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid ServiceOrderId: type: string description: Unique identifier of `Reservation`. format: uuid CompanionshipId: type: string description: Unique identifier of `Companionship`. format: uuid nullable: true ResourceId: type: string description: Unique identifier of `Resource`. format: uuid nullable: true Type: $ref: '#/components/schemas/ResourceAccessTokenType' Value: minLength: 1 type: string description: Value of the resource access token. SerialNumber: type: string description: Serial number of the resource access token. nullable: true ValidityStartUtc: minLength: 1 type: string description: Marks the start of interval in which the resource access token can be used. format: date-time ValidityEndUtc: minLength: 1 type: string description: Marks the end of interval in which the resource access token can be used. format: date-time Permissions: title: Resource access token permissions allOf: - $ref: '#/components/schemas/ResourceAccessTokenPermissions' description: Permissions of the resource access token. CreatedUtc: minLength: 1 type: string description: Creation date and time of the resource access token in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource access token in UTC timezone in ISO 8601 format. format: date-time IsActive: type: boolean description: Whether the resource access token is still active. additionalProperties: false x-schema-id: ResourceAccessToken Promotions: title: Promotions required: - AfterCheckIn - AfterCheckOut - BeforeCheckIn - BeforeCheckOut - DuringCheckOut - DuringStay type: object properties: BeforeCheckIn: type: boolean description: Whether it can be promoted before check-in. AfterCheckIn: type: boolean description: Whether it can be promoted after check-in. DuringStay: type: boolean description: Whether it can be promoted during stay. BeforeCheckOut: type: boolean description: Whether it can be promoted before check-out. AfterCheckOut: type: boolean description: Whether it can be promoted after check-out. DuringCheckOut: type: boolean description: Whether it can be promoted during check-out. additionalProperties: false description: '' x-schema-id: Promotions TaxBreakdownItem: title: Tax breakdown item required: - NetValue - TaxValue type: object properties: TaxRateCode: type: string description: Tax rate code for the item. `null` for untaxed amounts. nullable: true NetValue: type: number description: The net value that the tax is calculated from. format: double TaxValue: type: number description: The value of the tax. format: double additionalProperties: false x-schema-id: TaxBreakdownItem ServiceOptions: title: Service options required: - BillAsPackage type: object properties: BillAsPackage: type: boolean description: Products should be displayed as a single package instead of individual items. additionalProperties: false description: Options of the service. x-schema-id: ServiceOptions BookableServiceData: title: Bookable service data required: - EndOffset - OccupancyEndOffset - OccupancyStartOffset - StartOffset - TimeUnit - TimeUnitPeriod type: object properties: StartOffset: minLength: 1 type: string description: Offset from the start of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the default start of the service; expressed in ISO 8601 duration format. EndOffset: minLength: 1 type: string description: Offset from the end of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the default end of the service; expressed in ISO 8601 duration format. OccupancyStartOffset: minLength: 1 type: string description: Offset from the start of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the occupancy start of the service; expressed in ISO 8601 duration format. 'Occupancy start' is used for availability and reporting purposes, it implies the time at which the booked resource is considered occupied. OccupancyEndOffset: minLength: 1 type: string description: Offset from the end of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the occupancy end of the service; expressed in ISO 8601 duration format. 'Occupancy end' is used for availability and reporting purposes, it implies the time at which the booked resource is no longer considered occupied. TimeUnit: title: Time unit period allOf: - $ref: '#/components/schemas/TimeUnitPeriodEnum' description: ' Day Month Hour' deprecated: true x-enumNames: - Day - Month - Hour x-enumDescriptions: - '' - '' - '' x-deprecatedMessage: Use `TimeUnitPeriod` instead. TimeUnitPeriod: title: Time unit period allOf: - $ref: '#/components/schemas/TimeUnitPeriodEnum' description: 'The length of time or period represented by a [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), for which the service can be booked. Day Month Hour' x-enumNames: - Day - Month - Hour x-enumDescriptions: - '' - '' - '' additionalProperties: false x-schema-id: BookableServiceData ReservationProductParameters: title: ReservationProductParameters required: - AccessToken - Client - ClientToken - Count - ProductId - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. ReservationId: type: string description: Unique identifier of the reservation. format: uuid ProductId: type: string description: Unique identifier of the [Product](https://mews-systems.gitbook.io/connector-api/operations/products/#product). format: uuid Count: type: integer description: 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. format: int32 UnitAmount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Price of the product that overrides the price defined in Mews. nullable: true StartUtc: type: string description: Product start in UTC timezone in ISO 8601 format. For products with charging Once and PerPerson must be set to same value as EndUtc. format: date-time nullable: true EndUtc: type: string description: Product end in UTC timezone in ISO 8601 format. For products with charging Once and PerPerson must be set to same value as StartUtc. format: date-time nullable: true additionalProperties: false x-schema-id: ReservationProductParameters ReservationData: title: Reservation parameters required: - CustomerId - EndUtc - PersonCounts - RateId - RequestedCategoryId - StartUtc type: object properties: Identifier: type: string description: Identifier of the reservation within the transaction. nullable: true ChannelNumber: type: string nullable: true State: anyOf: - $ref: '#/components/schemas/ServiceOrderStateOld' description: State of the newly created reservation (either `Optional`, `Enquired` or `Confirmed`). If not specified, `Confirmed` is used. nullable: true StartUtc: minLength: 1 type: string description: Reservation start in UTC timezone in ISO 8601 format. format: date-time EndUtc: minLength: 1 type: string description: Reservation end in UTC timezone in ISO 8601 format. format: date-time ReleasedUtc: type: string description: Release date and time of an unconfirmed reservation in UTC timezone in ISO 8601 format. format: date-time nullable: true AdultCount: type: integer format: int32 deprecated: true x-deprecatedMessage: Use `PersonCounts` instead. ChildCount: type: integer format: int32 deprecated: true x-deprecatedMessage: Use `PersonCounts` instead. PersonCounts: minItems: 1 type: array items: $ref: '#/components/schemas/ReservationPersonCount' description: Number of people per age category the reservation was booked for. At least one category with valid count must be provided. CustomerId: type: string description: Unique identifier of the `Customer` who owns the reservation. format: uuid BookerId: type: string description: Unique identifier of the `Customer` on whose behalf the reservation was made. format: uuid nullable: true RequestedCategoryId: type: string description: Identifier of the requested `ResourceCategory`. format: uuid AssignedResourceId: type: string description: Identifier of the assigned `Resource`. format: uuid nullable: true AssignedResourceLocked: type: boolean description: Whether the reservation should be locked to the assigned `Resource`. (`null` or `false` if the reservation should not be locked) nullable: true RateId: type: string description: Identifier of the reservation `Rate`. format: uuid VoucherCode: type: string description: Voucher code value providing access to specified private `Rate` applied to this reservation. nullable: true CreditCardId: type: string description: Identifier of `CreditCard` belonging either to the `Customer` who owns the reservation or to the `Booker`. format: uuid nullable: true TravelAgencyId: type: string description: Identifier of the `Company` that mediated the reservation. format: uuid nullable: true CompanyId: type: string description: Identifier of the `Company` on behalf of which the reservation was made. format: uuid nullable: true BusinessSegmentId: type: string description: Identifier of the reservation `BusinessSegment`. format: uuid nullable: true Notes: type: string description: Additional notes. nullable: true TimeUnitAmount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Amount of each night of the reservation. nullable: true TimeUnitPrices: type: array items: $ref: '#/components/schemas/PerUnitPriceParameters' description: Prices for time units of the reservation. E.g. prices for the first or second night. nullable: true ProductOrders: type: array items: $ref: '#/components/schemas/ProductOrderAdditionData' description: Parameters of the products ordered together with the reservation. nullable: true AvailabilityBlockId: type: string description: Unique identifier of the `AvailabilityBlock` the reservation is assigned to. format: uuid nullable: true additionalProperties: false x-schema-id: ReservationData ReservationOptions: title: Reservation options required: - AllCompanionsCheckedIn - AnyCompanionCheckedIn - OwnerCheckedIn type: object properties: OwnerCheckedIn: type: boolean description: Owner of the reservation checked in. AllCompanionsCheckedIn: type: boolean description: All companions of the reservation checked in. AnyCompanionCheckedIn: type: boolean description: Any companion of the reservation checked in. additionalProperties: false x-schema-id: ReservationOptions Resource: title: Resource required: - CreatedUtc - Data - Descriptions - Directions - EnterpriseId - ExternalNames - Id - IsActive - Name - State - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the resource. format: uuid EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid IsActive: type: boolean description: Whether the resource is still active. ParentResourceId: type: string description: Identifier of the parent `Resource` (e.g. room of a bed). format: uuid nullable: true Name: minLength: 1 type: string description: Name of the resource (e.g. room number). State: $ref: '#/components/schemas/ResourceState' Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. x-schema-id: LocalizedStrings CreatedUtc: minLength: 1 type: string description: Creation date and time of the resource in UTC timezone in ISO 8601 format. UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource in UTC timezone in ISO 8601 format. Data: title: Resource data type: object properties: Discriminator: $ref: '#/components/schemas/ResourceDataDiscriminator' Value: oneOf: - $ref: '#/components/schemas/SpaceData' - title: Object resource data type: object additionalProperties: false - title: Person resource data type: object additionalProperties: false description: Based on `Discriminator`. Currently present only for `Space` resources with [Space resource data](https://mews-systems.gitbook.io/connector-api/operations/resources#space-resource-data). description: Additional data of the resource. x-coproduct: true x-schema-id: ResourceDataCoproductOfResourceDataDiscriminator ExternalNames: title: Localized text type: object additionalProperties: type: string description: All translations of external name. x-schema-id: LocalizedStrings Directions: title: Localized text type: object additionalProperties: type: string description: All translations of direction. x-schema-id: LocalizedStrings additionalProperties: false x-schema-id: Resource StringUpdateValue: title: String update value type: object properties: Value: type: string description: Value which is to be updated. nullable: true additionalProperties: false x-schema-id: StringUpdateValue AccountType: title: Account type enum: - Company - Customer type: string description: A discriminator specifying the account type, e.g. `Customer` or `Company` AccountingState: title: Order item accounting state enum: - Open - Closed - Inactive - Canceled type: string x-enumDescriptions: - Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice. - Order items which carry a non-zero value and have been closed on a bill or invoice. - Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive. - Order items which have been canceled, regardless of whether the item is of zero value. ProductChargingModeEnum: title: Product charging mode enum: - Once - PerTimeUnit - PerPersonPerTimeUnit - PerPerson type: string description: ' Once PerTimeUnit PerPersonPerTimeUnit PerPerson' x-enumNames: - Once - PerTimeUnit - PerPersonPerTimeUnit - PerPerson x-enumDescriptions: - '' - '' - '' - '' CurrencyValueOld: title: Currency value (ver 2018-06-07) required: - Currency type: object properties: Currency: minLength: 1 type: string format: currency Value: type: number format: double nullable: true Net: type: number format: double nullable: true deprecated: true Tax: type: number format: double nullable: true deprecated: true TaxRate: type: number format: double nullable: true deprecated: true additionalProperties: false description: Total price of the reservation. x-schema-id: CurrencyValueOld ReservationItemResult: title: ReservationItemResult required: - Reservations type: object properties: Reservations: type: array items: $ref: '#/components/schemas/ReservationItems' description: The reservations with their items. additionalProperties: false x-schema-id: ReservationItemResult ReservationsChannelManagerDetailsResult: title: Reservation channel manager details result required: - ChannelManagerDetails type: object properties: ChannelManagerDetails: type: array items: $ref: '#/components/schemas/ChannelManagerDetails' description: List of reservation channel manager details. additionalProperties: false x-schema-id: ReservationsChannelManagerDetailsResult BooleanUpdateValue: title: Boolean update value type: object properties: Value: type: boolean description: Value which is to be updated. additionalProperties: false x-schema-id: BooleanUpdateValue ServiceOrderOptions: title: Service Order Options required: - AllCompanionsCheckedIn - AnyCompanionCheckedIn - ConnectorCheckIn - OwnerCheckedIn type: object properties: OwnerCheckedIn: type: boolean description: Owner of the reservation checked in. AllCompanionsCheckedIn: type: boolean description: All companions of the reservation checked in. AnyCompanionCheckedIn: type: boolean description: Any of the companions of the reservation checked in. ConnectorCheckIn: type: boolean description: Check in was done via Connector API. additionalProperties: false x-schema-id: ServiceOrderOptions CreditRatingBasicEnum: title: Credit rating basic enum: - CreditOk - PaymentRequiredUpfront - LocalDecisionRequired type: string description: ' CreditOk (Company can book services.) PaymentRequiredUpfront (Company must pay upfront.) LocalDecisionRequired (Requires local approval.)' x-enumNames: - CreditOk - PaymentRequiredUpfront - LocalDecisionRequired x-enumDescriptions: - Company can book services. - Company must pay upfront. - Requires local approval. ReservationPrice: title: Reservation price required: - TotalAmount type: object properties: Identifier: type: string description: Identifier of the reservation within the transaction. nullable: true TotalAmount: title: Amount allOf: - $ref: '#/components/schemas/Amount' description: Total price of the reservation. Total: title: Currency value (ver 2018-06-07) allOf: - $ref: '#/components/schemas/CurrencyValueOld' description: Total price of the reservation. nullable: true deprecated: true x-deprecatedMessage: Use `TotalAmount` instead. additionalProperties: false x-schema-id: ReservationPrice Product: title: Product required: - ChargingMode - Classifications - ConsumptionMoment - CreatedUtc - ExternalNames - Id - IsActive - Names - Options - Ordering - PostingMode - Price - Pricing - Promotions - ServiceId - ShortNames - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the product. format: uuid ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service). format: uuid CategoryId: type: string description: Unique identifier of the Product category. format: uuid nullable: true AccountingCategoryId: type: string description: Unique identifier of [Accounting Category](https://mews-systems.gitbook.io/connector-api/operations/accountingcategories/#accounting-category). format: uuid nullable: true IsActive: type: boolean description: Whether the product is still active. IsDefault: type: boolean deprecated: true Name: type: string description: Name of the product. **Deprecated!** Please use Names nullable: true deprecated: true x-deprecatedMessage: Use `Names` instead. Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings ExternalName: type: string description: Name of the product meant to be displayed to customer. **Deprecated!** Please use ExternalNames nullable: true deprecated: true x-deprecatedMessage: Use `ExternalNames` instead. ExternalNames: title: Localized text type: object additionalProperties: type: string description: All translations of external name. x-schema-id: LocalizedStrings ShortName: type: string description: Short name of the product. **Deprecated!** Please use ShortNames nullable: true deprecated: true x-deprecatedMessage: Use `ShortNames` instead. ShortNames: title: Localized text type: object additionalProperties: type: string description: All translations of short name. x-schema-id: LocalizedStrings Description: type: string description: Description of the product. **Deprecated!** Please use Descriptions nullable: true deprecated: true x-deprecatedMessage: Use `Descriptions` instead. Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of descriptions. nullable: true x-schema-id: LocalizedStrings Charging: title: Product charging mode allOf: - $ref: '#/components/schemas/ProductChargingModeEnum' description: ' Once PerTimeUnit PerPersonPerTimeUnit PerPerson' deprecated: true x-enumNames: - Once - PerTimeUnit - PerPersonPerTimeUnit - PerPerson x-enumDescriptions: - '' - '' - '' - '' ChargingMode: title: Product charging mode allOf: - $ref: '#/components/schemas/ProductChargingModeEnum' description: 'Charging mode of the product. Once PerTimeUnit PerPersonPerTimeUnit PerPerson' x-enumNames: - Once - PerTimeUnit - PerPersonPerTimeUnit - PerPerson x-enumDescriptions: - '' - '' - '' - '' Posting: title: Product posting allOf: - $ref: '#/components/schemas/ProductPostingEnum' description: ' Once Daily' deprecated: true x-enumNames: - Once - Daily x-enumDescriptions: - '' - '' PostingMode: title: Product posting mode allOf: - $ref: '#/components/schemas/ProductPostingModeEnum' description: 'Charging mode of the product. Once PerTimeUnit' x-enumNames: - Once - PerTimeUnit x-enumDescriptions: - '' - '' Options: title: Product options allOf: - $ref: '#/components/schemas/ProductOptions' description: Options of the product. Promotions: allOf: - $ref: '#/components/schemas/Promotions' description: Promotions of the product. Classifications: title: Product classifications allOf: - $ref: '#/components/schemas/ProductClassifications' description: Classifications of the product. Price: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Price representing price of the product. Pricing: title: Product pricing type: object properties: Discriminator: $ref: '#/components/schemas/ProductPricing' Value: oneOf: - $ref: '#/components/schemas/ExtendedAmount' - $ref: '#/components/schemas/RelativeProductPrice' deprecated: true x-coproduct: true x-schema-id: ProductPricingCoproductOfProductPricing x-deprecatedMessage: Use `Price` instead. ImageIds: type: array items: type: string format: uuid description: Unique identifier of the product image. nullable: true Ordering: type: integer description: Order value for presentation purposes. format: int32 ExternalIdentifier: maxLength: 255 type: string description: Identifier of the product from external system. nullable: true TaxExemptionReason: allOf: - $ref: '#/components/schemas/TaxExemptionReasonTypeEnum' description: 'Specifies the reason a product is exempt from tax. Unknown (Unknown tax exemption reason) IT_N1 (N1 - Escluse ex art.15) IT_N2_2 (N2.2 - Non soggette – altri casi) IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento) IT_N4 (N4 - Esenti) IT_N5 (N5 - Regime del margine / IVA non esposta in fattura) PL_ZW (ZW - Zwolniony) PL_NP (NP - Nie podlega) DE_NATO (NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen)' nullable: true TaxExemptionLegalReference: type: string description: Legal reference that states why this product is exempt from tax. nullable: true CreatedUtc: minLength: 1 type: string description: Creation date and time of the product in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the product in UTC timezone in ISO 8601 format. format: date-time ConsumptionMoment: title: Product consumption moment allOf: - $ref: '#/components/schemas/ProductConsumptionMomentEnum' description: 'Consumption moment of the product. ServiceOrderEnd ServiceOrderStart PostingTimeUnit NextTimeUnit' x-enumNames: - ServiceOrderEnd - ServiceOrderStart - PostingTimeUnit - NextTimeUnit x-enumDescriptions: - '' - '' - '' - '' additionalProperties: false x-schema-id: Product ReservationOld: title: Reservation (ver 2017-04-12) required: - AssignedResourceLocked - CompanionIds - CreatedUtc - CustomerId - EndUtc - GroupId - Id - Number - Options - Origin - OwnerId - PersonCounts - RateId - RequestedCategoryId - ServiceId - StartUtc - State - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the reservation. format: uuid ServiceId: type: string description: Unique identifier of the Service that is reserved. format: uuid GroupId: type: string description: Unique identifier of the Reservation group. format: uuid Number: minLength: 1 type: string description: Confirmation number of the reservation in Mews. ChannelNumber: type: string description: 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). nullable: true ChannelManagerNumber: type: string description: Unique number of the reservation within the reservation group. nullable: true ChannelManagerGroupNumber: type: string description: Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews. nullable: true ChannelManager: type: string description: Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc). nullable: true State: $ref: '#/components/schemas/ServiceOrderStateOld' Origin: $ref: '#/components/schemas/ReservationOldOrigin' OriginDetails: type: string description: Details about the reservation origin. nullable: true Purpose: anyOf: - $ref: '#/components/schemas/ReservationPurpose' description: Purpose of the reservation. nullable: true CreatedUtc: minLength: 1 type: string description: Creation date and time of the reservation in UTC timezone in ISO 8601 format. UpdatedUtc: minLength: 1 type: string description: Last update date and time of the reservation in UTC timezone in ISO 8601 format. CancelledUtc: type: string description: Cancellation date and time in UTC timezone in ISO 8601 format. nullable: true StartUtc: minLength: 1 type: string description: 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. EndUtc: minLength: 1 type: string description: End of the reservation (departure) in UTC timezone in ISO 8601 format. ReleasedUtc: type: string description: Date when the optional reservation is released in UTC timezone in ISO 8601 format. nullable: true RequestedCategoryId: type: string description: Identifier of the requested Resource category. format: uuid AssignedSpaceId: type: string description: Identifier of the assigned Space. format: uuid nullable: true deprecated: true x-deprecatedMessage: Use `AssignedResourceId` instead. AssignedSpaceLocked: type: boolean description: Whether the reservation is locked to the assigned Space and cannot be moved. deprecated: true x-deprecatedMessage: Use `AssignedResourceLocked` instead. AssignedResourceId: type: string description: Identifier of the assigned Resource. format: uuid nullable: true AssignedResourceLocked: type: boolean description: Whether the reservation is locked to the assigned Resource and cannot be moved. BusinessSegmentId: type: string description: Identifier of the reservation Business segment. format: uuid nullable: true CompanyId: type: string description: Identifier of the Company on behalf of which the reservation was made. format: uuid nullable: true TravelAgencyId: type: string description: Identifier of the Company that mediated the reservation. format: uuid nullable: true AvailabilityBlockId: type: string description: Unique identifier of the Availability block the reservation is assigned to. format: uuid nullable: true RateId: type: string description: Identifier of the reservation Rate. format: uuid VoucherId: type: string description: Unique identifier of the Voucher that has been used to create reservation. format: uuid nullable: true CreditCardId: type: string description: Unique identifier of the Credit card. format: uuid nullable: true CancellationReason: anyOf: - $ref: '#/components/schemas/CancellationReason' description: Cancellation reason of the reservation. nullable: true AdultCount: type: integer description: Count of adults the reservation was booked for. format: int32 deprecated: true x-deprecatedMessage: Use `PersonCounts` instead. ChildCount: type: integer description: Count of children the reservation was booked for. format: int32 deprecated: true x-deprecatedMessage: Use `PersonCounts` instead. PersonCounts: type: array items: $ref: '#/components/schemas/ReservationPersonCount' description: Number of people per age category the reservation was booked for. OwnerId: type: string description: Unique identifier of the Customer or Company who owns the reservation. format: uuid CustomerId: type: string description: Unique identifier of the Customer who owns the reservation. format: uuid deprecated: true x-deprecatedMessage: Use `OwnerId` instead. BookerId: type: string description: Unique identifier of the Customer on whose behalf the reservation was made. format: uuid nullable: true CompanionIds: type: array items: type: string format: uuid description: Unique identifiers of the `Customer`s that will use the resource. deprecated: true x-deprecatedMessage: Use `companionships/getAll` instead. ChannelManagerId: type: string description: Channel Manager number. nullable: true deprecated: true x-deprecatedMessage: Use `ChannelManagerNumber` instead. Options: title: Reservation options allOf: - $ref: '#/components/schemas/ReservationOptions' description: Options of the reservation. additionalProperties: false description: '' x-schema-id: ReservationOld CreditRating: title: Credit Rating type: object properties: Basic: allOf: - $ref: '#/components/schemas/CreditRatingBasicEnum' description: 'Indicates the credit status of a company. CreditOk (Company can book services.) PaymentRequiredUpfront (Company must pay upfront.) LocalDecisionRequired (Requires local approval.)' nullable: true additionalProperties: false description: Credit rating to define creditworthiness of the company. x-schema-id: CreditRating Title: title: Title enum: - Mister - Miss - Misses type: string description: "Type of the title prefix of the customer.\r\n\r\nNote 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.\n\nMister (Mr.)\n\nMiss (Ms.)\n\nMisses (Mrs.)" x-enumNames: - Mister - Miss - Misses x-enumDescriptions: - Mr. - Ms. - Mrs. x-schema-id: Title x-showDescription: true ReservationStartParameters: title: ReservationStartParameters required: - AccessToken - Client - ClientToken - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationId: type: string description: Unique identifier of the reservation to start. format: uuid additionalProperties: false x-schema-id: ReservationStartParameters Amount: title: Amount required: - Breakdown - Currency - GrossValue - NetValue - TaxValues type: object properties: Currency: minLength: 1 type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). format: currency NetValue: type: number description: Net value without taxes. format: double GrossValue: type: number description: Gross value including all taxes. format: double TaxValues: type: array items: $ref: '#/components/schemas/TaxValue' description: The tax values applied. Breakdown: title: Tax breakdown allOf: - $ref: '#/components/schemas/TaxBreakdown' description: Information about individual tax amounts. additionalProperties: false description: '' x-schema-id: Amount ReservationPurpose: title: Reservation purpose enum: - Leisure - Business - Student type: string ReservationAdditionResult: title: ReservationAdditionResult required: - Reservations type: object properties: Reservations: type: array items: $ref: '#/components/schemas/AddedReservation' description: The added reservations. additionalProperties: false x-schema-id: ReservationAdditionResult CustomerOptionsEnum: title: Customer option enum: - None - SendMarketingEmails - Invoiceable - BillAddressObjection - SendMarketingPostalMail - SendPartnerMarketingEmails - SendPartnerMarketingPostalMail - WithdrawCardConsent - GuestPhotoConsent - IdPhotosConsent type: string description: ' None SendMarketingEmails Invoiceable BillAddressObjection SendMarketingPostalMail SendPartnerMarketingEmails SendPartnerMarketingPostalMail WithdrawCardConsent GuestPhotoConsent IdPhotosConsent' x-enumNames: - None - SendMarketingEmails - Invoiceable - BillAddressObjection - SendMarketingPostalMail - SendPartnerMarketingEmails - SendPartnerMarketingPostalMail - WithdrawCardConsent - GuestPhotoConsent - IdPhotosConsent x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' ChannelManagerDetails: title: Reservation channel manager details required: - CreatedUtc - RequestedRateCode - ReservationId type: object properties: ReservationId: type: string description: Unique identifier of the `Reservation`. format: uuid RequestedRateCode: minLength: 1 type: string description: Rate code requested by the channel manager for this reservation. ChannelManagerName: type: string description: Name of the Channel Manager associated with this reservation. nullable: true ChannelNumber: type: string description: 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). nullable: true ChannelManagerGroupNumber: type: string description: Number of the reservation group within a Channel Manager. nullable: true ChannelManagerNumber: type: string description: Unique number of the reservation within the reservation group. nullable: true CreatedUtc: minLength: 1 type: string description: The timestamp when the Channel Manager reservation was created. format: date-time additionalProperties: false x-schema-id: ChannelManagerDetails ResourceFeatureClassification: title: Resource feature classification enum: - SeaView - RiverView - OceanView - TwinBeds - DoubleBed - RollawayBed - UpperBed - LowerBed - Balcony - AccessibleBathroom - AccessibleRoom - ElevatorAccess - HighFloor - Kitchenette - AirConditioning - PrivateJacuzzi - PrivateSauna - EnsuiteRoom - PrivateBathroom - SharedBathroom type: string description: Classification of `ResourceFeature`. SpaceData: title: Space resource data required: - FloorNumber type: object properties: FloorNumber: minLength: 1 type: string description: Number of the floor the space is on. LocationNotes: type: string description: Location notes for the space. It can be, for example, Building number the space is located in or the Parking area the particular parking space is at. nullable: true additionalProperties: false x-schema-id: SpaceData ReservationPurposeEnum: title: Reservation purpose enum: - Leisure - Business - Student type: string description: ' Leisure Business Student' x-enumNames: - Leisure - Business - Student x-enumDescriptions: - '' - '' - '' ReservationServiceOrderFilterParameters: title: ReservationServiceOrderFilterParameters required: - AccessToken - Client - ClientToken - Limitation type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. nullable: true ReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2023-06-06). nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service). If not provided, all bookable services are used. nullable: true ReservationGroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Reservation groups](https://mews-systems.gitbook.io/connector-api/operations/#reservation-group). nullable: true AccountIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of accounts (currently only [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer), in the future also [Companies](https://mews-systems.gitbook.io/connector-api/operations/companies/#company)) the reservation is associated with. nullable: true PartnerCompanyIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Companies` on behalf of which the reservations were made. nullable: true TravelAgencyIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Identifier of the Travel Agencies (`Company`) that mediated the reservations. nullable: true Numbers: maxItems: 1000 minItems: 1 type: array items: type: string description: Reservation confirmation numbers. nullable: true ChannelNumbers: maxItems: 100 minItems: 1 type: array items: type: string description: Numbers or references used by a Channel (OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers. nullable: true AssignedResourceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Resources](https://mews-systems.gitbook.io/connector-api/operations/resources#resource) assigned to the reservations. nullable: true AvailabilityBlockIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Availability blocks` assigned to the reservations. nullable: true CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the [Reservation](https://mews-systems.gitbook.io/connector-api/operations/reservations/#reservation-ver-2023-06-06) was created. nullable: true x-max-interval-in-months: 3 UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Reservations` were updated. nullable: true x-max-interval-in-months: 3 CollidingUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the reservations are active. This is defined for a `Reservation` as the period between the reservation's scheduled start time `ScheduledStartUtc` and its scheduled end time `EndUtc`. Reservation is selected if any part of its interval intersects with the interval specified in `CollidingUtc nullable: true x-max-interval-in-months: 3 ScheduledStartUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval filtering Reservations by their scheduled start time. Cannot be used with `ActualStartUtc`. nullable: true x-max-interval-in-months: 3 ActualStartUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval filtering Reservations by their actual start (check-in) time. Cannot be used with `ScheduledStartUtc`. Note that the filter applies only to started or processed reservations. nullable: true x-max-interval-in-months: 3 ActualEndUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval filtering Reservations by their actual end (check-out) time. Cannot be used with `ScheduledEndUtc`. nullable: true x-max-interval-in-months: 3 ScheduledEndUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval filtering Reservations by their scheduled end time. Cannot be used with `ActualEndUtc`. nullable: true x-max-interval-in-months: 3 States: uniqueItems: true type: array items: $ref: '#/components/schemas/ServiceOrderStateEnum' description: A list of service order states to filter by. nullable: true additionalProperties: false x-schema-id: ReservationServiceOrderFilterParameters ProductPricing: title: Product pricing data discriminator enum: - Absolute - Relative type: string description: '' OrderItemTypeOld: title: Order item data discriminator enum: - CancellationFee - Rebate - Deposit - ExchangeRateDifference - CustomItem - Surcharge - SurchargeDiscount - SpaceOrder - ProductOrder - Other - TaxCorrection - ResourceUpgradeFee - InvoiceFee type: string x-enumDescriptions: - No additional data. - '[Rebate order item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#rebate-order-item-data)' - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - '[Product order item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#product-order-item-data)' - No additional data. - No additional data. - No additional data. - No additional data. ReservationAdditionParameters: title: ReservationAdditionParameters required: - AccessToken - Client - ClientToken - Reservations - ServiceId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ServiceId: type: string description: Unique identifier of the `Service` to be reserved. format: uuid GroupId: type: string description: Unique identifier of the `ReservationGroup` where the reservations are added. If not specified, a new group is created. format: uuid nullable: true GroupName: type: string description: Name of the `ReservationGroup` where the reservations are added to. If `GroupId` is specified, this field is ignored. If not specified, the group name is automatically created. nullable: true Reservations: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ReservationData' description: Parameters of the new reservations. CheckRateApplicability: type: boolean description: Indicates whether the system will check and prevent a booking being made using a restricted rate, e.g. a private rate. The default is `true`, i.e. the system will normally check for this unless the property is set to `false`. nullable: true CheckOverbooking: type: boolean description: 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. The default is `true`, i.e. the system will normally check for this unless the property is set to `false`. nullable: true SendConfirmationEmail: type: boolean description: Whether the confirmation email is sent. Default value is `true`. nullable: true additionalProperties: false x-schema-id: ReservationAdditionParameters ServiceOrderCommanderOriginEnum: title: Commander origin enum: - InPerson - Channel - Phone - Email - Website - Message - CallCenter - RoomingList type: string description: ' InPerson Channel Phone Email Website Message CallCenter RoomingList' x-enumNames: - InPerson - Channel - Phone - Email - Website - Message - CallCenter - RoomingList x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' Reservation: title: Reservation (ver 2023-06-06) required: - AccountId - AccountType - CreatedUtc - CreatorProfileId - EndUtc - GroupId - Id - Number - Options - Origin - PersonCounts - RateId - RequestedResourceCategoryId - ScheduledEndUtc - ScheduledStartUtc - ServiceId - StartUtc - State - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the reservation. format: uuid ServiceId: type: string description: Unique identifier of the `Service` that reservation is made against. format: uuid AccountId: type: string description: Unique identifier of the Customer or Company who owns the reservation, i.e. the main guest linked to the reservation. format: uuid AccountType: $ref: '#/components/schemas/AccountType' CreatorProfileId: type: string description: Unique identifier of the user who created the reservation. format: uuid UpdaterProfileId: type: string description: Unique identifier of the user who updated the reservation. format: uuid BookerId: type: string description: Unique identifier of the booker who made the reservation on behalf of the reservation owner, in the special case where the booker is also a registered customer in Mews. format: uuid nullable: true Number: minLength: 1 type: string description: Confirmation number of the reservation in Mews. State: title: Service order state allOf: - $ref: '#/components/schemas/ServiceOrderStateEnum' description: 'State of the reservation. Inquired (Confirmed neither by the customer nor enterprise.) Confirmed (Confirmed by both parties, before check-in.) Started (Checked in.) Processed (Checked out.) Canceled (Canceled.) Optional (Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest).) Requested (Confirmed by the customer but not by the enterprise (waitlist).)' x-enumNames: - Inquired - Confirmed - Started - Processed - Canceled - Optional - Requested x-enumDescriptions: - Confirmed neither by the customer nor enterprise. - Confirmed by both parties, before check-in. - Checked in. - Checked out. - Canceled. - Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest). - Confirmed by the customer but not by the enterprise (waitlist). Origin: title: Service order origin allOf: - $ref: '#/components/schemas/ServiceOrderOriginEnum' description: 'Origin of the reservation. Distributor (From the Mews Booking Engine or Booking Engine API.) ChannelManager (From a channel manager.) Commander (From Mews Operations.) Import (From an import process.) Connector (From the Mews Connector API.) Navigator (From Mews Guest Services.)' x-enumNames: - Distributor - ChannelManager - Commander - Import - Connector - Navigator x-enumDescriptions: - From the Mews Booking Engine or Booking Engine API. - From a channel manager. - From Mews Operations. - From an import process. - From the Mews Connector API. - From Mews Guest Services. CommanderOrigin: allOf: - $ref: '#/components/schemas/ServiceOrderCommanderOriginEnum' description: 'Further detail about origin in case of Origin `Commander`. InPerson Channel Phone Email Website Message CallCenter RoomingList' nullable: true OriginDetails: type: string description: Details about the reservation `Origin`. nullable: true CreatedUtc: minLength: 1 type: string description: Creation date and time of the reservation in UTC timezone. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the reservation in UTC timezone. format: date-time CancelledUtc: type: string description: Cancellation date and time in UTC timezone. format: date-time nullable: true VoucherId: type: string description: Unique identifier of the `Voucher` that has been used to create reservation. format: uuid nullable: true BusinessSegmentId: type: string description: Identifier of the reservation `BusinessSegment`. format: uuid nullable: true Options: title: Service order options allOf: - $ref: '#/components/schemas/ServiceOrderOptions' description: Options of the reservation. RateId: type: string description: Identifier of the reservation `Rate`. format: uuid CreditCardId: type: string description: Unique identifier of the Credit card. format: uuid nullable: true GroupId: type: string description: Unique identifier of the Reservation group. format: uuid RequestedResourceCategoryId: type: string description: Unique identifier of the Resource category. format: uuid AssignedResourceId: type: string description: Identifier of the assigned Resource. format: uuid nullable: true AvailabilityBlockId: type: string description: Unique identifier of the Availability block the reservation is assigned to. format: uuid nullable: true PartnerCompanyId: type: string description: Identifier of the `Company` on behalf of which the reservation was made. format: uuid nullable: true TravelAgencyId: type: string description: Identifier of the Travel Agency (`Company`) that mediated the reservation. format: uuid nullable: true AssignedResourceLocked: type: boolean description: Whether the reservation is locked to the assigned Resource and cannot be moved. ChannelNumber: type: string description: 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). nullable: true ChannelManagerNumber: type: string description: Unique number of the reservation within the reservation group. nullable: true CancellationReason: allOf: - $ref: '#/components/schemas/ServiceOrderCancellationReasonEnum' description: 'Cancellation reason of the reservation. Other ConfirmationMissed BookedElsewhere ForceMajeure GuestComplaint NoShow PriceTooHigh ServiceNotAvailable InputError InvalidPayment TravelAgency RequestedByGuest Update BookingAbandoned RequestedByBooker' nullable: true ReleasedUtc: type: string description: Date when the optional reservation is released in UTC timezone. format: date-time nullable: true StartUtc: minLength: 1 type: string description: Reservation start or check-in time (if it's earlier than scheduled start) in UTC timezone in ISO 8601 format. format: date-time deprecated: true x-deprecatedMessage: Use `ScheduledStartUtc` and `ActualStartUtc` instead. EndUtc: minLength: 1 type: string description: Scheduled end time of reservation in UTC timezone in ISO 8601 format format: date-time deprecated: true x-deprecatedMessage: Use `ScheduledEndUtc` and `ActualEndUtc` instead. ScheduledStartUtc: minLength: 1 type: string description: Scheduled start time of reservation in UTC timezone. format: date-time ActualStartUtc: type: string description: Actual customer check-in time of reservation in UTC timezone. format: date-time nullable: true ScheduledEndUtc: minLength: 1 type: string description: Scheduled end time of reservation in UTC timezone in ISO 8601 format. format: date-time ActualEndUtc: type: string description: Actual end time of reservation in UTC timezone in ISO 8601 format. format: date-time nullable: true Purpose: allOf: - $ref: '#/components/schemas/ReservationPurposeEnum' description: 'Purpose of the reservation. Leisure Business Student' nullable: true QrCodeData: type: string description: QR code data of the reservation. nullable: true PersonCounts: minItems: 1 type: array items: $ref: '#/components/schemas/ReservationPersonCount' description: Number of people per age category the reservation was booked for. additionalProperties: false x-schema-id: Reservation CompanionshipAddParameters: title: CompanionshipAddParameters required: - AccessToken - Client - ClientToken - CustomerId - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationId: type: string description: Unique identifier of the `Reservation`. format: uuid CustomerId: type: string description: Unique identifier of the `Customer`. format: uuid additionalProperties: false x-schema-id: CompanionshipAddParameters ReservationPersonCount: title: Age category parameters required: - AgeCategoryId - Count type: object properties: AgeCategoryId: type: string description: Unique identifier of the [Age category](https://mews-systems.gitbook.io/connector-api/operations/agecategories#age-category). format: uuid Count: type: integer description: Number of people of a given age category. Only positive value is accepted. format: int32 additionalProperties: false x-schema-id: ReservationPersonCount AdditionalServiceData: title: Additional service data required: - Promotions type: object properties: Promotions: allOf: - $ref: '#/components/schemas/Promotions' description: Promotions of the service. additionalProperties: false x-schema-id: AdditionalServiceData ReservationItemParameters: title: ReservationItemParameters required: - AccessToken - Client - ClientToken - ReservationIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. ReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the reservation. Currency: type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to. format: currency nullable: true AccountingStates: type: array items: type: string description: States the items should be in. If not specified, items in Open or Closed states are returned. nullable: true additionalProperties: false x-schema-id: ReservationItemParameters ResourceAccessTokenType: title: Resource access token type enum: - PinCode - RfidTag type: string description: Type of stored value. TimeUnitPeriodEnum: title: Time unit period enum: - Day - Month - Hour type: string description: ' Day Month Hour' x-enumNames: - Day - Month - Hour x-enumDescriptions: - '' - '' - '' ProductClassifications: title: Product classifications type: object properties: Food: type: boolean description: Product is classified as food. Beverage: type: boolean description: Product is classified as beverage. Wellness: type: boolean description: Product is classified as wellness. CityTax: type: boolean description: Product is classified as city tax. Fee: type: boolean description: Product is classified as fee. additionalProperties: false description: '' x-schema-id: ProductClassifications ConfirmReservationParameters: title: ConfirmReservationParameters required: - AccessToken - Client - ClientToken - ReservationIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationIds: type: array items: type: string format: uuid description: Unique identifier of the reservations to confirm. SendConfirmationEmail: type: boolean description: Wheter the confirmation email is sent. Default value is true. nullable: true additionalProperties: false x-schema-id: ConfirmReservationParameters CompanionshipDeleteParameters: title: CompanionshipDeleteParameters required: - AccessToken - Client - ClientToken - CustomerId - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true ReservationId: type: string description: Unique identifier of the `Reservation`. format: uuid CustomerId: type: string description: Unique identifier of the `Customer`. format: uuid additionalProperties: false x-schema-id: CompanionshipDeleteParameters TaxBreakdown: title: Tax breakdown required: - Items type: object properties: Items: type: array items: $ref: '#/components/schemas/TaxBreakdownItem' description: Tax breakdown items per each tax rate applied. additionalProperties: false x-schema-id: TaxBreakdown TimeFilterInterval: title: Time interval type: object properties: StartUtc: type: string format: date-time nullable: true EndUtc: type: string format: date-time nullable: true additionalProperties: false description: "When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:\r\n\r\n- **Start equals End (equality mode)** \r\n If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\r\n \r\n ```\r\n CreatedUtc == StartUtc\r\n ```\r\n \r\n This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\r\n\r\n- **Start differs from End (interval mode)** \r\n If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\r\n \r\n ```\r\n StartUtc <= CreatedUtc < EndUtc\r\n ```\r\n \r\n In other words, the start is inclusive and the end is exclusive.\r\n\r\nMake sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted." x-schema-id: TimeFilterInterval AddProductItemsResult: title: AddProductItemsResult type: object properties: ItemIds: type: array items: type: string format: uuid nullable: true additionalProperties: false x-schema-id: AddProductItemsResult Company: title: Company required: - ChainId - CreditRating - Id - IsActive - Name - Number - Options type: object properties: Id: type: string description: Unique identifier of the company. format: uuid ChainId: type: string description: Unique identifier of the chain. format: uuid Name: minLength: 1 type: string description: Name of the company. MotherCompanyId: type: string description: Unique identifier of mother company. format: uuid nullable: true InvoicingEmail: type: string description: Email for issuing invoices to the company. format: email nullable: true WebsiteUrl: type: string description: The website url of the company. format: uri nullable: true InvoiceDueInterval: type: string description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format. nullable: true Options: title: Company Options allOf: - $ref: '#/components/schemas/CompanyOptions' description: Options of the company. CreditRating: title: Credit Rating allOf: - $ref: '#/components/schemas/CreditRating' description: Credit rating to define creditworthiness of the company. Department: type: string description: The internal segmentation of a company, e.g. sales department. nullable: true DunsNumber: type: string description: The Dun & Bradstreet unique 9-digit DUNS number. nullable: true ReferenceIdentifier: type: string description: External system identifier - custom identifier used by an external system such as an external database. nullable: true AccountingCode: type: string description: Accounting code of the company. nullable: true AdditionalTaxIdentifier: type: string description: Additional tax identifier of the company. nullable: true BillingCode: type: string description: Billing code of the company. nullable: true Contact: type: string description: Other contact details, such as telephone, email or similar. nullable: true ContactPerson: type: string description: Contact person of the company. nullable: true ElectronicInvoiceIdentifier: type: string description: Electronic invoice identifier of the company. nullable: true deprecated: true x-deprecatedMessage: Use `AdditionalTaxIdentifier` instead. Identifier: type: string description: Fiscal or legal identifier of the company. nullable: true Iata: type: string description: Iata of the company. nullable: true IsActive: type: boolean description: Whether the company is still active. Notes: type: string description: Additional notes. nullable: true Number: type: integer description: Unique number of the company (max 19 digits). format: int64 TaxIdentifier: type: string description: Tax identification number of the company. nullable: true Telephone: type: string description: Contact telephone number. format: tel nullable: true CreatedUtc: type: string description: Date of [Company](https://mews-systems.gitbook.io/connector-api/operations/#company) creation date and time. format: date-time nullable: true UpdatedUtc: type: string description: Date of [Company](https://mews-systems.gitbook.io/connector-api/operations/#company) last update date and time. format: date-time nullable: true Address: title: Address allOf: - $ref: '#/components/schemas/OldAddress' description: '' nullable: true deprecated: true x-deprecatedMessage: Use AddressId instead. AddressId: type: string description: Unique identifier of the company [Address](https://mews-systems.gitbook.io/connector-api/operations/addresses/#account-address). format: uuid nullable: true MergeTargetId: type: string description: Unique identifier of the account (Customer) to which this company is linked. format: uuid nullable: true TaxIdentificationNumber: type: string nullable: true deprecated: true x-deprecatedMessage: Use TaxIdentifier instead. ExternalIdentifier: maxLength: 255 type: string description: Identifier of company from external system. nullable: true additionalProperties: false x-schema-id: Company ReservationResult: title: ReservationResult type: object properties: Reservations: type: array items: $ref: '#/components/schemas/ReservationOld' description: The reservations that collide with the specified interval. nullable: true ReservationGroups: type: array items: $ref: '#/components/schemas/ReservationGroupOld' description: Reservation groups that the reservations are members of. nullable: true Customers: type: array items: $ref: '#/components/schemas/Customer' description: Customers that are members of the reservations. nullable: true Services: type: array items: $ref: '#/components/schemas/Service' description: Services that have been reserved. nullable: true Products: type: array items: $ref: '#/components/schemas/Product' description: Products orderable with reservations. nullable: true Resources: type: array items: $ref: '#/components/schemas/Resource' description: Assigned resources of the reservations. nullable: true ResourceCategories: type: array items: $ref: '#/components/schemas/ResourceCategory' description: Resource categories of the resources. nullable: true ResourceCategoryAssignments: type: array items: $ref: '#/components/schemas/ResourceCategoryAssignment' description: Assignments of the resources to categories. nullable: true BusinessSegments: type: array items: $ref: '#/components/schemas/BusinessSegment' description: Business segments of the reservations. nullable: true Rates: type: array items: $ref: '#/components/schemas/RateForExtent' description: Rates of the reservations. nullable: true RateGroups: type: array items: $ref: '#/components/schemas/RateGroupOld' description: Rate groups of the reservation rates. nullable: true Items: type: array items: $ref: '#/components/schemas/AccountingItem' description: Accounting items that are part of the reservations. nullable: true OrderItems: type: array items: $ref: '#/components/schemas/OrderItemOld' description: Revenue items of the reservations. nullable: true Notes: type: array items: $ref: '#/components/schemas/OrderNote' description: Notes of the reservations. nullable: true QrCodeData: type: array items: $ref: '#/components/schemas/ReservationQrCodeData' description: QR code data of the reservations. nullable: true Companies: type: array items: $ref: '#/components/schemas/Company' description: Companies related to the reservations. nullable: true ResourceAccessTokens: type: array items: $ref: '#/components/schemas/ResourceAccessToken' description: Resource access tokens for the reservations. nullable: true Cursor: type: string description: Unique identifier of the last and hence oldest reservation returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older reservations. format: uuid nullable: true additionalProperties: false x-schema-id: ReservationResult IdentityDocumentTypeEnum: title: Document type enum: - IdentityCard - Passport - Visa - DriversLicense type: string description: ' IdentityCard Passport Visa DriversLicense' x-enumNames: - IdentityCard - Passport - Visa - DriversLicense x-enumDescriptions: - '' - '' - '' - '' ReservationTimeFilter: title: Reservation time filter enum: - Colliding - Created - Updated - Start - End - Overlapping - Canceled type: string x-enumDescriptions: - Reservations whose intervals collide with the specified interval. - Reservations created within the specified interval. - Reservations updated within the specified interval. - Reservations starting (arriving) within the specified interval. - Reservations ending (departing) within the specified interval. - Reservations whose intervals contain the specified interval. - Reservations canceled within the specified interval. MultipleReservationResult: title: MultipleReservationResult required: - ReservationIds type: object properties: ReservationIds: type: array items: type: string format: uuid description: Identifiers of the affected `Reservation` entities. additionalProperties: false x-schema-id: MultipleReservationResult ReservationDataParameters: title: ReservationDataParameters required: - AccessToken - Client - ClientToken - Reservations - ServiceId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. ServiceId: type: string description: Unique identifier of the `Service` to be priced. format: uuid Reservations: type: array items: $ref: '#/components/schemas/ReservationData' description: Parameters of the reservations to price. Note that `CustomerId` is not required when pricing reservations. additionalProperties: false x-schema-id: ReservationDataParameters