Formatbeschreibung für Deals (Kundenaufträge / Lieferantenbestellungen)

Die Daten für Deals (Kundenaufträge /Lieferantenbestellungen) stehen in den Ausgabeformaten XML und JSON zur Verfügung.

deal

Detailinformationen zu einem Auftrag/Bestellung:

Name	Pflichtfeld	Datentyp	Beschreibung
orderId	Ja	String (250)	Eindeutiger ITscope Key des Auftrags, der Bestellung
ownOrderId		String (250)	Eigene Auftrags oder Bestellnummer
customerOrderId		String (250)	Auftrags oder Bestellnummer des Endkunden
cartId	Ja	String (250)	Warenkorb-ID des Deals, in dem sich der Auftrag / die Bestellung befindet, nur in API 2.1 verfügbar
status	Ja	String (255)	Auftragsstatus in dem sich der Auftrag / die Bestellung befindet, siehe weiter unten: „Auftragsstatus / Bestellstatus Übersicht“ in diesem Beitrag weiter unten
statusMessage	Ja	String (8192)	zusätzliche textuelle Auftragsstatus / Bestellstatus Hinweise, teilweise direkt vom Verkäufer übermittelt
statusDate	Ja	Date	Letztes Änderungsdatum des Auftrag / der Bestellung
archived	Ja	Boolean	Gibt an, ob der Auftrag / die Bestellung archiviert wurde, nur in API 2.1 verfügbar
deeplink	Ja	String (2048)	Deeplink auf die ITscope.com Plattform, nur in API 2.1 verfügbar
imported		Boolean	Gibt an, ob der Auftrag / die Bestellung per API eingespielt wurde, nur in API 2.1 verfügbar
automated		Boolean	Gibt an, ob der Auftrag / die Bestellung per Bestellautomation (nur bei B2B Shops möglich) eingespielt wurde, nur in API 2.1 verfügbar
businessType		String (255)	Beschreibt den Typ des Auftrags / der Bestellung PURCHASE bei ausgehender Bestellung, SALE bei eingehendem Auftrag, nur in API 2.1 verfügbar
b2bOrder		Boolean	true gibt an, ob der Auftrag / die Bestellung ausschliesslich per B2B Shops eingegangen ist false gibt an, das der Auftrag / die Bestellung via ITscope Plattform eingegangen ist. Nur in API 2.1 verfügbar
vendor	Ja	vendor	Referenz auf das vendor-Objekt, den Verkäufer (interner Key, 1:1)
buyer		buyer	Referenz auf das buyer Objekt, den Käufer (interner Key, 1:1)
orders	Ja	List<order>	Details zur Liste der OpenTrans 2.1 ORDER Dokumente
orderresponses		List<orderresponse>	Details zur Liste der OpenTrans 2.1 ORDERRESPONSE Dokumente
dispatchnotifications		List<dispatchnotification>	Details zur Liste der OpenTrans 2.1 DISPATCHNOTIFICATION Dokumente
invoices		List<invoice>	Details zur Liste der OpenTrans 2.1 INVOICE Dokumente
payment		payment	Details zu Bezahlinformationen (nur bei B2B Shop Aufträgen/Bestellungen)

vendor

Verkäuferdaten zu einem Auftrag, Bestellung:

Name	Pflichtfeld	Datentyp	Beschreibung
name	Ja	String (255)	Name der Firma
supplier	Ja	supplier	Referenz auf das Lieferanten-Objekt; nur vorhanden, wenn diese Firma ein Lieferant ist

supplier

Lieferant einer Bezugsquelle:

Name	Pflichtfeld	Datentyp	Beschreibung
id	Ja	Long	Eindeutiger Key
name	Ja	String (255)	Bezeichner des Lieferanten
deeplink	Ja	String (2048)	URL, Link auf den Lieferanten innerhalb der ITscope Plattform
customerAccountNumber		String (255)	Kundennummer im Falle einer Partnerschaft. Kann als Filter verwendet werden, um zu ermitteln ob zu diesem Lieferanten eine Parnerschaft existiert
weeeRegNo		String (255)	Die WEEE-Reg.-Nr. des Lieferanten (nach §6 ElektroG)

