Interfaces
Interfaces
Matkahuolto offers the possibility to build integrations with your online store or other backend system using open interfaces. The interfaces are described in more detail below.
Matkahuolto’s XML interface
All online store applications can be directly linked to Matkahuolto’s data system via the XML interface.
The XML interface is implemented as an simple XML request to which the reply is given in XML format. The request is submitted to the contact address using the (POST) https protocol. In the request is successful, the sender receives an XML file containing not only the reply but also the address card in pdf format. The pdf is printed and appended to the consignment.
While the XML request is of standard format, there is a number of non-compulsory fields. The https protocol is the only permitted option because the server does not accept any non-encrypted http requests.
Matkahuolto’s pick-up point search
You can use the API interface of Matkahuolto’s pickup point search in real time or download Matkahuolto’s pickup point data, for example once a day, to the online store database for display to your customers.
The Matkahuolto pick-up point search is also pre-built in systems such as nShift.
Download technical description of the pickup point search
Tracking info
The recipient can track the progress of the shipment by using the Track & Trace feature on Matkahuolto’s website. Tracking info can also be displayed on the online store’s website based on the info provided by Matkahuolto.
Technical description of tracking info
Interface description for Matkahuolto’s address label search
Shipment information is transmitted to Matkahuolto electronically as an API call or file transfer. An EDI message can be in XML or CSV format. Most online store data systems support the required file formats without the need for custom development.
The information transmitted in an EDI message includes the sender’s and recipient’s details. The recipient’s mobile phone number or email address is required, for example for submitting arrival notifications.
Download technical description of the interface
Download example response file
Download example A5 label (pdf)
Download example A6 label (pdf)
Sample files
To facilitate deployment, Matkahuolto offers sample codes in some of the most common web programming languages. The sample codes may be used freely for both private and commercial purposes. The codes may be used as they are or modified at the user’s risk. Please note that the reliability of the sample codes has not been tested under all conditions.
The codes are zipped:
Php: matkahuolto_php.zip
Java: matkahuolto_java.zip
Ruby: matkahuolto_ruby.zip
Testing and deployment
To test the interface, Matkahuolto’s servers offer a testing environment which returns a reply of correct format to the requests submitted. No consignments submitted using the testing environment are actually processed. Deployment is easy by changing the contact address.
Here’s how to get started - Customer IDs and technical support
For testing and deployment, you will need a free customer ID. You can order it by e-mail from Matkahuolto at verkkokauppapalvelut@matkahuolto.fi.
Additional information on the user or XML interface is provided by the help desk The e-mail address to the help desk is verkkokauppapalvelut@matkahuolto.fi.