--- title: "Get all cancellation policies" method: POST path: "/api/connector/v1/cancellationPolicies/getAll" tags: ["Cancellation policies"] --- # Get all cancellation policies `POST /api/connector/v1/cancellationPolicies/getAll` ## Request - Base URL: `https://api.mews.com` - URL: `https://api.mews.com/api/connector/v1/cancellationPolicies/getAll` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) > ### Restricted! > This operation is currently in beta-test and as such it is subject to change. Returns all cancellation policies, filtered by services, rate groups 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). ## Request body - CancellationPolicyFilterParameters - `ClientToken` string, required: Token identifying the client application. - `AccessToken` string, required: Access token of the client application. - `Client` string, required: Name and version of the client application. - `Limitation` Limitation, required: Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable - `EnterpriseIds` string[], nullable: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. - `ServiceIds` string[], required: Unique identifiers of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service). - `CancellationPolicyIds` string[], nullable: Unique identifiers of the [Cancellation Policy](https://mews-systems.gitbook.io/connector-api/operations/#cancellationpolicy). Required if no other filter is provided. - `RateGroupIds` string[], nullable: Unique identifiers of the [Rate group](https://mews-systems.gitbook.io/connector-api/operations/rates/#rategroup). Required if no other filter is provided. - `UpdatedUtc` TimeFilterInterval: When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `ActivityStates` ActivityStates[], nullable: Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned. ## Response `200` OK - CancellationPolicyResult - `CancellationPolicies` CancellationPolicy[], required: The filtered cancellation policies. - `Id` string, uuid, required: Unique identifier of the cancellation policy. - `RateGroupId` string, uuid, required: Unique identifier of the rate group the cancellation policy belongs to. - `CreatedUtc` string, date-time, required: Date and time of the cancellation policy creation in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required: Date and time of the cancellation policy update in UTC timezone in ISO 8601 format. - `Applicability` 'Creation' | 'Start' | 'StartDate', required: Applicability mode of the cancellation policy. - `FeeExtent` CancellationFeeExtent[], required: Extent for the cancellation fee, i.e. what should be in scope for the automatic payment. - `ApplicabilityOffset` string, required: Offset for order start (assuming Applicability is set to Start) from which the fee is applied. - `FeeMaximumTimeUnits` integer, nullable: Maximum number of time units the cancellation fee is applicable to. - `AbsoluteFee` CurrencyValue, required: Absolute value of the fee. - `Currency` string, currency, required: ISO-4217 code of the `Currency`. - `Value` number, double, required: Amount in the currency. - `RelativeFee` number, double, required: Relative value of the fee, as a percentage of the reservation price. - `IsActive` boolean, required: Whether the cancellation policy is still active. - `Cursor` string, uuid, nullable: 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. ## Other responses - `204`: Server has successfully fulfilled the request and there is no additional information to send back. - `400`: 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). - `401`: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. - `403`: 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. - `408`: 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) - `429`: 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). - `500`: 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). --- [API](https://skmtc.dev/mews/apis/connector-api.md) - [All operations](https://skmtc.dev/mews/apis/connector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mews/apis/connector-api/revisions/cabf1b2da1d0?raw)