URL Parameters
All available parameters for calling the visual interface (/planning).
Note
Both boolean values (true/false) and numeric values (1/0) are supported. Exception: buttongeneratereinitid and buttongenerateparentnode expect true.
Authentication
| Parameter | Required | Description |
|---|---|---|
token | Optional | Security key. Without token, the last one passed is used; if there is none, the login page opens (in an iFrame, in a new tab). See Authentication. Example: &token={08646A79-2763-4A7C-B6C1-51E05C7F3C76} |
Display
| Parameter | Default | Description |
|---|---|---|
showlogoutbtn | true | Logout button visible |
showlanguageselection | true | Language selection visible |
showprice | true | Show the price. The value is also passed to the server. If a server profile is loaded, its show_price applies and the URL parameter is ignored. |
showdefaultpreviewimage | true | Show preview images of property values; false hides them |
hidegroundplane | false | Hide the floor plane in the 3D scene; only its light grey outline is visible |
hidedisabledproperties | false | Hide non-editable properties |
darkmode | – | true = dark, false = light design; without the parameter, the last chosen setting applies |
showmenubar | true | Show the menu bar at the top; with false, the 3D view and information panel fill the full height |
Language & currency
| Parameter | Description |
|---|---|
lang | Language of the interface and data: de, en, fr, nl, pl or cz. Without the parameter, the last language chosen applies, otherwise German. |
langalt | Alternative language if lang texts are missing |
currency | Currency according to ISO 4217 (e.g. EUR). No conversion — display only. |
Prices
| Parameter | Description |
|---|---|
vkrabatt | Sales price discount in percent. The original price is struck through and the new net sales price is shown. Example: &vkrabatt=10 |
mwst | VAT in percent. The gross price is shown in addition (with a discount, based on the discounted price). Example: &mwst=19 |
3D scene
| Parameter | Default | Description |
|---|---|---|
rotatescene | false | Automatic rotation of the object around its center |
disablepan | false | Disable the pan function (right mouse button) |
minzoom | 0 | Closest distance of the camera to the article in meters; decimals allowed (e.g. 1.5) |
Catalog
| Parameter | Description |
|---|---|
opencatalogue | Open the catalog automatically when the page loads |
disablecatalogue | Disable the catalog — the user can only see the loaded article. Breadcrumbs are hidden as well. |
parentnode | Start folder of the catalog (nodeid). Hides the breadcrumbs. Takes precedence over locally persisted catalog state on the initial load. Empty (parentnode=) starts at the top level without binding the catalog: the breadcrumbs stay visible. |
Loading articles
| Parameter | Description |
|---|---|
manufacturer | Manufacturer code (e.g. from a catalog call) |
currentmanufacturer | Manufacturer for logo and contact details. Takes precedence over the manufacturer derived from parentnode (first segment of the node path). |
program | Series code |
basearticlenumber | Base article number |
ocdreinit | Reinit string for commercial data (frontend use) |
permanentid | Previously generated PermanentID for a meta configuration |
id | ID from /ofml/reinit for reconfiguring a shopping cart article, see Shopping Cart Integration. Takes precedence over permanentid. |
Shopping cart & wishlist
| Parameter | Description |
|---|---|
urlwarenkorb | URL of the external shopping cart (without http:///https://). Shows the "Add to shopping cart" button. Example: www.meinserver.de/warenkorb/kundenid |
urlmerkzettel | URL of the wishlist. Shows the "Add to wishlist" button. |
warenkorbbtntext | Custom text for the shopping cart button. Only useful with urlwarenkorb. |
merkzettelbtntext | Custom text for the wishlist button. Only useful with urlmerkzettel. If urlwarenkorb is set as well, the wishlist appears as an icon button and the text as its tooltip. |
obxexport | Shows the "OBX exchange" section in the Download tab (export/import of .obx files) and allows dragging an .obx file onto the WebKatalog. See OBX. Default: false. |
Layout variants
| Parameter | Default | Description |
|---|---|---|
pev | compact | Property Editor layout: full or compact |
adv | modular | Article drawer variant: single or modular |
Admin & debug
| Parameter | Description |
|---|---|
devmode | Enable developer mode. Shows debug info and performance overlays. |
cache | Enable/disable client-side caching (default: true). With false, no data is cached in localStorage. |
buttongeneratereinitid | Show the button for generating PermanentIDs (admin) |
buttongenerateparentnode | Shows a button that displays the current catalog path (nodeid for parentnode) in a dialog (admin) |