Skip to content

Price reservations

POST
/api/connector/v1/reservations/price

Returns prices of reservations with the specified parameters. Note that the operation doesn’t check the maximum capacity of requested resource category. Requesting person counts above the capacity will return prices for the maximum available capacity.

This operation supports Portfolio Access Tokens.

ReservationDataParameters
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
ServiceId
required

Unique identifier of the Service to be priced.

string format: uuid
Reservations
required

Parameters of the reservations to price. Note that CustomerId is not required when pricing reservations.

Array<object>
Reservation parameters
object
Identifier

Identifier of the reservation within the transaction.

string
nullable
ChannelNumber
string
nullable
State
Any of:
Service order state (ver 2017-04-12)
string
Allowed values: Enquired Confirmed Started Processed Canceled Optional Requested
StartUtc
required

Reservation start in UTC timezone in ISO 8601 format.

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

Reservation end in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
ReleasedUtc

Release date and time of an unconfirmed reservation in UTC timezone in ISO 8601 format.

string format: date-time
nullable
AdultCount
integer format: int32
ChildCount
integer format: int32
PersonCounts
required

Number of people per age category the reservation was booked for. At least one category with valid count must be provided.

Array<object>
>= 1 items
Age category parameters
object
AgeCategoryId
required

Unique identifier of the Age category.

string format: uuid
Count
required

Number of people of a given age category. Only positive value is accepted.

integer format: int32
CustomerId
required

Unique identifier of the Customer who owns the reservation.

string format: uuid
BookerId

Unique identifier of the Customer on whose behalf the reservation was made.

string format: uuid
nullable
RequestedCategoryId
required

Identifier of the requested ResourceCategory.

string format: uuid
RateId
required

Identifier of the reservation Rate.

string format: uuid
VoucherCode

Voucher code value providing access to specified private Rate applied to this reservation.

string
nullable
CreditCardId

Identifier of CreditCard belonging either to the Customer who owns the reservation or to the Booker.

string format: uuid
nullable
TravelAgencyId

Identifier of the Company that mediated the reservation.

string format: uuid
nullable
CompanyId

Identifier of the Company on behalf of which the reservation was made.

string format: uuid
nullable
BusinessSegmentId

Identifier of the reservation BusinessSegment.

string format: uuid
nullable
Notes

Additional notes.

string
nullable
TimeUnitAmount
Amount parameters

Amount of each night of the reservation.

object
Currency
required
string format: currency
>= 1 characters
TaxCodes
required
Array<string>
NetValue
number format: double
nullable
GrossValue
number format: double
nullable
TimeUnitPrices

Prices for time units of the reservation. E.g. prices for the first or second night.

Array<object>
nullable
Time unit amount parameters
object
Index

Index of the unit. Indexing starts with 0. E.g. the first night of the reservation has index 0.

integer format: int32
Amount
Amount parameters

Amount of the unit.

object
Currency
required
string format: currency
>= 1 characters
TaxCodes
required
Array<string>
NetValue
number format: double
nullable
GrossValue
number format: double
nullable
ProductOrders

Parameters of the products ordered together with the reservation.

Array<object>
nullable
Product order parameters
object
ProductId
required
string format: uuid
Count
integer format: int32
nullable
UnitAmount
Amount parameters

Price of the product that overrides the price defined in Mews.

object
Currency
required
string format: currency
>= 1 characters
TaxCodes
required
Array<string>
NetValue
number format: double
nullable
GrossValue
number format: double
nullable
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
ExternalIdentifier
string
nullable
AvailabilityBlockId

Unique identifier of the AvailabilityBlock the reservation is assigned to.

string format: uuid
nullable
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
"Reservations": [
{
"Identifier": "1234",
"StartUtc": "2018-01-01T14:00:00Z",
"EndUtc": "2018-01-02T10:00:00Z",
"RequestedCategoryId": "0a5da171-3663-4496-a61e-35ecbd78b9b1",
"RateId": "33667cab-f17f-4089-ad07-c2cd50fa0df1",
"Notes": "Test reservation",
"ProductOrders": [
{
"ProductId": "3dc5d79b-67ce-48ed-9238-47fcf5d1a59f"
}
],
"PersonCounts": [
{
"AgeCategoryId": "1f67644f-052d-4863-acdf-ae1600c60ca0",
"Count": 2
},
{
"AgeCategoryId": "ab58c939-be30-4a60-8f75-ae1600c60c9f",
"Count": 2
}
]
}
]
}

OK

ReservationPricingResult
object
ReservationPrices
required

The reservation prices.

Array<object>
Reservation price
object
Identifier

Identifier of the reservation within the transaction.

string
nullable
TotalAmount
required
Amount

Total price of the reservation.

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
Total
Currency value (ver 2018-06-07)

Total price of the reservation.

object
Currency
required
string format: currency
>= 1 characters
Value
number format: double
nullable
Net
number format: double
nullable
Tax
number format: double
nullable
TaxRate
number format: double
nullable
Example
{
"ReservationPrices": [
{
"Identifier": "1234",
"Total": {
"Currency": "GBP",
"NetValue": 20,
"GrossValue": 23,
"TaxValues": [
{
"Code": "UK-S",
"Value": 3
}
]
}
}
]
}

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