Get all rates
POST /api/connector/v1/rates/getAll
Returns all rates (pricing setups) of the default service provided by the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.
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.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Extent of data to be returned. If not specified, both Rates and RateGroups will be included.
object
Whether the response should contain rates.
Whether the response should contain rate groups.
Whether the response should contain availability block assignments.
Unique identifiers of the requested Rates.
Interval in which Rate was updated.
object
Unique identifiers of the Services from which the rates are requested.
Identifiers of Rate from external systems.
Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted will be returned.
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
Section titled “ Responses ”OK
object
Rates of the default service.
object
Unique identifier of the rate.
Unique identifier of Rate Group where the rate belongs.
Unique identifier of the Service.
Unique identifier of the base Rate.
Indicates if this is a base rate.
Unique identifier of the Business Segment.
Indicates if this rate is active.
Indicates if this rate is currently available to customers.
Indicates if this rate is publicly available.
Indicates if this rate is the default rate for the service. Assigned automatically to the first rate of a service.
Type of the rate.
Public
Private
AvailabilityBlock
Name of the rate (in the default language).
All translations of the name.
object
Short name of the rate (in the default language).
Interval in which the rates were updated.
All translations of the external name of the rate.
object
All translations of the description of the rate.
object
Identifier of the rate from external system.
Specifies the reason a rate is exempt from tax.
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)
Legal reference that states why this rate is exempt from tax.
Rate groups of the default service.
object
Unique identifier of the rate group.
Unique identifier of the Service that the rate group belongs to.
Whether the rate group is still active.
Name of the rate group.
External identifier of the rate group.
object
Date restrictions for the rate.
object
Unique identifier of the rate restriction.
Unique identifier of the rate.
Whether the rate restriction is inherited from the parent rate.
Start of the rate restriction in UTC timezone in ISO 8601 format.
End of the rate restriction in UTC timezone in ISO 8601 format.
The restricted days of week.
Identifiers of from external systems.
Earliness restrictions for the rates that are only available up to before arrival.
object
Unique identifier of the rate restriction.
Unique identifier of the rate.
Whether the rate restriction is inherited from the parent rate.
Start of the rate restriction in UTC timezone in ISO 8601 format.
End of the rate restriction in UTC timezone in ISO 8601 format.
The restricted days of week.
Identifiers of from external systems.
The minimum time before the reservation starts, you can reserve in ISO 8601 duration format.
The maximum time before the reservation starts, you can reserve in ISO 8601 duration format.
Length restrictions for the rate.
object
Unique identifier of the rate restriction.
Unique identifier of the rate.
Whether the rate restriction is inherited from the parent rate.
Start of the rate restriction in UTC timezone in ISO 8601 format.
End of the rate restriction in UTC timezone in ISO 8601 format.
The restricted days of week.
Identifiers of from external systems.
Minimal reservation length in ISO 8601 duration format.
Maximal reservation length in ISO 8601 duration format.
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.
Example
{ "Rates": [ { "BaseRateId": null, "BusinessSegmentId": null, "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" } ]}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.