Skip to content

Get cancellation policies by rates

POST
/api/connector/v1/cancellationPolicies/getByRates

Gets cancellation policies for enterprise grouped by rate for granular cancellation policies flow. This operation supports Portfolio Access Tokens.

CancellationPolicyByRateParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
RateIds
required

Unique identifiers of the Rate.

Array<string>
>= 1 items <= 100 items
ReservationStartUtc
required

Start of the reservation interval in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
ReservationEndUtc
required

End of the reservation interval in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"RateIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"4d0201db-36f5-428b-8d11-4f0a65e960cc"
]
}

OK

CancellationPolicyByRateResult
object
CancellationPolicies
required

List of cancellation policies data grouped by rate.

Array<object>
<= 1300 items
Cancellation policy data grouped by rate
object
RateId
required

Unique identifier of the Rate.

string format: uuid
Policies
required

Collection of cancellation policy data.

Array<object>
Cancellation policy data
object
Applicability
required
Cancellation Policy Applicability

Applicability mode of the cancellation policy.

Creation

Start

StartDate

string
Allowed values: Creation Start StartDate
FeeExtents
required

Extent for the cancellation fee, i.e. what should be in scope for the automatic payment.

Array<string>
Allowed values: Nothing TimeUnits Products Everything
ApplicabilityOffset
required

Offset for order start (assuming Applicability is set to Start) from which the fee is applied in ISO 8601 duration format.

string
>= 1 characters
FeeMaximumTimeUnits

Maximum number of time units the cancellation fee is applicable to.

integer format: int32
nullable
AbsoluteFee
required
Currency value (ver 2023-02-02)

Absolute value of the fee.

object
Currency
required
string format: currency
>= 1 characters
Value
required
number format: double
RelativeFee
required

Relative value of the fee, as a percentage of the reservation price.

number format: double
Example
{
"CancellationPolicies": [
{
"RateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Policies": [
{
"Applicability": "Start",
"FeeExtents": [
"TimeUnits",
"Products"
],
"ApplicabilityOffset": "P10DT20H30M",
"FeeMaximumTimeUnits": 1,
"AbsoluteFee": {
"Currency": "EUR",
"Value": 20
},
"RelativeFee": 0.1
}
]
},
{
"RateId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
"Policies": [
{
"Applicability": "Start",
"FeeExtents": [
"TimeUnits",
"Products"
],
"ApplicabilityOffset": "P5DT10H30M",
"FeeMaximumTimeUnits": 2,
"AbsoluteFee": {
"Currency": "EUR",
"Value": 15
},
"RelativeFee": 0.4
},
{
"Applicability": "Start",
"FeeExtents": [
"TimeUnits",
"Products"
],
"ApplicabilityOffset": "P10DT10H30M",
"FeeMaximumTimeUnits": 2,
"AbsoluteFee": {
"Currency": "EUR",
"Value": 15
},
"RelativeFee": 0.2
}
]
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable