content - Catalogue (categories & products)

The content node forms the central configuration layer for all catalogue content.
This is where the structures, fields and settings are defined that are used to manage products, categories and the associated media and attribute data. The most important areas include:

Categories
Definition of category fields, field groups and supplementary information for display in the frontend.
Products
Management of product fields, variants, product types and general product settings.
Media
Control of image and video formats, storage targets and automatic conversion processes.
Links & extensions
Assignment of custom fields via usedFields, definition of additional attributes or field groups.

The configurations contained in the content node therefore form the foundation for all catalogue-based functions of the shop — from the product display in the frontend through to data integration via the API. The individual configuration areas can be found in the Admin Interface under different services (e.g. Catalogue → Products, Catalogue → Categories, etc.). They can also be edited via the REST API configuration.

`content*` - Basic structure

The basic structure of the content node is shown below:

{
    "content": {
      "categoryFieldGroup": {...},
      "categoryField": {...},
      "contentFieldDataTypes": {...},
      "customCategoryField": {...},
      "customProductField": {...},
      "imageFormat": {...},
      "inventory": {...},
      "productAttribute": {...},
      "productFieldGroup": {...},
      "productField": {...},
      "productSettings": {...},
      "productType": {...},
      "usedFields": {...},
      "videoSettings": {...}
    }
}

Parameter descriptions

Parameter	Description
`categoryFieldGroup`	Groups category fields.
`categoryField`	Predefined standard fields for categories.
`contentFieldDataTypes`	Central type definitions for fields.
`customCategoryField`	Custom (user-defined) category fields.
`customProductField`	Custom product fields for individual data points.
`imageFormat`	Specifications for image formats / sizes.
`inventory`	Settings for stock / availability management.
`productAttribute`	Management of attributes for catalogue navigation and search.
`productFieldGroup`	Groups product fields.
`productField`	Predefined standard fields for products.
`productSettings`	Global product switches & defaults.
`productType`	Definition of product types.
`usedFields`	Field usage overview.
`videoSettings`	Specifications for video integration.

`content.categoryField` - Standard category fields

This node describes the predefined system fields of a category. Creating or deleting additional fields is not possible at this point. Depending on the field, certain properties are editable while others are managed exclusively by the system. Existing values can — provided the respective field is editable — be changed via the Admin Interface (service “Catalogue → Categories”) or via the REST API configuration. System-managed fields (e.g. timestamps) are read-only.

Example configuration `content.categoryField.descr`

{
  "label": "",
  "manualEditable": true,
  "name": "descr",
  "required": false,
  "searchable": false,
  "serviceFilter": false,
  "type": {
    "bool": null,
    "dateTime": null,
    "enumeration": null,
    "float": null,
    "image": null,
    "integer": null,
    "list": null,
    "map": null,
    "multiFormatImage": null,
    "price": null,
    "text": {
      "maxLength": 4096,
      "regex": null,
      "searchIndexBehaviour": "notAnalyzed"
    },
    "uinteger": null,
    "video": null
  }
}

In this example the descr field has been defined as the category description field that can be maintained editorially. It is not search-relevant and not a required field.

Parameter overview

Parameter	Type	Description
`dataId`	`string`	System-internal unique ID of the field. Assigned automatically and read-only (`readonly`).
`label`	`string`	Display name of the field in the Admin Interface. Improves readability and can be adapted without affecting the field’s function.
`manualEditable`	`bool`	Controls whether the value of this field may be edited manually. `true` = the field can be changed via the Admin Interface, the REST API or connected systems (e.g. ERP). `false` = the field is read-only and is set exclusively by the system (e.g. fields like `timestampCreatedAt` managed automatically by the shop).
`name`	`string`	Technical name of the field. Must be unique. Overview of the standard fields for categories: - `active` — category is used in the shop. - `descr` — description of the category. - `hidden` — category is not shown in the navigation. - `id` — unique index for the category. - `name` — name of the category. - `productAssignmentType` — method by which products are assigned to the category, e.g. via the RuleBuilder or direct assignment of product indexes. - `productRules` — rules for product assignment. - `timestampCreatedAt` — creation date of the category (Unix timestamp). - `timestampUpdatedAt` — last update of the category (Unix timestamp).
`required`	`bool`	Marks the field as required. `true` = field must be filled in. `false` = field is optional.
`searchable`	`bool`	Indicates whether the content of the field is considered in the Core search indexing. `true` = field is added to the search index. `false` = field is not considered for search. This setting has no effect on the WEBSALE \| search module. Separate adjustments in the search module itself are required there.
`type`	`oneOf`	Data type of the field. Allowed values are defined via `contentFieldDataTypes`. → see data types

`content.categoryFieldGroup` - Category field groups

The content.categoryFieldGroup node is used for logically grouping category fields within the catalogue. Since extensive shops may have a large number of individual category fields, they can be summarised here into thematic groups — for example for SEO data, images, marketing content or master data. The grouping improves the clarity in the Admin Interface and ensures that fields are presented in a structured way. A field group can reference several existing fields. New groups can currently only be created via the REST API configuration.

Example configuration `content.categoryFieldGroup.robots`

{
  "fields": [
    "customCategoryField.robotsNoIndex",
    "customCategoryField.robotsNoFollow"
  ],
  "name": "Robots"
}

Parameter overview

Parameter	Type	Description
`name`	`string`	Display name of the field group. Used for unique identification and for display in the Admin Interface.
`fields`	`multiAssoc`	Contains a list of the associated fields. Fields of type `content.categoryField` or `content.customCategoryField` can be referenced here.

