TradebyteAddOrders

Mit dem Step TradebyteAddOrders können Aufträge im Tradebyte angelegt werden.

• 1 Vorbereitung
• 2 Kopfdaten
  • 2.1 Pflichtfelder des Kopf-Datastores
  • 2.2 Kanal- und Auftragsspezifische Informationen
  • 2.3 Rechnungsadresse
  • 2.4 Versandadresse
  • 2.5 Versandinformationen
  • 2.6 Zahlinformationen
  • 2.7 Fehlerauswertung
• 3 Positionsdaten
  • 3.1 Pflichtfelder des Positions-Datastores
  • 3.2 Positions-Informationen

Vorbereitung

Um Aufträge im Tradebyte anlegen zu können, müssen vorher 2 Datastores angelegt werden. Für die Kopfdaten muss ein Master-Datastore mit dem Schema TradebyteAddOrdersOrderHeadPayloadProvider und ein mit dem Master verknüpfterChild-Datastore mit dem Schema TradebyteAddOrdersOrderItemsPayloadProvider angelegt werden. Neue Aufträge müssen im updateProcessingStatus UNPROCESSED vorliegen. Nach erfolgreicher Bearbeitung wird der Status auf PROCESSED_SUCCESS geändert. Fehlerhafte Aufträge werden in den Status PROCESSED_ERROR gesetzt.

Die Kopf- und Positionsdaten werden in die entsprechenden Datastores geschrieben und mittels master_identifier miteinander verknüpft.

Kopfdaten

Diese Daten werden in den Master-Datastore im Status UNPROCESSED geschrieben.

Pflichtfelder des Kopf-Datastores

(zur internen Zuordnung, werden nicht an Tradebyte übertragen)

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
identifier	55	Eindeutiger Bezeichner des Auftrags (in der Regel die eindeutige Auftragsnummer)	ja	Text
master_identifier	55	Eindeutiger Bezeichner des Auftrags (in der Regel ebenfalls die eindeutige Auftragsnummer)	ja	Text		Dient der Zuordnung von Kopf- und Positionsdaten

Kanal- und Auftragsspezifische Informationen

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
ORDER_DATE	2020-11-30	Datum der Kundenbestellung, falls diese vom Kanal übermittelt wird. Andernfalls wird von TB.One das Datum Imports eingetragen	ja	Text	YYYY-MM-DD
CHANNEL_ID	303-6862327	Eindeutige Auftragsnummer des Vertriebskanals	ja	Text
CHANNEL_SIGN	otde	Kanalkennzeichen	nein	Text
CHANNEL_NO	303-6862327	Auftragsnummer des Vertriebskanals (muss nicht eindeutig sein, z.B. Auftragsnummer eines Webshops). Je nach Vertriebskanal können CHANNEL_ID und CHANNEL_NO auch den gleichen Wert enthalten.	nein	Text
APPROVED	1	Freigabekennzeichen des Auftrags	ja	Ganzzahl	1 (bestätigter Auftrag) 0 (schwebend)
CUSTOMER_COMMENT	Kundenbemerkung	Kundenbemerkung zum Auftrag. Falls in Ihrem Shop diese Option angeboten wird, können Sie hier den Kundenkommentar an den Händler weiterleiten.	nein	Text
ITEM_COUNT	1	Anzahl der Bestellpositionen. Wird gegen die im Auftrag übergebenen Positionen geprüft. Bei Abweichungen wird der Auftrag zur Sicherheit abgelehnt.	ja	Ganzzahl
TOTAL_ITEM_AMOUNT	120.00	Gesamtsumme der Auftragspositionen Brutto (ohne Versand- und andere Zusatzkosten). Wird gegen die einzelnen übergebenen Werte geprüft. Bei Abweichungen wird der Auftrag zur Sicherheit abgelehnt.	ja	Dezimalzahl

Rechnungsadresse

Daten der Rechnungsanschrift

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
SELL_TO_CHANNEL_NO	5607865	Nummer des Kunden beim jeweiligen Vertriebskanal	nein	Text
SELL_TO_TITLE	Herr	Anrede oder Titel	nein	Text	zB. Herr / Frau
SELL_TO_FIRSTNAME	Max	Vorname des Kunden	ja	Text		Wenn SELL_TO_FIRSTNAME und SELL_TO_LASTNAME angegeben werden, sollte SELL_TO_NAME leer bleiben.
SELL_TO_LASTNAME	Mustermann	Nachname des Kunden	ja	Text
SELL_TO_NAME	Max Mustermann	Wenn die Namensinformationen nicht getrennt nach Vor- und Nach name erfasst wird, können Sie auch den zusammengesetzten Namen des Kunden übergeben (getrennt durch ein Leerzeichen). TB.One versucht, den Namen aufzuschlüsseln.	nein	Text	Vorname Nachname	Wenn SELL_TO_NAME angegeben wird, sollten SELL_TO_FIRSTNAME und SELL_TO_LASTNAME leer bleiben.
SELL_TO_NAME_EXTENSION	Prof.	Namenszusatz	nein	Text	zB. akademischer Titel
SELL_TO_STREET_NO	Teststraße 5	Straße und Hausnummer	ja	Text
SELL_TO_STREET_EXTENSION	c/o Martin Mustermann	Adresszusatz	nein	Text	zB. c/o (care of - wohnhaft bei)
SELL_TO_ZIP	12345	Postleitzahl	ja	Text
SELL_TO_CITY	Teststadt	Stadt	ja	Text
SELL_TO_COUNTRY	DE	Ländercode ALPHA 2	ja	Text
SELL_TO_PHONE_PRIVATE	123456	Private Telefonnummer	nein	Text
SELL_TO_PHONE_OFFICE	123456	Geschäftliche Telefonnummer	nein	Text
SELL_TO_PHONE_MOBILE	123456	Mobilnummer	nein	Text
SELL_TO_EMAIL	x@y.de	E-Mail-Adresse	nein	Text
SELL_TO_BIRTHDAY	1980-01-01	Geburtsdatum des Kunden	nein	Text	YYYY-MM-DD
SELL_TO_VAT_ID	DE999999999	Umsatzsteueridentifikationsnummer	nein	Text

