Diese Methoden sind für Sales-Aufträge.
Abrufen einer Liste von empfangenen Portal Aufträgen
Folgende Query Parameter sind möglich
- archiv
- ARCHIVED: archivierte Aufträge
- NOTARCHIVED: nicht archivierte Aufträge
- sort – Sortierungskriterien
- LAST_MODIFIED : Änderungsdatum absteigend
- SENT_DESC: Versanddatum absteigend
- SEND_ASC: Versanddatum aufsteigend
- SUPPLIER: nach Lieferant absteigend
- ID: nach eindeutiger ITscope Dealnummer (Feld orderId) absteigend
- page
- 1..n, die Abfragen sind immer auf 50 Aufträge pro Seite begrenzt
Bsp: https://api.itscope.com/2.1/business/deals/sales/deal.xml
Eine Beschreibung der Response wird im Formatbeschreibung für Deals beschrieben.
Suche nach empfangenen Portal Aufträgen
Folgende Filter sind möglich
- keywords: Teilsuchen in orderId , ownOrderId und customerOrderId, z.B. keywords=11SRRK
- orderId (oder legacy per dealId): ITscope eindeutige Dealnummer z.B. orderId=11SRRK-150126-1136
- ownOrderId (oder legacy per ownDealId): Vom Einkäufer 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 der Auftrag befindet*
* nur API 2.1, siehe hier.
Folgende Query Parameter sind möglich
- archiv
- ARCHIVED: archivierte Aufträge
- NOTARCHIVED: nicht archivierte Aufträge
- sort – Sortierungskriterien
- LAST_MODIFIED : Änderungsdatum absteigend
- SENT_DESC: Versanddatum absteigend
- SEND_ASC: Versanddatum aufsteigend
- SUPPLIER: nach Lieferant absteigend
- ID: nach ITscope Dealnummer (Feld orderId) absteigend
- page
- 1..n, die Abfragen sind immer auf 50 Aufträge pro Seite begrenzt
- lastUpdateDateFrom (nur API 2.1)
- Datum, ab wann gesucht werden soll, im Format yyyy-MM-dd oder yyyy-MM-ddThh:mm:ss oder mit Zeitzonen yyyy-MM-ddThh:mm:ss±hh:mm
- siehe Einschränkung der Suche nach letztem Änderungsdatum eines Auftrags weiter unten in diesem Beitrag
- lastUpdateDateTo (nur API 2.1)
- Datum, bis wann gesucht werden soll, im Format yyyy-MM-dd oder yyyy-MM-ddThh:mm:ss oder mit Zeitzonen yyyy-MM-ddThh:mm:ss±hh:mm
- siehe Einschränkung der Suche nach letztem Änderungsdatum eines Auftrags weiter unten in diesem Beitrag
Beispiel für eine Suche nach einer vom Einkäufer vergebenen eigenen Bestellnummer 54231
https://api.itscope.com/2.1/business/deals/search/sales/ownOrderID%3D54231/deal.xml
Beispiel für eine Suche nach einer Endkunden Bestellnummer 12345
https://api.itscope.com/2.1/business/deals/search/sales/customerOrderID%3D12345/deal.xml
Beispiel für eine Suche nach allen Aufträgen zu einem Warenkorb mit der Id 611e-ac7b-42c2-a3b6-2434812ede75
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 bei den Aufträgen, siehe Formatbeschreibung für Deals. Das Änderungsdatum gibt an, wann bei einem Auftrag das letzte Mal eine neues Bestellantwortdokument (Transaktionsdokument) hinzugefügt wurde wie zum Beispiel eine geänderte Auftragsbestätigung oder ein Lieferschein oder Rechnung. Auch neue Aufträgen, die in dem Zeitraum angelegt wurden, werden damit gefunden
- lastUpdateDateFrom: Der Startzeitpunkt für die Einschränkung des Auftrag Änderungsdatum Zeitraums im Format yyyy-MM-dd oder yyyy-MM-ddThh:mm:ss oder mit Zeitzonen yyyy-MM-ddThh:mm:ss±hh:mm. Nur wenn dieser Parameter gesetzt ist, werden die Bestellungen nach dem Änderungsdatum Zeitraum gefiltert.
- lastUpdateDateTo: Der Endzeitpunkt für die Einschränkung Auftrag Änderungsdatum Zeitraums im Format yyyy-MM-dd oder yyyy-MM-ddThh:mm:ss oder mit Zeitzonen yyyy-MM-ddThh:mm:ss±hh:mm. Wird kein Wert übermittelt ist der Defaultwert das aktuelle Datum. Der Wert darf nicht weniger als lastUpdateDateFrom sein.