WebService Calls > Options for Growth

Beschreibung

Analog zur Funktion in der Speed4Trade CONNECT Oberfläche, löst dieser Webservice Call den Belegdruck für Auftragsdokumente aus. Es können verschiedene Dokumententypen pro Auftrag generiert werden. Typische Verwendung wäre das Erstellen von Rechnungen, damit diese im Nachgang automatisiert an den Marktplatz übergeben werden können.

Beispiel Request

Code

Feldliste Request

Name	Beschreibung	Anz.	Typ	sonstiges
request	Root-Element der Anfrage	1	Element
method	Attribut von request. Name der Webservice-Methode.	1	string	Fester Wert: „updateOrderDocuments“
version	Attribut von request. Legt die Version der Anfrage fest.	1	integer	Fester Wert: „1.0.0“
orders	Wrapper-Element, das die Aufträge zusammenfasst.	1	Element
order	Wrapper-Element, das die Daten eines Auftrags zusammenfasst	1..N	Element
significant_key	Gibt an welches Feld zur Identifikation des Auftrags für den Belegdruck genutzt wird.	1	string	Feste Werte: "order_id", "order_number", "order_number_and_prefix", "external_order_number_1", "external_order_number_2", "marketplace_order_id_1", "marketplace_order_id_2", "transaction_id_1", "transaction_id_2"
reference_id	Optionales Attribut des Elements request. In diesem Feld kann eine beliebige ID angegeben werden die in den zugehörigen Response durchgereicht wird.	0..1	string
mandator_id	Mandanten-ID	1	integer
order_id	Auftrags-ID	0..1	integer
order_number	Auftragsnummer	0..1	integer
order_number_prefix	Auftragsnummernpräfix	0..1	string
external_order_number_1	Externe Auftragsnummer 1	0..1	string
external_order_number_2	Externe Auftragsnummer 2	0..1	string
transaction_id_1	Transaktionsnummer 1 zur Identifikation der Zahlung falls vorhanden.	0..1	string
transaction_id_2	Transaktionsnummer 2 zur Identifikation der Zahlung falls vorhanden.	0..1	string
marketplace_order_id_1	Marktplatzauftragsnummer 1	0..1	string
marketplace_order_id_2	Marktplatzauftragsnummer 2	0..1	string
documents	Wrapper-Element, das die zu erstellenden Dokumententypen eines Auftrags zusammenfasst.	1	Element
document	Wrapper-Element, das den Dokumententyp enthält.	1..N	Element
document_type	Dokumententyp	1	string	Mögliche Werte.

Beispiel Response

Code

Feldliste Response

Name	Beschreibung	Anz.	Typ	sonstiges
response	Root-Element der Antwort	1	Element
method	Attribut von response. Name der Webservice-Methode.	1	string	Fester Wert: „updateOrderDocuments“
version	Attribut von response. Legt die Version der Anfrage fest.	1	integer	Fester Wert: „1.0.0“
reports	Wrapper-Element, das die Reports der Auftragsdokumentgenerierung zusammenfasst.	1	Element
report	Information über den ausgeführten Belegdruck. Für jeden Auftrag aus dem Request wird ein eigener Report zurückgegeben.	1..N	Element
return_code	Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind.	1	integer	>= 0 = OK. < 0 = Fehler
reference_id	Optionales Attribut von report. Enthält die reference_id des zugehörigen Requests, falls diese dort angegeben wurde.	0..1	string	Hinweis
error_description	Falls Fehler aufgetreten sind, wird in error_description eine Fehlerbeschreibung zurückgeliefert	0..1	string
order	Wrapper-Element, das die Daten des Auftrags zusammenfasst	1	Element
mandator_id	Mandanten ID	1	integer
order_id	Auftrags-ID	0..1	integer
order_number	Auftragsnummer	0..1	integer
order_number_prefix	Auftragsnummernpräfix	0..1	string
external_order_number_1	Externe Auftragsnummer 1	0..1	string
external_order_number_2	Externe Auftragsnummer 2	0..1	string
transaction_id_1	Transaktionsnummer 1 zur Identifikation der Zahlung falls vorhanden.	0..1	string
transaction_id_2	Transaktionsnummer 2 zur Identifikation der Zahlung falls vorhanden.	0..1	string
marketplace_order_id_1	Marktplatzauftragsnummer 1	0..1	string
marketplace_order_id_2	Marktplatzauftragsnummer 2	0..1	string
documents	Wrapper-Element, das die Dokumente eines Auftrags zusammenfasst.	1	Element
document	Wrapper-Element, das die Informationen für ein Dokument enthält.	1	Element
local_doc_path	UNC-Pfad zum Dokumentenspeicherort. Der Dateiname weicht vom extern übergebenen Dateinamen ab, da die Software intern die Dokumente eigenständig verwaltet, abspeichert und benennt.	1	string
document_type	Dokumententyp	1	string	Mögliche Werte.
document_name	Originaler Dateiname des Dokuments inkl. Dateityp.	0..1	string

