Lieferschein-Positionen

Alle Posi­tio­nen eines Lie­fer­scheins auflisten

GET /api/delivery-note-items?delivery_note_id={delivery_note_id}

Lie­fer­schein­po­si­tio­nen kön­nen immer nur für einen bestimm­ten Lie­fer­schein zurück­ge­ge­ben wer­den.
Des­halb ist delivery_note_id ein Pflichtparameter.

<?xml version="1.0" encoding="UTF-8"?>
<delivery-note-items type="array">
    <delivery-note-item>
        ...
    <delivery-note-item>
    <delivery-note-item>
        ...
    <delivery-note-item>
</delivery-note-items>

Ein­zelne Posi­tion aufrufen

GET /api/delivery-note-items/{id}
<?xml version="1.0" encoding="UTF-8"?>
<delivery-note-item>
    <id type="integer">1</id>
    <article_id type="integer">123</article_id>
    <delivery_note_id type="integer">1</delivery_note_id>
    <position type="integer">1</position>
    <unit>Stück</unit>
    <quantity type="float">5.2</quantity>
    <title>Visitenkarten</title>
    <description>Wunderschöne 4c Visitenkarten</description>
</delivery-note-item>

Posi­tion erstellen

POST /api/delivery-note-items

Lie­fer­schein­po­si­tio­nen kön­nen nur für Lie­fer­scheine mit Sta­tus Ent­wurf (DRAFT) erstellt werden.

XML-Element Beschrei­bung Typ Default-Wert Pflicht­feld
delivery_note_id ID des Lie­fer­schein INT ja (nicht aber bei der Lie­fer­schei­nen­er­stel­lung)
article_id ID des Arti­kels INT
unit Ein­heit ALNUM
quan­tity Menge FLOAT 0.0
title Titel ALNUM
descrip­tion Beschrei­bung ALNUM

Die Lie­fer­schein­po­si­tion wird nach eve­nu­tell bereits beste­hen­den Posi­tio­nen angefügt.

<delivery-note-item>
    <delivery_note_id>1</delivery_note_id>
    <unit>Stück</unit>
    <quantity>5.2</quantity>
    <title>Visitenkarten</title>
    <description>Wunderschöne 4c Visitenkarten</description>
</delivery-note-item>
<?xml version="1.0" encoding="UTF-8"?>
<delivery-note-item>
    <id type="integer">1</id>
    <article_id />
    <delivery_note_id type="integer">1</delivery_note_id>
    <created>2007-12-13T12:12:00+01:00</created>
    <position type="integer">1</position>
    <unit>Stück</unit>
    <quantity type="float">5.2</quantity>
    <title>Visitenkarten</title>
    <description>Wunderschöne 4c Visitenkarten</description>
</delivery-note-item>

Posi­tion bearbeiten

PUT /api/delivery-note-items/{id}

Hier gel­ten die sel­ben Para­me­ter wie beim Anle­gen, aller­dings kann der ver­knüpfte Lie­fer­schein (delivery_note_id) nicht mehr geän­dert wer­den.
Lie­fer­schein­po­si­tio­nen kön­nen nur für Lie­fer­scheine mit Sta­tus Ent­wurf (DRAFT) bear­bei­tet werden.

<delivery-note-item>
    <unit>Meter</unit>
    <quantity>8.5</quantity>
</delivery-note-item>

Posi­tion löschen

DELETE /api/delivery-note-items/{id}

Beim Löschen von Lie­fer­schein­po­si­tio­nen wird posi­tion für alle ver­blei­ben­den Posi­tio­nen neu ver­ge­ben (ohne die Sor­tie­rung zu ändern), um die evtl. ent­stan­dene Lücke wie­der zu fül­len.
Lie­fer­schein­po­si­tio­nen kön­nen nur für Lie­fer­scheine mit Sta­tus Ent­wurf (DRAFT) gelöscht werden.