Service

Create a service.

Create a service.<br>You must have at least one of these scopes: 'services.create, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.services.create'.

post/rateplan/v0-nsfw/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/v0-nsfw/services
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: services.create, setup.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

codestring required

The code for the service that can be shown in reports and table views

nameobject required

The name for the service

descriptionobject required

The description for the service

propertyIdstring required

The id of the property where the item will be created

pricingUnit'Room' | 'Person' required

Defines the granularity for which this item is offered and priced.

postNextDayboolean required

Whether the service is delivered and posted on the same business date as the accommodation, or on the next day.

channelCodesstring[] nullable

The channel codes the service is sold through. When no channels are defined, the service is sold only in a package

ageCategoryIdstring nullable

The id of the age category associated with this service.

Example request

{
  "code": "BRK",
  "name": {
    "en": "Breakfast",
    "de": "Frühstück"
  },
  "description": {
    "en": "Yummy yummy breakfast",
    "de": "Leckeres Frühstück"
  },
  "propertyId": "MUC",
  "defaultGrossPrice": {
    "amount": 20,
    "currency": "EUR"
  },
  "pricingUnit": "Person",
  "postNextDay": true,
  "availability": {
    "mode": "Daily",
    "quantity": 3,
    "daysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday",
      "Sunday"
    ]
  },
  "channelCodes": [
    "Direct",
    "Ibe",
    "BookingCom",
    "ChannelManager"
  ],
  "accountingConfigs": [
    {
      "state": "Unknown",
      "revenueAllocation": [
        {
          "vatType": "Normal",
          "subAccountId": "BEV",
          "percent": 30
        },
        {
          "vatType": "Reduced",
          "subAccountId": "FOOD",
          "percent": 70
        }
      ],
      "serviceType": "FoodAndBeverages",
      "validFrom": "2021-01-01"
    }
  ],
  "ageCategoryId": "MUC-BABY"
}

Response

Service successfully created.

idstring required

The item id

Example response

{
  "id": "MUC-BRKF"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.