try out ↗

← API Index


/api/configuration40

Provides shop-wide configuration (ShopUrl, Config, Translations, optionally Cars). The result depends on the called shop and current locale.

Change Note: adds donation_item_ids

Parameters

Name Description Type
notrans if present, omit the Translation list (smaller payload) any value
cars if present, include the Car list (driver app data) any value
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
ShopUrl 7 Shop binding information for initial client connection
Config 2 Shop-wide configuration values (one record). Drives client behaviour for shop, driver app, and admin UIs.
Translation 1 A translation key/value pair (translation table for shop locale)
Car 1 A delivery vehicle of the shop (driver app data)

OpenAPI

See configuration40.yaml

Referenced in skills

Other versions