WebService Calls > Options for Growth

Beschreibung

Aktualisierung des Auftragsstatus. Der Call kann verwendet werden um, mit wenig Daten, den Auftragsstatus zu setzen und rudimentäre Paketdaten und Zahlungshinweise zu übergeben. Zudem muss sich der Nutzer keine Gedanken über die verschiedenen Auftragsworkflows (Vorauskasse, Nachnahme oder Abholung der Ware) innerhalb Speed4Trade CONNECT machen. Es reicht aus, den Status wie z.B. SHIPPED oder PAID zu übergeben und die Logik des Call setzt dann dementsprechend den Auftragsstatus im richtigen Workflow.

Beispiel Request

Code

<mandator_id>1</mandator_id>

<order_id>1820955</order_id>

<order_number>100</order_number>

<order_number_prefix>T2-</order_number_prefix>

<external_order_number_1>Externe Auftragsnummer 1</external_order_number_1>

<external_order_number_2>Externe Auftragsnummer 2</external_order_number_2>

<transaction_id_1>TransactionID1</transaction_id_1>

<transaction_id_2>TransactionID2</transaction_id_2>

<marketplace_order_id_1>MarketplaceNumber1</marketplace_order_id_1>

<marketplace_order_id_2>MarketplaceNumber2</marketplace_order_id_2>

<status>SHIPPED</status>

<shipping_informations>

<shipping_information>

<tracking_number>32123461123</tracking_number>

<return_number>132654</return_number>

<shipping_provider_identifier>DHL</shipping_provider_identifier>

<shipping_provider_external_id>dhl_ext</shipping_provider_external_id>

<dispatch_type_identifier>STANDARD</dispatch_type_identifier>

<dispatch_type_external_id>standard_ext</dispatch_type_external_id>

<shipping_date>2020-11-27T10:00:00</shipping_date>

</shipping_information>

</shipping_informations>

<payment_informations>

<payment_information>

<payment_instructions>Zahlungshinweis</payment_instructions>

<depositor>Speed4Trade GmbH</depositor>

<bic>GENOD3F1WE1</bic>

<bank_name>Bankbezeichnung</bank_name>

<external_id>Externe ID</external_id>

<transaction_id>Transaktionsnummer</transaction_id>

<payment_status_id>1</payment_status_id>

<payment_status_identifier>unpaid</payment_status_identifier>

<payment_reason>Verwendungszweck</payment_reason>

<url>www.speed4trade.com/payment</url>

</payment_information>

</payment_informations>

<acknowledgement_informations>

<acknowledgement_information>

<export_time>2019-01-26T15:42:00.000+02:00</export_time>

</acknowledgement_information>

</acknowledgement_informations>

</order>

</request>

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: „updateOrderStatus“
version	Attribut von request. Legt die Version der Anfrage fest.	1	integer	Fester Wert: „1.0.0“
order	Wrapper-Element, das die Daten des Auftrags zusammenfasst.	0..N	Element
significant_key	Attribut von order. Gibt an welches Feld zur Identifikation des Auftrags verwendet wird. Hier kann aus verschiedenen Auftragsnummern gewählt werden. Wichtig ist, das die gewählte Nummer in ihrem System eindeutig ist.	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 von order. In diesem Feld kann eine beliebige ID angegeben werden die später im zugehörigen Report-Block der Response-Daten wieder erscheint.	0..1	string	Hinweis
mandator_id	Mandanten-ID	1	integer
order_id	Softwarespezifische AuftragsID	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	Transaktions-ID 1	0..1	string
transaction_id_2	Transaktions-ID 2	0..1	string
marketplace_order_id_1	Marktplatzauftrags-ID 1	0..1	string
marketplace_order_id_2	Marktplatzauftrags-ID 2	0..1	string
status	Auftragsstatus	1	string	Mögliche Werte: "FETCHED" \| "PAID" \| "SHIPPED" \| "CANCELED"
shipping_informations	Wrapper-Element, das alle Paketdaten zusammenfasst.	0..1	Element	Hinweis
shipping_information	Wrapper-Element, das die Daten eines Paketes beinhaltet.	1..N	Element
tracking_number	Paketverfolgungsnummer	1	string
return_number	Retourennummer	0..1	string
shipping_provider_identifier	Versanddienstleister nach Bezeichnung	0..1	string	Hinweis
shipping_provider_external_id	Versanddienstleister nach externer ID	0..1	string	Hinweis
dispatch_type_identifier	Versandart nach Bezeichnung	0..1	string
dispatch_type_external_id	Versandart nach externer ID	0..1	string
shipping_date	Versanddatum des Pakets	0..1	dateTime
payment_informations	Wrapper-Element, das alle Zahlungsinformationen zusammenfasst.	0..1	Element	Hinweis
payment_information	Wrapper-Element, das einen Datensatz an Zahlungsinformationen beinhaltet.	1..N	Element
payment_instructions	Zahlungshinweis	0..1	string
depositor	Zahlungsempfänger	0..1	string
bic	BIC	0..1	string
bank_name	Name der Bank	0..1	string
external_id	Externe ID des Zahlungshinweises	0..1	string
iban	IBAN	0..1	string
transaction_id	Transaktionsnummer	0..1	string
payment_status_id	Bezahlstatus des Auftrag via ID	0..1	integer
payment_status_identifier	Bezahlstatus des Auftrag via Bezeichner	0..1	string
payment_reason	Verwendungszweck	0..1	string
url	Link mit weiteren Informationen zum Zahlungshinweis.	0..1	string
acknowledgement_informations	Wrapper-Element, das alle acknowledgement_information zusammenfasst	0..1	Element	Hinweis
acknowledgement_information	Wrapper-Element, das einen Datensatz acknowledgement_information beinhaltet	1..N	Element
export_time	Exportzeitpunkt an das externe System. Dies dokumentiert wann das externe System den Auftrag erfolgreich abgerufen hat. Wird zusammen mit Status "ACKNOWLEDGED" verwendet.	1	date	Hinweis

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: „updateOrderStatus“
version	Attribut von response. Legt die Version der Anfrage fest.	1	integer	Fester Wert: „1.0.0“
report	Information über die ausgeführte Operation. Für jedes Order-Element aus dem Request wird ein Report zurückgegeben.	0..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 im zugehörigen Report-Block des Requests angegebene reference_id falls diese angegeben wurde.	0..1	string
error_description	Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert	0..1	string
order	Wrapper-Element, das die Informationen eines Auftrags zusammenfasst.	1..N	Element
order_id	ID des Auftrags	1	integer
mandator_id	Mandanten ID	1	integer
order_number_prefix	Auftragsnummernpräfix	1	string
order_number	Auftragsnummer	1	integer
external_order_number_1	Externe Auftragsnummer 1	1	string
external_order_number_2	Externe Auftragsnummer 2	1	string
warning_message	Warnung zu der durchgeführten Operation. Wird nur ausgegeben wenn ein Auftragsstatus übersprungen wurde, also z.B. wenn ein Vorauskasse-Auftrag direkt, ohne vorher eine Zahlung zu buchen, auf versendet gesetzt wird.	0..1	string

