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

{
    "Client": "My Client 1.0.0",
    "EnterpriseId": "3edbe1b4-6739-40b7-81b3-d369d9469c48",
    "ServiceId": "40665467-5862-4932-a861-aa6b00e2b660",
    "StartUtc": "202-01-01T00:00:00Z",
    "EndUtc": "2022-01-31T00:00:00Z",
    "CategoryIds": ["4037c0ec-a59d-43f1-9d97-d6c984764e8c"],
    "LanguageCode": "en-GB"
}
PropertyTypeContractDescription

Client

string

required

Identification of the client as described in Authorization.

EnterpriseId

string

required

Unique identifier of the enterprise.

ServiceId

string

required

Unique identifier of the Service for which availability should be returned.

StartUtc

string

required

Start date of the requested interval.

EndUtc

string

required

End date of the requested interval.

CategoryIds

array of string

optional

Unique identifiers of specific categories for which availability should be returned. If omitted, availability will be returned for all categories.

LanguageCode

string

optional

Code of the language. Supported language codes

Response

{
  "TimeUnitStartsUtc": [
    "2022-10-04T22:00:00Z",
    "2022-10-05T22:00:00Z",
    "2022-10-06T22:00:00Z"
  ],
  "CategoryAvailabilities": [
    {
      "CategoryId": "ddc48d9f-f21d-422a-b24a-aa6b00e2b77e",
      "Availabilities": [
        56,
        40,
        26
      ]
    },
    {
      "CategoryId": "abcdefg-08ad-4d19-98cc-aa6b00e2999e",
      "Availabilities": [
        0,
        10,
        0
      ]
    }
  ]
}
PropertyTypeContractDescription

TimeUnitStartsUtc

array of string

required

Each time unit specified in request interval. Values are in UTC timezone in ISO 8601 format.

CategoryAvailabilities

array of Category Availability

required

List of availability counts for each category. Each availability number belongs to TimeUnitStartsUtc linked by same index.

Category Availability

PropertyTypeContractDescription

CategoryId

string

required

Identifier of the room category.

Availabilities

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

{
    "Client": "My Client 1.0.0",
    "EnterpriseId": "3edbe1b4-6739-40b7-81b3-d369d9469c48",
    "ServiceId": "40665467-5862-4932-a861-aa6b00e2b660",
    "StartUtc": "202-01-01T00:00:00Z",
    "EndUtc": "2022-01-31T00:00:00Z",
    "CategoryIds": ["4037c0ec-a59d-43f1-9d97-d6c984764e8c"],
    "RateIds": ["4037c0ec-a59d-43f1-9d97-d6c984764e8c"],
    "LanguageCode": "en-GB",
    "CurrencyCode": "EUR"
}
PropertyTypeContractDescription

Client

string

required

Identification of the client as described in Authorization.

EnterpriseId

string

required

Unique identifier of the enterprise.

ServiceId

string

required

Unique identifier of the Service for which availability should be returned.

StartUtc

string

required

Start date of the requested interval.

EndUtc

string

required

End date of the requested interval.

CategoryIds

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.

RateIds

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.

LanguageCode

string

optional

Code of the language. Supported language codes

CurrencyCode

string

optional

Currency code which should be used for prices in the response. Supported currency codes

Response

