← API Index


/api/

Methods

Endpoint Description
/api/assortment13 Content of a give Assortment, Assortment items as Item and CartItem lists with tour limits, xunits and related items
/api/bestsellers1 The shop's bestsellers of the last weeks (Was andere bestellen), best first. The same for every visitor, also guests; updated regularly.
/api/bind5 Shop binding information for initial client connection
/api/bind6 Shop binding information for initial client connection
/api/chat1 Send a chat query and receive a (bot) response. The Bot configuration is part of the backend setup.
/api/chatscript1 Retrieve the chat conversation transcript. There is always only one active chat conversation per user.
/api/configuration39 Provides shop-wide configuration (ShopUrl, Config, Translations, optionally Cars). The result depends on the called shop and current locale.
/api/configuration40 Provides shop-wide configuration (ShopUrl, Config, Translations, optionally Cars). The result depends on the called shop and current locale.
/api/dates13 Provides delivery dates, pauses, subscriptions, favourites, aux dates, and deselected items/groups for the caller (an authenticated or guest user).
/api/findtour2 The delivery tours that can serve a given location, with the next delivery dates of each. Used to offer a new customer the tours and dates reachable at their address. Returns empty lists when nothing serves the location.
/api/findtour3 The delivery tours that can serve a given location, with the next delivery dates of each. Used to offer a new customer the tours and dates reachable at their address. Returns empty lists when nothing serves the location.
/api/geocode1 Address check / geocoding with results from cache and providers
/api/getdepots1 The public depots (pickup stations) that can serve a given location, each with its address, its tour and the next delivery date of that tour. Returns empty lists when the shop does not offer depots.
/api/item1 Provides full detail for a single item including alternative units, tour-specific order limits, and related items (recipes/packages), if this data exists.
/api/items20 provide items of a category and related data
/api/items21 provide items of a category and related data
/api/items22 provide items of a category and related data
/api/items23 provide items of a category and related data, incl. deposit (Pfand) info
/api/logon4 Authenticate a user and return session and cache information
/api/logout2 End the current session (logout), optionally unregister the customer.
/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.
/api/navigation7 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.
/api/order27 Single order with positions, subscriptions, and optional item data
/api/order28 Single order with positions, subscriptions, and optional item data
/api/order29 Single order with positions (incl. deposit/Pfand snapshot), subscriptions, and optional item data
/api/orders1 Order list with delivery and status information. Use pd/ad/tours or packday/tid parameters
/api/orders2 Order list with delivery and status information. Use pd/ad/tours or packday/tid parameters
/api/orders3 Order list with delivery and status information. Use pd/ad/tours or packday/tid parameters
/api/orgs1 List of all known certification organizations (Verbände). Each entry carries hasIcon (whether a logo exists), name, isBio (EU-certified organic association), and url (website).
/api/packstations1 List of all packing stations.
/api/plantour3 Optimise the order of the stops of a tour. Requires the geo tool permission or wpass, and the tourapi option.
/api/plantour4 Optimise the order of the stops of a tour, or calculate a given sequence. Requires the geo tool permission or wpass, and the tourapi option.
/api/refund1 List of refund item definitions (e.g. deposit/bottle refunds). Items may be bound to one of these.
/api/search2 Item search: the items matching a search term, with their accompanying data (alternative units, tour limits). Same output as /api/items23.
/api/tlnavi1 Limited Navigation Info for a quick top level rendering
/api/tour31 Driver tour plan for one tour: tour header, the delivery ride (DDate), all deliveries (stops) with box and prediction info, per-customer box return info, and the delivery addresses. Requires operator or superuser permissions; returns empty lists otherwise.
/api/tour32 Driver tour plan for one tour: tour header, the delivery ride (DDate), all deliveries (stops) with box and prediction info, per-customer box return info, the delivery addresses and the available e-car charge points. Requires operator or superuser permissions; returns empty lists otherwise.
/api/tour33 Driver tour plan for one tour: tour header, the delivery ride (DDate), all deliveries (stops) with box and prediction info, per-customer box return info, the delivery addresses and the available e-car charge points. Requires operator or superuser permissions; returns empty lists otherwise.
/api/tour34 Driver tour plan for one tour: tour header, the delivery ride (DDate), all deliveries (stops) with box and prediction info, per-customer box return info, the delivery addresses and the available e-car charge points. Requires operator or superuser permissions; returns empty lists otherwise.
/api/tours10 Tour overview for operators: all tours (incl. hidden) with geo polygons and address counts, plus the recent and upcoming delivery rides with customer/order counts. Requires operator or superuser permissions; returns empty lists otherwise.
/api/tours11 Tour overview for operators: all tours (incl. hidden) with geo polygons and address counts, plus the recent and upcoming delivery rides with customer/order counts. Requires operator or superuser permissions; returns empty lists otherwise.
/api/tours9 Tour overview for operators: all tours (incl. hidden) with geo polygons and address counts, plus the recent and upcoming delivery rides with customer/order counts. Requires operator or superuser permissions; returns empty lists otherwise.
/api/user26 Authenticated user profile with tours, addresses, boxes, discounts, vouchers and bonus data. Data is ultimately updated only upon login.
/api/user27 Authenticated user profile with tours, addresses, boxes, discounts, vouchers and bonus data. Data is ultimately updated only upon login.
/api/user28 Authenticated user profile with tours, addresses, boxes, discounts, vouchers and bonus data.
/api/user29 Authenticated user profile with tours, addresses, boxes, discounts, vouchers and bonus data. Data is ultimately updated only upon login.
/api/user30 Authenticated user profile with tours, addresses, boxes, discounts, vouchers and bonus data. Data is ultimately updated only upon login.
/api/user31 Authenticated user profile with tours, addresses, boxes, discounts, vouchers and bonus data. Data is ultimately updated only upon login.
/api/user32 Authenticated user profile with tours, addresses, boxes, discounts, vouchers and bonus data. Data is ultimately updated only upon login.
/api/user33 Authenticated user profile with tours, addresses, boxes, discounts, vouchers and bonus data. Data is ultimately updated only upon login.
/api/user34 Authenticated user profile with tours, addresses, boxes, discounts, vouchers, bonus data and outstanding payments. Data is ultimately updated only upon login, except the outstanding payments, which are read on every call.
/api/user35 Authenticated user profile with tours, addresses, boxes, discounts, vouchers, bonus data and outstanding payments. Data is ultimately updated only upon login, except the outstanding payments, which are read on every call.
/api/user36 Authenticated user profile with tours, addresses, boxes, discounts, vouchers, bonus data and outstanding payments. Data is ultimately updated only upon login, except the outstanding payments, which are read on every call.
/api/user37 Authenticated user profile with tours, addresses, boxes, discounts, vouchers, bonus data and outstanding payments. Data is ultimately updated only upon login, except the outstanding payments, which are read on every call.
/api/user38 Authenticated user profile with tours, addresses, boxes, discounts, vouchers, bonus data and outstanding payments. Data is ultimately updated only upon login, except the outstanding payments, which are read on every call.

Subdirectories