← API Index


Config (v1)

Shop-wide configuration values (one record). Drives client behaviour for shop, driver app, and admin UIs.

# Field Type Description
0 driver_confirm_load bool true if driver must confirm loading the car
1 driver_confirm_deliver bool true if driver must confirm each delivery
2 driver_layout string driver app layout variant (vertical:v, horizontal:h, automatic:a)
3 currency string currency symbol (e.g. €)
4 min_order_value double shop-wide minimum order value (only fallback)
5 delivery_cost_limit double order value above which delivery cost no longer applies
6 vat string VAT rates for the shop locale (configured per country)
7 driver_geo_alarm int geofence radius (meters) for driver position alarm
8 shop_start string shop start page identifier (per country)
9 driver_item_name bool true if driver app shows item names
10 paypal_id int paypal mode: 0=disabled, 1=enabled (but prefer Sepa if exists), 2=always-paypal (even if Sepa exists); negative if test environment
11 banking int bank info policy, from shop config banking (off/on/req): 0=off, 1=on (bank data optional), 2=req (bank data required). An empty/unknown config value maps to 1
12 agb_link string URL to terms-and-conditions page (per language)
13 specials_name string display name for specials/offers section (per language)
14 saleout_min double minimum value (in currency) for saleout items
15 paypal_over double paypal overpay percentage (if > 0)
16 paypal_mode int paypal mode: 0=refunded, 1=other
17 inv_allowed int invoice payment allowed (0=no, 1=yes, 2=companies, 3=new customers, 4=new businesses, 5=existing customers)
18 driver_msg string message to show in driver app
19 convtrck string conversion tracking snippet/identifier
20 def_country string default country code (e.g. 'de')
21 d_address string delivery address handling: on/off
22 bank_form string bank form variant
23 glid string google login id (oAuth client id)
24 first_cat string first category id to display (negative values reference rubrics)
25 reg_relaxed string 1 if registration is in relaxed mode (no bank required)
26 paypal_over_a double paypal overpay fixed amount (alternative to paypal_over), if > 0
27 dse_link string URL to privacy policy page (per language)
28 has_voucher_or_coupon bool true if shop has any voucher, coupon or referral code feature enabled. To enable input in cart forms.
29 shop_version_2018_or_later bool true if shop runs a build later than 2018-09-20 (feature gate)
30 ptracking string tracking pixel snippet/identifier. Can be a code snippet.
31 min_order_strict int days threshold for strict minimum-order checking
32 articles_list string comma-separated list of available article (id:shortname, comma delimited)
33 allow_multiple_per_tour bool true if customers may have multiple deliveries per tour
34 delivery_cost double default delivery cost (system fallback, if no value is available from tour or address)
35 new_customer_id int temporary id used for new (not-yet-registered) customers
36 item_notes bool true if customers may attach notes to order positions
37 driver_cid bool true if driver app exposes customer id
38 abo bool true if subscriptions (abo) are enabled
39 hidden_abo bool true if hidden assortments (abo) are enabled
40 starttrck string start-page tracking snippet/identifier
41 hide_filter bool true if shop filters are hidden by default
42 tour_notes bool true if tour-level notes are enabled
43 nl_page string newsletter signup page url/identifier
44 driver_box_warn_cnt int warning threshold for driver box count
45 driver_refund_opts string comma-separated driver refund options
46 driver_mileage string driver mileage tracking mode
47 offer_depot bool true if depot delivery is offered to customers
48 allow_matching_tours bool true if multiple matching tours per address are allowed (mode 'OnOne')
49 welcome_back string welcome-back message snippet shown to returning customers
50 giban bool true if a generic IBAN is configured for the shop (to enable visualizations as pre pay option)
51 abo_period int default subscription period in weeks
52 min_order_val_pack double Exceeding this total order value skips any packstation specific limits.
53 pack_over int If > 0, it defines a packing station that superseedes any limits of other packstations
54 quotes bool true if Region and Bio-Quotes are to be shown
55 fav_all bool true if favourites of other customers are shown (Top Picks)
56 req_box bool true if a delivery box is required to place an order
57 auto_optin bool true if newsletter auto opt-in is enabled (no double opt-in)
58 allow_callback bool true if customers may request a callback
59 callback_times string JSON array of available callback time slots, as String
60 driver_fwlan bool true if driver app uses follow-up WLAN sync mode
61 driver_frelease bool true if drivers may release images
62 wait_page string Waiting list for customers, if no tour can be assigned upon an registration attempt
63 use_min_as_default bool true if items.amountmin is to be used as default order amount on a first click
64 cash_allowed int cash payment allowed (0=no, 1=yes, 2=companies, 3=new customers, 4=new businesses, 5=existing customers)
65 coannounce string defines how an order is shown in the reminder emails (small:order sumary, full:all positions in detail, off:no details, shall force the customer to look it up online
66 mobile bool true if mobile messageing is enable in the shop
67 esstbio string esst-bio integration mode (listed, off, push:listed, push messages are neabled)
68 lostcart string lost-cart handling mode: off,simulate,on,onlymail,onlymobile
69 driver_delivery_mail bool delivery confirmation as email enabled
70 driver_delivery_sms bool delivery confirmation as mobile enabled
71 oreminder string order reminder configuration: off,on,onlymail,onlymobile
72 delivery_calculation string delivery cost calculation mode/identifier; deliveryCalcClassic:delivery costs ar partial, deliveryCalcFixed
73 show_item_season string controls how seasonal items are highlighted in the shop: moreThan10:10 days,moreThan7:7 days,always:0
74 dse_required bool true if customers must explicitly accept the privacy policy (DSE)
75 show_credit_in_cart bool true if customer credit balance shall be displayed in the cart
76 driver_request_temperature bool true if driver app prompts for delivery temperature
77 available_drop_off_locations string comma-separated list of available drop-off locations (whitespace-normalized)
78 zero_alternative_text string text shown when stock/quantity is zero (translated/encoded)
79 new_customer_item int id of an item to be auto-added for new customers (0 if disabled)
80 driver_boxacc bool true if driver app handles box accounting
81 driver_negdeposit bool true if driver app permits negative deposit/refund balances
82 imgproxy string image proxy base URL (empty if disabled)
83 show_sort_control bool true if the shop UI exposes a sort controls to the customer in item lists
84 app_onboarding_enabled bool true if (shop-)app onboarding flow is enabled
85 prepaid_enabled bool true if prepayment is enabled in cart
86 prepaidinfo string info text/snippet when displaying prepay advice
87 prepaid_paypal_enabled bool true if prepay-via-PayPal link is enabled
88 prepaid_paypal_info string info text/snippet shown for prepaid PayPal Link (encoded)
89 allow_tour_note bool driver may send notes to the office

Used in endpoints

Other versions