DeliveryApi

The following resources are applicable:

/api/v1/delivery/{deliveryid}/document

Mount Point: /restapi/services/rest/api/v1/delivery/{deliveryid}/document

POST

Legt Dateien in die Dokumentenablage eines Lieferscheins ab.

Die maximale Upload-Größe ist derzeit auf 500KiB gestellt

Parameters

name description type default
deliveryid Id des Lieferscheins path
userid ist der beim Logon ermittelte "Token" query
type ist die Belegart (optional) query
keywords sind die Schlagworte des Dokuments (optional) query
grouping ist die Gruppierung (optional) query
securitylevel ist die Sicherheitsstufe (optional) query

Request Body

element: (custom)
media types: */*
application/xml
application/json

ist der multipart/form-data des Requests, der den/die Dokumente enthält

GET

Parameters

name description type default
userid (no documentation provided) query
deliveryid (no documentation provided) path
documentcnr (no documentation provided) query

Response Body

element: (custom)
media types: */*
application/xml
application/json

(no documentation provided)

/api/v1/delivery/{deliveryid}/document/list

Mount Point: /restapi/services/rest/api/v1/delivery/{deliveryid}/document/list

GET

Parameters

name description type default
userid (no documentation provided) query
deliveryid (no documentation provided) path

Response Body

element: documentInfoEntryList
media types: application/xml
application/json

(no documentation provided)

/api/v1/delivery/customerdeliverables/{customercnr}

Mount Point: /restapi/services/rest/api/v1/delivery/customerdeliverables/{customercnr}

GET

Die Liste aller angelegten Kundenlieferscheine des Kunden

Der Kunde wird durch seine "Kundennummer" identifiziert. Es werden nur jene Lieferscheine angezeigt, für dessen Lager der Anwender eine Berechtigung hat.

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query
customercnr Die Kundennummer muss immer angegeben werden. Achtung: customerCNr ist die dem Kunden zugewiesene Kundennummer. Sie ist nicht mit der customerId zu verwechseln! path

Response Body

element: deliveryEntryList
media types: application/xml
application/json

eine Liste aller im Status ANGELEGT befindlichen Kundenlieferscheine der Kundennummer

/api/v1/delivery/customerdeliverables/{customercnr}/{deliveryid}

Mount Point: /restapi/services/rest/api/v1/delivery/customerdeliverables/{customercnr}/{deliveryid}

GET

Die Liste der Positionen dieses Kundenlieferscheins

Der Lieferschein muss sich noch im Status ANGELEGT befinden, ansonsten gibt es eine entsprechende Fehlermeldung (Expectation failed, falscher Status)

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query
customercnr Die Kundennummer muss immer angegeben werden. Achtung: customerCNr ist die dem Kunden zugewiesene Kundennummer. Sie ist nicht mit der customerId zu verwechseln! path
deliveryid die Id des Kundenlieferscheins path
itemid ist die (optionale) Id des Artikels auf den die Positionsinfo eingeschränkt werden soll query
itemCnr ist die (optionale) Artikelnummer auf den die Positionsinfo eingeschränkt werden soll query

Response Body

element: deliveryPositionEntryList
media types: application/xml
application/json

eine Liste der Positionen des angegebenen Lieferscheins. Wurde itemId oder itemCnr angegeben, enthält die Liste nur noch diese eine entsprechende Position

/api/v1/delivery/customerposition

Mount Point: /restapi/services/rest/api/v1/delivery/customerposition

POST

Eine neue freie Lieferscheinposition für einen Kundenlieferschein erstellen

Bei Bedarf wird ein neuer Lieferschein angelegt. Dies wird dadurch mitgeteilt, dass positionEntry.deliveryId null ist. Sollen für den Lieferschein weitere Positionen erfasst werden, muss die - hier erhaltene - deliveryId in den folgenden Anfragen angegeben werden. Die Kundennummer - customerNr - muss immer angegeben werden. Achtung: customerNr ist die dem Kunden zugewiesene Kundennummer. Sie ist nicht mit der customerId zu verwechseln!

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query

Request Body

element: createItemCustomerDeliveryPositionEntry
media types: application/xml
application/json

die neuen Lieferscheinpositionsdaten

Response Body

element: createdDeliveryPositionEntry
media types: application/xml
application/json

die neuen Lieferscheinpositionsdaten

/api/v1/delivery/deliverable

Mount Point: /restapi/services/rest/api/v1/delivery/deliverable

GET

Parameters

name description type default
hvtoken (no documentation provided) header
userid (no documentation provided) query
deliveryid (no documentation provided) query
deliveryCnr (no documentation provided) query

Response Body

element: deliverableDeliveryEntry
media types: application/xml
application/json

(no documentation provided)

/api/v1/delivery/forecastcustomerposition

Mount Point: /restapi/services/rest/api/v1/delivery/forecastcustomerposition

POST

Eine neue freie Lieferscheinposition für einen Kundenlieferschein erstellen

Bei Bedarf wird ein neuer Lieferschein angelegt. Dies wird dadurch mitgeteilt, dass positionEntry.deliveryId null ist. Sollen für den Lieferschein weitere Positionen erfasst werden, muss die - hier erhaltene - deliveryId in den folgenden Anfragen angegeben werden. Die Kundennummer - customerNr - muss immer angegeben werden. Achtung: customerNr ist die dem Kunden zugewiesene Kundennummer. Sie ist nicht mit der customerId zu verwechseln!

Es wird automatisch zuerst nach offenen Forecast-Positionen für den angegbenen Artikel gesucht. Sollte es solche nicht geben, wird nach offenen Auftragspositionen gesucht. Gibt es auch keine Auftragsfunktionen wird abgebrochen.

Sollte der Fall eintreten, dass die zu buchende Menge auf mehrere Belegpositionen (Forecast-Position, Auftragposition) aufgeteilt wird, wird nur die letzte erzeugte Lieferscheinposition und somit auch nur die dort gebuchte Menge als Ergebnis gebracht.

Im HELIUM V Server muss die entsprechende Zusatzfunktionsberechtigung freigeschaltet sein.

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query

Request Body

element: createItemCustomerDeliveryPositionEntry
media types: application/xml
application/json

die neuen Lieferscheinpositionsdaten

Response Body

element: createdDeliveryPositionEntry
media types: application/xml
application/json

die neuen Lieferscheinpositionsdaten

/api/v1/delivery/list

Mount Point: /restapi/services/rest/api/v1/delivery/list

GET

Eine Liste aller Lieferscheine gemäß den Filterkriterien

Parameters

name description type default
userid userId ist der beim Logon ermittelte "token" query
limit (optional) die maximale Anzahl von Einträgen die ermittelt werden sollen query
startIndex (optional) der StartIndex query
filter_cnr (optional) schränkt die Ausgabe auf Lieferscheine ein, die diesen Teil der Lieferscheinnummer beinhalten query
filter_status (optional) die zu filternden Status (aus DeliveryDocumentStatus) getrennt durch Komma query
filter_ordercnr (optional) schränkt die Ausgabe auf Lieferscheine ein, die mit diesem Auftrag verknüpft sind query
filter_customer (optional) schränkt die Ausgabe auf Lieferscheine ein, die für diesen Kundennamen ausgestellt wurden query

Response Body

element: deliveryEntryList
media types: application/xml
application/json

eine (leere) Liste von Lieferscheinen

/api/v1/delivery/position

Mount Point: /restapi/services/rest/api/v1/delivery/position

DELETE

Die angegebene LieferscheinpositionId löschen

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query
positionid die zu entfernende LieferscheinpositionId query

POST

Eine neue Lieferscheinposition zu einem freien Lieferschein hinzufügen

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query

Request Body

