Alle Artikel auflisten

GET /api/articles
<?xml version="1.0" encoding="UTF-8"?>
<articles type="array" page="1" per_page="100" total="2">
    <article>
        ...
    </article>
    <article>
        ...
    </article>
</articles>

Über Parameter kann gefiltert werden:

GET /articles?title=bildbearbeitung

Listet alle Artikel auf, die „bildbearbeitung“ in der Bezeichnung haben. Groß- und Kleinschreibung wird ignoriert.
Folgende Parameter stehen zur Verfügung:

ParameterBeschreibung
article_numberArtikelnummer
titleBezeichnung des Artikel
descriptionBeschreibung des Artikel
currency_codeWährungscode nach ISO
unit_idID der zugewiesenen Einheit
tagsKommaseparierte Liste der Schlagworte
supplier_idID des zugewiesenen Lieferanten

Einzelnen Artikel 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>
    <number_length type="integer">0</number_length>
    <title>Bildbearbeitung</title>
    <description>Das ist eine Beschreibung</description>
    <sales_price type="float">123.45</sales_price>
    <sales_price2 type="float">110.45</sales_price>
    <sales_price3 type="float">99.99</sales_price>
    <sales_price4 type="float"></sales_price>
    <sales_price5 type="float"></sales_price>
    <currency_code>EUR</currency_code>
    <unit_id type="integer">123</unit_id>
    <tax_id type="integer">1</tax_id>
    <purchase_price type="float"></purchase_price>
    <purchase_price_net_gross>NET</purchase_price_net_gross>
    <supplier_id type="integer">1</supplier_id>
</article>

Artikel erstellen

POST /api/articles
XML-ElementBeschreibungTypDefault-WertPflichtfeld
number_preArtikelnummer-PräfixALNUMWert aus Einstellungen
numberLaufende NummerINTnächste freie Artikelnummer
number_lengthMindestlänge der Artikelnummer (wird mit führenden Nullen aufgefüllt)INTWert aus den Einstellungen
titleTitelALNUMleerer String
descriptionBeschreibungALNUMleerer String
sales_pricePreisFLOAT0.0
sales_price2Preis für Kunden der Preisgruppe 2. Wird kein Preis angegeben, gilt der Normalpreis.FLOAT
sales_price3Preis für Kunden der Preisgruppe 3. Wird kein Preis angegeben, gilt der Normalpreis.FLOAT
sales_price4Preis für Kunden der Preisgruppe 4. Wird kein Preis angegeben, gilt der Normalpreis.FLOAT
sales_price5Preis für Kunden der Preisgruppe 5. Wird kein Preis angegeben, gilt der Normalpreis.FLOAT
currency_codeWährungISO-WährungscodeStandard-Währung aus Einstellungen
unit_idID der verknüpften EinheitINTnull
tax_idID des verknüpften SteuersatzesINTnull
purchase_priceEinkauspreisFLOATnull
purchase_price_net_grossPreisbasis des Einkaufspreises (Brutto- oder Netto-Preise)ALNUM („NET“, „GROSS“)NET
supplier_idID der verknüpften LieferantenINTnull
<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 type="integer">1235</number>
    <number_pre>ART</number_pre>
    <number_length type="integer">0</number_length>
    <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>

Artikel bearbeiten

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

Artikel löschen

DELETE /api/articles/{id}