openapi: 3.0.4 info: title: Mews Connector API — Reservations and Availability description: General-purpose API that enables partners of Mews to access data and services in Mews Operations This modular spec covers the Reservations and Availability domain (44 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/availabilityAdjustments/getAll: post: tags: - Availability adjustments summary: Mews Get All Availability Adjustments description: 'Returns all availability adjustments. 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: availabilityAdjustments_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/AvailabilityAdjustmentParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AvailabilityAdjustmentIds: - e19297af-373e-4701-b4ea-afae0129bded - 7413724a-6c48-46d4-ab3a-afae01280999 UpdatedUtc: StartUtc: '2023-02-18T18:00:10.155Z' EndUtc: '2023-02-20T18:00:10.155Z' ActivityStates: - Active - Deleted 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/AvailabilityAdjustmentResult' example: AvailabilityAdjustments: - Id: e19297af-373e-4701-b4ea-afae0129bded AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f StartUtc: EndUtc: FirstTimeUnitStartUtc: '2021-10-14T00:00:00Z' LastTimeUnitStartUtc: '2021-10-17T00:00:00Z' UnitCount: 6 ActivityState: Active ReleaseOverrideUtc: '2021-10-13T00:00:00Z' UpdatedUtc: '2021-10-21T13:32:32Z' IsActive: false PaxCounts: FirstTimeUnitReleaseUtc: '2021-10-13T00:00:00Z' - Id: 7413724a-6c48-46d4-ab3a-afae01280999 AvailabilityBlockId: ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f StartUtc: EndUtc: FirstTimeUnitStartUtc: '2023-02-19T23:00:00Z' LastTimeUnitStartUtc: '2023-02-23T23:00:00Z' UnitCount: 5 ActivityState: Deleted ReleaseOverrideUtc: UpdatedUtc: '2023-02-28T23:00:00Z' IsActive: false PaxCounts: FirstTimeUnitReleaseUtc: Cursor: 7413724a-6c48-46d4-ab3a-afae01280999 '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: AvailabilityAdjustmentsGetAll400Example: summary: Default availabilityAdjustments_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: AvailabilityAdjustmentsGetAll401Example: summary: Default availabilityAdjustments_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: AvailabilityAdjustmentsGetAll403Example: summary: Default availabilityAdjustments_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: AvailabilityAdjustmentsGetAll408Example: summary: Default availabilityAdjustments_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: AvailabilityAdjustmentsGetAll204Example: summary: Default availabilityAdjustments_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: AvailabilityAdjustmentsGetAll429Example: summary: Default availabilityAdjustments_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: AvailabilityAdjustmentsGetAll500Example: summary: Default availabilityAdjustments_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/availabilityBlocks/delete: post: tags: - Availability blocks summary: Mews Delete Availability Blocks description: Delete availability blocks. Note that an availability block containing active reservations (reservations which are not Canceled) cannot be deleted. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: availabilityBlocks_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/AvailabilityBlockDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AvailabilityBlockIds: - 5ee074b1-6c86-48e8-915f-c7aa4702086f - c32386aa-1cd2-414a-a823-489325842fbe EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: AvailabilityBlocksDelete200Example: summary: Default availabilityBlocks_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: AvailabilityBlocksDelete400Example: summary: Default availabilityBlocks_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: AvailabilityBlocksDelete401Example: summary: Default availabilityBlocks_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: AvailabilityBlocksDelete403Example: summary: Default availabilityBlocks_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: AvailabilityBlocksDelete408Example: summary: Default availabilityBlocks_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: AvailabilityBlocksDelete204Example: summary: Default availabilityBlocks_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: AvailabilityBlocksDelete429Example: summary: Default availabilityBlocks_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: AvailabilityBlocksDelete500Example: summary: Default availabilityBlocks_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/availabilityBlocks/getAll: post: tags: - Availability blocks summary: Mews Get All Availability Blocks description: Returns all availability blocks filtered by services, unique identifiers and other filters. 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: availabilityBlocks_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/AvailabilityBlockParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Extent: AvailabilityBlocks: true Adjustments: true ServiceOrders: false Rates: false ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 AvailabilityBlockIds: - 5ee074b1-6c86-48e8-915f-c7aa4702086f CreatedUtc: StartUtc: '2020-11-04T00:00:00Z' EndUtc: '2020-11-05T00:00:00Z' UpdatedUtc: StartUtc: '2020-11-04T00:00:00Z' EndUtc: '2020-11-05T00:00:00Z' CollidingUtc: StartUtc: '2020-11-04T00:00:00Z' EndUtc: '2020-11-05T00:00:00Z' ReleasedUtc: StartUtc: '2020-11-04T00:00:00Z' EndUtc: '2020-11-05T00:00:00Z' ExternalIdentifiers: - Block-0001 States: - Confirmed ActivityStates: - Active Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AvailabilityBlockResult' example: AvailabilityBlocks: - Id: 5ee074b1-6c86-48e8-915f-c7aa4702086f EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 CompanyId: TravelAgencyId: Budget: Currency: USD Value: 48.0 Net: Tax: TaxRate: State: Confirmed ReservationPurpose: Leisure CreatedUtc: '2020-11-04T13:00:00Z' UpdatedUtc: '2020-11-04T13:00:00Z' FirstTimeUnitStartUtc: '2020-11-04T13:00:00Z' LastTimeUnitStartUtc: '2020-11-04T13:00:00Z' ReleasedUtc: '2020-11-04T13:00:00Z' RollingReleaseOffset: ExternalIdentifier: Block-0001 Name: Wedding group Notes: Have a nice stay PickupDistribution: AllInOneGroup IsActive: false QuoteId: AvailabilityBlockNumber: '478' ReleaseStrategy: FixedRelease PurchaseOrderNumber: XX-123 BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed CanceledUtc: CancellationReason: CancellationReasonDetail: - Id: c32386aa-1cd2-414a-a823-489325842fbe EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 CompanyId: TravelAgencyId: Budget: Currency: USD Value: 48.0 Net: Tax: TaxRate: State: Confirmed ReservationPurpose: Leisure CreatedUtc: '2022-10-11T13:32:32Z' UpdatedUtc: '2022-10-11T13:32:32Z' FirstTimeUnitStartUtc: '2022-10-14T00:00:00Z' LastTimeUnitStartUtc: '2022-11-17T00:00:00Z' ReleasedUtc: RollingReleaseOffset: P-3DT4H ExternalIdentifier: Block-0002 Name: Rolling release Notes: PickupDistribution: AllInOneGroup IsActive: false QuoteId: 67eaf3c8-81e0-4ffb-b5f2-2b61803feb9c AvailabilityBlockNumber: '479' ReleaseStrategy: RollingRelease PurchaseOrderNumber: BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed CanceledUtc: CancellationReason: CancellationReasonDetail: ServiceOrders: Adjustments: - Id: e19297af-373e-4701-b4ea-afae0129bded AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f StartUtc: EndUtc: FirstTimeUnitStartUtc: '2021-10-14T00:00:00Z' LastTimeUnitStartUtc: '2021-10-17T00:00:00Z' UnitCount: 6 ActivityState: Active ReleaseOverrideUtc: '2021-10-13T00:00:00Z' UpdatedUtc: '2021-10-21T13:32:32Z' IsActive: false PaxCounts: FirstTimeUnitReleaseUtc: '2021-10-13T00:00:00Z' Rates: Cursor: c32386aa-1cd2-414a-a823-489325842fbe '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: AvailabilityBlocksGetAll400Example: summary: Default availabilityBlocks_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: AvailabilityBlocksGetAll401Example: summary: Default availabilityBlocks_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: AvailabilityBlocksGetAll403Example: summary: Default availabilityBlocks_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: AvailabilityBlocksGetAll408Example: summary: Default availabilityBlocks_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: AvailabilityBlocksGetAll204Example: summary: Default availabilityBlocks_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: AvailabilityBlocksGetAll429Example: summary: Default availabilityBlocks_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: AvailabilityBlocksGetAll500Example: summary: Default availabilityBlocks_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/availabilityBlocks/add: post: tags: - Availability blocks summary: Mews Add Availability Blocks description: Adds availability blocks which are used to group related `Availability updates`. This makes limiting public availability easier and more organized. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: availabilityBlocks_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleAvailabilityBlockAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 AvailabilityBlocks: - ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda FirstTimeUnitStartUtc: '2020-11-05T00:00:00Z' LastTimeUnitStartUtc: '2020-11-06T00:00:00Z' ReleasedUtc: '2020-11-04T00:00:00Z' Name: Mr. Smith's block Budget: Currency: USD Value: 48.0 ExternalIdentifier: Block-0001 State: Confirmed - ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda FirstTimeUnitStartUtc: '2021-11-05T00:00:00Z' LastTimeUnitStartUtc: '2021-11-06T00:00:00Z' Name: Rolling release block Budget: Currency: USD Value: 48.0 ExternalIdentifier: Block-0002 State: Confirmed EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AvailabilityBlockAddResult' example: AvailabilityBlocks: - Id: 5ee074b1-6c86-48e8-915f-c7aa4702086f EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 CompanyId: TravelAgencyId: Budget: Currency: USD Value: 48.0 Net: Tax: TaxRate: State: Confirmed ReservationPurpose: Leisure CreatedUtc: '2020-11-04T13:00:00Z' UpdatedUtc: '2020-11-04T13:00:00Z' FirstTimeUnitStartUtc: '2020-11-04T13:00:00Z' LastTimeUnitStartUtc: '2020-11-04T13:00:00Z' ReleasedUtc: '2020-11-04T13:00:00Z' RollingReleaseOffset: ExternalIdentifier: Block-0001 Name: Wedding group Notes: Have a nice stay PickupDistribution: AllInOneGroup IsActive: false QuoteId: AvailabilityBlockNumber: '478' ReleaseStrategy: FixedRelease PurchaseOrderNumber: XX-123 BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed CanceledUtc: CancellationReason: CancellationReasonDetail: - Id: c32386aa-1cd2-414a-a823-489325842fbe EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 CompanyId: TravelAgencyId: Budget: Currency: USD Value: 48.0 Net: Tax: TaxRate: State: Confirmed ReservationPurpose: Leisure CreatedUtc: '2022-10-11T13:32:32Z' UpdatedUtc: '2022-10-11T13:32:32Z' FirstTimeUnitStartUtc: '2022-10-14T00:00:00Z' LastTimeUnitStartUtc: '2022-11-17T00:00:00Z' ReleasedUtc: RollingReleaseOffset: P-3DT4H ExternalIdentifier: Block-0002 Name: Rolling release Notes: PickupDistribution: AllInOneGroup IsActive: false QuoteId: 67eaf3c8-81e0-4ffb-b5f2-2b61803feb9c AvailabilityBlockNumber: '479' ReleaseStrategy: RollingRelease PurchaseOrderNumber: BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed CanceledUtc: CancellationReason: CancellationReasonDetail: ServiceOrders: Adjustments: - Id: e19297af-373e-4701-b4ea-afae0129bded AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f StartUtc: EndUtc: FirstTimeUnitStartUtc: '2021-10-14T00:00:00Z' LastTimeUnitStartUtc: '2021-10-17T00:00:00Z' UnitCount: 6 ActivityState: Active ReleaseOverrideUtc: '2021-10-13T00:00:00Z' UpdatedUtc: '2021-10-21T13:32:32Z' IsActive: false PaxCounts: FirstTimeUnitReleaseUtc: '2021-10-13T00:00:00Z' Rates: Cursor: c32386aa-1cd2-414a-a823-489325842fbe '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: AvailabilityBlocksAdd400Example: summary: Default availabilityBlocks_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: AvailabilityBlocksAdd401Example: summary: Default availabilityBlocks_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: AvailabilityBlocksAdd403Example: summary: Default availabilityBlocks_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: AvailabilityBlocksAdd408Example: summary: Default availabilityBlocks_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: AvailabilityBlocksAdd204Example: summary: Default availabilityBlocks_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: AvailabilityBlocksAdd429Example: summary: Default availabilityBlocks_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: AvailabilityBlocksAdd500Example: summary: Default availabilityBlocks_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/availabilityBlocks/update: post: tags: - Availability blocks summary: Mews Update Availability Blocks description: Updates information about the specified `Availability block`. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: availabilityBlocks_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleAvailabilityBlockUpdateParameters' example: AvailabilityBlocks: - AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f Name: Value: Mr. Smith's block FirstTimeUnitStartUtc: Value: '2021-07-05T00:00:00Z' LastTimeUnitStartUtc: Value: '2021-07-15T00:00:00Z' ExternalIdentifier: Value: Block-1002 State: Value: Confirmed ReservationPurpose: Value: Business BookerId: Value: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 Notes: Value: Welcome to Washington Budget: Value: Currency: USD Value: 48.0 ReleasedUtc: Value: '2021-07-04T00:00:00Z' QuoteId: {} BusinessSegmentId: Value: dc9188f6-fb61-412c-b3fd-af32dab082ed - AvailabilityBlockId: c32386aa-1cd2-414a-a823-489325842fbe State: Value: Canceled CancellationReason: Value: ForceMajeure CancellationReasonDetail: Value: Event was canceled due to rain. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AvailabilityBlockAddResult' example: AvailabilityBlocks: - Id: 5ee074b1-6c86-48e8-915f-c7aa4702086f EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 CompanyId: TravelAgencyId: Budget: Currency: USD Value: 48.0 Net: Tax: TaxRate: State: Confirmed ReservationPurpose: Business CreatedUtc: '2020-11-04T13:00:00Z' UpdatedUtc: '2020-11-05T16:11:38Z' FirstTimeUnitStartUtc: '2021-07-05T00:00:00Z' LastTimeUnitStartUtc: '2021-07-15T00:00:00Z' ReleasedUtc: '2021-07-04T00:00:00Z' RollingReleaseOffset: ExternalIdentifier: Block-1002 Name: Mr. Smith's block Notes: Welcome to Washington PickupDistribution: AllInOneGroup IsActive: false QuoteId: AvailabilityBlockNumber: '478' ReleaseStrategy: FixedRelease PurchaseOrderNumber: XX-123 BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed CanceledUtc: CancellationReason: CancellationReasonDetail: - Id: c32386aa-1cd2-414a-a823-489325842fbe EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 CompanyId: TravelAgencyId: Budget: Currency: USD Value: 48.0 Net: Tax: TaxRate: State: Canceled ReservationPurpose: Leisure CreatedUtc: '2022-10-11T13:32:32Z' UpdatedUtc: '2022-10-11T13:32:32Z' FirstTimeUnitStartUtc: '2022-10-14T00:00:00Z' LastTimeUnitStartUtc: '2022-11-17T00:00:00Z' ReleasedUtc: RollingReleaseOffset: P-3DT4H ExternalIdentifier: Block-0002 Name: Rolling release Notes: PickupDistribution: AllInOneGroup IsActive: false QuoteId: 67eaf3c8-81e0-4ffb-b5f2-2b61803feb9c AvailabilityBlockNumber: '479' ReleaseStrategy: RollingRelease PurchaseOrderNumber: BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed CanceledUtc: '2022-10-12T15:12:49Z' CancellationReason: ForceMajeure CancellationReasonDetail: Event was canceled due to rain. ServiceOrders: Adjustments: - Id: e19297af-373e-4701-b4ea-afae0129bded AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f StartUtc: EndUtc: FirstTimeUnitStartUtc: '2021-10-14T00:00:00Z' LastTimeUnitStartUtc: '2021-10-17T00:00:00Z' UnitCount: 6 ActivityState: Active ReleaseOverrideUtc: '2021-10-13T00:00:00Z' UpdatedUtc: '2021-10-21T13:32:32Z' IsActive: false PaxCounts: FirstTimeUnitReleaseUtc: '2021-10-13T00:00:00Z' Rates: Cursor: c32386aa-1cd2-414a-a823-489325842fbe '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: AvailabilityBlocksUpdate400Example: summary: Default availabilityBlocks_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: AvailabilityBlocksUpdate401Example: summary: Default availabilityBlocks_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: AvailabilityBlocksUpdate403Example: summary: Default availabilityBlocks_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: AvailabilityBlocksUpdate408Example: summary: Default availabilityBlocks_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: AvailabilityBlocksUpdate204Example: summary: Default availabilityBlocks_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: AvailabilityBlocksUpdate429Example: summary: Default availabilityBlocks_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: AvailabilityBlocksUpdate500Example: summary: Default availabilityBlocks_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/businessSegments/getAll: post: tags: - Business segments summary: Mews Get All Business Segments description: Returns all business segments. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: businessSegments_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/BusinessSegmentFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Ids: - 7760b5cb-a666-41bb-9758-76bf5d1df399 - 54ec08b6-e6fc-48e9-b8ae-02943e0ac693 ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 - 8c1bd738-a505-4b29-aa71-9ecc2982b843 UpdatedUtc: StartUtc: '2023-10-01T00:00:00Z' EndUtc: '2023-10-31T00:00:00Z' ActivityStates: - Active EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BusinessSegmentResult' example: BusinessSegments: - Id: 7760b5cb-a666-41bb-9758-76bf5d1df399 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 IsActive: true Name: Business CreatedUtc: '2023-10-01T00:00:00Z' UpdatedUtc: '2023-10-01T00:00:00Z' - Id: 54ec08b6-e6fc-48e9-b8ae-02943e0ac693 ServiceId: 8c1bd738-a505-4b29-aa71-9ecc2982b843 IsActive: true Name: Leisure CreatedUtc: '2023-10-01T00:00:00Z' UpdatedUtc: '2023-10-01T00:00:00Z' Cursor: 54ec08b6-e6fc-48e9-b8ae-02943e0ac693 '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: BusinessSegmentsGetAll400Example: summary: Default businessSegments_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: BusinessSegmentsGetAll401Example: summary: Default businessSegments_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: BusinessSegmentsGetAll403Example: summary: Default businessSegments_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: BusinessSegmentsGetAll408Example: summary: Default businessSegments_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: BusinessSegmentsGetAll204Example: summary: Default businessSegments_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: BusinessSegmentsGetAll429Example: summary: Default businessSegments_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: BusinessSegmentsGetAll500Example: summary: Default businessSegments_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/cancellationPolicies/getAll: post: tags: - Cancellation policies summary: Mews Get All Cancellation Policies description: "> ### Restricted!\n> This operation is currently in beta-test and as such it is subject to change.\nReturns all cancellation policies, filtered by services, rate groups and other filters. \nNote 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: cancellationPolicies_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/CancellationPolicyFilterParameters' 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: - e654f217-d1b5-46be-a820-e93ba568dfac CancellationPolicyIds: - fe795f96-0b64-445b-89ed-c032563f2bac RateGroupIds: - deb9444e-6897-4f2a-86b4-aff100c2896e UpdatedUtc: StartUtc: '2023-04-27T11:48:57Z' EndUtc: '2023-04-27T11:48:57Z' Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CancellationPolicyResult' example: CancellationPolicies: - Id: 769fc613-838f-41a7-ac2a-aff100c3189f RateGroupId: deb9444e-6897-4f2a-86b4-aff100c2896e CreatedUtc: '2023-04-27T11:48:57Z' UpdatedUtc: '2023-04-27T11:48:57Z' Applicability: Creation FeeExtent: - TimeUnits - Products ApplicabilityOffset: 0M0D0:0:0.0 FeeMaximumTimeUnits: 0 AbsoluteFee: Currency: EUR Value: 15 RelativeFee: 0 Cursor: 769fc613-838f-41a7-ac2a-aff100c3189f '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: CancellationPoliciesGetAll400Example: summary: Default cancellationPolicies_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: CancellationPoliciesGetAll401Example: summary: Default cancellationPolicies_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: CancellationPoliciesGetAll403Example: summary: Default cancellationPolicies_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: CancellationPoliciesGetAll408Example: summary: Default cancellationPolicies_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: CancellationPoliciesGetAll204Example: summary: Default cancellationPolicies_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: CancellationPoliciesGetAll429Example: summary: Default cancellationPolicies_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: CancellationPoliciesGetAll500Example: summary: Default cancellationPolicies_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/cancellationPolicies/getByReservations: post: tags: - Cancellation policies summary: Mews Get Cancellation Policies by Reservations description: Gets cancellation policies for enterprise grouped by reservation for granular cancellation policies flow. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: cancellationPolicies_getByReservations requestBody: content: application/json: schema: $ref: '#/components/schemas/CancellationPolicyByReservationParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CancellationPolicyByReservationResult' example: CancellationPolicies: - ReservationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Policies: - Applicability: Start FeeExtents: - TimeUnits - Products ApplicabilityOffset: P10DT20H30M FeeMaximumTimeUnits: 1 AbsoluteFee: Currency: EUR Value: 20.0 RelativeFee: 0.1 - ReservationId: 4d0201db-36f5-428b-8d11-4f0a65e960cc Policies: - Applicability: Start FeeExtents: - TimeUnits - Products ApplicabilityOffset: P5DT10H30M FeeMaximumTimeUnits: 2 AbsoluteFee: Currency: EUR Value: 15.0 RelativeFee: 0.4 - Applicability: Start FeeExtents: - TimeUnits - Products ApplicabilityOffset: P10DT10H30M FeeMaximumTimeUnits: 2 AbsoluteFee: Currency: EUR Value: 15.0 RelativeFee: 0.2 '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: CancellationPoliciesGetByReservations400Example: summary: Default cancellationPolicies_getByReservations 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: CancellationPoliciesGetByReservations401Example: summary: Default cancellationPolicies_getByReservations 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: CancellationPoliciesGetByReservations403Example: summary: Default cancellationPolicies_getByReservations 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: CancellationPoliciesGetByReservations408Example: summary: Default cancellationPolicies_getByReservations 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: CancellationPoliciesGetByReservations204Example: summary: Default cancellationPolicies_getByReservations 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: CancellationPoliciesGetByReservations429Example: summary: Default cancellationPolicies_getByReservations 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: CancellationPoliciesGetByReservations500Example: summary: Default cancellationPolicies_getByReservations 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/cancellationPolicies/getByRates: post: tags: - Cancellation policies summary: Mews Get Cancellation Policies by Rates description: Gets cancellation policies for enterprise grouped by rate for granular cancellation policies flow. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: cancellationPolicies_getByRates requestBody: content: application/json: schema: $ref: '#/components/schemas/CancellationPolicyByRateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RateIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CancellationPolicyByRateResult' example: CancellationPolicies: - RateId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Policies: - Applicability: Start FeeExtents: - TimeUnits - Products ApplicabilityOffset: P10DT20H30M FeeMaximumTimeUnits: 1 AbsoluteFee: Currency: EUR Value: 20.0 RelativeFee: 0.1 - RateId: 4d0201db-36f5-428b-8d11-4f0a65e960cc Policies: - Applicability: Start FeeExtents: - TimeUnits - Products ApplicabilityOffset: P5DT10H30M FeeMaximumTimeUnits: 2 AbsoluteFee: Currency: EUR Value: 15.0 RelativeFee: 0.4 - Applicability: Start FeeExtents: - TimeUnits - Products ApplicabilityOffset: P10DT10H30M FeeMaximumTimeUnits: 2 AbsoluteFee: Currency: EUR Value: 15.0 RelativeFee: 0.2 '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: CancellationPoliciesGetByRates400Example: summary: Default cancellationPolicies_getByRates 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: CancellationPoliciesGetByRates401Example: summary: Default cancellationPolicies_getByRates 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: CancellationPoliciesGetByRates403Example: summary: Default cancellationPolicies_getByRates 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: CancellationPoliciesGetByRates408Example: summary: Default cancellationPolicies_getByRates 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: CancellationPoliciesGetByRates204Example: summary: Default cancellationPolicies_getByRates 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: CancellationPoliciesGetByRates429Example: summary: Default cancellationPolicies_getByRates 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: CancellationPoliciesGetByRates500Example: summary: Default cancellationPolicies_getByRates 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/rateGroups/getAll: post: tags: - Rate groups summary: Mews Get All Rate Groups description: Returns all rate groups, filtered by unique identifiers and other filters. 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: rateGroups_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/RateGroupFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RateGroupIds: - 6b3f718a-b537-45b0-a8ee-d30897723834 ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 ExternalIdentifiers: - RG-001 UpdatedUtc: StartUtc: '2024-01-27T11:48:57Z' EndUtc: '2024-02-27T11:48:57Z' ActivityStates: - Active EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 1000 Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RateGroupResult' example: RateGroups: - Id: 6b3f718a-b537-45b0-a8ee-d30897723834 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 IsActive: true CreatedUtc: '2023-01-11T13:32:32Z' UpdatedUtc: '2023-01-13T15:27:28Z' Ordering: 0 Names: en-US: Default group ShortNames: en-US: Default group Descriptions: en-US: Default group ExternalIdentifier: RG-001 Cursor: 6b3f718a-b537-45b0-a8ee-d30897723834 '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: RateGroupsGetAll400Example: summary: Default rateGroups_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: RateGroupsGetAll401Example: summary: Default rateGroups_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: RateGroupsGetAll403Example: summary: Default rateGroups_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: RateGroupsGetAll408Example: summary: Default rateGroups_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: RateGroupsGetAll204Example: summary: Default rateGroups_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: RateGroupsGetAll429Example: summary: Default rateGroups_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: RateGroupsGetAll500Example: summary: Default rateGroups_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/rates/updateCapacityOffset: post: tags: - Rates summary: Mews Update Rate Capacity Offset Pricing description: Updates capacity offset based pricing for specified rates. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: rates_updateCapacityOffset requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleRateCapacityOffsetUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 CapacityOffsetUpdates: - RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda NegativeOccupancyAdjustment: Value: 10.0 ExtraOccupancyAdjustment: Value: 20.0 - RateId: b7e6a1c2-4f3a-4e2b-9c1d-2a5e7b8c9d0f ExtraOccupancyAdjustment: Value: 15.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: RatesUpdateCapacityOffset200Example: summary: Default rates_updateCapacityOffset 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: RatesUpdateCapacityOffset400Example: summary: Default rates_updateCapacityOffset 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: RatesUpdateCapacityOffset401Example: summary: Default rates_updateCapacityOffset 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: RatesUpdateCapacityOffset403Example: summary: Default rates_updateCapacityOffset 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: RatesUpdateCapacityOffset408Example: summary: Default rates_updateCapacityOffset 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: RatesUpdateCapacityOffset204Example: summary: Default rates_updateCapacityOffset 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: RatesUpdateCapacityOffset429Example: summary: Default rates_updateCapacityOffset 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: RatesUpdateCapacityOffset500Example: summary: Default rates_updateCapacityOffset 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/rates/getAll: post: tags: - Rates summary: Mews Get All Rates description: Returns all rates (pricing setups) of the default service provided 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: rates_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/RateFilterParameters' 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: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateIds: - ed4b660b-19d0-434b-9360-a4de2ea42eda UpdatedUtc: StartUtc: '2022-10-15T00:00:00Z' EndUtc: '2022-10-20T00:00:00Z' ExternalIdentifiers: - Rate-001 - Rate-002 ActivityStates: - Active Extent: Rates: true RateGroups: true AvailabilityBlockAssignments: true Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RateResult' example: Rates: - BaseRateId: BusinessSegmentId: GroupId: c8b866b3-be2e-4a47-9486-034318e9f393 Id: ed4b660b-19d0-434b-9360-a4de2ea42eda ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 IsActive: true IsEnabled: true IsPublic: true Name: Fully Flexible ShortName: FF ExternalNames: en-US: Long Stay Flexible Rate ExternalIdentifier: D001 RateGroups: - Id: c8b866b3-be2e-4a47-9486-034318e9f393 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 IsActive: true Name: Default ExternalIdentifier: RG001 AvailabilityBlockAssignments: - RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda AvailabilityBlockId: 12806ae8-9c15-44c7-9a44-afae01289928 '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: RatesGetAll400Example: summary: Default rates_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: RatesGetAll401Example: summary: Default rates_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: RatesGetAll403Example: summary: Default rates_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: RatesGetAll408Example: summary: Default rates_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: RatesGetAll204Example: summary: Default rates_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: RatesGetAll429Example: summary: Default rates_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: RatesGetAll500Example: summary: Default rates_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/rates/add: post: tags: - Rates summary: Mews Add Rates description: Adds rates to the enterprise. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). Rate type of `AvailabilityBlock` cannot be created via this operation. operationId: rates_add requestBody: content: application/json: schema: $ref: '#/components/schemas/RateAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Rates: - ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 RateGroupId: b9f25a45-9b9a-4b33-99bd-b06f008eb6f5 IsEnabled: true Type: Public AccountingCategoryId: 3620c660-a4ec-4e0f-a0bc-b06f008eb8bf Names: EN: My rate ExternalIdentifier: D001 PricingType: DependentRatePricing Pricing: DependentRatePricing: BaseRateId: 1a1ddd3b-e106-4a70-aef1-54a75b483943 RelativeAdjustment: 0.15 AbsoluteAdjustment: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RateAddResult' example: Rates: - Id: ed4b660b-19d0-434b-9360-a4de2ea42eda GroupId: b9f25a45-9b9a-4b33-99bd-b06f008eb6f5 BaseRateId: 1a1ddd3b-e106-4a70-aef1-54a75b483943 BusinessSegmentId: ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 IsActive: true IsEnabled: true IsPublic: true Type: Public Name: My rate ShortName: FF ExternalNames: en-US: Long Stay Flexible Rate ExternalIdentifier: D001 '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: RatesAdd400Example: summary: Default rates_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: RatesAdd401Example: summary: Default rates_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: RatesAdd403Example: summary: Default rates_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: RatesAdd408Example: summary: Default rates_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: RatesAdd204Example: summary: Default rates_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: RatesAdd429Example: summary: Default rates_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: RatesAdd500Example: summary: Default rates_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/rates/set: post: tags: - Rates summary: Mews Set Rates description: Adds new Rates or updates existing ones if they are matched by `Id` or `ExternalIdentifier` property. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: rates_set requestBody: content: application/json: schema: $ref: '#/components/schemas/RateSetParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Rates: - Id: e1b0bf46-32a3-4f7c-99c1-1ff78447d55d ServiceId: 956176af-e10b-4f3c-beb7-274801bce328 RateGroupId: d7adfddc-c2dc-4798-ace2-28de7b25408f IsEnabled: true Type: Public Names: en-US: Base rate Descriptions: en-US: Base rate with all fields specified using GUID identifiers. PricingType: BaseRatePricing Pricing: BaseRatePricing: Amount: Currency: EUR NetValue: 100.0 - ExternalIdentifier: '55698' ServiceId: eid:Stay RateGroupId: eid:RG10 IsEnabled: false Type: Private Names: en-US: Dependent rate Descriptions: en-US: Dependent rate with all field specified using eid identifiers. PricingType: DependentRatePricing Pricing: DependentRatePricing: BaseRateId: 00392166-3869-4174-b491-cf0162524a38 RelativeAdjustment: 0.0 AbsoluteAdjustment: 0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RateSetResult' example: Rates: - Id: e1b0bf46-32a3-4f7c-99c1-1ff78447d55d GroupId: d7adfddc-c2dc-4798-ace2-28de7b25408f ServiceId: 956176af-e10b-4f3c-beb7-274801bce328 BaseRateId: IsBaseRate: true BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed IsActive: true IsEnabled: true IsPublic: true IsDefault: false Type: Public Name: Names: en-US: Base rate ShortName: BR UpdatedUtc: '2024-11-20T00:00:00Z' ExternalNames: en-US: External base rate Description: en-US: Base rate description. ExternalIdentifier: TaxExemptionReason: TaxExemptionLegalReference: - Id: 8eb1f163-bce7-49ca-a62c-c9261951c85f GroupId: d7adfddc-c2dc-4798-ace2-28de7b25408f ServiceId: 956176af-e10b-4f3c-beb7-274801bce328 BaseRateId: 00392166-3869-4174-b491-cf0162524a38 IsBaseRate: false BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed IsActive: true IsEnabled: false IsPublic: false IsDefault: false Type: Private Name: Names: en-US: Dependent rate ShortName: DR UpdatedUtc: '2024-11-20T00:00:00Z' ExternalNames: en-US: External dependent rate Description: en-US: Dependent rate description. ExternalIdentifier: '55698' TaxExemptionReason: TaxExemptionLegalReference: '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: RatesSet400Example: summary: Default rates_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: RatesSet401Example: summary: Default rates_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: RatesSet403Example: summary: Default rates_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: RatesSet408Example: summary: Default rates_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: RatesSet204Example: summary: Default rates_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: RatesSet429Example: summary: Default rates_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: RatesSet500Example: summary: Default rates_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/rates/delete: post: tags: - Rates summary: Mews Delete Rates description: Deletes specified rates. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: rates_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/RateDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RateIds: - 7e89ee8e-11a0-4d9d-8880-f8d8494824b5 - eid:BasicRate EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: RatesDelete200Example: summary: Default rates_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: RatesDelete400Example: summary: Default rates_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: RatesDelete401Example: summary: Default rates_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: RatesDelete403Example: summary: Default rates_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: RatesDelete408Example: summary: Default rates_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: RatesDelete204Example: summary: Default rates_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: RatesDelete429Example: summary: Default rates_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: RatesDelete500Example: summary: Default rates_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/rates/getPricing: post: tags: - Rates summary: Mews Get Rate Pricing description: 'Returns prices for a given rate for a specified time interval. Prices 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 units](https://mews-systems.gitbook.io/connector-api/concepts/time-units).' operationId: rates_getPricing requestBody: content: application/json: schema: $ref: '#/components/schemas/RatePricingFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda FirstTimeUnitStartUtc: '2022-01-01T23:00:00.000Z' LastTimeUnitStartUtc: '2022-01-03T23:00:00.000Z' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RatePricing' example: Currency: EUR BaseAmountPrices: - Currency: EUR NetValue: 93.46 GrossValue: 100 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 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 CategoryAdjustments: - AbsoluteValue: 0 CategoryId: 34c29e73-c8db-4e93-b51b-981e42655e03 ParentCategoryId: RelativeValue: 0.2 - AbsoluteValue: 50 CategoryId: a0a7a5c5-c4ef-494a-8b34-6cca97629076 ParentCategoryId: 34c29e73-c8db-4e93-b51b-981e42655e03 RelativeValue: 0 CategoryPrices: - CategoryId: e3aa3117-dff0-46b7-b49a-2c0391e70ff9 AmountPrices: - Currency: EUR NetValue: 93.46 GrossValue: 100 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 TaxValues: - Code: DE-2020-1-L Value: 6.54 Breakdown: Items: - TaxRateCode: DE-2020-1-L NetValue: 93.46 TaxValue: 6.54 TimeUnitStartsUtc: - '2022-01-01T23:00:00Z' - '2022-01-02T23:00:00Z' - '2022-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: RatesGetPricing400Example: summary: Default rates_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: RatesGetPricing401Example: summary: Default rates_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: RatesGetPricing403Example: summary: Default rates_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: RatesGetPricing408Example: summary: Default rates_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: RatesGetPricing204Example: summary: Default rates_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: RatesGetPricing429Example: summary: Default rates_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: RatesGetPricing500Example: summary: Default rates_getPricing 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/rates/updatePrice: post: tags: - Rates summary: Mews Update Rate Price description: 'Updates the prices for a given rate. You can make multiple price updates with one API call, and for each one specify the time interval for which the update applies, the price value and the applicable [resource category](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource-category). The price will be updated for all service [time units](https://mews-systems.gitbook.io/connector-api/operations/services/#time-unit) that the specified time interval intersects. The price is per time unit, e.g. per day or per month. If the resource category `CategoryId` is not specified, the updated price will apply to the base price for all resource categories. Note that prices are defined daily, so when the server receives the UTC interval, it first converts it to the enterprise timezone and updates the price on all dates that the interval intersects. Only root rates can be updated (the rates that have no base rate, that have `BaseRateId` set to `null`). It is not permitted to update historical prices older than specified by `EditableHistoryInterval`. Future prices may be updated up to 5 years in the future. The __maximum size of time interval__ is 100 time units or 2 years, whichever is the shorter amount of time.' operationId: rates_updatePrice requestBody: content: application/json: schema: $ref: '#/components/schemas/RatePriceUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda PriceUpdates: - FirstTimeUnitStartUtc: '2022-01-01T23:00:00.000Z' LastTimeUnitStartUtc: '2022-01-03T23:00:00.000Z' Value: 111 - CategoryId: e3aa3117-dff0-46b7-b49a-2c0391e70ff9 FirstTimeUnitStartUtc: '2022-01-04T23:00:00.000Z' LastTimeUnitStartUtc: '2022-01-05T23:00:00.000Z' Value: 222 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: RatesUpdatePrice200Example: summary: Default rates_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: RatesUpdatePrice400Example: summary: Default rates_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: RatesUpdatePrice401Example: summary: Default rates_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: RatesUpdatePrice403Example: summary: Default rates_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: RatesUpdatePrice408Example: summary: Default rates_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: RatesUpdatePrice204Example: summary: Default rates_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: RatesUpdatePrice429Example: summary: Default rates_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: RatesUpdatePrice500Example: summary: Default rates_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/reservationGroups/getAll: post: tags: - Reservation groups summary: Mews Get All Reservation Groups description: Returns all reservation groups, filtered by unique identifiers and other filters. 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: reservationGroups_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationGroupFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ReservationGroupIds: - fe795f96-0b64-445b-89ed-c032563f2bac UpdatedUtc: StartUtc: '2023-04-27T11:48:57Z' EndUtc: '2023-04-27T11:48:57Z' Limitation: Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationGroupResult' example: ReservationGroups: - Id: 769fc613-838f-41a7-ac2a-aff100c3189f EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 Name: Mr and Mrs smith wedding ChannelManager: '2023-04-27T11:48:57Z' ChannelManagerGroupNumber: 152fg645-834f-63a7-he6a-vsy845c4753a Cursor: 723jd664-235f-36a4-tg6d-gfy850c645f '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: ReservationGroupsGetAll400Example: summary: Default reservationGroups_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: ReservationGroupsGetAll401Example: summary: Default reservationGroups_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: ReservationGroupsGetAll403Example: summary: Default reservationGroups_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: ReservationGroupsGetAll408Example: summary: Default reservationGroups_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: ReservationGroupsGetAll204Example: summary: Default reservationGroups_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: ReservationGroupsGetAll429Example: summary: Default reservationGroups_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: ReservationGroupsGetAll500Example: summary: Default reservationGroups_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/reservations/getChannelManagerDetails: post: tags: - Reservations summary: Mews Get Reservation Channel Manager Details description: Returns channel manager-related details for the specified reservations. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: reservations_getChannelManagerDetails requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationsChannelManagerDetailsFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationsChannelManagerDetailsResult' example: ChannelManagerDetails: - ReservationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 RequestedRateCode: XyZ123AbC789 ChannelManagerName: HotelConnect ChannelNumber: HC1234 ChannelManagerGroupNumber: 9E5F7BC3B6F0102 ChannelManagerNumber: '1' CreatedUtc: '2025-03-10T15:30:00Z' - ReservationId: 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 RequestedRateCode: LmN456OpQ012 ChannelManagerName: GlobalRes ChannelNumber: GR5678 ChannelManagerGroupNumber: 461190401CD25FE ChannelManagerNumber: '1' CreatedUtc: '2025-03-11T09:45:00Z' '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsGetChannelManagerDetails400Example: summary: Default reservations_getChannelManagerDetails 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: ReservationsGetChannelManagerDetails401Example: summary: Default reservations_getChannelManagerDetails 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: ReservationsGetChannelManagerDetails403Example: summary: Default reservations_getChannelManagerDetails 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: ReservationsGetChannelManagerDetails408Example: summary: Default reservations_getChannelManagerDetails 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: ReservationsGetChannelManagerDetails204Example: summary: Default reservations_getChannelManagerDetails 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: ReservationsGetChannelManagerDetails429Example: summary: Default reservations_getChannelManagerDetails 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: ReservationsGetChannelManagerDetails500Example: summary: Default reservations_getChannelManagerDetails 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/reservations/getAll/2023-06-06: post: tags: - Reservations summary: Mews Get All Reservations (ver 2023-06-06) description: 'Returns all reservations within scope of the Access Token, filtered according to the specified parameters. This operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). ' operationId: reservations_getAll_2023-06-06 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationServiceOrderFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - 0f515589-99b4-423d-b83a-b237009f0509 - 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 - 8c1bd738-a505-4b29-aa71-9ecc2982b843 ReservationGroupIds: - 94843f6f-3be3-481b-a1c7-06458774c3df AccountIds: - fadd5bb6-b428-45d5-94f8-fd0d89fece6d PartnerCompanyIds: - c021013e-4930-4592-8e32-91b0b1fc9663 TravelAgencyIds: - a793d381-65a2-4fa6-9514-00c4c5bfe607 Numbers: - '50' - '51' - '52' - '53' AssignedResourceIds: - 5ee074b1-6c86-48e8-915f-c7aa4702086f - c32386aa-1cd2-414a-a823-489325842fbe AvailabilityBlockIds: - 5ee074b1-6c86-48e8-915f-c7aa4702086f - c32386aa-1cd2-414a-a823-489325842fbe CreatedUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' UpdatedUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' CollidingUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' ScheduledStartUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' ScheduledEndUtc: StartUtc: '2023-04-01T00:00:00Z' EndUtc: '2023-05-05T00:00:00Z' States: - Inquired - Confirmed EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationServiceOrderResult' example: Reservations: - Id: 0f515589-99b4-423d-b83a-b237009f0509 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 AccountId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d AccountType: Customer CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf UpdaterProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 Number: '52' State: Confirmed Origin: Connector CommanderOrigin: OriginDetails: CreatedUtc: '2023-03-23T16:00:00Z' UpdatedUtc: '2023-04-22T17:00:00Z' CancelledUtc: VoucherId: BusinessSegmentId: Options: OwnerCheckedIn: true AllCompanionsCheckedIn: true AnyCompanionCheckedIn: true ConnectorCheckIn: true RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda CreditCardId: GroupId: 94843f6f-3be3-481b-a1c7-06458774c3df RequestedResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f PartnerCompanyId: c021013e-4930-4592-8e32-91b0b1fc9663 TravelAgencyId: a793d381-65a2-4fa6-9514-00c4c5bfe607 AssignedResourceLocked: false ChannelNumber: TW48ZP ChannelManagerNumber: '' CancellationReason: ReleasedUtc: StartUtc: '2023-04-23T14:00:00Z' EndUtc: '2023-04-25T12:00:00Z' ScheduledStartUtc: '2023-04-23T14:00:00Z' ActualStartUtc: ScheduledEndUtc: '2023-04-25T12:00:00Z' ActualEndUtc: Purpose: Leisure QrCodeData: '{"Reservations":[{"Id":"0f515589-99b4-423d-b83a-b237009f0509","GroupId":"94843f6f-3be3-481b-a1c7-06458774c3df","CustomerId":"fadd5bb6-b428-45d5-94f8-fd0d89fece6d"}]}' PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 Cursor: 0f515589-99b4-423d-b83a-b237009f0509 '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsGetAll20230606400Example: summary: Default reservations_getAll_2023-06-06 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: ReservationsGetAll20230606401Example: summary: Default reservations_getAll_2023-06-06 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: ReservationsGetAll20230606403Example: summary: Default reservations_getAll_2023-06-06 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: ReservationsGetAll20230606408Example: summary: Default reservations_getAll_2023-06-06 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: ReservationsGetAll20230606204Example: summary: Default reservations_getAll_2023-06-06 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: ReservationsGetAll20230606429Example: summary: Default reservations_getAll_2023-06-06 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: ReservationsGetAll20230606500Example: summary: Default reservations_getAll_2023-06-06 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/getAll: post: tags: - Reservations summary: Mews Get All Reservations (ver 2017-04-12) description: Use [Get all reservations (ver 2023-06-06)](https://mews-systems.gitbook.io/connector-api/operations/reservations#get-all-reservations-ver-2023-06-06). operationId: reservations_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 StartUtc: '2016-01-01T00:00:00Z' EndUtc: '2016-01-07T00:00:00Z' ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 ReservationIds: - db6cad34-9a91-448b-bea1-abbe01240d9c CustomerIds: - 8e1d0ca6-1dde-4be0-8566-aafc01866110 RateIds: - ed4b660b-19d0-434b-9360-a4de2ea42eda ChannelNumbers: - TW48ZP States: - Started Extent: Reservations: true ReservationGroups: true Customers: true Limitation: Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationResult' example: BusinessSegments: Customers: - Address: BirthDate: BirthPlace: CategoryId: Classifications: [] CreatedUtc: '2016-01-01T00:00:00Z' Email: FirstName: John Sex: Id: 35d4b117-4e60-44a3-9580-c582117eff98 IdentityCard: LanguageCode: LastName: Smith LoyaltyCode: NationalityCode: US Notes: '' Number: '1' Passport: Phone: 00420123456789 SecondLastName: TaxIdentificationNumber: Title: UpdatedUtc: '2016-01-01T00:00:00Z' Visa: OrderItems: Products: RateGroups: Rates: ReservationGroups: - Id: c704dff3-7811-4af7-a3a0-7b2b0635ac59 Name: 13-12-Smith-F712 Reservations: - Id: bfee2c44-1f84-4326-a862-5289598f6e2d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 GroupId: 94843f6f-3be3-481b-a1c7-06458774c3df Number: '52' ChannelNumber: TW48ZP ChannelManager: '' ChannelManagerGroupNumber: ChannelManagerNumber: State: Processed Origin: Connector OriginDetail: Purpose: Student CreatedUtc: '2016-02-20T14:58:02Z' UpdatedUtc: '2016-02-20T14:58:02Z' CancelledUtc: StartUtc: '2016-02-20T13:00:00Z' EndUtc: '2016-02-22T11:00:00Z' ReleasedUtc: RequestedCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 AssignedResourceLocked: false BusinessSegmentId: CompanyId: TravelAgencyId: AvailabilityBlockId: RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 Services: Resources: ResourceCategories: ResourceCategoryAssignments: Notes: Cursor: 8d02142f-31cf-4115-90bf-ae5200c7a1ba '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsGetAll400Example: summary: Default reservations_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: ReservationsGetAll401Example: summary: Default reservations_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: ReservationsGetAll403Example: summary: Default reservations_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: ReservationsGetAll408Example: summary: Default reservations_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: ReservationsGetAll204Example: summary: Default reservations_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: ReservationsGetAll429Example: summary: Default reservations_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: ReservationsGetAll500Example: summary: Default reservations_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string deprecated: true x-deprecatedMessage: Use [Get all reservations (ver 2023-06-06)](https://mews-systems.gitbook.io/connector-api/operations/reservations#get-all-reservations-ver-2023-06-06). x-microcks-operation: *id001 /api/connector/v1/reservations/add: post: tags: - Reservations summary: Mews Add Reservations description: Adds the specified reservations as a single group. If `GroupId` is specified, adds the reservations to an already existing group. Note that all reservations linked to an availability block must belong to the same reservation group. operationId: reservations_add requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationAdditionParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 GroupId: GroupName: SendConfirmationEmail: true Reservations: - Identifier: '1234' State: Confirmed StartUtc: '2021-01-01T14:00:00Z' EndUtc: '2021-01-03T10:00:00Z' ReleasedUtc: CustomerId: e465c031-fd99-4546-8c70-abcf0029c249 BookerId: e465c031-fd99-4546-8c70-abcf0029c249 RequestedCategoryId: 0a5da171-3663-4496-a61e-35ecbd78b9b1 RateId: a39a59fa-3a08-4822-bdd4-ab0b00e3d21f TravelAgencyId: CompanyId: Notes: Test reservation TimeUnitAmount: PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 TimeUnitPrices: - Index: 0 Amount: Currency: GBP GrossValue: 20 TaxCodes: - UK-S - Index: 1 Amount: Currency: GBP GrossValue: 30 TaxCodes: - UK-S ProductOrders: - ProductId: 2e9eb3fc-8a77-466a-9cd9-abcf002a2a01 StartUtc: '2021-01-02T00:00:00Z' EndUtc: '2021-01-03T00:00:00Z' AvailabilityBlockId: VoucherCode: SpringSale2021 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationAdditionResult' example: Reservations: - Identifier: '1234' Reservation: Id: bfee2c44-1f84-4326-a862-5289598f6e2d ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 GroupId: 94843f6f-3be3-481b-a1c7-06458774c3df Number: '52' ChannelManager: '' ChannelManagerGroupNumber: ChannelManagerNumber: ChannelNumber: State: Processed Origin: Connector CreatedUtc: '2016-02-20T14:58:02Z' UpdatedUtc: '2016-02-20T14:58:02Z' CancelledUtc: StartUtc: '2016-02-20T13:00:00Z' EndUtc: '2016-02-22T11:00:00Z' ReleasedUtc: RequestedCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 AssignedResourceLocked: false BusinessSegmentId: CompanyId: TravelAgencyId: AvailabilityBlockId: RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 CompanionIds: - b22bf671-ccdf-40aa-a7e6-b20a4f91d79a '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsAdd400Example: summary: Default reservations_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: ReservationsAdd401Example: summary: Default reservations_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: ReservationsAdd403Example: summary: Default reservations_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: ReservationsAdd408Example: summary: Default reservations_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: ReservationsAdd204Example: summary: Default reservations_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: ReservationsAdd429Example: summary: Default reservations_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: ReservationsAdd500Example: summary: Default reservations_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/reservations/update: post: tags: - Reservations summary: Mews Update Reservations description: Updates information about the specified reservations. Note that if any of the fields are sent as `null`, it won't clear the field in Mews. If the `Value` within the object is sent as `null`, the field will be cleared in Mews. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleReservationUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationUpdates: - ReservationId: 0f515589-99b4-423d-b83a-b237009f0509 StartUtc: Value: '2019-10-01T14:00:00Z' EndUtc: Value: '2019-10-03T10:00:00Z' Reprice: true ApplyCancellationFee: true Reason: Testing ReservationId: 0f515589-99b4-423d-b83a-b237009f0509 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationResult' example: Reservations: - Id: 0f515589-99b4-423d-b83a-b237009f0509 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 GroupId: 94843f6f-3be3-481b-a1c7-06458774c3df Number: '50' ChannelNumber: TW48ZP ChannelManagerNumber: '' ChannelManagerGroupNumber: ChannelManager: State: Confirmed Origin: Connector OriginDetails: Purpose: Leisure CreatedUtc: '2019-09-23T16:00:00Z' UpdatedUtc: '2019-09-28T17:00:00Z' CancelledUtc: StartUtc: '2019-10-01T14:00:00Z' EndUtc: '2019-10-03T10:00:00Z' ReleasedUtc: RequestedCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f AssignedSpaceId: AssignedSpaceLocked: false AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 AssignedResourceLocked: false BusinessSegmentId: CompanyId: TravelAgencyId: AvailabilityBlockId: RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda VoucherId: CreditCardId: CancellationReason: AdultCount: 0 ChildCount: 0 PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 OwnerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72 CompanionIds: [] ChannelManagerId: Options: OwnerCheckedIn: false AllCompanionsCheckedIn: false AnyCompanionCheckedIn: false ReservationGroups: Customers: Services: Products: Resources: ResourceCategories: ResourceCategoryAssignments: BusinessSegments: Rates: RateGroups: Items: OrderItems: Notes: QrCodeData: Companies: ResourceAccessTokens: Cursor: '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: ReservationsUpdate400Example: summary: Default reservations_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: ReservationsUpdate401Example: summary: Default reservations_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: ReservationsUpdate403Example: summary: Default reservations_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: ReservationsUpdate408Example: summary: Default reservations_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: ReservationsUpdate204Example: summary: Default reservations_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: ReservationsUpdate429Example: summary: Default reservations_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: ReservationsUpdate500Example: summary: Default reservations_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/reservations/confirm: post: tags: - Reservations summary: Mews Confirm Reservation description: Marks all specified reservations as `Confirmed`. Succeeds only if all confirmation conditions are met (the reservations have the `Optional` state). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: reservations_confirm requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmReservationParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - 9af9d8b0-43ae-414d-80a8-abc1012a2a59 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MultipleReservationResult' example: ReservationIds: - 5ca70705-cbb7-48c4-8cc4-abb900aa278c '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsConfirm400Example: summary: Default reservations_confirm 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: ReservationsConfirm401Example: summary: Default reservations_confirm 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: ReservationsConfirm403Example: summary: Default reservations_confirm 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: ReservationsConfirm408Example: summary: Default reservations_confirm 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: ReservationsConfirm204Example: summary: Default reservations_confirm 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: ReservationsConfirm429Example: summary: Default reservations_confirm 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: ReservationsConfirm500Example: summary: Default reservations_confirm 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/start: post: tags: - Reservations summary: Mews Start Reservation description: Marks a reservation as `Started` (= checked in). Succeeds only if all starting conditions are met (the reservation has the `Confirmed` state, does not have start set to future, has an inspected room assigned etc). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_start requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationStartParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ReservationsStart200Example: summary: Default reservations_start 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: ReservationsStart400Example: summary: Default reservations_start 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: ReservationsStart401Example: summary: Default reservations_start 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: ReservationsStart403Example: summary: Default reservations_start 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: ReservationsStart408Example: summary: Default reservations_start 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: ReservationsStart204Example: summary: Default reservations_start 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: ReservationsStart429Example: summary: Default reservations_start 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: ReservationsStart500Example: summary: Default reservations_start 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/process: post: tags: - Reservations summary: Mews Process Reservation description: 'Marks a reservation as `Processed` (= checked out). Succeeds only if all processing conditions are met (the reservation has the `Started` state, balance of all reservation members is zero etc). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). ### Conditions - Reservation has already been checked in. - Reservation isn''t alredy in `Processed` state. - Reservation can''t be checked out sooner than last day of planned stay. - The companion profiles of reservation are complete (details can be found in error message). - If `AllowOpenBalance` set to `false`, all bills have to be closable (items on bills are either paid by current customer, or set to be paid by other customer). With `CloseBills` option set to `true` they can be automatically closed, when set to `false` they must be closed manually. - If `AllowOpenBalance` set to `true`, `Notes` must be filled in.' operationId: reservations_process requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationProcessingParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b CloseBills: false AllowOpenBalance: false Notes: responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ReservationsProcess200Example: summary: Default reservations_process 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: ReservationsProcess400Example: summary: Default reservations_process 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: ReservationsProcess401Example: summary: Default reservations_process 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: ReservationsProcess403Example: summary: Default reservations_process 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: ReservationsProcess408Example: summary: Default reservations_process 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: ReservationsProcess204Example: summary: Default reservations_process 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: ReservationsProcess429Example: summary: Default reservations_process 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: ReservationsProcess500Example: summary: Default reservations_process 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/cancel: post: tags: - Reservations summary: Mews Cancel Reservation description: Cancels all reservation with specified identifiers. Succeeds only if the reservations are cancellable. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_cancel requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationCancellationParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationIds: - 5ca70705-cbb7-48c4-8cc4-abb900aa278c PostCancellationFee: true Notes: Cancellation through Connector API responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MultipleReservationResult' example: ReservationIds: - 5ca70705-cbb7-48c4-8cc4-abb900aa278c '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsCancel400Example: summary: Default reservations_cancel 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: ReservationsCancel401Example: summary: Default reservations_cancel 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: ReservationsCancel403Example: summary: Default reservations_cancel 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: ReservationsCancel408Example: summary: Default reservations_cancel 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: ReservationsCancel204Example: summary: Default reservations_cancel 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: ReservationsCancel429Example: summary: Default reservations_cancel 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: ReservationsCancel500Example: summary: Default reservations_cancel 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/updateCustomer: post: tags: - Reservations summary: Mews Update Reservation Customer description: Updates customer of a reservation. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_updateCustomer requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationsUpdateCustomerParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationId: 209d984d-4985-4efb-96ec-f6591fc597bf CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ReservationsUpdateCustomer200Example: summary: Default reservations_updateCustomer 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: ReservationsUpdateCustomer400Example: summary: Default reservations_updateCustomer 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: ReservationsUpdateCustomer401Example: summary: Default reservations_updateCustomer 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: ReservationsUpdateCustomer403Example: summary: Default reservations_updateCustomer 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: ReservationsUpdateCustomer408Example: summary: Default reservations_updateCustomer 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: ReservationsUpdateCustomer204Example: summary: Default reservations_updateCustomer 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: ReservationsUpdateCustomer429Example: summary: Default reservations_updateCustomer 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: ReservationsUpdateCustomer500Example: summary: Default reservations_updateCustomer 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/updateInterval: post: tags: - Reservations summary: Mews Update Reservation Interval description: Updates reservation interval (start, end or both). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). operationId: reservations_updateInterval requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationUpdateIntervalParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ReservationId: 209d984d-4985-4efb-96ec-f6591fc597bf StartUtc: '2017-08-12T15:00:00Z' EndUtc: '2017-08-15T12:00:00Z' ChargeCancellationFee: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ReservationsUpdateInterval200Example: summary: Default reservations_updateInterval 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: ReservationsUpdateInterval400Example: summary: Default reservations_updateInterval 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: ReservationsUpdateInterval401Example: summary: Default reservations_updateInterval 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: ReservationsUpdateInterval403Example: summary: Default reservations_updateInterval 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: ReservationsUpdateInterval408Example: summary: Default reservations_updateInterval 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: ReservationsUpdateInterval204Example: summary: Default reservations_updateInterval 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: ReservationsUpdateInterval429Example: summary: Default reservations_updateInterval 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: ReservationsUpdateInterval500Example: summary: Default reservations_updateInterval 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/addCompanion: post: tags: - Reservations summary: Mews Add Reservation Companion description: Adds a customer as a companion to the reservation. Succeeds only if there is space for the new companion (count of current companions is less than `AdultCount + ChildCount`). Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: reservations_addCompanion requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanionshipAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CompanionshipAddResult' examples: ReservationsAddCompanion200Example: summary: Default reservations_addCompanion 200 response x-microcks-default: true value: CompanionshipId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 '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: ReservationsAddCompanion400Example: summary: Default reservations_addCompanion 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: ReservationsAddCompanion401Example: summary: Default reservations_addCompanion 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: ReservationsAddCompanion403Example: summary: Default reservations_addCompanion 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: ReservationsAddCompanion408Example: summary: Default reservations_addCompanion 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: ReservationsAddCompanion204Example: summary: Default reservations_addCompanion 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: ReservationsAddCompanion429Example: summary: Default reservations_addCompanion 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: ReservationsAddCompanion500Example: summary: Default reservations_addCompanion 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/deleteCompanion: post: tags: - Reservations summary: Mews Delete Reservation Companion description: Removes customer companionship from the reservation. Note that the customer profile stays untouched, only the relation between the customer and reservation is deleted. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: reservations_deleteCompanion requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanionshipDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b CustomerId: 35d4b117-4e60-44a3-9580-c582117eff98 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ReservationsDeleteCompanion200Example: summary: Default reservations_deleteCompanion 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: ReservationsDeleteCompanion400Example: summary: Default reservations_deleteCompanion 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: ReservationsDeleteCompanion401Example: summary: Default reservations_deleteCompanion 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: ReservationsDeleteCompanion403Example: summary: Default reservations_deleteCompanion 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: ReservationsDeleteCompanion408Example: summary: Default reservations_deleteCompanion 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: ReservationsDeleteCompanion204Example: summary: Default reservations_deleteCompanion 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: ReservationsDeleteCompanion429Example: summary: Default reservations_deleteCompanion 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: ReservationsDeleteCompanion500Example: summary: Default reservations_deleteCompanion 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/addProduct: post: tags: - Reservations summary: Mews Add Reservation Product description: Adds a new product order of the specified product to the reservation. operationId: reservations_addProduct requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationProductParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationId: 4d2aa234-5d30-472c-899f-ab45008c3479 ProductId: 47312820-2268-4f5c-864d-aa4100ed82bc Count: 1 StartUtc: '2021-01-02T00:00:00Z' EndUtc: '2021-01-03T00:00:00Z' UnitAmount: Currency: GBP GrossValue: 10 TaxCodes: - UK-S responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddProductItemsResult' example: ItemIds: - ff81fd7a-29ba-4160-8e22-ab4300f67b23 '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsAddProduct400Example: summary: Default reservations_addProduct 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: ReservationsAddProduct401Example: summary: Default reservations_addProduct 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: ReservationsAddProduct403Example: summary: Default reservations_addProduct 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: ReservationsAddProduct408Example: summary: Default reservations_addProduct 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: ReservationsAddProduct204Example: summary: Default reservations_addProduct 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: ReservationsAddProduct429Example: summary: Default reservations_addProduct 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: ReservationsAddProduct500Example: summary: Default reservations_addProduct 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/reservations/getAllItems: post: tags: - Reservations summary: Mews Get All Reservation Items description: Use orderItems/getAll. operationId: reservations_getAllItems requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationItemParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - e6ea708c-2a2a-412f-a152-b6c76ffad49b Currency: EUR AccountingStates: - Closed responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationItemResult' example: Reservations: - ReservationId: e6ea708c-2a2a-412f-a152-b6c76ffad49b OrderItems: - Id: 784a29df-6196-4402-96a0-58695a881239 AccountId: d73a087a-00c7-40cf-9372-314d0296334d OrderId: e6ea708c-2a2a-412f-a152-b6c76ffad49b BillId: 7fdc2957-bc08-44d3-ba2a-1c1760a84894 AccountingCategoryId: 0cf7aa90-736f-43e9-a7dc-787704548d86 Amount: Currency: EUR NetValue: 19.38 GrossValue: 23.26 TaxValues: - Code: UK-S Value: 3.88 Breakdown: Items: - TaxRateCode: UK-S NetValue: 19.38 TaxValue: 3.88 RevenueType: Service ConsumedUtc: '2016-03-10T13:00:00Z' ClosedUtc: '2016-04-06T06:41:44Z' AccountingState: Closed Data: Discriminator: ProductOrder Value: ProductId: a3f4e006-b3e4-4485-8a00-ad11015ac494 '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsGetAllItems400Example: summary: Default reservations_getAllItems 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: ReservationsGetAllItems401Example: summary: Default reservations_getAllItems 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: ReservationsGetAllItems403Example: summary: Default reservations_getAllItems 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: ReservationsGetAllItems408Example: summary: Default reservations_getAllItems 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: ReservationsGetAllItems204Example: summary: Default reservations_getAllItems 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: ReservationsGetAllItems429Example: summary: Default reservations_getAllItems 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: ReservationsGetAllItems500Example: summary: Default reservations_getAllItems 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string deprecated: true x-deprecatedMessage: Use orderItems/getAll. x-microcks-operation: *id001 /api/connector/v1/reservations/price: post: tags: - Reservations summary: Mews Price Reservations description: "Returns prices of reservations with the specified parameters.\r\nNote that the operation doesn't check the maximum capacity of requested resource category. Requesting person counts above the capacity will return prices for the maximum available capacity.\r\n\r\nThis operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/)." operationId: reservations_price requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservationDataParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 Reservations: - Identifier: '1234' StartUtc: '2018-01-01T14:00:00Z' EndUtc: '2018-01-02T10:00:00Z' RequestedCategoryId: 0a5da171-3663-4496-a61e-35ecbd78b9b1 RateId: 33667cab-f17f-4089-ad07-c2cd50fa0df1 Notes: Test reservation ProductOrders: - ProductId: 3dc5d79b-67ce-48ed-9238-47fcf5d1a59f PersonCounts: - AgeCategoryId: 1f67644f-052d-4863-acdf-ae1600c60ca0 Count: 2 - AgeCategoryId: ab58c939-be30-4a60-8f75-ae1600c60c9f Count: 2 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReservationPricingResult' example: ReservationPrices: - Identifier: '1234' Total: Currency: GBP NetValue: 20 GrossValue: 23 TaxValues: - Code: UK-S Value: 3 '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: ReservationsPrice400Example: summary: Default reservations_price 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: ReservationsPrice401Example: summary: Default reservations_price 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: ReservationsPrice403Example: summary: Default reservations_price 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: ReservationsPrice408Example: summary: Default reservations_price 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: ReservationsPrice204Example: summary: Default reservations_price 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: ReservationsPrice429Example: summary: Default reservations_price 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: ReservationsPrice500Example: summary: Default reservations_price 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/restrictions/set: post: tags: - Restrictions summary: Mews Set Restrictions description: "Adds new restrictions with the specified conditions. For improved efficiency, multiple similar restrictions will be merged into a single restriction. A quota of 150,000 restrictions per service applies, although it is unlikely to be exceeded because of the merging algorithm. For more information about the merging algorithm, see [Restrictions concepts](https://mews-systems.gitbook.io/connector-api/concepts/restrictions).\r\n\r\nCare is needed to specify `StartUtc` and `EndUtc` in the correct format - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes).\r\n\r\nOnly restrictions created through the API are affected by this operation, *not* restrictions created by the user within **Mews Operations**. Similarly, if a user creates a restriction in **Mews Operations**, this will *not* affect restrictions created through the API." operationId: restrictions_set requestBody: content: application/json: schema: $ref: '#/components/schemas/SetRestrictionParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 Data: - Type: Start ExactRateId: ed4b660b-19d0-434b-9360-a4de2ea42eda ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f StartUtc: '2023-02-15T00:00:00Z' EndUtc: '2023-02-22T00:00:00Z' Days: Monday: false Tuesday: false Wednesday: false Thursday: false Friday: true Saturday: true Sunday: true MinLength: P0M2DT0H0M0S MaxLength: P0M7DT0H0M0S - Type: Start BaseRateId: e5b538b1-36e6-43a0-9f5c-103204c7f68e StartUtc: '2023-02-23T00:00:00Z' EndUtc: '2023-03-03T00:00:00Z' Days: Monday: true Tuesday: true Wednesday: true Thursday: true Friday: true Saturday: false Sunday: false MinAdvance: P0Y0M1DT0H0M0S MaxAdvance: P0Y0M3DT0H0M0S 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: RestrictionsSet400Example: summary: Default restrictions_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: RestrictionsSet401Example: summary: Default restrictions_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: RestrictionsSet403Example: summary: Default restrictions_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: RestrictionsSet408Example: summary: Default restrictions_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: RestrictionsSet204Example: summary: Default restrictions_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: RestrictionsSet429Example: summary: Default restrictions_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: RestrictionsSet500Example: summary: Default restrictions_set 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '409': description: The request cannot be completed because the data has changed, causing conflict between the state on the client and the server. To get around this error, try refreshing the data on the client and resubmitting the request. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: RestrictionsSet409Example: summary: Default restrictions_set 409 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/restrictions/clear: post: tags: - Restrictions summary: Mews Clear Restrictions description: "Deletes restrictions that exactly match the specified conditions, using a splicing algorithm. This operation is intended to be used alongside [Set restrictions](https://mews-systems.gitbook.io/connector-api/operations/restrictions#set-restrictions). The specified conditions must be met exactly. The time interval, however, does not need to correspond to an existing restriction in the system, instead the API uses a splicing algorithm to work out how to divide up any existing restrictions to meet the specified time interval. For details about matching conditions and the splicing algorithm, see [Concepts > Restrictions](https://mews-systems.gitbook.io/connector-api/concepts/restrictions).\r\n\r\nOnly restrictions created through the API are affected by this operation, *not* restrictions created by the user within **Mews Operations**. Similarly, if a user creates a restriction in **Mews Operations**, this will *not* affect restrictions created through the API." operationId: restrictions_clear requestBody: content: application/json: schema: $ref: '#/components/schemas/ClearRestrictionParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 Data: - Type: Start ExactRateId: ed4b660b-19d0-434b-9360-a4de2ea42eda ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f StartUtc: '2023-02-15T00:00:00Z' EndUtc: '2023-02-22T00:00:00Z' Days: Monday: false Tuesday: false Wednesday: false Thursday: false Friday: true Saturday: true Sunday: true - Type: Start BaseRateId: e5b538b1-36e6-43a0-9f5c-103204c7f68e StartUtc: '2023-02-23T00:00:00Z' EndUtc: '2023-03-03T00:00:00Z' Days: Monday: true Tuesday: true Wednesday: true Thursday: true Friday: true Saturday: false Sunday: false 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: RestrictionsClear400Example: summary: Default restrictions_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: RestrictionsClear401Example: summary: Default restrictions_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: RestrictionsClear403Example: summary: Default restrictions_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: RestrictionsClear408Example: summary: Default restrictions_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: RestrictionsClear204Example: summary: Default restrictions_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: RestrictionsClear429Example: summary: Default restrictions_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: RestrictionsClear500Example: summary: Default restrictions_clear 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '409': description: The request cannot be completed because the data has changed, causing conflict between the state on the client and the server. To get around this error, try refreshing the data on the client and resubmitting the request. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: RestrictionsClear409Example: summary: Default restrictions_clear 409 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/restrictions/getAll: post: tags: - Restrictions summary: Mews Get All Restrictions description: 'Returns all restrictions of the default service provided 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: restrictions_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/RestrictionFilterParameters' 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: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 ResourceCategoryIds: - 34c29e73-c8db-4e93-b51b-981e42655e03 RateIds: - ed4b660b-19d0-434b-9360-a4de2ea42eda Origin: Integration CollidingUtc: StartUtc: '2020-02-15T00:00:00Z' EndUtc: '2020-02-20T00:00:00Z' CreatedUtc: StartUtc: '2020-02-05T00:00:00Z' EndUtc: '2020-02-15T00:00:00Z' UpdatedUtc: StartUtc: '2020-02-05T00:00:00Z' EndUtc: '2020-02-15T00:00:00Z' Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RestrictionResult' example: Restrictions: - Id: 40c24757-c16e-4094-91d3-4ca952e488a1 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 ExternalIdentifier: '5678' Origin: Integration Conditions: Type: Stay ExactRateId: 7c7e89d6-69c0-4cce-9d42-35443f2193f3 BaseRateId: RateGroupId: ResourceCategoryId: 86336EAC-4168-46B1-A544-2A47251BF864 ResourceCategoryType: StartUtc: '2018-10-09T00:00:00Z' EndUtc: '2018-10-31T00:00:00Z' Days: - Saturday - Sunday Exceptions: MinAdvance: MaxAdvance: MinLength: P0M2DT0H0M0S MaxLength: P0M7DT0H0M0S MinPrice: Value: 50 Currency: EUR MaxPrice: Value: 150 Currency: EUR - Id: b40ac4a8-f5da-457d-88fe-7a895e1580ab ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 ExternalIdentifier: '5678' Origin: Integration Conditions: Type: Start ExactRateId: BaseRateId: e5b538b1-36e6-43a0-9f5c-103204c7f68e RateGroupId: ResourceCategoryId: ResourceCategoryType: Room StartUtc: '2018-10-01T00:00:00Z' EndUtc: '2018-10-31T00:00:00Z' Days: - Monday - Tuesday - Wednesday - Thursday - Friday Exceptions: MinAdvance: P0M1DT0H0M0S MaxAdvance: P0M3DT0H0M0S MinLength: MaxLength: MinPrice: MaxPrice: Cursor: b40ac4a8-f5da-457d-88fe-7a895e1580ab '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: RestrictionsGetAll400Example: summary: Default restrictions_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: RestrictionsGetAll401Example: summary: Default restrictions_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: RestrictionsGetAll403Example: summary: Default restrictions_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: RestrictionsGetAll408Example: summary: Default restrictions_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: RestrictionsGetAll204Example: summary: Default restrictions_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: RestrictionsGetAll429Example: summary: Default restrictions_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: RestrictionsGetAll500Example: summary: Default restrictions_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/routingRules/getAll: post: tags: - Routing rules summary: Mews Get All Routing Rules description: Use [Get all billing automations](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#get-all-billing-automations). operationId: routingRules_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/RoutingRuleFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 CompanyIds: - c6f5c82d-621a-4c8a-903b-1b0a9a23b71f - 956aa0f0-a090-42c8-bee2-991972d32f80 RoutingRuleIds: - ff785b22-5422-4d1d-87f4-af2e00b3dfda - d98c9611-0006-4691-a835-af2e00b170c4 UpdatedUtc: StartUtc: '2023-10-01T00:00:00Z' EndUtc: '2023-10-31T00:00:00Z' 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/RoutingRuleResult' example: RoutingRules: - Id: ff785b22-5422-4d1d-87f4-af2e00b3dfda EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f CompanyRelation: PartnerCompany Applicability: PrepaidOnly RouteType: AllStayItems ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 SelectedStayItems: CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' - Id: d98c9611-0006-4691-a835-af2e00b170c4 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 CompanyId: c021013e-4930-4592-8e32-91b0b1fc9663 CompanyRelation: TravelAgency Applicability: Always RouteType: SelectedStayItems ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 SelectedStayItems: Nights: true CityTax: true ProductCategoryIds: - 004fa262-7b08-4853-b544-af2a00d5cf1f - 8f0dc6ef-1fd4-44e4-b353-af2c00b24caf - d4c1b435-0ed1-4d98-9833-af2c00b28518 CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' Cursor: d98c9611-0006-4691-a835-af2e00b170c4 '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: RoutingRulesGetAll400Example: summary: Default routingRules_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: RoutingRulesGetAll401Example: summary: Default routingRules_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: RoutingRulesGetAll403Example: summary: Default routingRules_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: RoutingRulesGetAll408Example: summary: Default routingRules_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: RoutingRulesGetAll204Example: summary: Default routingRules_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: RoutingRulesGetAll429Example: summary: Default routingRules_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: RoutingRulesGetAll500Example: summary: Default routingRules_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string deprecated: true x-deprecatedMessage: Use [Get all billing automations](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#get-all-billing-automations). x-microcks-operation: *id001 /api/connector/v1/routingRules/add: post: tags: - Routing rules summary: Mews Add Routing Rules description: Use [Add billing automations](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#add-billing-automations). operationId: routingRules_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleRoutingRuleAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RoutingRules: - CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 CompanyRelation: PartnerCompany Applicability: PrepaidOnly RouteType: AllStayItems - CompanyId: c021013e-4930-4592-8e32-91b0b1fc9663 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 CompanyRelation: TravelAgency Applicability: Always RouteType: SelectedStayItems AssignmentTargetType: CompanyAsDetails SelectedStayItems: Nights: true CityTax: true ProductCategoryIds: - 004fa262-7b08-4853-b544-af2a00d5cf1f - 8f0dc6ef-1fd4-44e4-b353-af2c00b24caf - d4c1b435-0ed1-4d98-9833-af2c00b28518 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RoutingRuleAdditionResult' example: RoutingRules: - Id: ff785b22-5422-4d1d-87f4-af2e00b3dfda EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f CompanyRelation: PartnerCompany Applicability: PrepaidOnly RouteType: AllStayItems ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 SelectedStayItems: CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' - Id: d98c9611-0006-4691-a835-af2e00b170c4 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 CompanyId: c021013e-4930-4592-8e32-91b0b1fc9663 CompanyRelation: TravelAgency Applicability: Always RouteType: SelectedStayItems ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 SelectedStayItems: Nights: true CityTax: true ProductCategoryIds: - 004fa262-7b08-4853-b544-af2a00d5cf1f - 8f0dc6ef-1fd4-44e4-b353-af2c00b24caf - d4c1b435-0ed1-4d98-9833-af2c00b28518 CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' '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: RoutingRulesAdd400Example: summary: Default routingRules_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: RoutingRulesAdd401Example: summary: Default routingRules_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: RoutingRulesAdd403Example: summary: Default routingRules_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: RoutingRulesAdd408Example: summary: Default routingRules_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: RoutingRulesAdd204Example: summary: Default routingRules_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: RoutingRulesAdd429Example: summary: Default routingRules_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: RoutingRulesAdd500Example: summary: Default routingRules_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string deprecated: true x-deprecatedMessage: Use [Add billing automations](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#add-billing-automations). x-microcks-operation: *id001 /api/connector/v1/routingRules/update: post: tags: - Routing rules summary: Mews Update Routing Rules description: Use [Update billing automations](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#update-billing-automations) and [Update billing automations assignments](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#update-billing-automations-assignments). operationId: routingRules_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleRoutingRuleUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RoutingRuleUpdates: - RoutingRuleId: ff785b22-5422-4d1d-87f4-af2e00b3dfda CompanyId: Value: c021013e-4930-4592-8e32-91b0b1fc9663 ServiceId: Value: bd26d8db-86da-4f96-9efc-e5a4654a4a94 CompanyRelation: Value: PartnerCompany Applicability: Value: Always RouteType: Value: AllStayItems - RoutingRuleId: d98c9611-0006-4691-a835-af2e00b170c4 CompanyId: Value: a793d381-65a2-4fa6-9514-00c4c5bfe607 ServiceId: Value: bd26d8db-86da-4f96-9efc-e5a4654a4a94 CompanyRelation: Value: TravelAgency Applicability: Value: Always RouteType: Value: SelectedStayItems AssignmentTargetType: Value: CompanyAsDetails SelectedStayItems: Nights: Value: false CityTax: Value: true ProductCategoryIds: Value: - 004fa262-7b08-4853-b544-af2a00d5cf1f responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RoutingRuleUpdateResult' example: RoutingRules: - Id: ff785b22-5422-4d1d-87f4-af2e00b3dfda EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 CompanyId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f CompanyRelation: PartnerCompany Applicability: PrepaidOnly RouteType: AllStayItems ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 SelectedStayItems: CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' - Id: d98c9611-0006-4691-a835-af2e00b170c4 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 CompanyId: c021013e-4930-4592-8e32-91b0b1fc9663 CompanyRelation: TravelAgency Applicability: Always RouteType: SelectedStayItems ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 SelectedStayItems: Nights: true CityTax: true ProductCategoryIds: - 004fa262-7b08-4853-b544-af2a00d5cf1f - 8f0dc6ef-1fd4-44e4-b353-af2c00b24caf - d4c1b435-0ed1-4d98-9833-af2c00b28518 CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' '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: RoutingRulesUpdate400Example: summary: Default routingRules_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: RoutingRulesUpdate401Example: summary: Default routingRules_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: RoutingRulesUpdate403Example: summary: Default routingRules_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: RoutingRulesUpdate408Example: summary: Default routingRules_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: RoutingRulesUpdate204Example: summary: Default routingRules_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: RoutingRulesUpdate429Example: summary: Default routingRules_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: RoutingRulesUpdate500Example: summary: Default routingRules_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string deprecated: true x-deprecatedMessage: Use [Update billing automations](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#update-billing-automations) and [Update billing automations assignments](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#update-billing-automations-assignments). x-microcks-operation: *id001 /api/connector/v1/routingRules/delete: post: tags: - Routing rules summary: Mews Delete Routing Rules description: Use [Delete billing automations](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#delete-billing-automations). operationId: routingRules_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/RoutingRuleDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RoutingRuleIds: - ff785b22-5422-4d1d-87f4-af2e00b3dfda - d98c9611-0006-4691-a835-af2e00b170c4 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: RoutingRulesDelete400Example: summary: Default routingRules_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: RoutingRulesDelete401Example: summary: Default routingRules_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: RoutingRulesDelete403Example: summary: Default routingRules_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: RoutingRulesDelete408Example: summary: Default routingRules_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: RoutingRulesDelete204Example: summary: Default routingRules_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: RoutingRulesDelete429Example: summary: Default routingRules_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: RoutingRulesDelete500Example: summary: Default routingRules_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string deprecated: true x-deprecatedMessage: Use [Delete billing automations](https://mews-systems.gitbook.io/connector-api/operations/billingautomations#delete-billing-automations). x-microcks-operation: *id001 /api/connector/v1/sourceAssignments/getAll: post: tags: - Source assignments summary: Mews Get All Source Assignments description: Returns all Sources assigned to a Reservation group. Each reservation group can have multiple sources. 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: sourceAssignments_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/SourceAssignmentFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationGroupIds: - 730d050c-8098-415a-95af-af2500a2de47 UpdatedUtc: StartUtc: '2023-02-1T00:00:00Z' EndUtc: '2023-02-28T00:00:00Z' EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SourceAssignmentResult' example: SourceAssignments: - Id: 670ef167-0380-4dd5-8dbb-af1500d3eb16 ReservationGroupId: 730d050c-8098-415a-95af-af2500a2de47 SourceId: de6c3fcc-feb9-4385-92e0-af25008b864e IsPrimary: true - Id: da272c89-3afc-4e6f-ad12-af2500a2de79 ReservationGroupId: 730d050c-8098-415a-95af-af2500a2de47 SourceId: 04db79fa-3a31-47c3-ae25-af25008b864e IsPrimary: false Cursor: da272c89-3afc-4e6f-ad12-af2500a2de79 '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: SourceAssignmentsGetAll400Example: summary: Default sourceAssignments_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: SourceAssignmentsGetAll401Example: summary: Default sourceAssignments_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: SourceAssignmentsGetAll403Example: summary: Default sourceAssignments_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: SourceAssignmentsGetAll408Example: summary: Default sourceAssignments_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: SourceAssignmentsGetAll204Example: summary: Default sourceAssignments_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: SourceAssignmentsGetAll429Example: summary: Default sourceAssignments_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: SourceAssignmentsGetAll500Example: summary: Default sourceAssignments_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/sourceAssignments/getAll/2024-09-20: post: tags: - Source assignments summary: Mews Get All Source Assignments (ver 2024-09-20) description: Returns all Sources assigned to Reservations. Each reservation can have multiple sources. 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: sourceAssignments_getAll_2024-09-20 requestBody: content: application/json: schema: $ref: '#/components/schemas/SourceAssignmentFilterParametersV20240920' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ReservationIds: - 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 UpdatedUtc: StartUtc: '2025-11-01T00:00:00Z' EndUtc: '2025-11-30T00:00:00Z' EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SourceAssignmentResultV20240920' example: SourceAssignments: - Id: c5e11f73-7e85-4a3c-9fe1-872014a10b43 ReservationId: 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 SourceId: 22e42a59-b321-43f8-a5d1-af1f00e1bb8b IsPrimary: true UpdatedUtc: '2025-11-05T11:00:00Z' - Id: 5411ffd5-72c6-4ab3-b179-708bcac73d08 ReservationId: 9b59b50d-bd32-4ce5-add8-09ea0e1300e7 SourceId: bbe29c21-401a-4746-b97d-af1f00e1bb8b IsPrimary: false UpdatedUtc: '2025-11-11T05:00:00Z' Cursor: 5411ffd5-72c6-4ab3-b179-708bcac73d08 '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: SourceAssignmentsGetAll20240920400Example: summary: Default sourceAssignments_getAll_2024-09-20 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: SourceAssignmentsGetAll20240920401Example: summary: Default sourceAssignments_getAll_2024-09-20 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: SourceAssignmentsGetAll20240920403Example: summary: Default sourceAssignments_getAll_2024-09-20 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: SourceAssignmentsGetAll20240920408Example: summary: Default sourceAssignments_getAll_2024-09-20 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: SourceAssignmentsGetAll20240920204Example: summary: Default sourceAssignments_getAll_2024-09-20 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: SourceAssignmentsGetAll20240920429Example: summary: Default sourceAssignments_getAll_2024-09-20 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: SourceAssignmentsGetAll20240920500Example: summary: Default sourceAssignments_getAll_2024-09-20 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/sources/getAll: post: tags: - Sources summary: Mews Get All Sources description: Returns all sources from which reservations can originate. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/). operationId: sources_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/SourceFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 UpdatedUtc: StartUtc: '2023-01-05T00:00:00Z' EndUtc: '2023-01-10T00:00:00Z' SourceIds: - bbe29c21-401a-4746-b97d-af1f00e1bb8b - 22e42a59-b321-43f8-a5d1-af1f00e1bb8b - b5a55d41-bbc5-48d0-a01b-af1f00e1bb8b Limitation: Count: 10 Cursor: responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SourceResult' example: Sources: - Id: bbe29c21-401a-4746-b97d-af1f00e1bb8b Name: Booking.com Type: OnlineTravelAgency UpdatedUtc: '2023-01-05T12:00:00Z' - Id: 22e42a59-b321-43f8-a5d1-af1f00e1bb8b Name: Hostelworld Type: OnlineTravelAgency UpdatedUtc: '2023-01-06T12:00:00Z' - Id: b5a55d41-bbc5-48d0-a01b-af1f00e1bb8b Name: SynXis Type: OnlineTravelAgency UpdatedUtc: '2023-01-06T12:00:00Z' Cursor: b5a55d41-bbc5-48d0-a01b-af1f00e1bb8b '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: SourcesGetAll400Example: summary: Default sources_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: SourcesGetAll401Example: summary: Default sources_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: SourcesGetAll403Example: summary: Default sources_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: SourcesGetAll408Example: summary: Default sources_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: SourcesGetAll204Example: summary: Default sources_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: SourcesGetAll429Example: summary: Default sources_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: SourcesGetAll500Example: summary: Default sources_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 components: schemas: AvailabilityAdjustment: title: Availability adjustment required: - ActivityState - FirstTimeUnitStartUtc - Id - IsActive - LastTimeUnitStartUtc - ResourceCategoryId - UnitCount - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the [Availability adjustment](https://mews-systems.gitbook.io/connector-api/operations/#availability-adjustment). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AvailabilityBlockId: type: string description: Unique identifier of the [Availability block](https://mews-systems.gitbook.io/connector-api/operations/availabilityblocks/#availability-block) which the availability adjustment belongs to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource-category) whose availability is updated. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 StartUtc: type: string description: Start of the interval in UTC timezone in ISO 8601 format. nullable: true deprecated: true example: string EndUtc: type: string description: End of the interval in UTC timezone in ISO 8601 format. nullable: true deprecated: true example: string 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/operations/services/#time-unit), 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/operations/services/#time-unit), in UTC timezone ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UnitCount: type: integer description: Adjustment value applied on the interval. format: int32 example: 1 ActivityState: title: Activity state allOf: - $ref: '#/components/schemas/ActivityStateEnum' description: 'Shows whether the availability adjustment is active or deleted. Deleted Active' deprecated: true x-enumNames: - Deleted - Active x-enumDescriptions: - '' - '' x-deprecatedMessage: Use `IsActive` instead. example: string ReleaseOverrideUtc: type: string description: Exact moment the availability adjustment is released if set; overrides the release strategy of the associated availability block. format: date-time nullable: true example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the adjustment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' IsActive: type: boolean description: Whether the availability adjustment is still active. example: true PaxCounts: maxItems: 5 type: array items: $ref: '#/components/schemas/PaxCount' description: Collection of predicted occupancy of availability adjustments. Relates to how many adjustments are assigned to each count of guests. nullable: true FirstTimeUnitReleaseUtc: type: string description: Exact moment the first time unit of the availability adjustment is released based on `ReleaseOverrideUtc` or the `ReleaseStrategy` of the associated availability block, or the `OperationalEditableHistoryInterval` of the associated enterprise if not set, or `null` if `AvailabilityBlockId` is `null`. format: date-time nullable: true example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: AvailabilityAdjustment 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 ServiceOrderStateOld: title: Service order state (ver 2017-04-12) enum: - Enquired - Confirmed - Started - Processed - Canceled - Optional - Requested type: string CancellationPolicyByReservation: title: Cancellation policy data grouped by reservation required: - Policies - ReservationId type: object properties: ReservationId: type: string description: Unique identifier of the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Policies: type: array items: $ref: '#/components/schemas/CancellationPolicyData' description: Collection of cancellation policy data. additionalProperties: false x-schema-id: CancellationPolicyByReservation 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 ProductOrderItemData: title: Product order item data required: - ProductId type: object properties: ProductId: type: string description: Unique identifier of the `Product`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AgeCategoryId: type: string description: Unique identifier of the `AgeCategory`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ProductOrderItemData RateSetData: title: Set rate parameters required: - Names - PricingType - ServiceId - Type type: object properties: Id: type: string description: Unique identifier of the rate. If it matches an existing rate, that rate will be updated. If no match is found, an error will be returned. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ExternalIdentifier: maxLength: 255 type: string description: Unique identifier of the rate in the external system. If `Id` is not provided and `ExternalIdentifier` matches an existing rate, the corresponding rate will be updated. If no match is found, a new rate will be created. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: minLength: 1 type: string description: Unique identifier of the service. Ignored in case of updating an existing rate. x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateGroupId: type: string description: Unique identifier of the rate group under which rate is assigned. Empty value means that rate is added to a default group or the current group is kept for update, respectively. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsEnabled: type: boolean description: Whether the rate is available to customers. `true` will be used as a default if not provided. nullable: true example: true Type: title: Rate Add Type allOf: - $ref: '#/components/schemas/RateAddTypeEnum' description: 'Type of the rate. `Private` will be used as a default if not provided. Public Private' example: string Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name of the rate. x-schema-id: LocalizedStrings Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. nullable: true x-schema-id: LocalizedStrings PricingType: title: Rate pricing discriminator allOf: - $ref: '#/components/schemas/RatePricingDiscriminatorEnum' description: 'Rate pricing type. Must match existing pricing type in case of update. BaseRatePricing DependentRatePricing' x-enumNames: - BaseRatePricing - DependentRatePricing x-enumDescriptions: - '' - '' example: string Pricing: title: Rate set pricing data parameters allOf: - $ref: '#/components/schemas/RateSetPricingDataParameters' description: Contains additional data about pricing of the rate. nullable: true example: string additionalProperties: false x-schema-id: RateSetData AvailabilityBlockExtent: title: Availability block extent type: object properties: AvailabilityBlocks: type: boolean description: Whether the response should contain the general availability blocks. nullable: true example: true Adjustments: type: boolean description: Whether the response should contain individual availability adjustments related to availability blocks. nullable: true example: true ServiceOrders: type: boolean description: Whether the response should contain reservations related to availability blocks. nullable: true deprecated: true x-deprecatedMessage: Use [Get all reservations (ver 2023-06-06)](https://mews-systems.gitbook.io/connector-api/operations/reservations#get-all-reservations-ver-2023-06-06) instead. example: true Rates: type: boolean description: Whether the response should contain rates related to availability blocks. nullable: true deprecated: true x-deprecatedMessage: Use [Get all rates](https://mews-systems.gitbook.io/connector-api/operations/rates#get-all-rates) instead. example: true additionalProperties: false description: '' x-schema-id: AvailabilityBlockExtent IdentityDocumentTypeEnum: title: Document type enum: - IdentityCard - Passport - Visa - DriversLicense type: string description: ' IdentityCard Passport Visa DriversLicense' x-enumNames: - IdentityCard - Passport - Visa - DriversLicense x-enumDescriptions: - '' - '' - '' - '' RateGroup: title: Rate Group required: - CreatedUtc - Id - IsActive - Names - Ordering - ServiceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the rate group. 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) the rate group belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the rate group is still active. example: true CreatedUtc: minLength: 1 type: string description: Creation date and time of the rate group 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 rate group in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' Ordering: type: integer description: Ordering of the rate group. format: int32 example: 1 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. nullable: true x-schema-id: LocalizedStrings Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. nullable: true x-schema-id: LocalizedStrings ExternalIdentifier: maxLength: 255 type: string description: Identifier of the rate group from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: RateGroup Restriction: title: Restriction required: - Conditions - Id - Origin - ServiceId type: object properties: Id: type: string description: Unique identifier of the restriction. 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 ExternalIdentifier: type: string description: External identifier of the restriction. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Origin: title: Restriction origin allOf: - $ref: '#/components/schemas/RestrictionOriginEnum' description: 'Restriction origin User (Restriction was created by a user in Mews.) Integration (Restriction was created by a 3rd-party integration.)' x-enumNames: - User - Integration x-enumDescriptions: - Restriction was created by a user in Mews. - Restriction was created by a 3rd-party integration. example: string Conditions: title: Restriction condition allOf: - $ref: '#/components/schemas/RestrictionConditions' description: The conditions or rules that must be met by a reservation for the restriction to apply. example: string Exceptions: title: Restriction exception allOf: - $ref: '#/components/schemas/RestrictionExceptions' description: The rules that prevent the restriction from applying to a reservation, even when all conditions have been met. nullable: true example: string additionalProperties: false description: The added restriction. x-schema-id: Restriction CancellationPolicyByReservationParameters: title: CancellationPolicyByReservationParameters required: - AccessToken - Client - ClientToken - ReservationIds 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 ReservationIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Reservation`. additionalProperties: false x-schema-id: CancellationPolicyByReservationParameters AgeCategoryAdjustmentTypeEnum: title: Age category adjustment type enum: - ExtraOccupancyAdjustment - NegativeOccupancyAdjustment - StandardOccupancyAdjustment type: string description: ' ExtraOccupancyAdjustment NegativeOccupancyAdjustment StandardOccupancyAdjustment' x-enumNames: - ExtraOccupancyAdjustment - NegativeOccupancyAdjustment - StandardOccupancyAdjustment x-enumDescriptions: - '' - '' - '' RoutingRuleAssignmentTargetType: title: Assignment target type enum: - CompanyAsDetails - CompanyAsOwner type: string CancellationPolicyApplicability: title: Cancellation Policy Applicability enum: - Creation - Start - StartDate type: string description: Applicability mode of the cancellation policy. CompanionshipDeleteParameters: title: CompanionshipDeleteParameters required: - AccessToken - Client - ClientToken - CustomerId - ReservationId 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 ReservationId: type: string description: Unique identifier of the `Reservation`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Unique identifier of the `Customer`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: CompanionshipDeleteParameters RestrictionConditions: title: Restriction condition required: - Type type: object properties: Type: title: Restriction type allOf: - $ref: '#/components/schemas/RestrictionTypeEnum' description: 'Restriction type. Stay (Guests can''t stay within specified dates.) Start (Guests can''t check in within specified dates.) End (Guests can''t check out within specified dates.)' x-enumNames: - Stay - Start - End x-enumDescriptions: - Guests can't stay within specified dates. - Guests can't check in within specified dates. - Guests can't check out within specified dates. example: string ExactRateId: type: string description: Unique identifier of the restricted exact `Rate`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BaseRateId: type: string description: Unique identifier of the restricted base `Rate`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateGroupId: type: string description: Unique identifier of the restricted `Rate group`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryId: type: string description: Unique identifier of the restricted `Resource category`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryType: allOf: - $ref: '#/components/schemas/ResourceCategoryTypeEnum' description: 'Name of the restricted `Resource category type`. Room Bed Dorm Apartment Suite Villa Site Office MeetingRoom ParkingSpot Desk TeamArea Membership Tent CaravanOrRV UnequippedCampsite Bike ExtraBed Cot Crib ConferenceRoom Rooftop Garden Restaurant Amphitheater PrivateSpaces' nullable: true example: string StartUtc: type: string description: Start date of the restriction time interval, specified in ISO 8601 format and adjusted to UTC - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes) for important information on format and implementation. nullable: true example: string EndUtc: type: string description: End date of the restriction time interval, specified in ISO 8601 format and adjusted to UTC - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes) for important information on format and implementation. nullable: true example: string Days: type: array items: type: string description: The restricted days of week. Defaults to all days when not provided. Ignored when the service uses a time unit longer than a day. nullable: true Hours: title: Hours allOf: - $ref: '#/components/schemas/Hours' description: The restricted hours. Defaults to all hours when not provided. nullable: true example: string additionalProperties: false description: The conditions or rules that must be met by a reservation for the restriction to apply. x-schema-id: RestrictionConditions 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 RestrictionOrigin: title: Restriction origin enum: - User - Integration type: string x-enumDescriptions: - Restriction was created by a user in Mews. - Restriction was created by a 3rd-party integration. ActivityStateEnum: title: Activity state enum: - Deleted - Active type: string description: ' Deleted Active' x-enumNames: - Deleted - Active x-enumDescriptions: - '' - '' Hours: title: Hours required: - Eight - Eighteen - Eleven - Fifteen - Five - Four - Fourteen - Nine - Nineteen - One - Seven - Seventeen - Six - Sixteen - Ten - Thirteen - Three - Twelve - Twenty - TwentyOne - TwentyThree - TwentyTwo - Two - Zero type: object properties: Zero: type: boolean description: Hour 0 enabled example: true One: type: boolean description: Hour 1 enabled example: true Two: type: boolean description: Hour 2 enabled example: true Three: type: boolean description: Hour 3 enabled example: true Four: type: boolean description: Hour 4 enabled example: true Five: type: boolean description: Hour 5 enabled example: true Six: type: boolean description: Hour 6 enabled example: true Seven: type: boolean description: Hour 7 enabled example: true Eight: type: boolean description: Hour 8 enabled example: true Nine: type: boolean description: Hour 9 enabled example: true Ten: type: boolean description: Hour 10 enabled example: true Eleven: type: boolean description: Hour 11 enabled example: true Twelve: type: boolean description: Hour 12 enabled example: true Thirteen: type: boolean description: Hour 13 enabled example: true Fourteen: type: boolean description: Hour 14 enabled example: true Fifteen: type: boolean description: Hour 15 enabled example: true Sixteen: type: boolean description: Hour 16 enabled example: true Seventeen: type: boolean description: Hour 17 enabled example: true Eighteen: type: boolean description: Hour 18 enabled example: true Nineteen: type: boolean description: Hour 19 enabled example: true Twenty: type: boolean description: Hour 20 enabled example: true TwentyOne: type: boolean description: Hour 21 enabled example: true TwentyTwo: type: boolean description: Hour 22 enabled example: true TwentyThree: type: boolean description: Hour 23 enabled example: true additionalProperties: false x-schema-id: Hours SourceResult: title: SourceResult required: - Sources type: object properties: Sources: type: array items: $ref: '#/components/schemas/Source' description: The reservation sources. Cursor: type: string description: Unique identifier of the last and hence oldest source 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 sources. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: SourceResult GuidUpdateValue: title: Guid update value type: object properties: Value: type: string description: Value which is to be updated. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: GuidUpdateValue SourceType: title: Source type enum: - OnlineTravelAgency - CentralReservationSystem - GlobalDistributionSystem - AlternativeDistributionSystem - SalesAndCateringSystem - PropertyManagementSystem - TourOperatorSystem - OnlineBookingEngine - Kiosk - Agent type: string description: Type of the source. RestrictionResult: title: RestrictionResult required: - Restrictions type: object properties: Restrictions: type: array items: $ref: '#/components/schemas/Restriction' description: Restrictions 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: RestrictionResult ReservationGroupOld: title: Reservation groups (ver 2017-04-12) type: object properties: Id: type: string description: Unique identifier of the reservation group. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: type: string description: Name of the reservation group. nullable: true example: Example Name additionalProperties: false x-schema-id: ReservationGroupOld ResourceCategory: title: Resource category required: - Capacity - Classification - Descriptions - EnterpriseId - ExtraCapacity - Id - IsActive - Names - Ordering - ServiceId - ShortNames - Type type: object properties: Id: type: string description: Unique identifier of the category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. 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 IsActive: type: boolean description: Whether the category is still active. example: true Type: $ref: '#/components/schemas/ResourceCategoryType' Classification: $ref: '#/components/schemas/ResourceClassification' Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings ShortNames: title: Localized text type: object additionalProperties: type: string description: All translations of the short name. x-schema-id: LocalizedStrings Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. x-schema-id: LocalizedStrings Ordering: type: integer description: Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed). format: int32 example: 1 Capacity: type: integer description: Capacity that can be served (e.g. bed count). format: int32 example: 1 ExtraCapacity: type: integer description: Extra capacity that can be served (e.g. extra bed count). format: int32 example: 1 ExternalIdentifier: maxLength: 255 type: string description: Identifier of the resource category from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string description: Unique identifier of the accounting category. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceCategory AgeCategoryAdjustment: title: Age category adjustment required: - AbsoluteValue - AgeCategoryId - Type type: object properties: AgeCategoryId: type: string description: Unique identifier of the age category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AbsoluteValue: type: number description: Absolute value of the adjustment (e.g. `50` represents 50 EUR in case the rate currency is `EUR`). format: double example: 100.0 Type: title: Age category adjustment type allOf: - $ref: '#/components/schemas/AgeCategoryAdjustmentTypeEnum' description: 'Age category adjustment type ExtraOccupancyAdjustment NegativeOccupancyAdjustment StandardOccupancyAdjustment' x-enumNames: - ExtraOccupancyAdjustment - NegativeOccupancyAdjustment - StandardOccupancyAdjustment x-enumDescriptions: - '' - '' - '' example: string additionalProperties: false x-schema-id: AgeCategoryAdjustment DaysParameters: title: Days parameters required: - Friday - Monday - Saturday - Sunday - Thursday - Tuesday - Wednesday type: object properties: Monday: type: boolean description: Monday enabled example: true Tuesday: type: boolean description: Tuesday enabled example: true Wednesday: type: boolean description: Wednesday enabled example: true Thursday: type: boolean description: Thursday enabled example: true Friday: type: boolean description: Friday enabled example: true Saturday: type: boolean description: Saturday enabled example: true Sunday: type: boolean description: Sunday enabled example: true additionalProperties: false x-schema-id: DaysParameters ConfirmReservationParameters: title: ConfirmReservationParameters required: - AccessToken - Client - ClientToken - ReservationIds 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 ReservationIds: type: array items: type: string format: uuid description: Unique identifier of the reservations to confirm. SendConfirmationEmail: type: boolean description: Wheter the confirmation email is sent. Default value is true. nullable: true example: true additionalProperties: false x-schema-id: ConfirmReservationParameters Customer: title: Customer required: - ChainId - Classifications - CreatedUtc - CreatorProfileId - Id - IsActive - LastName - Number - Options - PreferredSpaceFeatures - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the customer. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ChainId: type: string description: Unique identifier of the chain. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Number: maxLength: 19 minLength: 1 type: string description: Unique number of the customer (max 19 digits). example: '1001' Title: allOf: - $ref: '#/components/schemas/Title' description: 'Title of the customer. Mister (Mr.) Miss (Ms.) Misses (Mrs.)' nullable: true example: string Sex: allOf: - $ref: '#/components/schemas/SexEnum' description: 'Sex of the customer. Male Female' nullable: true example: string FirstName: type: string description: First name of the customer. nullable: true example: Example Name LastName: minLength: 1 type: string description: Last name of the customer. example: Example Name SecondLastName: type: string description: Second last name of the customer. nullable: true example: Example Name NationalityCode: type: string description: ISO 3166-1 code of the [Country](https://mews-systems.gitbook.io/connector-api/operations/countries/#country). nullable: true example: string PreferredLanguageCode: type: string description: 'Language and culture code of the customer''s preferred language, according to their profile. For example: `en-GB`, `fr-CA`.' nullable: true example: string LanguageCode: type: string description: Language and culture code of the customer's language, based on multiple sources. These sources include the preferred language specified in internal data based on previous bookings, and the preferred language of the customer specified in their profile. If neither of these sources are present, we use the native language based on the customer's nationality. The format is, for example, `en-US` or `fr-FR`. nullable: true example: string BirthDate: type: string description: Date of birth in ISO 8601 format. nullable: true example: string BirthCountryCode: type: string description: ISO 3166-1 alpha-2 code of the birth country. nullable: true example: string BirthCountrySubdivisionCode: type: string description: ISO 3166-2 code of the administrative division, e.g. ES-C. nullable: true example: string BirthPlace: type: string description: Place of birth. nullable: true example: string Occupation: type: string description: Occupation of the customer. nullable: true example: string Email: type: string description: Email address of the customer. nullable: true example: partner@example.com HasOtaEmail: type: boolean description: Whether the customer's email address is a temporary email address from an OTA. For more details, see the [product documentation](https://help.mews.com/s/article/how-to-maintain-ota-guest-profiles-with-verified-email-addresses-obtained-from-the-guest-portal). example: true Phone: type: string description: Phone number of the customer (possibly mobile). nullable: true example: string TaxIdentificationNumber: type: string description: Tax identification number of the customer. nullable: true example: '1001' LoyaltyCode: type: string description: Loyalty code of the customer. nullable: true example: string AccountingCode: type: string description: Accounting code of the customer. nullable: true example: string BillingCode: type: string description: Billing code of the customer. nullable: true example: string Notes: type: string description: Internal notes about the customer. nullable: true example: string CarRegistrationNumber: maxLength: 255 type: string description: Registration number of the customer's car. nullable: true example: '1001' DietaryRequirements: maxLength: 255 type: string description: Customer's dietary requirements, e.g. Vegan, Halal. nullable: true example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the customer 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 customer in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' Passport: title: Identity document allOf: - $ref: '#/components/schemas/IdentityDocument' nullable: true deprecated: true x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents. example: string IdentityCard: title: Identity document allOf: - $ref: '#/components/schemas/IdentityDocument' nullable: true deprecated: true x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents. example: string Visa: title: Identity document allOf: - $ref: '#/components/schemas/IdentityDocument' nullable: true deprecated: true x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents. example: string DriversLicense: title: Identity document allOf: - $ref: '#/components/schemas/IdentityDocument' nullable: true deprecated: true x-deprecatedMessage: Use [Get all identity documents](https://mews-systems.gitbook.io/connector-api/operations/identitydocuments#get-all-identity-documents) to fetch identity documents. example: string 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 `Address` of the customer. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Classifications: type: array items: $ref: '#/components/schemas/CustomerClassificationEnum' description: Classifications of the customer. Options: type: array items: $ref: '#/components/schemas/CustomerOptionsEnum' description: Options of the customer. ItalianDestinationCode: type: string description: Value of Italian destination code. nullable: true example: string ItalianFiscalCode: type: string description: Value of Italian fiscal code. nullable: true example: string ItalianLotteryCode: type: string description: Italian lottery code. nullable: true example: string CompanyId: type: string description: Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) the customer is associated with. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 MergeTargetId: type: string description: Unique identifier of the account ([Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer)) to which this customer is linked. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ActivityState: type: string description: '[Activity State](https://mews-systems.gitbook.io/connector-api/operations/#activity-state) of customer record, i.e. whether active or deleted.' nullable: true deprecated: true x-deprecatedMessage: Use `IsActive` instead. example: string IsActive: type: boolean description: Whether the customer record is still active. example: true PreferredSpaceFeatures: type: array items: $ref: '#/components/schemas/ResourceFeatureClassification' description: A list of room preferences, such as view type, bed type, and amenities. CreatorProfileId: type: string description: Unique identifier of the user who created the customer. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UpdaterProfileId: type: string description: Unique identifier of the user who last updated the customer. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: Customer 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 SourceAssignment: title: Source assignment required: - Id - IsPrimary - ReservationGroupId - SourceId type: object properties: Id: type: string description: Unique identifier of the source assignement. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ReservationGroupId: type: string description: Unique identifier of the [Reservation group](https://mews-systems.gitbook.io/connector-api/operations/reservations/#reservation-group). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 SourceId: type: string description: Unique identifier of the [Source](https://mews-systems.gitbook.io/connector-api/operations/sources/#source). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsPrimary: type: boolean description: Specifies the primary source for the [Reservation group](https://mews-systems.gitbook.io/connector-api/operations/reservations/#reservation-group). example: true additionalProperties: false x-schema-id: SourceAssignment RateFilterParameters: title: Rate filter 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 Extent: title: Rate extent allOf: - $ref: '#/components/schemas/RateExtent' description: Extent of data to be returned. If not specified, both `Rates` and `RateGroups` will be included. nullable: true example: string RateIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested [Rates](https://mews-systems.gitbook.io/connector-api/operations/rates/#rate). nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which `Rate` was updated. nullable: true x-max-interval-in-months: 3 example: string ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service) from which the rates are requested. ExternalIdentifiers: maxItems: 1000 type: array items: type: string description: Identifiers of [Rate](https://mews-systems.gitbook.io/connector-api/operations/#rate) from external systems. 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 will be returned. nullable: true additionalProperties: false x-schema-id: RateFilterParameters Resource: title: Resource required: - CreatedUtc - Data - Descriptions - Directions - EnterpriseId - ExternalNames - Id - IsActive - Name - State - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the resource. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the resource is still active. example: true ParentResourceId: type: string description: Identifier of the parent `Resource` (e.g. room of a bed). format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name of the resource (e.g. room number). example: Example Name State: $ref: '#/components/schemas/ResourceState' Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. x-schema-id: LocalizedStrings CreatedUtc: minLength: 1 type: string description: Creation date and time of the resource in UTC timezone in ISO 8601 format. example: string UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource in UTC timezone in ISO 8601 format. example: string Data: title: Resource data type: object properties: Discriminator: $ref: '#/components/schemas/ResourceDataDiscriminator' Value: oneOf: - $ref: '#/components/schemas/SpaceData' - title: Object resource data type: object additionalProperties: false - title: Person resource data type: object additionalProperties: false description: Based on `Discriminator`. Currently present only for `Space` resources with [Space resource data](https://mews-systems.gitbook.io/connector-api/operations/resources#space-resource-data). description: Additional data of the resource. x-coproduct: true x-schema-id: ResourceDataCoproductOfResourceDataDiscriminator ExternalNames: title: Localized text type: object additionalProperties: type: string description: All translations of external name. x-schema-id: LocalizedStrings Directions: title: Localized text type: object additionalProperties: type: string description: All translations of direction. x-schema-id: LocalizedStrings additionalProperties: false x-schema-id: Resource AvailabilityBlockResult: title: AvailabilityBlockResult type: object properties: AvailabilityBlocks: type: array items: $ref: '#/components/schemas/AvailabilityBlock' description: Availability blocks. nullable: true ServiceOrders: type: array items: $ref: '#/components/schemas/ReservationOld' description: Service orders (for example reservations) linked to availability blocks. nullable: true deprecated: true x-deprecatedMessage: Use [Get all reservations (ver 2023-06-06)](https://mews-systems.gitbook.io/connector-api/operations/reservations#get-all-reservations-ver-2023-06-06) instead. Adjustments: type: array items: $ref: '#/components/schemas/AvailabilityAdjustment' description: Availability adjustments of availability blocks. nullable: true Rates: type: array items: $ref: '#/components/schemas/RateForExtent' description: '`Rates` assigned to the block.' nullable: true deprecated: true x-deprecatedMessage: Use [Get all rates](https://mews-systems.gitbook.io/connector-api/operations/rates#get-all-rates) instead. Cursor: type: string description: Unique identifier of the last returned availability block. This can be used in Limitation in a subsequent request to fetch the next batch of availability block. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: AvailabilityBlockResult RateTypeEnum: title: Rate type enum: - Public - Private - AvailabilityBlock type: string description: ' Public Private AvailabilityBlock' x-enumNames: - Public - Private - AvailabilityBlock x-enumDescriptions: - '' - '' - '' AvailabilityBlockDeleteParameters: title: AvailabilityBlockDeleteParameters required: - AccessToken - AvailabilityBlockIds - Client - ClientToken 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 AvailabilityBlockIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifier of the Availability block to delete. additionalProperties: false x-schema-id: AvailabilityBlockDeleteParameters ReservationUpdateIntervalParameters: title: ReservationUpdateIntervalParameters required: - AccessToken - ChargeCancellationFee - Client - ClientToken - ReservationId 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 ReservationId: type: string description: Unique identifier of the reservation to be updated. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 StartUtc: type: string description: New reservation start in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string description: New reservation end in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ChargeCancellationFee: type: boolean description: Whether cancellation fee should be charged for potentially canceled nights. example: true additionalProperties: false x-schema-id: ReservationUpdateIntervalParameters RoutingRuleCompanyRelation: title: Company relation enum: - PartnerCompany - TravelAgency type: string description: Relation of the company to the routing rule. RoutingRuleUpdateParameters: title: Routing rule update parameters required: - RoutingRuleId type: object properties: RoutingRuleId: type: string description: Unique identifier of the routing rule. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Unique identifier of the Company (or null should it not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Unique identifier of the Service routing rule is assigned to (or null should it not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyRelation: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' anyOf: - $ref: '#/components/schemas/RoutingRuleCompanyRelation' description: Company relation to the routing rule (or null should it not be updated). nullable: true example: string Applicability: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' anyOf: - $ref: '#/components/schemas/RoutingRuleApplicability' description: Applicability that determines if routing rule apply to all future reservations with this company or travel agency attached or only future reservations that are prepaid in online travel agency (OTA) (or null should it not be updated). nullable: true example: string RouteType: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' anyOf: - $ref: '#/components/schemas/RoutingRuleRouteType' description: What should be routed Route type (or null should it not be updated). nullable: true example: string AssignmentTargetType: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' anyOf: - $ref: '#/components/schemas/RoutingRuleAssignmentTargetType' description: Relation of company to the bill Assignment target type (or null should it not be updated). nullable: true example: string SelectedStayItems: title: Selected stay items update parameters allOf: - $ref: '#/components/schemas/RoutingRuleStayItemsUpdateParameters' description: To which stay items routing rule applies to. Required only if `RouteType` value is `SelectedStayItems`. nullable: true example: string additionalProperties: false x-schema-id: RoutingRuleUpdateParameters SourceAssignmentFilterParametersV20240920: title: SourceAssignmentFilterParametersV20240920 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 ReservationIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Reservation`. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval of source assignment last update date and time. nullable: true x-max-interval-in-months: 1 example: string EnterpriseIds: maxItems: 1 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. Required when using Portfolio Access Tokens, ignored otherwise. nullable: true additionalProperties: false x-schema-id: SourceAssignmentFilterParametersV20240920 ReservationServiceOrderResult: title: ReservationServiceOrderResult required: - Reservations type: object properties: Reservations: type: array items: $ref: '#/components/schemas/Reservation' description: The reservations of the enterprise. Cursor: type: string description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ReservationServiceOrderResult RateDeleteParameters: title: RateDeleteParameters required: - AccessToken - Client - ClientToken - RateIds 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 RateIds: maxItems: 10 minItems: 1 type: array items: type: string description: Unique identifiers of the rates to be deleted. x-schema-id: HybridIdentifier additionalProperties: false x-schema-id: RateDeleteParameters BooleanUpdateValue: title: Boolean update value type: object properties: Value: type: boolean description: Value which is to be updated. example: true additionalProperties: false x-schema-id: BooleanUpdateValue ReservationOptions: title: Reservation options required: - AllCompanionsCheckedIn - AnyCompanionCheckedIn - 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 companion of the reservation checked in. example: true additionalProperties: false x-schema-id: ReservationOptions ReservationItemResult: title: ReservationItemResult required: - Reservations type: object properties: Reservations: type: array items: $ref: '#/components/schemas/ReservationItems' description: The reservations with their items. additionalProperties: false x-schema-id: ReservationItemResult RoutingRuleUpdateResult: title: RoutingRuleUpdateResult required: - RoutingRules type: object properties: RoutingRules: maxItems: 1000 type: array items: $ref: '#/components/schemas/RoutingRule' description: Updated routing rules. additionalProperties: false x-schema-id: RoutingRuleUpdateResult BusinessSegmentFilterParameters: title: BusinessSegmentFilterParameters 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 Ids: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested `Business segment`. nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Services` from which the business segments are requested. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval of `Business segment` last update date and time. nullable: true x-max-interval-in-months: 3 example: string ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted or both records. nullable: true additionalProperties: false x-schema-id: BusinessSegmentFilterParameters 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 RateAddData: title: Rate parameters required: - Names - PricingType - RateGroupId - ServiceId type: object properties: ServiceId: minLength: 1 type: string description: Unique identifier of the service. x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateGroupId: minLength: 1 type: string description: Unique identifier of the rate group under which rate is assigned. x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsEnabled: type: boolean description: Whether the rate is available to customers. `false` will be used as a default when not provided. nullable: true example: true Type: title: Rate Add Type allOf: - $ref: '#/components/schemas/RateAddTypeEnum' description: 'Type of the rate. Public Private' x-enumNames: - Public - Private x-enumDescriptions: - '' - '' example: string AccountingCategoryId: type: string description: Unique identifier of the accounting category the rate belongs to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BusinessSegmentId: type: string description: Unique identifier of the business segment. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name of the rate. x-schema-id: LocalizedStrings ShortNames: title: Localized text type: object additionalProperties: type: string description: All translations of the short name of the rate. nullable: true x-schema-id: LocalizedStrings 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 Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. nullable: true x-schema-id: LocalizedStrings PricingType: title: Rate pricing discriminator allOf: - $ref: '#/components/schemas/RatePricingDiscriminatorEnum' description: 'Discriminator in which field inside `Pricing` contains additional data. BaseRatePricing DependentRatePricing' x-enumNames: - BaseRatePricing - DependentRatePricing x-enumDescriptions: - '' - '' example: string ExternalIdentifier: maxLength: 255 type: string description: Identifier of the rate from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Pricing: title: Rate add pricing data parameters allOf: - $ref: '#/components/schemas/RateAddPricingDataParameters' description: Contains additional data about pricing of the rate. nullable: true example: string additionalProperties: false x-schema-id: RateAddData UpdateValueCurrencyValueOld: title: Currency value (ver 2018-06-07) update value type: object properties: Value: title: Currency value (ver 2018-06-07) allOf: - $ref: '#/components/schemas/CurrencyValueOld' description: Value in the specified currency. nullable: true example: string additionalProperties: false x-schema-id: UpdateValueCurrencyValueOld AccountType: title: Account type enum: - Company - Customer type: string description: A discriminator specifying the account type, e.g. `Customer` or `Company` ReservationQrCodeData: title: Reservation QR code data type: object properties: ReservationId: type: string description: Unique identifier of the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Data: type: string description: Reservation data for QR code generation. nullable: true example: string additionalProperties: false x-schema-id: ReservationQrCodeData CustomerOptionsEnum: title: Customer option enum: - None - SendMarketingEmails - Invoiceable - BillAddressObjection - SendMarketingPostalMail - SendPartnerMarketingEmails - SendPartnerMarketingPostalMail - WithdrawCardConsent - GuestPhotoConsent - IdPhotosConsent type: string description: ' None SendMarketingEmails Invoiceable BillAddressObjection SendMarketingPostalMail SendPartnerMarketingEmails SendPartnerMarketingPostalMail WithdrawCardConsent GuestPhotoConsent IdPhotosConsent' x-enumNames: - None - SendMarketingEmails - Invoiceable - BillAddressObjection - SendMarketingPostalMail - SendPartnerMarketingEmails - SendPartnerMarketingPostalMail - WithdrawCardConsent - GuestPhotoConsent - IdPhotosConsent x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' ReservationExtent: title: Reservation extent type: object properties: Reservations: type: boolean description: Whether the response should contain reservations. nullable: true example: true ReservationGroups: type: boolean description: Whether the response should contain groups of the reservations. nullable: true example: true Customers: type: boolean description: Whether the response should contain customers of the reservations. nullable: true example: true CustomerAdresses: type: boolean description: Whether the response should contain addresses of the customers. nullable: true example: true CustomerIdentityDocuments: type: boolean description: Whether the response should contain identity documents of the customers. nullable: true example: true Services: type: boolean description: Whether the response should contain services reserved by the reservations. nullable: true example: true Products: type: boolean description: Whether the response should contain products orderable with the reservations. nullable: true example: true BusinessSegments: type: boolean description: Whether the response should contain business segmentation. nullable: true example: true Resources: type: boolean description: Whether the response should contain resources. nullable: true example: true ResourceCategories: type: boolean description: Whether the response should contain resource categories. nullable: true example: true ResourceCategoryAssignments: type: boolean description: Whether the response should contain assignments of the resources to categories. nullable: true example: true Rates: type: boolean description: Whether the response should contain rates and rate groups. nullable: true example: true Items: type: boolean description: Whether the response should contain accounting items. nullable: true example: true OrderItems: type: boolean description: Whether the response should contain reservation items. nullable: true example: true Notes: type: boolean description: Whether the response should contain notes. nullable: true example: true QrCodeData: type: boolean description: Whether the response should contain QR code data. nullable: true example: true Companies: type: boolean description: Whether the response should contain companies. nullable: true example: true AccountingStates: type: array items: $ref: '#/components/schemas/AccountingState' description: States the items should be in. If not specified, items in `Open` or `Closed` states are returned. nullable: true additionalProperties: false description: Extent of data to be returned. E.g. it is possible to specify that together with the reservations, customers, groups and rates should be also returned. x-schema-id: ReservationExtent 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 RateRestrictionResult: title: Rate restriction result required: - DateRestrictions - EarlinessRestrictions - LengthRestrictions type: object properties: DateRestrictions: type: array items: $ref: '#/components/schemas/DateRestriction' description: Date restrictions for the rate. EarlinessRestrictions: type: array items: $ref: '#/components/schemas/EarlinessRestriction' description: Earliness restrictions for the rates that are only available up to before arrival. LengthRestrictions: type: array items: $ref: '#/components/schemas/LengthRestriction' description: Length restrictions for the rate. additionalProperties: false x-schema-id: RateRestrictionResult RateCapacityOffsetUpdateParameters: title: RateCapacityOffsetUpdateParameters required: - RateId type: object properties: RateId: type: string description: The unique identifier of the `Rate` to update. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 NegativeOccupancyAdjustment: title: Decimal update value allOf: - $ref: '#/components/schemas/DecimalUpdateValue' description: Amount added to the price when occupancy is less than the Space Category Capacity. Use a negative value to provide a discount for under-occupancy. Set to 'null' if not updated. nullable: true example: string ExtraOccupancyAdjustment: title: Decimal update value allOf: - $ref: '#/components/schemas/DecimalUpdateValue' description: Amount added to the price when the Space Category Capacity is exceeded. nullable: true example: string additionalProperties: false x-schema-id: RateCapacityOffsetUpdateParameters RoutingRuleStayItemsAddParameters: title: Selected stay items parameters type: object properties: Nights: type: boolean description: Whether the routing rule applies to nights. example: true CityTax: type: boolean description: Whether the routing rule applies to city tax. example: true ProductCategoryIds: type: array items: type: string format: uuid description: Product categories to which the routing rule applies to. nullable: true additionalProperties: false description: '' x-schema-id: RoutingRuleStayItemsAddParameters 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 CompanionshipAddResult: title: CompanionshipAddResult required: - CompanionshipId type: object properties: CompanionshipId: type: string description: Identifier of the created `Companionship` entity. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: CompanionshipAddResult 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 ReservationOldOrigin: title: Reservation origin (ver 2017-04-12) enum: - Distributor - ChannelManager - Import - Connector - Navigator - CommanderInPerson - CommanderChannel - CommanderPhone - CommanderEmail - CommanderWebsite - CommanderMessage - CommanderCallCenter - CommanderRoomingList type: string x-enumDescriptions: - From the Mews Booking Engine or Booking Engine API. - From a channel manager. - From an import process. - From the Mews Connector API. - From Mews Guest Services. - From Mews Operations, in person. - From Mews Operations, via channel. - From Mews Operations, via telephone. - From Mews Operations, via email. - From Mews Operations, via website. - From Mews Operations, via message person. - From Mews Operations, via call center. - From Mews Operations, via rooming list. 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 ReservationPersonCount: title: Age category parameters required: - AgeCategoryId - Count type: object properties: AgeCategoryId: type: string description: Unique identifier of the [Age category](https://mews-systems.gitbook.io/connector-api/operations/agecategories#age-category). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Count: type: integer description: Number of people of a given age category. Only positive value is accepted. format: int32 example: 1 additionalProperties: false x-schema-id: ReservationPersonCount SpaceData: title: Space resource data required: - FloorNumber type: object properties: FloorNumber: minLength: 1 type: string description: Number of the floor the space is on. example: '1001' LocationNotes: type: string description: Location notes for the space. It can be, for example, Building number the space is located in or the Parking area the particular parking space is at. nullable: true example: string additionalProperties: false x-schema-id: SpaceData RateSetResult: title: Rate set result type: object properties: Rates: maxItems: 1000 type: array items: $ref: '#/components/schemas/Rate' description: Rates that were added or updated. nullable: true additionalProperties: false x-schema-id: RateSetResult AddProductItemsResult: title: AddProductItemsResult type: object properties: ItemIds: type: array items: type: string format: uuid nullable: true additionalProperties: false x-schema-id: AddProductItemsResult CancellationPolicyByRate: title: Cancellation policy data grouped by rate required: - Policies - RateId type: object properties: RateId: type: string description: Unique identifier of the `Rate`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Policies: type: array items: $ref: '#/components/schemas/CancellationPolicyData' description: Collection of cancellation policy data. additionalProperties: false x-schema-id: CancellationPolicyByRate RestrictionTypeEnum: title: Restriction type enum: - Stay - Start - End type: string description: ' Stay (Guests can''t stay within specified dates.) Start (Guests can''t check in within specified dates.) End (Guests can''t check out within specified dates.)' x-enumNames: - Stay - Start - End x-enumDescriptions: - Guests can't stay within specified dates. - Guests can't check in within specified dates. - Guests can't check out within specified dates. 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. ServiceDataDiscriminator: title: Service data discriminator enum: - Bookable - Additional type: string CancellationFeeExtent: title: Cancellation Fee Extent enum: - TimeUnits - Products type: string description: Extent for the cancellation fee, i.e. what should be in scope for the automatic payment. ReservationItemParameters: title: ReservationItemParameters required: - AccessToken - Client - ClientToken - ReservationIds 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 ReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the reservation. Currency: type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to. format: currency nullable: true example: EUR AccountingStates: type: array items: type: string description: States the items should be in. If not specified, items in Open or Closed states are returned. nullable: true additionalProperties: false x-schema-id: ReservationItemParameters ReleaseStrategyUpdateValue: title: Release strategy update value type: object properties: Value: title: Release strategy allOf: - $ref: '#/components/schemas/ReleaseStrategyEnum' description: 'The strategy for automatic release of the availability block. FixedRelease (The availability block is released at a fixed time.) RollingRelease (Each availability adjustment is released at a fixed offset from its start.) None (The availability block is not automatically released.)' x-enumNames: - FixedRelease - RollingRelease - None x-enumDescriptions: - The availability block is released at a fixed time. - Each availability adjustment is released at a fixed offset from its start. - The availability block is not automatically released. example: string additionalProperties: false x-schema-id: ReleaseStrategyUpdateValue CancellationReason: enum: - Other - ConfirmationMissed - BookedElsewhere - ForceMajeure - GuestComplaint - NoShow - PriceTooHigh - ServiceNotAvailable - InputError - InvalidPayment - TravelAgency - RequestedByGuest - Update - BookingAbandoned - RequestedByBooker type: string 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 ResourceAccessToken: title: Resource access token required: - CreatedUtc - EnterpriseId - Id - IsActive - Permissions - ServiceOrderId - Type - UpdatedUtc - ValidityEndUtc - ValidityStartUtc - Value type: object properties: Id: type: string description: Unique identifier of the resource access token. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceOrderId: type: string description: Unique identifier of `Reservation`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanionshipId: type: string description: Unique identifier of `Companionship`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceId: type: string description: Unique identifier of `Resource`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: $ref: '#/components/schemas/ResourceAccessTokenType' Value: minLength: 1 type: string description: Value of the resource access token. example: string SerialNumber: type: string description: Serial number of the resource access token. nullable: true example: '1001' ValidityStartUtc: minLength: 1 type: string description: Marks the start of interval in which the resource access token can be used. format: date-time example: '2026-06-02T14:30:00Z' ValidityEndUtc: minLength: 1 type: string description: Marks the end of interval in which the resource access token can be used. format: date-time example: '2026-06-02T14:30:00Z' Permissions: title: Resource access token permissions allOf: - $ref: '#/components/schemas/ResourceAccessTokenPermissions' description: Permissions of the resource access token. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the resource access token in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource access token in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' IsActive: type: boolean description: Whether the resource access token is still active. example: true additionalProperties: false x-schema-id: ResourceAccessToken ReservationGroupFilterParameters: title: ReservationGroupFilterParameters 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 ReservationGroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `ReservationGroup`. Required if no other filter is provided. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `ReservationGroup` was updated. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: ReservationGroupFilterParameters LengthRestriction: title: Length restriction type: object properties: Id: type: string description: Unique identifier of the rate restriction. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateId: type: string description: Unique identifier of the rate. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsInherited: type: boolean description: Whether the rate restriction is inherited from the parent rate. example: true StartUtc: type: string description: Start of the rate restriction in UTC timezone in ISO 8601 format. nullable: true example: string EndUtc: type: string description: End of the rate restriction in UTC timezone in ISO 8601 format. nullable: true example: string Days: type: array items: type: string description: The restricted days of week. nullable: true ExternalIdentifier: type: string description: Identifiers of from external systems. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 MinLength: type: string description: Minimal reservation length in ISO 8601 duration format. nullable: true example: string MaxLength: type: string description: Maximal reservation length in ISO 8601 duration format. nullable: true example: string additionalProperties: false x-schema-id: LengthRestriction CancellationPolicyData: title: Cancellation policy data required: - AbsoluteFee - Applicability - ApplicabilityOffset - FeeExtents - RelativeFee type: object properties: Applicability: title: Cancellation Policy Applicability allOf: - $ref: '#/components/schemas/CancellationPolicyApplicabilityEnum' description: 'Applicability mode of the cancellation policy. Creation Start StartDate' x-enumNames: - Creation - Start - StartDate x-enumDescriptions: - '' - '' - '' example: string FeeExtents: type: array items: $ref: '#/components/schemas/CancellationFeeExtentEnum' description: Extent for the cancellation fee, i.e. what should be in scope for the automatic payment. ApplicabilityOffset: minLength: 1 type: string description: Offset for order start (assuming Applicability is set to Start) from which the fee is applied in ISO 8601 duration format. example: string FeeMaximumTimeUnits: type: integer description: Maximum number of time units the cancellation fee is applicable to. format: int32 nullable: true example: 1 AbsoluteFee: title: Currency value (ver 2023-02-02) allOf: - $ref: '#/components/schemas/CurrencyValue' description: Absolute value of the fee. example: string RelativeFee: type: number description: Relative value of the fee, as a percentage of the reservation price. format: double example: 100.0 additionalProperties: false x-schema-id: CancellationPolicyData RoutingRuleApplicability: title: Applicability enum: - Always - PrepaidOnly type: string description: Determines if routing rule applies to all future reservations with this company or travel agency, or only future reservations that are prepaid. BusinessSegmentResult: title: BusinessSegmentResult required: - BusinessSegments type: object properties: BusinessSegments: type: array items: $ref: '#/components/schemas/BusinessSegment' description: Business segments. Cursor: type: string description: Unique identifier of the last and hence oldest business segment item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older business segment. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: BusinessSegmentResult PerUnitPriceParameters: title: Time unit amount parameters type: object properties: Index: type: integer description: Index of the unit. Indexing starts with `0`. E.g. the first night of the reservation has index `0`. format: int32 example: 1 Amount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Amount of the unit. nullable: true example: string additionalProperties: false x-schema-id: PerUnitPriceParameters SourceAssignmentV20240920: title: Source assignments (ver 2024-09-20) required: - Id - IsPrimary - ReservationId - SourceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the source assignment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ReservationId: type: string description: Unique identifier of the `Reservation`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 SourceId: type: string description: Unique identifier of the `Source`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsPrimary: type: boolean description: Specifies whether the source is primary for the `Reservation`. example: true UpdatedUtc: minLength: 1 type: string description: Date and time of the source assignment last update in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: SourceAssignmentV20240920 AccountingItem: title: Accounting item type: object properties: Id: type: string format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string format: uuid nullable: true deprecated: true x-deprecatedMessage: Use `AccountId` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 OrderId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProductId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 InvoiceId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreditCardId: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: type: string nullable: true example: string SubType: type: string nullable: true example: string Name: type: string nullable: true example: Example Name Notes: type: string nullable: true example: string ConsumptionUtc: type: string nullable: true example: string ClosedUtc: type: string nullable: true example: string State: type: string nullable: true example: string SubState: type: string nullable: true example: string Amount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: '' nullable: true example: string TaxExemptionReasonCode: type: string description: Code of tax exemption reason. **Restricted!** This property is currently intended for Mews' internal usage and may be subject to change. nullable: true example: string additionalProperties: false x-schema-id: AccountingItem SourceAssignmentResult: title: SourceAssignmentResult required: - Cursor - SourceAssignments type: object properties: SourceAssignments: type: array items: $ref: '#/components/schemas/SourceAssignment' description: Assignments between reservation group and sources. Cursor: type: string description: Unique identifier of the last and hence oldest source assignment returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older source assignments. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: SourceAssignmentResult SetRestrictionParameters: title: SetRestrictionParameters required: - AccessToken - Client - ClientToken - Data - 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: minLength: 1 type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services#service) restrictions will be set in. x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Data: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/RestrictionSetData' description: Parameters of restrictions. additionalProperties: false x-schema-id: SetRestrictionParameters RestrictionClearData: title: Restriction clear data required: - Days - Type type: object properties: Type: title: Restriction type allOf: - $ref: '#/components/schemas/RestrictionTypeEnum' description: 'Restriction type. Stay (Guests can''t stay within specified dates.) Start (Guests can''t check in within specified dates.) End (Guests can''t check out within specified dates.)' x-enumNames: - Stay - Start - End x-enumDescriptions: - Guests can't stay within specified dates. - Guests can't check in within specified dates. - Guests can't check out within specified dates. example: string ExactRateId: type: string description: Unique identifier of the exact `Rate` to which the restriction applies. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BaseRateId: type: string description: Unique identifier of the base `Rate` to which the restriction applies. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateGroupId: type: string description: Unique identifier of the `Rate group` to which the restriction applies. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryId: type: string description: Unique identifier of the `Resource category` to which the restriction applies. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryType: allOf: - $ref: '#/components/schemas/ResourceCategoryTypeEnum' description: 'Name of the `Resource category type` to which the restriction applies. Room Bed Dorm Apartment Suite Villa Site Office MeetingRoom ParkingSpot Desk TeamArea Membership Tent CaravanOrRV UnequippedCampsite Bike ExtraBed Cot Crib ConferenceRoom Rooftop Garden Restaurant Amphitheater PrivateSpaces' nullable: true example: string StartUtc: type: string description: Start date of the time interval for which the restriction conditions should be applied. This must be in UTC timezone in ISO 8601 format - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes). format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string description: End date of the time interval for which the restriction conditions should be applied. This must be in UTC timezone in ISO 8601 format - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes). format: date-time nullable: true example: '2026-06-02T14:30:00Z' Days: title: Days parameters allOf: - $ref: '#/components/schemas/DaysParameters' description: The days of week to which the restriction applies. example: string additionalProperties: false x-schema-id: RestrictionClearData ChannelManagerDetails: title: Reservation channel manager details required: - CreatedUtc - RequestedRateCode - ReservationId type: object properties: ReservationId: type: string description: Unique identifier of the `Reservation`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RequestedRateCode: minLength: 1 type: string description: Rate code requested by the channel manager for this reservation. example: string ChannelManagerName: type: string description: Name of the Channel Manager associated with this reservation. nullable: true example: Example Name ChannelNumber: type: string description: Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number). nullable: true example: '1001' ChannelManagerGroupNumber: type: string description: Number of the reservation group within a Channel Manager. nullable: true example: '1001' ChannelManagerNumber: type: string description: Unique number of the reservation within the reservation group. nullable: true example: '1001' CreatedUtc: minLength: 1 type: string description: The timestamp when the Channel Manager reservation was created. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ChannelManagerDetails ReleaseStrategyEnum: title: Release strategy enum: - FixedRelease - RollingRelease - None type: string description: 'The strategy for automatic release of the availability block. FixedRelease (The availability block is released at a fixed time.) RollingRelease (Each availability adjustment is released at a fixed offset from its start.) None (The availability block is not automatically released.)' x-enumNames: - FixedRelease - RollingRelease - None x-enumDescriptions: - The availability block is released at a fixed time. - Each availability adjustment is released at a fixed offset from its start. - The availability block is not automatically released. RestrictionFilterParameters: title: RestrictionFilterParameters 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 TimeFilter: type: string nullable: true deprecated: true example: string StartUtc: type: string nullable: true deprecated: true example: string EndUtc: type: string nullable: true deprecated: true example: string CollidingUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Restriction` is active. nullable: true example: string CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Restriction` was created. nullable: true example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Restriction` was updated. nullable: true example: string RestrictionIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of the `Restriction`. nullable: true ResourceCategoryIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of `Resource category`. nullable: true RateIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of `Rate`. Returns all restrictions that affect the given rates, i.e. ones without any `Restriction Conditions`, ones assigned directly to specified rates, ones assigned to `Rate group` of specified rates, or ones inherited from base rates.`. nullable: true ExactRateIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of `Rate`. Returns only those restrictions which have matching `ExactRateId` set in `Restriction Condition`. nullable: true BaseRateIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of `Rate`. Returns only those restrictions which have matching `BaseRateId` set in `Restriction Condition`. nullable: true Origin: anyOf: - $ref: '#/components/schemas/RestrictionOrigin' description: Restriction origin. Returns only those restrictions which have matching Origin or all if not specified. nullable: true example: string ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Service` from which the restrictions are requested. additionalProperties: false x-schema-id: RestrictionFilterParameters OrderItemOld: title: Order item required: - AccountId - AccountingState - Amount - CreatedUtc - CreatorProfileId - Data - Id - OrderId - OriginalAmount - RevenueType - UnitAmount - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountId: type: string description: Unique identifier of the account (for example `Customer`) the item belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 OrderId: type: string description: Unique identifier of the order (or `Reservation` which is a special type of order) the item belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BillId: type: string description: Unique identifier of the `Bill` the item is assigned to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string description: Unique identifier of the `AccountingCategory` the item belongs to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UnitCount: type: integer description: Unit count of item, i.e. the number of sub-items or units, if applicable. format: int32 example: 1 UnitAmount: title: Amount allOf: - $ref: '#/components/schemas/Amount' description: Unit amount of item, i.e. the amount of each individual sub-item or unit, if applicable. example: string Amount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Amount of item; note a negative amount represents a rebate or payment. example: string OriginalAmount: title: Extended amount allOf: - $ref: '#/components/schemas/ExtendedAmount' description: Amount of item; note a negative amount represents a rebate or payment. Contains the earliest known value in conversion chain. example: string RevenueType: minLength: 1 type: string description: Revenue type of the item. example: string CreatorProfileId: type: string description: Unique identifier of the user who created the item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UpdaterProfileId: type: string description: Unique identifier of the user who updated the item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the item in UTC timezone in ISO 8601 format. format: date example: '2026-06-02' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the item in UTC timezone in ISO 8601 format. format: date example: '2026-06-02' ConsumedUtc: type: string description: Date and time of the item consumption in UTC timezone in ISO 8601 format. format: date nullable: true example: '2026-06-02' CanceledUtc: type: string description: Cancellation date and time of the item in UTC timezone in ISO 8601 format. format: date nullable: true example: '2026-06-02' ClosedUtc: type: string description: Date and time of the item bill closure in UTC timezone in ISO 8601 format. format: date nullable: true example: '2026-06-02' StartUtc: type: string description: Start date and time of the item in UTC timezone in ISO 8601 format. format: date nullable: true example: '2026-06-02' AccountingState: minLength: 1 type: string description: Accounting state of the item. example: string Data: title: Order item data type: object properties: Discriminator: $ref: '#/components/schemas/OrderItemTypeOld' Value: oneOf: - $ref: '#/components/schemas/RebateOrderItemData' - $ref: '#/components/schemas/ProductOrderItemData' description: Based on order item discriminator or `null` for types without any additional data. nullable: true description: Additional data specific to particular order item. x-coproduct: true x-schema-id: OrderItemOldDataCoproductOfOrderItemTypeOld additionalProperties: false x-schema-id: OrderItemOld ReservationPurpose: title: Reservation purpose enum: - Leisure - Business - Student type: string CancellationPolicyResult: title: CancellationPolicyResult required: - CancellationPolicies type: object properties: CancellationPolicies: maxItems: 1000 type: array items: $ref: '#/components/schemas/CancellationPolicy' description: The filtered cancellation policies. Cursor: type: string description: Unique identifier of the last and hence oldest cancellation policy 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 cancellation policies. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: CancellationPolicyResult ResourceCategoryTypeEnum: title: Resource category type enum: - Room - Bed - Dorm - Apartment - Suite - Villa - Site - Office - MeetingRoom - ParkingSpot - Desk - TeamArea - Membership - Tent - CaravanOrRV - UnequippedCampsite - Bike - ExtraBed - Cot - Crib - ConferenceRoom - Rooftop - Garden - Restaurant - Amphitheater - PrivateSpaces type: string description: 'Type of the category. Room Bed Dorm Apartment Suite Villa Site Office MeetingRoom ParkingSpot Desk TeamArea Membership Tent CaravanOrRV UnequippedCampsite Bike ExtraBed Cot Crib ConferenceRoom Rooftop Garden Restaurant Amphitheater PrivateSpaces' x-enumNames: - Room - Bed - Dorm - Apartment - Suite - Villa - Site - Office - MeetingRoom - ParkingSpot - Desk - TeamArea - Membership - Tent - CaravanOrRV - UnequippedCampsite - Bike - ExtraBed - Cot - Crib - ConferenceRoom - Rooftop - Garden - Restaurant - Amphitheater - PrivateSpaces x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' RestrictionExceptions: title: Restriction exception type: object properties: MinAdvance: type: string description: The minimum time before the reservation starts, you can reserve in ISO 8601 duration format. nullable: true example: string MaxAdvance: type: string description: The maximum time before the reservation starts, you can reserve in ISO 8601 duration format. nullable: true example: string MinLength: type: string description: Minimal reservation length in ISO 8601 duration format. nullable: true example: string MaxLength: type: string description: Maximal reservation length in ISO 8601 duration format. nullable: true example: string MinPrice: title: Currency value (ver 2018-06-07) allOf: - $ref: '#/components/schemas/CurrencyValueOld' description: Value of the minimum price per time unit. nullable: true example: string MaxPrice: title: Currency value (ver 2018-06-07) allOf: - $ref: '#/components/schemas/CurrencyValueOld' description: Value of the maximum price per time unit. nullable: true example: string additionalProperties: false description: The rules that prevent the restriction from applying to a reservation, even when all conditions have been met. x-schema-id: RestrictionExceptions ReservationAdditionParameters: title: ReservationAdditionParameters required: - AccessToken - Client - ClientToken - Reservations - 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` to be reserved. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 GroupId: type: string description: Unique identifier of the `ReservationGroup` where the reservations are added. If not specified, a new group is created. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 GroupName: type: string description: Name of the `ReservationGroup` where the reservations are added to. If `GroupId` is specified, this field is ignored. If not specified, the group name is automatically created. nullable: true example: Example Name Reservations: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ReservationData' description: Parameters of the new reservations. CheckRateApplicability: type: boolean description: Indicates whether the system will check and prevent a booking being made using a restricted rate, e.g. a private rate. The default is `true`, i.e. the system will normally check for this unless the property is set to `false`. nullable: true example: true CheckOverbooking: type: boolean description: Indicates whether the system will check and prevent a booking being made in the case of an overbooking, i.e. where there is an insufficient number of resources available to meet the request. The default is `true`, i.e. the system will normally check for this unless the property is set to `false`. nullable: true example: true SendConfirmationEmail: type: boolean description: Whether the confirmation email is sent. Default value is `true`. nullable: true example: true additionalProperties: false x-schema-id: ReservationAdditionParameters RoutingRuleStayItems: title: Selected stay items type: object properties: Nights: type: boolean description: Whether the routing rule applies to nights. example: true CityTax: type: boolean description: Whether the routing rule applies to city tax. example: true ProductCategoryIds: type: array items: type: string format: uuid description: Product categories to which the routing rule applies to. nullable: true additionalProperties: false description: '' x-schema-id: RoutingRuleStayItems Unit: type: object additionalProperties: false ReservationData: title: Reservation parameters required: - CustomerId - EndUtc - PersonCounts - RateId - RequestedCategoryId - StartUtc type: object properties: Identifier: type: string description: Identifier of the reservation within the transaction. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ChannelNumber: type: string nullable: true example: '1001' State: anyOf: - $ref: '#/components/schemas/ServiceOrderStateOld' description: State of the newly created reservation (either `Optional`, `Enquired` or `Confirmed`). If not specified, `Confirmed` is used. nullable: true example: string StartUtc: minLength: 1 type: string description: Reservation start in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' EndUtc: minLength: 1 type: string description: Reservation end in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' ReleasedUtc: type: string description: Release date and time of an unconfirmed reservation in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' AdultCount: type: integer format: int32 deprecated: true x-deprecatedMessage: Use `PersonCounts` instead. example: 1 ChildCount: type: integer format: int32 deprecated: true x-deprecatedMessage: Use `PersonCounts` instead. example: 1 PersonCounts: minItems: 1 type: array items: $ref: '#/components/schemas/ReservationPersonCount' description: Number of people per age category the reservation was booked for. At least one category with valid count must be provided. CustomerId: type: string description: Unique identifier of the `Customer` who owns the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BookerId: type: string description: Unique identifier of the `Customer` on whose behalf the reservation was made. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RequestedCategoryId: type: string description: Identifier of the requested `ResourceCategory`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedResourceId: type: string description: Identifier of the assigned `Resource`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedResourceLocked: type: boolean description: Whether the reservation should be locked to the assigned `Resource`. (`null` or `false` if the reservation should not be locked) nullable: true example: true RateId: type: string description: Identifier of the reservation `Rate`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherCode: type: string description: Voucher code value providing access to specified private `Rate` applied to this reservation. nullable: true example: string CreditCardId: type: string description: Identifier of `CreditCard` belonging either to the `Customer` who owns the reservation or to the `Booker`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: type: string description: Identifier of the `Company` that mediated the reservation. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: type: string description: Identifier of the `Company` on behalf of which the reservation was made. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BusinessSegmentId: type: string description: Identifier of the reservation `BusinessSegment`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Notes: type: string description: Additional notes. nullable: true example: string TimeUnitAmount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Amount of each night of the reservation. nullable: true example: string TimeUnitPrices: type: array items: $ref: '#/components/schemas/PerUnitPriceParameters' description: Prices for time units of the reservation. E.g. prices for the first or second night. nullable: true ProductOrders: type: array items: $ref: '#/components/schemas/ProductOrderAdditionData' description: Parameters of the products ordered together with the reservation. nullable: true AvailabilityBlockId: type: string description: Unique identifier of the `AvailabilityBlock` the reservation is assigned to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ReservationData ReservationGroupResult: title: ReservationGroupResult required: - ReservationGroups type: object properties: ReservationGroups: maxItems: 1000 type: array items: $ref: '#/components/schemas/ReservationGroup' description: The filtered reservation groups. Cursor: type: string description: Unique identifier of the last and hence oldest reservation group returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older reservation groups. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ReservationGroupResult OrderItemTypeOld: title: Order item data discriminator enum: - CancellationFee - Rebate - Deposit - ExchangeRateDifference - CustomItem - Surcharge - SurchargeDiscount - SpaceOrder - ProductOrder - Other - TaxCorrection - ResourceUpgradeFee - InvoiceFee type: string x-enumDescriptions: - No additional data. - '[Rebate order item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#rebate-order-item-data)' - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - No additional data. - '[Product order item data](https://mews-systems.gitbook.io/connector-api/operations/accountingitems#product-order-item-data)' - No additional data. - No additional data. - No additional data. - No additional data. DependentRatePricingParameters: title: Dependent rate pricing parameters required: - BaseRateId type: object properties: BaseRateId: minLength: 1 type: string description: Unique identifier of the base rate. x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RelativeAdjustment: type: number description: Relative amount which shows the difference between this rate and the base rate. format: double example: 100.0 AbsoluteAdjustment: type: number description: Specific amount which shows the difference between this rate and the base rate. format: double example: 100.0 additionalProperties: false x-schema-id: DependentRatePricingParameters ReservationDataParameters: title: ReservationDataParameters required: - AccessToken - Client - ClientToken - Reservations - 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` to be priced. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Reservations: type: array items: $ref: '#/components/schemas/ReservationData' description: Parameters of the reservations to price. Note that `CustomerId` is not required when pricing reservations. additionalProperties: false x-schema-id: ReservationDataParameters 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 CancellationPolicyByRateResult: title: CancellationPolicyByRateResult required: - CancellationPolicies type: object properties: CancellationPolicies: maxItems: 1300 type: array items: $ref: '#/components/schemas/CancellationPolicyByRate' description: List of cancellation policies data grouped by rate. additionalProperties: false x-schema-id: CancellationPolicyByRateResult 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 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 MultipleAvailabilityBlockAddParameters: title: MultipleAvailabilityBlockAddParameters required: - AccessToken - AvailabilityBlocks - Client - ClientToken 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 AvailabilityBlocks: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/AvailabilityBlockAddParameters' description: Availability blocks to be added. additionalProperties: false x-schema-id: MultipleAvailabilityBlockAddParameters 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 ServiceOrderCancellationReasonEnum: title: Reservation cancellation reason enum: - Other - ConfirmationMissed - BookedElsewhere - ForceMajeure - GuestComplaint - NoShow - PriceTooHigh - ServiceNotAvailable - InputError - InvalidPayment - TravelAgency - RequestedByGuest - Update - BookingAbandoned - RequestedByBooker type: string description: ' Other ConfirmationMissed BookedElsewhere ForceMajeure GuestComplaint NoShow PriceTooHigh ServiceNotAvailable InputError InvalidPayment TravelAgency RequestedByGuest Update BookingAbandoned RequestedByBooker' x-enumNames: - Other - ConfirmationMissed - BookedElsewhere - ForceMajeure - GuestComplaint - NoShow - PriceTooHigh - ServiceNotAvailable - InputError - InvalidPayment - TravelAgency - RequestedByGuest - Update - BookingAbandoned - RequestedByBooker x-enumDescriptions: - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' MultipleRoutingRuleAddParameters: title: MultipleRoutingRuleAddParameters required: - AccessToken - Client - ClientToken - RoutingRules 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 RoutingRules: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/RoutingRuleAddParameter' description: Collection of Routing rules to be added. additionalProperties: false x-schema-id: MultipleRoutingRuleAddParameters CancellationPolicyByReservationResult: title: CancellationPolicyByReservationResult required: - CancellationPolicies type: object properties: CancellationPolicies: maxItems: 1300 type: array items: $ref: '#/components/schemas/CancellationPolicyByReservation' description: List of cancellation policies data grouped by reservation. additionalProperties: false x-schema-id: CancellationPolicyByReservationResult CancellationPolicy: title: Cancellation Policy required: - AbsoluteFee - Applicability - ApplicabilityOffset - CreatedUtc - FeeExtent - Id - IsActive - RateGroupId - RelativeFee - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the cancellation policy. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateGroupId: type: string description: Unique identifier of the rate group the cancellation policy belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Date and time of the cancellation policy creation in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Date and time of the cancellation policy update in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' Applicability: $ref: '#/components/schemas/CancellationPolicyApplicability' FeeExtent: type: array items: $ref: '#/components/schemas/CancellationFeeExtent' description: Extent for the cancellation fee, i.e. what should be in scope for the automatic payment. ApplicabilityOffset: minLength: 1 type: string description: Offset for order start (assuming Applicability is set to Start) from which the fee is applied. example: string FeeMaximumTimeUnits: type: integer description: Maximum number of time units the cancellation fee is applicable to. format: int32 nullable: true example: 1 AbsoluteFee: title: Currency value (ver 2023-02-02) allOf: - $ref: '#/components/schemas/CurrencyValue' description: Absolute value of the fee. example: string RelativeFee: type: number description: Relative value of the fee, as a percentage of the reservation price. format: double example: 100.0 IsActive: type: boolean description: Whether the cancellation policy is still active. example: true additionalProperties: false x-schema-id: CancellationPolicy AddedReservation: title: Added reservation required: - Reservation type: object properties: Identifier: type: string description: Identifier of the reservation within the transaction. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Reservation: title: Reservation (ver 2017-04-12) allOf: - $ref: '#/components/schemas/ReservationOld' description: The added reservation. example: string additionalProperties: false x-schema-id: AddedReservation ReservationsUpdateCustomerParameters: title: ReservationsUpdateCustomerParameters required: - AccessToken - Client - ClientToken - CustomerId - ReservationId 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 ReservationId: type: string description: Unique identifier of the reservation to be updated. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Unique identifier of the [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ReservationsUpdateCustomerParameters ReservationServiceOrderFilterParameters: title: ReservationServiceOrderFilterParameters 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 ReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2023-06-06). nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service). If not provided, all bookable services are used. nullable: true ReservationGroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Reservation groups](https://mews-systems.gitbook.io/connector-api/operations/#reservation-group). nullable: true AccountIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of accounts (currently only [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer), in the future also [Companies](https://mews-systems.gitbook.io/connector-api/operations/companies/#company)) the reservation is associated with. nullable: true PartnerCompanyIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Companies` on behalf of which the reservations were made. nullable: true TravelAgencyIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Identifier of the Travel Agencies (`Company`) that mediated the reservations. nullable: true Numbers: maxItems: 1000 minItems: 1 type: array items: type: string description: Reservation confirmation numbers. nullable: true ChannelNumbers: maxItems: 100 minItems: 1 type: array items: type: string description: Numbers or references used by a Channel (OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers. nullable: true AssignedResourceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Resources](https://mews-systems.gitbook.io/connector-api/operations/resources#resource) assigned to the reservations. nullable: true AvailabilityBlockIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Availability blocks` assigned to the reservations. nullable: true CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the [Reservation](https://mews-systems.gitbook.io/connector-api/operations/reservations/#reservation-ver-2023-06-06) was created. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Reservations` were updated. nullable: true x-max-interval-in-months: 3 example: string CollidingUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the reservations are active. This is defined for a `Reservation` as the period between the reservation's scheduled start time `ScheduledStartUtc` and its scheduled end time `EndUtc`. Reservation is selected if any part of its interval intersects with the interval specified in `CollidingUtc nullable: true x-max-interval-in-months: 3 example: string ScheduledStartUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval filtering Reservations by their scheduled start time. Cannot be used with `ActualStartUtc`. nullable: true x-max-interval-in-months: 3 example: string ActualStartUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval filtering Reservations by their actual start (check-in) time. Cannot be used with `ScheduledStartUtc`. Note that the filter applies only to started or processed reservations. nullable: true x-max-interval-in-months: 3 example: string ActualEndUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval filtering Reservations by their actual end (check-out) time. Cannot be used with `ScheduledEndUtc`. nullable: true x-max-interval-in-months: 3 example: string ScheduledEndUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval filtering Reservations by their scheduled end time. Cannot be used with `ActualEndUtc`. nullable: true x-max-interval-in-months: 3 example: string States: uniqueItems: true type: array items: $ref: '#/components/schemas/ServiceOrderStateEnum' description: A list of service order states to filter by. nullable: true additionalProperties: false x-schema-id: ReservationServiceOrderFilterParameters 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). CurrencyValue: title: Currency value (ver 2023-02-02) required: - Currency - Value type: object properties: Currency: minLength: 1 type: string description: ISO-4217 code of the `Currency`. format: currency example: EUR Value: type: number description: Amount in the currency. format: double example: 100.0 additionalProperties: false description: Absolute value of the fee. x-schema-id: CurrencyValue OrderNoteTypeEnum: title: Service order note type enum: - General - ChannelManager - SpecialRequest type: string description: ' General ChannelManager SpecialRequest' x-enumNames: - General - ChannelManager - SpecialRequest x-enumDescriptions: - '' - '' - '' ReservationPurposeEnum: title: Reservation purpose enum: - Leisure - Business - Student type: string description: ' Leisure Business Student' x-enumNames: - Leisure - Business - Student x-enumDescriptions: - '' - '' - '' DecimalUpdateValue: title: Decimal update value type: object properties: Value: type: number description: Value which is to be updated. format: double example: 100.0 additionalProperties: false x-schema-id: DecimalUpdateValue RatePricing: title: Rate pricing required: - AgeCategoryAdjustments - BaseAmountPrices - BasePrices - CategoryAdjustments - CategoryPrices - Currency - TimeUnitStartsUtc 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). example: EUR DatesUtc: type: array items: type: string nullable: true deprecated: true x-deprecatedMessage: Use `TimeUnitStartsUtc` instead. TimeUnitStartsUtc: type: array items: type: string description: Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format. BasePrices: type: array items: type: number format: double deprecated: true x-deprecatedMessage: Use `BaseAmountPrices` instead. BaseAmountPrices: type: array items: $ref: '#/components/schemas/Amount' description: Base prices of the rates for each time unit covered by the time interval. CategoryPrices: type: array items: $ref: '#/components/schemas/CategoryPricing' description: Resource category prices. CategoryAdjustments: type: array items: $ref: '#/components/schemas/CategoryAdjustment' description: Resource category adjustments. AgeCategoryAdjustments: type: array items: $ref: '#/components/schemas/AgeCategoryAdjustment' description: Assigns different pricing or occupancy based on the guest's age. RelativeAdjustment: type: number description: Specific amount which shows the difference between this rate and the base rate. format: double example: 100.0 AbsoluteAdjustment: type: number description: Relative amount which shows the difference between this rate and the base rate. format: double example: 100.0 EmptyUnitAdjustment: type: number description: Price adjustment for when the resource booked with this rate is not full to capacity. format: double example: 100.0 ExtraUnitAdjustment: type: number description: Price adjustment for when the resource booked with this rate exceeds capacity. format: double example: 100.0 additionalProperties: false x-schema-id: RatePricing AvailabilityAdjustmentParameters: title: AvailabilityAdjustmentParameters 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 AvailabilityAdjustmentIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested [Availability adjustments](https://mews-systems.gitbook.io/connector-api/operations/#availability-adjustment). nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the availability adjustments 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: AvailabilityAdjustmentParameters BusinessSegment: title: Business segment required: - CreatedUtc - Id - IsActive - Name - ServiceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the business segment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the business segment is still active. example: true Name: minLength: 1 type: string description: Name of the business segment. example: Example Name CreatedUtc: minLength: 1 type: string description: Creation date and time of the business segment 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 business segment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: BusinessSegment IdentityDocument: title: Identity document type: object properties: Id: type: string description: Unique identifier of the document. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Identifier of the `Customer`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: title: Document type allOf: - $ref: '#/components/schemas/IdentityDocumentTypeEnum' description: 'Type of the document. IdentityCard Passport Visa DriversLicense' x-enumNames: - IdentityCard - Passport - Visa - DriversLicense x-enumDescriptions: - '' - '' - '' - '' example: string Number: type: string description: Number of the document (e.g. passport number). nullable: true example: '1001' Expiration: type: string description: Expiration date in ISO 8601 format. format: date nullable: true example: '2026-06-02' Issuance: type: string description: Date of issuance in ISO 8601 format. format: date nullable: true example: '2026-06-02' IssuingCountryCode: type: string description: ISO 3166-1 code of the `Country`. nullable: true example: string IssuingCountrySubdivisionCode: type: string description: Identifier of the country subdivision where the document was issued (province, state or region). nullable: true example: string IssuingCity: type: string description: City where the document was issued. nullable: true example: string IdentityDocumentSupportNumber: type: string description: Identity document support number. Only required for Spanish identity cards in Spanish hotels. nullable: true example: '1001' additionalProperties: false x-schema-id: IdentityDocument 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 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 RoutingRuleAddParameter: title: Routing rule parameters required: - Applicability - CompanyId - CompanyRelation - RouteType - ServiceId type: object properties: CompanyId: type: string description: Unique identifier of the Company routing rule is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the Service routing rule is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyRelation: $ref: '#/components/schemas/RoutingRuleCompanyRelation' Applicability: $ref: '#/components/schemas/RoutingRuleApplicability' RouteType: $ref: '#/components/schemas/RoutingRuleRouteType' AssignmentTargetType: anyOf: - $ref: '#/components/schemas/RoutingRuleAssignmentTargetType' description: Relation of company to the bill. Defaults to `CompanyAsDetails`. nullable: true example: string SelectedStayItems: title: Selected stay items parameters allOf: - $ref: '#/components/schemas/RoutingRuleStayItemsAddParameters' description: To which stay items routing rule applies to. Required only if `RouteType` value is `SelectedStayItems`. nullable: true example: string additionalProperties: false x-schema-id: RoutingRuleAddParameter CancellationFeeExtentEnum: title: Cancellation Fee Extent enum: - Nothing - TimeUnits - Products - Everything type: string description: 'Extent for the cancellation fee, i.e. what should be in scope for the automatic payment. Nothing TimeUnits Products Everything' x-enumNames: - Nothing - TimeUnits - Products - Everything x-enumDescriptions: - '' - '' - '' - '' ReservationPricingResult: title: ReservationPricingResult required: - ReservationPrices type: object properties: ReservationPrices: type: array items: $ref: '#/components/schemas/ReservationPrice' description: The reservation prices. additionalProperties: false x-schema-id: ReservationPricingResult SexEnum: title: Sex enum: - Male - Female type: string description: ' Male Female' x-enumNames: - Male - Female x-enumDescriptions: - '' - '' ReservationUpdatePerUnitPriceParameters: title: Time unit amount update value type: object properties: Value: type: array items: $ref: '#/components/schemas/PerUnitPriceParameters' nullable: true additionalProperties: false x-schema-id: ReservationUpdatePerUnitPriceParameters RateAddPricingDataParameters: title: Rate add pricing data parameters type: object properties: BaseRatePricing: title: Base rate pricing parameters (with occupancy adjustments) allOf: - $ref: '#/components/schemas/BaseRatePricingParametersWithOccupancyAdjustments' description: 'Additional data for rates with base rate pricing. Used when `PricingType` is `BaseRatePricing`. Defaults are applied if not specified: amount is set to 10000 in default Enterprise''s currency and with its default accommodation tax rate code.' nullable: true example: string DependentRatePricing: title: Dependent rate pricing parameters allOf: - $ref: '#/components/schemas/DependentRatePricingParameters' description: Additional data for rate with dependent rate pricing. Required when `PricingType` is `DependentRatePricing`. nullable: true example: string additionalProperties: false x-schema-id: RateAddPricingDataParameters ClearRestrictionParameters: title: ClearRestrictionParameters required: - AccessToken - Client - ClientToken - Data - 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: minLength: 1 type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services#service) to which the restrictions apply. x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Data: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/RestrictionClearData' description: Details of the matching conditions and time intervals for clearing restrictions. additionalProperties: false x-schema-id: ClearRestrictionParameters ReservationProductParameters: title: ReservationProductParameters required: - AccessToken - Client - ClientToken - Count - ProductId - ReservationId 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 ReservationId: type: string description: Unique identifier of the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProductId: type: string description: Unique identifier of the [Product](https://mews-systems.gitbook.io/connector-api/operations/products/#product). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Count: type: integer description: The amount of the products to be added. Note that if the product is charged e.g. per night, count 1 means a single product every night. Count 2 means two products every night. format: int32 example: 1 UnitAmount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Price of the product that overrides the price defined in Mews. nullable: true example: string StartUtc: type: string description: Product start in UTC timezone in ISO 8601 format. For products with charging Once and PerPerson must be set to same value as EndUtc. format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string description: Product end in UTC timezone in ISO 8601 format. For products with charging Once and PerPerson must be set to same value as StartUtc. format: date-time nullable: true example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ReservationProductParameters 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 CurrencyValueOld: title: Currency value (ver 2018-06-07) required: - Currency type: object properties: Currency: minLength: 1 type: string format: currency example: EUR Value: type: number format: double nullable: true example: 100.0 Net: type: number format: double nullable: true deprecated: true example: 100.0 Tax: type: number format: double nullable: true deprecated: true example: 100.0 TaxRate: type: number format: double nullable: true deprecated: true example: 100.0 additionalProperties: false description: Total price of the reservation. x-schema-id: CurrencyValueOld 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 RoutingRule: title: Routing rule required: - Applicability - CompanyId - CompanyRelation - CreatedUtc - EnterpriseId - Id - RouteType - ServiceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the routing rule. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the Enterprise. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: type: string description: Unique identifier of the Company routing rule is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyRelation: $ref: '#/components/schemas/RoutingRuleCompanyRelation' Applicability: $ref: '#/components/schemas/RoutingRuleApplicability' RouteType: $ref: '#/components/schemas/RoutingRuleRouteType' ServiceId: type: string description: Unique identifier of the Service routing rule is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 SelectedStayItems: title: Selected stay items allOf: - $ref: '#/components/schemas/RoutingRuleStayItems' description: Specific items to which the routing rule applies. Returns only if `RouteType` value is `SelectedStayItems`. nullable: true example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the routing rule 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 routing rule in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: RoutingRule BaseRatePricingParametersWithOccupancyAdjustments: title: Base rate pricing parameters (with occupancy adjustments) required: - Amount type: object properties: Amount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Price of the product that overrides the price defined in Mews. example: string NegativeOccupancyAdjustment: type: number description: This is the amount added to the price when occupancy of the space is less than the Space Category Capacity. To provide a discount price for under-occupancy, simply use a negative value. format: double example: 100.0 ExtraOccupancyAdjustment: type: number description: This is the amount added to the price when the Space Category Capacity is exceeded. format: double example: 100.0 additionalProperties: false x-schema-id: BaseRatePricingParametersWithOccupancyAdjustments ReservationsChannelManagerDetailsFilterParameters: title: Reservation channel manager details filter parameters required: - AccessToken - Client - ClientToken - ReservationIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. 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 ReservationIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Reservations`. additionalProperties: false x-schema-id: ReservationsChannelManagerDetailsFilterParameters CancellationPolicyByRateParameters: title: CancellationPolicyByRateParameters required: - AccessToken - Client - ClientToken - RateIds - ReservationEndUtc - ReservationStartUtc 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 RateIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Rate`. ReservationStartUtc: minLength: 1 type: string description: Start of the reservation interval in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' ReservationEndUtc: minLength: 1 type: string description: End of the reservation interval in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: CancellationPolicyByRateParameters RebateOrderItemData: title: Rebate order item data required: - RebatedItemId type: object properties: RebatedItemId: type: string description: Unique identifier of `OrderItem` which has been rebated by current item. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: RebateOrderItemData SourceFilterParameters: title: SourceFilterParameters 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 SourceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Sources](https://mews-systems.gitbook.io/connector-api/operations/sources/#source). nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the source was updated. nullable: true x-max-interval-in-months: 3 example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned. example: string additionalProperties: false x-schema-id: SourceFilterParameters ActivityState: title: Activity state enum: - Deleted - Active type: string AvailabilityBlockUpdateParameters: title: Availability block update parameters type: object properties: AvailabilityBlockId: type: string description: Unique identifier of the [Availability block](https://mews-systems.gitbook.io/connector-api/operations/availabilityblocks#availability-block). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: The name of the block (or `null` if the name should not be updated). nullable: true example: Example Name FirstTimeUnitStartUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format (or `null` if the start time should not be updated). nullable: true example: string LastTimeUnitStartUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format (or `null` if the end time should not be updated). nullable: true example: string ExternalIdentifier: title: String update value maxLength: 255 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Identifier of the block from external system (or `null` if the identifier should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 State: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: State of the availability block (or `null` if not updated). nullable: true example: string ReservationPurpose: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: The purpose of the block (or `null` if not updated). nullable: true example: string CompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the [Company](https://mews-systems.gitbook.io/connector-api/operations/companies#company) (or `null` if not updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the travel agency (i.e. `Company`; or `null` if not updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BookerId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the Booker as a creator of an availability block (or `null` if not updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Notes: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Additional notes of the block (or `null` if not updated). nullable: true example: string Budget: title: Currency value (ver 2018-06-07) update value allOf: - $ref: '#/components/schemas/UpdateValueCurrencyValueOld' description: The tentative budget for the total price of reservations (or `null` if not updated). nullable: true example: string CancellationReason: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Cancellation reason of the availability block (or `null` if not updated). nullable: true example: string CancellationReasonDetail: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Cancellation reason detail of the availability block (or `null` if not updated). nullable: true example: string RollingReleaseOffset: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Exact offset from the start of availability adjustments to the moment the availability adjustment should be released, in ISO 8601 duration format. Required if `ReleaseStrategy` is set to `RollingRelease`, ignored otherwise. nullable: true example: string ReleasedUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: The moment when the block and its availability is released, in UTC timezone ISO 8601 format. Required if `ReleaseStrategy` is set to `FixedRelease`, or used when `ReleaseStrategy` update is unspecified. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ReleaseStrategy: title: Release strategy update value allOf: - $ref: '#/components/schemas/ReleaseStrategyUpdateValue' description: The strategy for automatic release of the availability block (or `null` if not updated). nullable: true example: string QuoteId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the Mews Events quote associated with the availability block (or `null` if not updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PurchaseOrderNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Unique number of the purchase order. This number is propagated to any newly picked up `Reservation` within the block. nullable: true example: '1001' BusinessSegmentId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the Business segment. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: AvailabilityBlockUpdateParameters RateResult: title: Rate result required: - RateGroups - RateRestrictions - Rates type: object properties: Rates: maxItems: 1000 type: array items: $ref: '#/components/schemas/Rate' description: Rates of the default service. RateGroups: maxItems: 1000 type: array items: $ref: '#/components/schemas/RateGroupOld' description: Rate groups of the default service. deprecated: true x-deprecatedMessage: Use [rateGroups/getAll](https://mews-systems.gitbook.io/connector-api/operations/rategroups#request). RateRestrictions: title: Rate restriction result allOf: - $ref: '#/components/schemas/RateRestrictionResult' deprecated: true x-deprecatedMessage: Use [restrictions/getAll](https://mews-systems.gitbook.io/connector-api/operations/restrictions#request). example: string 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: RateResult SourceAssignmentFilterParameters: title: SourceAssignmentFilterParameters 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 ReservationGroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Reservation group`. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval of `Reservation group` last update date and time. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: SourceAssignmentFilterParameters ProductPostingModeEnum: title: Product posting mode enum: - Once - PerTimeUnit type: string description: ' Once PerTimeUnit' x-enumNames: - Once - PerTimeUnit x-enumDescriptions: - '' - '' PickupDistributionEnum: title: Pickup distribution enum: - AllInOneGroup - IndividualGroups type: string description: ' AllInOneGroup (All created reservations in the block are added to the same reservation group.) IndividualGroups (Reservations can be picked up in multiple groups, with up to 750 reservations per group.)' x-enumNames: - AllInOneGroup - IndividualGroups x-enumDescriptions: - All created reservations in the block are added to the same reservation group. - Reservations can be picked up in multiple groups, with up to 750 reservations per group. Title: title: Title enum: - Mister - Miss - Misses type: string description: "Type of the title prefix of the customer.\r\n\r\nNote that the value should not be used as-is, but localized. For example, the value `Misses` should be displayed as `Mrs.` in English and `Fr.` in German.\n\nMister (Mr.)\n\nMiss (Ms.)\n\nMisses (Mrs.)" x-enumNames: - Mister - Miss - Misses x-enumDescriptions: - Mr. - Ms. - Mrs. x-schema-id: Title x-showDescription: true CustomerClassificationEnum: title: Customer classification enum: - PaymasterAccount - Blacklist - Media - LoyaltyProgram - PreviousComplaint - Returning - Staff - FriendOrFamily - TopManagement - Important - VeryImportant - Problematic - Cashlist - DisabledPerson - Military - Airline - HealthCompliant - InRoom - WaitingForRoom - Student - Blocklist type: string description: ' PaymasterAccount Blacklist (Deprecated, use Blocklist instead.) Media LoyaltyProgram PreviousComplaint Returning Staff FriendOrFamily TopManagement Important VeryImportant Problematic Cashlist DisabledPerson Military Airline HealthCompliant InRoom WaitingForRoom Student Blocklist' x-enumNames: - PaymasterAccount - Blacklist - Media - LoyaltyProgram - PreviousComplaint - Returning - Staff - FriendOrFamily - TopManagement - Important - VeryImportant - Problematic - Cashlist - DisabledPerson - Military - Airline - HealthCompliant - InRoom - WaitingForRoom - Student - Blocklist x-enumDescriptions: - '' - Deprecated, use Blocklist instead. - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' - '' BaseRatePricingWithoutAdjustmentsParameters: title: Base rate pricing parameters (without occupancy adjustments) required: - Amount type: object properties: Amount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Price of the product that overrides the price defined in Mews. example: string additionalProperties: false x-schema-id: BaseRatePricingWithoutAdjustmentsParameters ReservationOld: title: Reservation (ver 2017-04-12) required: - AssignedResourceLocked - CompanionIds - CreatedUtc - CustomerId - EndUtc - GroupId - Id - Number - Options - Origin - OwnerId - PersonCounts - RateId - RequestedCategoryId - ServiceId - StartUtc - State - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the Service that is reserved. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 GroupId: type: string description: Unique identifier of the Reservation group. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Number: minLength: 1 type: string description: Confirmation number of the reservation in Mews. example: '1001' ChannelNumber: type: string description: Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number). nullable: true example: '1001' ChannelManagerNumber: type: string description: Unique number of the reservation within the reservation group. nullable: true example: '1001' ChannelManagerGroupNumber: type: string description: Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews. nullable: true example: '1001' ChannelManager: type: string description: Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc). nullable: true example: string State: $ref: '#/components/schemas/ServiceOrderStateOld' Origin: $ref: '#/components/schemas/ReservationOldOrigin' OriginDetails: type: string description: Details about the reservation origin. nullable: true example: string Purpose: anyOf: - $ref: '#/components/schemas/ReservationPurpose' description: Purpose of the reservation. nullable: true example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the reservation in UTC timezone in ISO 8601 format. example: string UpdatedUtc: minLength: 1 type: string description: Last update date and time of the reservation in UTC timezone in ISO 8601 format. example: string CancelledUtc: type: string description: Cancellation date and time in UTC timezone in ISO 8601 format. nullable: true example: string StartUtc: minLength: 1 type: string description: Start of the reservation in UTC timezone in ISO 8601 format. This is either the scheduled reservation start time, or the actual customer check-in time if this is earlier than the scheduled start time. example: string EndUtc: minLength: 1 type: string description: End of the reservation (departure) in UTC timezone in ISO 8601 format. example: string ReleasedUtc: type: string description: Date when the optional reservation is released in UTC timezone in ISO 8601 format. nullable: true example: string RequestedCategoryId: type: string description: Identifier of the requested Resource category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedSpaceId: type: string description: Identifier of the assigned Space. format: uuid nullable: true deprecated: true x-deprecatedMessage: Use `AssignedResourceId` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedSpaceLocked: type: boolean description: Whether the reservation is locked to the assigned Space and cannot be moved. deprecated: true x-deprecatedMessage: Use `AssignedResourceLocked` instead. example: true AssignedResourceId: type: string description: Identifier of the assigned Resource. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedResourceLocked: type: boolean description: Whether the reservation is locked to the assigned Resource and cannot be moved. example: true BusinessSegmentId: type: string description: Identifier of the reservation Business segment. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: type: string description: Identifier of the Company on behalf of which the reservation was made. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: type: string description: Identifier of the Company that mediated the reservation. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AvailabilityBlockId: type: string description: Unique identifier of the Availability block the reservation is assigned to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateId: type: string description: Identifier of the reservation Rate. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherId: type: string description: Unique identifier of the Voucher that has been used to create reservation. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreditCardId: type: string description: Unique identifier of the Credit card. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CancellationReason: anyOf: - $ref: '#/components/schemas/CancellationReason' description: Cancellation reason of the reservation. nullable: true example: string AdultCount: type: integer description: Count of adults the reservation was booked for. format: int32 deprecated: true x-deprecatedMessage: Use `PersonCounts` instead. example: 1 ChildCount: type: integer description: Count of children the reservation was booked for. format: int32 deprecated: true x-deprecatedMessage: Use `PersonCounts` instead. example: 1 PersonCounts: type: array items: $ref: '#/components/schemas/ReservationPersonCount' description: Number of people per age category the reservation was booked for. OwnerId: type: string description: Unique identifier of the Customer or Company who owns the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Unique identifier of the Customer who owns the reservation. format: uuid deprecated: true x-deprecatedMessage: Use `OwnerId` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BookerId: type: string description: Unique identifier of the Customer on whose behalf the reservation was made. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanionIds: type: array items: type: string format: uuid description: Unique identifiers of the `Customer`s that will use the resource. deprecated: true x-deprecatedMessage: Use `companionships/getAll` instead. ChannelManagerId: type: string description: Channel Manager number. nullable: true deprecated: true x-deprecatedMessage: Use `ChannelManagerNumber` instead. example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Options: title: Reservation options allOf: - $ref: '#/components/schemas/ReservationOptions' description: Options of the reservation. example: string additionalProperties: false description: '' x-schema-id: ReservationOld ReservationFilterParameters: title: ReservationFilterParameters 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 ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service) from which the reservations are requested. ServiceId: type: string format: uuid nullable: true deprecated: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 GroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested [Reservation groups](https://mews-systems.gitbook.io/connector-api/operations/#reservation-group). nullable: true ReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2017-04-12). nullable: true CustomerIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) which own the reservations. nullable: true AssignedResourceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Resources](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource) assigned to the reservations. nullable: true RateIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Rates](https://mews-systems.gitbook.io/connector-api/operations/rates/#rate) assigned to the reservations. nullable: true BusinessSegmentIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Business segments](https://mews-systems.gitbook.io/connector-api/operations/businesssegments/#business-segment) assigned to the reservations. nullable: true ChannelNumbers: maxItems: 1000 minItems: 1 type: array items: type: string description: Set of numbers or references used by the Channel (i.e. OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers. nullable: true Numbers: maxItems: 1000 minItems: 1 type: array items: type: string description: Confirmation numbers of [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2017-04-12). nullable: true StartUtc: type: string description: Start of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter. format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string description: End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter. format: date-time nullable: true example: '2026-06-02T14:30:00Z' TimeFilter: anyOf: - $ref: '#/components/schemas/ReservationTimeFilter' description: Time filter of the interval. If not specified, reservations Colliding with the interval are returned. nullable: true example: string Currency: type: string description: ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to. format: currency nullable: true example: EUR States: type: array items: $ref: '#/components/schemas/ServiceOrderStateOld' description: States the reservations should be in. If not specified, reservations in Confirmed, Started or Processed states or reservations specified by ReservationIds regardless of state are returned. nullable: true Extent: title: Reservation extent allOf: - $ref: '#/components/schemas/ReservationExtent' description: Extent of data to be returned. E.g. it is possible to specify that together with the reservations, customers, groups and rates should be also returned. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned. example: string additionalProperties: false x-schema-id: ReservationFilterParameters 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 ReservationItems: title: Reservation items required: - Items - OrderItems type: object properties: ReservationId: type: string description: Unique identifier of the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Items: type: array items: $ref: '#/components/schemas/AccountingItem' description: Accounting items associated with the reservation. OrderItems: type: array items: $ref: '#/components/schemas/OrderItemOld' description: Order items associated with the reservation. additionalProperties: false x-schema-id: ReservationItems ResourceCategoryAssignment: title: Resource category assignment required: - CategoryId - CreatedUtc - Id - IsActive - ResourceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the assignment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the assignment is still active. example: true ResourceId: type: string description: Unique identifier of the [Resource](https://mews-systems.gitbook.io/connector-api/operations/#resource) assigned to the Resource category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the assignment 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 assignment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ResourceCategoryAssignment 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 ResourceAccessTokenPermissions: title: Resource access token permissions type: object properties: Bed: type: boolean description: Specify whether the resource access token grants permission to access bed. example: true Room: type: boolean description: Specify whether the resource access token grants permission to access room. example: true Floor: type: boolean description: Specify whether the resource access token grants permission to access floor. example: true Building: type: boolean description: Specify whether the resource access token grants permission to access building. example: true additionalProperties: false description: '' x-schema-id: ResourceAccessTokenPermissions ReservationUpdateOptionsParameters: title: Reservations options parameters update values type: object properties: OwnerCheckedIn: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: True if the owner of the reservation is checked in. (or `null` if the value should not be updated). nullable: true example: string additionalProperties: false x-schema-id: ReservationUpdateOptionsParameters ReservationStartParameters: title: ReservationStartParameters required: - AccessToken - Client - ClientToken - ReservationId 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 ReservationId: type: string description: Unique identifier of the reservation to start. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ReservationStartParameters ReservationUpdatePersonCountParameters: title: Person counts update value type: object properties: Value: type: array items: $ref: '#/components/schemas/ReservationPersonCount' nullable: true additionalProperties: false x-schema-id: ReservationUpdatePersonCountParameters AmountParameters: title: Amount parameters required: - Currency - TaxCodes type: object properties: Currency: minLength: 1 type: string format: currency example: EUR TaxCodes: type: array items: type: string NetValue: type: number format: double nullable: true example: 100.0 GrossValue: type: number format: double nullable: true example: 100.0 additionalProperties: false description: Price of the product that overrides the price defined in Mews. x-schema-id: AmountParameters 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: - '' - '' - '' - '' RateSetPricingDataParameters: title: Rate set pricing data parameters type: object properties: BaseRatePricing: title: Base rate pricing parameters (without occupancy adjustments) allOf: - $ref: '#/components/schemas/BaseRatePricingWithoutAdjustmentsParameters' description: 'Additional data for rates with base rate pricing. Used when `PricingType` is `BaseRatePricing`. Defaults are applied if not specified: amount is set to 10000 in default Enterprise''s currency and with its default accommodation tax rate code.' nullable: true example: string DependentRatePricing: title: Dependent rate pricing parameters allOf: - $ref: '#/components/schemas/DependentRatePricingParameters' description: Additional data for rate with dependent rate pricing. Required when `PricingType` is `DependentRatePricing`. nullable: true example: string additionalProperties: false x-schema-id: RateSetPricingDataParameters RoutingRuleDeleteParameters: title: RoutingRuleDeleteParameters required: - AccessToken - Client - ClientToken - RoutingRuleIds 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 RoutingRuleIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the routing rules to be deleted. additionalProperties: false x-schema-id: RoutingRuleDeleteParameters GuidIEnumerableUpdateValue: title: Guid array update value type: object properties: Value: type: array items: type: string format: uuid description: Value which is to be updated. nullable: true additionalProperties: false x-schema-id: GuidIEnumerableUpdateValue AvailabilityBlockStateEnum: title: Availability block state enum: - Confirmed - Optional - Inquired - Canceled type: string description: ' Confirmed (The block deducts availability and can have reservations assigned.) Optional (The block deducts availability and cannot have reservations assigned.) Inquired (The block does not deduct availability and cannot have reservations assigned (waitlist).) Canceled (The block does not deduct availability and cannot have reservations assigned (waitlist).)' x-enumNames: - Confirmed - Optional - Inquired - Canceled x-enumDescriptions: - The block deducts availability and can have reservations assigned. - The block deducts availability and cannot have reservations assigned. - The block does not deduct availability and cannot have reservations assigned (waitlist). - The block does not deduct availability and cannot have reservations assigned (waitlist). ReservationResult: title: ReservationResult type: object properties: Reservations: type: array items: $ref: '#/components/schemas/ReservationOld' description: The reservations that collide with the specified interval. nullable: true ReservationGroups: type: array items: $ref: '#/components/schemas/ReservationGroupOld' description: Reservation groups that the reservations are members of. nullable: true Customers: type: array items: $ref: '#/components/schemas/Customer' description: Customers that are members of the reservations. nullable: true Services: type: array items: $ref: '#/components/schemas/Service' description: Services that have been reserved. nullable: true Products: type: array items: $ref: '#/components/schemas/Product' description: Products orderable with reservations. nullable: true Resources: type: array items: $ref: '#/components/schemas/Resource' description: Assigned resources of the reservations. nullable: true ResourceCategories: type: array items: $ref: '#/components/schemas/ResourceCategory' description: Resource categories of the resources. nullable: true ResourceCategoryAssignments: type: array items: $ref: '#/components/schemas/ResourceCategoryAssignment' description: Assignments of the resources to categories. nullable: true BusinessSegments: type: array items: $ref: '#/components/schemas/BusinessSegment' description: Business segments of the reservations. nullable: true Rates: type: array items: $ref: '#/components/schemas/RateForExtent' description: Rates of the reservations. nullable: true RateGroups: type: array items: $ref: '#/components/schemas/RateGroupOld' description: Rate groups of the reservation rates. nullable: true Items: type: array items: $ref: '#/components/schemas/AccountingItem' description: Accounting items that are part of the reservations. nullable: true OrderItems: type: array items: $ref: '#/components/schemas/OrderItemOld' description: Revenue items of the reservations. nullable: true Notes: type: array items: $ref: '#/components/schemas/OrderNote' description: Notes of the reservations. nullable: true QrCodeData: type: array items: $ref: '#/components/schemas/ReservationQrCodeData' description: QR code data of the reservations. nullable: true Companies: type: array items: $ref: '#/components/schemas/Company' description: Companies related to the reservations. nullable: true ResourceAccessTokens: type: array items: $ref: '#/components/schemas/ResourceAccessToken' description: Resource access tokens for the reservations. nullable: true Cursor: type: string description: Unique identifier of the last and hence oldest reservation returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older reservations. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ReservationResult ReservationUpdateParameters: title: Reservation updates required: - AccessToken - Client - ClientToken - ReservationId 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 ReservationId: type: string description: Unique identifier of the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ChannelNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number) (or `null` if the channel number should not be updated). nullable: true example: '1001' StartUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reservation start in UTC timezone in ISO 8601 format. (or `null` if the start time should not be updated). nullable: true example: string EndUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reservation end in UTC timezone in ISO 8601 format. (or `null` if the end time should not be updated). nullable: true example: string ReleasedUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Date when the optional reservation is released in UTC timezone in ISO 8601 format. (or `null` if the release time should not be updated). nullable: true example: string PersonCounts: title: Person counts update value allOf: - $ref: '#/components/schemas/ReservationUpdatePersonCountParameters' description: Number of people per age category the reservation is for. If supplied, the person counts will be replaced. (or `null` if the person counts should not be updated). nullable: true example: string AssignedResourceId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the assigned `Resource`. If the assigned resource is locked, see `AssignedResourceLocked` for updating the assigned resource. (`null` if the assigned resource should not be updated) nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RequestedCategoryId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Identifier of the requested `ResourceCategory` (or `null` if resource category should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Company` that mediated the reservation (or `null` if travel agency should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Company` on behalf of which the reservation was made (or `null` if company should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BusinessSegmentId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the reservation `BusinessSegment` (or `null` if the business segment should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Purpose: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: '`Purpose` of the reservation (or `null` if the purpose should not be updated).' nullable: true example: string RateId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Identifier of the reservation `Rate` (or `null` if the rate should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreditCardId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of `CreditCard` belonging to `Customer` who owns the reservation. (or `null` if the credit card should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TimeUnitPrices: title: Time unit amount update value allOf: - $ref: '#/components/schemas/ReservationUpdatePerUnitPriceParameters' description: Prices for time units of the reservation. E.g. prices for the first or second night. (or `null` if the unit amounts should not be updated). nullable: true example: string BookerId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Customer` on whose behalf the reservation was made. (or `null` if the booker should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedResourceLocked: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether the reservation should be locked to the assigned `Resource`. To reassign the reservation to a new `Resource`, first set `AssignedResourceLocked` to `false` to unlock the resource. Then, assign the reservation to a new `Resource` by setting `AssignedResourceId` to the new resource ID. (`null` if the lock should not be updated) nullable: true example: string AvailabilityBlockId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the `AvailabilityBlock` the reservation is assigned to. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Options: title: Reservations options parameters update values allOf: - $ref: '#/components/schemas/ReservationUpdateOptionsParameters' description: Options of the reservations. nullable: true example: string additionalProperties: false x-schema-id: ReservationUpdateParameters 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 AccountingState: title: Order item accounting state enum: - Open - Closed - Inactive - Canceled type: string x-enumDescriptions: - Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice. - Order items which carry a non-zero value and have been closed on a bill or invoice. - Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive. - Order items which have been canceled, regardless of whether the item is of zero value. RateAddTypeEnum: title: Rate Add Type enum: - Public - Private type: string description: ' Public Private' x-enumNames: - Public - Private x-enumDescriptions: - '' - '' AvailabilityBlockParameters: title: AvailabilityBlockParameters required: - AccessToken - Client - ClientToken - Extent - 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 Extent: title: Availability block extent allOf: - $ref: '#/components/schemas/AvailabilityBlockExtent' description: Extent of data to be returned, e.g. it is possible to specify that related service orders (for example reservations) are returned. example: string ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Services` to which `Availability blocks` are assigned. nullable: true AvailabilityBlockIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested `Availability blocks`. nullable: true CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the availability blocks were created. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Availability blocks` were updated. nullable: true x-max-interval-in-months: 3 example: string CollidingUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Availability blocks` are active. nullable: true x-max-interval-in-months: 3 example: string ReleasedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the `Availability blocks`are released. nullable: true x-max-interval-in-months: 3 example: string ExternalIdentifiers: maxItems: 1000 minItems: 1 type: array items: type: string description: Identifiers of `Availability blocks` from external systems. nullable: true States: type: array items: $ref: '#/components/schemas/AvailabilityBlockStateEnum' description: States the availability blocks should be in. nullable: true ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted or both records. nullable: true additionalProperties: false x-schema-id: AvailabilityBlockParameters AvailabilityBlock: title: Availability block required: - AvailabilityBlockNumber - BusinessSegmentId - CreatedUtc - FirstTimeUnitStartUtc - IsActive - LastTimeUnitStartUtc - PickupDistribution - ReleaseStrategy - State - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the availability block. 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 ServiceId: type: string description: Unique identifier of the `Service` the block is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateId: type: string description: Unique identifier of the `Rate` the block is assigned to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 VoucherId: type: string description: Unique identifier of the `Voucher` used to access specified private `Rate`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BookerId: type: string description: Unique identifier of the `Customer` on whose behalf the block was made. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: type: string description: Unique identifier of the `Company` linked to the block. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: type: string description: Unique identifier of `Company`with `Travel agency contract` the Availability Block is related to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Budget: title: Currency value (ver 2018-06-07) allOf: - $ref: '#/components/schemas/CurrencyValueOld' description: The tentative budget for the total price of reservations in the block. nullable: true example: string State: title: Availability block state allOf: - $ref: '#/components/schemas/AvailabilityBlockStateEnum' description: 'State of the availability block. Confirmed (The block deducts availability and can have reservations assigned.) Optional (The block deducts availability and cannot have reservations assigned.) Inquired (The block does not deduct availability and cannot have reservations assigned (waitlist).) Canceled (The block does not deduct availability and cannot have reservations assigned (waitlist).)' x-enumNames: - Confirmed - Optional - Inquired - Canceled x-enumDescriptions: - The block deducts availability and can have reservations assigned. - The block deducts availability and cannot have reservations assigned. - The block does not deduct availability and cannot have reservations assigned (waitlist). - The block does not deduct availability and cannot have reservations assigned (waitlist). example: string ReservationPurpose: allOf: - $ref: '#/components/schemas/ReservationPurposeEnum' description: 'The purpose of the block. Leisure Business Student' nullable: true example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the block in UTC timezone in ISO 8601 format. example: string UpdatedUtc: minLength: 1 type: string description: Last update date and time of the block in UTC timezone in ISO 8601 format. example: string FirstTimeUnitStartUtc: minLength: 1 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. See [Time units](https://mews-systems.gitbook.io/connector-api/concepts/time-units). example: string LastTimeUnitStartUtc: minLength: 1 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. See [Time units](https://mews-systems.gitbook.io/connector-api/concepts/time-units). example: string ReleasedUtc: type: string description: The moment when the block and its availability is released in UTC timezone in ISO 8601 format. Mutually exclusive with `RollingReleaseOffset`; the block will not be automatically released if neither `ReleasedUtc` nor `RollingReleaseOffsetUtc` is specified. nullable: true example: string RollingReleaseOffset: type: string description: Exact offset from the start of availability adjustments to the moment the individual days in the adjustment should be released, in ISO 8601 duration format. Mutually exclusive with `ReleasedUtc`; the block will not be automatically released if neither `ReleasedUtc` nor `RollingReleaseOffsetUtc` is specified. nullable: true example: string ExternalIdentifier: maxLength: 255 type: string description: Identifier of the block from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: type: string description: The name of the block in Mews. nullable: true example: Example Name Notes: type: string description: Additional notes of the block. nullable: true example: string PickupDistribution: title: Pickup distribution allOf: - $ref: '#/components/schemas/PickupDistributionEnum' description: 'Whether assigning spaces to reservations within an availability block is done as a single group or divided into individual groups. AllInOneGroup (All created reservations in the block are added to the same reservation group.) IndividualGroups (Reservations can be picked up in multiple groups, with up to 750 reservations per group.)' x-enumNames: - AllInOneGroup - IndividualGroups x-enumDescriptions: - All created reservations in the block are added to the same reservation group. - Reservations can be picked up in multiple groups, with up to 750 reservations per group. example: string IsActive: type: boolean description: Whether the `Availability Block` is still active. example: true QuoteId: type: string description: Unique identifier of the Mews Events quote associated with the availability block. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AvailabilityBlockNumber: minLength: 1 type: string description: Unique number for a specific availability block within the Mews system. example: '1001' ReleaseStrategy: title: Release strategy allOf: - $ref: '#/components/schemas/ReleaseStrategyEnum' description: 'The strategy for automatic release of the availability block. FixedRelease (The availability block is released at a fixed time.) RollingRelease (Each availability adjustment is released at a fixed offset from its start.) None (The availability block is not automatically released.)' x-enumNames: - FixedRelease - RollingRelease - None x-enumDescriptions: - The availability block is released at a fixed time. - Each availability adjustment is released at a fixed offset from its start. - The availability block is not automatically released. example: string PurchaseOrderNumber: type: string description: Unique number of the purchase order. This number is propagated to any newly picked up `Reservation` within the block. nullable: true example: '1001' BusinessSegmentId: type: string description: Unique identifier of the associated `Business segment`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CanceledUtc: type: string description: Date and time of the block cancellation in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' CancellationReason: allOf: - $ref: '#/components/schemas/ServiceOrderCancellationReasonEnum' description: 'Cancellation reason of the availability block. Other ConfirmationMissed BookedElsewhere ForceMajeure GuestComplaint NoShow PriceTooHigh ServiceNotAvailable InputError InvalidPayment TravelAgency RequestedByGuest Update BookingAbandoned RequestedByBooker' nullable: true example: string CancellationReasonDetail: type: string description: Additional details of availability block cancellation. nullable: true example: string additionalProperties: false x-schema-id: AvailabilityBlock RestrictionOriginEnum: title: Restriction origin enum: - User - Integration type: string description: ' User (Restriction was created by a user in Mews.) Integration (Restriction was created by a 3rd-party integration.)' x-enumNames: - User - Integration x-enumDescriptions: - Restriction was created by a user in Mews. - Restriction was created by a 3rd-party integration. MultipleReservationResult: title: MultipleReservationResult required: - ReservationIds type: object properties: ReservationIds: type: array items: type: string format: uuid description: Identifiers of the affected `Reservation` entities. additionalProperties: false x-schema-id: MultipleReservationResult ProductOrderAdditionData: title: Product order parameters required: - ProductId type: object properties: ProductId: type: string description: Unique identifier of the `Product` to be ordered. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Count: type: integer description: Count of products to be ordered, e.g. 10 in case of 10 beers. format: int32 nullable: true example: 1 UnitAmount: title: Amount parameters allOf: - $ref: '#/components/schemas/AmountParameters' description: Unit amount of the product that overrides the amount defined in Mews. nullable: true example: string StartUtc: type: string description: Product start in UTC timezone in ISO 8601 format. For products with charging `Once` and `PerPerson` must be set to same value as `EndUtc`. Use only with operation [Add reservations](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservations) or [Add reservation product](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservation-product), can be omitted for [Add order](https://mews-systems.gitbook.io/connector-api/operations/orders#add-order) operation. format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string description: Product end in UTC timezone in ISO 8601 format. For products with charging `Once` and `PerPerson` must be set to same value as `StartUtc`. Use only with operation [Add reservations](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservations) or [Add reservation product](https://mews-systems.gitbook.io/connector-api/operations/reservations#add-reservation-product), can be omitted for [Add order](https://mews-systems.gitbook.io/connector-api/operations/orders#add-order) operation. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ExternalIdentifier: type: string description: External identifier of the product order. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ProductOrderAdditionData ResourceCategoryType: title: Resource category type enum: - Room - Bed - Dorm - Apartment - Suite - Villa - Site - Office - MeetingRoom - ParkingSpot - Desk - TeamArea - Membership - Tent - CaravanOrRV - UnequippedCampsite - Bike - ExtraBed - Cot - Crib - ConferenceRoom - Rooftop - Garden - Restaurant - Amphitheater - PrivateSpaces type: string description: Type of the category. 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 RateGroupFilterParameters: title: RateGroupFilterParameters 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 RateGroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Rate group](https://mews-systems.gitbook.io/connector-api/operations/#rate-group). Required if ServiceIds filter is not provided. nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service). Required if RateGroupIds filter is not provided. nullable: true ExternalIdentifiers: maxItems: 1000 minItems: 1 type: array items: type: string description: Identifiers of [Rate group](https://mews-systems.gitbook.io/connector-api/operations/#rate-group) from external systems. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the rate groups were updated. nullable: true x-max-interval-in-months: 3 example: string ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted or both records. nullable: true additionalProperties: false x-schema-id: RateGroupFilterParameters ResourceClassification: title: Resource classification enum: - StandardSingle - StandardDouble - SuperiorTwin - SuperiorDouble - JuniorSuite - SharedOrDorm - Other - SuperiorSingle - Triple - Family - StandardTwin - Studio - SuperiorTripleRoom - OneBedroomApartment - ThreeBedroomsApartment - TwoBedroomsApartment type: string description: Classification of the resource category. AvailabilityBlockAddParameters: title: Availability block parameters required: - FirstTimeUnitStartUtc - LastTimeUnitStartUtc - RateId - ServiceId - State type: object properties: ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services#service) to assign block to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateId: type: string description: Unique identifier of the [Rate](https://mews-systems.gitbook.io/connector-api/operations/rates#rate) to assign block to. 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, in UTC timezone ISO 8601 format. example: string LastTimeUnitStartUtc: minLength: 1 type: string description: End of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format. example: string ReleasedUtc: type: string description: The moment when the block and its availability is released, in UTC timezone ISO 8601 format. Takes precedence over `RollingReleaseOffset`. format: date-time nullable: true example: '2026-06-02T14:30:00Z' RollingReleaseOffset: type: string description: Exact offset from the start of availability adjustments to the moment the availability adjustment should be released, in ISO 8601 duration format. Ignored if `ReleasedUtc` is specified. nullable: true example: string Name: type: string description: The name of the block. nullable: true example: Example Name VoucherCode: type: string description: Voucher code providing access to specified private [Rate](https://mews-systems.gitbook.io/connector-api/operations/rates#rate). nullable: true example: string BookerId: type: string description: Unique identifier of the Booker as a creator of an availability block. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: type: string description: Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies#company). format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: type: string description: Unique identifier of travel agency (`Company` with a `TravelAgencyContract`). format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Budget: title: Currency value (ver 2018-06-07) allOf: - $ref: '#/components/schemas/CurrencyValueOld' description: The tentative budget for the total price of reservations. nullable: true example: string ReservationPurpose: allOf: - $ref: '#/components/schemas/ReservationPurposeEnum' description: 'The purpose of the block. Leisure Business Student' nullable: true example: string ExternalIdentifier: maxLength: 255 type: string description: Identifier of the block from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Notes: type: string description: Additional notes of the block. nullable: true example: string State: allOf: - $ref: '#/components/schemas/AvailabilityBlockStateEnum' description: 'State of the availability block. Confirmed (The block deducts availability and can have reservations assigned.) Optional (The block deducts availability and cannot have reservations assigned.) Inquired (The block does not deduct availability and cannot have reservations assigned (waitlist).) Canceled (The block does not deduct availability and cannot have reservations assigned (waitlist).)' example: string QuoteId: type: string description: Unique identifier of the Mews Events quote associated with the availability block. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PurchaseOrderNumber: type: string description: Unique number of the purchase order. This number is propagated to any newly picked up `Reservation` within the block. nullable: true example: '1001' BusinessSegmentId: type: string description: Unique identifier of the business segment. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PickupDistribution: allOf: - $ref: '#/components/schemas/PickupDistributionEnum' description: 'Specifies how reservations within the block are distributed for pickup. Defaults to `AllInOneGroup` if not provided. This value cannot be updated after creation. AllInOneGroup (All created reservations in the block are added to the same reservation group.) IndividualGroups (Reservations can be picked up in multiple groups, with up to 750 reservations per group.)' nullable: true example: string additionalProperties: false x-schema-id: AvailabilityBlockAddParameters ReservationCancellationParameters: title: ReservationCancellationParameters required: - AccessToken - Client - ClientToken - ReservationIds 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 ReservationIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the reservation to cancel. ReservationId: type: string format: uuid deprecated: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PostCancellationFee: type: boolean description: Whether the cancellation fees should be charged according to rate conditions. The default is `false`. nullable: true example: true SendEmail: type: boolean description: Whether the cancellation email should be sent. The default is `true`. nullable: true example: true Notes: type: string description: Additional notes describing the reason for the cancellation. example: string additionalProperties: false x-schema-id: ReservationCancellationParameters Source: title: Source required: - Code - Id - Name - Type - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the source. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name of the source. example: Example Name Type: $ref: '#/components/schemas/SourceType' UpdatedUtc: minLength: 1 type: string description: Date and time when the source was last updated, expressed in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' Code: type: integer description: Code of the source. format: int32 example: 1 additionalProperties: false x-schema-id: Source 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 RateAddParameters: title: Rate add parameters required: - AccessToken - Client - ClientToken - Rates 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 Rates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/RateAddData' description: Information about rates to be created. additionalProperties: false x-schema-id: RateAddParameters ReservationTimeFilter: title: Reservation time filter enum: - Colliding - Created - Updated - Start - End - Overlapping - Canceled type: string x-enumDescriptions: - Reservations whose intervals collide with the specified interval. - Reservations created within the specified interval. - Reservations updated within the specified interval. - Reservations starting (arriving) within the specified interval. - Reservations ending (departing) within the specified interval. - Reservations whose intervals contain the specified interval. - Reservations canceled within the specified interval. 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 RateGroupResult: title: RateGroupResult required: - RateGroups type: object properties: RateGroups: maxItems: 1000 type: array items: $ref: '#/components/schemas/RateGroup' description: The filtered rate groups. Cursor: type: string description: Unique identifier of the last and hence oldest rate group 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 rate groups. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: RateGroupResult RatePriceUpdate: title: Rate price update type: object properties: CategoryId: type: string description: Unique identifier of the Resource category whose prices to update. If not specified, base price is updated. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Value: type: number description: New value of the rate on the interval. If not specified, removes all 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: RatePriceUpdate Rate: title: Rate required: - GroupId - Id - IsActive - IsBaseRate - IsDefault - 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: Indicates if this 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: Indicates if this rate is active. example: true IsEnabled: type: boolean description: Indicates if this rate is currently available to customers. example: true IsPublic: type: boolean description: Indicates if this rate is publicly available. example: true IsDefault: type: boolean description: Indicates if this rate is the default rate for the service. Assigned automatically to the first rate of a service. 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 TaxExemptionReason: allOf: - $ref: '#/components/schemas/TaxExemptionReasonTypeEnum' description: 'Specifies the reason a rate 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 rate is exempt from tax. nullable: true example: string additionalProperties: false x-schema-id: Rate ReservationGroup: title: Reservation Group required: - EnterpriseId - Id type: object properties: Id: type: string description: Unique identifier of the reservation group. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: type: string description: Name of the reservation group, might be empty or same for multiple groups. nullable: true example: Example Name ChannelManager: type: string description: Name of the corresponding channel manager. nullable: true example: string ChannelManagerGroupNumber: type: string description: Identifier of the channel manager. nullable: true example: '1001' EnterpriseId: type: string description: Unique identifier of the `Enterprise` the reservation group belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ReservationGroup CategoryPricing: title: Resource category pricing required: - AmountPrices - CategoryId - Prices type: object properties: CategoryId: type: string description: Unique identifier of the category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Prices: type: array items: type: number format: double description: Prices of the rate for the resource category in the covered dates. deprecated: true x-deprecatedMessage: Use `AmountPrices` instead. AmountPrices: type: array items: $ref: '#/components/schemas/Amount' description: Prices of the rate for the resource category in the covered dates. additionalProperties: false x-schema-id: CategoryPricing AvailabilityBlockAddResult: title: AvailabilityBlockAddResult required: - AvailabilityBlocks type: object properties: AvailabilityBlocks: type: array items: $ref: '#/components/schemas/AvailabilityBlock' description: Availability blocks. additionalProperties: false x-schema-id: AvailabilityBlockAddResult RoutingRuleResult: title: RoutingRuleResult required: - RoutingRules type: object properties: RoutingRules: maxItems: 1000 type: array items: $ref: '#/components/schemas/RoutingRule' description: Collection of routing rules. 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: RoutingRuleResult MultipleRoutingRuleUpdateParameters: title: MultipleRoutingRuleUpdateParameters required: - AccessToken - Client - ClientToken - RoutingRuleUpdates 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 RoutingRuleUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/RoutingRuleUpdateParameters' description: Collection of Routing rules to be updated. additionalProperties: false x-schema-id: MultipleRoutingRuleUpdateParameters 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 CancellationPolicyApplicabilityEnum: title: Cancellation Policy Applicability enum: - Creation - Start - StartDate type: string description: 'Applicability mode of the cancellation policy. Creation Start StartDate' x-enumNames: - Creation - Start - StartDate x-enumDescriptions: - '' - '' - '' RatePricingDiscriminatorEnum: title: Rate pricing discriminator enum: - BaseRatePricing - DependentRatePricing type: string description: ' BaseRatePricing DependentRatePricing' x-enumNames: - BaseRatePricing - DependentRatePricing x-enumDescriptions: - '' - '' CategoryAdjustment: title: Resource category adjustment required: - AbsoluteValue - CategoryId - RelativeValue type: object properties: CategoryId: type: string description: Unique identifier of the adjustment category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ParentCategoryId: type: string description: Unique identifier of the parent category that serves as a base price for the current category. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AbsoluteValue: type: number description: Absolute value of the adjustment (e.g. `50` represents 50 EUR in case the rate currency is `EUR`). format: double example: 100.0 RelativeValue: type: number description: Relative value of the adjustment (e.g. `0.5` represents 50% increase). format: double example: 100.0 additionalProperties: false x-schema-id: CategoryAdjustment 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 MultipleAvailabilityBlockUpdateParameters: title: MultipleAvailabilityBlockUpdateParameters required: - AccessToken - AvailabilityBlocks - Client - ClientToken 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 AvailabilityBlocks: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/AvailabilityBlockUpdateParameters' description: Availability blocks to be updated. additionalProperties: false x-schema-id: MultipleAvailabilityBlockUpdateParameters EarlinessRestriction: title: Earliness restriction type: object properties: Id: type: string description: Unique identifier of the rate restriction. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateId: type: string description: Unique identifier of the rate. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsInherited: type: boolean description: Whether the rate restriction is inherited from the parent rate. example: true StartUtc: type: string description: Start of the rate restriction in UTC timezone in ISO 8601 format. nullable: true example: string EndUtc: type: string description: End of the rate restriction in UTC timezone in ISO 8601 format. nullable: true example: string Days: type: array items: type: string description: The restricted days of week. nullable: true ExternalIdentifier: type: string description: Identifiers of from external systems. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 MinAdvance: type: string description: The minimum time before the reservation starts, you can reserve in ISO 8601 duration format. nullable: true example: string MaxAdvance: type: string description: The maximum time before the reservation starts, you can reserve in ISO 8601 duration format. nullable: true example: string additionalProperties: false x-schema-id: EarlinessRestriction AvailabilityAdjustmentResult: title: AvailabilityAdjustmentResult required: - AvailabilityAdjustments type: object properties: AvailabilityAdjustments: type: array items: $ref: '#/components/schemas/AvailabilityAdjustment' description: Availability adjustments. 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: AvailabilityAdjustmentResult RateGroupOld: title: Rate group (ver 2017-04-12) type: object properties: Id: type: string description: Unique identifier of the rate group. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the Service that the rate group belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the rate group is still active. example: true Name: type: string description: Name of the rate group. nullable: true example: Example Name ExternalIdentifier: maxLength: 255 type: string description: External identifier of the rate group. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: RateGroupOld Reservation: title: Reservation (ver 2023-06-06) required: - AccountId - AccountType - CreatedUtc - CreatorProfileId - EndUtc - GroupId - Id - Number - Options - Origin - PersonCounts - RateId - RequestedResourceCategoryId - ScheduledEndUtc - ScheduledStartUtc - ServiceId - StartUtc - State - UpdatedUtc - UpdaterProfileId type: object properties: Id: type: string description: Unique identifier of the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service` that reservation 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 reservation, i.e. the main guest linked to the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountType: $ref: '#/components/schemas/AccountType' CreatorProfileId: type: string description: Unique identifier of the user who created the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 UpdaterProfileId: type: string description: Unique identifier of the user who updated the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BookerId: type: string description: Unique identifier of the booker who made the reservation on behalf of the reservation owner, in the special case where the booker is also a registered customer in Mews. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Number: minLength: 1 type: string description: Confirmation number of the reservation in Mews. example: '1001' State: title: Service order state allOf: - $ref: '#/components/schemas/ServiceOrderStateEnum' description: 'State of the reservation. Inquired (Confirmed neither by the customer nor enterprise.) Confirmed (Confirmed by both parties, before check-in.) Started (Checked in.) Processed (Checked out.) Canceled (Canceled.) Optional (Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest).) Requested (Confirmed by the customer but not by the enterprise (waitlist).)' x-enumNames: - Inquired - Confirmed - Started - Processed - Canceled - Optional - Requested x-enumDescriptions: - Confirmed neither by the customer nor enterprise. - Confirmed by both parties, before check-in. - Checked in. - Checked out. - Canceled. - Confirmed by enterprise but not by the guest (the enterprise is holding resource for the guest). - Confirmed by the customer but not by the enterprise (waitlist). example: string Origin: title: Service order origin allOf: - $ref: '#/components/schemas/ServiceOrderOriginEnum' description: 'Origin of the reservation. Distributor (From the Mews Booking Engine or Booking Engine API.) ChannelManager (From a channel manager.) Commander (From Mews Operations.) Import (From an import process.) Connector (From the Mews Connector API.) Navigator (From Mews Guest Services.)' x-enumNames: - Distributor - ChannelManager - Commander - Import - Connector - Navigator x-enumDescriptions: - From the Mews Booking Engine or Booking Engine API. - From a channel manager. - From Mews Operations. - From an import process. - From the Mews Connector API. - From Mews Guest Services. 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 reservation `Origin`. nullable: true example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the reservation in UTC timezone. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the reservation in UTC timezone. format: date-time example: '2026-06-02T14:30:00Z' CancelledUtc: type: string description: Cancellation date and time in UTC timezone. 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 reservation. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BusinessSegmentId: type: string description: Identifier of the reservation `BusinessSegment`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Options: title: Service order options allOf: - $ref: '#/components/schemas/ServiceOrderOptions' description: Options of the reservation. example: string RateId: type: string description: Identifier of the reservation `Rate`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreditCardId: type: string description: Unique identifier of the Credit card. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 GroupId: type: string description: Unique identifier of the Reservation group. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RequestedResourceCategoryId: type: string description: Unique identifier of the Resource category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedResourceId: type: string description: Identifier of the assigned Resource. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AvailabilityBlockId: type: string description: Unique identifier of the Availability block the reservation is assigned to. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PartnerCompanyId: type: string description: Identifier of the `Company` on behalf of which the reservation was made. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: type: string description: Identifier of the Travel Agency (`Company`) that mediated the reservation. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedResourceLocked: type: boolean description: Whether the reservation is locked to the assigned Resource and cannot be moved. example: true ChannelNumber: type: string description: Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number). nullable: true example: '1001' ChannelManagerNumber: type: string description: Unique number of the reservation within the reservation group. nullable: true example: '1001' CancellationReason: allOf: - $ref: '#/components/schemas/ServiceOrderCancellationReasonEnum' description: 'Cancellation reason of the reservation. Other ConfirmationMissed BookedElsewhere ForceMajeure GuestComplaint NoShow PriceTooHigh ServiceNotAvailable InputError InvalidPayment TravelAgency RequestedByGuest Update BookingAbandoned RequestedByBooker' nullable: true example: string ReleasedUtc: type: string description: Date when the optional reservation is released in UTC timezone. format: date-time nullable: true example: '2026-06-02T14:30:00Z' StartUtc: minLength: 1 type: string description: Reservation start or check-in time (if it's earlier than scheduled start) in UTC timezone in ISO 8601 format. format: date-time deprecated: true x-deprecatedMessage: Use `ScheduledStartUtc` and `ActualStartUtc` instead. example: '2026-06-02T14:30:00Z' EndUtc: minLength: 1 type: string description: Scheduled end time of reservation in UTC timezone in ISO 8601 format format: date-time deprecated: true x-deprecatedMessage: Use `ScheduledEndUtc` and `ActualEndUtc` instead. example: '2026-06-02T14:30:00Z' ScheduledStartUtc: minLength: 1 type: string description: Scheduled start time of reservation in UTC timezone. format: date-time example: '2026-06-02T14:30:00Z' ActualStartUtc: type: string description: Actual customer check-in time of reservation in UTC timezone. format: date-time nullable: true example: '2026-06-02T14:30:00Z' ScheduledEndUtc: minLength: 1 type: string description: Scheduled end time of reservation in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' ActualEndUtc: type: string description: Actual end time of reservation in UTC timezone in ISO 8601 format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' Purpose: allOf: - $ref: '#/components/schemas/ReservationPurposeEnum' description: 'Purpose of the reservation. Leisure Business Student' nullable: true example: string QrCodeData: type: string description: QR code data of the reservation. nullable: true example: string PersonCounts: minItems: 1 type: array items: $ref: '#/components/schemas/ReservationPersonCount' description: Number of people per age category the reservation was booked for. additionalProperties: false x-schema-id: Reservation CompanionshipAddParameters: title: CompanionshipAddParameters required: - AccessToken - Client - ClientToken - CustomerId - ReservationId type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. 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 ReservationId: type: string description: Unique identifier of the `Reservation`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Unique identifier of the `Customer`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: CompanionshipAddParameters RatePricingFilterParameters: title: Rate pricing filter parameters required: - AccessToken - Client - ClientToken - FirstTimeUnitStartUtc - LastTimeUnitStartUtc - RateId 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 RateId: type: string description: Unique identifier of the `Rate`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProductId: type: string description: Unique identifier of the `Product`. format: uuid nullable: true 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: 367 hours if hours, 367 days if days, or 24 months if months.' format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: RatePricingFilterParameters CancellationPolicyFilterParameters: title: CancellationPolicyFilterParameters 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: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service). CancellationPolicyIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Cancellation Policy](https://mews-systems.gitbook.io/connector-api/operations/#cancellationpolicy). Required if no other filter is provided. nullable: true RateGroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Rate group](https://mews-systems.gitbook.io/connector-api/operations/rates/#rategroup). Required if no other filter is provided. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the Cancellation Policy was updated. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' 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: CancellationPolicyFilterParameters ResourceAccessTokenType: title: Resource access token type enum: - PinCode - RfidTag type: string description: Type of stored value. MultipleRateCapacityOffsetUpdateParameters: title: MultipleRateCapacityOffsetUpdateParameters required: - AccessToken - CapacityOffsetUpdates - Client - ClientToken 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 CapacityOffsetUpdates: maxItems: 50 minItems: 1 type: array items: $ref: '#/components/schemas/RateCapacityOffsetUpdateParameters' description: A list of rate capacity offset updates to apply. additionalProperties: false description: Parameters for updating rate capacity offsets in an enterprise. x-schema-id: MultipleRateCapacityOffsetUpdateParameters RatePriceUpdateParameters: title: Rate price update parameters required: - AccessToken - Client - ClientToken - PriceUpdates - RateId 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 RateId: minLength: 1 type: string description: Unique identifier of the `Rate`. x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ProductId: type: string description: Unique identifier of the `Product`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 PriceUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/RatePriceUpdate' description: Price adjustments for specific time intervals. additionalProperties: false x-schema-id: RatePriceUpdateParameters ResourceFeatureClassification: title: Resource feature classification enum: - SeaView - RiverView - OceanView - TwinBeds - DoubleBed - RollawayBed - UpperBed - LowerBed - Balcony - AccessibleBathroom - AccessibleRoom - ElevatorAccess - HighFloor - Kitchenette - AirConditioning - PrivateJacuzzi - PrivateSauna - EnsuiteRoom - PrivateBathroom - SharedBathroom type: string description: Classification of `ResourceFeature`. RestrictionSetData: title: Restriction set data required: - Days - Type type: object properties: Type: title: Restriction type allOf: - $ref: '#/components/schemas/RestrictionTypeEnum' description: 'Restriction type. Stay (Guests can''t stay within specified dates.) Start (Guests can''t check in within specified dates.) End (Guests can''t check out within specified dates.)' x-enumNames: - Stay - Start - End x-enumDescriptions: - Guests can't stay within specified dates. - Guests can't check in within specified dates. - Guests can't check out within specified dates. example: string ExactRateId: type: string description: Unique identifier of the exact `Rate` to which the restriction applies. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BaseRateId: type: string description: Unique identifier of the base `Rate` to which the restriction applies. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateGroupId: type: string description: Unique identifier of the `Rate group` to which the restriction applies. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryId: type: string description: Unique identifier of the `Resource category` to which the restriction applies. nullable: true x-schema-id: HybridIdentifier example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceCategoryType: allOf: - $ref: '#/components/schemas/ResourceCategoryTypeEnum' description: 'Name of the `Resource category type` to which the restriction applies. Room Bed Dorm Apartment Suite Villa Site Office MeetingRoom ParkingSpot Desk TeamArea Membership Tent CaravanOrRV UnequippedCampsite Bike ExtraBed Cot Crib ConferenceRoom Rooftop Garden Restaurant Amphitheater PrivateSpaces' nullable: true example: string StartUtc: type: string description: Start date of the time interval for which the restriction conditions should be applied. This must be in UTC timezone in ISO 8601 format - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes). format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string description: End date of the time interval for which the restriction conditions should be applied. This must be in UTC timezone in ISO 8601 format - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes). format: date-time nullable: true example: '2026-06-02T14:30:00Z' Days: title: Days parameters allOf: - $ref: '#/components/schemas/DaysParameters' description: The restricted days of week. example: string MinAdvance: type: string description: The minimum time before the reservation starts, you can reserve in ISO 8601 duration format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' MaxAdvance: type: string description: The maximum time before the reservation starts, you can reserve in ISO 8601 duration format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' MinLength: type: string description: Minimal reservation length in ISO 8601 duration format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' MaxLength: type: string description: Maximal reservation length in ISO 8601 duration format. format: date-time nullable: true example: '2026-06-02T14:30:00Z' MinPrice: title: Currency value (ver 2023-02-02) allOf: - $ref: '#/components/schemas/CurrencyValue' description: Value of the minimum price per time unit. nullable: true example: string MaxPrice: title: Currency value (ver 2023-02-02) allOf: - $ref: '#/components/schemas/CurrencyValue' description: Value of the maximum price per time unit. nullable: true example: string additionalProperties: false x-schema-id: RestrictionSetData MultipleReservationUpdateParameters: title: Reservation updates required: - AccessToken - Client - ClientToken - ReservationId - ReservationUpdates 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 ReservationId: type: string description: Unique identifier of the reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ChannelNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number) (or `null` if the channel number should not be updated). nullable: true example: '1001' StartUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reservation start in UTC timezone in ISO 8601 format. (or `null` if the start time should not be updated). nullable: true example: string EndUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Reservation end in UTC timezone in ISO 8601 format. (or `null` if the end time should not be updated). nullable: true example: string ReleasedUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Date when the optional reservation is released in UTC timezone in ISO 8601 format. (or `null` if the release time should not be updated). nullable: true example: string PersonCounts: title: Person counts update value allOf: - $ref: '#/components/schemas/ReservationUpdatePersonCountParameters' description: Number of people per age category the reservation is for. If supplied, the person counts will be replaced. (or `null` if the person counts should not be updated). nullable: true example: string AssignedResourceId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the assigned `Resource`. If the assigned resource is locked, see `AssignedResourceLocked` for updating the assigned resource. (`null` if the assigned resource should not be updated) nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RequestedCategoryId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Identifier of the requested `ResourceCategory` (or `null` if resource category should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TravelAgencyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Company` that mediated the reservation (or `null` if travel agency should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanyId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Company` on behalf of which the reservation was made (or `null` if company should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 BusinessSegmentId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the reservation `BusinessSegment` (or `null` if the business segment should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Purpose: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: '`Purpose` of the reservation (or `null` if the purpose should not be updated).' nullable: true example: string RateId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidUpdateValue' description: Identifier of the reservation `Rate` (or `null` if the rate should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreditCardId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of `CreditCard` belonging to `Customer` who owns the reservation. (or `null` if the credit card should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TimeUnitPrices: title: Time unit amount update value allOf: - $ref: '#/components/schemas/ReservationUpdatePerUnitPriceParameters' description: Prices for time units of the reservation. E.g. prices for the first or second night. (or `null` if the unit amounts should not be updated). nullable: true example: string BookerId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the `Customer` on whose behalf the reservation was made. (or `null` if the booker should not be updated). nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedResourceLocked: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether the reservation should be locked to the assigned `Resource`. To reassign the reservation to a new `Resource`, first set `AssignedResourceLocked` to `false` to unlock the resource. Then, assign the reservation to a new `Resource` by setting `AssignedResourceId` to the new resource ID. (`null` if the lock should not be updated) nullable: true example: string AvailabilityBlockId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Unique identifier of the `AvailabilityBlock` the reservation is assigned to. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Options: title: Reservations options parameters update values allOf: - $ref: '#/components/schemas/ReservationUpdateOptionsParameters' description: Options of the reservations. nullable: true example: string ReservationUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ReservationUpdateParameters' description: Array of properties to be updated in each reservation specified. Reprice: type: boolean description: Whether the price should be updated to latest value for date/rate/category combination set in Mews. If not specified, the reservation price is updated. nullable: true example: true ApplyCancellationFee: type: boolean description: Whether the cancellation fees should be applied according to rate cancellation policies. If not specified, the cancellation fees are applied. nullable: true example: true Reason: type: string description: Reason for updating the reservation. Required when updating the price of the reservation. nullable: true example: string additionalProperties: false x-schema-id: MultipleReservationUpdateParameters RateAddResult: title: Rate add result type: object properties: Rates: maxItems: 1000 type: array items: $ref: '#/components/schemas/Rate' description: Rates that have been added. nullable: true additionalProperties: false x-schema-id: RateAddResult ReservationAdditionResult: title: ReservationAdditionResult required: - Reservations type: object properties: Reservations: type: array items: $ref: '#/components/schemas/AddedReservation' description: The added reservations. additionalProperties: false x-schema-id: ReservationAdditionResult ReservationsChannelManagerDetailsResult: title: Reservation channel manager details result required: - ChannelManagerDetails type: object properties: ChannelManagerDetails: type: array items: $ref: '#/components/schemas/ChannelManagerDetails' description: List of reservation channel manager details. additionalProperties: false x-schema-id: ReservationsChannelManagerDetailsResult RoutingRuleFilterParameters: title: RoutingRuleFilterParameters 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 CompanyIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifier of the `Company`. nullable: true RoutingRuleIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifier of the routing rules. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the routing rules were updated. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: RoutingRuleFilterParameters ProductPostingEnum: title: Product posting enum: - Once - Daily type: string description: ' Once Daily' x-enumNames: - Once - Daily x-enumDescriptions: - '' - '' 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: - '' - '' - '' - '' - '' - '' - '' - '' ReservationProcessingParameters: title: ReservationProcessingParameters required: - AccessToken - Client - ClientToken - ReservationId 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 ReservationId: type: string description: Unique identifier of the reservation to process. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CloseBills: type: boolean description: Whether closable bills of the reservation members should be automatically closed. nullable: true example: true AllowOpenBalance: type: boolean description: Whether non-zero consumed balance of all reservation members is allowed. nullable: true example: true Notes: type: string description: Required if AllowOpenBalance set to true. Used to provide reason for closing with unbalanced bill. nullable: true example: string additionalProperties: false x-schema-id: ReservationProcessingParameters RateSetParameters: title: Set rates parameters required: - AccessToken - Client - ClientToken - Rates 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 Rates: maxItems: 100 minItems: 1 type: array items: $ref: '#/components/schemas/RateSetData' description: Rates to be added or updated. additionalProperties: false x-schema-id: RateSetParameters RateExtent: title: Rate extent type: object properties: Rates: type: boolean description: Whether the response should contain rates. nullable: true example: true RateGroups: type: boolean description: Whether the response should contain rate groups. nullable: true deprecated: true x-deprecatedMessage: Use `rateGroups/getAll` example: true AvailabilityBlockAssignments: type: boolean description: Whether the response should contain availability block assignments. example: true additionalProperties: false description: Extent of data to be returned. x-schema-id: RateExtent RoutingRuleRouteType: title: Route type enum: - AllStayItems - SelectedStayItems type: string description: Determines to which stay items the routing rule applies. 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 ReservationPrice: title: Reservation price required: - TotalAmount type: object properties: Identifier: type: string description: Identifier of the reservation within the transaction. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 TotalAmount: title: Amount allOf: - $ref: '#/components/schemas/Amount' description: Total price of the reservation. example: string Total: title: Currency value (ver 2018-06-07) allOf: - $ref: '#/components/schemas/CurrencyValueOld' description: Total price of the reservation. nullable: true deprecated: true x-deprecatedMessage: Use `TotalAmount` instead. example: string additionalProperties: false x-schema-id: ReservationPrice ActivityStates: title: Activity state enum: - Deleted - Active type: string description: Activity states used for filtering. SourceAssignmentResultV20240920: title: SourceAssignmentResultV20240920 required: - SourceAssignments type: object properties: SourceAssignments: type: array items: $ref: '#/components/schemas/SourceAssignmentV20240920' description: Assignments between `Reservation` and `Source`. Cursor: type: string description: Opaque pagination cursor which can be used in `Limitation` to fetch newer source assignments. format: string nullable: true example: string additionalProperties: false x-schema-id: SourceAssignmentResultV20240920 ResourceState: title: Resource state enum: - Dirty - Clean - Inspected - OutOfService - OutOfOrder type: string description: 'State of the resource. Dirty Clean Inspected OutOfService OutOfOrder' x-enumNames: - Dirty - Clean - Inspected - OutOfService - OutOfOrder x-enumDescriptions: - '' - '' - '' - '' - '' x-schema-id: ResourceState RoutingRuleAdditionResult: title: RoutingRuleAdditionResult required: - RoutingRules type: object properties: RoutingRules: maxItems: 1000 type: array items: $ref: '#/components/schemas/RoutingRule' description: Added routing rules. additionalProperties: false x-schema-id: RoutingRuleAdditionResult RoutingRuleStayItemsUpdateParameters: title: Selected stay items update parameters type: object properties: Nights: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether the routing rule applies to nights (or null should it not be updated). nullable: true example: string CityTax: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Whether the routing rule applies to city tax (or null should it not be updated). nullable: true example: string ProductCategoryIds: title: Guid array update value allOf: - $ref: '#/components/schemas/GuidIEnumerableUpdateValue' description: Product categories to which the routing rule applies to (or null should it not be updated). nullable: true example: string additionalProperties: false description: '' x-schema-id: RoutingRuleStayItemsUpdateParameters DateRestriction: title: Date restriction type: object properties: Id: type: string description: Unique identifier of the rate restriction. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 RateId: type: string description: Unique identifier of the rate. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsInherited: type: boolean description: Whether the rate restriction is inherited from the parent rate. example: true StartUtc: type: string description: Start of the rate restriction in UTC timezone in ISO 8601 format. nullable: true example: string EndUtc: type: string description: End of the rate restriction in UTC timezone in ISO 8601 format. nullable: true example: string Days: type: array items: type: string description: The restricted days of week. nullable: true ExternalIdentifier: type: string description: Identifiers of from external systems. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: DateRestriction ResourceDataDiscriminator: title: Resource data discriminator enum: - Space - Object - Person type: string description: Whether the resource is space, object, or person. 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: Availability adjustments - name: Availability blocks - name: Business segments - name: Cancellation policies - name: Rate groups - name: Rates - name: Reservation groups - name: Reservations - name: Restrictions - name: Routing rules - name: Source assignments - name: Sources