Amenity - SpaPortal Docs

Draft — not yet available. This is a work-in-progress contract. It may change before release; do not build against it.

An entry in the amenity dictionary: a stable code, its category, the scope it applies to (hotel, roomType, or both), a valueType, and a localized label.

Draft. One possible amenity — a dictionary entry. Returned by GET /amenities.

code

string

required

Identifier in category.slug form; use it for filtering.

Example:

"wellness.sauna"

category

string

required

The category the amenity belongs to.

Example:

"wellness"

scope

enum<string>[]

required

The levels where the amenity applies. E.g. ["hotel"], ["roomType"], or ["hotel", "roomType"].

Available options:

hotel,

roomType

Example:

["hotel", "roomType"]

valueType

enum<string>

required

Whether the amenity is a simple flag (boolean) or carries a count.

Available options:

boolean,

count

Example:

"boolean"

label

object

required

Localized display name.

Show child attributes

Example:

{
  "cs-CZ": "Sauna",
  "de": "Sauna",
  "en": "Sauna"
}