Oekobox-Online API Documentation
CURRENTLY UNDER CONSTRUCTION, THIS IS A TEMPORARY LOCATION !
Endpoints for various actions typically return lists of flat versioned objects ('ResponseTypes').
- Endpoints and response objects are versioned. Every released version stays stable and available forever. Use the highest postfix for the newest endpoint version.
- Different endpoints may produce the same return object types, even with different versions.
- If you see a 'try'-Hint, you may exercise the endpoint. Start with logon to have a valid session. You need to use these pages under a valid tenant domain.
- Skills explain non-obvious things and give tips on how to use the API
- Use our Components to build a shop quickly, without reimplementing millions of details. You may adjust their style with CSS.
Jump to: Endpoints · Response Types · Skills · JS Components · Recent Changes
Endpoints (127)
Browse by subdirectory: admin/ · admin/kanban/ · admin/kanban/detail/ · admin/kanban/state/ · admin/kanban/ticket/ · admin/message/ · admin/message/series/ · admin/tour/ · admin/voucher/ · client/ · client/wero/ · driver/ · stats/ · system/ · system/bonus/ · system/pushhook/ · system/webhook/ · wero/
| Endpoint | Description |
|---|---|
| /api/admin/kanban/add | Creates a new ticket board |
| /api/admin/kanban/delete | Deletes a ticket board including all its states, their tickets and details |
| /api/admin/kanban/detail/add | Adds a detail/note to a ticket |
| /api/admin/kanban/detail/delete | Deletes a ticket detail entry |
| /api/admin/kanban/list | Lists all ticket boards with state counts |
| /api/admin/kanban/state/add | Adds a ticket state to a board |
| /api/admin/kanban/state/delete | Deletes a ticket state and all tickets (including archived) using it on this board |
| /api/admin/kanban/state/list | Lists ticket states for a board with ticket counts |
| /api/admin/kanban/state/update | Updates color and sorting of a ticket state, identified by name and board_id |
| /api/admin/kanban/ticket | Returns a single ticket with its details and attachments |
| /api/admin/kanban/ticket/delete | Deletes a ticket and all its details |
| /api/admin/kanban/ticket/new | Creates a new ticket on a board and returns it |
| /api/admin/kanban/ticket/update | Partially updates a ticket. Omitted fields keep their current value. |
| /api/admin/kanban/ticketlist | Lists tickets and states for a board. Supports filtering by state, search text and archived flag. |
| /api/admin/kanban/update | Updates a ticket board (rename, color, sorting). Omitted fields keep their current value. |
| /api/admin/message/series | Queue a message series: one message to many customers on one channel (mail, push, sms, or auto = best channel per recipient). Admin only. Returns immediately with the series reference; delivery runs in the background (throttled, optionally scheduled), the text is personalized per recipient (%Variable% placeholders), links are tracked, and the series shows up in stats/mailcampaigns1 like a Serienmail. Recipients: exactly one of agid, all or cids. A mail can name its template; mails with attachments keep coming from PCG. |
| /api/admin/message/series/cancel | Remove the not-yet-sent messages of a message series from the queue (a series queued via message/series, pushactiongroup, or by PCG). Admin only, idempotent. Messages already handed to a provider are not affected; the series statistics keep what was sent. |
| /api/admin/pushactiongroup | Queue one push notification for every current member of an action group (Aktionsgruppe). Admin only. Returns immediately: the pushes are queued as a message series and delivered in the background (throttled), through the tenant's regular push delivery or its external push hook. Follow the result via stats/mailcampaigns1 with the returned serieref, or cancel the rest via message/series/cancel. Use dryrun=1 first to see how many members would be addressed. |
| /api/admin/setbonus | Set bonus points for a customer. Admin only. Replaces the current point balance. |
| /api/admin/tour/setpolygon | Sets the delivery area polygon of a tour from a KML document, overriding any polygon previously stored for that tour (including one provided by the backend). Only the first polygon of the KML document is used, with its holes. An empty kml parameter clears the stored polygon. The polygon becomes visible in /api/tours9 immediately. Requires operator or superuser permissions. |
| /api/admin/voucher/create2 | Creates individual voucher codes for a voucher item and returns them. The lifetime of the codes is taken from validuntil, else from days, else from the item (items.voucherdays, 0 = unlimited). If customers are given, the codes are bound to them: amount codes per customer; a customer who still has unused codes for the item keeps those, only their lifetime is renewed, and they are returned instead. Requires the permission to create vouchers. |
| /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/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/client/actiongroup | Join or leave an Aktionsgruppe (action group) as the authenticated customer. Admins may act on behalf of another customer via the 'cid' parameter. |
| /api/client/addfavourite1 | Add an item or entity to the user's favourites (shelf) |
| /api/client/addpause2 | Add a delivery pause for the authenticated user |
| /api/client/addsubscription2 | Create a new item or assortment subscription |
| /api/client/applybonus | Apply for a bonus campaign. The customer opts into a campaign that requires explicit application. |
| /api/client/cancelorder7 | Cancel an existing order |
| /api/client/changeorder8 | Modify an existing order |
| /api/client/changesubscription2 | Modify an existing subscription |
| /api/client/claimbonus | Claim a bonus reward. Deducts the required points from the customer's balance. |
| /api/client/delivery3 | Estimated delivery state for the caller's tour stops, plus the driver's current position. |
| /api/client/dropdeselected1 | Remove a deselected item or group from the customer's exclusion list |
| /api/client/dropfavourite1 | Remove an item or entity from the user's favourites (shelf) |
| /api/client/droppause2 | Remove a delivery pause |
| /api/client/droppushtoken | Remove a previously registered FCM device token; works for guests (no session) as well as logged-on customers |
| /api/client/dropsubscription2 | Delete an existing subscription |
| /api/client/frequentitems1 | The items most often in the logged-on customer's orders (Oft in deinen Bestellungen), most often first. Items that are not offered are left out. |
| /api/client/log1 | Write a customer-related entry to the shop event log. The entry is attached to a customer record and shows up in the customer's activity log (also visible to the backend). |
| /api/client/newclient1 | Create a new user account. Returns registration result and user profile on success. |
| /api/client/neworder8 | Create a new order for a delivery date. If the shop allows only one order per delivery (setup allowmultiorders off, the default) and the customer already has an open order on that date and tour, the request is treated as a change of that order: the posted cart becomes its content and its id is returned, no second order is created (locked -> the one order of that date is in processing). Clients should normally send changeorder for a date that already has an order (see ShopDate.orderId) |
| /api/client/nudge1 | Switch the cart suggestion (Nicht vergessen) off for the logged-on customer, or on again. The setting is kept in the customer profile, see nonudge in the user data. |
| /api/client/password2 | Request a new password mail for an existing user. Looks up the account by email (and optional /cid suffix) or by numeric id, generates a password if none is set, and sends it to the user's mail address. |
| /api/client/ppauthorize1 | Initiate a PayPal payment authorization. On success returns the PayPal token (orderID for the SDK). |
| /api/client/ppresponse1 | Finalize a PayPal payment: shop calls this when the customer returns from the PayPal flow. Confirms or cancels the previously authorized payment. |
| /api/client/pushdelivered | Report that an FCM push was delivered to this device; no session required |
| /api/client/pushopened | Report that the user tapped an FCM push notification; no session required |
| /api/client/registerpushtoken | Register an FCM device token; works for guests (no session) as well as logged-on customers |
| /api/client/regorder2 | Guest registration including an order: create a new customer account and place an order in a single call. Combines the NewAddress and StoreOrder actions; logs out at the end unless no_logout=1 is set. Use dcity/dzi/dstreet for the delivery address. |
| /api/client/reorderhints1 | Items the logged-on customer buys regularly and may want to order for the selected delivery (Nicht vergessen), most due first. Items already in that order, unavailable ones and those that come with a subscription or box are left out. |
| /api/client/savecart1 | Save the current cart server-side. Always updates the session cart from the given positions (backup of an unsubmitted cart). If cart autosave is active for the customer (shop setting cartAutosave plus customer opt-in), the cart is additionally written into an order: a new order on the first storable save, the same order on every following save - its id is returned as oid. Order mails of such autosaved orders are deferred to the end of the session. (JS) clients can call this periodically after cart changes; a later NewOrder/ChangeOrder for the same cart is routed to that order server-side, never to a duplicate. |
| /api/client/setprofile11 | Update user profile/address and return the updated user data with tours, addresses, boxes, discounts, vouchers and bonus. |
| /api/client/settour5 | Set the active delivery date and tour for the current shopping session |
| /api/client/state1 | Polling endpoint: client passes a known order id (with its last-changed timestamp) OR a delivery date and tour id, server tells whether the order / date is still actionable. |
| /api/client/wero/transaction1 | Initiate a Wero (VR Payment) payment. On success returns the bank's landing page the customer must be redirected to for consent. |
| /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/driver/assign1 | Assign a reusable box to a customer. Box-level rejections (box_not_existing, box_locked) are returned as result codes with HTTP 200, see the DriverAssignResult type. |
| /api/driver/boxexchange1 | Report the number of boxes delivered to and returned by a customer. At least one of delivered/returned must be non-zero. |
| /api/driver/bpos1 | Store the geo position where the box is placed for a customer address. Requires power driver permission. |
| /api/driver/cadr1 | Correct the delivery geo position (park position) of a customer address. Requires power driver permission. |
| /api/driver/deassign1 | Remove a box assignment from a customer. The box must currently be assigned to the given cid. Box-level rejections (box_not_existing, unassigned, wrong_cid) are returned as result codes with HTTP 200, see the DriverAssignResult type. |
| /api/driver/delpause | Delete a previously recorded driver pause, returning a PauseResult with id=0 to confirm deletion. The pauseid alone is sufficient - the tourid used as consistency guard in the delete is resolved from the pause row itself. ddate or tourid may optionally be supplied (PCG call shape); they are then cross-checked against the pause row and a mismatch is rejected. |
| /api/driver/dlvr1 | Mark an order as delivered. Logs the delivery, updates the tour delivery state and may trigger delivery notifications (mail, SMS, push) to the customer and to customers whose delivery is announced as upcoming. |
| /api/driver/info1 | Send an arbitrary driver info message to the office. The message is logged for the given customer or, when no cid is given, for the driver itself. |
| /api/driver/locate1 | Last known driver positions. A driver gets the latest position of every active tour; a regular authenticated customer gets the single position of the tour currently delivering to them. |
| /api/driver/pauses | List active driver pauses for a tour and date |
| /api/driver/refund1 | Hand over one or more refund bookings collected by the driver. The refunded lines are passed positionally: for each value of the repeatable position parameter n, the item is given as pid-n and the amount as amount-n. Returns result refundok on success. |
| /api/driver/reorder1 | Hand over a re-ordered tour position sequence. Each entry of pos is a triple of customer ids [before, moved, after]; a missing first or last element means the customer was moved to the very start or end of the tour. |
| /api/driver/setpause1 | Record a planned or actual driver pause, returning the stored pause with its computed start and end times. Pass either length (minutes) or endtime - exactly one is required. To set a recurring pause that applies to every run of a tour (e.g. a standing lunch pause set by PCG), pass ddate=0 and include tourid; for a date-specific pause, pass the ddates.id as ddate. |
| /api/driver/setstart1 | Set the start time of a tour. With a ddate the start applies to that specific tour run; with only a tourid the general start time of the tour is set. |
| /api/driver/state1 | Report a driver tour state change (e.g. starttour) with optional car plate, temperature and mileage. The state is logged against the tour resolved from ddate. |
| /api/driver/trck1 | Upload driver GPS tracking data, one position fix per line. Each line is lat,lng,accuracy,timestamp with an optional fifth mileage (km) value. The tour is taken from tourid/tid or, if absent, from the current session. |
| /api/driver/udlvr1 | Revoke a previously reported delivery of an order (undo of dlvr). |
| /api/driver/urefund1 | Revoke previously handed over refund bookings (mistake correction); the amounts are booked negatively. Takes the same positional parameters as refund1 and also returns result refundok on success. |
| /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/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/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/order29 | Single order with positions (incl. deposit/Pfand snapshot), subscriptions, and optional item data |
| /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/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/stats/campaign1 | Per-week statistics of a mail campaign (sends, opens, clicks, bounces and rates). Admin access only. Also reachable as /api/stats/campaign1/ |
| /api/stats/events1 | Per-day (or per-hour) counts of a statistics event. Admin access only. Use stats/eventtypes1 to discover the available event codes. |
| /api/stats/eventtypes1 | List all statistics event types (code, key, localized description). The codes are valid eventid inputs for stats/events1. perGroup marks the events that are also counted per action group (stats/events1 with agid). |
| /api/stats/links1 | Per-day click counts for tracked shop links. Admin access only. |
| /api/stats/mailcampaigns1 | List all message series (Serienmails, push and SMS series) with their delivery and engagement statistics, newest first (up to 150). Admin access only. A series with duration = 0 is still running. Campaign series (campaignid > 0) link to per-week details via stats/campaign1. |
| /api/stats/mailopens | Mail opens over time after a sendout (per hour or per day), for the opens chart of a Serienmail. Admin access only. Get the serieref values from stats/mailcampaigns. |
| /api/stats/push1 | Recent push notification sends, one row per delivery channel (onesignal, fcm, external), newest first. Admin access or API-role account. Delivered/opened counts only carry information when analytics_capable is non-zero. |
| /api/stats/pushdevices1 | Devices registered for platform-side push (FCM), grouped by platform and app product, with how many are attached to a customer and how many report delivery/open analytics. Admin access or API-role account. |
| /api/stats/pushsummary1 | Push notification sends aggregated per day and delivery channel: sends, failed, recipients, accepted, delivered, opened. Newest day first. Admin access or API-role account. |
| /api/system/actiongroups | Lists the action groups (aka Aktionsgruppen) of this shop, with a member flag indicating whether the authenticated customer belongs to each group. Customers and guests get the customer-editable groups (edittype=2) only; backend-only (0) and shop-only (1) groups are filtered out. Admins and callers with the statistics permission get all groups, each with its memberCount. |
| /api/system/bonus/list2 | Lists all available bonus campaigns, with the campaign's info link (BonusCampaign v2). When not authenticated, only campaigns are shown that are not limited by customer group. When authenticated, only available campaigns are shown |
| /api/system/config1 | Returns the value of a single public shop configuration key. |
| /api/system/eventtypes | Lists all loggable event/action codes, for use in a webhook's events filter (see api/system/webhook/create). |
| /api/system/files | Lists all files in the filestore |
| /api/system/geo | Geo points (lat/lng + marker meta data) for the geo tools: addresses of tours, delivery dates or id lists, customers, driver tracks or registration misses. Exactly one selection mode is used, precedence: miss, cid, aid, did, tid+tf, tid. Replaces the legacy geo/data.jsp. |
| /api/system/goodbye_reasons | Lists all goodbye reasons (why did the customer leave) |
| /api/system/log1 | Write a system-related (not customer-related) entry to the shop event log. Useful for external integrations to leave traces (e.g. sync runs, device events). |
| /api/system/msg1 | Queue a message for the PCG backend. Primarily for tools within the PCG ecosystem: the message is stored in an internal queue table and picked up by the backend. |
| /api/system/ppscript1 | Returns the URL of the PayPal SDK script for this shop. Requires a valid API key (X-OO-APIKEY). |
| /api/system/pushhook/create | Create (or replace) the push hook: once a URL is set, push notifications matching the type filter are handed to that external provider instead of being sent by the platform. Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS). |
| /api/system/pushhook/drop | Drop (clear) the push hook so push notifications are sent by the platform again. Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS). |
| /api/system/pushhook/list | Shows the push hook configuration (one entry; configured=false if no external push provider is set). Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS). |
| /api/system/register_reasons | Lists all register reasons (how did the customer find us) |
| /api/system/setconfig | Sets one configuration value. The value is type-checked and validated like on the admin settings pages, the change shows up in the setup history. Requires the settings permission (UPDATE_SETTINGS_ACTION_ACCESS). Send it as POST: a value in the query string ends up in request logs. |
| /api/system/variables | Lists all personalization variables (%Variable%) that can be used in mails, SMS and content texts, with the groups they belong to. Aliases and descriptions come in the requested language; an alias that does not exist in that language falls back to the default (German) form, which resolves as well. |
| /api/system/webhook/create | Create (or replace) a webhook in an explicitly named slot (0-3). Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS). |
| /api/system/webhook/drop | Drop (clear) one of the 4 webhook slots. Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS). |
| /api/system/webhook/list | Lists all 4 webhook slots and their configuration. Requires an API-role executor with the settings permission (UPDATE_SETTINGS_ACTION_ACCESS). |
| /api/tlnavi1 | Limited Navigation Info for a quick top level rendering |
| /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/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/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. |
| /api/wero/confirm1 | Confirm consent and capture a Wero payment that has no associated shop order (see /api/client/wero/transaction1's orderless path). Requires an API-role executor with the API_WERO_ACCESS permission. |
Response Types (120)
| Type | Version | Description |
|---|---|---|
| ActionGroup | 1 | (aka Actionsgruppe), an arbitrary customer grouping used for automation, marketing or segmentation |
| ActionGroupResult | 1 | Result of setting/removing actiongroup membership for a customer |
| ActionResult | 0 | Result of a backend action |
| Address | 23 | A delivery address with geo-coordinates and delivery hints, extended with driver tour-plan info (translated hints, box placement position) and the customer-facing placement note. |
| Article | 3 | Text snippets |
| Assorted | 1 | Unresolved assortment subscription detail for an order |
| Assortment | 8 | 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) |
| AssortmentPosition | 2 | Item-to-Assortment Mapping incl. amounts |
| AuxDate | 1 | An auxiliary calendar event or notice |
| B2BInfo | 1 | Wholesale (B2B) net price and packaging option for an item. May occur multiple times per item, one per pick option. Exists only in B2B systems. |
| BonusCampaign | 2 | A bonus campaign defining rules for point collection and rewards |
| BonusDiscount | 1 | A discount granted to the customer when a bonus reward is reached. Referenced by BonusReward.discount. Not necessarily currently active for the caller. Class Derived from userDiscount. |
| BonusResult | 1 | Result of a bonus action (apply, claim or admin set) |
| BonusReward | 5 | Rewards possible for the campaigns and their state |
| Box | 2 | A subscription box assigned to the customer |
| CampaignStat | 1 | One calendar week of mail campaign statistics |
| Car | 1 | A delivery vehicle of the shop (driver app data) |
| CartItem | 1 | An item with amount and unit, may be from cart or from a previous order or an assortment position |
| ChangeOrderResult | 1 | Optional Result of a order mutation action (order submission, cancellation, etc.) |
| ChargePoint | 1 | An e-car charging point (Ladepunkt) the driver or the tour optimization may use. All addresses of fuel-station customers (orgtype 4) that are assigned to the requested tour are provided with the tour plan; tour_index is 0 unless the charge point was intentionally planned into the tour. |
| ChatControl | 1 | Chat service availability status |
| ChatResponse | 1 | A chat bot response message or a message in a chat transcript. |
| Config | 2 | Shop-wide configuration values (one record). Drives client behaviour for shop, driver app, and admin UIs. |
| ConfigResult | 1 | Result of setting a configuration value |
| ConfigValue | 1 | A single public configuration value |
| CreateVoucherResult | 1 | Result of creating individual voucher codes |
| CreatedVoucher | 1 | An individual voucher code created for a voucher item |
| CustomerInfo | 5 | Per-customer box return info for a delivery ride: which delivery boxes are still on the customer's record. |
| DDate | 4 | A delivery ride (delivery date on a tour) in the admin/operator tour overview, with customer and order counts. |
| Delivery | 15 | One delivery (stop) of a delivery ride: which customer/address is served in which sequence, incl. packing box info and arrival prediction. |
| DeliveryListState | 1 | Meta information about the Delivery list of a tour plan: completeness of the geocoded stops. Replaces the 'incomplete' attribute the legacy tour endpoint carried on the Delivery list header. |
| DeliveryState | 3 | Estimated delivery state for a stop on the driver's tour |
| DeselectedGroup | 1 | A category preferably excluded from a customer's assortment |
| DeselectedItem | 1 | An item preferably excluded from a customer's assortment |
| DeviceRegistration | 1 | Result of a device push-token registration, including a rotated claim token when the device was associated with a customer |
| Discount | 2 | An active discount for the customer. If this record is provided, it must be active for the caller. |
| DriverActionResult | 1 | Acknowledgement of a driver action |
| DriverAssignResult | 1 | Result of a driver box (de-)assignment |
| DriverPause | 1 | A scheduled driver pause |
| DriverPosition | 1 | Last known position of a driver on a tour |
| DriverState | 3 | Current position and identity of the driver on the tour |
| EventStat | 1 | One data point (day or hour bucket) of an event statistic |
| EventType | 2 | A statistics event type that can be queried via the stats/events endpoint |
| Favourite | 1 | A shelf favourite (bookmarked item or menu level) |
| File | 1 | A file stored in the filestore |
| FilterGroup | 1 | Labels are part of a filter group (aka LabelGroup) |
| GeoAddress | 1 | A geocoded address result with coordinates and quality indicator |
| GeoCodeResult | 1 | Result of a geocode/address check operation |
| GeoPoint | 1 | A geo located point (delivery address, customer, registration miss or driver track position) as used by the geo tools |
| GoodbyeReason | 1 | A reason why a customer left us |
| Group | 4 | A warehouse category. Any Item is exactly member of one category. |
| Item | 25 | A warehouse Item |
| ItemDetail | 1 | Extended item information such as long description HTML |
| 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). |
| LinkStat | 1 | One day of click counts for a tracked shop link |
| LogResult | 1 | Result of writing a log entry to the shop event log (Log table). |
| LogonResult | 1 | Result of a logon attempt with session and cache information |
| LogoutResult | 1 | Result of a logout/unregister action |
| MailCampaign | 2 | One message series (Serienmail, push or SMS series) with its delivery and engagement statistics |
| MailOpenStat | 1 | Mail opens in one time bucket (hour or day) after a sendout |
| MessageSeriesResult | 1 | Result of queueing or cancelling a message series |
| MsgResult | 1 | Result of queuing a message for the PCG backend (msgqueue table). |
| Navigation | 4 | Top Level Navigation entries |
| NavigationDetail | 3 | Navigation Child Levels |
| NewClientResult | 1 | Result of a new client registration attempt |
| NudgeResult | 1 | Result of switching the cart suggestion (Nicht vergessen) off or on |
| Order | 12 | A customer order with delivery, status, and invoice information |
| OrderState | 1 | Polling result that tells whether a specific order or a specific delivery date is still actionable for the client. Can be used by shops to decide if a stale (old, modified) cart needs to reload data (a order may have changes on server side). For a complete overview about possible dates and orders, use the dates endpoint. |
| OrgInfo | 1 | A certification organization (Verband) with icon flag, name, bio flag, and website URL |
| OutstandingPayment | 1 | An open position of the customer that the back office has not settled yet, e.g. deposit |
| PackStation | 3 | Goods are packed there. Some pricing calculation may depend on the packing station. |
| Pause | 1 | A delivery pause period |
| PauseResult | 1 | Result of a driver pause operation |
| PaypalAuthorize | 1 | Result of starting a PayPal authorization. On success carries the PayPal token (orderID in the new SDK). |
| PaypalResponse | 1 | Result of a PayPal payment finalization call (invoked after the customer returns from PayPal). |
| PaypalScript | 1 | Returns the URL of the PayPal client-side script (with the shop's configured PayPal client id). Used by the shop to load the PayPal JavaScript SDK. |
| PermanentPosition | 1 | A permanent (standing) order position from a subscription |
| Position | 3 | An order line item position with deposit (Pfand) snapshot |
| PushActionGroupResult | 1 | Result of queueing a push message to all members of an action group |
| PushDayStat | 1 | Push sends of one day on one delivery channel, aggregated |
| PushDeviceStat | 1 | Number of devices registered for platform-side push (FCM), per platform and app product |
| PushHook | 1 | The push hook configuration. When a URL is configured, push notifications (matching the type filter) are handed to that external provider instead of being sent by the platform itself |
| PushHookResult | 1 | Result of a push hook create/drop operation |
| PushSend | 1 | One push notification send per delivery channel: what was sent, to whom, and how far it got (accepted / delivered / opened) |
| RankedItem | 1 | An item in a ranking, like the customer's most ordered items or the shop's bestsellers. Listed best first |
| Refund | 1 | Refund item definition (e.g. deposit/bottle refund). Items may require one of these refund objects. |
| RegisterReason | 1 | A reason how a customer found the shop during registration |
| RelatedItem | 2 | Items may have relations to other items (like recommended additions or as ingredient) |
| ReorderHint | 1 | An item the customer buys regularly and may want to order for the selected delivery ("Nicht vergessen"). Listed in display order, most due first |
| Rubric | 3 | A warehouse rubric, often that is a internal price list. An Item can be in multiple rubrics. |
| RubricMap | 1 | Item-to-Rubric Mapping |
| SaveCartResult | 1 | Result of saving the current cart server-side (/api/client/savecart1) |
| SendPasswordResult | 1 | Result of a password reminder request. When verbose=0 (default) the only success result is 'sent', regardless of whether the user actually exists; this prevents user enumeration. The 'blocked' and 'slower' results are always returned as-is. |
| ShopDate | 8 | A delivery date with order, tour, shipping, and address information |
| ShopUrl | 8 | Shop binding information for initial client connection |
| SubGroup | 3 | A warehouse category subgroup. An Item can be in multiple subgroups. |
| SubGroupMap | 1 | Item-to-Subgroup Mapping |
| Subscription | 4 | A standing subscription (item or assortment box) |
| Ticket | 2 | A ticket within a board, ordered by sorting then start date descending |
| TicketAttachment | 1 | A file attachment on a ticket |
| TicketBoard | 1 | A ticket board groups states into separate kanban-style views |
| TicketDetail | 1 | A detail entry (comment/note) on a ticket |
| TicketResult | 1 | Result of a ticket/kanban mutation (board, state, ticket or detail operation) |
| TicketState | 1 | A ticket state within a board. Tickets are assigned to exactly one state. |
| Tour | 9 | A delivery tour in the admin/operator tour overview, including geo polygons and address counts. |
| TourDistance | 3 | A delivery tour that can serve a given location, with how close it already comes to it. Emitted by the tour lookup for a new customer's address (findtour3). |
| TourLimit | 2 | Item order limits applicable for individual tours |
| TourPlan | 4 | Optimised order of the stops of a tour, with the metres and minutes of the sequence as given for comparison |
| TourPolygonResult | 1 | Result of setting or clearing a tour area polygon |
| Translation | 1 | A translation key/value pair (translation table for shop locale) |
| UserInfo | 24 | Authenticated user profile and preferences |
| Variable | 1 | A personalization variable: written as %alias% into a mail, SMS or content text, it is replaced by data of the addressed customer, an item, a date or a link when the text is used. Some aliases carry an id or amount argument, e.g. Artikel. |
| VariableGroup | 1 | A group of personalization variables sharing the same context (customer, item, order, ...). Groups are listed in the recommended display order. |
| Voucher | 1 | A voucher code assigned to the customer |
| Webhook | 1 | One of the 4 webhook slots and its configuration |
| WebhookResult | 1 | Result of a webhook create/drop operation |
| WeroAuthorize | 1 | Result of starting a Wero (VR Payment) authorization. On success carries the bank's landing page for consent. |
| WeroConfirm | 1 | Result of confirming consent and capturing a Wero payment that has no associated shop order. |
| XUnit | 5 | Alternative Units |
Skills (36)
| Skill | Description |
|---|---|
| actiongroups | Aktionsgruppen (action groups) tag customers by interest, newsletter or marketing campaign. Customer-editable groups appear in the authenticated user profile and can be listed, joined or left via the API. Use when showing/letting a customer manage their own group memberships, or when an admin needs to set/remove membership on behalf of a customer. |
| bonus_system | aka "Bonuspunkte" / "Bonussystem" in German. How to display bonus campaigns, point balances and rewards in a shop implementation, let customers opt into a campaign and claim rewards via the API. |
| cart-autosave | How to implement cart autosave in your own API client: save the customer's cart server-side while they shop, have it turned into a real order automatically when the customer has opted in, and keep your client in sync with the order that was created. Use when building a shop front end or app that should never lose a forgotten cart, or when asked how savecart1 and the autosave opt-in work. |
| cart-display | How to build the shopping cart of your own shop front end or app on top of the API: which data to load, how to derive the deadlines (change, cancel, per item), which action button to offer in which situation, what to tell the customer instead of a disabled button, how to mark single positions (locked, delete only, earlier deadline, pre-order, subscription, duplicate, price change), and how to submit, change and cancel the order. Use when implementing your own cart. |
| customer-wero-api | How to pay for a shop order with Wero (VR Payment) on behalf of a logged-in shopper: initiate the payment, redirect through the bank's consent page, then resubmit the order, which verifies consent and captures inline. Use when driving a customer's checkout through /api/client/wero/transaction1 + /api/client/neworder8 or /api/client/changeorder8. |
| Delivery Date Selection | PCG Backends process all orders for dedicated delivery days. |
| donations-and-tip | aka "Spendenartikel" / "Trinkgeld" in German. How to offer donation or tip items (item type 78) in a shop implementation: discover the configured items via the Config object, load their details, present them once the minimum order value is reached, and submit them as regular order positions. |
| Implement a Push Provider | How to take over push notification delivery for a tenant with your own push service: register a push hook via the API, receive every push notification as a JSON webhook, deliver it to the devices yourself, feed delivery/open analytics back and read the push statistics. Use when a shop wants to send push through its own provider (own Firebase project, another push vendor, an app that is not one of the standard apps) instead of the platform's built-in push. |
| favourites-and-individual-offering | How a customer gets an individual offer in your own shop front end or app: the favourites ("Merkliste") and the personal lists next to it in the standard shop — "Nicht vergessen" (regular items due again), "Oft in deinen Bestellungen" and "Was andere bestellen". Covers which call delivers what, how to add and drop favourites, how to turn references into item tiles and menu links, what to show for items that are currently not available, and what to offer when a list is empty. Use when building a favourites page, a heart toggle on item tiles or a personal start area. |
| feed-orders-into-the-system | How to feed orders into the PCG backend from external systems: log on with user credentials, choose a delivery date, then create, change or cancel orders (including one-off guest orders). Use when integrating an external order source or when asked how to submit, modify or cancel orders through the API. |
| Image and File-Proxy | The image and file proxy (*.px / *.py): how to fetch item, group, navigation, producer, association, article and file store images through the shop server by type code and id, scale, fit, blur and rotate them on the server, what is cached for how long, and what happens when an image is missing. Use whenever you display images from API objects. Addresses security, caching and performance concerns. |
| how-to-use-kanban | The admin kanban / ticket management API: boards, states, tickets, notes and attachments. Use when building an internal task board for the admin area. |
| Provide images for items and groups | aka "Artikelbilder" / "Warengruppenbilder" in German. The ways a shop operator or integrator can get images onto items and navigation levels (groups, subgroups, price lists, navigation entries).Check this, when images are missing or wrong, or before building an image gallery on top of Item.imageCount. |
| implement-complaints | aka "Reklamation" / "Beanstandung" in German. How a customer complains about a delivered order: missing, damaged or wrong goods. Covers the ready-made ways (profile component, the complaint page and its links with order number and email hash, links in mails) and the endpoint behind them for your own form or app: who is allowed to complain about an order (session, email address or link hash), how to offer the items of the order with a reason each, the photo upload, the answers and error codes, the limits (4 weeks, rate limit) and what happens afterwards (mails to shop and customer, event for webhooks and statistics). Use when building a complaint form, a QR code or mail link to it, or when processing complaints in another system. |
| implement-paypal | How to take PayPal payments for a shop order from your own frontend: the in-page PayPal SDK checkout (ppscript1 → ppauthorize1 → SDK approval → ppresponse1 → order store with paycode 2) and the pay-by-link alternative (order store with paycode 9, link in the confirmation mail). Covers the overcharge, sandbox detection, re-authorization after cart changes and what the API does and does not tell you about a PayPal order. |
| display item details | Beside the core data from the Item Response type, more data can be presented in a online shop |
| item-labels | |
| Logging | How to Log Events using the API |
| Message Queue | Internal Message Queuing. You may send a Message to the backend. |
| new-customer-registration | aka "Neuanmeldung" / "Registrierung" in German. How to register a new customer through the API: what to read from the shop configuration first, how to check whether the shop delivers to the address (tours, depots, invitation codes), which parameters newclient1 takes, how the invoice and the delivery address are stored and returned, what the backend changes afterwards (customer id, addresses, payment methods), the one-call guest order (regorder2: registration plus first order), and what not to forget: terms and privacy acceptance, bank data, newsletter consent, bonus and action groups. Use when building your own registration form, onboarding flow, guest checkout or an admin tool that creates customers. |
| profile-display | How to build the customer profile ("Mein Profil") of your own shop front end or app on top of the API: which sections the standard shop offers, which call delivers the data for each (login data, settings, subscriptions, pauses, favourites, deselected items, discounts, boxes, past orders, personal data, delivery, payment with balance and open positions, account deletion), which call changes it, and what is easy to get wrong (stale customer data, guests, role restrictions). Use when implementing a profile page. |
| Publish the shop's FAQ on a website | How to put a shop's confirmed FAQ (written and reviewed in the shop admin's FAQ generator) on the shop's own website: the three forms served under /faqdownload/ |
| reduced prices | aka "Preissenkung" / "durchgestrichene Preise" in German. How to show a former, higher price struck through next to the current price using Item.lastPrice, what the value means, when it changes and which legal wording must accompany it. Use when rendering item prices in a shop front end or app. |
| saleoff | aka "Abverkauf" in German. decribes how this can be implemented using the API |
| send-message-series | How to send one mail, push or SMS message to many customers as a queued, throttled message series (like a Serienmail), choose the mail template, follow its delivery in the series statistics, and cancel it. Use when an admin integration wants to mail or push to an action group, all customers or a list of customers, schedule such a send, or read how many messages were delivered and opened. |
| Implement push notifications in your App | What a native app developer (whitelabel or esst.bio Android/iOS) needs to do to receive push notifications sent by obox via Firebase Cloud Messaging (FCM). One required baseline plus independent optional add-ons (deep-linking, rich images, delivery/open analytics), each with its own extra setup cost - none depend on each other. Use when integrating a client app with obox push, or when asked what's needed to add one of the optional pieces to an app that already has bare push working. |
| standalone-wero-api | How to process a standalone Wero (VR Payment) transaction via the API — one with no associated shop order and no logged-in shopper: initiate a payment, redirect the customer through the bank's consent page, and confirm/capture it afterwards. Use when building an external payment integration against /api/client/wero/transaction1 and /api/wero/confirm1. |
| supporting-b2b-customers | How the API expresses customer-group pricing (B2C) and wholesale (B2B) shops: per-customer item overrides, net prices with informational VAT, price validity time ranges, and packaging units. Use when building shop UIs that must show group-specific or wholesale prices, or when detecting whether a system is a B2B / wholesale backend. |
| Entity-Relationships in this API | Explains the relation between the Response Types in this API |
| use-altcha-captcha | Shops can protect the anonymous newsletter subscription (api/client/subscribe) and the message form (api/client/message) with an ALTCHA proof-of-work captcha; guests in the chat (api/chat1) solve it once per chat session. Use when building your own frontend or integration that posts to these endpoints: how to find out whether a shop wants the captcha, fetch a challenge, solve it (in the browser with the ALTCHA widget, or headless) and send the solution. |
| use-api | Introduction to the low-level PCG API: how endpoint URLs are built, how to discover a shop's base URL, the response formats controlled by oo-rf, the session model, forcing authentication, access restrictions and getting started. Use when you need to understand how to call the API at all, or before using any of the more specific API skills. |
| use-built-in-chat | The built-in AI chat bot API: send questions via chat1, read the conversation transcript via chatscript1, understand the ChatControl status codes, the chat session model and the action microformat in bot answers. Use when integrating the shop's chat bot into a frontend or when debugging chat behaviour. |
| use-driver-api | Endpoints that support the delivery driver (the person delivering goods by bike or car): goods delivery, box handling, refund handling and improving the accuracy of the delivery time. Use when building driver-facing features. |
| use-js-components | How to install, embed and configure the shop's JavaScript components (cart, shop, date, logon, profile, search, status, ...): loading the client script and its parameters, the bootstrap hook, mounting a component in a page, component switches and the order in which their values are resolved, page-link values, setting switches ad-hoc at runtime, and enabling per-component debug output. Use before configuring any single component. |
| use-stats-api | Overview of the statistics endpoints under /api/stats/: shop event statistics, mail sendout (Serienmail) statistics with campaign details and opens-over-time, and link click statistics. Use when you want to build dashboards, reports or monitoring on top of shop and mailing activity data. |
| setup_webhooks | How to use, create, list and drop webhooks via the API so an external system gets called on PCG events (order changes, cancellations, etc.). Use when asked to register, inspect or remove a webhook, or to automate that setup for a tenant. |
JS Components (24)
| Component | Description |
|---|---|
| cancel-form | The cancel form (Widerruf) component: the legally required right-of-withdrawal form for any visitor, with a one-click direct cancel shortcut for logged-on customers and their still open orders. Lists all component switches, the page parameter and debug terms. |
| cart | The shopping cart component: cart positions with in-cart amount editing, summaries, state-dependent action buttons, cart note, checkout flow. Lists all component switches and debug terms of the cart. |
| chat | The chat component: the shop's AI sales assistant as an overlay chat window for logged-on customers, with conversation history, navigation actions, flagging and privacy information. Lists all component switches and debug terms. |
| content | The content component: embeds an article from the shop's content pool (mini CMS) or a placeholder text, by id, short name or from the page URL, optionally rendered in wiki format; multiple instances per page. Lists the content spec, all component switches and debug terms. |
| contentnavi | The content navigation component: builds a menu of articles from the shop's content pool (mini CMS) selected by keyword, linking to a content page; several menus per page possible. Lists all component switches, the changed event and debug terms. |
| date | The delivery date selection component: lets an authenticated customer pick the next delivery date as a list or calendar, handles conflicts with an open cart and shows delivery pauses. Lists all component switches and debug terms. |
| filter | The filter component: global item filtering by label groups (origin, diet advice, ingredients, ...) configured in the backend, with the active filters stored in the browser and applied by shop and search. Lists the filter logic, the changed event and debug terms. |
| flash | The flash component: displays info and error messages issued by the other components or your own script — collected across a page change and shown at the next opportunity, with automatic fade-out for info messages. Lists all component switches, the message functions and debug terms. |
| last | The last-seen component: lists the recently visited items and navigation levels for quick re-selection, stored in the browser, newest first and without duplicates. Lists all component switches and debug terms. |
| loading | The loading indicator component: shows a small activity indicator while the toolkit talks to the server and a "taking longer" element after a configurable delay; can block user input during long processes. Lists all component switches and debug terms. |
| loadingbar | The loading bar component: a thin progress bar (like browsers show on page load) that advances with every network request of the toolkit and completes when all are done. Lists the done event and debug terms. |
| logon | The logon component: logon form in its variants (email first, email + password, name logon), logout with cart warning, and dispatching to the registration, cart or profile page. Lists all component switches and debug terms. |
| The mail component: a contact form that mails all its named fields to the shop operator, with required-field checks, URL parameter pre-filling and a test mode. Lists all component switches and debug terms. | |
| navi | The main navigation component: renders the shop's menu tree (top level plus up to two sub levels) as hover or click menus, hamburger navigation for small screens, and controls page-wide header and image elements for the current navigation level. Lists all component switches, the external control event and debug terms. |
| path | The path (breadcrumb) component: shows the path of the currently selected navigation level or item within the shop's menu tree, each element clickable. Lists all component switches and debug terms. |
| profile | The profile component: address lookup and tour/depot selection for visitors, new customer registration (tabbed form, quick order), and viewing/editing all profile sections of a customer (personal data, delivery, payment, subscriptions, pauses, denials, favourites, last orders, account removal). Lists all component switches and debug terms. |
| progressbar | The progress bar component: shows the byte progress of large downloads (e.g. the initial item data) as one bar per request with current, total and percent values. Lists the template placeholders and debug terms. |
| search | The search component: free text search over items, navigation levels and site pages with an overlay of suggestions, preview items and function shortcuts; also the entry point for test, admin, ad-hoc switch and debug commands. Lists all component switches and debug terms. |
| shop | The main shop and item selection component: renders navigation levels, item lists, single items, assortments and recipes, handles add-to-cart, paging, scrolling and the browser history. Lists all component switches and debug terms. |
| shoplink | The shoplink component: enhances links to shop items anywhere on the page with an image and details preview on mouse over. Lists the link format, component switches and debug terms. |
| status | The status bar component: shows the visitor's state (anonymous, located, customer) with links to logon, profile, date and cart, a mini cart preview with editing, the next delivery date and page-wide status placeholders. Lists all component switches, the add-to-cart event and debug terms. |
| subnavi | The sub navigation component: renders a secondary menu (e.g. a left column) showing the siblings of the current navigation level or a fixed level of the navigation tree, with an empty-state placeholder and hamburger support; multiple instances per page possible. Lists all component switches, the rendered event and debug terms. |
| subscribe | The subscribe component: double opt-in newsletter / waiting list subscription form, confirmation of the mailed link and unsubscription, optionally assigning the subscriber to an action group, protected by the shop's ALTCHA captcha. Lists all component switches, page parameters, captcha requirements (HTTPS, CSP, styling) and debug terms. |
| ticker | The ticker / teaser component: shows one or several items, groups or navigation entries from the shop, optionally rotating, with image, details and an add-to-cart button. Many tickers per page, content controllable from the backend via a navigation entry. Lists the ticker spec, all component switches and debug terms. |
Recent Changes (179)
Endpoint and response type versions added in the last 6 months, newest first.
| Date | Endpoint / Type | Change Note |
|---|---|---|
| 2026-11-20 | /api/system/setconfig | |
| 2026-11-20 | ConfigResult v1 | |
| 2026-11-19 | /api/client/setprofile11 | v10 + bonus data as in user38 (BonusReward v5, BonusDiscount) |
| 2026-11-19 | /api/user38 | same as user37, BonusReward v5 adds last_redemption and last_redemption_state |
| 2026-11-19 | BonusReward v5 | same fields as v4, adds last_redemption and last_redemption_state |
| 2026-11-07 | /api/client/setprofile10 | v9 + UserInfo v24 (adds nobonus) |
| 2026-11-07 | /api/user37 | same as user36, UserInfo v24 adds nobonus |
| 2026-11-07 | UserInfo v24 | same fields as v23, adds nobonus |
| 2026-11-05 | /api/search2 | first version in the typed format; replaces the legacy /api/search and /api/search1 |
| 2026-11-01 | /api/bestsellers1 | |
| 2026-11-01 | /api/client/frequentitems1 | |
| 2026-11-01 | /api/client/nudge1 | |
| 2026-11-01 | /api/client/reorderhints1 | |
| 2026-11-01 | /api/client/setprofile9 | v8 + UserInfo v23 (adds nonudge), takes pref_nonudge |
| 2026-11-01 | /api/user36 | same as user35, UserInfo v23 adds nonudge |
| 2026-11-01 | NudgeResult v1 | |
| 2026-11-01 | RankedItem v1 | |
| 2026-11-01 | ReorderHint v1 | |
| 2026-11-01 | UserInfo v23 | same fields as v22, adds nonudge |
| 2026-10-30 | /api/system/bonus/list2 | |
| 2026-10-30 | BonusCampaign v2 | |
| 2026-10-24 | /api/client/setprofile8 | v7 + Tour v6 (adds shipping) |
| 2026-10-24 | /api/findtour3 | replaces /api/findtour2: TourDistance v3 adds shipping |
| 2026-10-24 | /api/user35 | same as user34, Tour v6 adds shipping |
| 2026-10-24 | Tour v6 | same as v5, adds shipping |
| 2026-10-24 | TourDistance v3 | same as v2, adds shipping |
| 2026-10-22 | /api/plantour4 | opt=no calculates the given sequence without optimising; before_* fields with the metres and hours of the given sequence for comparison (aid, cid and did calls) |
| 2026-10-22 | TourPlan v4 | opt=no calculates the given sequence without optimising (status CALCULATED); before_* fields carry the given sequence's metres and hours next to the optimised plan |
| 2026-10-20 | /api/user34 | same as user33, adds the OutstandingPayment list |
| 2026-10-20 | OutstandingPayment v1 | |
| 2026-10-19 | /api/plantour3 | metres driven to each stop and back to the start; errors as HTTP status instead of a status text |
| 2026-10-19 | /api/tour34 | replaces /api/tour33; the deliveries move from Delivery v14 to Delivery v15 (adds distance) |
| 2026-10-19 | Delivery v15 | adds distance: street meters from the stop before, as the tour optimisation planned them |
| 2026-10-19 | TourPlan v3 | |
| 2026-10-12 | /api/admin/voucher/create2 | Successor of /api/admin/voucher/create: parameters of the admin form (lifetime, customers), returns exactly the created codes. |
| 2026-10-12 | /api/bind6 | added seoPlz (postal codes of the delivery area) |
| 2026-10-12 | CreateVoucherResult v1 | |
| 2026-10-12 | CreatedVoucher v1 | |
| 2026-10-12 | ShopUrl v8 | |
| 2026-10-09 | /api/system/variables | |
| 2026-10-09 | Variable v1 | |
| 2026-10-09 | VariableGroup v1 | |
| 2026-10-05 | /api/client/savecart1 | replaces /api/client/modifiedcart and /api/client/resetcart (exec1.jsp), which stay for old bundles |
| 2026-10-05 | SaveCartResult v1 | |
| 2026-09-20 | /api/tour33 | replaces /api/tour32; the tour header moves from Tour v7 to Tour v9 (adds active, nopreorders, sameday, noautoassign) |
| 2026-09-20 | /api/tours11 | replaces /api/tours10; Tour v9 adds the tour flags nopreorders, sameday and noautoassign |
| 2026-09-20 | /api/user32 | same as user31, ATTENTION: emits BonusReward v4 - same fields as v3, adds redemption_count (how often the user already redeemed that reward) |
| 2026-09-20 | BonusReward v4 | |
| 2026-09-20 | Tour v9 | adds the tour flags nopreorders, sameday and noautoassign |
| 2026-09-14 | /api/admin/message/series | |
| 2026-09-14 | /api/admin/message/series/cancel | |
| 2026-09-14 | /api/admin/pushactiongroup | |
| 2026-09-14 | /api/stats/mailcampaigns1 | adds channel and delivered (MailCampaign v2) and the channel filter |
| 2026-09-14 | MailCampaign v2 | adds channel and delivered |
| 2026-09-14 | MessageSeriesResult v1 | |
| 2026-09-14 | PushActionGroupResult v1 | |
| 2026-09-13 | /api/stats/push1 | |
| 2026-09-13 | /api/stats/pushdevices1 | |
| 2026-09-13 | /api/stats/pushsummary1 | |
| 2026-09-13 | /api/system/pushhook/create | |
| 2026-09-13 | /api/system/pushhook/drop | |
| 2026-09-13 | /api/system/pushhook/list | |
| 2026-09-13 | PushDayStat v1 | |
| 2026-09-13 | PushDeviceStat v1 | |
| 2026-09-13 | PushHook v1 | |
| 2026-09-13 | PushHookResult v1 | |
| 2026-09-13 | PushSend v1 | |
| 2026-09-07 | /api/client/setprofile7 | v6 + addresses as UserAddress23 (adds chint) |
| 2026-09-07 | /api/user31 | same as user30, ATTENTION: emits UserInfo v22 - same fields as v21, adds orgtype (customers.orgtype) |
| 2026-09-07 | Address v23 | same fields as v22, plus chint |
| 2026-09-01 | /api/wero/confirm1 | |
| 2026-09-01 | WeroAuthorize v1 | |
| 2026-09-01 | WeroConfirm v1 | |
| 2026-08-31 | UserInfo v22 | same fields as v21, adds orgtype |
| 2026-08-23 | /api/system/geo | |
| 2026-08-23 | GeoPoint v1 | |
| 2026-08-19 | Assortment v8 | added isdefault, the variant a shop should preselect within its abogroup |
| 2026-08-18 | /api/admin/tour/setpolygon | |
| 2026-08-18 | /api/tours10 | replaces /api/tours9; Tour v8 adds the active count (visible addresses of active customers) |
| 2026-08-18 | Tour v8 | adds active (number of visible delivery addresses of active customers) |
| 2026-08-18 | TourPolygonResult v1 | |
| 2026-08-11 | /api/system/msg1 | dedicated endpoint using POJO pattern, replaces exec2.jsp dispatch |
| 2026-08-11 | DeviceRegistration v1 | |
| 2026-08-11 | MsgResult v1 | |
| 2026-08-10 | /api/findtour2 | replaces /api/findtour1: typed response, ShopDate v8 instead of v7; the ?depot=1 variant moved to /api/getdepots1 |
| 2026-08-10 | /api/getdepots1 | replaces /api/getdepots: typed response, Address v22 instead of v12, ShopDate v8 instead of v7 |
| 2026-08-10 | TourDistance v2 | same fields as the hand-rolled v2 of findtour/findtour1, now a typed response |
| 2026-08-07 | /api/client/pushdelivered | |
| 2026-08-07 | /api/client/pushopened | |
| 2026-08-05 | /api/client/log1 | dedicated endpoint using POJO pattern, replaces exec1.jsp dispatch; documents the cid parameter |
| 2026-08-05 | /api/system/log1 | dedicated endpoint using POJO pattern, replaces exec1.jsp dispatch |
| 2026-08-05 | /api/tour32 | adds the ChargePoint list (addresses of fuel-station customers, orgtype 4); ATTENTION: Address v22 reorders its fields onto the shared Location base |
| 2026-08-05 | /api/user30 | ATTENTION: emits Address v22 - same fields as v21/v15, but reordered onto the shared Location base (Location fields first, delivery-specific fields last) |
| 2026-08-05 | Address v22 | same fields as v21, ATTENTION:: reordered: shared Location base fields (also used by ChargePoint) first, delivery-specific fields last |
| 2026-08-05 | ChargePoint v1 | |
| 2026-08-05 | LogResult v1 | |
| 2026-07-31 | /api/client/droppushtoken | |
| 2026-07-31 | /api/client/registerpushtoken | |
| 2026-07-29 | /api/client/actiongroup | |
| 2026-07-29 | ActionGroupResult v1 | |
| 2026-07-20 | /api/system/eventtypes | |
| 2026-07-20 | EventType v1 | |
| 2026-07-17 | /api/stats/campaign1 | typed CampaignStat objects instead of the hand-rolled 'CampaignStats' JSON; unauthorized is now 403 (was 401) |
| 2026-07-17 | /api/stats/events1 | typed EventStat objects instead of the hand-rolled 'Stats' JSON; timestamps stay unix ms |
| 2026-07-17 | /api/stats/eventtypes1 | typed EventType objects instead of the hand-rolled JSON |
| 2026-07-17 | /api/stats/links1 | typed LinkStat objects instead of the hand-rolled 'LinkStats' JSON; errors are now HTTP status codes instead of an inline error member |
| 2026-07-17 | /api/stats/mailcampaigns | |
| 2026-07-17 | /api/stats/mailopens | |
| 2026-07-17 | /api/system/actiongroups | |
| 2026-07-17 | /api/user29 | |
| 2026-07-17 | ActionGroup v1 | |
| 2026-07-17 | CampaignStat v1 | |
| 2026-07-17 | EventStat v1 | |
| 2026-07-17 | EventType v2 | |
| 2026-07-17 | LinkStat v1 | |
| 2026-07-17 | MailCampaign v1 | |
| 2026-07-17 | MailOpenStat v1 | |
| 2026-07-17 | UserInfo v21 | |
| 2026-07-09 | /api/admin/kanban/add | |
| 2026-07-09 | /api/admin/kanban/delete | |
| 2026-07-09 | /api/admin/kanban/detail/add | |
| 2026-07-09 | /api/admin/kanban/detail/delete | |
| 2026-07-09 | /api/admin/kanban/state/add | |
| 2026-07-09 | /api/admin/kanban/state/delete | |
| 2026-07-09 | /api/admin/kanban/state/update | |
| 2026-07-09 | /api/admin/kanban/update | |
| 2026-07-09 | /api/items23 | Item now carries the deposit (Pfand): refundPrice, refundName and refundVat, resolved from the item's refund category |
| 2026-07-09 | Item v25 | added deposit (Pfand) info |
| 2026-07-09 | Ticket v2 | added background_color, board is referenced by id (board_id) |
| 2026-07-09 | TicketResult v1 | |
| 2026-07-08 | /api/system/webhook/create | |
| 2026-07-08 | /api/system/webhook/drop | |
| 2026-07-08 | /api/system/webhook/list | |
| 2026-07-08 | Webhook v1 | |
| 2026-07-08 | WebhookResult v1 | |
| 2026-07-07 | /api/tour31 | replaces legacy /api/tour30 with POJO pattern |
| 2026-07-07 | /api/tours9 | replaces legacy /api/tours8 (tours7.jsp) with POJO pattern |
| 2026-07-07 | Address v21 | migrated from legacy Address v20 (tour30) to POJO pattern; extends the base Address fields |
| 2026-07-07 | CustomerInfo v5 | migrated from legacy CustomerInfo v4 (tour30) to POJO pattern |
| 2026-07-07 | DDate v4 | migrated from legacy DDate v3 (tours8) to POJO pattern |
| 2026-07-07 | Delivery v14 | migrated from legacy Delivery v13 (tour30) to POJO pattern |
| 2026-07-07 | DeliveryListState v1 | |
| 2026-07-07 | Tour v7 | migrated from legacy Tour v6 (tours8) to POJO pattern; 0/1 switches are now booleans |
| 2026-07-05 | /api/driver/assign1 | |
| 2026-07-05 | /api/driver/boxexchange1 | |
| 2026-07-05 | /api/driver/bpos1 | |
| 2026-07-05 | /api/driver/cadr1 | |
| 2026-07-05 | /api/driver/deassign1 | |
| 2026-07-05 | /api/driver/dlvr1 | |
| 2026-07-05 | /api/driver/info1 | |
| 2026-07-05 | /api/driver/locate1 | |
| 2026-07-05 | /api/driver/refund1 | |
| 2026-07-05 | /api/driver/reorder1 | |
| 2026-07-05 | /api/driver/setstart1 | |
| 2026-07-05 | /api/driver/state1 | |
| 2026-07-05 | /api/driver/trck1 | |
| 2026-07-05 | /api/driver/udlvr1 | |
| 2026-07-05 | /api/driver/urefund1 | |
| 2026-07-05 | B2BInfo v1 | |
| 2026-07-05 | DriverActionResult v1 | |
| 2026-07-05 | DriverAssignResult v1 | |
| 2026-07-05 | DriverPosition v1 | |
| 2026-07-03 | /api/driver/delpause | |
| 2026-07-02 | XUnit v5 | Added internal Id |
| 2026-06-22 | /api/client/delivery3 | Migrated to ResponseFactory/ApiType; fixes lastname field (was incorrectly returning firstname in v2). |
| 2026-06-22 | DeliveryState v3 | |
| 2026-06-22 | DriverState v3 | |
| 2026-06-15 | /api/items22 | |
| 2026-06-15 | /api/orgs1 | simplified to hasIcon, name, isBio, url; added isBio for EU Kontrolliert entry |
| 2026-06-15 | Item v24 | added isBio flag (derived from VerbandInfo), bestBeforeDays |
| 2026-06-15 | OrgInfo v1 | |
| 2026-06-13 | /api/logout2 | new API |
| 2026-06-13 | /api/user28 | |
| 2026-06-13 | BonusReward v3 | |
| 2026-06-13 | LogoutResult v1 | |
| 2026-05-29 | /api/order29 | Position now carries the per-position deposit snapshot (refund, refundvat frozen at order time; refundname resolved live from the frozen refundid) |
| 2026-05-29 | Position v3 | |
| 2026-05-23 | /api/configuration40 | adds donation_item_ids |
| 2026-05-23 | Config v2 | adds donation_item_ids |