Order
REST-API JSON
Order transmission to Promail (Json API)
Read orders (dispatch, goods receipt and returns) with tracking (Json API)
Delete order (Json API)
Stocklevel (Json API)
Returns (Json API)
Items (Json API)
Enter new item (Json API)
Customize article (Json API)
Goods receipt transmission to Promail (Json API)
Goods receipt from rework (Json API)
Booking without order (Json API)

Order api overview

Promail REST API 2.0 is an easy way to exchange and manipulate data with the Promail platform. Orders can be sent to Promail with the Order API.

Basic HTTP

The API is HTTP based. That means the API can be used with HTTP libraries like cURL or urllib. This allows the API to be used directly in the browser.

Host url

Requests can be sent to the url https://www.deal1.ch/PromailRESTorderV2.php.

Json

The queries are to be sent to the API in the JavaScript language "Json". examples below.

POST

The API reacts to the API Send methods and controls different functions.
The POST method is used to transmit data such as delivery orders to Promail.

Access Key and API_Name

In order to use the API, the correct access keys and desired API name must be included in the API call.
The API uses 3 keys, which are transferred when the API is called.
"Key" = x6R38e94z721GtUp (the key is related to your Promail account).
"PrivatKey" = Must be requested from Promail.
"Your_Email" = Your main account email address. Promail will be happy to provide you with information.
The corresponding interface is selected with "API name".
Partners/customers receive the access key by sending an email to office@promail-ag.ch.

Submit POST delivery orders

In the following example PHP code, 2 orders are submitted with cURL:
//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;

Explanations

The sample code submits three records for two orders. Order with delivery note number 1234 has two SKU's. Order with delivery note number 1235 has one SKU. Up to 500 data sets can be transmitted in this way.

Error messages+success messages

If the API is successfully called, an http status 200 is sent.
If the call was unsuccessful, an http status 401 is sent.
The following error messages are possible: