Allgemein

In dieser Anleitung finden Sie die Dokumentation der Kasse I/O REST API. Bei der API handelt es sich um eine REST-Schnittstelle. Wir haben REST als Schnittstelle ausgewählt, um den Nutzer dieser API einen möglichst portablen Ansatz zur platformübergreifenden Implementierung und Nutzung zu ermöglichen. Das Kassensystem basiert auf CakePHP 2 / Croogo CMS und bietet dadurch eine breite Anwender- und Entwickler-Community.

CakePHP

Croogo CMS

Als Formate für die Datenrückgabe der REST-Aufrufe bietet die API:

• JSON
• XML

Die Aufrufe der API's werden bei uns primär durch GET- und POST-Aufrufe durchgeführt.

Weitere Informationen finden Sie im Kapitel Beschreibung der API.

REST (Representational State Transfer)

REST steht für "Representational State Transfer" und bezeichnet ein Programmier Paradigma für Webanwendungen. REST abstrahiert dabei primär das Verhalten des HTTP Protokolls in Bezug auf die Nutzung der URI's sowie der HTTP-Header.

Wir setzen primär GET- und POST-Aufrufe im HTTP / HTTPS ein, um eine möglichst einfache Einbindung Client-seitig zu ermöglichen. GET-Aufrufe dienen dabei primär der Übergabe und Abfrage kleinerer Datenmengen, wohingegen POST-Aufrufe überall dort eingesetzt werden müssen, wo größere Datenmengen vom Client zum Kassensystem übergeben werden sollen.

Der Request:

https://domain.com/api/v2.0/kasse_users/kasse_auth_login.json?username=AABBCC&password=AABBCC

Weitere Informationen finden Sie im Wikipedia Beitrag zu REST.

Datenrückgabe in JSON

Die Rückgabe der Daten im JSON-Format wird erzeugt, indem Sie an den Aufruf der REST-URI’s als Dateiendung .json anhängen.

Die JSON notierte Response:

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": {
        "id": "2",
        "sid": "qm117fj81s3427sb5bb6684f87"
    }
}

Generell enthält jede Datenrückgabe in JSON immer das Element "status". In diesem Element befinden sich die Unterlemente "code" und "msg", welche Ihnen den Rückgabe-Code sowie eine Rückgabe-Nachricht ausgeben. Im Abschnitt Rückgabe-Codes finden Sie eine Liste der möglichen Rückgabe-Codes und eine Beschreibung was der jeweilige Rückgabe-Code bedeutet.

Weitere Elemente neben dem status-Element enthalten dann die eigentlichen Nutzdaten. Primär sei an dieser Stelle vorab das data-Element genannt.

Datenrückgabe in XML

Die Rückgabe der Daten im XML-Format wird erzeugt, indem Sie an den Aufruf der REST-URI's als Dateiendung .xml anhängen.

Die XML notierte Response:

<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <id>2</id>
        <sid>iqi16ist2m1esu9skmdps70nu7</sid>
    </data>
</response>

Generell enthält jede Datenrückgabe in XML immer das Element "status". In diesem Element befinden sich die Unterlemente "code" und "msg", welche Ihnen den Rückgabe-Code sowie eine Rückgabe-Nachricht ausgeben. Im Abschnitt Rückgabe-Codes finden Sie eine Liste der möglichen Rückgabe-Codes und eine Beschreibung was der jeweilige Rückgabe-Code bedeutet.

Weitere Elemente neben dem status-Element enthalten dann die eigentlichen Nutzdaten. Primär sei an dieser Stelle vorab das data-Element genannt, welches bei XML mehrfach vorkommen kann.

Wikipedia Eintrag zu JSON

Wikipedia Eintrag zu XML

API Rückgabe-Codes im status-Element

Jeder API-Aufruf liefert immer das status-Element mit den folgenden Unterelemente zurück und dient damit der Überprüfung ob ein API-Aufruf erfolgreich war und eine weitere Berarbeitung der angeforderten Daten möglich ist:

• code Rückgabe-Code (siehe nachfolgende Liste)
• msg Header Text für den Rückgabewert in status.code

Folgende Rückgabe-Codes wurden in Anlehnung an die HTTP Rückgabe-Codes von uns implementiert:

• 200 - OK
  Aktion erfolgreich, ggf. angeforderte Daten folgen oder gesendete Daten wurden erfolgreich übergeben.
• 201 - Created
  Die Daten wurden erfolgreich erstellt.
• 202 - Accepted
  Ihre Anfrage / Daten wurden akzeptiert und ggf. später ausgeführt / übernommen.
• 203 - Non-Information
  Ihre Anfrage wurde akzeptiert, es wurden nicht aktuelle Daten zurückgegeben.
• 204 - No Content
  Die Anfrage wurde bearbeitet, es liegen keine Daten vor.
• 400 - Bad Request
  Die Anfrage war fehlerhaft aufgebaut.
• 401 - Unauthorized
  Die Anfrage wurde ohne gültige Authentifizierung durchgeführt.
• 403 - Forbidden
  Die Anfrage wurde mangels Berechtigung nicht durchgeführt.
• 404 - Not Found
  Die angeforderte Ressource wurde nicht gefunden.
• 408 - Request Timeout
  Innerhalb der vom Server erlaubten Zeitspanne wurde keine vollständige Anfrage des Clients empfangen.
• 411 - Length Required
  Die Anfrage kann ohne ein „Content-Length“-Header-Feld nicht bearbeitet werden.
• 414 - Request-URL Too Long
  Die URL der Anfrage war zu lang. Ursache ist oft eine Endlosschleife aus Redirects.
• 423 - Locked
  Die angeforderte Ressource ist zurzeit gesperrt.
• 429 - Too Many Requests
  Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.
• 431 - Request Header Fields Too Large
  Die Maximallänge eines Headerfelds oder des Gesamtheaders wurde überschritten.

Der Rückgabe-Code im HTTP-Header wird dabei entsprechend gesetzt und stimmt somit mit dem im status-Element übermittelten Code überein. Es bleibt Ihnen überlassen, welchen Status-Code Sie auswerten.

Beschreibung der API

