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:
| Parameter | Beschreibung |
|---|
| article_number | Artikelnummer |
|---|
| title | Bezeichnung des Artikel |
|---|
| description | Beschreibung des Artikel |
|---|
| currency_code | Währungscode nach ISO |
|---|
| unit_id | ID der zugewiesenen Einheit |
|---|
| tags | Kommaseparierte Liste der Schlagworte |
|---|
| supplier_id | ID 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-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|
| number_pre | Artikelnummer-Präfix | ALNUM | Wert aus Einstellungen | |
|---|
| number | Laufende Nummer | INT | nächste freie Artikelnummer | |
|---|
| number_length | Mindestlänge der Artikelnummer (wird mit führenden Nullen aufgefüllt) | INT | Wert aus den Einstellungen | |
|---|
| title | Titel | ALNUM | leerer String | |
|---|
| description | Beschreibung | ALNUM | leerer String | |
|---|
| sales_price | Preis | FLOAT | 0.0 | |
|---|
| sales_price2 | Preis für Kunden der Preisgruppe 2. Wird kein Preis angegeben, gilt der Normalpreis. | FLOAT | | |
|---|
| sales_price3 | Preis für Kunden der Preisgruppe 3. Wird kein Preis angegeben, gilt der Normalpreis. | FLOAT | | |
|---|
| sales_price4 | Preis für Kunden der Preisgruppe 4. Wird kein Preis angegeben, gilt der Normalpreis. | FLOAT | | |
|---|
| sales_price5 | Preis für Kunden der Preisgruppe 5. Wird kein Preis angegeben, gilt der Normalpreis. | FLOAT | | |
|---|
| currency_code | Währung | ISO-Währungscode | Standard-Währung aus Einstellungen | |
|---|
| unit_id | ID der verknüpften Einheit | INT | null | |
|---|
| tax_id | ID des verknüpften Steuersatzes | INT | null | |
|---|
| purchase_price | Einkauspreis | FLOAT | null | |
|---|
| purchase_price_net_gross | Preisbasis des Einkaufspreises (Brutto- oder Netto-Preise) | ALNUM („NET“, „GROSS“) | NET | |
|---|
| supplier_id | ID der verknüpften Lieferanten | INT | null | |
|---|
| type | Typ (Produkt/Dienstleistung) | ENUM (PRODUCT/SERVICE) | | |
|---|
<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}
