Status + Tracking
REST-API Schnittstelle (JSON)
Entwickler - Home
Order-Übermittlung an Promail (Json API)
Order auslesen (Versand, Wareneingang und Retouren) mit Tracking (Json API)
Order löschen (Json API)
Stock/Lager auslesen (Json API)
Retouren auslesen (Json API)
Neuer Artikel erfassen (Json API)
Artikel anpassen (Json API)
Delivery/Wareneingang-Übermittlung an Promail (Json API)
Delivery/Wareneingang aus Rework (Json API)
Booking without order (Json API)

Überblick Order auslesen (Versand, Wareneingang und Retouren) und Tracking V2

Promail REST API 2.0 ist ein einfacher Wege um Daten mit der Promail Plattform auszutauschen und zu bearbeiten.
Mit dem "Order auslesen - API" können die aktuellen Aufträge (Versand, Retouren oder Wareneingänge) abgerufen werden.
Im Respond sind Informationen wie Trackingnummer, Versanddatum oder Differenzen bei Wareneingang enthalten.
ältere Version V1 (bis Juni 2021)

Basis HTTP

Das API ist HTTP-basiert. Das heisst das API kann mit HTTP Bibliotheken wie cURL oder urllib genutzt werden. Dadurch kann das API direkt im Browser genutzt werden.

Host url

Die Anfragen können an die url https://test.deal1.ch/PromailRESTstatusV2.php geschickt werden.

Json

Die Antworten werden in der JavaScript Sprache "Json" retourniert. Beispiele unten.

GET

Das API reagiert auf die API Send-Methoden und steuert unterschiedliche Funktionen an.
Für Status + Tracking muss die Methode GET verwendet werden.

Zugriffsschlüssel und API_Name

Um das API verwenden zu können, müssen die korrekten Zugriffsschlüssel und der gewünschte API-Name im API-Aufruf enthalten sein.
Das API verwendet 3 Schlüssel, welche beim API-Aufruf übergeben werden.
"Key" = x6R38e94z721GtUp (der Key steht in Bezug zu ihrem Promail-Konto).
"PrivatKey" = Muss bei Promail beantragt werden.
"Your_Email" = Die Emailadresse ihres Hauptkontos. Promail erteilt ihnen gerne Auskunft.
Mit "API-Name" wird die entsprechende Schittstelle ausgewählt.
Partner/Kunden erhalten die Zugriffsschlüssel durch Anfrage-Mail an office@promail-ag.ch.
Als GET Abfrage werden die Zugriffsschlüssel wie folgt verwendet:
https://test.deal1.ch/PromailRESTstatusV2.php?partner=Key*PrivatKey:Your_Email&lieferschein_nr=1234 oder für die letzten 100 Aufträge:
https://test.deal1.ch/PromailRESTstatusV2.php?partner=Key*PrivatKey:Your_Email&lieferschein_nr=last Mit group kann die Anfrage weiter eingegrenzt werden.
group=post -> Mit der Post verschickte Aufträge werden angezeigt.
group=dhl -> Mit der DHL verschickte Aufträge werden angezeigt.
group=gls -> Mit der GLS verschickte Aufträge werden angezeigt.
group=truck -> Mit LKW verschickte Aufträge werden angezeigt.
group=return -> Retouren werden angezeigt.
group=delivery -> Wareneingänge werden angezeigt.
Zum Beispiel:
https://test.deal1.ch/PromailRESTstatusV2.php?partner=Key*PrivatKey:Your_Email&lieferschein_nr=last&group=delivery

GET Status + Tracking abfragen

Im folgenden PHP-Beispiel-Code wird eine Abfrage mit cURL übermittelt:
//API variables $url = 'https://test.deal1.ch/PromailRESTstatusV1.php'; $key = 'x6R38'; $privatkey = 'abc'; $your_email = 'meine.email@xyz.ch'; $lieferschein_nr = 'ihre Auftragsnummer'; //Making GET-url $url = $url.'?partner='.$key.'*'.$privatkey.':'.$your_email.'&lieferschein_nr='.$lieferschein_nr; // Initiate curl $ch = curl_init(); // Will return the response, if false it print the response curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Set the url curl_setopt($ch, CURLOPT_URL,$url); // Execute $result=curl_exec($ch); // Will dump a beauty json $arr = json_decode($result,true); //wandelt in ein array //Get Status Code $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); echo 'HTTP code: ' . $httpcode;

Erklärungen

Der Beispielcode übermittelt eine Abfrage welche als JSON beantwortet wird:
HTTP code: 200
{
"order": [
{
"lieferschein_nr": "555",
"emp_firma": "Muster AG",
"emp_name": "Hans Muster",
"emp_strasse": "Seestrasse",
"emp_hausnr": "5",
"emp_plz": "8000",
"emp_ort": "Zürich",
"emp_land": "Schweiz",
"emp_email": "Hans.Muster@Muster.com",
"emp_tel": "00000000000",
"status": "success",
"forwarder": "delivery",
"forwarder_product": "",
"tracking": "kein PDF",
"weight": "1",
"sent": "2021-06-29 09:13:27",
"info": "",
"basket": [
{
"artikel_name": "Testprodukt",
"artikel_nr": "1234",
"lot": "",
"mhd": "0000-00-00",
"erwartet": "11", (= Bei Wareneingang, Anzahl gemäss Lieferschein)
"anzahl": "11", (= Effektive Anzahl)
"preis": "0.00"
},
{
"artikel_name": "TestArtikel",
"artikel_nr": "2345",
"lot": "",
"mhd": "0000-00-00",
"erwartet": "11",
"anzahl": "11",
"preis": "0.00"
} ]
} ]
}

status "success" = Auftrag wurde verschickt
status "unchecked" = Auftrag noch nicht geprüft
status "in progress" = Auftrag in Arbeit
status "done" = Auftrag fertig aber noch nicht verschickt
status "deleted" = Auftrag wurde gelöscht

Fehlermeldungen+Erfolgsmeldungen

Bei einem erfolgreichen Aufruf des API's wird ein http-status 200 gesendet.
Wenn der Aufruf nicht erfolgreich war, wird ein http-status 401 gesendet.
Folgende Fehlermeldungen sind möglich: