try out ↗

← API Index


/api/navigation6

Provides all details to render a shop navigation for the current user or visitor. So result may differ for different caller roles or caller tour assignments.

Parameters

Name Description Type
priv if 0, dont give private nodes int
raw if 1, use only artificial menu int
full if 1, collect tree (expensive) int
numLevels amount of tree levels to render (1,,3) int
naviGroup a comma-list of integers between 1 and 3 specifying the shop navigation groups to include int
hidden if 1, include hiddem elements, that are normally not offered to regular custoemers int
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
Group 4 A warehouse category. Any Item is exactly member of one category.
SubGroup 3 A warehouse category subgroup. An Item can be in multiple subgroups.
Assortment 7 An assortment is a temporary collection of items, presented and delivered as one box (aka Abobox). This record describes that box itself.
AssortmentGroup 1 Assortments are usually groups (in types or sizes)
Rubric 3 A warehouse rubric, often that is a internal price list. An Item can be in multiple rubrics.
Article 3 Text snippets
Navigation 4 Top Level Navigation entries
NavigationDetail 3 Navigation Child Levels
SubGroupMap 1 Item-to-Subgroup Mapping
RubricMap 1 Item-to-Rubric Mapping
AssortmentPosition 2 Item-to-Assortment Mapping incl. amounts
FilterGroup 1 Labels are part of a filter group (aka LabelGroup)
Label 1 Arbitrary Labels for items. Depending on the labels group a label may have a positive ('ITEM X HAS...'), a negative ('ITEM X HAS NOT..') or just a informative meaning. Groups have label assignments too; labels may be relevant to items only if they are assigned to their groups. This is important when filtering for (positive) labels, as not all items will have ubiquitous labels assigned (greens are vegetarian by all means).
PackStation 3 Goods are packed there. Some pricing calculation may depend on the packing station.

OpenAPI

See navigation6.yaml

Referenced in skills

Other versions