Retouren
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 Retouren api

Promail REST API 2.0 ist ein einfacher Wege um Daten mit der Promail Plattform auszutauschen und zu bearbeiten. Mit dem "Retouren - API" können pro Retoure; Artikeldaten, Retourengrund und Grading abgerufen werden.

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://www.deal1.ch/PromailRESTreturnV1.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 Retouren 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://www.deal1.ch/PromailRESTreturnV1.php?partner=Key*PrivatKey:Your_Email&data=2021-01-31

Wenn ein Datum "data=2021-01-31" mit übergeben wird, werden bis 50 Retouren ab diesem Datum ausgelesen. Ohne Datum-Feld werden die letzten 50 Retouren ausgelesen.

GET Retouren abfragen

Im folgenden PHP-Beispiel-Code wird eine Abfrage mit cURL übermittelt:
//API variables $url = 'https://test.deal1.ch/PromailRESTreturnV1.php'; $key = 'x6R38'; $privatkey = 'abc'; $your_email = 'meine.email@xyz.ch'; $date = 'ab Datum'; //Making GET-url $url = $url.'?partner='.$key.'*'.$privatkey.':'.$your_email.'&date='.$date; // 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
{
"return": [
{
"lieferschein_nr": "3456",
"return_lieferschein_nr": "Retouren807022020082033",
"count": "1",
"sku": "66163",
"article": "5 handgedrehte Rattan-Stäbchen, gedreht.",
"specification": "",
"emp_firma": "Jeppesen AG",
"emp_name": "Vincent Jeppesen",
"emp_strasse": "Fischmattweg",
"emp_hausnr": "5",
"emp_plz": "6415",
"emp_ort": "Arth",
"emp_land": "Schweiz",
"emp_email": "vincent.jeppesen@jeppesen.ch",
"emp_tel": "044 761 10 00",
"pdf": "kein PDF",
"reason": "",
"grading": "A",
"stock_status": "-2",
"received": "2021-03-16 16:19:23",
"info": ""
} ]
}

Grading "A" = Produkt kann wieder verkauft werden
Grading "B" = Produkt braucht ein Rework, damit es wieder verkauft werden kann
Grading "C" = Produkt kann nicht wieder verkauft werden (defekt oder angebraucht)

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: