System order status query

AyMINE unterstützt die Möglichkeit, automatisch Bestellstatus von Clients zu erhalten

• Terminologie
• Bestellabfrage
• Abfrage der API-Struktur:
• Abfrage-Frequenz
• Bestellen der Funktion STatus (oper=ost)

Terminologie

• User in diesem Kapitel bezeichnet eine Organisation/Firma, die AyMINE verwendet, um Prozesse zu automatisieren
• Client bezeichnet einen Client des Benutzers – eine Firma, die von API oder Client-Portal-Diensten zur Verfügung gestellt wurde

Bestellabfrage

Die genaue Adresse, um den Bestellstatus zu erhalten, wird den Kunden nach Absprache mit AyMINE-Benutzern mitgeteilt.

Abfrage der API-Struktur:

• AyMINE-Adresse oder eindeutige Adresse (wenn das System unter der Domäne des Benutzers ausgeführt wird)
• Einzigartige Service-Adresse
• Abfrage von Parametern
• Service-ID (ID kann jederzeit in den Systemeinstellungen geändert werden, um den Dienst zu blockieren)
• Client-ID (Für den Client ist die Zuweisungs-ID eine für alle Dienste, die in den Client-Einstellungen bereitgestellt werden. Durch Ändern oder Löschen der zugewiesenen ID kann der Dienst für einen bestimmten Client blockiert/aktiviert werden)
• oper – eine der Schnittstellenoperationen
• enc – Antwortkodierung: Klartext, b64 – in Base64 kodiert
• format – Antwortformat: xml, js

Abfrage-Frequenz

Die API überwacht nicht, wie oft eine Abfrage gesendet wird, sondern

• Maximal erlaubte Anzahl an Abfragen pro Stunde – gibt einen Fehlercode zurück, nachdem er überschritten wurde
• Maximal zulässige Anzahl an Abfragen pro Tag – gibt einen Fehlercode zurück, nachdem er überschritten wurde
• Anzahl der fehlgeschlagenen Anmeldungen von der IP-Adresse – nach dem Überschreiten reagiert die Schnittstelle nicht mehr vollständig und die Adresse wird gesperrt

Grenzen werden individuell festgelegt. Im Allgemeinen gilt die Empfehlung, nicht rufen Sie die Schnittstelle öfter als 1 x 2 Minuten.

Bestellen der Funktion STatus (oper=ost)

Bestellstände zurückgegeben:

• CE – (Kunde / Fehler) – Die Bestellung erfordert die Fertigstellung / Reparatur über das Kundenportal. Bis zur Korrektur und Bestätigung durch den Kunden auf dem Portal wird es nicht intern
• PR – (Prepare) – Der Auftrag wird intern vorbereitet oder kann aus irgendeinem Grund (z.B. fehlende Ware) nicht in die Lieferung einbezogen werden
• DL – (Lieferung) – Die Bestellung wird bereits ausgeliefert
• CO – (Fertiggestellt) – Die Bestellung wurde bearbeitet und die gelieferte Ware wurde geliefert. Die Bestellung wird nach Bestätigung der Übergabe an den endgültigen Empfänger in diesen Zustand umgegliedert. Wird die Ware zum Verkauf übernommen, ändert sich der Zustand nach Erhalt.
• DE_ – (Gelöscht) – von der Verarbeitung ausgeschlossen

Entsprechend der Vereinbarung kann die Schnittstelle zusätzliche Informationen zurückgeben:

• Ausgewählte Transportart
• Geplanter Liefertermin (Datum + Uhrzeit)
  Zahlungsstatus