In this article, we are delighted to present the Track-POD Application Programming Interface. We have been following the best integration practices and designed it from the perspective of the end-user. There are hundreds of our customers who are already happy with our API. Here are the reasons why they like our API:
- The API is well documented. It contains object examples and responses definition.
- Each object goes with an example. The object parameters go with the required type and possible values.
- The cherry on the top is that you can authorize the API page and test the requests. You can test both with JSON and XML objects.
Now when you understand the core principles of our API design let's go into details. The first thing you might want to do is to visit the documentation page. Once you are in there you may notice a green Authorize button.
This button will let you log in with your secret key. It's so easy to get this key. Just go to your Track-POD account settings and click on the Web API tab. From there you can create an unlimited amount of keys for different integrations and disable the keys for integrations you prefer to stop supporting.
Once you get authorized you might want to run your first test. Let's do this on the example of the "get an order by number" GET request. Press the "Try it out" button then just find any order in your Track-POD account and put its number in the white number field. Press "Execute" to perform the request.
We trust you received code 200 Response and the Response Body containing your order parameters.
POST requests testing is pretty similar to GET. The difference is that you have to put the object you want to post in to "Edit value" field. Don't worry, you don't have to create the parameters array from scratch. The Edit value field contains a dummy object which is just fine for testing purposes.
With regard to the PUT request, it is designed to be as simple as possible. The Track-POD API recognizes which object should be updated by the Id parameter. Feel free to correct other values and check how it changes on the Track-POD side.
And finally here are a couple of hints to improve your experience and make the development process time-effective.
- Speaking of Number and Id order parameters. The end-user sees the Number only. While the developer can operate with Id as well which is a unique identifier.
- It's a good practice to get orders with updated status after some date and time. It's much better than check each order in some category with the filters. This request is highly appreciated by our customers. It makes your integration more organized and stable.
- Be careful with clientId, addressId, goodsId parameters. If there is a client with the ID you are trying to import then this client's name will be updated in Track-POD (with the name from your request).
Using cycles it is very simple to receive all orders batch with the same customer if you have accidentally processed them with the same ID. Id is not a mandatory parameter. It's a good practice to not keep the Id parameter in the object if you don't need it.
- Please note, Track-POD goes with build-in integrations for many popular apps. You can check them in Settings->Integrations.
That is it about the Track-POD API. We trust your integration will work smoothly and bring a lot of benefits to your company!