element: createItemDeliveryPositionEntry
media types: application/xml
application/json

die hinzuzufügenden Lieferscheinpositionsdaten

Response Body

element: createdDeliveryPositionEntry
media types: application/xml
application/json

die neu erzeugte Lieferscheinposition

/api/v1/delivery/position/{positionid}

Mount Point: /restapi/services/rest/api/v1/delivery/position/{positionid}

PUT

Eine bestehende freie Lieferscheinposition abändern

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query
positionid die Id der abzuändernden Lieferscheinposition path

Request Body

element: createItemDeliveryPositionEntry
media types: application/xml
application/json

die neuen Lieferscheinpositionsdaten

Response Body

element: createdDeliveryPositionEntry
media types: application/xml
application/json

die neuen Lieferscheinpositionsdaten

/api/v1/delivery/positionfromorder

Mount Point: /restapi/services/rest/api/v1/delivery/positionfromorder

POST

Eine auftragsbezogene Lieferscheinposition erzeugen/ändern

Gibt es für diese Auftragsposition noch keine Lieferscheinposition, wird diese neu erzeugt. Ansonsten werden die Daten aus positionEntry zu der bereits bestehenden Lieferscheinposition hinzugefügt.

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query

Request Body

element: createDeliveryPositionEntry
media types: application/xml
application/json

die zusätzlichen Positionsdaten

Response Body

element: createdDeliveryPositionEntry
media types: application/xml
application/json

Informationen zu der (neu) entstandenen Lieferscheinposition

DELETE

Die durch die AuftragspositionId definierte Lieferscheinposition entfernen

Es wird (derzeit) nur dann die Lieferscheinposition entfernt, wenn es genau eine(!) Lieferscheinposition für die angegebene Auftragsposition gibt

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query
deliveryid den Lieferschein den es betrifft query
orderpositionid die zu dieser AuftragspositionId zugehörige Lieferscheinposition query

/api/v1/delivery/print

Mount Point: /restapi/services/rest/api/v1/delivery/print

GET

Den Lieferschein als "geliefert" betrachten und ausdrucken

Der Lieferschein wird auf dem Drucker ausgedruckt, der dem Arbeitsplatz (des mobilen Endgerätes) zugewiesen worden ist

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query
deliveryid die Id des Lieferscheins query
sort (no documentation provided) query

Response Body

element: (custom)
media types: */*
application/xml
application/json

deliveryId sofern der Lieferschein berechnet, aktiviert und gedruckt werden konnte

/api/v1/delivery/printdispatchlabel

Mount Point: /restapi/services/rest/api/v1/delivery/printdispatchlabel

GET

Das Versandetikett des Lieferscheins ausdrucken

Das Versandetikett wird auf dem Drucker ausgedruckt, der dem Arbeitsplatz (des mobilen Endgerätes) zugewiesen worden ist

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query
deliveryid die Id des Lieferscheins query
activateDelivery wenn true wird der Lieferschein auch berechnet und aktiviert query

Response Body

element: (custom)
media types: */*
application/xml
application/json

deliveryId sofern der Lieferschein optional berechnet/aktiviert und gedruckt werden konnte

/api/v1/delivery/printgoodsissuelabel

Mount Point: /restapi/services/rest/api/v1/delivery/printgoodsissuelabel

GET

Das Warenausgangsetikett des Lieferscheins ausdrucken

Das Warenausgangsetikett wird auf dem Drucker ausgedruckt, der dem Arbeitsplatz (des mobilen Endgerätes) zugewiesen worden ist

Parameters

name description type default
userid ist der beim Logon ermittelte "token" query
deliveryid die Id des Lieferscheins query
activateDelivery wenn true wird der Lieferschein auch berechnet und aktiviert query

Response Body

element: (custom)
media types: */*
application/xml
application/json

deliveryId sofern der Lieferschein optional berechnet/aktiviert und gedruckt werden konnte