`content.contentFieldDataTypes` - Data types (oneOf)

The contentFieldDataTypes type defines which data type type is assigned to a product and/or category data field. This way, WEBSALE provides consistent, validatable field definitions for categories and products (e.g. “text with max length”, “integer with min/max”, “selection list”). The oneOf principle applies: exactly one data type is active; all other type objects are not set (e.g. null or missing).

Example configuration for the data type assignment `type` of a data field

{
  ...
  "type": {
    "bool": null,
    "dateTime": null,
    "enumeration": null,
    "float": null,
    "image": null,
    "integer": null,
    "list": null,
    "map": null,
    "multiFormatImage": null,
    "price": null,
    "text": {
      "maxLength": 4096,
      "regex": null,
      "searchIndexBehaviour": "notAnalyzed"
    },
    "uinteger": null,
    "video": null
  }
  ...
}

Overview of available data types

int?, uint?, float?, string? mean optional. If the property is not set, “no additional restriction” applies.

Type name	Property (excerpt)	Description
`bool`	-	True/false. In descriptions, always state the effect for `true` / `false`.
`dateTime`	-	Timestamp / date-time (ISO-8601). Often system-managed.
`enumeration`	`options` (`list<string>`)	Selection list of fixed values (allowlist).
`float`	`min` (`float?`), `max` (`float?`)	Floating-point number (e.g. dimensions, weights).
`image`	-	Single image (format/storage defined elsewhere).
`integer`	`min` (`int?`), `max` (`int?`)	Signed integer (including negative values).
`list`	`maxEntries` (`int`)	Ordered list of homogeneous values (type from field context).
`map`	`maxEntries` (`int`)	Key-value collection (strings → values; limit size).
`multiFormatImage`	`imageFormats` (`multiAssoc → content.imageFormat`)	Image reference in multiple target formats / breakpoints.
`price`	`min` (`float?`), `max` (`float?`)	Prices / amounts (functionally like `float`; currency context separately, if necessary).
`text`	`searchIndexBehaviour` (`notAnalyzed` \| `analyzed`), `maxLength` (`int?`), `regex` (`string?`)	Free-text field. `searchIndexBehaviour` controls whether the field content is evaluated for search queries (`analyzed`/`notAnalyzed`). `maxLength` optionally limits the number of characters, `regex` enables an optional pattern check.
`uinteger`	`min` (`uint?`), `max` (`uint?`)	Unsigned integer (≥ 0).
`video`	-	Single video (reference/storage defined elsewhere).

Details & parameter tables per type

`bool`

Example

"type": { "bool": {} }

Parameter overview

Parameter	Type	Description
-	-	No additional properties. Document the effect in the field context clearly: `true` = function/property is active (e.g. “visible”, “available”). `false` = inactive.

`dateTime`

Example

"type": { "dateTime": {} }

Parameter overview

Parameter	Type	Description
-	-	No additional properties. Expected format: ISO-8601 (e.g. `2025-10-28T12:34:56Z`). Often system-managed (e.g. `timestampCreatedAt`).

`enumeration`

Example — product assignment type

"type": { "enumeration": { "options": ["manual", "rules"] } }

Parameter overview

Parameter	Type	Description
`options`	`list<string>`	List of allowed values (allowlist). Inputs must match one of the entries.

`float`

Example — weight in kg

"type": { "float": { "min": 0.0, "max": 200.0 } }

Parameter overview

Parameter	Type	Description
`min`	`float?`	Lower bound (inclusive).
`max`	`float?`	Upper bound (inclusive).

`image`

Example

"type": { "image": {} }

Parameter overview

Parameter	Type	Description
-	-	Image reference; validation, size restrictions and storage location are defined elsewhere (e.g. in `content.imageFormat`).

`integer`

Example — range −100 … 100

"type": { "integer": { "min": -100, "max": 100 } }

Parameter overview

Parameter	Type	Description
`min`	`int?`	Lower bound (inclusive).
`max`	`int?`	Upper bound (inclusive).

`list`

Example — max. 20 entries

"type": { "list": { "maxEntries": 20 } }

Parameter overview

Parameter	Type	Description
`maxEntries`	`int`	Maximum number of list entries.

`map`

Example — key-value structure for properties

"type": { "map": { "maxEntries": 50 } }

Parameter overview

Parameter	Type	Description
`maxEntries`	`int`	Maximum number of key-value pairs.

`multiFormatImage`

Example — two output formats

"type": {
  "multiFormatImage": {
    "imageFormats": ["thumb_1x1", "hero_16x9"]
  }
}

Parameter overview

Parameter	Type	Description
`imageFormats`	`multiAssoc → content.imageFormat`	Link to several defined image formats (breakpoints, variants).

`price`

Example

"type": { "price": { "min": 0.0, "max": 999999.99 } }

Parameter overview

Parameter	Type	Description
`min`	`float?`	Lower bound (inclusive).
`max`	`float?`	Upper bound (inclusive).

Note: Currency, tax context and rounding logic are configured outside of this type. See → general - General shop settings

`text`

Example — SEO text with full-text search

"type": {
  "text": {
    "searchIndexBehaviour": "analyzed",
    "maxLength": 512,
    "regex": null
  }
}

Parameter overview

Parameter	Type	Description
`searchIndexBehaviour`	`enum` (`notAnalyzed`, `analyzed`)	Controls whether and in which form the content of the field is evaluated in the search index. All contents of the field are transferred to Elasticsearch; `searchIndexBehaviour` only defines whether the field is considered in search queries (e.g. full-text search or filters) or only serves as a data store. - `analyzed` = full text (tokenised, linguistically analysed). - `notAnalyzed` = exact indexing without splitting. This setting does not apply to the WEBSALE \| search module. The technical mapping of the field in Elasticsearch is not changed by this setting.
`maxLength`	`int?`	Maximum number of characters. Without a value: no limit.
`regex`	`string?`	Optional regular expression for input validation.

