try out ↗

← API Index · ↑ methods


/api/system

Methods

Endpoint Description
/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/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/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.

Subdirectories