API Bereiche

Die Kasse I/O API wurde von uns in anwendungsspezifische Bereiche eingeteilt:

• Authentifizierung und Benutzer (Kasse User)
• Hersteller (Manufacturer)
• Marke (Brand)
• Distributor (Distributor)
• Wiederverkäufer (Reseller)
• Fachhändler (Retailer)
• Produktgruppen (Product Category)
• Produkt-Zustand (Product Condition)
• Produkt (Product)
• Lager
• Kunden
• Warenkorb

Im jeweiligen Bereich sind die einzelnen API’s nach ihrem API-Funktionen alphabetisch sortiert. Dieses dient in erster Linie der Übersichtlichkeit beim Durchsuchen der API. In den einzelnen API’s finden Sie teilweise verweise auf andere API’s, die Sie bequem per Link erreichen können.

Aufbau der API Funktions-Beschreibungen

Der grundsätzliche Aufbau der einzelnsen API-Beschreibungen ist wie folgt:

• API-Bezeichnung und Beschreibung der Funktionalität
• Aufruf-Beispiel in Form der REST-URI
• Tabellarische Beschreibung der Aufruf Parameter
• Beispiel-Rückgabe im Format JSON
• Beispiel-Rückgabe im Format XML
• Tabellarische Beschreibung der Rückgabe Werte, bei die immer benötigten Parameter normal und die optionalen Parameter kursiv geschrieben sind.

Bei einigen API-Beschreibungen gibt es darüber hinaus noch Hinweise und Ergänzungen. Das folgende Beispiel zeigt Ihnen den Aufbau:

Definition der Lookup API [apiname]

Der Request:

https://domain.com/api/v2.0/controller_name/controller_action[.json|.xml]?sid=XXXXXX[&id=1][&api_search=XXX][&api_recursive=n][&api_limit=n][&api_order_by=XXX][&api_order_direction=ASC|DESC][&api_condition_field=XXX][&api_condition_value=XXX][&api_find_type=first|count|all|list|threaded|neighbors]

Request Daten:

JSON Response Notation (JSON Response):

{
    [...] JSON Response Daten
}

XML Response Notation (XML Response):

<?xml version="1.0" encoding="UTF-8"?>
<response>
    [...] XML Response Daten
</response>

Response Daten:

Zeichensatz- und Datenkonventionen

Folgende Zeichensatz- und Datenkonventionen setzen wir zum Aufruf der API voraus:

• Die REST API-Aufrufe als GET und POST müssen immer in UTF-8 Encoding als MIME Type "application/x-www-form-urlencoded" erfolgen.
• Rückgabe der Daten von der Kasse erfolgt immer als UTF-8.

Im Rahmen der API-Beschreibungen benutzen wir häufig folgende Begriffe:

• Kasse I/O API / Kassen-API / API: Diese API in ihrem hier dokumentierten Umfang.
• Client: Bezeichnet denAnwender der REST-Schnittstelle (das was Sie anhand dieser API implementieren)
• Server / Kassen-System: Bezeichnet das Kasse I/O System an sich bzw. das zugrundeliegende System mit dem Sie über die REST-API als Client kommunizieren.

Wikipedia Eintrag zu MIME

Wikipedia Eintrag zu UTF-8

Beispiel einer HTTP POST Funktion in PHP für das Login

Nachfolgend finden Sie das Beispiel für eine PHP Funktion die einen HTTP-POST über unsere REST-API zum Login ausführt. Diese Funktion kann einfach für weitere Zwecke als Grundlage genutzt und entsprechend angepasst sowie erweitert werden.

Ein Code-Beispiel eines PHP Request:

<?php
function http_post_request($url, $data, $optional_headers = NULL) {
    $params = array ('http' => array(
            'method' => 'POST',
            'content' => $data,
            'protocol_version' => 1.1
        )
    );
    $params['http']['header'] = "Content-Length:" . strlen($data) . "\r\n";

    if ($optional_headers !== NULL) {
        $params['http']['header'] .= $optional_headers;
    }

    $ctx = stream_context_create($params);
    $fp = @fopen($url, 'rb', false, $ctx);
    if (!$fp) {
        die("Problem with $url, $php_errormsg");
    }

    $response = @stream_get_contents($fp);
    if ($response === false) {
        die ("Problem reading data from $url, $php_errormsg");
    }

    return $response;
}


$login_data = http_post_request("https://domain.com/api/v2.0/kasse_users/kasse_users_auth_login.xml", "username=AABBCC&password=AABBCC", NULL);

echo $login_data; ?>

Authentifizierung und Benutzer

Login [kasse_users_auth_login]

Führt das Login für einen REST-Benutzer durch und liefert eine eindeutige SESSION-ID (sid) zurück, die im weiteren für alle folgenden REST-Aufrufe benötigt wird, damit sich der Client dem Kasse-System gegenüber als zugriffsberechtigt ausweißt.

Bitte benutzen Sie nach Abschluss der Zugriffe auf die API die Logout Funktion damit Ihre Session abgemeldet wird.

Die SESSION-ID einer Session sollte aufgrund eines möglichen Timeouts regelmäßig auf Gültigkeit mit der kasse_users_auth_check_sid Funktion überprüft werden.

Der Request:

https://domain.com/api/v2.0/kasse_users/kasse_users_auth_login[.json|.xml]?username=AABBCC&password=AABBCC

Request Daten:

JSON Response:

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": {
        "id": "2",
        "sid": "id2ekbieuuv1savsd8mq35n7b7"
    }
}

XML Response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <id>1</id>
        <sid>XXXXXX</sid>
    </data>
</response>

Response Daten:

Logout [kasse_users_auth_logout]

Führt das Logout für einen REST-Benutzer anhand der angegebenen SESSION-ID (sid) durch. Die SESSION-ID (sid) ist danach sofort ungültig und kann nicht weiter verwendet werden. Sollten weitere REST-Aufrufe durch den Client nötig werden, muss ein erneutes Login durchgeführt werden.

Der Request:

https://domain.com/api/v2.0/kasse_users/kasse_users_auth_logout[.json|.xml]?sid=XXXXXX