`uinteger`

Example — only non-negative values

"type": { "uinteger": { "min": 0, "max": 10000 } }

Parameter overview

Parameter	Type	Description
`min`	`uint?`	Lower bound (≥ 0, inclusive).
`max`	`uint?`	Upper bound (inclusive).

`video`

Example — only non-negative values

"type": { "video": {} }

Parameter overview

Parameter	Type	Description
-	-	Video reference; format, codec and storage location are defined elsewhere.

`content.customCategoryField` - Custom category fields

The content.customCategoryField node is used to create additional, freely definable fields that can be used to describe categories in the catalogue. This allows you to attach individual information to categories — such as texts, images, SEO metadata or technical properties — which can be displayed or further processed in the frontend or in external systems (e.g. ERP, search index, PIM). These fields complement the fixed standard fields from content.categoryField and enable a flexible extension of the category structure. New fields can be created either via the Admin Interface in the service “Catalogue → Categories” or via the REST API configuration.

Example configuration `content.customCategoryField.image`

{
  "label": "Kategorie",
  "manualEditable": true,
  "name": "image",
  "required": false,
  "searchable": false,
  "serviceFilter": false,
  "type": {
    "bool": null,
    "dateTime": null,
    "enumeration": null,
    "float": null,
    "image": null,
    "integer": null,
    "list": null,
    "map": null,
    "multiFormatImage": {
      "imageFormats": [
        "content.imageFormat.category",
        "content.imageFormat.categoryWebp"
      ]
    },
    "price": null,
    "text": null,
    "uinteger": null,
    "video": null
  }
}

Parameter overview

Parameter	Type	Description
`dataId`	`string`	System-internal unique ID of the field. Generated automatically and read-only.
`label`	`string`	Display name of the field in the Admin Interface. Improves readability and can be set freely.
`manualEditable`	`bool`	Indicates whether the field value may be changed manually. `true` = field can be maintained via the Admin Interface, the REST API or ERP. `false` = field is read-only (e.g. system fields). Typical use: read-only fields such as automatically calculated values or system-set statuses.
`name`	`string`	Technical name of the field. Must be unique. Freely selectable for your own fields (e.g. `image`, `seoText`, `bannerVideo`).
`required`	`bool`	Marks the field as required. `true` = field must be filled, otherwise saving is not possible. `false` = field is optional.
`searchable`	`bool`	Controls whether the field content is included in search indexing. `true` = field is integrated into the search index. `false` = field is not considered for search. This setting does not apply to the WEBSALE \| search module.
`type`	`oneOf`	Data type of the field. The available types are defined in `contentFieldDataTypes` (e.g. `text`, `image`, `multiFormatImage`, `enumeration`, `price`). → see data types

`content.customProductField` - Custom product fields

The content.customProductField node is used to create additional, freely definable fields for products. These fields make it possible to capture individual product information that goes beyond the standard fields — such as materials, technical properties, additional texts, media content or marketing attributes. In this way, product-relevant additional data can be maintained, which is then used in the frontend, in the search index or in external systems (e.g. PIM, ERP). New fields can be created either via the Admin Interface in the service “Catalogue → Products” or via the REST API configuration.

Example configuration `content.customProductField.material`

{
  "label": "Material",
  "manualEditable": true,
  "name": "material",
  "protectedField": false,
  "required": false,
  "searchBoost": 1,
  "searchable": false,
  "serviceFilter": false,
  "type": {
    "bool": null,
    "dateTime": null,
    "enumeration": null,
    "float": null,
    "image": null,
    "integer": null,
    "list": null,
    "map": null,
    "multiFormatImage": null,
    "price": null,
    "text": {
      "maxLength": 100,
      "regex": null,
      "searchIndexBehaviour": "notAnalyzed"
    },
    "uinteger": null,
    "video": null
  },
  "variant": false
}

Parameter overview

Parameter	Type	Description
`dataId`	`string`	System-internal unique ID of the field. Generated automatically and read-only.
`label`	`string`	Display name of the field in the Admin Interface. Improves readability and can be set freely.
`manualEditable`	`bool`	Indicates whether the field may be edited manually. - `true` = field can be maintained via the Admin Interface, the REST API or ERP. - `false` = field is read-only (e.g. system fields or automatically set values).
`name`	`string`	Technical name of the field. Must be unique. Referenced for example in templates or API queries.
`protectedField`	`bool`	Controls whether the field is protected against unwanted changes. - `true` = field cannot be deleted or overwritten. - `false` = field can be adjusted or deleted at any time. Typical use: protection of system-critical fields.
`required`	`bool`	Marks the field as required. - `true` = field must be filled. - `false` = field is optional.
`searchable`	`bool`	Controls whether the field content is included in the search index. - `true` = field is considered in the search. - `false` = field is not indexed. This setting does not apply to the WEBSALE \| search module.
`searchBoost`	`int`	Weighting factor for the search. Higher values increase the influence of the field on the search ranking. Default: `1`. This setting does not apply to the WEBSALE \| search module.
`serviceFilter`	`bool`	Indicates whether the field can be used in service-based filters (e.g. API queries, dynamic product selections). - `true` = field can be used as a filter criterion. - `false` = field is not available for filters.
`type`	`oneOf`	Data type of the field. The available types are described in `contentFieldDataTypes`. → see data types
`variant`	`bool`	Indicates whether the field is considered a variant-relevant attribute. - `true` = field can have different values for product variants (e.g. colour, size). - `false` = field applies equally to all variants.

