This section describes a REST/JSON based API, intended to develop special modules for the Ökobox-Online shop system, specific shopping solutions or integration’s to other systems such as CMS’es.
Ökobox-Online is a multi-tenant SaaS Shop Solution tailored for the PCG ERP System. It is especially suited for subscription based food delivery businesses.

Javascript Components API #

Using these components allows a simple assembling of a shop by just marking HTML Elements and assign Styles. Start Reading here

WebHooks Integration #

Sometimes you need to trigger processes based on events that happen in the shop system. That can be originated from a user (like an order) or the system (e.g. items were updated from backend).

You can setup the address of you system in the Admin-Backend. You’ll find there some debugging utilities as well. All ~130 events from the system can be subscribed that way.

The call to the webhook typically transports the event id and an id of a related object. Further information can then be obtained using the regular API.

Low Level API #

This API is intended to support selling activities for the business that owns the shop and its data. While possible, it is not intended to build complete shopping solutions. Written permission is required to present any data outside the owners domain.

Below you find information about the basic concepts. Start reading there. |||

The following information gives more Details about the low level API.

Data Model and common Terms #

The various methods listed above operate on or return objects. Typically, the objects and their relations are described in the respective topic.
Within this API you typically will connect to one of the systems hosted here. Systems are strictly separated in terms of data and access policies, but share all code and resources.
A user of the system is typically a Customer, but it might also be a user in an operator or admin role.
Items are the pieces the Customer’s will order, by collecting them into a cart. Note that a cart might have been preloaded by the system from an existing order. When stored in the system that cart becomes or updates an order.
If items are ordered for repeated delivery they become subscriptions