Request Daten:

JSON Response:

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    }
}

XML Response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
</response>

Response Daten:

SID überprüfen [kasse_users_auth_check_sid]

Die kasse_users_auth_check_sid Funktion dient zum Überprüfen ob eine übermittelte SESSION-ID (sid) noch gültig ist oder z.B. durch den Session-Timeout ungültig geworden ist. Ist eine SESSION-ID ungültig geworden, ist ein erneutes Login notwendig, um weiterarbeiten zu können. Clients sollten die SESSION-ID in regelmäßigen Abständen oder nach Arbeitspausen erneut überprüfen.

Der Request:

https://domain.com/api/v2.0/kasse_users/kasse_users_auth_check_sid[.json|.xml]?sid=XXXXXX

Request Daten:

JSON Response:

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    }
}

XML Response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
</response>

Response Daten:

Hersteller (Manufacturer)

Hersteller Auflistung [manufacturers_lookup]

Die Hersteller Auflistungs-API dient dem Auflisten der im System erfassten Hersteller nach verschiedenen Kriterien oder in einer Gesamtauflistung.

Der Request:

https://domain.com/api/v2.0/manufacturers/manufacturers_lookup[.json|.xml]?sid=XXXXXX[&id=1]...

Request Daten:

JSON Response:

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": [
        {
            "Manufacturer": {
                "id": "1",
                "name": " Apple",
                "slug": " apple",
                "info": " Hersteller Info",
                "image": "apple.png",
                "product_count": "98",
                "status": true,
                "updated": "2014-11-12 22:29:57",
                "updated_by": "1",
                "created": "2014-12-06 00:00:00",
                "created_by": "1"
            }
        }
    ]
}

XML Response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Manufacturer>
            <id>1</id>
            <name>Apple</name>
            <slug>apple</slug>
            <info>Hersteller Info</info>
            <image>apple.png</image>
            <product_count>98</product_count>
            <status>1</status>
            <updated>2014-11-12 22:29:57</updated>
            <updated_by>1</updated_by>
            <created>2014-12-06 00:00:00</created>
            <created_by>1</created_by>
        </Manufacturer>
    </data>
</response>

Response Daten:

Hersteller anlegen [manufacturers_add]

Funktion zum Anlegen eines Hersteller-Datensatzes in der Datenbank.
Bei erfolgreichem Eintrag in die Datenbank gibt das status-Element als Rückgabe-Code 200 zurück.

https://domain.com/api/v2.0/manufacturers/manufacturers_add[.json|.xml]?sid=XXXXXX&name=Hersteller-Name[&info=InfoText][&image=Bilddatei[.png|.jpg]][&status=1]

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": {
        "Manufacturer": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Manufacturer>
            <id>1</id>
        </Manufacturer>
    </data>
</response>

Hersteller bearbeiten [manufacturers_edit]

Funktion zum Bearbeiten eines Hersteller-Datensatzes in der Datenbank. Nach erfolgreichem Bearbeiten gibt das status-Element als Rückgabe-Code 200 zurück. Von den optionalen Parametern muss zumindest ein Wert übergeben werden. Alle anderen Werte werden vom System vorbelegt mit vorhandenen Werten oder mit Default-Werten.

https://domain.com/api/v2.0/manufacturers/manufacturers_edit[.json|.xml]?sid=XXXXXX&id=1[&name=Hersteller-Name][&info=InfoText][&image=Bilddatei[.png|.jpg]][&status=1]

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": {
        "Brand": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Manufacturer>
            <id>1</id>
        </Manufacturer>
    </data>
</response>

Hersteller löschen [manufacturers_delete]

Funktion zum Löschen eines Herstellers aus der Datenbank. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/manufacturers/manufacturers_delete[.json|.xml]?sid=XXXXXX&id=1

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": {
        "Manufacturer": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Manufacturer>
            <id>1</id>
        </Manufacturer>
    </data>
</response>

Marke (Brand)

Marken Auflistung [brands_lookup]

Die Marken Auflistungs-API dient dem Auflisten der im System erfassten Marken nach verschiedenen Kriterien oder in einer Gesamtauflistung.

