Skip to content

Get product pricing

POST
/api/connector/v1/products/getPricing

Returns prices for a given product for a specified time interval. 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: 100 hours if hours, 100 days if days, or 24 months if months. For more information about time units, see Time unit. This operation supports Portfolio Access Tokens.

Product pricing filter parameters
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
ProductId
required

Unique identifier of the product.

string format: uuid
FirstTimeUnitStartUtc
required

Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.

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

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: 100 hours if hours, 100 days if days, or 24 months if months.

string format: date-time
>= 1 characters
EnterpriseIds

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

Array<string>
nullable >= 1 items <= 1000 items
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ProductId": "6b97a38b-0043-41e0-afbd-3f083bdbc0d2",
"FirstTimeUnitStartUtc": "2024-03-01T23:00:00.000Z",
"LastTimeUnitStartUtc": "2024-03-03T23:00:00.000Z",
"EnterpriseIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"4d0201db-36f5-428b-8d11-4f0a65e960cc"
]
}

OK

Product pricing result
object
ProductId
required

Unique identifier of the product.

string format: uuid
TimeUnitStartsUtc
required

Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.

Array<string> format: date-time
BaseAmountPrices
required

Base prices of the product for each time unit covered by the time interval.

Array<object>
Amount
object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
AgeCategoryPrices
required

Age category prices.

Array<object>
Age category price
object
AgeCategoryId
required

Unique identifier of the age category.

string format: uuid
Prices
required

Prices of the product for the resource category in the covered dates.

Array<object>
Amount
object
Currency
required

ISO-4217 code of the Currency.

string format: currency
>= 1 characters
NetValue
required

Net value without taxes.

number format: double
GrossValue
required

Gross value including all taxes.

number format: double
TaxValues
required

The tax values applied.

Array<object>
Tax value
object
Code

Code corresponding to tax type.

string
nullable
Value
required

Amount of tax applied.

number format: double
Breakdown
required
Tax breakdown

Information about individual tax amounts.

object
Items
required

Tax breakdown items per each tax rate applied.

Array<object>
Tax breakdown item
object
TaxRateCode

Tax rate code for the item. null for untaxed amounts.

string
nullable
NetValue
required

The net value that the tax is calculated from.

number format: double
TaxValue
required

The value of the tax.

number format: double
Example
{
"ProductId": "6b97a38b-0043-41e0-afbd-3f083bdbc0d2",
"TimeUnitStartsUtc": [
"2024-03-01T23:00:00Z",
"2024-03-02T23:00:00Z",
"2024-03-03T23:00:00Z"
],
"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
}
]
}
}
],
"AgeCategoryPrices": [
{
"AgeCategoryId": "7d9d9b11-2c96-4862-9ead-501c6a8ed114",
"Prices": [
{
"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
}
]
}
}
]
}
]
}

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