Order 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-api Promail REST API 2.0 ist ein einfacher Wege um Daten mit der Promail Plattform auszutauschen und zu bearbeiten. Mit dem Order-API können Aufträge 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://test.deal1.ch/PromailRESTorderV2.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 Lieferaufträge 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 Lieferaufträge übermitteln Im folgenden PHP-Beispiel-Code werden 2 Aufträge mit cURL übermittelt: //API Url $url = 'https://www.deal1.ch/PromailRESTorderV2.php'; //Initiate cURL. $ch = curl_init($url); //The JSON data. $jsonData = '{ "partner": { "key": "x6R38e94z8721GtUp", "privatkey": "abc", "your_email": "vincent.jeppesen@jeppesen.ch", "api_name": "order", "orders": [ { "lieferschein_nr": "1234", "rechnungs_nr":"", "emp_firma": "Jep AG", "emp_name": "Vin Jep", "emp_strasse": "strasse", "emp_hausnr": "5", "emp_plz": "5555", "emp_ort": "Arth", "emp_land": "CH", "emp_email": "vin@jk.ch", "emp_tel": "78979888", "versandart": "", "versandbemerkung": "", "rechnungsart": "", "total_betrag": "100.00", "currency": "CHF", "basket": [ { "artikel_name": "Sleep", "artikel_nr": "72127", "lot": "", "mhd": "", "anzahl": "1", "preis": "12.50" },{ "artikel_name": "Tomato", "artikel_nr": "72128", "lot": "", "mhd": "", "anzahl": "2", "preis": "25.50" } ] },{ "lieferschein_nr": "1235", "rechnungs_nr":"", "emp_firma": "Muster AG", "emp_name": "Hans Muster", "emp_strasse": "strasse", "emp_hausnr": "6", "emp_plz": "6666", "emp_ort": "Zürich", "emp_land": "CH", "emp_email": "hans@muster.ch", "emp_tel": "78979999", "versandart": "", "versandbemerkung": "", "rechnungsart": "", "total_betrag": "100.00", "currency": "CHF", "basket": [ { "artikel_name": "Sleep", "artikel_nr": "72127", "lot": "", "mhd": "", "anzahl": "1", "preis": "12.50" } ] } ] } }'; //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 Aufträge. 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. keybei Promail beantragenmandatory privatkeybei Promail beantragenmandatory your_emailbei Promail beantragenmandatory api_namemit "Order" wird das API angesteuert, welches Aufträge ins Promail-WMS übermitteltmandatory lieferschein_nrAuftragsnummer ihres Auftragsmandatory emp_firmaEmpfänger-Firma oder Empfänger-Namemandatory emp_nameName in Empfänger-Firma emp_strasseEmpfängerstrasse (ev. mit Hausnummer)mandatory emp_hausnrHausnummer, wenn nicht bereits in der emp_strasse(mandatory) emp_plzEmpfänger PLZmandatory emp_ortEmpfänger Ortmandatory emp_landLand des Empfängersmandatory emp_emailEmail des Empfängers emp_telTel des Empfängers versandartWenn nichts steht, wird Kundenstandard verwendet. Weitere Optionen sind "B-Post", "B-Post Einschreiben", "Nachnahme Paket", "A-Post", "Midibrief A-Post", "Midibrief A-Post Einschreiben", "Nachnahme Paket". weitere Informationen versandbemerkungWenn nichts steht, wird Kundenstandard verwendet. Weitere Optionen sind zum Besispiel "Ersatz", "Leichte Verpackung" oder mit Promail abgesprochene Instruktionen. rechnungsartWenn nichts steht, wird Kundenstandard verwendet. Weitere Optionen sind "Vorkasse", "Nachnahme". total_betragRechnungssumme des Auftrags currency"CHF"mandatory artikel_nameName des Artikels artikel_nrArtikelnummer (SKU) des Artikelsmandatory lotlot des Artikels mhdMindesthaltbarkeit des Artikels anzahlAnzahl der zu liefernden Artikelmenge mandatory preisPreis eines Artikels Alle Positionen mit der gleichen Lieferschein_Nr werden zu einem Auftrag zusammen gezogen.
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: "message": "No data received" / status 401api hat keine Daten erhalten "message": "Could not convert json" / status 401api konnte Daten nicht als Json erkennen "message": "key is missing" / status 401api hat keinen key-wert gefunden "message": "privatkey is missing" / status 401api hat keinen privatkey-wert gefunden "message": "your_email is missing" / status 401api hat keinen email-wert gefunden "message": "api_name is missing" / status 401api hat keinen api-name-wert gefunden "message": "order-API has not been sent with POST-methode" / status 401Order-api muss mit POST-Method gesendet werden "message": "key is wrong" / status 401key-wert ist falsch "message": "your privatkey or email is wrong" / status 401privatkey oder email ist falsch "message": "all ANZAHL records have been uploaded" / status 200api-call war erfolgreich "not in database": "Artikelnummer" / status 200api-call war werfolgreich, aber einige Artikelnummern sind unbekannt
