Abrufen einer Liste von vorhandenen Deals

Folgende Query Parameter sind möglich

  • archiv
    • ARCHIVED: achivierte Deals
    • NOTARCHIVED: nicht archivierte Deals
  • businessType
    • PURCHASE: ausgehende Deals, für Einkäufer
    • SALES: eingehende Deals, für Verkäufer
  • sort - Sortierungskriterien
    • LAST_MODIFIED : Anderungsdatum absteigend
    • SENT_DESC: Versendedatum absteigend
    • SEND_ASC: Versendedatum aufsteigend
    • SUPPLIER: nach Lieferant absteigend
    • ID: nach ITscope Bestellnummer orderId absteigend
  • page
    •  1..n, bei Abfragen sind immer auf 50 Deals pro Seite begrenzt

Bsp: https://api.itscope.com/2.0/business/deals/deal.xml&businessType=PURCHASE 

Eine Beschreibung der Response wird im Formatbeschreibung für Deals beschrieben.

 

Suche nach vorhandenen Deals

Folgende Filter sind möglich

  • keywords: Teilsuchen in orderId , ownOrderId und customerOrderId, z.B. keywords=11SRRK
  • orderId (oder legacy per dealId): ITscope eindeutige Deal ID Nummer z.B. orderId=11SRRK-150126-1136
  • ownOrderId (oder legacy per ownDealId): Vom Händler selbst vergebene eigene Bestellnummer, z.B. ownOrderId=54321
  • customerOrderId (oder legacy per customerDealId): Die Bestellnummer des Endkunden, z.B. customerOrderId=12345
  • status: Filtern nach Auftragsstatus, z.B. status=ADVISED
  • cartId: Suche anhand der Warenkorb-IDs, in dem sich die Deals befinden*

* nur API 2.1, siehe hier.

Folgende Query Parameter sind möglich

  • archiv
    • ARCHIVED: achivierte Deals
    • NOTARCHIVED: nicht archivierte Deals
  • businessType
    • PURCHASE: ausgehende Deals, für Einkäufer
    • SALES: eingehende Aufträge, für Verkäufer
  • sort - Sortierungskriterien
    • LAST_MODIFIED : Anderungsdatum absteigend
    • SENT_DESC: Versendedatum absteigend
    • SEND_ASC: Versendedatum aufsteigend
    • SUPPLIER: nach Lieferant absteigend
    • ID: nach ITscope Bestellnummer absteigend
  • page
    • 1..n, bei Abfragen sind immer auf 50 Deals pro Seite begrenzt
  • lastUpdateDateFrom (nur API 2.1)
    • Datumszeitraum von im Format yyyy-MM-dd
    • siehe Einschränkung der Suche nach letztem Änderungsdatum einer Bestellung in diesem Artikel
  • lastUpdateDateTo (nur API 2.1)
    • Datumszeitraum bis im Format yyyy-MM-dd
    • siehe Einschränkung der Suche nach letztem Änderungsdatum einer Bestellung in diesem Artikel

 

Beispiel suche nach einer Händler eigenen Bestellnummer 54231

https://api.itscope.com/2.0/business/deals/search/ownOrderID%3D54231/deal.xml?businessType=PURCHASE 

Beispiel suche nach einer Endkunden Bestellnummer 12345

https://api.itscope.com/2.0/business/deals/search/customerOrderID%3D12345/deal.xml?businessType=PURCHASE 

 

Beispiel suche nach allen Bestellungen zu einem Warenkorb mit der Id 611e-ac7b-42c2-a3b6-2434812ede75

https://api.itscope.com/2.0/business/deals/search/cartId%3D611-ac7b-42c2-a3b6-2434812ede75/deal.xml?businessType=PURCHASE 

Eine Beschreibung der Response wird im Formatbeschreibung für Deals beschrieben.

 

Einschränkung der Suche nach letztem Änderungsdatum (nur API 2.1)