Versandadresse

Daten der Versandadresse (nur anzugeben wenn Rechnungs- und Lieferanschrift abweichen)

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
SHIP_TO_CHANNEL_NO	5607865	Nummer des Kunden beim jeweiligen Vertriebskanal	nein	Text
SHIP_TO_TITLE	Herr	Anrede oder Titel	nein	Text	zB. Herr / Frau
SHIP_TO_FIRSTNAME	Max	Vorname des Kunden	ja	Text		Wenn SHIP_TO_FIRSTNAME und SHIP_TO_LASTNAME angegeben werden, sollte SHIP_TO_NAME leer bleiben.
SHIP_TO_LASTNAME	Mustermann	Nachname des Kunden	ja	Text
SHIP_TO_NAME	Max Mustermann	Wenn die Namensinformationen nicht getrennt nach Vor- und Nach name erfasst wird, können Sie auch den zusammengesetzten Namen des Kunden übergeben (getrennt durch ein Leerzeichen). TB.One versucht, den Namen aufzuschlüsseln.	nein	Text	Vorname Nachname	Wenn SHIP_TO_NAME angegeben wird, sollten SHIP_TO_FIRSTNAME und SHIP_TO_LASTNAME leer bleiben.
SHIP_TO_NAME_EXTENSION	Prof.	Namenszusatz	nein	Text	zB. akademischer Titel
SHIP_TO_STREET_NO	Teststraße 5	Straße und Hausnummer	ja	Text
SHIP_TO_STREET_EXTENSION	c/o Martin Mustermann	Adresszusatz	nein	Text	zB. c/o (care of - wohnhaft bei)
SHIP_TO_ZIP	12345	Postleitzahl	ja	Text
SHIP_TO_CITY	Teststadt	Stadt	ja	Text
SHIP_TO_COUNTRY	DE	Ländercode ALPHA 2	ja	Text
SHIP_TO_PHONE_PRIVATE	123456	Private Telefonnummer	nein	Text
SHIP_TO_PHONE_OFFICE	123456	Geschäftliche Telefonnummer	nein	Text
SHIP_TO_PHONE_MOBILE	123456	Mobilnummer	nein	Text
SHIP_TO_EMAIL	x@y.de	E-Mail-Adresse	nein	Text
SHIP_TO_BIRTHDAY	1980-01-01	Geburtsdatum des Kunden	nein	Text	YYYY-MM-DD
SHIP_TO_VAT_ID	DE999999999	Umsatzsteueridentifikationsnummer	nein	Text

Versandinformationen

Die Versandinformationen sind optional.

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
SHIPMENT_CARRIER_PARCEL_TYPE	DHL_STANDART	Angabe des Pakettyps.	nein	Text		Die Pakettypen müssen vorher mit Tradebyte abgesprochen werden.
SHIPMENT_IDCODE_SHIP	1234567890	DHL-Sendungsnummern	nein	Text
SHIPMENT_IDCODE_RETURN	1234567899	DHL-Sendungsnummern der Retoure	nein	Text
SHIPMENT_ROUTING_CODE	2134807501640	Leitcode (DHL) der Kundenadresse	nein	Text
SHIPMENT_PRICE	3.95	Versandkosten	nein	Text
SHIPMENT_IS_EXPRESS	1	Expressversand-Kennzeichen	nein	Text	1 (Expressversand) 0 (Normalversand)

Zahlinformationen