Wertetabelle(n)

Aufgeführte Werte gelten für das Feld document_type.

Wert	Belegtyp
offer	Angebot
order	Auftrag
invoice	Rechnung
delivery note	Lieferschein
return ticket	Rücksendeschein
cancellation invoice	Stornorechnung
shipping label	Versandlabel
parcel label 1	Paketschein 1
parcel label 2	Paketschein 2
sepa debit agreement	SEPA Lastschriftmandat (Kann nicht durch die Software generiert werden. Kann als Typ verwendet werden um bestehende Dokumente am Auftrag zu hinterlegen.)

Hinweise

•Rechnungsdokumente können nur einmal erzeugt werden. Wird versucht nochmal eine Rechnung zu erstellen, werden nur die Informationen der bestehenden Rechnung und der Return-Code 1 zurück gegeben.

•Die reference_id wird nicht in Speed4Trade CONNECT gespeichert und ist damit auch nicht fest an das betroffene Dokument gebunden. Dieselbe ID kann daher in unterschiedlichen Calls problemlos wiederverwendet werden. Sie dient lediglich zur schnellen Zuordnung eines Reports zu einem Request. Dies ist insbesondere dann nützlich wenn es bei der Verarbeitung eines oder mehrerer der übergebenen Datensätze zu Fehlern kommt. So kann dennoch die Fehlermeldung einem Request zugeordnet werden.

•Sollen externe Dokumente zu einem Auftrag hinzugefügt werden, ist der Call updateOrderDocuments zu benutzen.

•Bei Verwendung des significant_keys "order_number_and_prefix" müssen dann sowohl order_number als auch order_number_prefix übergeben werden.

•Im Falle eines Fehlers wird ein negativer Return-Code zurück gegeben und der XML-Knoten "error_description" mit einer zusätzlichen Fehlerbeschreibung wird ausgegeben. Die Informationen im Dokument-Knoten des Auftrags bleiben dann leer.

•Damit Speed4Trade CONNECT Dokumente generieren kann, müssen je Verkaufsaccount entsprechende Dokumentenvorlagen gepflegt sein.

Return-Codes

Für den Webservice-Call "createOrderDocuments" sind folgende Return-Codes möglich:

Code	Beschreibung
0	Das Dokument wurde erfolgreich erstellt.
1	Das Rechnungsdokument des Auftrags existiert bereits. Die Daten der existierenden Rechnung werden zurück gegeben. Dies ist kein Fehler-Return-Code.
-6	Für den Erstellung eines Auftragsdokuments zum angeforderten Dokumenttyp gibt es keine passenden Daten im Auftrag. Beispielsweise muss für die Generierung von Stornorechnungen bereits vorher ein Rechnungsdokument oder für die Erstellung eines Rücksendescheins eine Retourenposition im Auftrag existieren. Bitte beachten Sie die mitgelieferte Fehlerbeschreibung.
-7	Die Erstellung des Dokuments ist nicht möglich, weil beispielsweise beim Belegdruck selbst Fehler aufgetreten ist. Bitte beachten Sie die mitgelieferte Fehlerbeschreibung.
-8	Der Auftrag, zu dem das Dokument generiert werden soll, wurde nicht gefunden. Dieser Code kann auch bedeuten, dass bei der Prüfung, ob eine Rechnungs generiert werden darf, die bestehenden Auftragsdokumente nicht geladen werden konnten. Bitte beachten Sie die mitgelieferte Fehlerbeschreibung.
-10	Der Request enthält ungültige Daten, die eine Generierung des Dokuments/der Dokumente verhindern. Dies kann beispielsweise eine fehlende Mandanten-ID sein. Bitte beachten Sie die mitgelieferte Fehlerbeschreibung.

Änderungsübersicht

Version	Änderungsbeschreibung
4.12.23	Einführung des createOrderDocuments-Calls.