{
  "RateGroups":[
    {
      "Id": "3ede420b-9e9e-4008-abef-abc800c82505",
      "Ordering": 0,
      "SettlementType": "Manual",
      "SettlementAction": "ChargeCreditCard",
      "SettlementTrigger": "Start",
      "SettlementValue": 1.00,
      "SettlementOffset": "P0M0DT0H0M0S",
      "SettlementMaximumNights": null,
      "SettlementMaximumTimeUnits": null,
      "SettlementCurrencyCode": null
    }
  ],
  "Rates":[
    {
      "Id": "f02923a9-ffa3-4d83-a9d7-abc800c81111",
      "ServiceId": "33c75941-c2ec-467e-9797-abc800c8110d",
      "RateGroupId": "3ede420b-9e9e-4008-abef-abc800c82505",
      "Ordering": 0,
      "Name": {
        "es-ES": "Fully Flexible",
        "en-US": "Fully Flexible"
      },
      "Description": {},
      "IsPrivate": false,
      "CurrencyCode": "EUR"
    }
  ],
  "CategoryPrices": [
    {
      "CategoryId": "4037c0ec-a59d-43f1-9d97-d6c984764e8c",
      "OccupancyPrices": [
        {
          "Occupancies": [
            {
              "AgeCategoryId": "16e8a466-729e-4d32-a221-ade300e410a8",
              "PersonCount": 2
            },
            {
              "AgeCategoryId": "790c82c1-cbe6-4b8d-a45f-ade300e410a8",
              "PersonCount": 0
            }
          ]
        }
      ],
      "RateGroupPrices":[
        {
          "MinRateId": "abd865c2-8cc3-4ebc-acad-aca100b125b9",
          "MinPrice": {
            "TotalAmount": {
              "Currency": "EUR",
              "GrossValue": 83.41,
              "NetValue": 77.65,
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": 18.11,
                    "TaxValue": 0.0
                  },
                  {
                    "TaxRateCode": "CZ-L",
                    "NetValue": 57.50,
                    "TaxValue": 5.76
                  },
                  {
                    "TaxRateCode": "CZ-Z",
                    "NetValue": 2.04,
                    "TaxValue": 0.00
                  }
                ]
              }
            },
            "AverageAmountPerTimeUnit": {
              "Currency": "EUR",
              "GrossValue": 41.71,
              "NetValue": 38.83,
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": 9.06,
                    "TaxValue": 0.0
                  },
                  {
                    "TaxRateCode": "CZ-L",
                    "NetValue": 28.75,
                    "TaxValue": 2.88
                  },
                  {
                    "TaxRateCode": "CZ-Z",
                    "NetValue": 1.02,
                    "TaxValue": 0.00
                  }
                ]
              }
            }
          },
          "MaxPrice": {
            "TotalAmount": {
              "Currency": "EUR",
              "GrossValue": 20020.15,
              "NetValue": 18201.97,
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": 18.11,
                    "TaxValue": 0.0
                  },
                  {
                    "TaxRateCode": "CZ-L",
                    "NetValue": 18181.82,
                    "TaxValue": 1818.18
                  },
                  {
                    "TaxRateCode": "CZ-Z",
                    "NetValue": 2.04,
                    "TaxValue": 0.00
                  }
                ]
              }
            },
            "AverageAmountPerTimeUnit": {
              "Currency": "EUR",
              "GrossValue": 10010.08,
              "NetValue": 9100.99,
              "Breakdown": {
                "Items": [
                  {
                    "TaxRateCode": null,
                    "NetValue": 9.06,
                    "TaxValue": 0.0
                  },
                  {
                    "TaxRateCode": "CZ-L",
                    "NetValue": 9090.91,
                    "TaxValue": 909.09
                  },
                  {
                    "TaxRateCode": "CZ-Z",
                    "NetValue": 1.02,
                    "TaxValue": 0.00
                  }
                ]
              }
            }
          }
        }
      ]
    }
  ]
}
PropertyTypeContractDescription

RateGroups

array of Rate group

required

Information about all available rate groups.

Rates

array of Rate

required

Information about all available rates.

CategoryPrices

array of Category price

required

Prices for all specified categories.

Category price

PropertyTypeContractDescription

CategoryId

string

required

Unique identifier of category.

OccupancyPrices

array of objects with arrays of Occupancy

required

List of occupancies for age categories against which rate group prices are supplied.

RateGroupPrices

array of Rate group price

required

Prices for the given category for each of the occupancy bands specified in OccupancyPrices.

Occupancy

PropertyTypeContractDescription

AgeCategoryId

string

required

Identifier of age category.

PersonCount

number

required

Number of persons of this Age category type.

Rate group price

PropertyTypeContractDescription

MinRateId

string

required

Unique identifier of rate.

MinPrice

Min price objects

required

Minimal price for the specified interval for rate.

MaxPrice

Max price objects

required

Maximal price for the specified interval for rate.

Min price

PropertyTypeContractDescription

TotalAmount

Amount objects

required

Total price for specified interval.

AverageAmountPerTimeUnit

Amount objects

required

Price for one timeUnit. (Day/Night)

Max price

PropertyTypeContractDescription

TotalAmount

Amount objects

required

Total price for specified interval.

AverageAmountPerTimeUnit

Amount objects

required

Price for one timeUnit. (Day/Night)

Rate

PropertyTypeContractDescription

Id

string

required

Unique identifier of the rate.

Name

Localized text

required

Name of the rate localized into all supported languages.

Description

Localized text

required

Description of the rate localized into all supported languages.

IsPrivate

boolean

required

Set to true for promotion rate enabled by provided VoucherCode.

ServiceId

string

required

Unique identifier of the Service to which the rate is bound.

RateGroupId

string

required

Rate group Identifier of the rate.

Ordering

number

required

Number defining the ordering of the rate.

Amount

PropertyTypeContractDescription

Currency

string

required

ISO 4217 code of the currency.

GrossValue

number

required

Gross value of the amount. (Net + sum of TaxValues)

NetValue

number

required

Net value of the amount.

Breakdown.Items

array of Complete tax

required

List of taxes related to this amount.

Rate

PropertyTypeContractDescription

Currency

string

required

Amount currency.

GrossValue

number

required

Gross value of the amount. (Net + sum of Breakdown > Items)

NetValue

number

required

Net value of the amount.

Breakdown.Items

array of Complete tax

required

List of taxes related to this amount.

Complete tax

PropertyTypeContractDescription

TaxRateCode

string

Unique identifier of the tax rate.

NetValue

number

required

Net value taxValue is calculated from.

TaxValue

number

required

Tax value calculated from NetValue based on Tax configuration.

Response diagram

PreviousReservation groupsNextVouchers

Last updated