`content.imageFormat` - Image formats & conversion settings

The content.imageFormat node defines image formats and the associated conversion rules used by the system during import, automatic conversion or output of product, category or CMS images. An image format describes how an image is processed, checked, stored and named.
This includes settings for scaling, cropping, file size, DPI limits, output folders and compression quality. New image formats can be created either via the Admin Interface in the service “Templates and Content → Image converter” or via the REST API configuration.

Example configuration `content.imageFormat.normal`

{
  "autoConvert": {
    "active": false,
    "allowExternalTrigger": false,
    "hour": null,
    "sourceDirectory": "products",
    "weekday": null
  },
  "check": {
    "dpi": {
      "active": false,
      "max": 0,
      "min": 0
    },
    "fileSize": {
      "active": false,
      "max": 0,
      "maxUnit": "byte",
      "min": 0,
      "minUnit": "byte"
    },
    "inputTypeRestriction": {
      "active": false,
      "allowedTypes": null
    }
  },
  "convert": {
    "additionalArguments": "",
    "changeType": {
      "active": false,
      "type": "jpg"
    },
    "quality": {
      "active": true,
      "value": 75
    },
    "removeMetadata": true,
    "resize": {
      "active": true,
      "background": "#FFFFFF",
      "height": 660,
      "orientation": "center",
      "type": "scale",
      "width": 600
    },
    "sharpen": {
      "active": false,
      "sigma": 1
    }
  },
  "description": "normal - bild",
  "name": "Normal Produkt",
  "output": {
    "handleIfExists": "overwrite",
    "nameSuffix": "",
    "targetDirectory": "products/normal"
  },
  "type": "product"
}

This example defines a standard image format for product images of 600 × 660 px, white background, JPG output quality of 75 %, and automatic saving under products/normal.

Parameter overview

Parameter	Type	Description
`autoConvert`	`object`	Time- or trigger-based automatic conversion.
`active`	`bool`	Enables automatic conversion. - `true` = regular execution according to schedule. - `false` = only triggered manually.
`hour`	`list<uint>`	Hour values (0–23) for scheduled execution.
`sourceDirectory`	`string`	Source folder of the images to be converted.
`weekday`	`list<uint>`	List of weekdays (0–6 = Sunday–Saturday) on which conversion takes place.
`check`	`object`	Rules for input checks (file type, resolution, size).
`inputTypeRestriction`
`active`	`bool`	Enables the type check. - `true` = only defined file types are allowed. - `false` = no restriction.
`allowedTypes`	`list<string>`	List of allowed file types (e.g. `["jpg", "png", "webp"]`).
`dpi`		DPI check.
`active`	`bool`	Enables the DPI check. - `true` = files must lie within the DPI range. - `false` = no check.
`min`	`unit`	Minimum DPI.
`max`	`unit`	Maximum DPI.
`fileSize`		Size check.
`active`	`bool`	Enables the size check. - `true` = checks file size. - `false` = no check.
`min`	`float`	Lower limit for file size.
`max`	`float`	Upper limit for file size.
`minUnit`	`enum`	Unit: `byte`, `kiloByte`, `megaByte`.
`maxUnit`	`enum`	Unit: `byte`, `kiloByte`, `megaByte`.
`convert`	`object`	Definition of the image conversion (format, quality, scaling, etc.).
`changeType`		File-type conversion.
`active`	`bool`	Enables the file-type conversion. - `true` = target file is converted to the specified type. - `false` = original format is preserved.
`type`	`enum`	Target file format: `jpg`, `jpeg`, `png`, `gif`, `webp`, `avif`. Default: `jpg`.
`quality`		Quality control.
`active`	`bool`	Enables quality control. - `true` = enabled. - `false` = disabled.
`value`	`uint`	Quality value 0–100 (100 = best quality, largest file).
`resize`		Resize.
`active`	`bool`	Enables resizing. - `true` = enabled. - `false` = disabled.
`type`	`enum`	Method: `scale` (proportional), `crop` (cut), `stretch` (stretch).
`width`	`uint`	Target width in px.
`height`	`uint`	Target height in px.
`background`	`string`	Background colour in hex format (e.g. `#FFFFFF`).
`orientation`	`enum`	Positioning when cropping/placing: `center`, `north`, `south`, `east`, `west`, `northEast`, `southEast`, `northWest`, `southWest`.
`sharpen`		Sharpen filter.
`active`	`bool`	Enables sharpening. - `true` = sharpen filter is applied. - `false` = no sharpening.
`sigma`	`float`	Strength of the sharpen filter (default 1.0).
`removeMetadata`	`bool`	Removes metadata (EXIF and others). - `true` = metadata is deleted. - `false` = metadata is preserved.
`additionalArguments`	`string`	Advanced command or tool parameters (for internal converters).
`description`	`string`	Description or purpose of the format (freely selectable).
`name`	`string`	Unique name of the image format. Shown internally and in the Admin Interface.
`output`	`object`	Target path and write rules for the generated files. See the output section for details.
`targetDirectory`	`string`	Target directory for converted images (relative to the media root).
`nameSuffix`	`string`	Optional name suffix (e.g. `_thumb`, `_webp`).
`handleIfExists`	`enum`	Behaviour when a file already exists: - `overwrite` — overwrite. - `skip` — skip. - `counter` — generate a new name with a counter.
`type`	`enum`	Classification of the format. Allowed values: - `product` — product images. - `category` — category images. - `cms` — CMS or content images. - `app` — app assets. - `other` — other images. Default: `product`.

