Services
Get services availability
Get availability for the specified service for each time unit in the specified date interval.
Request
[ApiBaseUrl]/api/distributor/v1/services/getAvailability
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Identification of the client as described in Authorization. |
| string | required | Unique identifier of the enterprise. |
| string | required | Unique identifier of the Service for which availability should be returned. |
| string | required | Start date of the requested interval. |
| string | required | End date of the requested interval. |
| array of string | optional | Unique identifiers of specific categories for which availability should be returned. If omitted, availability will be returned for all categories. |
| string | optional | Code of the language. Supported language codes |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of string | required | Each time unit specified in request interval. Values are in UTC timezone in ISO 8601 format. |
| array of Category Availability | required | List of availability counts for each category. Each availability number belongs to TimeUnitStartsUtc linked by same index. |
Category Availability
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Identifier of the room category. |
| array of number | required | List of availability counts for each TimeUnitStartsUtc linked by same index. |
Get services pricing
Get pricing for the specified service for each time unit in the specified date interval.
Request
[ApiBaseUrl]/api/distributor/v1/services/getPricing
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Identification of the client as described in Authorization. |
| string | required | Unique identifier of the enterprise. |
| string | required | Unique identifier of the Service for which availability should be returned. |
| string | required | Start date of the requested interval. |
| string | required | End date of the requested interval. |
| array of string | optional | Unique identifiers of specific room categories for which pricing should be computed. If omitted, pricing will be computed and returned for all room categories. |
| array of string | optional | Unique identifiers of specific rates for which pricing should be computed. If omitted, pricing will be computed and returned for all rates. |
| string | optional | Code of the language. Supported language codes |
| string | optional | Currency code which should be used for prices in the response. Supported currency codes |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Rate group | required | Information about all available rate groups. |
| array of Rate | required | Information about all available rates. |
| array of Category price | required | Prices for all specified categories. |
Category price
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of category. |
| array of objects with arrays of Occupancy | required | List of occupancies for age categories against which rate group prices are supplied. |
| array of Rate group price | required | Prices for the given category for each of the occupancy bands specified in OccupancyPrices. |
Occupancy
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Identifier of age category. |
| number | required | Number of persons of this Age category type. |
Rate group price
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of rate. |
| Min price objects | required | Minimal price for the specified interval for rate. |
| Max price objects | required | Maximal price for the specified interval for rate. |
Min price
Property | Type | Contract | Description |
---|---|---|---|
| Amount objects | required | Total price for specified interval. |
| Amount objects | required | Price for one timeUnit. (Day/Night) |
Max price
Property | Type | Contract | Description |
---|---|---|---|
| Amount objects | required | Total price for specified interval. |
| Amount objects | required | Price for one timeUnit. (Day/Night) |
Rate
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the rate. |
| required | Name of the rate localized into all supported languages. | |
| required | Description of the rate localized into all supported languages. | |
| boolean | required | Set to |
| string | required | Unique identifier of the Service to which the rate is bound. |
| string | required | Rate group Identifier of the rate. |
| number | required | Number defining the ordering of the rate. |
Amount
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO 4217 code of the currency. |
| number | required | Gross value of the amount. (Net + sum of |
| number | required | Net value of the amount. |
| array of Complete tax | required | List of taxes related to this amount. |
Rate
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Amount currency. |
| number | required | Gross value of the amount. (Net + sum of |
| number | required | Net value of the amount. |
| array of Complete tax | required | List of taxes related to this amount. |
Complete tax
Property | Type | Contract | Description |
---|---|---|---|
| string | Unique identifier of the tax rate. | |
| number | required | Net value taxValue is calculated from. |
| number | required | Tax value calculated from |
Response diagram
Last updated