openapi: 3.0.4 info: title: Mews Connector API — Services and Products description: General-purpose API that enables partners of Mews to access data and services in Mews Operations This modular spec covers the Services and Products domain (24 operations). termsOfService: https://www.mews.com/en/terms-conditions/partners contact: name: Partner success email: partnersuccess@mews.com version: v1 x-generated-from: documentation x-source-url: https://api.mews.com/Swagger/connector/swagger.json x-last-validated: '2026-06-02' paths: /api/connector/v1/productCategories/getAll: post: tags: - Product categories summary: Mews Get All Product Categories description: Returns all categories of products. Note 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: productCategories_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductCategoryFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ProductCategoryIds: - 5228623e-b2cf-4f9f-8bd6-71cbe3ec5e6f - 63bc87d3-edf5-4d06-a601-6052a2ad709d ServiceIds: - 9b3a6c54-63aa-4383-b50e-b0030078184b - c0f71466-6c0b-4993-88ac-1794f6b7e958 UpdatedUtc: StartUtc: '2023-05-05T00:00:00Z' EndUtc: '2023-05-10T00:00:00Z' Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductCategoryResult' example: ProductCategories: - Id: 5c0804f9-d03a-4b13-a57d-b00300781a41 ServiceId: 9b3a6c54-63aa-4383-b50e-b0030078184b Names: en-US: Alcohol 1 ShortNames: en-US: Alcohol 1 Descriptions: {} ParentProductCategory: - Id: 0b82f6d8-e5eb-4711-9069-40db2b8d968f - Names: en-US: Alcoholic beverages CreatedUtc: '2023-06-09T13:32:32Z' UpdatedUtc: '2023-06-09T13:32:32Z' Ordering: 1 - Id: f0709b02-f1a4-46b2-9c1e-744b5ecd6980 ServiceId: 9b3a6c54-63aa-4383-b50e-b0030078184b Names: en-US: Lemonade 1 ShortNames: en-US: Lemonade 1 Descriptions: {} ParentProductCategory: - Id: aa4f3930-3f9d-4df7-9c6b-5aba5b2f6f7e - Names: en-US: Lemonades CreatedUtc: '2023-06-09T13:32:32Z' UpdatedUtc: '2023-06-09T13:32:32Z' Ordering: 1 Cursor: f0709b02-f1a4-46b2-9c1e-744b5ecd6980 '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' examples: ProductCategoriesGetAll400Example: summary: Default productCategories_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductCategoriesGetAll401Example: summary: Default productCategories_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductCategoriesGetAll403Example: summary: Default productCategories_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductCategoriesGetAll408Example: summary: Default productCategories_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductCategoriesGetAll204Example: summary: Default productCategories_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductCategoriesGetAll429Example: summary: Default productCategories_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductCategoriesGetAll500Example: summary: Default productCategories_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: &id001 delay: 0 dispatcher: FALLBACK /api/connector/v1/productServiceOrders/getAll: post: tags: - Product service orders summary: Mews Get All Product Service Orders description: Returns all product service orders associated with the given enterprise. 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: productServiceOrders_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductServiceOrderFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ProductServiceOrderIds: - 9e6d4492-315b-4089-b9d6-5b1bd2eddc1b ServiceIds: - ae8da28c-e8a4-4141-9df0-8c998976c691 - 6b02d015-47ac-4c41-8e9f-5b4db61d4284 LinkedReservationIds: - 0f515589-99b4-423d-b83a-b237009f0509 - b7a3f5cb-1e69-4a5f-a069-10f461996d7f UpdatedUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' States: - Confirmed - Started Limitation: Count: 10 Cursor: 819e3435-7d5e-441f-bc68-76d89c69b8f5 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductServiceOrderResult' example: ProductServiceOrders: - Id: 9e6d4492-315b-4089-b9d6-5b1bd2eddc1b ServiceId: ae8da28c-e8a4-4141-9df0-8c998976c691 AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d AccountType: Customer CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 122fc063-ec6e-4198-b8db-6b168a59ffae BookerId: bccdafd1-3e44-439d-861f-341526b597a9 Number: '52' State: Confirmed Origin: Connector CommanderOrigin: OriginDetails: CreatedUtc: '2023-04-23T14:58:02Z' UpdatedUtc: '2023-04-23T14:58:02Z' CancelledUtc: VoucherId: BusinessSegmentId: LinkedReservationId: 0f515589-99b4-423d-b83a-b237009f0509 Options: OwnerCheckedIn: true AllCompanionsCheckedIn: true AnyCompanionCheckedIn: true ConnectorCheckIn: true Cursor: 9e6d4492-315b-4089-b9d6-5b1bd2eddc1b '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' examples: ProductServiceOrdersGetAll400Example: summary: Default productServiceOrders_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductServiceOrdersGetAll401Example: summary: Default productServiceOrders_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductServiceOrdersGetAll403Example: summary: Default productServiceOrders_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductServiceOrdersGetAll408Example: summary: Default productServiceOrders_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductServiceOrdersGetAll204Example: summary: Default productServiceOrders_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductServiceOrdersGetAll429Example: summary: Default productServiceOrders_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductServiceOrdersGetAll500Example: summary: Default productServiceOrders_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/products/getPricing: post: tags: - Products summary: Mews Get Product Pricing description: 'Returns prices for a given product for a specified time interval. UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The __maximum size of time interval__ depends on the service''s time unit: 100 hours if hours, 100 days if days, or 24 months if months. For more information about time units, see [Time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units). This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).' operationId: products_getPricing requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductPricingFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ProductId: 6b97a38b-0043-41e0-afbd-3f083bdbc0d2 FirstTimeUnitStartUtc: '2024-03-01T23:00:00.000Z' LastTimeUnitStartUtc: '2024-03-03T23:00:00.000Z' EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductPricingResult' example: ProductId: 6b97a38b-0043-41e0-afbd-3f083bdbc0d2 TimeUnitStartsUtc: - '2024-03-01T23:00:00Z' - '2024-03-02T23:00:00Z' - '2024-03-03T23:00:00Z' BaseAmountPrices: - Currency: EUR NetValue: 93.46 GrossValue: 100.0 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 - Currency: EUR NetValue: 93.46 GrossValue: 100.0 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 AgeCategoryPrices: - AgeCategoryId: 7d9d9b11-2c96-4862-9ead-501c6a8ed114 Prices: - Currency: EUR NetValue: 93.46 GrossValue: 100.0 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 - Currency: EUR NetValue: 93.46 GrossValue: 100.0 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 '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' examples: ProductsGetPricing400Example: summary: Default products_getPricing 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetPricing401Example: summary: Default products_getPricing 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetPricing403Example: summary: Default products_getPricing 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetPricing408Example: summary: Default products_getPricing 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetPricing204Example: summary: Default products_getPricing 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetPricing429Example: summary: Default products_getPricing 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetPricing500Example: summary: Default products_getPricing 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/products/updatePrice: post: tags: - Products summary: Mews Update Product Pricing description: Updates the prices for a given product. You can make multiple price updates with one API call, and for each one specify the price amount per [Time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units) and the time interval for which it applies. The price will be updated for all service time units that the specified time interval intersects. It is not permitted to update historical prices older than specified by `EditableHistoryInterval`. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: products_updatePrice requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductPriceUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ProductId: 6b97a38b-0043-41e0-afbd-3f083bdbc0d2 PriceUpdates: - Value: 100.0 FirstTimeUnitStartUtc: '2024-03-01T23:00:00.000Z' LastTimeUnitStartUtc: '2024-03-03T23:00:00.000Z' - Value: 200.0 FirstTimeUnitStartUtc: '2024-03-06T23:00:00.000Z' LastTimeUnitStartUtc: '2024-03-08T23:00:00.000Z' EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ProductsUpdatePrice200Example: summary: Default products_updatePrice 200 response x-microcks-default: true value: {} '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' examples: ProductsUpdatePrice400Example: summary: Default products_updatePrice 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsUpdatePrice401Example: summary: Default products_updatePrice 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsUpdatePrice403Example: summary: Default products_updatePrice 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsUpdatePrice408Example: summary: Default products_updatePrice 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsUpdatePrice204Example: summary: Default products_updatePrice 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsUpdatePrice429Example: summary: Default products_updatePrice 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsUpdatePrice500Example: summary: Default products_updatePrice 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/products/getAll: post: tags: - Products summary: Mews Get All Products description: Returns all products offered together with the specified services. Note 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: products_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 UpdatedUtc: StartUtc: '2023-10-01T00:00:00Z' EndUtc: '2023-10-31T00:00:00Z' Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductResult' example: Products: - Id: 198bc308-c1f2-4a1c-a827-c41d99d52f3d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' CategoryId: AccountingCategoryId: 6535e19e-1077-49d9-a338-67bf4ffecb14 IsActive: true Names: en-US: Breakfast ExternalNames: en-US: Breakfast ShortNames: en-US: BFST Descriptions: en-US: Nice continental breakfast. ChargingMode: PerPersonPerTimeUnit PostingMode: Once Options: BillAsPackage: false Promotions: BeforeCheckIn: false AfterCheckIn: false DuringStay: false BeforeCheckOut: false AfterCheckOut: false DuringCheckOut: false Classifications: Food: false Beverage: false Wellness: false CityTax: false Price: GrossValue: 25 Currency: EUR TaxValues: - Code: FR-T ExternalIdentifier: PROD-BFST-009 CustomerProducts: - Id: 198bc308-c1f2-4a1c-a827-c41d99d52f3d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' CategoryId: AccountingCategoryId: 6535e19e-1077-49d9-a338-67bf4ffecb14 IsActive: true Names: en-US: Breakfast ExternalNames: en-US: Breakfast ShortNames: en-US: BFST Descriptions: en-US: Nice continental breakfast. ChargingMode: PerPersonPerTimeUnit PostingMode: Once Options: BillAsPackage: false Promotions: BeforeCheckIn: false AfterCheckIn: false DuringStay: false BeforeCheckOut: false AfterCheckOut: false DuringCheckOut: false Classifications: Food: false Beverage: false Wellness: false CityTax: false Price: GrossValue: 25 Currency: EUR TaxValues: - Code: FR-T ExternalIdentifier: PROD-BFST-009 Cursor: 198bc308-c1f2-4a1c-a827-c41d99d52f3d '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' examples: ProductsGetAll400Example: summary: Default products_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetAll401Example: summary: Default products_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetAll403Example: summary: Default products_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetAll408Example: summary: Default products_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetAll204Example: summary: Default products_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetAll429Example: summary: Default products_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsGetAll500Example: summary: Default products_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/products/delete: post: tags: - Products summary: Mews Delete Products description: Deletes specified products. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: products_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: aff75fbb-5cce-4fae-8039-b07000d16650 ProductIds: - 1f60b9de-c042-4841-bcab-b07000d2201f responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ProductsDelete200Example: summary: Default products_delete 200 response x-microcks-default: true value: {} '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' examples: ProductsDelete400Example: summary: Default products_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsDelete401Example: summary: Default products_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsDelete403Example: summary: Default products_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsDelete408Example: summary: Default products_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsDelete204Example: summary: Default products_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsDelete429Example: summary: Default products_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ProductsDelete500Example: summary: Default products_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/serviceOrderNotes/add: post: tags: - Service order notes summary: Mews Add Service Order Notes description: Adds one or more notes with a provided text to a specific service order. Service orders can be reservations or product orders. operationId: serviceOrderNotes_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleServiceOrderNoteAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceOrderNotes: - ServiceOrderId: 1dc0c6bf-2ce6-4a9f-af97-af5c01676720 Text: Shaken, not stirred. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServiceOrderNoteAdditionResult' example: ServiceOrderNotes: - Id: a06a225b-00f7-48c8-a463-af5c016768e9 OrderId: 1dc0c6bf-2ce6-4a9f-af97-af5c01676720 Text: Shaken, not stirred. Type: General CreatedUtc: '2022-11-29T21:48:32Z' UpdatedUtc: '2022-11-30T12:36:37Z' '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' examples: ServiceOrderNotesAdd400Example: summary: Default serviceOrderNotes_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesAdd401Example: summary: Default serviceOrderNotes_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesAdd403Example: summary: Default serviceOrderNotes_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesAdd408Example: summary: Default serviceOrderNotes_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesAdd204Example: summary: Default serviceOrderNotes_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesAdd429Example: summary: Default serviceOrderNotes_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesAdd500Example: summary: Default serviceOrderNotes_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/serviceOrderNotes/update: post: tags: - Service order notes summary: Mews Update Service Order Notes description: Updates one or more given service order notes with new text. operationId: serviceOrderNotes_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleServiceOrderNoteUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceOrderNoteUpdates: - ServiceOrderNoteId: a06a225b-00f7-48c8-a463-af5c016768e9 Text: Value: Shaken, not stirred. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServiceOrderNoteUpdateResult' example: ServiceOrderNotes: - Id: a06a225b-00f7-48c8-a463-af5c016768e9 OrderId: 1dc0c6bf-2ce6-4a9f-af97-af5c01676720 Text: Shaken, not stirred. Type: General CreatedUtc: '2022-11-29T21:48:32Z' UpdatedUtc: '2022-11-30T12:36:37Z' '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' examples: ServiceOrderNotesUpdate400Example: summary: Default serviceOrderNotes_update 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesUpdate401Example: summary: Default serviceOrderNotes_update 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesUpdate403Example: summary: Default serviceOrderNotes_update 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesUpdate408Example: summary: Default serviceOrderNotes_update 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesUpdate204Example: summary: Default serviceOrderNotes_update 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesUpdate429Example: summary: Default serviceOrderNotes_update 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesUpdate500Example: summary: Default serviceOrderNotes_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/serviceOrderNotes/getAll: post: tags: - Service order notes summary: Mews Get All Service Order Notes description: "Returns all notes associated with the given service orders. Service orders can be reservations or product orders. Note this operation uses [Pagination](../guidelines/pagination.md) and supports [Portfolio Access Tokens](../guidelines/multi-property.md).\r\n> **Service order:** This is the general name for an order made against a service, which includes both 'stay' service orders, called [Reservations](reservations.md#reservation), and 'product' service orders, which we simply call [Orders](orders.md). Operations such as [Get all service order notes](#get-all-service-order-notes) will accept Reservation IDs or Order IDs as service order identifiers." operationId: serviceOrderNotes_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceOrderNoteFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceOrderIds: - 1dc0c6bf-2ce6-4a9f-af97-af5c01676720 ServiceOrderNoteIds: - a06a225b-00f7-48c8-a463-af5c016768e9 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServiceOrderNoteResult' example: ServiceOrderNotes: - Id: a06a225b-00f7-48c8-a463-af5c016768e9 OrderId: 1dc0c6bf-2ce6-4a9f-af97-af5c01676720 Text: Shaken, not stirred. Type: General CreatedUtc: '2022-11-29T21:48:32Z' UpdatedUtc: '2022-11-30T12:36:37Z' Cursor: a06a225b-00f7-48c8-a463-af5c016768e9 '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' examples: ServiceOrderNotesGetAll400Example: summary: Default serviceOrderNotes_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesGetAll401Example: summary: Default serviceOrderNotes_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesGetAll403Example: summary: Default serviceOrderNotes_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesGetAll408Example: summary: Default serviceOrderNotes_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesGetAll204Example: summary: Default serviceOrderNotes_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesGetAll429Example: summary: Default serviceOrderNotes_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesGetAll500Example: summary: Default serviceOrderNotes_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/serviceOrderNotes/delete: post: tags: - Service order notes summary: Mews Delete Service Order Notes description: Deletes service order notes. operationId: serviceOrderNotes_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceOrderNoteDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceOrderNoteIds: - a06a225b-00f7-48c8-a463-af5c016768e9 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ServiceOrderNotesDelete200Example: summary: Default serviceOrderNotes_delete 200 response x-microcks-default: true value: {} '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' examples: ServiceOrderNotesDelete400Example: summary: Default serviceOrderNotes_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesDelete401Example: summary: Default serviceOrderNotes_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesDelete403Example: summary: Default serviceOrderNotes_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesDelete408Example: summary: Default serviceOrderNotes_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesDelete204Example: summary: Default serviceOrderNotes_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesDelete429Example: summary: Default serviceOrderNotes_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOrderNotesDelete500Example: summary: Default serviceOrderNotes_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/serviceOverbookingLimits/getAll: post: tags: - Service overbooking limits summary: Mews Get All Service Overbooking Limits description: Returns all service overbooking limits. Note 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: serviceOverbookingLimits_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceOverbookingLimitFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 - 8c1bd738-a505-4b29-aa71-9ecc2982b843 ServiceOverbookingLimitIds: - e654f217-d1b5-46be-a820-e93ba568dfac CollidingUtc: StartUtc: '2024-11-01T00:00:00Z' EndUtc: '2024-11-30T00:00:00Z' UpdatedUtc: StartUtc: '2024-11-01T00:00:00Z' EndUtc: '2024-11-30T00:00:00Z' ActivityStates: - Active EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServiceOverbookingLimitResult' example: ServiceOverbookingLimits: - Id: e654f217-d1b5-46be-a820-e93ba568dfac ServiceId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 FirstTimeUnitStartUtc: '2024-11-01T00:00:00Z' LastTimeUnitStartUtc: '2024-11-30T00:00:00Z' Limit: 10 CreatedUtc: '2024-01-31T10:48:06Z' UpdatedUtc: '2024-01-31T10:58:06Z' IsActive: true Cursor: e654f217-d1b5-46be-a820-e93ba568dfac '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' examples: ServiceOverbookingLimitsGetAll400Example: summary: Default serviceOverbookingLimits_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsGetAll401Example: summary: Default serviceOverbookingLimits_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsGetAll403Example: summary: Default serviceOverbookingLimits_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsGetAll408Example: summary: Default serviceOverbookingLimits_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsGetAll204Example: summary: Default serviceOverbookingLimits_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsGetAll429Example: summary: Default serviceOverbookingLimits_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsGetAll500Example: summary: Default serviceOverbookingLimits_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/serviceOverbookingLimits/set: post: tags: - Service overbooking limits summary: Mews Set Service Overbooking Limits description: Adds new service overbooking limits with the specified conditions. Past overbooking limits cannot be updated outside of `OperationalEditableHistoryInterval`. Care is needed to specify `FirstTimeUnitStartUtc` and `LastTimeUnitStartUtc` in the correct format - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes). This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: serviceOverbookingLimits_set requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceOverbookingLimitSetParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 SetServiceOverbookingLimits: - FirstTimeUnitStartUtc: '2024-11-01T00:00:00Z' LastTimeUnitStartUtc: '2024-11-30T00:00:00Z' Limit: 10 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ServiceOverbookingLimitsSet200Example: summary: Default serviceOverbookingLimits_set 200 response x-microcks-default: true value: {} '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' examples: ServiceOverbookingLimitsSet400Example: summary: Default serviceOverbookingLimits_set 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsSet401Example: summary: Default serviceOverbookingLimits_set 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsSet403Example: summary: Default serviceOverbookingLimits_set 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsSet408Example: summary: Default serviceOverbookingLimits_set 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsSet204Example: summary: Default serviceOverbookingLimits_set 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsSet429Example: summary: Default serviceOverbookingLimits_set 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsSet500Example: summary: Default serviceOverbookingLimits_set 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/serviceOverbookingLimits/clear: post: tags: - Service overbooking limits summary: Mews Clear Service Overbooking Limits description: Deletes service overbooking limits that exactly match the specified conditions. This operation is intended to be used alongside `serviceOverbookingLimits/set`. The specified conditions must be met exactly. The time interval, however, does not need to correspond to an existing service overbooking limit in the system, instead the API uses a splicing algorithm to work out how to divide up any existing service overbooking limit to meet the specified time interval. Past overbooking limits cannot be cleared outside of `OperationalEditableHistoryInterval`. Care is needed to specify `FirstTimeUnitStartUtc` and `LastTimeUnitStartUtc` in the correct format - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes). This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: serviceOverbookingLimits_clear requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceOverbookingLimitClearParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 ClearServiceOverbookingLimits: - FirstTimeUnitStartUtc: '2024-11-01T00:00:00Z' LastTimeUnitStartUtc: '2024-11-30T00:00:00Z' EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ServiceOverbookingLimitsClear200Example: summary: Default serviceOverbookingLimits_clear 200 response x-microcks-default: true value: {} '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' examples: ServiceOverbookingLimitsClear400Example: summary: Default serviceOverbookingLimits_clear 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsClear401Example: summary: Default serviceOverbookingLimits_clear 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsClear403Example: summary: Default serviceOverbookingLimits_clear 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsClear408Example: summary: Default serviceOverbookingLimits_clear 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsClear204Example: summary: Default serviceOverbookingLimits_clear 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsClear429Example: summary: Default serviceOverbookingLimits_clear 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServiceOverbookingLimitsClear500Example: summary: Default serviceOverbookingLimits_clear 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 /api/connector/v1/services/getAll: post: tags: - Services summary: Mews Get All Services description: 'Returns all services offered by the enterprise. Note 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: services_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ServiceIds: - fc79a518-bc69-45b8-93bd-83326201bd14 - bd26d8db-86da-4f96-9efc-e5a4654a4a94 UpdatedUtc: StartUtc: '2020-01-05T00:00:00Z' EndUtc: '2020-01-10T00:00:00Z' Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServiceResult' example: Services: - Id: fc79a518-bc69-45b8-93bd-83326201bd14 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsActive: true Name: Restaurant Options: BillAsPackage: false Data: Discriminator: Additional Value: Promotions: BeforeCheckIn: false AfterCheckIn: false DuringStay: false BeforeCheckOut: false AfterCheckOut: false DuringCheckOut: false ExternalIdentifier: SVCE-Restaurant - Id: bd26d8db-86da-4f96-9efc-e5a4654a4a94 EnterpriseId: 4d0201db-36f5-428b-8d11-4f0a65e960cc CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsActive: true Name: Accommodation Options: BillAsPackage: true Data: Discriminator: Bookable Value: StartOffset: P0M0DT15H0M0S EndOffset: P0M0DT12H0M0S OccupancyStartOffset: P0M0DT15H0M0S OccupancyEndOffset: P0M0DT12H0M0S TimeUnitPeriod: Day ExternalIdentifier: SVCE-Accomm Cursor: bd26d8db-86da-4f96-9efc-e5a4654a4a94 '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' examples: ServicesGetAll400Example: summary: Default services_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAll401Example: summary: Default services_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAll403Example: summary: Default services_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAll408Example: summary: Default services_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAll204Example: summary: Default services_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAll429Example: summary: Default services_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAll500Example: summary: Default services_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/services/updateAvailability: post: tags: - Services summary: Mews Update Service Availability description: Updates the number of available resources in [Resource category](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource-category) by a certain amount (relative adjustment). Note that availabilities are defined per time unit, so when the server receives the UTC interval, it first converts it to enterprise timezone and updates the availability on all time units that the interval intersects. It's not allowed to update past availabilities outside of `EditableHistoryInterval`, future updates are allowed for up to 5 years. operationId: services_updateAvailability requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceAvailabilityUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 AvailabilityUpdates: - FirstTimeUnitStartUtc: '2020-10-05T23:00:00Z' LastTimeUnitStartUtc: '2020-10-05T23:00:00Z' AvailabilityBlockId: 23e85a44-d95a-4dcf-9f36-acb000b10abe ResourceCategoryId: 46bc1498-38cf-4d03-b144-aa69012f5d50 UnitCountAdjustment: Value: 6 - FirstTimeUnitStartUtc: '2020-10-07T23:00:00Z' LastTimeUnitStartUtc: '2020-10-08T23:00:00Z' ResourceCategoryId: 46bc1498-38cf-4d03-b144-aa69012f5d50 UnitCountAdjustment: {} responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ServicesUpdateAvailability200Example: summary: Default services_updateAvailability 200 response x-microcks-default: true value: {} '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' examples: ServicesUpdateAvailability400Example: summary: Default services_updateAvailability 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesUpdateAvailability401Example: summary: Default services_updateAvailability 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesUpdateAvailability403Example: summary: Default services_updateAvailability 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesUpdateAvailability408Example: summary: Default services_updateAvailability 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesUpdateAvailability204Example: summary: Default services_updateAvailability 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesUpdateAvailability429Example: summary: Default services_updateAvailability 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesUpdateAvailability500Example: summary: Default services_updateAvailability 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/services/getAvailability: post: tags: - Services summary: Mews Get Service Availability description: 'Returns availability of a bookable service for a specified time interval including applied availability adjustments. Availability will be returned for all service time units that the specified time interval intersects. So, for example, an interval `1st Jan 23:00 UTC - 1st Jan 23:00 UTC` will result in one price for `2nd Jan`, while Interval `1st Jan 23:00 UTC - 2nd Jan 23:00 UTC` will result in two prices for `2nd Jan` and `3rd Jan` (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The __maximum size of time interval__ depends on the service''s time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see [Time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units).' operationId: services_getAvailability requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceAvailabilityFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 FirstTimeUnitStartUtc: '2017-01-01T23:00:00.000Z' LastTimeUnitStartUtc: '2017-01-03T23:00:00.000Z' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServiceAvailabilityResult' example: CategoryAvailabilities: - Availabilities: - 6 - 7 - 5 'Adjustments ': - 0 - 1 - -1 CategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f - Availabilities: - 7 - 7 - 7 'Adjustments ': - 1 - 0 - -1 CategoryId: a0a7a5c5-c4ef-494a-8b34-6cca97629076 TimeUnitStartsUtc: - '2017-01-01T23:00:00Z' - '2017-01-02T23:00:00Z' - '2017-01-03T23:00: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' examples: ServicesGetAvailability400Example: summary: Default services_getAvailability 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability401Example: summary: Default services_getAvailability 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability403Example: summary: Default services_getAvailability 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability408Example: summary: Default services_getAvailability 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability204Example: summary: Default services_getAvailability 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability429Example: summary: Default services_getAvailability 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability500Example: summary: Default services_getAvailability 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/services/getAvailability/2024-01-22: post: tags: - Services summary: Mews Get Service Availability (ver 2024-01-22) description: 'Returns selected availability and occupancy metrics of a bookable service for a specified time interval, similar to [the availability & occupancy report](https://help.mews.com/s/article/Availability-Occupancy-report). Availability will be returned for all service time units that the specified time interval intersects. So, for example, an interval `1st Jan 23:00 UTC - 1st Jan 23:00 UTC` will result in one time unit for `2nd Jan`, while Interval `1st Jan 23:00 UTC - 2nd Jan 23:00 UTC` will result in two time units for `2nd Jan` and `3rd Jan` (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The __maximum size of time interval__ depends on the service''s time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see [Time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units).' operationId: services_getAvailability_2024-01-22 requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceAvailabilityFilterParametersV20240122' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 FirstTimeUnitStartUtc: '2024-02-01T23:00:00.000Z' LastTimeUnitStartUtc: '2024-02-05T23:00:00.000Z' Metrics: - OutOfOrderBlocks - PublicAvailabilityAdjustment - OtherServiceReservationCount - Occupied - ConfirmedReservations - OptionalReservations - BlockAvailability - AllocatedBlockAvailability - UsableResources - ActiveResources - HouseUse responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ServiceAvailabilityResultV20240122' example: TimeUnitStartsUtc: - '2024-01-31T23:00:00Z' - '2024-02-01T23:00:00Z' - '2024-02-02T23:00:00Z' - '2024-02-03T23:00:00Z' - '2024-02-04T23:00:00Z' ResourceCategoryAvailabilities: - ResourceCategoryId: d1801d11-fe8d-404b-a26f-af170189605a Metrics: OutOfOrderBlocks: - 0 - 1 - 0 - 0 - 1 PublicAvailabilityAdjustment: - 7 - 5 - 4 - 3 - 4 OtherServiceReservationCount: - 0 - 0 - 1 - 0 - 0 Occupied: - 7 - 5 - 4 - 3 - 4 ConfirmedReservations: - 7 - 5 - 4 - 3 - 4 OptionalReservations: - 0 - 2 - 0 - 0 - 1 BlockAvailability: - 0 - 0 - 1 - 0 - 0 AllocatedBlockAvailability: - 0 - 0 - 0 - 1 - 0 UsableResources: - 8 - 8 - 8 - 8 - 8 ActiveResources: - 8 - 8 - 8 - 8 - 8 HouseUse: - 1 - 0 - 1 - 0 - 0 '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' examples: ServicesGetAvailability20240122400Example: summary: Default services_getAvailability_2024-01-22 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability20240122401Example: summary: Default services_getAvailability_2024-01-22 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability20240122403Example: summary: Default services_getAvailability_2024-01-22 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability20240122408Example: summary: Default services_getAvailability_2024-01-22 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability20240122204Example: summary: Default services_getAvailability_2024-01-22 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability20240122429Example: summary: Default services_getAvailability_2024-01-22 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ServicesGetAvailability20240122500Example: summary: Default services_getAvailability_2024-01-22 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/voucherCodes/add: post: tags: - Voucher codes summary: Mews Add Voucher Codes description: Adds voucher codes to the specified [Vouchers](https://mews-systems.gitbook.io/connector-api/operations/vouchers/#voucher). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: voucherCodes_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleVoucherCodeAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 VoucherCodeParameters: - VoucherId: 8c364829-c7ae-4972-b67f-93ea704d7228 Value: 0E5856B0A73E62B7E446 ValidityStartUtc: '2023-10-09T22:00:00Z' ValidityEndUtc: '2023-10-09T22:00:00Z' - VoucherId: dc9d3488-7fc4-4fc9-a524-14e6504d8734 Value: 021D047E42A5FD522CBA ValidityStartUtc: '2023-10-09T22:00:00Z' ValidityEndUtc: '2023-10-09T22:00:00Z' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VoucherCodeResult' example: VoucherCodes: - Id: 8c364829-c7ae-4972-b67f-93ea704d7228 VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d Value: 0E5856B0A73E62B7E446 ValidityStartUtc: ValidityEndUtc: CreatedUtc: '2023-10-30T13:37:16Z' UpdatedUtc: '2023-10-30T13:37:16Z' ActivityState: Active - Id: dc9d3488-7fc4-4fc9-a524-14e6504d8734 VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d Value: 021D047E42A5FD522CBA ValidityStartUtc: '2023-10-09T22:00:00Z' ValidityEndUtc: '2023-10-09T22:00:00Z' CreatedUtc: '2023-10-09T15:08:14Z' UpdatedUtc: '2023-10-09T15:08:14Z' ActivityState: Active '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' examples: VoucherCodesAdd400Example: summary: Default voucherCodes_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesAdd401Example: summary: Default voucherCodes_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesAdd403Example: summary: Default voucherCodes_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesAdd408Example: summary: Default voucherCodes_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesAdd204Example: summary: Default voucherCodes_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesAdd429Example: summary: Default voucherCodes_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesAdd500Example: summary: Default voucherCodes_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/voucherCodes/delete: post: tags: - Voucher codes summary: Mews Delete Voucher Codes description: Delete specified voucher codes. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: voucherCodes_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleVoucherCodeDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 VoucherCodeIds: - 8c364829-c7ae-4972-b67f-93ea704d7228 - dc9d3488-7fc4-4fc9-a524-14e6504d8734 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: VoucherCodesDelete200Example: summary: Default voucherCodes_delete 200 response x-microcks-default: true value: {} '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' examples: VoucherCodesDelete400Example: summary: Default voucherCodes_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesDelete401Example: summary: Default voucherCodes_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesDelete403Example: summary: Default voucherCodes_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesDelete408Example: summary: Default voucherCodes_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesDelete204Example: summary: Default voucherCodes_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesDelete429Example: summary: Default voucherCodes_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesDelete500Example: summary: Default voucherCodes_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/voucherCodes/getAll: post: tags: - Voucher codes summary: Mews Get All Voucher Codes description: Returns all voucher codes filtered by [Voucher](https://mews-systems.gitbook.io/connector-api/operations/vouchers/#voucher) or other filter parameters. Note 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: voucherCodes_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/VoucherCodeFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc VoucherCodeIds: - 8c364829-c7ae-4972-b67f-93ea704d7228 - dc9d3488-7fc4-4fc9-a524-14e6504d8734 VoucherIds: - fe568bbd-1ecb-4bb2-bf77-96c3698de20d UpdatedUtc: StartUtc: '2023-10-10T00:00:00Z' EndUtc: '2023-10-17T00:00:00Z' Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VoucherCodeResult' example: VoucherCodes: - Id: 8c364829-c7ae-4972-b67f-93ea704d7228 VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d Value: 0E5856B0A73E62B7E446 ValidityStartUtc: ValidityEndUtc: CreatedUtc: '2023-10-30T13:37:16Z' UpdatedUtc: '2023-10-30T13:37:16Z' ActivityState: Active - Id: dc9d3488-7fc4-4fc9-a524-14e6504d8734 VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d Value: 021D047E42A5FD522CBA ValidityStartUtc: '2023-10-09T22:00:00Z' ValidityEndUtc: '2023-10-09T22:00:00Z' CreatedUtc: '2023-10-09T15:08:14Z' UpdatedUtc: '2023-10-09T15:08:14Z' ActivityState: Active '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' examples: VoucherCodesGetAll400Example: summary: Default voucherCodes_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesGetAll401Example: summary: Default voucherCodes_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesGetAll403Example: summary: Default voucherCodes_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesGetAll408Example: summary: Default voucherCodes_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesGetAll204Example: summary: Default voucherCodes_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesGetAll429Example: summary: Default voucherCodes_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VoucherCodesGetAll500Example: summary: Default voucherCodes_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/vouchers/getAll: post: tags: - Vouchers summary: Mews Get All Vouchers description: Returns all rate vouchers filtered by [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service), voucher code or voucher identifier. Note 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: vouchers_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/VoucherFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Extent: Vouchers: true VoucherCodes: true VoucherAssignments: true Companies: false Rates: false ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 - 8c1bd738-a505-4b29-aa71-9ecc2982b843 VoucherIds: - fe568bbd-1ecb-4bb2-bf77-96c3698de20d VoucherCodeValues: - TEST-VOUCHER-CODE ActivityStates: - Active UpdatedUtc: StartUtc: '2023-10-10T00:00:00Z' EndUtc: '2023-10-17T00:00:00Z' ExternalIdentifiers: - Voucher-001 - Voucher-002 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VoucherResult' example: Vouchers: - Id: fe568bbd-1ecb-4bb2-bf77-96c3698de20d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Weekend Voucher CreatedUtc: '2018-11-29T08:17:05Z' UpdatedUtc: '2020-10-30T13:38:49Z' Type: Public ActivityState: Active CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f TravelAgencyId: OccupiableIntervalStartUtc: OccupiableIntervalEndUtc: ExternalIdentifier: VCHR-278 IsActive: true VoucherCodes: - Id: 11111111-1111-1111-1111-111111111111 VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d Value: TEST-VOUCHER-CODE ValidityStartUtc: ValidityEndUtc: CreatedUtc: '2020-10-30T13:37:16Z' UpdatedUtc: '2020-10-30T13:37:16Z' ActivityState: Active IsActive: true - Id: 22222222-2222-2222-2222-222222222222 VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d Value: 05400269B23A59C649E4 ValidityStartUtc: '2020-10-09T22:00:00Z' ValidityEndUtc: '2020-10-09T22:00:00Z' CreatedUtc: '2020-10-09T15:08:14Z' UpdatedUtc: '2020-10-09T15:08:14Z' ActivityState: Active IsActive: true VoucherAssignments: - VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda - VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d RateId: b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f Rates: Companies: Cursor: fe568bbd-1ecb-4bb2-bf77-96c3698de20d '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' examples: VouchersGetAll400Example: summary: Default vouchers_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersGetAll401Example: summary: Default vouchers_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersGetAll403Example: summary: Default vouchers_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersGetAll408Example: summary: Default vouchers_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersGetAll204Example: summary: Default vouchers_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersGetAll429Example: summary: Default vouchers_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersGetAll500Example: summary: Default vouchers_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/vouchers/add: post: tags: - Vouchers summary: Mews Add Vouchers description: Adds the specified vouchers to the specified [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: vouchers_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleVoucherAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 VoucherParameters: - ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 Name: Weekend Voucher Type: Public AssignedRateIds: - ed4b660b-19d0-434b-9360-a4de2ea42eda - b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f - ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 Name: Sample company voucher Type: PartnerCompany CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f AssignedRateIds: - ed4b660b-19d0-434b-9360-a4de2ea42eda - b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f OccupiableIntervalStartUtc: '2023-12-31T22:00:00Z' OccupiableIntervalEndUtc: '2024-01-01T22:00:00Z' ExternalIdentifier: VCHR-278 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VoucherWriteResult' example: Vouchers: - Id: fe568bbd-1ecb-4bb2-bf77-96c3698de20d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Weekend Voucher CreatedUtc: '2018-11-29T08:17:05Z' UpdatedUtc: '2020-10-30T13:38:49Z' Type: Public ActivityState: Active CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f TravelAgencyId: OccupiableIntervalStartUtc: OccupiableIntervalEndUtc: ExternalIdentifier: VCHR-278 IsActive: true - Id: f4a9942c-2616-4074-b1f4-4b959515e933 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Sample company voucher CreatedUtc: '2023-12-01T08:17:05Z' UpdatedUtc: '2023-12-02T13:38:49Z' Type: PartnerCompany ActivityState: Active CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f TravelAgencyId: OccupiableIntervalStartUtc: '2023-12-31T22:00:00Z' OccupiableIntervalEndUtc: '2024-01-01T22:00:00Z' ExternalIdentifier: VCHR-278 IsActive: true '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' examples: VouchersAdd400Example: summary: Default vouchers_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersAdd401Example: summary: Default vouchers_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersAdd403Example: summary: Default vouchers_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersAdd408Example: summary: Default vouchers_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersAdd204Example: summary: Default vouchers_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersAdd429Example: summary: Default vouchers_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersAdd500Example: summary: Default vouchers_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/vouchers/update: post: tags: - Vouchers summary: Mews Update Vouchers description: Updates information about the specified vouchers. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: vouchers_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleVoucherUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 VoucherUpdates: - VoucherId: fe568bbd-1ecb-4bb2-bf77-96c3698de20d Name: Value: Weekend Voucher Type: Value: Public AssignedRateIds: Value: - ed4b660b-19d0-434b-9360-a4de2ea42eda - b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f - VoucherId: f4a9942c-2616-4074-b1f4-4b959515e933 Name: Value: Sample company voucher Type: Value: PartnerCompany CompanyId: Value: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f AssignedRateIds: Value: - ed4b660b-19d0-434b-9360-a4de2ea42eda - b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f OccupiableIntervalStartUtc: Value: '2023-12-31T22:00:00Z' OccupiableIntervalEndUtc: Value: '2024-01-01T22:00:00Z' ExternalIdentifier: Value: VCHR-278 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VoucherWriteResult' example: Vouchers: - Id: fe568bbd-1ecb-4bb2-bf77-96c3698de20d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Weekend Voucher CreatedUtc: '2018-11-29T08:17:05Z' UpdatedUtc: '2020-10-30T13:38:49Z' Type: Public ActivityState: Active CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f TravelAgencyId: OccupiableIntervalStartUtc: OccupiableIntervalEndUtc: ExternalIdentifier: VCHR-278 IsActive: true - Id: f4a9942c-2616-4074-b1f4-4b959515e933 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Sample company voucher CreatedUtc: '2023-12-01T08:17:05Z' UpdatedUtc: '2023-12-02T13:38:49Z' Type: PartnerCompany ActivityState: Active CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f TravelAgencyId: OccupiableIntervalStartUtc: '2023-12-31T22:00:00Z' OccupiableIntervalEndUtc: '2024-01-01T22:00:00Z' ExternalIdentifier: VCHR-278 IsActive: true '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' examples: VouchersUpdate400Example: summary: Default vouchers_update 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersUpdate401Example: summary: Default vouchers_update 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersUpdate403Example: summary: Default vouchers_update 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersUpdate408Example: summary: Default vouchers_update 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersUpdate204Example: summary: Default vouchers_update 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersUpdate429Example: summary: Default vouchers_update 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersUpdate500Example: summary: Default vouchers_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/vouchers/delete: post: tags: - Vouchers summary: Mews Delete Vouchers description: Delete specified vouchers. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: vouchers_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleVoucherDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 VoucherIds: - fe568bbd-1ecb-4bb2-bf77-96c3698de20d - f4a9942c-2616-4074-b1f4-4b959515e933 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' example: {} '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' examples: VouchersDelete400Example: summary: Default vouchers_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersDelete401Example: summary: Default vouchers_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersDelete403Example: summary: Default vouchers_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersDelete408Example: summary: Default vouchers_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersDelete204Example: summary: Default vouchers_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersDelete429Example: summary: Default vouchers_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: VouchersDelete500Example: summary: Default vouchers_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 components: schemas: RelativeProductPrice: title: Relative product price type: object properties: Multiplier: type: number format: double deprecated: true example: 100.0 Target: type: string nullable: true deprecated: true example: string 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 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). OrderNoteTypeEnum: title: Service order note type enum: - General - ChannelManager - SpecialRequest type: string description: ' General ChannelManager SpecialRequest' x-enumNames: - General - ChannelManager - SpecialRequest x-enumDescriptions: - '' - '' - '' VoucherCodeFilterParameters: title: VoucherCodeFilterParameters required: - AccessToken - Client - ClientToken - Limitation - VoucherIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 VoucherCodeIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the voucher codes. nullable: true VoucherIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of vouchers. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval of voucher code's last update date and time. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: VoucherCodeFilterParameters PaxCount: title: PaxCount required: - PersonCount - UnitCount type: object properties: PersonCount: type: integer description: Predicted guest count that will be assigned to the Resource. The guest count must fit within the Resource Category maximum capacity. format: int32 example: 1 UnitCount: type: integer description: Positive number of adjustments that are assigned to `PersonCount`. The sum of all `UnitCount` in `PaxCounts` should match the adjustment value applied to the interval. format: int32 example: 1 additionalProperties: false x-schema-id: PaxCount 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CategoryId: type: string description: Unique identifier of the Product category. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string description: Unique identifier of [Accounting Category](https://mews-systems.gitbook.io/connector-api/operations/accountingcategories/#accounting-category). format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the product is still active. example: true IsDefault: type: boolean deprecated: true example: true Name: type: string description: Name of the product. **Deprecated!** Please use Names nullable: true deprecated: true x-deprecatedMessage: Use `Names` instead. example: Example Name 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. example: Example Name 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. example: Example Name 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. example: string 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: - '' - '' - '' - '' example: string 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: - '' - '' - '' - '' example: string Posting: title: Product posting allOf: - $ref: '#/components/schemas/ProductPostingEnum' description: ' Once Daily' deprecated: true x-enumNames: - Once - Daily x-enumDescriptions: - '' - '' example: string PostingMode: title: Product posting mode allOf: - $ref: '#/components/schemas/ProductPostingModeEnum' description: 'Charging mode of the product. Once PerTimeUnit' x-enumNames: - Once - PerTimeUnit x-enumDescriptions: - '' - '' example: string Options: title: Product options allOf: - $ref: '#/components/schemas/ProductOptions' description: Options of the product. example: string Promotions: allOf: - $ref: '#/components/schemas/Promotions' description: Promotions of the product. example: string Classifications: title: Product classifications allOf: - $ref: '#/components/schemas/ProductClassifications' description: Classifications of the product. example: string Price: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Price representing price of the product. example: string 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 example: 1 ExternalIdentifier: maxLength: 255 type: string description: Identifier of the product from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 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 example: string TaxExemptionLegalReference: type: string description: Legal reference that states why this product is exempt from tax. nullable: true example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the product in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the product in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' 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: - '' - '' - '' - '' example: string additionalProperties: false x-schema-id: Product ServiceOverbookingLimitSetData: title: Service overbooking limits set parameters required: - FirstTimeUnitStartUtc - LastTimeUnitStartUtc - Limit type: object properties: FirstTimeUnitStartUtc: minLength: 1 type: string description: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' LastTimeUnitStartUtc: minLength: 1 type: string description: 'End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service''s [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units): 367 days.' format: date-time example: '2026-06-02T14:30:00Z' Limit: maximum: 2147483647 minimum: 0 type: integer description: Number of overbookings allowed for the `Service`. Must be non-negative. format: int32 example: 0 additionalProperties: false x-schema-id: ServiceOverbookingLimitSetData 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. example: string 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. example: string 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. example: string 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. example: string 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. example: string 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: - '' - '' - '' example: string additionalProperties: false x-schema-id: BookableServiceData ServiceAvailabilityFilterParametersV20240122: title: ServiceAvailabilityFilterParametersV20240122 required: - AccessToken - Client - ClientToken - FirstTimeUnitStartUtc - LastTimeUnitStartUtc - Metrics - ServiceId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service) whose availability should be returned. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 FirstTimeUnitStartUtc: minLength: 1 type: string description: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' LastTimeUnitStartUtc: minLength: 1 type: string description: 'End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service''s [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/): 367 hours if hours, 367 days if days, or 60 months if months.' format: date-time example: '2026-06-02T14:30:00Z' Metrics: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/ResourceAvailabilityMetricTypeEnum' description: Set of [Service availability metrics](https://mews-systems.gitbook.io/connector-api/operations/services/#service-availability-metrics) to be returned. additionalProperties: false x-schema-id: ServiceAvailabilityFilterParametersV20240122 ServiceFilterParameters: title: ServiceFilterParameters required: - AccessToken - Client - ClientToken - Limitation type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service). nullable: true ServiceType: allOf: - $ref: '#/components/schemas/ServiceDataDiscriminatorEnum' description: 'Filter services by type. Bookable Additional' nullable: true example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which `Services` were updated. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: ServiceFilterParameters ProductPricingResult: title: Product pricing result required: - AgeCategoryPrices - BaseAmountPrices - ProductId - TimeUnitStartsUtc type: object properties: ProductId: type: string description: Unique identifier of the product. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TimeUnitStartsUtc: type: array items: type: string description: Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format. format: date-time BaseAmountPrices: type: array items: $ref: '#/components/schemas/Amount' description: Base prices of the product for each time unit covered by the time interval. AgeCategoryPrices: type: array items: $ref: '#/components/schemas/ProductAgeCategoryPrice' description: Age category prices. additionalProperties: false x-schema-id: ProductPricingResult ServiceOrderNoteAdditionResult: title: ServiceOrderNoteAdditionResult required: - ServiceOrderNotes type: object properties: ServiceOrderNotes: type: array items: $ref: '#/components/schemas/OrderNote' description: Added service order notes. additionalProperties: false x-schema-id: ServiceOrderNoteAdditionResult ServiceOrderNoteFilterParameters: title: ServiceOrderNoteFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ServiceOrderIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ServiceOrderIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Service order`. Reservation IDs or Order IDs can be used as service order identifiers. ServiceOrderNoteIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Service order note`. Use this property if you want to fetch specific service order notes. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Timestamp in UTC timezone ISO 8601 format when the service order note was updated. nullable: true x-max-interval-in-months: 3 example: string Types: type: array items: $ref: '#/components/schemas/OrderNoteTypeEnum' description: Type of the service order note. Defaults to `["General", "ChannelManager"]`. nullable: true additionalProperties: false x-schema-id: ServiceOrderNoteFilterParameters VoucherCodeResult: title: VoucherCodeResult required: - VoucherCodes type: object properties: VoucherCodes: maxItems: 1000 type: array items: $ref: '#/components/schemas/VoucherCode' description: Information about voucher codes used by customers. 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: VoucherCodeResult VoucherUpdateParameters: title: Vouchers update parameters required: - VoucherId type: object properties: VoucherId: type: string description: Unique identifier of the Voucher. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: title: String update value maxLength: 128 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Internal name of the voucher (or `null` if the name should not be updated). nullable: true example: Example Name Type: title: Voucher Type update value allOf: - $ref: '#/components/schemas/VoucherTypeUpdateValue' description: Type of the voucher e.g. 'Public', 'PartnerCompany' or 'TravelAgency' (or `null` if the type should not be updated). nullable: true example: string CompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of Company (Company or Travel Agency) the voucher is related to. This is required for Type of `PartnerCompany` or `TravelAgency`. Use `null` if Company should not be updated. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedRateIds: title: Assigned rate IDs allOf: - $ref: '#/components/schemas/AssignedRateIds' description: Unique identifiers of Rates (or `null` should it not be updated). nullable: true example: string OccupiableIntervalStartUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Start of the interval in which the voucher can be applied (or `null` if the start time should not be updated). format: date-time nullable: true example: '2026-06-02T14:30:00Z' OccupiableIntervalEndUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: End of the interval in which the voucher can be applied (or `null` if the end time should not be updated). format: date-time nullable: true example: '2026-06-02T14:30:00Z' ExternalIdentifier: title: String update value maxLength: 255 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Identifier of the voucher from external system (or `null` if the identifier should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: VoucherUpdateParameters 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. example: true AfterCheckIn: type: boolean description: Whether it can be promoted after check-in. example: true DuringStay: type: boolean description: Whether it can be promoted during stay. example: true BeforeCheckOut: type: boolean description: Whether it can be promoted before check-out. example: true AfterCheckOut: type: boolean description: Whether it can be promoted after check-out. example: true DuringCheckOut: type: boolean description: Whether it can be promoted during check-out. example: true additionalProperties: false description: '' x-schema-id: Promotions StringUpdateValue: title: String update value type: object properties: Value: type: string description: Value which is to be updated. nullable: true example: string additionalProperties: false x-schema-id: StringUpdateValue GuidNullableUpdateValue: title: Guid update value type: object properties: Value: type: string description: Value which is to be updated. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: GuidNullableUpdateValue ActivityStateEnum: title: Activity state enum: - Deleted - Active type: string description: ' Deleted Active' x-enumNames: - Deleted - Active x-enumDescriptions: - '' - '' ActivityState: title: Activity state enum: - Deleted - Active type: string ProductCategory: title: Product category required: - CreatedUtc - Descriptions - EnterpriseId - Id - Names - Ordering - ServiceId - ShortNames - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the product category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the enterprise to which the product category belongs. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service` of the resource category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 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 ParentProductCategory: title: Parent product category allOf: - $ref: '#/components/schemas/ParentProductCategory' description: Parent product category, if set. nullable: true example: string UpdatedUtc: minLength: 1 type: string description: Date and time of the product category update in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' CreatedUtc: minLength: 1 type: string description: Date and time of the product category creation in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' 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 example: 1 additionalProperties: false x-schema-id: ProductCategory VoucherResult: title: VoucherResult type: object properties: Vouchers: type: array items: $ref: '#/components/schemas/Voucher' description: Details about vouchers added to the system. nullable: true VoucherCodes: type: array items: $ref: '#/components/schemas/VoucherCode' description: Information about voucher codes used by customers. nullable: true VoucherAssignments: type: array items: $ref: '#/components/schemas/VoucherAssignment' description: The assignments between vouchers and [Rates](https://mews-systems.gitbook.io/connector-api/operations/rates/#rate). nullable: true Rates: type: array items: $ref: '#/components/schemas/RateForExtent' description: The assigned rates. nullable: true Companies: type: array items: $ref: '#/components/schemas/Company' description: The related companies and travel agencies. nullable: true 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: VoucherResult ProductPostingModeEnum: title: Product posting mode enum: - Once - PerTimeUnit type: string description: ' Once PerTimeUnit' x-enumNames: - Once - PerTimeUnit x-enumDescriptions: - '' - '' ProductCategoryResult: title: ProductCategoryResult required: - ProductCategories type: object properties: ProductCategories: maxItems: 1000 type: array items: $ref: '#/components/schemas/ProductCategory' description: Product categories. Cursor: type: string description: Unique identifier of the last product category returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of product categories. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ProductCategoryResult 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 example: EUR NetValue: type: number description: Net value without taxes. format: double example: 100.0 GrossValue: type: number description: Gross value including all taxes. format: double example: 100.0 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. example: string additionalProperties: false description: '' x-schema-id: Amount ServiceOrderNoteDeleteParameters: title: ServiceOrderNoteDeleteParameters required: - AccessToken - Client - ClientToken - ServiceOrderNoteIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ServiceOrderNoteIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the service order notes to be deleted. additionalProperties: false x-schema-id: ServiceOrderNoteDeleteParameters ServiceAvailabilityUpdateData: title: Availability update required: - FirstTimeUnitStartUtc - LastTimeUnitStartUtc - ResourceCategoryId - UnitCountAdjustment type: object properties: FirstTimeUnitStartUtc: minLength: 1 type: string description: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' LastTimeUnitStartUtc: minLength: 1 type: string description: 'End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service''s [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units): 367 hours if hours, 367 days if days, or 60 months if months.' format: date-time example: '2026-06-02T14:30:00Z' StartUtc: type: string format: date-time nullable: true deprecated: true example: '2026-06-02T14:30:00Z' EndUtc: type: string format: date-time nullable: true deprecated: true example: '2026-06-02T14:30:00Z' ResourceCategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/resources#resource-category) whose availability to update. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UnitCountAdjustment: title: Int32 update value allOf: - $ref: '#/components/schemas/Int32NullableUpdateValue' description: Adjustment value to be applied on the interval, can be both positive and negative (relative adjustment, not an absolute number). If specified without `Value` parameter, removes all adjustments within the interval. example: string AvailabilityBlockId: type: string description: Unique identifier of the [Availability block](https://mews-systems.gitbook.io/connector-api/operations/availabilityblocks#availability-block) whose availability to update. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PaxCounts: maxItems: 5 type: array items: $ref: '#/components/schemas/PaxCount' description: Collection of predicted occupancy of availability adjustments. Relates how many adjustments are assigned to each count of guests. nullable: true additionalProperties: false x-schema-id: ServiceAvailabilityUpdateData ServiceOrder: title: Product service order required: - AccountId - AccountType - CreatedUtc - CreatorProfileId - Id - Number - Options - Origin - ServiceId - State - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the product service order format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service` that product service order is made against. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the Customer or Company who owns the product service order. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountType: allOf: - $ref: '#/components/schemas/AccountTypeEnum' description: 'A discriminator specifying the type of account, e.g. `Customer` or `Company`. Company Customer' example: string CreatorProfileId: type: string description: Unique identifier of the user who created the product service order. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UpdaterProfileId: type: string description: Unique identifier of the user who updated the product service order. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BookerId: type: string description: Unique identifier of the Customer on whose behalf the service order was made. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Number: minLength: 1 type: string description: Confirmation number of the service order in Mews. example: '1001' State: title: Service order state allOf: - $ref: '#/components/schemas/ServiceOrderStateEnum' description: 'State of the product service order. 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). example: string Origin: title: Service order origin allOf: - $ref: '#/components/schemas/ServiceOrderOriginEnum' description: 'Origin of the product service order. 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. example: string 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 example: string OriginDetails: type: string description: Details about the product service order Origin. nullable: true example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the product service order in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the product service order in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' CancelledUtc: type: string description: Cancellation date and time in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' VoucherId: type: string description: Unique identifier of the Voucher that has been used to create product service order. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BusinessSegmentId: type: string description: Identifier of the Business segment. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 LinkedReservationId: type: string description: Identifier of the linked Reservation. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Options: title: Service order options allOf: - $ref: '#/components/schemas/ServiceOrderOptions' description: Options of the service order. example: string additionalProperties: false x-schema-id: ServiceOrder VoucherTypeEnum: title: Voucher Type enum: - Public - PartnerCompany - TravelAgency type: string description: ' Public PartnerCompany TravelAgency' x-enumNames: - Public - PartnerCompany - TravelAgency x-enumDescriptions: - '' - '' - '' MultipleVoucherUpdateParameters: title: MultipleVoucherUpdateParameters required: - AccessToken - Client - ClientToken - VoucherUpdates type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/VoucherUpdateParameters' description: Details of voucher updates. additionalProperties: false x-schema-id: MultipleVoucherUpdateParameters ProductDeleteParameters: title: Product delete parameters required: - AccessToken - Client - ClientToken - ProductIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProductIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of the products to delete. additionalProperties: false x-schema-id: ProductDeleteParameters ProductClassifications: title: Product classifications type: object properties: Food: type: boolean description: Product is classified as food. example: true Beverage: type: boolean description: Product is classified as beverage. example: true Wellness: type: boolean description: Product is classified as wellness. example: true CityTax: type: boolean description: Product is classified as city tax. example: true Fee: type: boolean description: Product is classified as fee. example: true additionalProperties: false description: '' x-schema-id: ProductClassifications RateTypeEnum: title: Rate type enum: - Public - Private - AvailabilityBlock type: string description: ' Public Private AvailabilityBlock' x-enumNames: - Public - Private - AvailabilityBlock x-enumDescriptions: - '' - '' - '' ServiceOrderNoteUpdateParameters: title: Service order note update parameters required: - ServiceOrderNoteId type: object properties: ServiceOrderNoteId: type: string description: Unique identifier of the `Service order note`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Text: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Content of the service order note (or `null` if the content should not be updated). nullable: true example: string additionalProperties: false x-schema-id: ServiceOrderNoteUpdateParameters ProductCategoryFilterParameters: title: ProductCategoryFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ServiceIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ProductCategoryIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `ProductCategory`. nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Service` to which the product categories belong. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the product categories were updated. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: ProductCategoryFilterParameters ResourceAvailabilityMetricTypeEnum: title: Service availability metrics enum: - OutOfOrderBlocks - PublicAvailabilityAdjustment - OtherServiceReservationCount - Occupied - ConfirmedReservations - OptionalReservations - BlockAvailability - AllocatedBlockAvailability - UsableResources - ActiveResources - HouseUse type: string description: ' OutOfOrderBlocks (Number of resources that are out of order for the resource category (see `Resource Block`).) PublicAvailabilityAdjustment (Number of resources marked as manual availability adjustments.) OtherServiceReservationCount (Number of resources occupied by another service.) Occupied (Number of bookings that have been assigned to the resource category (i.e. reservations and blocks).) ConfirmedReservations (Number of confirmed reservations that have been assigned to the resource category.) OptionalReservations (Number of optional reservations that have been assigned to the resource category.) BlockAvailability (Number of blocked resources (from an availability block / allotment).) AllocatedBlockAvailability (Number of blocked resources that are in a deducting state (from an availability block / allotment).) UsableResources (Number of usable resources (i.e. which are not out of order).) ActiveResources (Number of active resources.) HouseUse (Number of resources marked as house use (internal use).)' x-enumNames: - OutOfOrderBlocks - PublicAvailabilityAdjustment - OtherServiceReservationCount - Occupied - ConfirmedReservations - OptionalReservations - BlockAvailability - AllocatedBlockAvailability - UsableResources - ActiveResources - HouseUse x-enumDescriptions: - Number of resources that are out of order for the resource category (see `Resource Block`). - Number of resources marked as manual availability adjustments. - Number of resources occupied by another service. - Number of bookings that have been assigned to the resource category (i.e. reservations and blocks). - Number of confirmed reservations that have been assigned to the resource category. - Number of optional reservations that have been assigned to the resource category. - Number of blocked resources (from an availability block / allotment). - Number of blocked resources that are in a deducting state (from an availability block / allotment). - Number of usable resources (i.e. which are not out of order). - Number of active resources. - Number of resources marked as house use (internal use). MultipleVoucherAddParameters: title: MultipleVoucherAddParameters required: - AccessToken - Client - ClientToken - VoucherParameters type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherParameters: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/VoucherAddParameters' description: Vouchers to be added. additionalProperties: false x-schema-id: MultipleVoucherAddParameters VoucherFilterParameters: title: VoucherFilterParameters required: - AccessToken - Client - ClientToken - Extent - Limitation - ServiceIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 Extent: title: Voucher Extent allOf: - $ref: '#/components/schemas/VoucherExtent' description: Extent of data to be returned. Whether only specific voucher info should be returned or related items as well. example: string ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service) where the vouchers belong to. VoucherIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of vouchers. nullable: true CompanyIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the companies. nullable: true VoucherCodeValues: maxItems: 1000 minItems: 1 type: array items: type: string description: Value of voucher codes used by customers. nullable: true ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted records will be returned. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the vouchers were updated. nullable: true x-max-interval-in-months: 3 example: string ExternalIdentifiers: maxItems: 1000 minItems: 1 type: array items: type: string description: Identifiers of [Voucher](https://mews-systems.gitbook.io/connector-api/operations/#voucher) from external systems. nullable: true additionalProperties: false x-schema-id: VoucherFilterParameters OrderNote: title: Service order note type: object properties: Id: type: string description: Unique identifier of the service order note. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 OrderId: type: string description: Unique identifier of the `Service order` to which the Service Order Note belongs. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Text: type: string description: Content of the service order note. nullable: true example: string 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: - '' - '' - '' example: string 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 example: '2026-06-02T14:30:00Z' 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 example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: OrderNote ParentProductCategory: title: Parent product category required: - Id - Names type: object properties: Id: type: string description: Unique identifier of the product category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings additionalProperties: false description: '' x-schema-id: ParentProductCategory ServiceAvailabilityFilterParameters: title: ServiceAvailabilityFilterParameters required: - AccessToken - Client - ClientToken - FirstTimeUnitStartUtc - LastTimeUnitStartUtc - ServiceId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/#service) whose availability should be returned. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 FirstTimeUnitStartUtc: minLength: 1 type: string description: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' LastTimeUnitStartUtc: minLength: 1 type: string description: 'End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service''s [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/): 367 hours if hours, 367 days if days, or 60 months if months.' format: date-time example: '2026-06-02T14:30:00Z' StartUtc: type: string format: date-time nullable: true deprecated: true example: '2026-06-02T14:30:00Z' EndUtc: type: string format: date-time nullable: true deprecated: true example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ServiceAvailabilityFilterParameters ProductPriceUpdateParameters: title: Product price update parameters required: - AccessToken - Client - ClientToken - PriceUpdates - ProductId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProductId: minLength: 1 type: string description: Unique identifier of the `Product`. x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PriceUpdates: maxItems: 100 minItems: 1 type: array items: $ref: '#/components/schemas/ProductPriceUpdate' description: Price adjustments for specific time intervals. additionalProperties: false x-schema-id: ProductPriceUpdateParameters ServiceOverbookingLimit: title: Service overbooking limit required: - CreatedUtc - FirstTimeUnitStartUtc - Id - IsActive - LastTimeUnitStartUtc - Limit - ServiceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the service overbooking limit. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 FirstTimeUnitStartUtc: minLength: 1 type: string description: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' LastTimeUnitStartUtc: minLength: 1 type: string description: End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' Limit: type: integer description: Number of overbookings allowed for the `Service`. format: int32 example: 1 CreatedUtc: minLength: 1 type: string description: Timestamp in UTC timezone ISO 8601 format when the service overbooking was created. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Timestamp in UTC timezone ISO 8601 format when the service overbooking was updated. format: date-time example: '2026-06-02T14:30:00Z' IsActive: type: boolean description: Whether the service overbooking limit is still active. example: true additionalProperties: false x-schema-id: ServiceOverbookingLimit ServiceOverbookingLimitClearData: title: Service overbooking limits clear parameters required: - FirstTimeUnitStartUtc - LastTimeUnitStartUtc type: object properties: FirstTimeUnitStartUtc: minLength: 1 type: string description: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' LastTimeUnitStartUtc: minLength: 1 type: string description: 'End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service''s time unit: 367 hours if hours, 367 days if days, or 60 months if months.' format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ServiceOverbookingLimitClearData Voucher: title: Voucher required: - ActivityState - CreatedUtc - EnterpriseId - Id - IsActive - Name - ServiceId - Type - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of voucher. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service) the voucher belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the enterprise to which the voucher belongs. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: maxLength: 128 minLength: 1 type: string description: Internal name of the voucher. example: Example Name CreatedUtc: minLength: 1 type: string description: Creation date and time of the voucher in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the voucher in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' Type: title: Voucher Type allOf: - $ref: '#/components/schemas/VoucherTypeEnum' description: 'Type of the voucher. Public PartnerCompany TravelAgency' x-enumNames: - Public - PartnerCompany - TravelAgency x-enumDescriptions: - '' - '' - '' example: string ActivityState: title: Activity state allOf: - $ref: '#/components/schemas/ActivityStateEnum' description: 'Whether voucher is active or deleted. Deleted Active' deprecated: true x-enumNames: - Deleted - Active x-enumDescriptions: - '' - '' x-deprecatedMessage: Use `IsActive` instead. example: string CompanyId: type: string description: Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) the voucher is related to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: type: string description: Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) with [Travel agency contract](https://mews-systems.gitbook.io/connector-api/operations/companycontracts/#travel-agency-contract) the voucher is related to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 OccupiableIntervalStartUtc: type: string description: Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' OccupiableIntervalEndUtc: type: string description: End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ExternalIdentifier: maxLength: 255 type: string description: Identifier of the voucher from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the voucher is still active. example: true additionalProperties: false x-schema-id: Voucher VoucherAssignment: title: Voucher assignment type: object properties: VoucherId: type: string description: Unique identifier of [Voucher](https://mews-systems.gitbook.io/connector-api/operations/#voucher). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateId: type: string description: Unique identifier of [Rate](https://mews-systems.gitbook.io/connector-api/operations/rates/#rate) the voucher is assigned with. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: VoucherAssignment 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: - '' - '' - '' - '' ProductServiceOrderFilterParameters: title: ProductServiceOrderFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ServiceIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ProductServiceOrderIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Product service order. nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Service`. AccountIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Customer or Company who owns the product service order. nullable: true LinkedReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of linked Reservations. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the Product service orders were updated. nullable: true x-max-interval-in-months: 3 example: string States: type: array items: $ref: '#/components/schemas/ServiceOrderState' description: A list of product service order states to filter by. nullable: true additionalProperties: false x-schema-id: ProductServiceOrderFilterParameters VoucherAddParameters: title: Voucher Parameters required: - Name - ServiceId - Type type: object properties: ServiceId: type: string description: Unique identifier of Service. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: maxLength: 128 minLength: 1 type: string description: Internal name of the voucher. example: Example Name Type: title: Voucher Type allOf: - $ref: '#/components/schemas/VoucherTypeEnum' description: 'Type of the voucher. Public PartnerCompany TravelAgency' x-enumNames: - Public - PartnerCompany - TravelAgency x-enumDescriptions: - '' - '' - '' example: string CompanyId: type: string description: Unique identifier of Company. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedRateIds: maxItems: 10 uniqueItems: true type: array items: type: string format: uuid description: Unique identifiers of Rates. nullable: true OccupiableIntervalStartUtc: type: string description: Start of the interval in which the voucher can be applied. format: date-time nullable: true example: '2026-06-02T14:30:00Z' OccupiableIntervalEndUtc: type: string description: End of the interval in which the voucher can be applied. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ExternalIdentifier: maxLength: 255 type: string description: Identifier of the voucher from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: VoucherAddParameters OldAddress: title: Address type: object properties: Id: type: string description: Unique identifier of the address. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Line1: type: string description: First line of the address. nullable: true example: string Line2: type: string description: Second line of the address. nullable: true example: string City: type: string description: The city. nullable: true example: string PostalCode: type: string description: Postal code. nullable: true example: string CountryCode: type: string description: ISO 3166-1 code of the `Country`. nullable: true example: string CountrySubdivisionCode: type: string description: ISO 3166-2 code of the administrative division, e.g. `DE-BW`. nullable: true example: string Latitude: type: number description: The latitude. format: double nullable: true example: 100.0 Longitude: type: number description: The longitude. format: double nullable: true example: 100.0 additionalProperties: false description: '' x-schema-id: OldAddress ServiceOrderNoteResult: title: ServiceOrderNoteResult required: - ServiceOrderNotes type: object properties: ServiceOrderNotes: type: array items: $ref: '#/components/schemas/OrderNote' description: The collection of service order notes. Cursor: type: string description: Unique identifier of the last and hence oldest service order note 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 service order notes. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ServiceOrderNoteResult ResourceCategoryAvailabilityV20240122: title: Resource category availability (ver 2024-01-22) required: - Metrics - ResourceCategoryId type: object properties: ResourceCategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/resources#resource-category). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Metrics: title: ResourceAvailabilityMetricTypeInt32IEnumerableIDictionary type: object properties: OutOfOrderBlocks: type: array items: type: integer format: int32 PublicAvailabilityAdjustment: type: array items: type: integer format: int32 OtherServiceReservationCount: type: array items: type: integer format: int32 Occupied: type: array items: type: integer format: int32 ConfirmedReservations: type: array items: type: integer format: int32 OptionalReservations: type: array items: type: integer format: int32 BlockAvailability: type: array items: type: integer format: int32 AllocatedBlockAvailability: type: array items: type: integer format: int32 UsableResources: type: array items: type: integer format: int32 ActiveResources: type: array items: type: integer format: int32 HouseUse: type: array items: type: integer format: int32 additionalProperties: false description: Dictionary keys are names of [Service availability metrics](https://mews-systems.gitbook.io/connector-api/operations/services#service-availability-metrics), values are arrays of integers with metric values for corresponding time unit in `TimeUnitStartsUtc`. x-schema-id: ResourceAvailabilityMetricTypeInt32IEnumerableIDictionary additionalProperties: false x-schema-id: ResourceCategoryAvailabilityV20240122 TimeUnitPeriodEnum: title: Time unit period enum: - Day - Month - Hour type: string description: ' Day Month Hour' x-enumNames: - Day - Month - Hour x-enumDescriptions: - '' - '' - '' 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: - '' - '' - '' - '' Limitation: title: Limitation required: - Count type: object properties: Count: type: integer format: int32 example: 1 Cursor: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false description: Limitation on the quantity of data returned. x-schema-id: Limitation AdditionalServiceData: title: Additional service data required: - Promotions type: object properties: Promotions: allOf: - $ref: '#/components/schemas/Promotions' description: Promotions of the service. example: string additionalProperties: false x-schema-id: AdditionalServiceData ServiceOrderState: title: Service order state enum: - Inquired - Confirmed - Started - Processed - Canceled - Optional - Requested type: string 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). MultipleVoucherCodeDeleteParameters: title: MultipleVoucherCodeDeleteParameters required: - AccessToken - Client - ClientToken - VoucherCodeIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherCodeIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the voucher codes to be deleted. additionalProperties: false x-schema-id: MultipleVoucherCodeDeleteParameters 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 GroupId: type: string description: Unique identifier of `Rate Group` where the rate belongs. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BaseRateId: type: string description: Unique identifier of the base `Rate`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsBaseRate: type: boolean description: Whether the rate is a base rate. example: true BusinessSegmentId: type: string description: Unique identifier of the `Business Segment`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the rate is still active. example: true IsEnabled: type: boolean description: Whether the rate is currently available to customers. example: true IsPublic: type: boolean description: Whether the rate is publicly available. example: true Type: title: Rate type allOf: - $ref: '#/components/schemas/RateTypeEnum' description: 'Type of the rate. Public Private AvailabilityBlock' x-enumNames: - Public - Private - AvailabilityBlock x-enumDescriptions: - '' - '' - '' example: string Name: type: string description: Name of the rate (in the default language). nullable: true deprecated: true x-deprecatedMessage: Use `Names` instead example: Example Name 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 example: Example Name UpdatedUtc: minLength: 1 type: string description: Interval in which the rates were updated. format: date-time example: '2026-06-02T14:30:00Z' 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false description: '`Rate` entity, without some of the details, e.g. pricing.' x-schema-id: RateForExtent ServiceAvailabilityUpdateParameters: title: ServiceAvailabilityUpdateParameters required: - AccessToken - AvailabilityUpdates - Client - ClientToken - ServiceId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/#service) to update. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AvailabilityUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ServiceAvailabilityUpdateData' description: Availability updates. additionalProperties: false x-schema-id: ServiceAvailabilityUpdateParameters CompanyOptions: title: Company Options type: object properties: Invoiceable: type: boolean description: Whether the company is invoiceable or not. example: true AddFeesToInvoices: type: boolean description: Whether the company has an additional fee applied for invoicing or not. example: true AddTaxDeductedPaymentToInvoices: type: boolean description: Whether tax-deducted payments should be automatically added to invoices. example: true additionalProperties: false description: Options of the company. x-schema-id: CompanyOptions ServiceOrderOptions: title: Service Order Options required: - AllCompanionsCheckedIn - AnyCompanionCheckedIn - ConnectorCheckIn - OwnerCheckedIn type: object properties: OwnerCheckedIn: type: boolean description: Owner of the reservation checked in. example: true AllCompanionsCheckedIn: type: boolean description: All companions of the reservation checked in. example: true AnyCompanionCheckedIn: type: boolean description: Any of the companions of the reservation checked in. example: true ConnectorCheckIn: type: boolean description: Check in was done via Connector API. example: true additionalProperties: false x-schema-id: ServiceOrderOptions 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 example: string NetValue: type: number description: The net value that the tax is calculated from. format: double example: 100.0 TaxValue: type: number description: The value of the tax. format: double example: 100.0 additionalProperties: false x-schema-id: TaxBreakdownItem VoucherTypeUpdateValue: title: Voucher Type update value type: object properties: Value: title: Voucher Type allOf: - $ref: '#/components/schemas/VoucherTypeEnum' description: Value which is to be updated. x-enumNames: - Public - PartnerCompany - TravelAgency x-enumDescriptions: - '' - '' - '' example: string additionalProperties: false x-schema-id: VoucherTypeUpdateValue ServiceOrderNoteUpdateResult: title: ServiceOrderNoteUpdateResult required: - ServiceOrderNotes type: object properties: ServiceOrderNotes: type: array items: $ref: '#/components/schemas/OrderNote' description: Updated service order notes. additionalProperties: false x-schema-id: ServiceOrderNoteUpdateResult 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. example: true additionalProperties: false description: Options of the service. x-schema-id: ServiceOptions ServiceResult: title: ServiceResult required: - Services type: object properties: Services: type: array items: $ref: '#/components/schemas/Service' description: Services offered by 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ServiceResult TimeFilterInterval: title: Time interval type: object properties: StartUtc: type: string format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string format: date-time nullable: true example: '2026-06-02T14:30:00Z' 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 VoucherCodeAddParameters: title: Voucher code parameters required: - Value - VoucherId type: object properties: VoucherId: type: string description: Unique identifier of [Voucher](#voucher) the code belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Value: maxLength: 128 minLength: 1 type: string description: Value of voucher code used by customers. example: string ValidityStartUtc: type: string description: If specified, marks the beginning of interval in which the code can be used. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ValidityEndUtc: type: string description: If specified, marks the end of interval in which the code can be used. format: date-time nullable: true example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: VoucherCodeAddParameters ProductServiceOrderResult: title: ProductServiceOrderResult required: - ProductServiceOrders type: object properties: ProductServiceOrders: type: array items: $ref: '#/components/schemas/ServiceOrder' description: The collection of product service orders. 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ProductServiceOrderResult 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. ServiceOverbookingLimitResult: title: ServiceOverbookingLimitResult required: - ServiceOverbookingLimits type: object properties: ServiceOverbookingLimits: type: array items: $ref: '#/components/schemas/ServiceOverbookingLimit' description: Service overbooking limits of the default service. 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ServiceOverbookingLimitResult ServiceOverbookingLimitSetParameters: title: ServiceOverbookingLimitSetParameters required: - AccessToken - Client - ClientToken - ServiceId - SetServiceOverbookingLimits type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services#service) overbooking limits will be set in. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 SetServiceOverbookingLimits: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ServiceOverbookingLimitSetData' description: Collection of service overbooking limits to be set. additionalProperties: false x-schema-id: ServiceOverbookingLimitSetParameters ServiceDataDiscriminator: title: Service data discriminator enum: - Bookable - Additional type: string ServiceAvailabilityResult: title: ServiceAvailabilityResult required: - CategoryAvailabilities - TimeUnitStartsUtc type: object properties: DatesUtc: type: array items: type: string nullable: true deprecated: true TimeUnitStartsUtc: type: array items: type: string description: Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format. CategoryAvailabilities: type: array items: $ref: '#/components/schemas/CategoryAvailability' description: Resource category availabilities. additionalProperties: false x-schema-id: ServiceAvailabilityResult 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 example: string additionalProperties: false description: Credit rating to define creditworthiness of the company. x-schema-id: CreditRating 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the service is still active. example: true Name: minLength: 1 type: string description: Name of the service. deprecated: true x-deprecatedMessage: Use `Names` instead example: Example Name 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 example: string EndTime: type: string nullable: true deprecated: true example: string Options: title: Service options allOf: - $ref: '#/components/schemas/ServiceOptions' description: Options of the service. example: string Promotions: allOf: - $ref: '#/components/schemas/Promotions' description: '' nullable: true deprecated: true x-deprecatedMessage: Use `Promotions` in `Data` instead. example: string Type: type: string nullable: true deprecated: true example: string Ordering: type: integer description: Order value for presentation purposes. format: int32 example: 1 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the service in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the service in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false description: '' x-schema-id: Service AccountTypeEnum: title: Account type enum: - Company - Customer type: string description: 'A discriminator specifying the account type, e.g. `Customer` or `Company` Company Customer' x-enumNames: - Company - Customer x-enumDescriptions: - '' - '' VoucherWriteResult: title: VoucherWriteResult type: object properties: Vouchers: type: array items: $ref: '#/components/schemas/Voucher' description: Details about vouchers added to the system. nullable: true additionalProperties: false x-schema-id: VoucherWriteResult 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 ServiceOrderNoteAddParameters: title: Service order note parameters required: - ServiceOrderId - Text type: object properties: ServiceOrderId: type: string description: Unique identifier of the `Service order` to which note will be added. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Text: minLength: 1 type: string description: Content of the service order note. example: string additionalProperties: false x-schema-id: ServiceOrderNoteAddParameters MultipleServiceOrderNoteAddParameters: title: MultipleServiceOrderNoteAddParameters required: - AccessToken - Client - ClientToken - ServiceOrderNotes type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ServiceOrderNotes: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ServiceOrderNoteAddParameters' description: Notes to be added. additionalProperties: false x-schema-id: MultipleServiceOrderNoteAddParameters ServiceAvailabilityResultV20240122: title: ServiceAvailabilityResultV20240122 required: - ResourceCategoryAvailabilities - TimeUnitStartsUtc type: object properties: TimeUnitStartsUtc: type: array items: type: string description: Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format. format: date-time ResourceCategoryAvailabilities: type: array items: $ref: '#/components/schemas/ResourceCategoryAvailabilityV20240122' description: Resource category availabilities. Can be empty if no resource categories are assigned to the service. additionalProperties: false x-schema-id: ServiceAvailabilityResultV20240122 ConnectorApiExceptionResult: title: ConnectorApiExceptionResult type: object properties: Message: type: string nullable: true example: string RequestId: type: string nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: nullable: true example: string additionalProperties: false x-schema-id: ConnectorApiExceptionResult Int32NullableUpdateValue: title: Int32 update value type: object properties: Value: type: integer description: Value which is to be updated. format: int32 nullable: true example: 1 additionalProperties: false x-schema-id: Int32NullableUpdateValue ProductPriceUpdate: title: Product price update type: object properties: Value: type: number description: New value of the product on the interval. If not specified, removes all price adjustments within the interval. format: double nullable: true example: 100.0 FirstTimeUnitStartUtc: type: string description: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' LastTimeUnitStartUtc: type: string description: 'End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units), in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service''s time unit: 367 hours if hours, 367 days if days, or 24 months if months.' format: date-time nullable: true example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ProductPriceUpdate ProductPricingFilterParameters: title: Product pricing filter parameters required: - AccessToken - Client - ClientToken - FirstTimeUnitStartUtc - LastTimeUnitStartUtc - ProductId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ProductId: type: string description: Unique identifier of the product. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 FirstTimeUnitStartUtc: minLength: 1 type: string description: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' LastTimeUnitStartUtc: minLength: 1 type: string description: 'End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service''s [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/): 100 hours if hours, 100 days if days, or 24 months if months.' format: date-time example: '2026-06-02T14:30:00Z' 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 additionalProperties: false x-schema-id: ProductPricingFilterParameters ProductFilterParameters: title: Product parameters required: - AccessToken - Client - ClientToken - Limitation - ServiceIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ProductIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the product. 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). UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the products were updated. nullable: true x-max-interval-in-months: 3 example: string IncludeDefault: type: boolean description: Whether or not to include default products for the service, i.e. products which are standard includes and not true extras. For example, the night's stay would be the default product for a room reservation. These may be useful for accounting purposes but should not be displayed to customers for selection. If `ProductIds` are provided, `IncludeDefault` defaults to true, otherwise it defaults to false. nullable: true example: true additionalProperties: false x-schema-id: ProductFilterParameters CategoryAvailability: title: Resource category availability required: - Adjustments - Availabilities - CategoryId type: object properties: CategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/resources#resource-category). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Availabilities: type: array items: type: integer format: int32 description: Absolute availabilities of the resource category in the covered dates. Adjustments: type: array items: type: integer format: int32 description: Relative availability adjustments set for resource category in the covered dates. additionalProperties: false x-schema-id: CategoryAvailability ServiceOverbookingLimitFilterParameters: title: ServiceOverbookingLimitFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ServiceIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Service` associated with the service overbooking limits. ServiceOverbookingLimitIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the service overbooking limits. nullable: true CollidingUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the service overbooking limit is active. nullable: true example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the service overbooking limits were updated. nullable: true x-max-interval-in-months: 3 example: string ActivityStates: type: array items: $ref: '#/components/schemas/ActivityState' description: Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned. nullable: true additionalProperties: false x-schema-id: ServiceOverbookingLimitFilterParameters Unit: type: object additionalProperties: false MultipleVoucherDeleteParameters: title: MultipleVoucherDeleteParameters required: - AccessToken - Client - ClientToken - VoucherIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the vouchers to be deleted. additionalProperties: false x-schema-id: MultipleVoucherDeleteParameters ServiceOverbookingLimitClearParameters: title: ServiceOverbookingLimitClearParameters required: - AccessToken - ClearServiceOverbookingLimits - Client - ClientToken - ServiceId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services#service) overbooking limits will be set in. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ClearServiceOverbookingLimits: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ServiceOverbookingLimitClearData' description: Collection of service overbooking limits to be cleared. additionalProperties: false x-schema-id: ServiceOverbookingLimitClearParameters MultipleVoucherCodeAddParameters: title: MultipleVoucherCodeAddParameters required: - AccessToken - Client - ClientToken - VoucherCodeParameters type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherCodeParameters: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/VoucherCodeAddParameters' description: Voucher codes to be added. additionalProperties: false x-schema-id: MultipleVoucherCodeAddParameters ServiceDataDiscriminatorEnum: title: Service data discriminator enum: - Bookable - Additional type: string description: ' Bookable Additional' x-enumNames: - Bookable - Additional x-enumDescriptions: - '' - '' ProductResult: title: Product result required: - CustomerProducts - Products type: object properties: Products: type: array items: $ref: '#/components/schemas/Product' description: Products offered with the service. CustomerProducts: type: array items: $ref: '#/components/schemas/Product' description: Products offered specifically to customers. Cursor: type: string description: Unique identifier of the last and hence oldest product returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older products. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ProductResult TaxValue: title: Tax value required: - Value type: object properties: Code: type: string description: Code corresponding to tax type. nullable: true example: string Value: type: number description: Amount of tax applied. format: double example: 100.0 additionalProperties: false x-schema-id: TaxValue ProductAgeCategoryPrice: title: Age category price required: - AgeCategoryId - Prices type: object properties: AgeCategoryId: type: string description: Unique identifier of the age category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Prices: type: array items: $ref: '#/components/schemas/Amount' description: Prices of the product for the resource category in the covered dates. additionalProperties: false x-schema-id: ProductAgeCategoryPrice 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 example: EUR NetValue: type: number description: Net value without taxes. format: double example: 100.0 GrossValue: type: number description: Gross value including all taxes. format: double example: 100.0 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. example: string Value: type: number format: double nullable: true example: 100.0 Net: type: number format: double nullable: true example: 100.0 Tax: type: number format: double nullable: true example: 100.0 TaxRate: type: number format: double nullable: true example: 100.0 additionalProperties: false description: '' x-schema-id: ExtendedAmount VoucherExtent: title: Voucher Extent type: object properties: Vouchers: type: boolean description: Whether the response should contain main information about vouchers. nullable: true example: true VoucherCodes: type: boolean description: Whether the response should contain voucher codes used by customers. nullable: true deprecated: true x-deprecatedMessage: Use `voucherCodes/getAll` example: true VoucherAssignments: type: boolean description: Whether the response should contain assignments between vouchers and Rates. nullable: true example: true Companies: type: boolean description: Whether the response should contain detail of related companies. nullable: true deprecated: true x-deprecatedMessage: Use `companies/getAll` example: true Rates: type: boolean description: Whether the response should contain detail of assigned rates. nullable: true example: true additionalProperties: false description: Extent of data to be returned. Whether only specific voucher info should be returned or related items as well. x-schema-id: VoucherExtent AssignedRateIds: title: Assigned rate ids type: object properties: Value: maxItems: 10 type: array items: type: string format: uuid description: Unique identifiers of Rates (or `null` should it not be updated). nullable: true additionalProperties: false description: Has same structure as [Array of strings update value](https://mews-systems.gitbook.io/connector-api/operations/_objects#array-of-strings-update-value). x-schema-id: AssignedRateIds 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 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: - '' - '' - '' - '' - '' - '' - '' - '' ProductPostingEnum: title: Product posting enum: - Once - Daily type: string description: ' Once Daily' x-enumNames: - Once - Daily x-enumDescriptions: - '' - '' 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. 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ChainId: type: string description: Unique identifier of the chain. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name of the company. example: Example Name MotherCompanyId: type: string description: Unique identifier of mother company. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 InvoicingEmail: type: string description: Email for issuing invoices to the company. format: email nullable: true example: partner@example.com WebsiteUrl: type: string description: The website url of the company. format: uri nullable: true example: https://api.mews.com/api/connector/v1 InvoiceDueInterval: type: string description: The maximum time, when the invoice has to be be paid in ISO 8601 duration format. nullable: true example: string Options: title: Company Options allOf: - $ref: '#/components/schemas/CompanyOptions' description: Options of the company. example: string CreditRating: title: Credit Rating allOf: - $ref: '#/components/schemas/CreditRating' description: Credit rating to define creditworthiness of the company. example: string Department: type: string description: The internal segmentation of a company, e.g. sales department. nullable: true example: string DunsNumber: type: string description: The Dun & Bradstreet unique 9-digit DUNS number. nullable: true example: '1001' ReferenceIdentifier: type: string description: External system identifier - custom identifier used by an external system such as an external database. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCode: type: string description: Accounting code of the company. nullable: true example: string AdditionalTaxIdentifier: type: string description: Additional tax identifier of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillingCode: type: string description: Billing code of the company. nullable: true example: string Contact: type: string description: Other contact details, such as telephone, email or similar. nullable: true example: string ContactPerson: type: string description: Contact person of the company. nullable: true example: string ElectronicInvoiceIdentifier: type: string description: Electronic invoice identifier of the company. nullable: true deprecated: true x-deprecatedMessage: Use `AdditionalTaxIdentifier` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Identifier: type: string description: Fiscal or legal identifier of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Iata: type: string description: Iata of the company. nullable: true example: string IsActive: type: boolean description: Whether the company is still active. example: true Notes: type: string description: Additional notes. nullable: true example: string Number: type: integer description: Unique number of the company (max 19 digits). format: int64 example: 1 TaxIdentifier: type: string description: Tax identification number of the company. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Telephone: type: string description: Contact telephone number. format: tel nullable: true example: string 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 example: '2026-06-02T14:30:00Z' 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 example: '2026-06-02T14:30:00Z' Address: title: Address allOf: - $ref: '#/components/schemas/OldAddress' description: '' nullable: true deprecated: true x-deprecatedMessage: Use AddressId instead. example: string 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 example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 MergeTargetId: type: string description: Unique identifier of the account (Customer) to which this company is linked. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TaxIdentificationNumber: type: string nullable: true deprecated: true x-deprecatedMessage: Use TaxIdentifier instead. example: '1001' ExternalIdentifier: maxLength: 255 type: string description: Identifier of company from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: Company ProductPricing: title: Product pricing data discriminator enum: - Absolute - Relative type: string description: '' ProductOptions: title: Product options required: - BillAsPackage - ExcludePriceFromOffer type: object properties: BillAsPackage: type: boolean description: Product should be displayed as part of a package. example: true ExcludePriceFromOffer: type: boolean description: Product's price should not be displayed separately on the offer. example: true additionalProperties: false description: '' x-schema-id: ProductOptions ActivityStates: title: Activity state enum: - Deleted - Active type: string description: Activity states used for filtering. VoucherCode: title: Voucher code required: - ActivityState - Id - IsActive - VoucherId type: object properties: Id: type: string description: Unique identifier of the voucher code. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherId: type: string description: Unique identifier of `Voucher` the code belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Value: type: string description: Value of voucher code used by customers. nullable: true example: string ValidityStartUtc: type: string description: If specified, marks the beginning of interval in which the code can be used. nullable: true example: string ValidityEndUtc: type: string description: If specified, marks the end of interval in which the code can be used. nullable: true example: string CreatedUtc: type: string description: Creation date and time of the voucher in UTC timezone in ISO 8601 format. nullable: true example: string UpdatedUtc: type: string description: Last update date and time of the voucher in UTC timezone in ISO 8601 format. nullable: true example: string ActivityState: title: Activity state allOf: - $ref: '#/components/schemas/ActivityStateEnum' description: 'Whether voucher code is active or deleted. Deleted Active' deprecated: true x-enumNames: - Deleted - Active x-enumDescriptions: - '' - '' x-deprecatedMessage: Use `IsActive` instead. example: string IsActive: type: boolean description: Whether the voucher code is still active. example: true additionalProperties: false x-schema-id: VoucherCode MultipleServiceOrderNoteUpdateParameters: title: MultipleServiceOrderNoteUpdateParameters required: - AccessToken - Client - ClientToken - ServiceOrderNoteUpdates type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ServiceOrderNoteUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ServiceOrderNoteUpdateParameters' description: Notes to be updated. additionalProperties: false x-schema-id: MultipleServiceOrderNoteUpdateParameters securitySchemes: MewsClientToken: type: apiKey in: header name: ClientToken description: Mews authentication is performed by supplying ClientToken, AccessToken and Client as fields in the JSON request body (not as HTTP headers). This securityScheme is a tooling-compatible representation of the ClientToken credential. ClientToken is unique to your application and identifies the API client. MewsAccessToken: type: apiKey in: header name: AccessToken description: Tooling-compatible representation of the AccessToken credential, which is supplied in the JSON request body. AccessToken is unique to the connection with a property (enterprise) and identifies the property or properties whose data and services you can access. Portfolio Access Tokens enable multi-property access with a single token. servers: - url: https://api.mews.com description: Production - url: https://api.mews-demo.com description: Demo / sandbox security: - MewsClientToken: [] MewsAccessToken: [] tags: - name: Product categories - name: Product service orders - name: Products - name: Service order notes - name: Service overbooking limits - name: Services - name: Voucher codes - name: Vouchers