buyer

Käuferdaten zu einem Auftrag, Bestellung:

Name	Pflichtfeld	Datentyp	Beschreibung
name	Ja	String (255)	Name der Käufer Firma
customer	Ja	customer	Referenz auf das Kunden-Objekt des Käufers

customer

Kundenobjekt des Käufers

Name	Pflichtfeld	Datentyp	Beschreibung
id	Ja	Integer	Eindeutige ITscope Id das Kundenobjekt des Käufers
name	Ja	String (255)	Name des Käufers im Kundenobjekt
deeplink	Ja	String (255)	URL, Deeplink auf den Kunden innerhalb der ITscope Plattform

orders

Details zur Liste der OpenTrans 2.1 ORDER Dokumente:

Name	Pflichtfeld	Datentyp	Beschreibung
transactionId		String (36)	ITscope Transaktions-ID
lastUpdate		Date	Datum des letzten Updates des Dokuments
documentUrl		String (255)	API Business Dokumente URL für den Download des Dokuments. Ist keine URL vorhanden,  hat diese Transaktion kein ORDER Dokument.

orderresponses

Details zur Liste der OpenTrans 2.1 ORDERRESPONSE Dokumente:

Name	Pflichtfeld	Datentyp	Beschreibung
transactionId		String (36)	ITscope Transaktions-ID
lastUpdate		Date	Datum des letzten Updates des Dokuments
documentUrl		String (255)	API Business Dokumente URL für den Download des Dokuments. Ist keine URL vorhanden, hat diese Transaktion kein ORDERRESPONSE Dokument, z.B. weil die Transaktion von Hand über das Verkaufsboard betätigt wurde.

dispatchnotifications

Details zur Liste der OpenTrans 2.1 DISPATCHNOTIFICATION Dokumente:

Name	Pflichtfeld	Datentyp	Beschreibung
transactionId		String (36)	ITscope Transaktions-ID
lastUpdate		Date	Datum des letzten Updates des Dokuments
documentUrl		String (255)	API Business Dokumente URL für den Download des Dokuments. Ist keine URL vorhanden hat diese Transaktion kein DISPATCHNOTIFICATION Dokument, z.B. weil die Transaktion von Hand über das Verkaufsboard betätigt wurde.

invoices

Details zur Liste der OpenTrans 2.1 INVOICE Dokumente:

Name	Pflichtfeld	Datentyp	Beschreibung
transactionId		String (36)	ITscope Transaktions-ID
lastUpdate		Date	Datum des letzten Updates des Dokuments
documentUrl		String (255)	API Business Dokumente URL für den Download des Dokuments. Ist keine URL vorhanden,  hat diese Transaktion kein INVOICE Dokument, z.B. weil die Transaktion von Hand über das Verkaufsboard betätigt wurde.

payment

Details zu Bezahlinformationen (nur bei B2B Shop Bestellungen)

Name	Pflichtfeld	Datentyp	Beschreibung
transactionId		String (36)	TransaktionsId des Zahlungsdienstleisters
lastUpdate		Date	Datum des letzten Updates des Dokuments

Auftragsstatus/ Bestellstatus Übersicht