`content.inventory` - Stock management & inventory notifications

The content.inventory node controls the stock management of the shop and the communication when stock levels are low or items are sold out. It defines from which thresholds products are considered available, low or not deliverable, and which texts or email notifications are used in these cases. In addition, automatic emails to people in charge or to customers can be configured, e.g. for low stock or when an item is available again. New limits and inventory notifications can be created via the REST API configuration.

Example configuration `content.inventory`

{
  "active": true,
  "backInStock": {
    "allow": true,
    "minStockForMail": 15,
    "mailSubject": "Produkt wieder verfügbar",
    "senderAddress": "noreply@websale.de",
    "senderName": "Mustershop",
    "template": "backInStock.htm"
  },
  "greenYellowBorder": 50,
  "message": {
    "active": true,
    "fromAddress": "lagerbestand@websale.de",
    "fromName": "Lagerbestandswächter",
    "limit": 5,
    "mail": "dev-test@websale.de",
    "subject": "Lagerbestandsmitteilung",
    "template": "inventory.htm"
  },
  "reservationTime": 10,
  "reservationTimeCheckout": 30,
  "reserveRedOrdable": true,
  "splitDeliveryText": true,
  "textGreen": "Auf Lager",
  "textRed": "Ausverkauft",
  "textRedOrder": "Wird nachbestellt",
  "textYellow": "Nur noch wenige Stück auf Lager",
  "yellowRedBorder": 0
}

In this example, stock monitoring is active. As soon as the stock falls below 50 units, the yellow warning level is displayed, and from 0 units the item is considered sold out. In addition, automatic notifications to the stock manager and to customers when the item is back in stock are enabled.

Parameter overview

Parameter	Type	Description
active	`bool`	Enables stock management. - `true` = stock is monitored and shown in the frontend. - `false` = no stock check; all items are considered available.
`backInStock`	`object`	Configuration of the back-in-stock notification for customers. Controls whether customers are automatically informed as soon as a product is available again.
`allow`	`bool`	Enables the “notify when back in stock” function. - `true` = customers can subscribe to an email notification. - `false` = no notification possible.
`mailSubject`	`string`	Subject of the email (e.g. “Product available again”).
`senderAddress`	`string`	Sender address (e.g. `noreply@shop.de`).
`senderName`	`string`	Sender name (e.g. shop name).
`template`	`string`	Email template for the message (e.g. `backInStock.htm`).
`greenYellowBorder`	`uint`	Threshold (quantity) at which the display switches from green to yellow. Example: `50`.
`message`	`object`	Configuration of automatic internal inventory notifications (to merchant/admin).
`active`	`bool`	Enables internal notifications. - `true` = warning emails are sent. - `false` = no notifications possible.
`fromAddress`	`string`	Sender address for warning emails.
`fromName`	`string`	Sender name (e.g. “Stock watcher”).
`limit`	`uint`	Threshold for the inventory notification. If the stock is ≤ value, a warning email is sent.
`mail`	`string`	Recipient address for warning emails.
`template`	`string`	Email template for the notification (e.g. `inventory.htm`).
`subject`	`string`	Subject line of the email.
`reserveRedOrdable`	`bool`	Controls whether items that are sold out but still orderable can also be reserved. - `true` = reservation allowed. - `false` = reservation only for available products.
`reservationTime`	`uint`	Time span (in minutes) for which a product is reserved when added to the basket. Default: `15`
`reservationTimeCheckout`	`uint`	Time span (in minutes) for which products remain reserved during the order process. Default: `30`
`splitDeliveryText`	`bool`	Enables separate text displays for partial deliveries. - `true` = separate texts for available and back-ordered products. - `false` = uniform display.
`textGreen`	`string`	Text for the green status display (e.g. “In stock”).
`textRed`	`string`	Text for the red status display (e.g. “Sold out”).
`textRedOrder`	`string`	Text when an item is sold out but orderable on backorder (e.g. “Will be reordered”).
`textYellow`	`string`	Text for the yellow status display (e.g. “Only a few in stock”).
`yellowRedBorder`	`uint`	Threshold (quantity) at which an item is considered red (unavailable). Example: `0`.

`content.productField` - Standard product data fields

The content.productField node describes the predefined standard fields of product data. These fields form the fixed technical basis for all products and cannot be deleted or newly created. They define which properties every product has in the system — such as name, price, description or tax information. Depending on the field, you can specify whether it is manually editable, search-relevant or variant-specific. New, additional fields cannot be created through this node. The separate content.customProductField node is available for that. Existing values can — provided the respective field is editable — be changed via the Admin Interface (service “Catalogue → Products”) or via the REST API configuration. System-managed fields (e.g. timestamps) are read-only.

Example configuration `content.productField.name`

{
  "label": "",
  "manualEditable": true,
  "name": "name",
  "protectedField": false,
  "required": true,
  "searchBoost": 6,
  "searchable": true,
  "serviceFilter": true,
  "type": {
    "bool": null,
    "dateTime": null,
    "enumeration": null,
    "float": null,
    "image": null,
    "integer": null,
    "list": null,
    "map": null,
    "multiFormatImage": null,
    "price": null,
    "text": {
      "maxLength": 255,
      "regex": null,
      "searchIndexBehaviour": "analyzed"
    },
    "uinteger": null,
    "video": null
  },
  "variant": true
}

This example shows the standard name field, which is available for all products. It is search-relevant, required and variant-specific. The maximum length is 255 characters.