Die entsprechenden Requestparameter stehen erst ab der API 2.1 zur Verfügung. Die Parameter filtern auf dem Feld statusDate beim Deal, siehe Formatbeschreibung für Deals. Das Änderungsdatum gibt an, wann bei einem Deal das letzte Mal eine neues Transaktionsdokument hinzugefügt wurde, oder sich irgendetwas beim Deal geändert hat..

  • lastUpdateDateFrom: Der Startzeitpunkt für die Einschränkung des Deal Änderungsdatum Zeitraums im Format yyyy-MM-dd. Nur wenn dieser Parameter gesetzt ist, werden die Deals nach dem Änderungsdatum Zeitraum gefiltert. Uhrzeit ist immer 00:00:00.
  • lastUpdateDateTo: Der Endzeitpunkt für die Einschränkung Deal Änderungsdatum Zeitraums im Format yyyy-MM-dd. Wird kein Wert übermittel ist der Defaultwert das aktuelle Datum. Uhrzeit ist immer 00:00:00. Der Wert darf nicht weniger als lastUpdateDateFrom sein.

Abrufen von generellen Dealinfos eines bereits vorhandenen Deals

Abrufen von Dealinformationen eines bereits abgeschickten Deals aus dem ITscope Portal anhand dessen ITscope Bestellnummer 11SRRK-150126-1136

Bsp: https://api.itscope.com/2.0/business/deals/11SRRK-150126-1136/deal.xml

Eine Beschreibung der Response wird im Formatbeschreibung für Deals beschrieben.

 

Archivieren eines bereits vorhandenen Deals

Archivieren eines bereits versendeten Deals im Portal anhand dessen ITscope Bestellnummer 11SRRK-150126-1136. Die HTTP Anfragemethode für diese Funktion ist PUT, anstatt GET.

Bsp: https://api.itscope.com/2.0/business/deals/archive/11SRRK-150126-1136

Im Beitrag zum Thema Archive wird erklärt warum archiviert werden sollte.

 

Bestätigen eines empfangenen Deals als Distributor (nur in Api Version 2.1)

Bestätigen eines empfangenen Deals im Portal anhand dessen ITscope Bestellnummer 11SRRK-150126-1136. Die HTTP Anfragemethode für diese Funktion ist PUT, anstatt GET.

Bsp: https://api.itscope.com/2.1/business/deals/confirm/11SRRK-150126-1136

Damit wird der Deal auf den Bestellstatus / Auftragsstatus Auftrag bestätigt für den Distributor und den Besteller gesetzt. Es wird automatisch ein generiertes Bestellantwortdokument in OpenTrans 2.1 Format "ORDERRESPONSE" angelegt.

 

Lieferschein erstellen für einen empfangenen Deal als Distributor (nur in Api Version 2.1)

Lieferschein erstellen für einen empfangenen Deal im Portal anhand dessen ITscope Bestellnummer 11SRRK-150126-1136. Die HTTP Anfragemethode für diese Funktion ist PUT, anstatt GET.

Bsp: https://api.itscope.com/2.1/business/deals/advise/11SRRK-150126-1136

Damit wird der Deal auf den Bestellstatus / Auftragsstatus Im Versand für den Distributor und den Besteller gesetzt. Es wird automatisch ein generiertes Bestellantwortdokument in OpenTrans 2.1 Format "DISPATCHNOTIFICATION" angelegt.

 

Berechnen eines empfangenen Deals als Distributor (nur in Api Version 2.1)

Rechnung erstellen für einen empfangenen Deal im Portal anhand dessen ITscope Bestellnummer 11SRRK-150126-1136. Die HTTP Anfragemethode für diese Funktion ist PUT, anstatt GET.

Bsp: https://api.itscope.com/2.1/business/deals/invoice/11SRRK-150126-1136

Damit wird der Deal auf den Bestellstatus / Auftragsstatus Berechnet für den Distributor und den Besteller gesetzt. Es wird automatisch ein generiertes Bestellantwortdokument in OpenTrans 2.1 Format "INVOICE" angelegt.

 

Ablehnen eines empfangenen Deals als Distributor (nur in Api Version 2.1)

Ablehnen eines empfangenen Deals im Portal anhand dessen ITscope Bestellnummer 11SRRK-150126-1136. Die HTTP Anfragemethode für diese Funktion ist PUT, anstatt GET.

Bsp: https://api.itscope.com/2.1/business/deals/reject/11SRRK-150126-1136

Damit wird der Deal auf den Bestellstatus / Auftragsstatus Abgelehnt für den Distributor und den Besteller gesetzt. Es wird automatisch ein generiertes Bestellantwortdokument in OpenTrans 2.1 Format "ORDERRESPONSE" angelegt.

 

Haben Sie Fragen? Anfrage einreichen