API Status	Plattform Status	Beschreibung
PREPARING	Vorschlag	Der Auftrag / die Bestellung liegt als Vorschlag vor, nur der Einkäufer sieht diesen Auftrag / diese Bestellung
PAYMENT_AWAITING	Zahlung ausstehend	Bei einigen Aufträgen / Bestellungen ist es möglich eine Bezahlung vor dem Versenden durchzuführen. Dieser Status zeigt an, dass im Moment ein Bezahlvorgang stattfindet
PAYMENT_SUCCESSFUL	Zahlung erfolgreich	Bei einigen Aufträgen / Bestellungen ist es möglich eine Bezahlung vor dem Versenden durchzuführen. Dieser Status zeigt an die Zahlung erfolgreich war
TRANSMITTING	Wird gerade versandt	Der Auftrag / die Bestellung wird gerade technisch an das System des Verkäufers übermittelt
SENT	Abgeschickt	Der Auftrag / die Bestellung wurde zum Verkäufer gesendet
ARRIVED	Angekommen	Der Auftrag / die Bestellung ist beim Verkäufer angekommen
ARRIVED_WARNING	Angekommen mit Warnung	Der Auftrag / die wurde zum Teil vom Verkäufer bestätigt, d.h. nicht alle Bestellpositionen wurden bestätigt. Hinweise dazu stehen im Feld statusMessage z.B. einige Ihrer bestellten Positionen wurden storniert oder liegen auf Backorder. z.B. x Ihrer bestellten Positionen wurden storniert, oder ein konkreter Hinweis vom Verkäufer
PARTIALLY_PROCESSING	Auftrag teilweise bestätigt	Der Auftrag / die Bestellung wurde zum Teil vom Verkäufer bestätigt, d.h. nicht alle Positionen wurden bestätigt. Hinweise dazu stehen im Feld statusMessage z.B. einige Ihrer bestellten Positionen wurden storniert oder liegen auf Backorder. z.B. x Ihrer bestellten Positionen wurden storniert, oder ein konkreter Hinweis vom Verkäufer
PROCESSING	Auftrag bestätigt	Der Auftrag / die Bestellung inklusive aller Positionen wurde vom Verkäufer bestätigt
PARTIALLY_ADVISED	teilweise im Versand	Der Auftrag / die Bestellung wurde zum Teil vom Verkäufer versendet, d.h. nicht allePositionen wurden versendet
ADVISED	Im Versand	Der Auftrag / die Bestellung inklusive aller Positionen wurde vom Verkäufer versendet
PARTIALLY_INVOICED	teilweise Berechnet	Der Auftrag / die Bestellung wurde zum Teil vom Verkäufer berechnet, d.h. nicht alle Positionen wurden berechnet
INVOICED	Berechnet	Der Auftrag / die Bestellung inklusive aller Positionen wurde vom Verkäufer berechnet
CANCELED	Storniert	Der Auftrag / die Bestellung wurde vom Verkäufer storniert, nachdem der Auftrag / die Bestellung bereits (teilweise) bestätigt war
REJECTED	Abgelehnt	Der Auftrag / die Bestellung wurde vom Verkäufer komplett abgelehnt oder alle Positionen wurden auf storniert gesetzt
BLOCKED	Gesperrt	Der Auftrag / die Bestellung wurde vom Verkäufer gesperrt, diese kann dann nur explizit vom Verkäufer wieder freigegeben werden
BLOCKED_BYLIMIT	Limit erreicht	Der Auftrag / die Bestellung wurde technisch erfolgreich an das System des Verkäufers übermittelt, jedoch hat dessen System bei dem initialen Check der Bestellung einen Fehler gemeldet. Die dazugehörige Fehlermeldung steht dann dementsprechend im Feld statusMessage
ERROR	Fehler	Der Auftrag / die Bestellung wurde technisch erfolgreich an das System des Verkäufers übermittelt, jedoch hat dessen System bei dem initialen Check des Dokuments einen Fehler gemeldet. Die dazugehörige Fehlermeldung steht dann dementsprechend im Feld statusMessage
ORDERED_ELSEWHERE	andersweitig Bestellt	Dieser Status kann manuell oder per ITscope API gesetzt werden, und sagt aus dass der Besteller dieser Auftrag / Bestellung anderweitig aufgegeben hat (Email, Telefon, Shop des Verkäufers,…). In diesem Status wird der Auftrag / die Bestellung nicht an den Verkäufer gesendet, aber der Empfang von EDI Antwortnachrichten (wie ABs, Lieferscheine und Rechnungen) vom Verkäufer ist damit möglich.