This guide is designed to assist developers in integrating with DMSTrack, a tracking and logistics management solution provided by DMSMatrix. The DMSTrack API enables businesses to efficiently manage shipment tracking by adding tracking numbers and retrieving real-time tracking details within their own systems.
\nBy integrating with DMSTrack API, businesses can automate tracking workflows, improve visibility into shipments, and reduce manual tracking efforts, ensuring a seamless logistics experience.
\nTo support a smooth integration process, DMSMatrix provides:
\nComprehensive API documentation to guide developers through implementation.
\nTechnical support specialists to assist with integration challenges and troubleshooting.
\nA dedicated implementation manager to oversee customer onboarding and ensure a successful deployment.
\nBefore integrating with DMSTrack API, developers should have knowledge of:
\nRESTful API principles, including HTTP methods, authentication, and response handling.
\nShipment tracking workflows, particularly around tracking number registration and real-time tracking updates.
\nError-handling strategies, ensuring smooth exception management and fault tolerance in API interactions.
\nThe DMSTrack API provides two key endpoints to streamline tracking management:
\nAdd Tracking Number: Allows businesses to submit and register tracking numbers for shipments.
\nFetch Tracking Details: Enables retrieval of tracking status and shipment events for registered tracking numbers.
\nThere are two versions of this API available for integration: Staging and Production. Use the staging environment for testing purposes—no live data will be processed, allowing you to develop and validate your integration. Once testing is complete, your integration must be approved by your Account Manager, who will provide access credentials for the production environment.
\nNote: All API endpoints use the HTTPS protocol to ensure secure data transmission between servers.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20209157","collectionId":"96b2e285-867f-4f36-bd91-021d971983ad","publishedId":"2sA3e2e91R","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"326637"},"publishDate":"2024-07-08T14:05:24.000Z"},"item":[{"name":"Authentication","item":[{"name":"New Request","id":"ee12c7d9-7953-46e1-9761-caa89014a623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7518fe4c-0272-4604-a3c3-a693e4a8cd47","id":"7518fe4c-0272-4604-a3c3-a693e4a8cd47","name":"Authentication","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"ee12c7d9-7953-46e1-9761-caa89014a623"}],"id":"7518fe4c-0272-4604-a3c3-a693e4a8cd47","description":"Authentication
Every DMSTrack API request requires authentication through API Key and whitelisted IP addresses. API credentials can be found in the Profile Page of your account.
All API requests must include the following authentication headers:
\n⚠ Note:
\nIf an API request is made from a non-whitelisted IP address, it will be rejected.
\nKeep your API Key secure and do not share it with unauthorized parties.
\nUpon successful addition of a product, the API returns status code 200. The response includes the following sections and fields:
\n","urlObject":{"path":["addTrackingNumbers"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"8b922b03-e4de-423e-afff-d26cb0b19cdc","name":"Add Tracking Numbers - Success","originalRequest":{"method":"POST","header":[{"key":"Client-Id","value":"ABCDEFGH-IJKL-MNOP-QRST-UVWXYZ123456","type":"text"},{"key":"Client-Secret","value":"ABCDEFGH-IJKL-MNOP-QRST-UVWXYZ123456","type":"text"},{"key":"Client-Name","value":"NAME","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"sellerName\": \"Sharim\",\r\n \"trackingNumbers\": [\r\n {\r\n \"trackNum\": \"81696169693\",\r\n \"code\": \"\", // Carrier Name Optional\r\n \"orderId\": \"\" // Order ID Optional\r\n },\r\n {\r\n \"trackNum\": \"81696169693243243\",\r\n \"code\": \"\", // Carrier Name Optional\r\n \"orderId\": \"\"\r\n },\r\n {\r\n \"trackNum\": \"8169616932235693\",\r\n \"code\": \"\" // Carrier Name Optional\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dmstrack.com/api/addTrackingNumbers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 08 Jul 2024 13:55:38 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8a0092b58c4871e1-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Tracking numbers added successfully\"\n}"},{"id":"f557bc5b-09ca-4684-9eba-605175cc612d","name":"Add Tracking Numbers - Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"sellerName\": \"Sharim\",\r\n \"trackingNumbers\": [\r\n {\r\n \"trackNum\": \"81696169693\",\r\n \"code\": \"\", // Carrier Name Optional\r\n \"orderId\": \"\" // Order ID Optional\r\n },\r\n {\r\n \"trackNum\": \"81696169693243243\",\r\n \"code\": \"\", // Carrier Name Optional\r\n \"orderId\": \"\" \r\n },\r\n {\r\n \"trackNum\": \"8169616932235693\",\r\n \"code\": \"\" // Carrier Name Optional\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/addTrackingNumbers"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"fail\",\n \"message\": \"There are no IPs configured for whitelisting.\"\n}"}],"_postman_id":"83108804-6e65-481f-9518-806f9212ddfe"}],"id":"da583269-7512-4c49-907c-15fbd33aab88","_postman_id":"da583269-7512-4c49-907c-15fbd33aab88","description":""},{"name":"Fetch Tracking","item":[{"name":"Fetch Tracking","id":"17d464b9-09f6-416c-bde3-38f42e5c60d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/trackingEvents","description":"Upon successful addition of a product, the API returns status code 200. The response includes the following sections and fields:
\n","urlObject":{"path":["trackingEvents"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"04336639-7e45-441d-ac30-a2d29fac3d5f","name":"Fetch Tracking - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"trackingNumbers\": [\r\n {\r\n \"trackNum\": \"81696169693\"\r\n },\r\n {\r\n \"trackNum\": \"81696169693243243\"\r\n },\r\n {\r\n \"trackNum\": \"8169616932235693\"\r\n },\r\n {\r\n \"trackNum\": \"YT2502821272064643\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dmstrack.com/api/trackingEvents"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"list\": [\n {\n \"trackingNumber\": \"YT2502821272064643\",\n \"carrier\": \"Yun Express\",\n \"status\": 40,\n \"trackDate\": \"2025-01-28T07:46:57.000Z\",\n \"complete\": \"Delivered\",\n \"deliveredDate\": \"2025-02-12T08:00:00.000Z\",\n \"scannedDate\": \"2025-02-04T12:31:20.000Z\",\n \"destinationCountry\": \"SE\",\n \"originCountry\": \"CN\",\n \"events\": [\n {\n \"activity\": \"Shipment information received\",\n \"location\": \"\",\n \"details\": \"Shipment information received\",\n \"dateTime\": \"2025-01-28T07:46:57.000Z\",\n \"data\": [\n {\n \"date\": \"2025-01-28 13:16:57\",\n \"status\": \"Shipment information received\",\n \"address\": \"\",\n \"result\": 10,\n \"subResult\": 10,\n \"addressInfo\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"street\": \"\",\n \"zipCode\": \"\",\n \"timeZone\": \"+08:00\",\n \"coordinates\": {\n \"longitude\": \"\",\n \"latitude\": \"\"\n }\n }\n }\n ]\n },\n {\n \"activity\": \"The shipment item has been delivered to the recipient's mailbox.\",\n \"location\": \"Linköping\",\n \"details\": \"The shipment item has been delivered to the recipient's mailbox.\",\n \"dateTime\": \"2025-02-12T08:00:00.000Z\",\n \"data\": [\n {\n \"date\": \"2025-02-12 13:30:00\",\n \"status\": \"The shipment item has been delivered to the recipient's mailbox.\",\n \"address\": \"Linköping\",\n \"result\": 40,\n \"subResult\": 40,\n \"addressInfo\": {\n \"country\": \"\",\n \"state\": \"\",\n \"city\": \"Linköping\",\n \"street\": \"\",\n \"zipCode\": \"\",\n \"timeZone\": \"+01:00\",\n \"coordinates\": {\n \"longitude\": \"\",\n \"latitude\": \"\"\n }\n }\n }\n ]\n }\n ]\n },\n {\n \"trackingNumber\": \"81696169693\",\n \"carrier\": null,\n \"orderId\": null,\n \"sellerName\": \"Sharim\",\n \"events\": []\n },\n {\n \"trackingNumber\": \"81696169693243243\",\n \"carrier\": null,\n \"orderId\": null,\n \"sellerName\": \"Sharim\",\n \"events\": []\n },\n {\n \"trackingNumber\": \"8169616932235693\",\n \"carrier\": null,\n \"orderId\": null,\n \"sellerName\": \"Sharim\",\n \"events\": []\n }\n ]\n }\n}"},{"id":"37400b23-f4d8-4118-9985-9ee27c599626","name":"Fetch Tracking - Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"trackingNumbers\": [\r\n {\r\n \"trackNum\": \"81696169693\"\r\n },\r\n {\r\n \"trackNum\": \"81696169693243243\"\r\n },\r\n {\r\n \"trackNum\": \"8169616932235693\"\r\n },\r\n {\r\n \"trackNum\": \"YT2502821272064643\"\r\n }\r\n ]\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.dmstrack.com/api/trackingEvents"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"fail\",\n \"message\": \"User is not registered.\"\n}"}],"_postman_id":"17d464b9-09f6-416c-bde3-38f42e5c60d5"}],"id":"265f5893-ec9b-4dcb-a64d-d304cfa6942a","_postman_id":"265f5893-ec9b-4dcb-a64d-d304cfa6942a","description":""},{"name":"Error Handling","item":[],"id":"3dc1441c-fefa-4dfa-8057-b021320e9f5e","description":"The DMSTrack API returns error responses in case of authentication failures, missing configurations, or other request issues. Below are common error responses you may encounter:
\nThe following status codes may be returned to indicate the outcome of the request:
\n","_postman_id":"3dc1441c-fefa-4dfa-8057-b021320e9f5e"}],"event":[{"listen":"prerequest","script":{"id":"dce53640-2b7f-4da2-896f-50dd3523de4f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3a9a7b2c-d697-400e-b892-e771af762946","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"apiKey","value":"4ab0f6f0-05d1-11ef-acb6-93f4ee291515"}]}