APapaleo
Service

Get all services.

Changed on

Get the list of services. Pass languages to return each service's name and description in those languages (names and descriptions). languages=all returns every translation in one call.<br>You must have at least one of these scopes: 'services.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.services.read'.

get/rateplan/v1/services

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/rateplan/v1/services
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: services.read, setup.read, setup.manage, admin

Query parameters

languagesstring[]

'all' or comma separated list of two-letter language codes (ISO Alpha-2). Selects which translations are returned for each service. When omitted, the Accept-Language header is used.

propertyIdstring

Filter services by the specified property

textSearchstring

This will filter all services for the provided free text. Currently it only looks up if the service name contains one of the provided values.

onlySoldAsExtrasboolean

If set to true, return only services that can be sold as extras. Otherwise, it returns both, extras, and include-only.

channelCodesstring[]

The channel codes the service is sold through

serviceTypesstring[]

The service types offered

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: property. All other values will be silently ignored.

Response

Success.

countinteger required

Total count of items

Example response

{
  "services": [
    {
      "id": "MUC-WIFI",
      "name": "High Speed Wifi",
      "code": "WIFI",
      "description": "High speed wifi access for 24 hours, up to four devices.",
      "names": {
        "en": "High Speed Wifi",
        "de": "High-Speed WLAN"
      },
      "descriptions": {
        "en": "High speed wifi access for 24 hours, up to four devices.",
        "de": "High-Speed WLAN für 24 Stunden, bis zu vier Geräte."
      },
      "defaultGrossPrice": {
        "amount": 10,
        "currency": "EUR"
      },
      "pricingUnit": "Room",
      "postNextDay": false,
      "serviceType": "Other",
      "vatType": "Normal",
      "availability": {
        "mode": "Daily",
        "daysOfWeek": [
          "Saturday",
          "Sunday"
        ]
      },
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      },
      "subAccountId": "MUC-WF",
      "accountingConfig": {
        "revenueAllocation": [
          {
            "vatType": "Normal",
            "subAccountId": "MUC-WF",
            "percent": 100
          }
        ],
        "serviceType": "Other",
        "validFrom": "2021-01-01"
      },
      "channelCodes": [
        "Direct"
      ]
    },
    {
      "id": "MUC-BRKF",
      "name": "Breakfast",
      "code": "BRKF",
      "description": "Yummy yummy breakfast.",
      "names": {
        "en": "Breakfast",
        "de": "Frühstück"
      },
      "descriptions": {
        "en": "Yummy yummy breakfast.",
        "de": "Leckeres Frühstück."
      },
      "defaultGrossPrice": {
        "amount": 20,
        "currency": "EUR"
      },
      "pricingUnit": "Person",
      "postNextDay": false,
      "serviceType": "FoodAndBeverages",
      "vatType": "Null",
      "availability": {
        "mode": "Daily",
        "quantity": 7,
        "daysOfWeek": [
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday"
        ]
      },
      "property": {
        "id": "BER",
        "code": "BER",
        "name": "Demo Hotel Berlin",
        "description": "This is the demo hotel Berlin"
      },
      "accountingConfig": {
        "revenueAllocation": [
          {
            "vatType": "Normal",
            "percent": 70
          },
          {
            "vatType": "Reduced",
            "percent": 30
          }
        ],
        "serviceType": "FoodAndBeverages",
        "validFrom": "2021-01-01"
      },
      "channelCodes": [
        "Direct",
        "Ibe",
        "BookingCom",
        "ChannelManager"
      ]
    },
    {
      "id": "MUC-BRKF_CHILD",
      "name": "Breakfast for children.",
      "code": "BRKF_CHILD",
      "description": "Healthy breakfast for children.",
      "names": {
        "en": "Breakfast for children.",
        "de": "Frühstück für Kinder."
      },
      "descriptions": {
        "en": "Healthy breakfast for children.",
        "de": "Gesundes Frühstück für Kinder."
      },
      "defaultGrossPrice": {
        "amount": 10,
        "currency": "EUR"
      },
      "pricingUnit": "Person",
      "postNextDay": false,
      "serviceType": "FoodAndBeverages",
      "vatType": "Null",
      "availability": {
        "mode": "Daily",
        "quantity": 7,
        "daysOfWeek": [
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday"
        ]
      },
      "property": {
        "id": "BER",
        "code": "BER",
        "name": "Demo Hotel Berlin",
        "description": "This is the demo hotel Berlin"
      },
      "accountingConfig": {
        "revenueAllocation": [
          {
            "vatType": "Normal",
            "percent": 70
          },
          {
            "vatType": "Reduced",
            "percent": 30
          }
        ],
        "serviceType": "FoodAndBeverages",
        "validFrom": "2021-01-01"
      },
      "channelCodes": [
        "Direct",
        "Ibe",
        "BookingCom",
        "ChannelManager"
      ],
      "ageCategoryId": "MUC-CHILD"
    }
  ],
  "count": 0
}

Changes