Alle Artikel auflisten
GET /api/articles
Response: 200 OK<?xml version="1.0" encoding="UTF-8"?> <articles type="array"> <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 |
Einzelnen Artikel aufrufen
GET /api/articles/{id}
Response: 200 OK<?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> </article>
Artikel erstellen
POST /api/articles
Erstellt einen neuen Artikel. Keine Pflichtfelder.
XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|---|---|---|---|
number_pre | Artikelnummer-Präfix | ALNUM | Wert aus Einstellungen | |
number | Laufende Nummer | INT | nächste freie Artikelnummer | |
title | Titel | ALNUM | leerer String | |
description | Beschreibung | ALNUM | leerer String | |
sales_price | Preis | FLOAT | 0.0 | |
currency_code | Währung | ISO-Währungscode | Standard-Währung aus Einstellungen | |
unit_id | ID der verknüpften Einheit | INT | null |
Request Body<article> <title>Retusche</title> <sales_price>12.34</sales_price> <currency_code>USD</currency_code> <unit_id>123</unit_id> </article>
Response: 201 Created<?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> </article>
Artikel Bearbeiten
PUT /api/articles/{id}
Aktualisiert einen Artikel mit den übergebenen Parametern.
Request Body<article> <description>Exessive Photoshop-Manipulationen</description> </article>
Response: 200 OK
Artikel löschen
DELETE /api/articles/{id}
Löscht einen Artikel.
Response: 200 OK