Parameter overview

Parameter	Type	Description
`dataId`	`string`	System-internal unique ID of the field. Assigned automatically and read-only.
`label`	`string`	Display name of the field in the Admin Interface. Can be customised freely and only serves readability.
`manualEditable`	`bool`	Indicates whether the value may be edited manually. - `true` = field can be changed via the Admin Interface, the REST API or ERP. - `false` = field is read-only and managed exclusively by the system (e.g. `timestampCreatedAt`).
`name`	`string`	Technical name of the field. Must be unique. The following standard fields are available: - `active` - `descr` - `id` - `itemNumber` - `name` - `price` - `setPrice` - `taxRateId` - `timestampCreatedAt` - `timestampUpdatedAt` These fields are fixed and not changeable. For your own fields see `content.customProductField`.
`protectedField`	`bool`	Controls whether the field is protected against changes or deletion. - `true` = field cannot be removed or overwritten. - `false` = field can be adapted (within the allowed limits).
`required`	`bool`	Indicates whether the field must be filled. - `true` = required (e.g. product name, item number). - `false` = optional field.
`searchable`	`bool`	Determines whether the field content is included in the search index. - `true` = field is considered in the search. - `false` = field is not considered for the search.
`searchBoost`	`int`	Weighting factor for the search. Higher values increase the relevance of the field in the search ranking. Default: `1`
`serviceFilter`	`bool`	Controls whether the field can be used as a filter criterion in service-based queries. - `true` = field can be used in filters and API requests. - `false` = field is not available for filters.
`type`	`oneOf`	Data type of the field. Only one type may be active. The available types are described in `contentFieldDataTypes`. → see data types
`text`
`maxLength`	`integer`	Maximum number of characters allowed in the text field.
`regex`	`string`	Optional regular expression for validation. - `null` = no check. - `"<pattern>"` = input must match the pattern.
`searchIndexBehaviour`	`string`	Controls how the text is indexed in the search. - `"analyzed"` = tokenisation / full-text search. - `"notAnalyzed"` = exact match (keyword).
`variant`	`bool`	Defines whether the field is variant-dependent. - `true` = field value can differ per variant (e.g. colour, size, price). - `false` = field applies equally to all variants of a product.

`content.productSettings` - General product settings

The content.productSettings node contains general settings that influence the behaviour of product display and tagging in the shop. Currently this section in particular contains the definition of how long a product should be marked as “new”. The settings can be created via the REST API configuration.

Example configuration `content.productSettings`

{
  "daysNewTagged": 14
}

In this example, products are tagged as new for 14 days after their creation.
After this period, the tag is removed automatically.

Parameter overview

Parameter	Type	Description
`daysNewTagged`	`int`	Specifies how many days after creation a product is considered “new”. Default: `14`. Typically used for badges or highlights in the frontend (“New”, “Just arrived”, “New in the range”).

`content.productType` - Product types

The content.productType node is used to define product types that allow you to classify different kinds of products in the system. Product types can be used to control functions, processes or display logic depending on the type — for example to distinguish between physical products, digital goods or services. Each product type has a unique ID and a name that is shown in the Admin Interface. New product types can be created via the REST API configuration.

Example configuration `content.productType.digital`

{
  "id": "digital",
  "name": "Digital"
}

In this example the product type “Digital” with the technical ID digital is defined.
It can then be used on products to distinguish digital content from physical goods, for example.

Parameter overview

Parameter	Type	Description
`id`	`string`	Technical, unique identifier of the product type (e.g. `"physical"`, `"digital"`, `"service"`). Used as a reference in product objects.
`name`	`string`	Display name of the product type in the Admin Interface. Improves readability and can be chosen freely.

`content.usedFields` - Assignment of custom fields

The content.usedFields node defines which custom fields (customCategoryField / customProductField) are actively used in the shop system for specific functional areas. This defines which custom fields are used in the frontend or in the backend for SEO, metadata, cross-selling, discounts, vouchers, etc. This means:
A reference stored here such as "metaTitle": "content.customProductField.metaTitle"
defines which custom field is actually the SEO title field for products. This way administrators and developers can flexibly integrate individual fields into the system logic without the need for fixed system fields. The assignment can be created and edited via the REST API configuration.

Example configuration `content.usedFields`

{
  "categories": {
    "alternativeTemplate": "content.customCategoryField.alternativeTemplate",
    "defaultSort": null,
    "metaDescription": "content.customCategoryField.metaDescription",
    "metaDescriptionSetManually": "content.customCategoryField.metaDescriptionSetManually",
    "metaTitle": "content.customCategoryField.metaTitle",
    "metaTitleSetManually": "content.customCategoryField.metaTitleSetManually",
    "robotsNoFollow": "content.customCategoryField.robotsNoFollow",
    "robotsNoIndex": "content.customCategoryField.robotsNoIndex"
  },
  "products": {
    "bestPrice": null,
    "commission": "content.customProductField.commission",
    "commissionTaxRate": "content.customProductField.commissionTaxRate",
    "crossSelling": "content.customProductField.crossSelling",
    "customNumber": "content.customProductField.customNumber",
    "mainCategory": "content.customProductField.mainCategory",
    "maxQuantity": null,
    "metaDescription": "content.customProductField.metaDescription",
    "metaDescriptionSetManually": "content.customProductField.metaDescriptionSetManually",
    "metaTitle": "content.customProductField.metaTitle",
    "metaTitleSetManually": "content.customProductField.metaTitleSetManually",
    "oneTimeFee": "content.customProductField.oneTimeFee",
    "oneTimeFeeTaxRate": "content.customProductField.oneTimeFeeTaxRate",
    "orderExportFields": null,
    "productDiscount": "content.customProductField.productDiscount",
    "productDiscountAbsolute": "content.customProductField.productDiscountAbsolute",
    "productType": "content.customProductField.productType",
    "ratingPoints": null,
    "robotsNoFollow": "content.customProductField.robotsNoFollow",
    "robotsNoIndex": "content.customProductField.robotsNoIndex",
    "setOrgPrice": "content.customProductField.setOrgPrice",
    "validForDiscount": "content.customProductField.validForDiscount",
    "voucherProductActive": "content.customProductField.voucherProductActive",
    "voucherProductCharge": "content.customProductField.voucherProductCharge",
    "voucherProductHtmlTemplate": "content.customProductField.voucherProductHtmlTemplate",
    "voucherProductPrice": "content.customProductField.voucherProductPrice",
    "weight": "content.customProductField.weight",
    "freeShipping": "content.customProductField.freeShipping"
  }
}

