Die Daten für Deals (Bestellungen) 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 der Bestellung |
| ownOrderId | String (250) | Eigene Bestellnummer | |
| customerOrderId | String (250) | Bestellnummer des Endkunden | |
| cartId | Ja | String (250) | Warenkorb-ID des Deals, in dem sich die Bestellung befindet, nur in API 2.1 verfügbar |
| status | Ja | String (255) | Auftragsstatus in dem sich die Bestellung befindet, siehe Punkt 8: „Auftragsstatus Übersicht“ in diesem Beitrag weiter unten |
| statusMessage | Ja | String (8192) | zusätzliche textuelle Auftragsstatus Hinweise, teilweise direkt vom Verkäufer übermittelt |
| statusDate | Ja | Date | Letztes Änderungsdatum der Bestellung |
| archived | Ja | Boolean | Gibt an, ob 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 |
| vendor | vendor (255) | Referenz auf den Verkäufer (interner Key, n:1) | |
| orders | 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 |
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 |
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. |
Bestellstatus/Auftragsstatus Übersicht
| API Status | Plattform Status | Beschreibung |
| PREPARING | Vorschlag | Die Bestellung liegt als Bestellvorschlag vor, nur der Besteller sieht diese Bestellung |
| PAYMENT_AWAITING | Zahlung ausstehend | Bei einigen Bestellung ist es möglich eine Bezahlung vor dem Versenden der Bestellung durchzuführen. Dieser Status zeigt an, dass im Moment ein Bezahlvorgang stattfindet |
| PAYMENT_SUCCESSFUL | Zahlung erfolgreich | Bei einigen Bestellung ist es möglich eine Bezahlung vor dem Versenden der Bestellung durchzuführen. Dieser Status zeigt an die Zahlung erfolgreich war |
| TRANSMITTING | Wird gerade versandt | Die Bestellung wird gerade technisch an das System des Verkäufers übermittelt |
| SENT | Abgeschickt | Die Bestellung wurde zum Verkäufer gesendet |
| ARRIVED | Angekommen | Die Bestellung ist beim Verkäufer angekommen |
| ARRIVED_WARNING | Angekommen mit Warnung | Die Bestellung ist beim Verkäufer angekommen, jedoch gab es bei der Ankunft der Bestellung auf der Seite des Verkäufers einige technische Warnhinweise. Die Hinweise stehen im Feld statusMessage |
| PARTIALLY_PROCESSING | Auftrag teilweise bestätigt | Die Bestellung 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 |
| PROCESSING | Auftrag bestätigt | Die Bestellung inklusive aller Bestellpositionen wurde vom Verkäufer bestätigt |
| PARTIALLY_ADVISED | teilweise im Versand | Die Bestellung wurde zum Teil vom Verkäufer versendet, d.h. nicht alle Bestellpositionen wurden versendet |
| ADVISED | Im Versand | Die Bestellung inklusive aller Bestellpositionen wurde vom Verkäufer versendet |
| PARTIALLY_INVOICED | teilweise Berechnet | Die Bestellung wurde zum Teil vom Verkäufer berechnet, d.h. nicht alle Bestellpositionen wurden berechnet |
| INVOICED | Berechnet | Die Bestellung inklusive aller Bestellpositionen wurde vom Verkäufer berechnet |
| CANCELED | Storniert | Die komplette Bestellung wurde vom Verkäufer storniert, nachdem die Bestellung bereits (teilweise) bestätigt war |
| REJECTED | Abgelehnt | Die komplette Bestellung wurde vom Verkäufer abgelehnt oder alle Positionen in der Bestellung wurden auf storniert gesetzt |
| BLOCKED | Gesperrt | Die Bestellung wurde vom Verkäufer gesperrt, diese kann dann nur explizit vom Verkäufer wieder freigegeben werden |
| BLOCKED_BYLIMIT | Limit erreicht | Die Bestellung ist geblockt, da das Kreditlimit oder Budget überschritten wurde |
| ERROR | Fehler | 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 |
| ORDERED_ELSEWHERE | andersweitig Bestellt | Dieser Status kann manuell oder per ITscope API gesetzt werden, und sagt aus dass der Besteller diese Bestellung anderweitig aufgegeben hat (Email, Telefon, Shop des Verkäufers,…). In diesem Status wird die Bestellung nicht an den Verkäufer gesendet, aber der Empfang von EDI Antwortnachrichten vom Verkäufer ist damit möglich. |