https://domain.com/api/v2.0/brands/brands_lookup[.json|.xml]?sid=XXXXXX[&id=1][&search=SUCHTEXT][&limit=n]

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": [
        {
            "Manufacturer": {
                "id": "1",
                "name": " Apple",
                "slug": " apple",
                "info": " Hersteller Info",
                "image": "apple.png",
                "product_count": "98",
                "status": true,
                "updated": "2014-11-12 22:29:57",
                "updated_by": "1",
                "created": "2014-12-06 00:00:00",
                "created_by": "1"
            }
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Manufacturer>
            <id>1</id>
            <name>Apple</name>
            <slug>apple</slug>
            <info>Hersteller Info</info>
            <image>apple.png</image>
            <product_count>98</product_count>
            <status>1</status>
            <updated>2014-11-12 22:29:57</updated>
            <updated_by>1</updated_by>
            <created>2014-12-06 00:00:00</created>
            <created_by>1</created_by>
        </Manufacturer>
    </data>
</response>

Marke anlegen [brands_add]

Funktion zum Anlegen eines Marke-Datensatzes in der Datenbank.
Bei erfolgreichem Eintrag in die Datenbank gibt das status-Element als Rückgabe-Code 200 zurück.

https://domain.com/api/v2.0/brands/brands_add[.json|.xml]?sid=XXXXXX&name=Marken-Name[&info=InfoText][&image=Bilddatei[.png|.jpg]][&status=1]

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": {
        "Manufacturer": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Brand>
            <id>1</id>
        </Brand>
    </data>
</response>

Marke bearbeiten [brands_edit]

Funktion zum Bearbeiten eines Marke-Datensatzes in der Datenbank. Nach erfolgreichem Bearbeiten gibt das status-Element als Rückgabe-Code 200 zurück. Von den optionalen Parametern muss zumindest ein Wert übergeben werden. Alle anderen Werte werden vom System vorbelegt mit vorhandenen Werten oder mit Default-Werten.

https://domain.com/api/v2.0/brands/brands_edit[.json|.xml]?sid=XXXXXX&id=1[&name=Marken-Name][&info=InfoText][&image=Bilddatei.[.png|.jpg]][&status=1]

{
    "status": {
        "code": "200",
        "msg": "OK"
    },
    "data": {
        "Brand": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Brand>
            <id>1</id>
        </Brand>
    </data>
</response>

Marke löschen [brands_delete]

Funktion zum Löschen einer Marke aus der Datenbank. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/brands/brands_delete[.json|.xml]?sid=XXXXXX&id=1

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": {
        "Brand": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Brand>
            <id>1</id>
        </Brand>
    </data>
</response>

Distributoren

Distributoren anlegen [distributors_add]

Funktion zum Anlegen eines Distributoren-Datensatzes in der Datenbank. Bei erfolgreichem Eintrag in die Datenbank gibt das status-Element als Rückgabe-Code 200 zurück.

https://domain.com/api/v2.0/distributors/distributors_add[.json|.xml]?sid=XXXXXX&name=Distributoren-Name&info=InfoText&image=Bilddatei.png&status=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Distributor ": {
            "id": "3"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Distributor>
            <id>3</id>
        </Distributor>
    </data>
</response>

Distributoren löschen [distributors_delete]

Funktion zum Löschen eines Distributors aus der Datenbank. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/distributors/distributors_delete[.json|.xml]?sid=XXXXXX&id=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Distributor ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Distributor>
            <id>1</id>
        </Distributor>
    </data>
</response>

Distributoren bearbeiten [distributors_edit]

Funktion zum Bearbeiten eines Distributoren-Datensatzes in der Datenbank. Nach erfolgreichem Bearbeiten gibt das status-Element als Rückgabe-Code 200 zurück. Von den optionalen Parametern muss zumindest ein Wert übergeben werden. Alle anderen Werte werden vom System vorbelegt mit vorhandenen Werten oder mit Default-Werten.

https://domain.com/api/v2.0/distributors/distributors_edit[.json|.xml]?sid=XXXXXX&id=1[&name=Distributoren-Name][&info=InfoText][&image=Bilddatei.png][&status=1]

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Distributor ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Distributor>
            <id>1</id>
        </Distributor>
    </data>
</response>

Distributoren Auflistung [distributors_lookup]

Die Distributoren Auflistungs-API dient dem Auflisten der im System erfassten Distributoren nach verschiedenen Kriterien oder in einer Gesamtauflistung.

https://domain.com/api/v2.0/distributors/distributors_lookup[.json|.xml]?sid=XXXXXX[&id][&search=SUCHTEXT]

{
    " status ": {   
        " code ": 200,
        "msg": {
            "200": "OK"
        }
    },
    " data ": [
        {
            " Distributor ": {
                "id": "1",
                " name ": " Firma ABC GmbH ",
                " slug ": " firma_abc_gmbh ",
                " info ": " Distributor Info zur Firma ABC GmbH ",
                " image ": " abc_gmbh .png",
                " status ": true ,
                " updated ": "2014-11-18 22:02:10",
                " updated_by ": "1",
                " created ": "2014-11-18 00:00:00",
                " created_by ": "1"
            }
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Distributor>
            <id>1</id>
            <name>Firma ABC GmbH</name>
            <slug>firma_abc_gmbh</slug>
            <info>Distributor Info zur Firma ABC GmbH</info>
            <image>abc_gmbh.png</image>
            <status>1</status>
            <updated>2014-11-18 22:02:10</updated>
            <updated_by>1</updated_by>
            <created>2014-11-18 00:00:00</created>
            <created_by>1</created_by>
        </Distributor>
    </data>
</response>

Wiederverkäufer

Wiederverkäufer anlegen [resellers_add]

Funktion zum Anlegen eines Wiederverkäufer-Datensatzes in der Datenbank. Bei erfolgreichem Eintrag in die Datenbank gibt das status-Element als Rückgabe-Code 200 zurück.

https://domain.com/api/v2.0/resellers/resellers_add[.json|.xml]?sid=XXXXXX&name=Wiederverkaeufer-Name&info=InfoText&logo=Logo.png&image=Bilddatei.png&status=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Reseller ": {
            "id": "3"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg<OK</msg>
    </status>
    <data>
        <Reseller>
            <id>3</id>
        </Reseller>
    </data>
</response>

Wiederverkäufer löschen [resellers_delete]

Funktion zum Löschen eines Wiederverkäufers aus der Datenbank. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/resellers/resellers_delete[.json|.xml]?sid=XXXXXX&id=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Reseller ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Reseller>
            <id>1</id>
        </Reseller>
    </data>
</response>

Wiederverkäufer bearbeiten [resellers_edit]

Funktion zum Bearbeiten eines Wiederverkäufer-Datensatzes in der Datenbank. Nach erfolgreichem Bearbeiten gibt das status-Element als Rückgabe-Code 200 zurück. Von den optionalen Parametern muss zumindest ein Wert übergeben werden. Alle anderen Werte werden vom System vorbelegt mit vorhandenen Werten oder mit Default-Werten.

https://domain.com/api/v2.0/resellers/resellers_edit[.json|.xml]?sid=XXXXXX&id=1[&name=Wiederverkaeufer-Name][&info=InfoText][&logo=Logo.png][&image=Bilddatei.png][&status=1]

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Reseller ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Reseller>
            <id>1</id>
        </Reseller>
    </data>
</response>

Wiederverkäufer Auflistung [resellers_lookup]

Die Wiederverkäufer Auflistungs-API dient dem Auflisten der im System erfassten Wiederverkäufer nach verschiedenen Kriterien oder in einer Gesamtauflistung.

https://domain.com/api/v2.0/resellers/resellers_lookup[.json|.xml]?sid=XXXXXX[&id][&search=SUCHTEXT]

{
    " status ": {
        " code ": 200,
        " msg": {
            "200": "OK"
        }
    },
    " data ": [
        {
            " Reseller ": {
                " id": "1",
                " name ": " LuMAX W3B",
                " slug ": "lumax -w3b",
                " info ": " Reseller Info ",
                " logo ": "lumax -w3b.png",
                " image ": "lumax -w3b.png",
                " status ": true ,
                " updated ": "2015-01-05 18:31:15",
                " updated_by ": "1",
                " created ": "2015-01-05 18:31:15",
                " created_by ": "1"
            }
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Reseller>
            <id>1</id>
            <name>LuMAX W3B</name>
            <slug>lumax-w3b</slug>
            <info>Reseller Info</info>
            <logo>lumax-w3b.png</logo>
            <image>lumax-w3b.png</image>
            <status>1</status>
            <updated>2015-01-05 18:31:15</updated>
            <updated_by>1</updated_by>
            <created>2015-01-05 18:31:15</created>
            <created_by>1</created_by>
        </Reseller>
    </data>
</response>

Fachhändler

Fachhändler anlegen [retailers_add]

Funktion zum Anlegen eines Fachhändler-Datensatzes in der Datenbank. Bei erfolgreichem Eintrag in die Datenbank gibt das status-Element als Rückgabe-Code 200 zurück.

https://domain.com/api/v2.0/retailers/retailers_add[.json|.xml]?sid=XXXXXX&name=Fachhaendler-Name&info=InfoText&logo=Logo.png&image=Bilddatei.png&status=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Retailer ": {
            "id": "3"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Retailer>
            <id>3</id>
        </Retailer>
    </data>
</response>

Fachhändler löschen [retailers_delete]

Funktion zum Löschen eines Fachhändlers aus der Datenbank. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/retailers/retailers_delete[.json|.xml]?sid=XXXXXX&id=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Retailer ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Retailer>
            <id>1</id>
        </Retailer>
    </data>
</response>

Fachhändler bearbeiten [retailers_edit]

Funktion zum Bearbeiten eines Fachhändler-Datensatzes in der Datenbank. Nach erfolgreichem Bearbeiten gibt das status-Element als Rückgabe-Code 200 zurück. Von den optionalen Parametern muss zumindest ein Wert übergeben werden. Alle anderen Werte werden vom System vorbelegt mit vorhandenen Werten oder mit Default-Werten.

https://domain.com/api/v2.0/retailers/retailers_edit[.json|.xml]?sid=XXXXXX&id=1[&name=Fachhaendler-Name][&info=InfoText][&logo=Logo.png][&image=Bilddatei.png][&status=1]

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Retailer ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Retailer>
            <id>1</id>
        </Retailer>
    </data>
</response>

Fachhändler Auflistung [retailers_lookup]

Die Fachhändler Auflistungs-API dient dem Auflisten der im System erfassten Fachhändler nach verschiedenen Kriterien oder in einer Gesamtauflistung.

https://domain.com/api/v2.0/retailers/retailers_lookup[.json|.xml]?sid=XXXXXX[&id][&search=SUCHTEXT]

{
    " status ": {
        " code ": 200,
        " msg ": {
            "200": "OK"
        }
    },
    " data ": [
        {
            " Retailer ": {
                " id ": "1",
                " name ": " LuMAX W3B",
                " slug ": "lumax -w3b",
                " info ": " Info Neu",
                " logo ": "lumax -w3b.png",
                " image ": "lumax -w3b.jpg",
                " status ": true ,
                " updated ": "2015-01-05 16:48:03",
                " updated_by ": "1",
                " created ": "2014-12-29 14:01:13",
                " created_by ": "1"
            }
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Retailer>
            <id>1</id>
            <name>LuMAX W3B</name>
            <slug>lumax-w3b</slug>
            <info>Info Neu</info>
            <logo>lumax-w3b.png</logo>
            <image>lumax-w3b.jpg</image>
            <status>1</status>
            <updated>2015-01-05 16:48:03</updated>
            <updated_by>1</updated_by>
            <created>2014-12-29 14:01:13</created>
            <created_by>1</created_by>
        </Retailer>
    </data>
</response>

Produktgruppen

Produktgruppen anlegen [product_categories_add]

Funktion zum Anlegen eines Produktgruppen-Datensatzes in der Datenbank. Bei erfolgreichem Eintrag in die Datenbank gibt das status-Element als Rückgabe-Code 200 zurück.

https://domain.com/api/v2.0/product_categories/product_categories_add[.json|.xml]?sid=XXXXXX&parent_id=1&parent_name=Test&name=Produktgruppe-2&description=Das-ist-ein-Test&meta_description=Test&meta_keywords=Test&image=bild.png&status=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " ProductCagegory ": {
            "id": "3"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <ProductCategory>
            <id>3</id>
        </ProductCategory>
    </data>
</response>

Produktgruppen löschen [product_categories_delete]

Funktion zum Löschen einer Produkt-Kategorie aus der Datenbank. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/product_categories/product_categories_delete[.json|.xml]?sid=XXXXXX&id=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " ProductCategory ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <ProductCategory>
            <id>1</id>
        </ProductCategory>
    </data>
</response>

Produktgruppen bearbeiten [product_categories_edit]

Funktion zum Bearbeiten eines Produktgruppen Datensatzes in der Datenbank. Nach erfolgreichem Bearbeiten gibt das status-Element als Rückgabe-Code 200 zurück. Von den optionalen Parametern muss zumindest ein Wert übergeben werden. Alle anderen Werte werden vom System vorbelegt mit vorhandenen Werten oder mit Default-Werten.

https://domain.com/api/v2.0/product_categories/product_categories_edit[.json|.xml]?sid=XXXXXX&id=1[&parent_id=1][&parent_name=Test][&name=Produktgruppe-2][&description=Das-ist-ein-Test][&meta_description=Test][&meta_keywords=Test][&image=bild.png][&status=1]

{
    " status ": {
        " code ": "200",
        " msg ": "OK"
    },
    " data ": {
        " ProductCategory ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <ProductCategory>
            <id>1</id>
        </ProductCategory>
    </data>
</response>

Produktgruppen Auflistung [product_categories_lookup]

Die Produktgruppen Auflistungs-API dient dem Auflisten der im System erfassten Produktgruppen nach verschiedenen Kriterien oder in einer Gesamtauflistung.

https://domain.com/api/v2.0/product_categories/product_categories_lookup[.json|.xml]?sid=XXXXXX[&id=1][&search=SUCHTEXT}

{
    " status ": {
        " code ": 200,
        " msg ": {
            "200": "OK"
        }
    },
    " data ": [
        {
            " ProductCategory ": {
                "id": "1",
                " parent_id ": null ,
                " parent_name ": null ,
                " lft ": "1",
                " rght ": "22",
                " name ": " Cell Phones ",
                " slug ": "cell - phones ",
                " description ": "",
                " meta_description ": "",
                " meta_keywords ": "",
                " image ": "cell - phones .jpg",
                " status ": true ,
                " updated ": "2014-11-07 14:08:28",
                " updated_by ": "1",
                " created ": "2014-11-07 13:59:12",
                " created_by ": "1"
            }
        },
        {
            " ProductCategory ": {
                "id": "2",
                " parent_id ": "1",
                " parent_name ": " Cell Phones ",
                " lft ": "2",
                " rght ": "3",
                " name ": " Contract Cell Phones ",
                " slug ": " contract -cell - phones ",
                " description ": "",
                " meta_description ": "",
                " meta_keywords ": "",
                " image ": " contract -cell - phones . jpg",
                " status ": true ,
                " updated ": "2014-11-07 18:26:08",
                " updated_by ": "1",
                " created ": "2014-11-07 14:10:18",
                " created_by ": "1"
            }
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <ProductCategory>
            <id>1</id>
            <parent_id/>
            <parent_name/>
            <lft>1</lft>
            <rght>22</rght>
            <name>Cell Phones</name>
            <slug>cell-phones</slug>
            <description/>
            <meta_description/>
            <meta_keywords/>
            <image>cell-phones.jpg</image>
            <status>1</status>
            <updated>2014-11-07 14:08:28</updated>
            <updated_by>1</updated_by>
            <created>2014-11-07 13:59:12</created>
            <created_by>1</created_by>
        </ProductCategory>
    </data>
    <data>
        <ProductCategory>
            <id>2</id>
            <parent_id>1</parent_id>
            <parent_name>Cell Phones</parent_name>
            <lft>2</lft>
            <rght>3</rght>
            <name>Contract Cell Phones</name>
            <slug>contract-cell-phones</slug>
            <description/>
            <meta_description/>
            <meta_keywords/>
            <image>contract-cell-phones.jpg</image>
            <status>1</status>
            <updated>2014-11-07 18:26:08</updated>
            <updated_by>1</updated_by>
            <created>2014-11-07 14:10:18</created>
            <created_by>1</created_by>
        </ProductCategory>
    </data>
</response>

Produkt-Zustand

Neuen Produkt-Zustand anlegen [product_conditions_add]

Funktion zum Anlegen eines neuen Produkt-Zustandes. Ein Produkt-Zustand stellt Zustandseigenschaften des Produkt wie z.B.

• Neu - Produkt ist neu
• Gebraucht - Produkt ist gebraucht
• Vorführgerät - Produkt ist Austellungsstück
• und weitere selbst definierten Zustände dar.

Bei erfolgreichem Eintrag in die Datenbank gibt das status-Element als Rückgabe-Code 200 zurück

https://domain.com/api/v2.0/product_conditions/product_conditions_add[.json|.xml]?sid=XXXXXX&name=Reduziert&info=Info-Text&status=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " ProductCondition ": {
            "id": "3"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <ProductCondition>
            <id>3</id>
        </ProductCondition>
    </data>
</response>

Produkt-Zustand löschen [product_conditions_delete]

Funktion zum Löschen eines Produkt-Zustandes aus der Datenbank. Sollte der zu löschende Zustand noch einem Produkt zugeordnet sein, wird dieses Zustandsfeld beim entsprechenden Produkt geleert. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/product_conditions/product_conditionss_delete[.json|.xml]?sid=XXXXXX&id=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " ProductCondition ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <ProductCondition>
            <id>1</id>
        </ProductCondition>
    </data>
</response>

Produkt-Zustand bearbeiten [product_conditions_edit]

Funktion zum Bearbeiten eines Produkt-Zustand Datensatzes in der Datenbank. Nach erfolgreichem Bearbeiten gibt das status-Element als Rückgabe-Code 200 zurück. Von den optionalen Parametern muss zumindest ein Wert übergeben werden. Alle anderen Werte werden vom System vorbelegt mit vorhandenen Werten oder mit Default-Werten.

https://domain.com/api/v2.0/product_conditions/product_conditions_edit[.json|.xml]?sid=XXXXXX&id=1[&name=Reduziert][&info=Test-Info][&status=1]

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " ProductCondition ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <ProductCondition>
            <id>1</id>
        </ProductCondition>
    </data>
</response>

Auflistung der vorhandenen Produkt-Zustände [product_conditions_lookup]

Die Produkt-Zustands Auflistungs-API dient dem Auflisten der im Kassensystem erfassten Produkt-Zustände in einer Gesamtauflistung.

https://domain.com/api/v2.0/product_conditions/product_conditions_lookup[.json|.xml]?sid=XXXXXX[&id=1][&search=SUCHTEXT]

{
    " status ": {
        " code ": 200,
        " msg ": {
            "200": "OK"
        }
    },
    " data ": [
        {
            " ProductCondition ": {
                "id": "1",
                " name ": "New",
                " slug ": "new",
                " info ": "New Product ",
                " product_count ": "2",
                " status ": true ,
                " updated ": "2015-01-01 16:55:06",
                " updated_by ": "1",
                " created ": "2014-12-30 00:00:00",
                " created_by ": "1"
            }
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <ProductCondition>
            <id>1</id>
            <name>New</name>
            <slug>new</slug>
            <info>New Product</info>
            <product_count>2</product_count>
            <status>1</status>
            <updated>2015-01-01 16:55:06</updated>
            <updated_by>1</updated_by>
            <created>2014-12-30 00:00:00</created>
            <created_by>1</created_by>
        </ProductCondition>
    </data>
</response>

Produkte

Produkt anlegen [products_add]

Funktion zum Anlegen eines Produkt-Datensatzes in der Datenbank. Bei erfolgreichem Eintrag in die Datenbank gibt das status-Element als Rückgabe-Code 200 zurück.

https://domain.com/api/v2.0/products/products_add[.json|.xml]?sid=XXXXXX&sku=123456&ean=491828229292&imei=0&distributors=Distributor-1&retailers=Retailer-2&categories=Telefone&name=Apple%20iPhone&description_short=Kurzbeschreibung1&description_short_add=Zusatz&description_long=Lange%20Beschreibung&description_long_add=Zusatz&categorization_tags=Test&meta_keywords=Keyword1&meta_description=Telefon&image=produkt.png&weight=1.25&product_condition=new&tax_class=b2b&tax=19.2&price=599&shipment=6.10&stock=20&active_from=2014-01-01&active_to=2015-12-29&status=1

{
    " status ": {
        " code ": "200",
        " msg ": "OK"
    },
    " data ": {
        " Product ": {
            " id ": "3"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Product>
            <id>3</id>
        </Product>
    </data>
</response>

Produkt löschen [products_delete]

Funktion zum Löschen eines Produkts aus der Datenbank. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/products/products_delete[.json|.xml]?sid=XXXXXX&id=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Product ": {
          "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Product>
            <id>1</id>
        </Product>
    </data>
</response>

Produkt bearbeiten [products_edit]

Funktion zum Bearbeiten eines Produkt-Datensatzes in der Datenbank. Nach erfolgreichem Bearbeiten gibt das status-Element als Rückgabe-Code 200 zurück. Von den optionalen Parametern muss zumindest ein Wert übergeben werden. Alle anderen Werte werden vom System vorbelegt mit vorhandenen Werten oder mit Default-Werten.

https://domain.com/api/v2.0/products/products_edit[.json|.xml]?sid=XXXXXX&id=1[&sku=123456][&ean=4918282292929[&imei=0][&distributors=Distributor-1][&retailers=Retailer-2][&categories=Telefone][&name=Apple%20iPhone][&description_short=Kurzbeschreibung][&description_short_add=Zusatz][&description_long=Lange%20Beschreibung][&description_long_add=Zusatz]5[&categorization_tags=Test][&meta_keywords=Keyword1][&meta_description=Telefon][&image=produkt.png][&weight=1.25][&product_condition=new][&tax_class=b2b][&tax=19.2][&price=599][&shipment=6.10][&stock=20][&active_from=2014-01-01][&active_to=2015-12-29][&status=1]

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Product ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Product>
            <id>1</id>
        </Product>
    </data>
</response>

Produkt Auflistung [products_lookup]

Die Produkt Auflistungs-API dient dem Auflisten der im System erfassten Produkte nach verschiedenen Kriterien oder in einer Gesamtauflistung.

https://domain.com/api/v2.0/products/products_lookup[.json|.xml]?sid=XXXXXX[&id=1][&search=SUCHTEXT]

{
    " status ": {
        " code ": 200,
        " msg ": {
            "200": "OK"
        }
    },
    " data ": [
        {
            " Product ": {
                "id": "1",
                " brand_id ": "1",
                " brand_name ": " Apple ",
                "sku": "apple -iphone -6-smartphone -gold -123456789",
                "ean": "0888462062947",
                " imei ": "123456789",
                " distributors ": null ,
                " retailers ": null ,
                " categories ": " Cell , Phones , Contract ",
                " name ": " Apple iPhone 6 Smartphone gold ",
                " slug ": "apple -iphone -6-smartphone - gold ",
                " description_short ": "11,9 cm (4,7 Zoll )",
                " description_short_add ": "",
                " description_long ": " Lang , breit , ultra .",
                " description_long_add ": "",
                " categorization_tags ": " apple , iphone 6",
                " meta_keywords ": " apple , iphone 6",
                " meta_description ": " apple , iphone 6",
                " image ": "apple -iphone -6-smartphone - gold . jpg",
                " weight ": "281,00",
                " product_condition_id ": "1"
                " product_tax_class_id ": "1",
                "tax": "19,00",
                " price ": "704,99",
                " shipment ": "0,00",
                " product_delivery_time_id ": "1",
                " stock ": "1",
                " active_from ": "2014-11-11",
                " active_to ": "2014-12-31",
                " status ": true ,
                " views ": "0",
                " updated ": "2014-11-11 20:07:19",
                " updated_by ": "1",
                " created ": "2014-11-11 20:07:19",
                " created_by ": "1"
            }
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Product>
            <id>1</id>
            <brand_id>1</brand_id>
            <brand_name>Apple</brand_name>
            <sku>apple-iphone-6-smartphone-gold-123456789</sku>
            <ean>0888462062947</ean>
            <imei>123456789</imei>
            <distributors/>
            <retailers/>
            <categories>Cell,Phones,Contract</categories>
            <name>Apple iPhone 6Smartphone gold</name>
            <slug>apple-iphone-6-smartphone-gold</slug>
            <description_short>11,9 cm (4,7 Zoll)</description_short>
            <description_short_add/>
            <description_long>Lang, breit, ultra.</description_long>
            <description_long_add/>
            <categorization_tags>apple, iphone 6</categorization_tags>
            <meta_keywords>apple, iphone 6</meta_keywords>
            <meta_description>apple, iphone 6</meta_description>
            <image>apple-iphone-6-smartphone-gold.jpg</image>
            <weight>281,00</weight>
            <product_condition_id>1</product_condition_id>
            <product_tax_class_id>1</product_tax_class_id>
            <tax>19,00</tax>
            <price>704,99</price>
            <shipment>0,00</shipment>
            <product_delivery_time_id>1</product_delivery_time_id>
            <stock>1</stock>
            <active_from>2014-11-11</active_from>
            <active_to>2014-12-31</active_to>
            <status>1</status>
            <views>0</views>
            <updated>2014-11-11 20:07:19</updated>
            <updated_by>1</updated_by>
            <created>2014-11-11 20:07:19</created>
            <created_by>1</created_by>
        </Product>
    </data>
</response>

Lager

Lagerbestand zubuchen [stock_incoming]

Funktion zum Einbuchen/Zubuchen von Lagerbestand.

Lagerbestand ausbuchen [stock_outgoing]

Funktion zum Ausbuchen von Lagerbestand.

Kunden

Kunden anlegen [customers_add]

Kunden löschen [customers_delete]

Funktion zum Löschen eines Kunden aus der Datenbank. Die Funktion gibt bei Erfolg 200 OK zurück.

https://domain.com/api/v2.0/customers/customers_delete[.json|.xml]?sid=XXXXXX&id=1

{
    " status ": {
        " code ": "200",
        "msg": "OK"
    },
    " data ": {
        " Customer ": {
            "id": "1"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Customer>
            <id>1</id>
        </Customer>
    </data>
</response>

Kunden bearbeiten [customers_edit]

Kunden Auflistung [customers_lookup]

Die Kunden Auflistungs-API dient dem Auflisten der im System erfassten Kunden nach verschiedenen Kriterien oder in einer Gesamtauflistung.

https://domain.com/api/v2.0/customers/customers_lookup[.json|.xml]?sid=XXXXXX[&id=1][&search=SUCHTEXT]

{
    " status ": {
        " code ": 200,
    "msg": {
        "200": "OK"
    }
    },
    " data ": [
        {
            " Kunde ": {
                "id": "1",
                TODO TODO TODO
                " created_by ": "1"
            }
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <Product>
            <id>1</id>
            TODO TODO TODO
        </Product>
    </data>
</response>

Warenkorb

Auf dieser Seite folgt die API-Beschreibung zu den Warenkorb-Schnittstellen.

Glossar

• API
  Als API bezeichnet man eine Programmierschnittstelle zur Anwendungsprogrammierung, der von einem Softwaresystem anderen Programmen zur Anbindung an das System zur Verfügung gestellt wird.
• Element
  In XML dient ein Elment - oder auch Tag - dazu, Daten zu klassifizieren und strukturieren.
• GET
  siehe HTTP-GET.
• Header
  Ein Header bezeichnet die Kopfdaten und somit Zusatzinformationen zu den eigentlichen Nutzdaten (z.b. Zeichercodierung, Länge Nutzdaten, Quelle, Ziel).
• HTTP
  Hypertext Transfer Protocol ist ein zustandsloses Protokoll zur Übertragung von Daten auf der Anwendungsschicht.
• HTTP-GET
  Beim GET werden die Daten in der URL nach einem einleitenden Fragezeichen übergeben. Weitere Werte sind durch Semikolons voneinander getrennt.
• HTTP-POST
  Beim POST befinden sich die Daten nicht in der URL, sondern im eigentlichen Rumpfteil nach dem Header. Dadurch ist es möglich größere Datenmengen zu übertragen.
• HTTP-Statuscode
  siehe Statuscode.
• JSON
  JavaScript Object Notation ist ein kompaktes Datenformat in einer einfach lesbaren Textform zum Zweck des Datenaustauschs zwischen Anwendungen.
• Kasse
  Eine Kasse ist die Zahlungsstelle und dient der Abwicklung von Zahlungsvorgängen mit Bargeld, Schecks, Geldkarten und Kreditkarten.
• MIME
  Die Multipurpose Internet Mail Extensions (MIME) sind Erweiterungen des RFC 822 / RFC 5322.
• PHP
  PHP steht für Hypertext Processor und ist eine Scriptsprache mit an C angelehnten Syntaxm, hauptsächlich zur Erstellung von Webanwendungen.
• POST
  siehe HTTP-POST.
• REST
  Representational State Transfer (REST) bezeichnet ein Programmierparadigma für Webanwendungen.
• SID (Session-ID)
  Session-ID ist eine zur Zeit der Nutzung eindeutige Identifikationskennung die einen Benutzer und seine Sitzung eindeutig indentifiziert.
• Statuscode
  Jede HTTP-Anfrage liefert einen eindeutigen Statuscode zurück. Dieser gibt Informationen darüber ob eine Anfrage erfolgreich war.
• Timeout
  Ein Timeout bezeichnet die Aktion oder den Fehler, die / der nach der Überschreitung einer festgelegten Zeit ausgelöst wird.
• URI
  Uniform Resource Identifier (URI) ist ein Identifikator und besteht aus einer Zeichenfolge, die zur Identifizierung einer abstrakten oder physischen Ressource (z.B. einer Webseite) dient.
• UTF-8
  UTF-8 ist die Abkürzung für 8-Bit UCS Transformation Form und steht für die am weitesten verbreitete Kodierung für Unicode-Zeichen.
• XML
  Die Extensible Markup Language (XML) ist eine Auszeichnungssprache zur Darstellung hierarchisch strukturierter Daten in Textform.

APITEMPLATE [api_name]

BESCHREIBUNG

https://domain.com/api/v2.0/CONTROLLER/CONTROLLER_ACTION[.json|.xml]?sid=XXXXXX&[KEY=VAL1]&[KEY=VAL2]&[...]

{
    "status": {
        "code": 200,
        "msg": {
            "200": "OK"
        }
    },
    "data": {
        "id": "2",
        "sid": "mbqjukp3pal08smeoaug72hlq1"
    }
}

<response>
    <status>
        <code>200</code>
        <msg>OK</msg>
    </status>
    <data>
        <id>2</id>
        <sid>f097p3k7ikaeso8ho8cqs70m10</sid>
    </data>
</response>

Impressum

Kasse I/O - REST API Dokumentation

Marks Software GmbH
Holunderweg 20
D-29664 Walsrode

Tel.: +49 (0) 51 61 / 78 75 356

E-Mail: info@marks-software.de
Internet: http://www.marks-software.de/

Vertretungsberechtigter Geschäftsführer: Lukas Marks
Umsatzsteuer-Identifikationsnummer gemäß § 27 a Umsatzsteuergesetz: DE315790961
Steuernummer: 41/205/08357
Handelsregister: AG Walsrode, HRB 207013
Inhaltlich Verantwortlicher gemäß § 10 Absatz 3 MDStV: Lukas Marks

Copyright 2014 - 2018 Marks Software GmbH

Alle Recht vorbehalten.