Alle Arti­kel auflisten

GET /api/articles
<?xml version="1.0" encoding="UTF-8"?>
<articles type="array">
    <article>
        ...
    </article>
    <article>
        ...
    </article>
</articles>

Über Para­me­ter kann gefil­tert werden:

GET /articles?title=bildbearbeitung

Lis­tet alle Arti­kel auf, die “bild­be­ar­bei­tung” in der Bezeich­nung haben. Groß– und Klein­schrei­bung wird igno­riert.
Fol­gende Para­me­ter ste­hen zur Verfügung:

Para­me­ter Beschrei­bung
article_number Arti­kel­num­mer
title Bezeich­nung des Artikel
descrip­tion Beschrei­bung des Artikel
currency_code Wäh­rungs­code nach ISO
unit_id ID der zuge­wie­se­nen Ein­heit

Ein­zel­nen Arti­kel aufrufen

GET /api/articles/{id}
<?xml version="1.0" encoding="UTF-8"?>
<article>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <article_number>ART123</client_number>
    <number type="integer">123</number>
    <number_pre>KD</number_pre>
    <title>Bildbearbeitung</title>
    <description>Das ist eine Beschreibung</description>
    <sales_price type="float">123.45</sales_price>
    <currency_code>EUR</currency_code>
    <unit_id type="integer">123</unit_id>
    <tax_id type="integer">1</tax_id>
</article>

Arti­kel erstellen

POST /api/articles
XML-Element Beschrei­bung Typ Default-Wert Pflicht­feld
number_pre Artikelnummer-Präfix ALNUM Wert aus Ein­stel­lun­gen
num­ber Lau­fende Nummer INT nächste freie Artikelnummer
number_length Min­dest­länge der Arti­kel­num­mer (wird mit füh­ren­den Nul­len aufgefüllt) INT Wert aus den Ein­stel­lun­gen
title Titel ALNUM lee­rer String
descrip­tion Beschrei­bung ALNUM lee­rer String
sales_price Preis FLOAT 0.0
currency_code Wäh­rung ISO-Währungscode Standard-Währung aus Ein­stel­lun­gen
unit_id ID der ver­knüpf­ten Ein­heit INT null
tax_id ID des ver­knüpf­ten Steu­er­sat­zes INT null
<article>
    <title>Retusche</title>
    <sales_price>12.34</sales_price>
    <currency_code>USD</currency_code>
    <unit_id>123</unit_id>
</article>
<?xml version="1.0" encoding="UTF-8"?>
<article>
    <id type="integer">1234</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <number_pre>ART</number_pre>
    <number type="integer">1235</number>
    <title>Retusche</title>
    <description></description>
    <sales_price type="float">12.34</sales_price>
    <currency_code>USD</currency_code>
    <unit_id type="integer">123</unit_id>
    <tax_id type="integer">1</tax_id>
</article>

Arti­kel Bearbeiten

PUT /api/articles/{id}
<article>
    <description>Exessive Photoshop-Manipulationen</description>
</article>

Arti­kel löschen

DELETE /api/articles/{id}