Service

Get all services.

Get the list of services.<br>You must have at least one of these scopes: 'services.read, setup.read, setup.manage'.

get/rateplan/v1/services

Query parameters

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.",
      "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",
      "channelCodes": [
        "Direct"
      ]
    },
    {
      "id": "MUC-BRKF",
      "name": "Breakfast",
      "code": "BRKF",
      "description": "Yummy yummy breakfast.",
      "defaultGrossPrice": {
        "amount": 20,
        "currency": "EUR"
      },
      "pricingUnit": "Person",
      "postNextDay": false,
      "serviceType": "FoodAndBeverages",
      "vatType": "Normal",
      "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"
      },
      "channelCodes": [
        "Direct",
        "Ibe",
        "BookingCom",
        "ChannelManager"
      ]
    },
    {
      "id": "MUC-BRKF_CHILD",
      "name": "Breakfast for children.",
      "code": "BRKF_CHILD",
      "description": "Healthy breakfast for children.",
      "defaultGrossPrice": {
        "amount": 10,
        "currency": "EUR"
      },
      "pricingUnit": "Person",
      "postNextDay": false,
      "serviceType": "FoodAndBeverages",
      "vatType": "Normal",
      "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"
      },
      "channelCodes": [
        "Direct",
        "Ibe",
        "BookingCom",
        "ChannelManager"
      ],
      "ageCategoryId": "MUC-CHILD"
    }
  ],
  "count": 0
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.