In this example, certain custom fields are explicitly assigned for SEO, prices, weight, vouchers and cross-selling. Other fields (e.g. bestPrice, defaultSort) remain unused (null).

Parameter overview

Parameter	Type	Description
`categories`	`object`	Contains all assignments that apply to category fields (e.g. SEO texts, templates, robots information).
`alternativeTemplate`	`singleAssoc` `→ content.customCategoryField`	Reference to a field that defines alternative template paths or layouts.
`defaultSort`	`singleAssoc` `→ content.customCategoryField`	Specifies the default sorting within a category for the internal search. The value must contain the name of a configured sort option from `search.productSortOption`.
`metaDescription`	`singleAssoc` `→ content.customCategoryField`	Field for the SEO description of the category.
`metaDescriptionSetManually`	`singleAssoc` `→ content.customCategoryField`	Indicates for the SEO fields whether their content is maintained manually or generated automatically. By default the SEO service populates these values automatically; in the configuration you assign once from which fields the generation takes place.
`metaTitle`	`singleAssoc` `→ content.customCategoryField`	Field for the SEO title of the category.
`metaTitleSetManually`	`singleAssoc` `→ content.customCategoryField`	SEO title control field that indicates whether the values were set manually or generated automatically.
`robotsNoFollow`	`singleAssoc` `→ content.customCategoryField`	Reference to a custom field (boolean) that controls whether search engines may follow links on this page. `true` — “`nofollow`” enabled for this page. `false` — links are indexed by search engines.
`robotsNoIndex`	`singleAssoc` `→ content.customCategoryField`	Reference to a custom field (boolean) that controls whether the page may be indexed. `true` — `noindex` (do not index page). `false` — page may be indexed.
`products`	`object`	Contains all assignments that apply to product field properties (e.g. prices, voucher information, cross-selling, SEO). Assigns custom fields that are used for products.
`bestPrice`	`singleAssoc` `→ content.customProductField`	Optional field for the lowest price option or comparison prices.
`commission`	`singleAssoc` `→ content.customProductField`	Commission fields for the sale (e.g. partner programmes).
`commissionTaxRate`	`singleAssoc` `→ content.customProductField`	Commission fields for the sale (e.g. partner programmes).
`crossSelling`	`singleAssoc` `→ content.customProductField`	Field for cross-selling or accessory references.
`customNumber`	`singleAssoc` `→ content.customProductField`	Alternative item number.
`mainCategory`	`singleAssoc` `→ content.customProductField`	Refers to a custom field that contains the main category of a product. This is used, among other things, for the SEO URL path (parent category in the link) or breadcrumbs when entering directly on the product page.
`metaDescription`	`singleAssoc` `→ content.customProductField`	SEO field for the product description.
`metaDescriptionSetManually`	`singleAssoc` `→ content.customProductField`	Control field for manually set SEO values.
`metaTitle`	`singleAssoc` `→ content.customProductField`	SEO field for the product title.
`metaTitleSetManually`	`singleAssoc` `→ content.customProductField`	Control field for manually set SEO values.
`oneTimeFee`	`singleAssoc` `→ content.customProductField`	Additional fees (e.g. service charge) and their tax information.
`oneTimeFeeTaxRate`	`singleAssoc` `→ content.customProductField`	Additional fees (e.g. service charge) and their tax information.
`orderExportFields`	`multiAssoc` `→ content.customProductField`	List of additional fields that are included in the order export.
`productDiscount`	`singleAssoc` `→ content.customProductField`	Fields for controlling discount information (percentage / absolute). This discount only applies to set products.
`productDiscountAbsolute`	`singleAssoc` `→ content.customProductField`	Fields for controlling discount information (percentage / absolute). This discount only applies to set products.
`productType`	`singleAssoc` `→ content.customProductField`	Assignment of a custom field for product type information.
`ratingPoints`	`singleAssoc` `→ content.customProductField`	Field for rating or point systems.
`robotsNoFollow`	`singleAssoc` `→ content.customProductField`	Search engine control (indexing / follow).
`robotsNoIndex`	`singleAssoc` `→ content.customProductField`	Search engine control (indexing / follow).
`validForDiscount`	`singleAssoc` `→ content.customProductField`	Controls whether a product is considered for discount campaigns.
`voucherProductActive`	`singleAssoc` `→ content.customProductField`	Controls whether a voucher (PDF) is automatically generated on purchase.
`voucherProductCharge`	`singleAssoc` `→ content.customProductField`	Reference to the batch / batch ID from which a voucher is newly created or taken from an imported pool.
`voucherProductHtmlTemplate`	`singleAssoc` `→ content.customProductField`	Name/path of the HTML template used to generate the voucher PDF.
`voucherProductPrice`	`singleAssoc` `→ content.customProductField`	If active, the voucher value matches the product price.
`weight`	`singleAssoc` `→ content.customProductField`	Field for the product weight.
`freeShipping`	`singleAssoc` `→ content.customProductField`	If only products for which this field is set to `true` are in the basket, no shipping costs are charged.

