MeinEinkauf.ch Partner API (1.6.7)

On the following pages you will find the information required to transfer order details directly to us from your online store using the MeinEinkauf.ch Partner API.

MeinEinkauf.ch acts as an interface between German online vendors and Swiss customers.

We provide a service with which you can ship your goods to Swiss customers at German prices. Your customers can expect delivery from Germany with the following advantages:

• All duties paid delivery to the customers’ doorstep
• Short shipping times (in general German delivery time + 1 business day)
• National instead of international shipping fees (enabling deliveries up to 30kg to be more reasonably priced)
• Returns without additional customs fees at the border customs office

Our partnership offers an easier access to Swiss customers and the Swiss market.

If you are interested in joining the MeinEinkauf.ch partner program, please contact partner@meineinkauf.ch or visit us at partner.meineinkauf.ch.

The MeinEinkauf.ch partner API directed at online vendors, logistics service providers and developers who are aquainted with the integration of a RESTful API into their IT system environment. Plugins for the most common shop systems will be introduced in the near future.

To secure the sensitive information that is transmitted with the order, all requests must be encrypted with SSL. MeinEinkauf.ch offers a valid and signed SSL certificate. Requests that are transmitted without SSL encoding will be rejected by our API.

The MeinEinkauf.ch API is constructed according to the REST paradigm. Despite there being no defined REST standard, there are approaches and best-practises that can simplify the use of RESTful APIs. Interaction with API endpoints is made possible with standard HTTP methods POST, GET, PUT and DELETE. For these operations the acronym CRUD (Create, Read, Update, Delete) is used as well. You can find more information on REST here.

The MeinEinkauf.ch partner API exclusively uses JSON for data transmissions. Transmitted data must apply to valid JSON standards. API responses are also in JSON.

We value our partner APIs maximal availability which is ensured with state-of-the-art IT technologies. With scheduled updates and maintenance being a requirement, we do our best to keep maintenance times as low as possible. During maintenance the API is not accessible; in which case you will receive the HTTP status code 503 Service Unavailable. In this case it is necessary for the request to be sent again at a later time. You can find more information on possible HTTP status codes here.

The MeinEinkauf.ch partner API can be found at the following URL:

https://api.meineinkauf.ch/v1/

All requests to the MeinEinkauf.ch Partner API must be authenticated by HTTP Basic authentication. The user name is api, the password is the API key we will provide.

Test API Key

In order to test the implementation in your online store, you may use MEINEINKAUF_TEST_API_KEY as the API key. The transmitted data will be validated at the actual conditions, as will the answers and possible error reports. However we do not persist transmitted test data.

Test System

Additionally to the test via API Key, we also provide a test system. After the test system has been set up, we will save the transmitted data. You can find it here:

https://api-test.meineinkauf.ch/v1/

This sandbox system is an exact copy of the productive system. Order processing is simulated in the test system. Every 15 minutes, routines ensure that all orders pass through all states and the process can be tested thoroughly.

To streamline introduction we have implemented an echo endpoint which returns a transmitted parameter. This way, you may test functions such as authentication and others.

Request:

curl https://api.meineinkauf.ch/v1/echo/HelloWorld \
  -X GET \
  -u 'api:MEINEINKAUF_TEST_API_KEY'

Response:

{
    "echo": "HelloWorld",
    "errors": [],
    "success": true,
    "testMode": true
}

• 200 OK - Your request has been successful.
• 201 Created - The transmitted data has been successfully processed and e.g. an order has been created.
• 400 Bad Request - The endpoint does not exist or has been requested with an incorrect HTTP method.
• 401 Unauthorized - The request could not be authenticated.
• 422 Unprocessable Entity - The transmitted data is invalid.
• 500 Internal Server Error - Due to an error on our page the request has not been processed. We are currently working on fixing the problem. Please send the request again at a later time.
• 503 Service Unavailable - This status is given during scheduled maintenance work. The transmitted data has not been processed. Please send the request again at a later time.

• E0000 ApiKey is missing - You did not give an ApiKey.
• E0001 Unknown ApiKey - The ApiKey is unknown.
• E1000 Invalid JSON - The transmitted data is invalid. A detailed error report will be returned as well.
• E1001 No order found for given ordernumber - The order does not exist.
• E1002 No return consignment found for given reference - The return consignment does not exist.

The echo endpoint has been implemented to test the connection from your system to our API. It exclusively serves to render the transmitted parameters.

You may use our order endpoint to transfer the order files from your online shop directly to us, but also to request information about the current order status. The status may include information such as the Swiss tracking number for your customers to track their delivery.

At our returns endpoint, you may request information about returns that have been delivered and registered to our returns center in Switzerland.

MeinEinkauf AG
Fürstenlandstrasse 35
CH-9001 St. Gallen

MwSt-Nr.: CHE-331.561.017 MWST
Handelsregister-Nr.: CHE-320.3.072.275-1

The entire website is subject to Swiss legislation.