Die Zahlinformationen sind optional.

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
PAYMENT_TYPE		Zahlart	nein	Text		Abhängig vom Vertriebskanal
PAYMENT_COSTS	10.99	Zahlkosten	nein	Dezimalzahl
PAYMENT_PAYMENT_TRANSACTION_ID	1AB23456C7890123D	Transaktionsnummer der Zahlung	nein	Text	z.B. Freigabecode zum Anstoß der Zahlung
PAYMENT_PAYMENT_TRANSACTION_NR	1AB23456C7890123D	Zusätzliches Kennzeichen zur Identifizierung der Zahlung	nein	Text	z.B: PayPal Kundennummer
PAYMENT_PAYMENT_TRANSACTION_NAME	Martin Mustermann	Evtl. abweichender Kundenname für Zahlung	nein	Text
PAYMENT_PAYMENT_DATA		Zusätzliche Informationen zur Zahlung	nein	Text
PAYMENT_DIRECTDEBIT_ACCOUNTNAME	Max Mustermann	Name des Kontoinhabers	nein	Text
PAYMENT_DIRECTDEBIT_ACCOUNTNR	0648489890	Kontonummer	nein	Text
PAYMENT_BANKNAME	Musterbank	Name der Bank	nein	Text
PAYMENT_BANKCODE	50010517	Bankleitzahl	nein	Text
PAYMENT_IBAN	DE12500105170648489890	IBAN	nein	Text
PAYMENT_BIC	BELADEBE	BIC	nein	Text

Fehlerauswertung

Falls ein Auftrag nicht angelegt werden kann wird in die entsprechende Zeile im Feld ORDER_RESPONSE_ERROR_MESSAGE die von Tradebyte ausgegebene Fehlermeldung gespeichert.

Bei erfolgreicher Auftragsanlage wird die vergebene interne ID des Auftrages in der Spalte ORDER_RESPONSE_TB_ID abgelegt.

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
ORDER_RESPONSE_TB_ID		Interne Tradebyte OrderID des neu angelegten Auftrags			Diese Felder müssen leer bleiben.	Werden bei der Auftragsanlage befüllt.
ORDER_RESPONSE_ERROR_MESSAGE		Fehlermeldung im Fall eines abgelehnten Auftrags

Positionsdaten

Diese Daten werden in den Child-Datastore geschrieben. Der Status ist in diesem Fall irrelevant.

Pflichtfelder des Positions-Datastores

(zur internen Zuordnung, werden nicht an Tradebyte übertragen)

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
identifier	55_123123	Eindeutiger Bezeichner des Auftragsposition (in der Regel die Kombination von Auftragsnummer und Artikelnummer)	ja	Text	Auftragsnummer_Artikelnummer
master_identifier	55	Eindeutiger Bezeichner des Auftrags (in der Regel die eindeutige Auftragsnummer)	ja	Text		Dient der Zuordnung von Kopf- und Positionsdaten

Positions-Informationen

Name	Beispiel	Beschreibung	Pflichtfeld	Datentyp	Werte	Hinweise
ITEM_CHANNEL_ID	1	Positionsnummer des Vertriebskanals	ja	Text
ITEM_SKU	4060029565719	Artikelnummer aus TB.One.	ja	Text
ITEM_CHANNEL_SKU	00257241717043	externe Artikelnummer des Custom-Kanals	nein	Text
ITEM_EAN	4060989565719	EAN	nein	Text
ITEM_QUANTITY	2	Bestellmenge	ja	Ganzzahl
ITEM_BILLING_TEXT	Longshirt (40, Blau)	Rechnungstext der Auftragsposition	nein	Text
ITEM_TRANSFER_PRICE		Artikelpreis netto (optional)	nein	Dezimalzahl
ITEM_ITEM_PRICE	60.00	Verkaufspreis Brutto	ja	Dezimalzahl
ITEM_DELIVERY_TIME	5	Lieferzeit in Werktagen	nein	Ganzzahl
ITEM_SERVICES		Positionsbezogene Services	nein	Text	z.B. Geschenkverpackung	In Abspreche mit Tradebyte

Inputs

Das sind die Optionen, mit denen man den Step konfigurieren kann.

Name	Datentyp	Beschreibung	Pflichtfeld	Werte
account	ACCOUNT	Tradebyte Account	Nein
TradebyteOrderHead	DATASTORE		Nein
TradebyteOrderHead Folder	STRING		Nein
Channel ID	STRING	The ID of the channel from which the orders are fetched from.	Nein

Outputs

Das sind die Ergebnisse des Steps, die von nachfolgenden Steps, nach der Ausführung verwendet werden können.

Name	Datentyp	Beschreibung	Pflichtfeld	Werte
created Orders	SPREADSHEET		Ja
	Folgende Felder sind im Output enthalten: Feld Datentyp Beschreibung Pflichtfeld Standardwert datastorename SINGLE Nein folder SINGLE Nein identifier SINGLE Nein identifier2 SINGLE Nein identifier3 SINGLE Nein datastoretags MULTIPLEVALUE Nein parent_identifier SINGLE Nein master_folder SINGLE Nein master_identifier SINGLE Nein
failed Orders	SPREADSHEET		Ja
	Folgende Felder sind im Output enthalten: Feld Datentyp Beschreibung Pflichtfeld Standardwert datastorename SINGLE Nein folder SINGLE Nein identifier SINGLE Nein identifier2 SINGLE Nein identifier3 SINGLE Nein datastoretags MULTIPLEVALUE Nein parent_identifier SINGLE Nein master_folder SINGLE Nein master_identifier SINGLE Nein
responseContent von TB	SPREADSHEET		Ja