Hinweise

•Die reference_id wird nicht in Speed4Trade CONNECT gespeichert und ist damit auch nicht fest an den betroffenen Auftrag gebunden. Die selbe ID kann daher in unterschiedlichen Calls problemlos wiederverwendet werden. Sie dient lediglich zur schnellen Zuordnung eines Reports in den Response-Daten zu einem order-Block aus den Request-Daten.

•Die Informationen zum Versand oder zur Bezahlung können nur dann mit übergeben und im Auftrag gesetzt werden, wenn der entsprechende Auftragsstatus mit übergeben wird. Zahlungsinformationen werden bei dem Status "PAID" gesetzt. Versandinformationen beim Status "SHIPPED". Die übergebenen Zahlungs- oder Versandinformationen werden ignoriert wenn der Auftrag bereits den entsprechenden Status hat.

•Es können mehrere Sätze an Versand- und Zahlungsinformationen für einen Auftrag übergeben werden. Eine Bearbeitung oder Entfernung der bestehenden Zahlungs- und Versandinformationen ist über diesen Call nicht möglich. Für eine umfangreichere Manipulation dieser Informationen verwenden Sie bitte den Call updateOrders.

•Aufträge die bereits storniert sind oder den Status "umgruppiert" haben, können mit diesem Call nicht geändert werden.

•Sollen Paketdaten übergeben werden, muss der Versanddienstleister entweder via shipping_provider_identifier oder shipping_provider_external_id übergeben werden.

•Hat der Auftrag noch keine Zahlungsart zugewiesen, dann kann der Auftrag nicht über updateOrderStatus bearbeitet werden. Dies ist nötig da der Auftragsworkflow von der Zahlungsart abhängt.

•Der Status "ACKNOWLEDGED" wird verwendet um das WaWi-Exportflag zu setzen. Wenn das Flag gesetzt ist, wird der jeweilige Auftrag nichtmehr vom WaWi-Export berücksichtigt, wenn dieser über die Oberfläche ausgeführt wird. Desweiteren sehen die Nutzer in der Oberfläche den Bestätigungszeitpunkt der WaWi. Der Status kann zusammen mit dem Feld export_time innerhalb eines acknowledgement_information Elementes übergeben werden. Die export_time dokumentiert die erfolgreiche Auftragsübergabe mit einem Zeitstempel. Wird kein Element acknowledgement_informations angegeben, so wird die aktuelle Zeit verwendet.

•Verwenden Sie weder marketplace_order_id_1 noch marketplace_order_id_2 als significant_key für eBay Aufträge, da diese Felder ihre Werte nach Abschluss des Bestellvorgangs ändern.

Änderungsübersicht

Version	Änderungsbeschreibung
4.7.26	Integration des Calls updateOrderStatus.
4.9.7	Neuer Status "ACKNOWLEDGED" und zugehöriges Element acknowledgement_informations hinzugefügt.
4.9.28	Neuer Hinweistext zu marketplace_order_id_1 und marketplace_order_id_2 bei eBay Aufträgen.
4.10.48	Für Pakete können das Versanddatum (shipping_date) und die Retourennummer (return_number) übergeben werden.
4.12.30	Für Pakete kann die Versandart (via dispatch_type_identifier oder dispatch_type_external_id) übergeben werden.