Get rate pricing
POST /api/connector/v1/rates/getPricing
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.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the Rate
.
Unique identifier of the Product
.
Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the last time unit, 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.
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
Section titled “ Responses ”OK
object
ISO-4217 code of the Currency.
Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.
Base prices of the rates for each time unit covered by the time interval.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null
for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Resource category prices.
object
Unique identifier of the category.
Prices of the rate for the resource category in the covered dates.
Prices of the rate for the resource category in the covered dates.
object
ISO-4217 code of the Currency.
Net value without taxes.
Gross value including all taxes.
The tax values applied.
object
Code corresponding to tax type.
Amount of tax applied.
Information about individual tax amounts.
object
Tax breakdown items per each tax rate applied.
object
Tax rate code for the item. null
for untaxed amounts.
The net value that the tax is calculated from.
The value of the tax.
Resource category adjustments.
object
Unique identifier of the adjustment category.
Unique identifier of the parent category that serves as a base price for the current category.
Absolute value of the adjustment (e.g. 50
represents 50 EUR in case the rate currency is EUR
).
Relative value of the adjustment (e.g. 0.5
represents 50% increase).
Assigns different pricing or occupancy based on the guest’s age.
object
Unique identifier of the age category.
Absolute value of the adjustment (e.g. 50
represents 50 EUR in case the rate currency is EUR
).
Age category adjustment type
ExtraOccupancyAdjustment
NegativeOccupancyAdjustment
StandardOccupancyAdjustment
Specific amount which shows the difference between this rate and the base rate.
Relative amount which shows the difference between this rate and the base rate.
Price adjustment for when the resource booked with this rate is not full to capacity.
Price adjustment for when the resource booked with this rate exceeds capacity.
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": null, "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" ]}
Server has successfully fulfilled the request and there is no additional information to send back.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.