`content.videoSettings` - Video settings for products and categories

The content.videoSettings node defines the general parameters for uploading and storing video files used in product or category content.
This is where you specify which formats are allowed, how large a video file may be at maximum, and in which target directories videos are stored. These settings apply both to manual uploads in the Admin Interface and to automated data imports. New and existing settings can be edited via the Admin Interface (service “Other modules → Videos”) or via the REST API configuration.

Example configuration `content.videoSettings`

{
  "allowedFormats": [],
  "categoryTargetDirectory": "categories/video",
  "maxFileSize": 250,
  "productTargetDirectory": "products/video"
}

Parameter overview

Parameter	Type	Description
`allowedFormats`	`list<string>`	List of allowed file formats (e.g. `["mp4", "mov", "webm"]`). If the list is empty, all supported standard formats are accepted.
`categoryTargetDirectory`	`string`	Target directory for category videos. Default: `categories/video`.
`maxFileSize`	`int`	Maximum file size in megabytes (MB) allowed when uploading video files. Default: `250`.
`productTargetDirectory`	`string`	Target directory for product videos. Default: `products/video`.

checkout - Checkout process creditCheck - Credit check

⌘I

​content* - Basic structure

​Parameter descriptions

​content.categoryField - Standard category fields

​Example configuration content.categoryField.descr

​Parameter overview

​content.categoryFieldGroup - Category field groups

​Example configuration content.categoryFieldGroup.robots

​Parameter overview

​content.contentFieldDataTypes - Data types (oneOf)

​Example configuration for the data type assignment type of a data field

​Overview of available data types

​Details & parameter tables per type

​bool

​Example

​Parameter overview

​dateTime

​Example

​Parameter overview

​enumeration

​Example — product assignment type

​Parameter overview

​float

​Example — weight in kg

​Parameter overview

​image

​Example

​Parameter overview

​integer

​Example — range −100 … 100

​Parameter overview

​list

​Example — max. 20 entries

​Parameter overview

​map

​Example — key-value structure for properties

​Parameter overview

​multiFormatImage

​Example — two output formats

​Parameter overview

​price

​Example

​Parameter overview

​text

​Example — SEO text with full-text search

​Parameter overview

​uinteger

​Example — only non-negative values

​Parameter overview

​video

​Example — only non-negative values

​Parameter overview

​content.customCategoryField - Custom category fields

​Example configuration content.customCategoryField.image

​Parameter overview

​content.customProductField - Custom product fields

​Example configuration content.customProductField.material

​Parameter overview

​content.imageFormat - Image formats & conversion settings

​Example configuration content.imageFormat.normal

​Parameter overview

​content.inventory - Stock management & inventory notifications

​Example configuration content.inventory

​Parameter overview

​content.productField - Standard product data fields

​Example configuration content.productField.name

​Parameter overview

​content.productSettings - General product settings

​Example configuration content.productSettings

​Parameter overview

​content.productType - Product types

​Example configuration content.productType.digital

​Parameter overview

​content.usedFields - Assignment of custom fields

​Example configuration content.usedFields

​Parameter overview

​content.videoSettings - Video settings for products and categories

​Example configuration content.videoSettings

​Parameter overview

`content*` - Basic structure

Parameter descriptions

`content.categoryField` - Standard category fields

Example configuration `content.categoryField.descr`

Parameter overview

`content.categoryFieldGroup` - Category field groups

Example configuration `content.categoryFieldGroup.robots`

Parameter overview

`content.contentFieldDataTypes` - Data types (oneOf)

Example configuration for the data type assignment `type` of a data field

Overview of available data types

Details & parameter tables per type

`bool`

Example

Parameter overview

`dateTime`

Example

Parameter overview

`enumeration`

Example — product assignment type

Parameter overview

`float`

Example — weight in kg

Parameter overview

`image`

Example

Parameter overview

`integer`

Example — range −100 … 100

Parameter overview

`list`

Example — max. 20 entries

Parameter overview

`map`

Example — key-value structure for properties

Parameter overview

`multiFormatImage`

Example — two output formats

Parameter overview

`price`

Example

Parameter overview

`text`

Example — SEO text with full-text search

Parameter overview

`uinteger`

Example — only non-negative values

Parameter overview

`video`

Example — only non-negative values

Parameter overview

`content.customCategoryField` - Custom category fields

Example configuration `content.customCategoryField.image`

Parameter overview

`content.customProductField` - Custom product fields

Example configuration `content.customProductField.material`

Parameter overview

`content.imageFormat` - Image formats & conversion settings

Example configuration `content.imageFormat.normal`

Parameter overview

`content.inventory` - Stock management & inventory notifications

Example configuration `content.inventory`

Parameter overview

`content.productField` - Standard product data fields

Example configuration `content.productField.name`

Parameter overview

`content.productSettings` - General product settings

Example configuration `content.productSettings`

Parameter overview

`content.productType` - Product types

Example configuration `content.productType.digital`

Parameter overview

`content.usedFields` - Assignment of custom fields

Example configuration `content.usedFields`

Parameter overview

`content.videoSettings` - Video settings for products and categories

Example configuration `content.videoSettings`

Parameter overview