Delivery (Wareneingang)
REST-API Schnittstelle JSON
Entwickler - Home

Überblick Delivery-api

Promail REST API 2.0 ist ein einfacher Wege um Daten mit der Promail Plattform auszutauschen und zu bearbeiten. Mit dem Delivery-API können Wareneingänge an Promail übermittelt 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

Anfragen können an die url https://www.deal1.ch/PromailRESTdeliveryV2.php geschickt werden.

Json

Die Abfragen sind in der JavaScript Sprache "Json" an das API zu schicken. Beispiele unten.

POST

Das API reagiert auf die API Send-Methoden und steuert unterschiedliche Funktionen an.
Die Methode POST wird verwendet um Daten wie Wareneingänge an Promail zu übermitteln.

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.

POST Wareneingänge übermitteln

Im folgenden PHP-Beispiel-Code werden 2 Eingänge mit cURL übermittelt:
//API Url $url = 'https://www.deal1.ch/PromailRESTdeliveryV2.php'; //Initiate cURL. $ch = curl_init($url); //The JSON data. $jsonData = '{ "partner": { "key": "x6R38e94z8721GtUp", "privatkey": "abc", "your_email": "vincent.jeppesen@jeppesen.ch", "api_name": "delivery", "deliveries": [ { "lieferschein_nr": "1234", "lieferschein_3PL": "", "kundennr_3PL": "", "supplier_id": "", "send_firma": "Jep AG", "send_name": "Vin Jep", "send_strasse": "strasse", "send_hausnr": "5", "send_plz": "5555", "send_ort": "Arth", "send_land": "CH", "send_email": "vin@jk.ch", "send_tel": "78979888", "expected_delivery": "15.06.2022", "basket": [ { "linenr": "", "artikel_name": "Sleep", "artikel_nr": "72127", "lot": "", "mhd": "", "anzahl": "1" },{ "linenr": "", "artikel_name": "Tomato", "artikel_nr": "72128", "lot": "", "mhd": "", "anzahl": "2" } ] },{ "lieferschein_nr": "1235", "lieferschein_3PL": "", "kundennr_3PL": "", "supplier_id": "", "send_firma": "Muster AG", "send_name": "Hans Muster", "send_strasse": "strasse", "send_hausnr": "6", "send_plz": "6666", "send_ort": "Zürich", "send_land": "CH", "send_email": "hans@muster.ch", "send_tel": "78979999", "expected_delivery": "15.06.2022", "basket": [ { "linenr": "", "artikel_name": "Sleep", "artikel_nr": "72127", "lot": "", "mhd": "", "anzahl": "1" } ] } ] } }'; //Tell cURL that we want to send a POST request. curl_setopt($ch, CURLOPT_POST, 1); //Attach our encoded JSON string to the POST fields. curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData); //Set the content type to application/json curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json')); //Execute the request $result = curl_exec($ch); //Get Status Code $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); echo 'HTTP code: ' . $httpcode;

Erklärungen

Der Beispielcode übermittelt drei Datensätze für zwei Anlieferungen. Auftrag mit lieferschein_nr 1234 hat zwei SKU's. Auftrag mit lieferschein_nr 1235 hat eine SKU. Auf diese Art können bis zu 500 Datensätze übermittelt werden.

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: