If you insist on going the adventurous way, or maybe this is part of your development requirement. You can use this api to create a new api key.
\nYou can also create an API key by logging in to Customer Portal (just saying...)
\n","urlObject":{"path":["v1.0","auth","personalAccessToken"],"host":["{{API_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"ccfed3d3-ccb0-4a2a-8263-e2881a5b1718","name":"Create token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"My Apps\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_ENDPOINT}}/auth/personalAccessToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"companyId\": \"c9b51032-112d-48ae-9fb6-7e03965c435f\",\n \"userId\": \"a6fb1140-f49f-11e9-a840-ffaca7958d9b\",\n \"name\": \"My Apps\",\n \"token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJhNmZiMTE0MC1mNDlmLTExZTktYTg0MC1mZmFjYTc5NThkOWIiLCJjb21wYW55SWQiOiJjOWI1MTAzMi0xMTJkLTQ4YWUtOWZiNi03ZTAzOTY1YzQzNWYiLCJ0eXBlIjoicGVyc29uYWwiLCJpYXQiOjE1NzI3MjE2NDcsImV4cCI6MTYzNTgzNjg0N30.pcicIakyWef_mjbdPg3FFde0xsApFb1XJGxSPSf7MdGw5rZ1D1VVqJUnuB6N-ei7zB8Z77Jys3abNit60AiA2oR-gEtiH2kv8xpep9gzLE2JmXGZobYOUrOjTvPUNFJrM8IQMm8ZiC3vomA3v37mN8IFXU1RGQ0hdPG0h_JOV8CzVmFeYHYUf-hrVqweBwqtpDMsk1NWdTAmobsvyn2JskOB0Z41CjOsm3i6BLkeoIkiQCQRRIq6F-vsp4fsQ7ObEHLGV7sWiHCQ4ztduJxpOzL0O6rguMCTIHEE9RDSyjRCkG_3SNNzI3YKxfkBqGqnbIVwX_unSgMbn0yTI2Hb6w\",\n \"id\": 2\n }\n}"}],"_postman_id":"460d0f77-7a2b-45c9-bb11-a2962ab8aa9f"},{"name":"Get all token","id":"ae9db34c-9ea2-423a-ba03-4aec75e6da01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"How to get an API key
\n- \n
- You can obtain API Key in Customer Portal.\nGo to \"Settings\" > \"API Integrations\" > \"Add new key\". \n
- OR You can also generating it programmatically using Create API Key/Token API. \n
How to authenticate?
\nTo authenticate, send X-Delyvax-Access-Token: <access_token> header, where <access_token> is replaced with the api key.
- \n
- companyCode - required \n
- username - required \n
- password - required \n
If you're not sure what is your companyCode, you can get it from customer portal in \"API Integration\" tab.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}},"urlObject":{"path":["v1.0","auth","login"],"host":["{{API_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"0f5c6e0a-ee8a-4e6a-b2c6-5f9ef7c42a72","name":"STAGING: Expected Result","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"companyCode\": \"delyva\",\r\n \"username\": \"ridhuanhassan@delyva.com\",\r\n \"password\": \"password\"\r\n}"},"url":"{{API_ENDPOINT}}/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,PUT,PATCH,DELETE,COPY,OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 05 Aug 2019 08:42:01 GMT"},{"key":"Etag","value":"W/\"4e2-2UXwivebusP+PJLOnBzSfWwoiRM\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"DelyvaX"},{"key":"Content-Length","value":"864"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accessToken\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJmNzM4NjBiMC1iNzRlLTExZTktOTQ2MS0xOTg1YzA5NThjMTciLCJjb21wYW55SWQiOiI1YjhkZmUzYy1hMTIxLTRlODgtYWQ1My0yMzkzNmQ1YjY5MTQiLCJyb2xlcyI6W10sInNjb3BlcyI6W10sImlhdCI6MTU2NDk5NDUyMSwiZXhwIjoxNTY0OTk1NDIxfQ.SGrsIq_-zDCUcnhREFhQGJk8xuik4xpY3ospgBM8cWQe94oTzWhYrF4u53lJPWl8paXDmaa9_rWN_6UVCID9qRKYXpRpl4O29IhyQ9D405wqaInRrVlqef7htwoK9YGjmDL9LK1xkzVCR_otPKYIRckgP65WRiS9w8o0wuuGglzQKrFPN055sYrlggygAy_hZ4V5qCwh2h5bG6RZsoc2iNMcqaewRMLbXL_gcRG0dPZh4kHVjnQqhbDNJdl14ZnHzw1MaRxG2AXgHwYP-lvZbNDQ6l7-sGNZH7-cw_ANqYNLH2ciyHNWBi-00iHvMZOhTdGjTPgAnfHDOPGydkyZgA\",\n \"expireIn\": 900000,\n \"expireAt\": \"2019-08-05T08:57:01.641Z\",\n \"refreshToken\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJmNzM4NjBiMC1iNzRlLTExZTktOTQ2MS0xOTg1YzA5NThjMTciLCJjb21wYW55SWQiOiI1YjhkZmUzYy1hMTIxLTRlODgtYWQ1My0yMzkzNmQ1YjY5MTQiLCJpYXQiOjE1NjQ5OTQ1MjEsImV4cCI6MTU2NzU4NjUyMX0.SZtR7ok3CV1MSVdlFdYl5gBt9jzyjmL2uoxzTzElBb3_Vc7kfbcfiGE0ebtSWGQhR7ApFi5hwrIFcWQmGWkPYVO6I6Ltek8DDK8rWRheGiMN6dQ2ytsU8VahrobnM0oah-iuWnojCBCggupQTkJNQnzkW6KqK-RMjFLvFKzV5syVlySd5IIWf5OlWJkA9MhdNBhqRTksqn7KykHq5DRG7crDftTMBiaTDtqYvH5a7m7kyK2CzF44j-BlLix2Y-NtJ3xokkw2cOALRJI8epeOYdSS78C-sOdbzVtsCw7DGKCRRuKt6wJeKdAd24Ry73ZWGo7-pWsQsO1nE1hiQVPTTA\"\n }\n}"},{"id":"1e9a9915-5e2e-48a0-ac69-849687e28d85","name":"User not exist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"companyCode\": \"delyva\",\n\t\"username\": \"supersimple@gmail.com\",\n\t\"password\": \"password\"\n}"},"url":"{{API_ENDPOINT}}/auth/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 11 Jun 2019 03:52:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"44"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"matdespatch.app"},{"key":"ETag","value":"W/\"2c-CGmkX981SLZSDziUMPJ+aouVLIU\""},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"User does not exists\"\n }\n}"},{"id":"30a0d066-ea7f-4273-8107-236cc23abbe6","name":"Invalid Password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"companyCode\": \"delyva\",\n\t\"username\": \"mr.ridhuanhassan@gmail.com\",\n\t\"password\": \"p4ssw0rd\"\n}"},"url":"{{API_ENDPOINT}}/auth/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 11 Jun 2019 03:53:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"matdespatch.app"},{"key":"ETag","value":"W/\"28-9/O1eR8XJINf+2dWpy8+h25mWNM\""},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"Invalid password\"\n }\n}"},{"id":"d30a2bdd-0bc1-47eb-8cb2-b179dc06a998","name":"Expected Result","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"companyCode\": \"delyva\",\n\t\"username\": \"mr.ridhuanhassan@gmail.com\",\n\t\"password\": \"password\"\n}"},"url":"{{API_ENDPOINT}}/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 11 Jun 2019 03:51:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"722"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"matdespatch.app"},{"key":"ETag","value":"W/\"2d2-yUbKIYLAB4ugo2izphqPW8fp+ZE\""},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accessToken\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI3YmFhOTVlMC04YmZiLTExZTktODhiYi02YjRkMmNlNmFlYzciLCJjb21wYW55SWQiOiJjOWI1MTAzMi0xMTJkLTQ4YWUtOWZiNi03ZTAzOTY1YzQzNWYiLCJyb2xlcyI6W10sImlhdCI6MTU2MDIyNTA3MiwiZXhwIjoxNTYwMjI1OTcyfQ.Kz-dGSoJK-YG7TULf8Kf6tKzPzQv4w0A3MBM2WSc4bVYH7daPKdxJbkfVuLnvLLKNGddFO-p5g3BiX9Mfo9MZg\",\n \"expireIn\": 900000,\n \"expireAt\": \"2019-06-11T04:06:12.229Z\",\n \"refreshToken\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI3YmFhOTVlMC04YmZiLTExZTktODhiYi02YjRkMmNlNmFlYzciLCJjb21wYW55SWQiOiJjOWI1MTAzMi0xMTJkLTQ4YWUtOWZiNi03ZTAzOTY1YzQzNWYiLCJpYXQiOjE1NjAyMjUwNzIsImV4cCI6MTU2MjgxNzA3Mn0.JKpJb9i15a2z8VtVeDvYFcYt2k_ygoIAsCooOOnMB3G1A3eg4UEeNXnOf3rHuvJ7d_VDpnpYW2CHCMwdyg64wg\"\n }\n}"}],"_postman_id":"c02650c0-950d-40af-8411-05959ee6b5c6"},{"name":"Renew JWT Token","event":[{"listen":"prerequest","script":{"id":"311ec6b0-591b-4ce5-8f24-e377a5cdcdd4","exec":["pm.environment.set(\"API_ENDPOINT\", \"https://staging-api.delyva.com\");"],"type":"text/javascript"}}],"id":"eb844bb7-a0c6-4c34-aef0-20427d3ec03d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"How to get JWT Token?
\n- \n
- Use Login User api to get the jwt token \n
- Please cache the token, and AVOID calling login user api each time. \n
- JWT token will expire in a very short time, you need to renew the token when it's expire or when nearly expire. \n
How to Authenticate?
\nTo authenticate you should supply the JWT token in the Authorization HTTP header with the Bearer schema as follows:
\nAuthorization: Bearer <jwt_token>\nYou need to obtain new token once it expires, please only request new token when the token nearly expire or when it expire.
\n","_postman_id":"be7efeff-79a4-499c-8c5e-60ee902c743d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}}},{"name":"Get company lists","event":[{"listen":"prerequest","script":{"id":"e4c8213e-f439-4592-904f-8d3a717f76b9","exec":[""],"type":"text/javascript"}}],"id":"2f53bdc6-17c0-4b21-b4c6-15ca82a14945","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"username\": \"suhaimi@delyva.com\"\n}"},"url":"{{API_ENDPOINT}}/v1.0/auth/getCompany","description":"Use this API to get list of company that belongs to a user, by username. Username can be an email or mobile phone number.
\n","urlObject":{"path":["v1.0","auth","getCompany"],"host":["{{API_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"1e1099a7-a103-48f4-b6d3-ac170941cd62","name":"Get list of company by username","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"username\": \"suhaimi@delyva.com\"\n}"},"url":"{{API_ENDPOINT}}/auth/getCompany"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"listOfCompanies\": [\n {\n \"id\": \"f6114bec-6b36-46c7-8fb2-e6a3afccb9a1\",\n \"planId\": 1,\n \"code\": \"suhaimi\",\n \"name\": \"Suhaimi Express\",\n \"regNo\": \"1183888-A\",\n \"address1\": \"Early Risers Sdn. Bhd.\",\n \"address2\": \"F-11-19, Block F, Pacific Palace\",\n \"address3\": \"Ara Damansara\",\n \"postcode\": \"47301\",\n \"city\": \"Petaling Jaya\",\n \"state\": \"Selangor\",\n \"country\": \"MY\",\n \"businessType\": \"Fleet Management\",\n \"courierOperation\": \"Pickup Only\",\n \"courierAgentType\": [\n \"Full-time Agent\",\n \"Crowdsource\"\n ],\n \"volume\": 500,\n \"email\": \"suhaimi@delyva.com\",\n \"phone\": \"6036419090\",\n \"fax\": \"6039901919\",\n \"websiteUrl\": \"https://www.delyva.com\",\n \"nature\": \"\",\n \"logo\": \"https://www.delyva.com/logo.png\",\n \"icon\": \"https://www.delyva.com/icon.png\",\n \"contactName\": \"Suhaimi Amir\",\n \"contactEmail\": \"suhaimi@delyva.com\",\n \"contactPhone\": \"60176712829\",\n \"timeZone\": \"GMT+8\",\n \"deleted\": false,\n \"created_at\": \"2019-11-03T14:10:45.033Z\",\n \"updated_at\": \"2019-11-03T14:10:45.033Z\",\n \"fullAddress\": \"\\nEarlyRisersSdn.Bhd.,\\nF-11-19,BlockF,PacificPalace,\\nAraDamansara,\\n47301,\\nPetalingJaya,\\nSelangor,\\nMY,\\n\"\n },\n {\n \"id\": \"4ec530fa-ebcf-40e4-adca-15e3c8e8fc8b\",\n \"planId\": 1,\n \"code\": \"delyva\",\n \"name\": \"Delyva\",\n \"regNo\": \"1183844-A\",\n \"address1\": \"Early Risers Sdn. Bhd. 2\",\n \"address2\": \"F-11-19, Block F, Pacific Palace\",\n \"address3\": \"Ara Damansara\",\n \"postcode\": \"47301\",\n \"city\": \"Petaling Jaya\",\n \"state\": \"Selangor\",\n \"country\": \"MY\",\n \"businessType\": \"Fleet Management\",\n \"courierOperation\": \"Pickup Only\",\n \"courierAgentType\": [\n \"Full-time Agent\",\n \"Crowdsource\"\n ],\n \"volume\": 500,\n \"email\": \"hello@delyva.com\",\n \"phone\": \"6036419090\",\n \"fax\": \"6039901919\",\n \"websiteUrl\": \"https://www.delyva.com\",\n \"nature\": \"\",\n \"logo\": \"https://www.delyva.com/logo.png\",\n \"icon\": \"https://www.delyva.com/icon.png\",\n \"contactName\": \"Ridhuan Hassan\",\n \"contactEmail\": \"ridhuan@delyva.com\",\n \"contactPhone\": \"60176712829\",\n \"timeZone\": \"\",\n \"deleted\": false,\n \"created_at\": \"2019-09-24T05:20:43.315Z\",\n \"updated_at\": \"2019-09-24T05:20:43.315Z\",\n \"fullAddress\": \"\\nEarlyRisersSdn.Bhd.2,\\nF-11-19,BlockF,PacificPalace,\\nAraDamansara,\\n47301,\\nPetalingJaya,\\nSelangor,\\nMY,\\n\"\n },\n {\n \"id\": \"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"planId\": 1,\n \"code\": \"matdespatch-my\",\n \"name\": \"MatDespatch\",\n \"regNo\": \"1111111-A\",\n \"address1\": \"Early Risers Sdn. Bhd.\",\n \"address2\": \"F-11-19, Block F, Pacific Palace\",\n \"address3\": \"Ara Damansara\",\n \"postcode\": \"47301\",\n \"city\": \"Petaling Jaya\",\n \"state\": \"Selangor\",\n \"country\": \"MatDespatch\",\n \"businessType\": \"test\",\n \"courierOperation\": \"test\",\n \"courierAgentType\": [],\n \"volume\": 0,\n \"email\": \"suhaimi@delyva.com\",\n \"phone\": \"6036419090\",\n \"fax\": \"6039901919\",\n \"websiteUrl\": \"https://www.delyva.com\",\n \"nature\": \"\",\n \"logo\": \"https://www.delyva.com/logo.png\",\n \"icon\": \"https://www.delyva.com/icon.png\",\n \"contactName\": \"Suhaimi Amir\",\n \"contactEmail\": \"suhaimi@delyva.com\",\n \"contactPhone\": \"60137778595\",\n \"timeZone\": \"GMT+8\",\n \"deleted\": false,\n \"created_at\": \"2019-11-06T02:21:55.160Z\",\n \"updated_at\": \"2019-11-06T02:21:55.160Z\",\n \"fullAddress\": \"\\nEarlyRisersSdn.Bhd.,\\nF-11-19,BlockF,PacificPalace,\\nAraDamansara,\\n47301,\\nPetalingJaya,\\nSelangor,\\nMatDespatch,\\n\"\n }\n ]\n }\n}"}],"_postman_id":"2f53bdc6-17c0-4b21-b4c6-15ca82a14945"}],"id":"35b02d77-2394-42b0-847d-c43ada79b313","description":"There's two type of authentication you can use. You can choose which one is suitable to your needs.
\n- \n
API Key
\n \nJWT Token
\n \n
Request
\nWaypoint Object (origin & destination)
\nAll field is optional but, at least one is required.
\nService Addon object
\nWeight Object
\nDimension Object
\nDistance Object
\n\n
Response
\nStandard Response
\nError
\nData
\nServiceQuote
\nMoney
\nWeight
\nDistance
\nMileage
\nService
\nServiceCompany
\nAddon
\nAddonField
\nWaypoint
\nCoordinate
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}},"urlObject":{"path":["v1.0","service","instantQuote"],"host":["{{API_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"4a5b07e0-b522-450b-a0ff-f1f75054b59c","name":"instant quote with address","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customerId\": 123,\n \"origin\": {\n \"address1\": \"28 Jalan 5\",\n \"address2\": \"Taman Mesra\",\n \"city\": \"Kajang\",\n \"state\": \"Selangor\",\n \"postcode\": \"43000\",\n \"country\": \"MY\",\n \"coord\": {\n \"lat\": \"3.013478\",\n \"lon\": \"101.779682\"\n }\n },\n \"destination\": {\n \"address1\": \"F-11-19 Pacific Place\",\n \"address2\": \"Ara Damansara\",\n \"city\": \"Petaling Jaya\",\n \"state\": \"Selangor\",\n \"postcode\": \"47301\",\n \"country\": \"MY\",\n \"coord\": {\n \"lat\": \"3.11100853226846\",\n \"lon\": \"101.58726936290537\"\n }\n },\n \"weight\": {\n \"unit\": \"kg\",\n \"value\": 10\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{API_ENDPOINT}}/service/instantQuote"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"services\": [\n {\n \"price\": {\n \"amount\": 10,\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 10,\n \"unit\": \"kg\"\n },\n \"distance\": {\n \"value\": 308.091,\n \"unit\": \"km\"\n },\n \"commission\": {\n \"amount\": 1,\n \"currency\": \"MYR\"\n },\n \"revenue\": {\n \"amount\": 9,\n \"currency\": \"MYR\"\n },\n \"service\": {\n \"id\": 1,\n \"companyId\": \"9caa4e01-04ac-4434-a794-f6cdbda90704\",\n \"serviceCompanyId\": null,\n \"name\": \"Same Day Delivery\",\n \"code\": \"SDD\",\n \"serviceGroupId\": 1,\n \"status\": 1,\n \"custDescription\": \"hahaC\",\n \"driverInstruction\": \"hahaD\",\n \"operationType\": null,\n \"paymentMethod\": \"debit\",\n \"multiWaypoint\": false,\n \"plugin\": null,\n \"consignmentLabelGroupId\": 1,\n \"consignmentId\": null\n }\n }\n ],\n \"origin\": {\n \"address1\": \"28 Jalan 5\",\n \"address2\": \"Taman Mesra\",\n \"city\": \"Kajang\",\n \"state\": \"Selangor\",\n \"postcode\": \"43000\",\n \"country\": \"MY\"\n },\n \"destination\": {\n \"address1\": \"USM Penang\",\n \"address2\": \"-\",\n \"city\": \"Gelugor\",\n \"state\": \"Penang\",\n \"postcode\": \"11800\",\n \"country\": \"MY\"\n },\n \"perf\": \"2080.09175 ms\"\n}"}],"_postman_id":"80cd6a2a-7758-466c-a866-95ae56713469"}],"id":"eaa01f94-b465-428b-b3b8-8d205687dd38","_postman_id":"eaa01f94-b465-428b-b3b8-8d205687dd38","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}}},{"name":"Create Order","item":[{"name":"Create Order","event":[{"listen":"prerequest","script":{"id":"a1a9be08-9f2f-4889-aab6-76bc617fe125","exec":["// pm.environment.set('API_ENDPOINT', 'https://staging-api.delyva.com');","pm.environment.set('API_ENDPOINT', 'localhost:3000');"],"type":"text/javascript"}}],"id":"36aa5c0c-f35b-4ca0-b348-28d2de9ae403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"123\",\n \"process\": true,\n \"serviceCode\": \"SERVICECODE_FROM_PRICE_QUOTE\",\n \"origin\": {\n \"scheduledAt\": \"2020-12-24T12:00:00+0800\",\n \"inventory\": [\n {\n \"name\": \"Mee Kari\",\n \"type\": \"PARCEL\",\n \"price\": {\n \"amount\": \"10.50\",\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 1,\n \"unit\": \"kg\"\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n },\n \"quantity\": 1,\n \"description\": \"\"\n },\n {\n \"name\": \"Ayam Goreng\",\n \"type\": \"PARCEL\",\n \"price\": {\n \"amount\": \"8.00\",\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 500,\n \"unit\": \"g\"\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n },\n \"quantity\": 1,\n \"description\": \"\"\n }\n ],\n \"contact\": {\n \"name\": \"Test Sender\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"60124433300\",\n \"unitNo\": \"\",\n \"address1\": \"157, Jalan Ampang\",\n \"address2\": \"\",\n \"city\": \"Wilayah Persekutuan\",\n \"state\": \"Kuala Lumpur\",\n \"postcode\": \"55000\",\n \"country\": \"MY\",\n \"coord\": {\n \"lat\": \"3.013478\",\n \"lon\": \"101.779682\"\n }\n }\n },\n \"destination\": {\n \"inventory\": [\n {\n \"name\": \"Mee Kari\",\n \"type\": \"PARCEL\",\n \"price\": {\n \"amount\": \"10.50\",\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 1,\n \"unit\": \"kg\"\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n },\n \"quantity\": 1,\n \"description\": \"\"\n },\n {\n \"name\": \"Ayam Goreng\",\n \"type\": \"PARCEL\",\n \"price\": {\n \"amount\": \"8.00\",\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 500,\n \"unit\": \"g\"\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n },\n \"quantity\": 1,\n \"description\": \"\"\n }],\n \"contact\": {\n \"name\": \"Mr Receiver\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"60124433300\",\n \"mobile\": \"60124433300\",\n \"unitNo\": \"6-8\",\n \"address1\": \"MRT Sungai Jernih (SBK33)\",\n \"address2\": \"1, Kampung Sungai Kantan\",\n \"city\": \"Kajang\",\n \"state\": \"Selangor\",\n \"postcode\": \"43000\",\n \"country\": \"MY\",\n \"coord\": {\n \"lat\": \"3.013478\",\n \"lon\": \"101.779682\"\n }\n }\n }\n}"},"url":"{{API_ENDPOINT}}/v1.0/order","description":"* Consignment number wont be returned immediately, new order will first get in queue, it'll usually be processed immediately or within few seconds on peak hour.
* You can then get the consignment number with GET /order/:orderId or via order.created webhook
* order.process = false will save the order as draft, you can then process the order later with Process Order API
* order.poll = true will wait for the order to finished processing before responding, but please take note that if the time taken to process the order exceed 5 seconds, it'll return current order status. Make sure to check the statusCode returned is 100 (created).
Standard create order workflow
\n![](\"https://cdn.delyva.app/api-docs/delyvax_create_order_recommended.png\")
\n\nPolled create order workflow
\n![](\"https://cdn.delyva.app/api-docs/delyvax_create_order_polled2.png\")
\n\nRequest
\nCreate order object
\nOrder waypoint object
\nOrder waypoint inventory object
\nOrder waypoint contact object
\ncoord is required for on-demand courier (eg: Lalamove, GrabExpress)
\nInventory Weight Object
\nInventory Dimension Object
\nInventory Price Object
\n\n
Response
\nSuccess Response
\nError
\nData (Standard Async Response)
\nData (Non-async Response | poll=true)
\nDimension
\nServiceAddon
\nBillingAddress
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}},"urlObject":{"path":["v1.0","order"],"host":["{{API_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"fb5fcb6f-e64a-4a6b-9b3d-412f69e16e99","name":"Create Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"123\",\n \"process\": true,\n \"serviceCode\": \"SERVICECODE_FROM_PRICE_QUOTE\",\n \"origin\": {\n \"scheduledAt\": \"2020-12-24T12:00:00+0800\",\n \"inventory\": [\n {\n \"name\": \"Mee Kari\",\n \"type\": \"PARCEL\",\n \"price\": {\n \"amount\": \"10.50\",\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 1,\n \"unit\": \"kg\"\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n },\n \"quantity\": 1,\n \"description\": \"\"\n },\n {\n \"name\": \"Ayam Goreng\",\n \"type\": \"PARCEL\",\n \"price\": {\n \"amount\": \"8.00\",\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 500,\n \"unit\": \"g\"\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n },\n \"quantity\": 1,\n \"description\": \"\"\n }\n ],\n \"contact\": {\n \"name\": \"Test Sender\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"60124433300\",\n \"unitNo\": \"\",\n \"address1\": \"157, Jalan Ampang\",\n \"address2\": \"\",\n \"city\": \"Wilayah Persekutuan\",\n \"state\": \"Kuala Lumpur\",\n \"postcode\": \"55000\",\n \"country\": \"MY\",\n \"coord\": {\n \"lat\": \"3.013478\",\n \"lon\": \"101.779682\"\n }\n }\n },\n \"destination\": {\n \"inventory\": [\n {\n \"name\": \"Mee Kari\",\n \"type\": \"PARCEL\",\n \"price\": {\n \"amount\": \"10.50\",\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 1,\n \"unit\": \"kg\"\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n },\n \"quantity\": 1,\n \"description\": \"\"\n },\n {\n \"name\": \"Ayam Goreng\",\n \"type\": \"PARCEL\",\n \"price\": {\n \"amount\": \"8.00\",\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 500,\n \"unit\": \"g\"\n },\n \"dimension\": {\n \"width\": 10,\n \"height\": 11,\n \"length\": 12,\n \"unit\": \"cm\"\n },\n \"quantity\": 1,\n \"description\": \"\"\n }],\n \"contact\": {\n \"name\": \"Mr Receiver\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"60124433300\",\n \"mobile\": \"60124433300\",\n \"unitNo\": \"6-8\",\n \"address1\": \"MRT Sungai Jernih (SBK33)\",\n \"address2\": \"1, Kampung Sungai Kantan\",\n \"city\": \"Kajang\",\n \"state\": \"Selangor\",\n \"postcode\": \"43000\",\n \"country\": \"MY\",\n \"coord\": {\n \"lat\": \"3.013478\",\n \"lon\": \"101.779682\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{API_ENDPOINT}}/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,PUT,PATCH,DELETE,COPY,OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"113"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 18 Dec 2020 07:19:37 GMT"},{"key":"Etag","value":"W/\"71-p0DRnVLmEh75M92v/Dxcc2zW85s\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Delyvax-Api-Version","value":"1.0"},{"key":"X-Powered-By","value":"DelyvaX"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"orderId\": \"1c1d526f-1da3-4f4a-897f-93e82bdd3e3d\",\n \"status\": \"processing\",\n \"statusCode\": 0,\n \"invoiceId\": null\n }\n}"}],"_postman_id":"36aa5c0c-f35b-4ca0-b348-28d2de9ae403"},{"name":"Cancel Order","event":[{"listen":"prerequest","script":{"id":"f36d1cad-3d87-4927-830f-d930017c0cc5","exec":["// pm.environment.set('API_ENDPOINT', 'https://staging-api.delyva.com');",""],"type":"text/javascript"}}],"id":"fcdf8669-05f5-4e24-87b8-19834c91b45a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{API_ENDPOINT}}/v1.0/order/:orderId/cancel","description":"This will cancel the order, and set order status code to 900.
\nCancellation Policy
\n- \n
- Only when order status code is between
0and110. \n - Once order is assigned to personnel, and status changed to 200, you cannot cancel the order. \n
Use this API to processed draft order (order with statusCode 0).
\nYou can also use this to retry failed order (order with statusCode 99)
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}},"urlObject":{"path":["v1.0","order",":orderId","process"],"host":["{{API_ENDPOINT}}"],"query":[],"variable":[{"type":"string","value":"62b2a38b-1721-41eb-badb-f2bb2690ee19","key":"orderId"}]}},"response":[{"id":"dc6383fa-6d09-46f4-8928-d17e0521569a","name":"Process/Confirm Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"serviceCode\": \"SDD\",\n\t\"originScheduledAt\": \"2019-11-11T08:23:57.000Z\",\n\t\"destinationScheduledAt\": \"2019-11-12T08:23:57.000Z\"\n}"},"url":"{{API_ENDPOINT}}/order/270bf29d-9574-474f-aae2-b351e5b511c0/process"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"DelyvaX"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,PUT,PATCH,DELETE,COPY,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2136"},{"key":"ETag","value":"W/\"858-jx/OPz8z9E+l2MT/tYviVfLsSTM\""},{"key":"Date","value":"Tue, 05 Nov 2019 19:27:34 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"270bf29d-9574-474f-aae2-b351e5b511c0\",\n \"consignmentNo\": \"MM0000000006MY\",\n \"companyId\": \"9caa4e01-04ac-4434-a794-f6cdbda90704\",\n \"statusCode\": 100,\n \"status\": \"created\",\n \"updatedAt\": \"2019-11-05T19:27:34.018Z\",\n \"userId\": \"0beea380-fe48-11e9-9fa5-6977a8b97854\",\n \"customerId\": 1,\n \"serviceId\": 1,\n \"price\": {\n \"amount\": 4.3,\n \"currency\": \"MYR\"\n },\n \"revenue\": {\n \"amount\": 1,\n \"currency\": \"MYR\"\n },\n \"commission\": {\n \"amount\": 1,\n \"currency\": \"MYR\"\n },\n \"distance\": {\n \"unit\": \"mm\",\n \"value\": 0\n },\n \"weight\": {\n \"unit\": \"kg\",\n \"value\": 1\n },\n \"cod\": null,\n \"paymentTerm\": \"credit\",\n \"itemType\": \"PARCEL\",\n \"itemTypeId\": null,\n \"dimension\": null,\n \"createdAt\": \"2019-11-05T02:27:12.997Z\",\n \"deletedAt\": null,\n \"serviceCode\": \"SDD\",\n \"waypoint\": [\n {\n \"id\": \"wp_2E3xZ5rgqpSXfZFn2PF443\",\n \"orderId\": \"270bf29d-9574-474f-aae2-b351e5b511c0\",\n \"no\": 1,\n \"inventory\": [\n {\n \"name\": \"Pencil Box\",\n \"type\": \"parcel\",\n \"price\": {\n \"amount\": 10.5,\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"unit\": \"kg\",\n \"value\": 2\n },\n \"quantity\": 1,\n \"description\": \"Stationary\"\n }\n ],\n \"contact\": {\n \"city\": \"Setapak\",\n \"name\": \"Test Sender\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"60124433300\",\n \"state\": \"Wilayah Persekutuan Kuala Lumpur\",\n \"mobile\": \"60124433300\",\n \"unitNo\": \"6-8\",\n \"country\": \"Malaysia\",\n \"address1\": \"Jalan 4/27a\",\n \"address2\": \"Seksyen 2, Wangsa Maju\",\n \"postcode\": \"53300\"\n },\n \"type\": \"DROPOFF\",\n \"description\": null,\n \"status\": \"pending\",\n \"note\": null,\n \"scheduledAt\": \"2019-11-12T08:23:57.000Z\",\n \"createdAt\": \"2019-11-05T02:27:13.037Z\",\n \"updatedAt\": \"2019-11-05T19:27:32.484Z\",\n \"deletedAt\": null\n },\n {\n \"id\": \"wp_3ioXRfaAqtjG9Mf99P7ZGF\",\n \"orderId\": \"270bf29d-9574-474f-aae2-b351e5b511c0\",\n \"no\": 1,\n \"inventory\": [\n {\n \"name\": \"Pencil Box\",\n \"type\": \"parcel\",\n \"price\": {\n \"amount\": 10.5,\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"unit\": \"kg\",\n \"value\": 1\n },\n \"quantity\": 1,\n \"description\": \"Stationary\"\n }\n ],\n \"contact\": {\n \"city\": \"Setapak\",\n \"name\": \"Test Sender\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"60124433300\",\n \"state\": \"Wilayah Persekutuan Kuala Lumpur\",\n \"mobile\": \"60124433300\",\n \"unitNo\": \"6-8\",\n \"country\": \"Malaysia\",\n \"address1\": \"Jalan 4/27a\",\n \"address2\": \"Seksyen 2, Wangsa Maju\",\n \"postcode\": \"53300\"\n },\n \"type\": \"PICKUP\",\n \"description\": null,\n \"status\": \"pending\",\n \"note\": null,\n \"scheduledAt\": \"2019-11-11T08:23:57.000Z\",\n \"createdAt\": \"2019-11-05T02:27:13.037Z\",\n \"updatedAt\": \"2019-11-05T19:27:32.510Z\",\n \"deletedAt\": null\n }\n ]\n }\n}"}],"_postman_id":"60cb1f5e-f560-49ac-a8f0-2eae4a057ed6"},{"name":"Get Order Details","event":[{"listen":"prerequest","script":{"id":"9ac5107a-c665-4de7-a196-0058856ba68c","exec":["pm.environment.set('API_ENDPOINT', 'https://api.delyva.app');","// pm.environment.set('API_ENDPOINT', 'localhost:3000');"],"type":"text/javascript"}}],"id":"3c377e65-d121-4f18-b1b9-50573dce0876","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Order status code
\nYou should atleast integrate status code in bold
\n","event":[{"listen":"prerequest","script":{"id":"5d899b3d-f4f9-494d-a577-456f433648a5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0121cad3-c5a5-4f9d-9390-00152d30d3cb","type":"text/javascript","exec":[""]}}],"_postman_id":"f6a492da-8f82-42ce-9b34-3c27753755a3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}}},{"name":"Tracking","item":[{"name":"Order history","event":[{"listen":"prerequest","script":{"id":"f36d1cad-3d87-4927-830f-d930017c0cc5","exec":["// pm.environment.set('API_ENDPOINT', 'https://staging-api.delyva.com');",""],"type":"text/javascript"}}],"id":"e37ca271-6e37-46db-9c2e-14ef0c97efdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{API_ENDPOINT}}/v1.0/order/track/:consignmentNo?companyId=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}},"urlObject":{"path":["v1.0","order","track",":consignmentNo"],"host":["{{API_ENDPOINT}}"],"query":[{"description":{"content":"Required
\n","type":"text/plain"},"key":"companyId","value":""}],"variable":[{"description":{"content":"Required
\n","type":"text/plain"},"type":"string","value":"","key":"consignmentNo"}]}},"response":[{"id":"e25eb835-91b6-4b42-96b0-282067f431b7","name":"200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{API_ENDPOINT}}/order/track/:consignmentNo?companyId=9e0aed8a-5c67-42a4-82b6-e01bf7687f31","host":["{{API_ENDPOINT}}"],"path":["order","track",":consignmentNo"],"query":[{"key":"companyId","value":"9e0aed8a-5c67-42a4-82b6-e01bf7687f31"}],"variable":[{"key":"consignmentNo","value":"DM000337M"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,PUT,PATCH,DELETE,COPY,OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 20 Jan 2021 02:13:39 GMT"},{"key":"Etag","value":"W/\"40d-w8Lk9nNKtnwR2pELwwjmcpYiCBI\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Delyvax-Api-Version","value":"1.0"},{"key":"X-Powered-By","value":"DelyvaX"},{"key":"Content-Length","value":"373"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 92497,\n \"companyId\": \"9e0aed8a-5c67-42a4-82b6-e01bf7687f31\",\n \"customerId\": 414,\n \"orderId\": \"06660606-adcc-416e-b279-a57fd1fb987a\",\n \"consignmentNo\": \"DM000337M\",\n \"statusCode\": 400,\n \"statusText\": null,\n \"description\": \"In-transit by personnel\",\n \"location\": \"-\",\n \"createdAt\": \"2021-01-19T16:17:23.712Z\",\n \"coord\": {\n \"lon\": 101.7378658,\n \"lat\": 3.1422749\n }\n },\n {\n \"id\": 92496,\n \"companyId\": \"9e0aed8a-5c67-42a4-82b6-e01bf7687f31\",\n \"customerId\": 414,\n \"orderId\": \"06660606-adcc-416e-b279-a57fd1fb987a\",\n \"consignmentNo\": \"DM000337M\",\n \"statusCode\": 200,\n \"statusText\": null,\n \"description\": \"Pending collection by personnel\",\n \"location\": \"-\",\n \"createdAt\": \"2021-01-19T16:14:49.980Z\",\n \"coord\": {\n \"lon\": 101.7378658,\n \"lat\": 3.1422749\n }\n },\n {\n \"id\": 92495,\n \"companyId\": \"9e0aed8a-5c67-42a4-82b6-e01bf7687f31\",\n \"customerId\": 414,\n \"orderId\": \"06660606-adcc-416e-b279-a57fd1fb987a\",\n \"consignmentNo\": \"DM000337M\",\n \"statusCode\": 100,\n \"statusText\": null,\n \"description\": \"Record created\",\n \"location\": \"-\",\n \"createdAt\": \"2021-01-19T16:14:05.527Z\",\n \"coord\": {\n \"lon\": null,\n \"lat\": null\n }\n }\n ],\n \"page\": 1,\n \"limit\": 30,\n \"rowTotal\": 3,\n \"pageTotal\": 1\n}"}],"_postman_id":"e37ca271-6e37-46db-9c2e-14ef0c97efdf"},{"name":"ETA","event":[{"listen":"prerequest","script":{"id":"72e50fe1-df41-47ca-8e04-7ced553e8246","exec":["pm.environment.set('API_ENDPOINT', 'https://staging-api.delyva.app');","// pm.environment.set('API_ENDPOINT', 'localhost:3000');"],"type":"text/javascript"}}],"id":"896056bf-e580-438d-97cf-838899af7da5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"consignmentNo\": \"000001913ASD\",\n \"resultType\": \"latestFirst\"\n}"},"url":"{{API_ENDPOINT}}/v1.0/order/track","description":"resultType=latestFirst will return last status, old status is returned in histories attribute.
Authentication is not required, but companyId is required. However companyId is optional if Bearer token is present.
\nEstimated Time Arrival
\nThis type of tracking will also return estimated time arrival when order is in statusCode 400 (in transit to pickup) or 600 (in transit for dropoff).
\nIf not applicable, arrival attribute will return as null.
If estimation can't be calculated, distance and/or duration value will returned as -1
arrival.accuracy = 1 means, the estimation is the most accurate.
arrival.accuracy = 0 means, the estimation is less accurate, due to many factor.
Request Attributes
\n","urlObject":{"path":["v1.0","order","track"],"host":["{{API_ENDPOINT}}"],"query":[],"variable":[]}},"response":[{"id":"1f289a52-7fa9-4581-8b07-588d11837f21","name":"200","originalRequest":{"method":"POST","header":[{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"consignmentNo\": \"000001913ASD\",\n \"resultType\": \"latestFirst\"\n}"},"url":"{{API_ENDPOINT}}/v1.0/order/track"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,PUT,PATCH,DELETE,COPY,OPTIONS"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 28 Dec 2020 11:57:48 GMT"},{"key":"Etag","value":"W/\"59b-+UKMs1kXPead4u0UHa0y35uWS/k\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Delyvax-Api-Version","value":"1.0"},{"key":"X-Powered-By","value":"DelyvaX"},{"key":"Content-Length","value":"460"}],"cookie":[],"responseTime":null,"body":"{\n \"data\":{\n \"companyId\":\"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"consignmentNo\":\"000001889ASD\",\n \"statusCode\":600,\n \"statusText\":\"In transit\",\n \"description\":\"In-transit\",\n \"coord\":{\n \"lon\":101.7386138,\n \"lat\":3.1413686\n },\n \"orderId\":\"3145da28-ceaf-46fd-a214-d1efc4eddf65\",\n \"origin\":\"Subang Jaya, Selangor, MY\",\n \"destination\":\"Kuala Lumpur, Wilayah Persekutuan Kuala Lumpur, MY\",\n \"histories\":[\n {\n \"id\":3095,\n \"companyId\":\"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"customerId\":32,\n \"orderId\":\"3145da28-ceaf-46fd-a214-d1efc4eddf65\",\n \"consignmentNo\":\"000001889ASD\",\n \"statusCode\":600,\n \"statusText\":\"In transit\",\n \"description\":\"In-transit\",\n \"location\":\"-\",\n \"createdAt\":\"2021-02-22T13:48:27.386Z\",\n \"metadata\":{\n \n },\n \"coord\":{\n \"lon\":101.7386138,\n \"lat\":3.1413686\n }\n },\n {\n \"id\":3094,\n \"companyId\":\"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"customerId\":32,\n \"orderId\":\"3145da28-ceaf-46fd-a214-d1efc4eddf65\",\n \"consignmentNo\":\"000001889ASD\",\n \"statusCode\":500,\n \"statusText\":\"Collected\",\n \"description\":\"Collected by personnel\",\n \"location\":\"-\",\n \"createdAt\":\"2021-02-22T13:48:12.147Z\",\n \"coord\":{\n \"lon\":101.7386138,\n \"lat\":3.1413686\n }\n },\n {\n \"id\":3093,\n \"companyId\":\"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"customerId\":32,\n \"orderId\":\"3145da28-ceaf-46fd-a214-d1efc4eddf65\",\n \"consignmentNo\":\"000001889ASD\",\n \"statusCode\":450,\n \"statusText\":\"Arrived for pick-up\",\n \"description\":\"Personnel arrived for collection\",\n \"location\":\"-\",\n \"createdAt\":\"2021-02-22T13:47:25.388Z\",\n \"coord\":{\n \"lon\":101.7386138,\n \"lat\":3.1413686\n }\n },\n {\n \"id\":3092,\n \"companyId\":\"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"customerId\":32,\n \"orderId\":\"3145da28-ceaf-46fd-a214-d1efc4eddf65\",\n \"consignmentNo\":\"000001889ASD\",\n \"statusCode\":400,\n \"statusText\":\"In transit for pick-up\",\n \"description\":\"In-transit by personnel\",\n \"location\":\"-\",\n \"createdAt\":\"2021-02-22T13:47:06.636Z\",\n \"coord\":{\n \"lon\":101.7386138,\n \"lat\":3.1413686\n }\n },\n {\n \"id\":2474,\n \"companyId\":\"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"customerId\":32,\n \"orderId\":\"3145da28-ceaf-46fd-a214-d1efc4eddf65\",\n \"consignmentNo\":\"000001889ASD\",\n \"statusCode\":200,\n \"statusText\":\"Pending for collection\",\n \"description\":\"Pending collection by personnel\",\n \"location\":\"-\",\n \"createdAt\":\"2020-12-17T07:20:22.168Z\",\n \"coord\":{\n \"lon\":101.585503108799,\n \"lat\":3.04290194150979\n }\n },\n {\n \"id\":2473,\n \"companyId\":\"2cab0b07-7a5d-4971-aeba-5ffac537a455\",\n \"customerId\":32,\n \"orderId\":\"3145da28-ceaf-46fd-a214-d1efc4eddf65\",\n \"consignmentNo\":\"000001889ASD\",\n \"statusCode\":100,\n \"statusText\":\"Record created\",\n \"description\":null,\n \"location\":\"-\",\n \"createdAt\":\"2020-12-17T07:15:44.503Z\",\n \"coord\":{\n \"lon\":null,\n \"lat\":null\n }\n }\n ],\n \"arrival\":{\n \"distance\":{\n \"value\":12407,\n \"unit\":\"m\"\n },\n \"duration\":{\n \"value\":1042,\n \"unit\":\"s\"\n },\n \"accuracy\":0\n },\n \"invoiceId\":\"9f33d6a0-757d-460b-aad4-5ad1fe337ecd\",\n \"originCoord\":{\n \"lat\":3.042901941509791,\n \"lon\":101.58550310879946\n },\n \"destinationCoord\":{\n \"lat\":3.1176925,\n \"lon\":101.6772474\n },\n \"personnel\":{\n \"name\":\"Suhaimi Amir (Real)\",\n \"phone\":\"60137777777\",\n \"vehicleName\":\"Preve Gold\",\n \"vehicleType\":\"CAR\",\n \"vehicleRegNo\":\"WXB111\",\n \"coord\":{\n \"lon\":101.7386138,\n \"lat\":3.1413686\n }\n }\n }\n}"}],"_postman_id":"896056bf-e580-438d-97cf-838899af7da5"}],"id":"06c145d0-385c-4afe-a7bc-1f03cd7f1631","_postman_id":"06c145d0-385c-4afe-a7bc-1f03cd7f1631","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}}},{"name":"Billing","item":[{"name":"Print Invoice","event":[{"listen":"prerequest","script":{"id":"a13b4b2d-bbc7-401b-b76c-f4e839b947bd","exec":["// pm.environment.set(\"API_ENDPOINT\", \"https://staging-api.delyva.app\");","// pm.environment.set(\"API_ENDPOINT\", \"localhost:3000\");","// pm.environment.set(\"invoiceId\", \"50a7e23f-f62b-4bbd-8a99-ff0f930be54b\");"],"type":"text/javascript"}}],"id":"53e8a725-e535-4555-816c-0e6f281ed2bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{API_ENDPOINT}}/v1.0/wallet/invoice/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}},"urlObject":{"path":["v1.0","wallet","invoice",":id"],"host":["{{API_ENDPOINT}}"],"query":[],"variable":[{"id":"15af0f72-12c9-495f-83f8-4f94e89d8780","type":"string","value":"19628681-fec3-4f38-97f0-be678d2d37bc","key":"id"}]}},"response":[],"_postman_id":"53e8a725-e535-4555-816c-0e6f281ed2bd"},{"name":"Pay Invoice","event":[{"listen":"prerequest","script":{"id":"71de8203-d643-4325-99ce-efb84d4021f1","exec":["// pm.environment.set(\"API_ENDPOINT\", \"https://staging-api.delyva.app\");","// pm.environment.set(\"API_ENDPOINT\", \"localhost:3000\");",""],"type":"text/javascript"}}],"id":"937bafe0-55b5-4e5a-9f63-24cb7b17d392","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{API_ENDPOINT}}/v1.0/wallet/invoice/:invoiceId/payment/?doneUrl=https://redirect.user.to.here.after.payment/success","urlObject":{"path":["v1.0","wallet","invoice",":invoiceId","payment",""],"host":["{{API_ENDPOINT}}"],"query":[{"key":"doneUrl","value":"https://redirect.user.to.here.after.payment/success"}],"variable":[{"type":"string","value":"80a83460-748f-4635-9031-e7eaf5f6243d","key":"invoiceId"}]}},"response":[{"id":"ce236c42-54bf-4d5d-aab9-008c40ae0b83","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"invoice\": {\n \t\"invoiceTypeId\": \"1\",\n \"anyId\": \"1\",\n \"currency\": \"MYR\",\n \"transactions\": [\n {\n \"id\": \"123\",\n \"date\": \"2019-05-29\"\n },\n {\n \"id\": \"1245\",\n \"date\": \"2019-06-29\"\n }\n ],\n \"status\": \"PAID\"\n },\n \"items\": [\n {\n \"name\": \"Ais Krim\",\n \"qty\": 2,\n \"price\": 25.9,\n \"discount\": 0.1,\n \"tax\": 0.06\n },\n {\n \"name\": \"Kek\",\n \"qty\": 3,\n \"price\": 50.5,\n \"discount\": 0.06,\n \"tax\": 0.05\n },\n {\n \"name\": \"Pisang\",\n \"qty\": 3,\n \"price\": 50.5,\n \"discount\": 0.06,\n \"tax\": 0.1\n },\n {\n \"name\": \"Ayam Goreng\",\n \"qty\": 3,\n \"price\": 50.5,\n \"discount\": 0.06,\n \"tax\": 0.066\n },\n {\n \"name\": \"Laksa\",\n \"qty\": 3,\n \"price\": 50.5,\n \"discount\": 0.06,\n \"tax\": 0.043\n },\n {\n \"name\": \"Teh Ais\",\n \"qty\": 5,\n \"price\": 3,\n \"discount\": 0.01,\n \"tax\": 0.2\n }\n ]\n}"},"url":"{{API_ENDPOINT}}/wallet/invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"DelyvaX"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,PUT,PATCH,DELETE,COPY,OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2095"},{"key":"ETag","value":"W/\"82f-XdnknKyS7wtZ4gA3paz2apsgJ5k\""},{"key":"Date","value":"Mon, 22 Jul 2019 07:22:38 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invoiceTypeId\": 1,\n \"anyId\": 1,\n \"currency\": \"MYR\",\n \"transactions\": [\n {\n \"id\": \"123\",\n \"date\": \"2019-05-29\"\n },\n {\n \"id\": \"1245\",\n \"date\": \"2019-06-29\"\n }\n ],\n \"status\": \"PAID\",\n \"companyId\": \"456911db-0d76-447f-9b0c-b40a451592c0\",\n \"userId\": \"67c07a70-ac41-11e9-b15e-d913ecc038fa\",\n \"date\": \"2019-07-22T07:22:38.757Z\",\n \"dueAt\": \"2019-07-28T07:22:38.757Z\",\n \"invoiceNo\": 2,\n \"items\": [\n {\n \"id\": 1,\n \"invoiceId\": \"3b229935-54bb-4a4d-854d-d907dd33a6fd\",\n \"name\": \"Ais Krim\",\n \"qty\": 2,\n \"price\": \"25.90\",\n \"tax\": \"0.06\",\n \"discount\": \"0.10\",\n \"date\": \"2019-07-22T07:22:38.760Z\",\n \"deleted\": false,\n \"created_at\": \"2019-07-22T07:22:38.760Z\",\n \"updated_at\": \"2019-07-22T07:22:38.760Z\"\n },\n {\n \"id\": 2,\n \"invoiceId\": \"3b229935-54bb-4a4d-854d-d907dd33a6fd\",\n \"name\": \"Kek\",\n \"qty\": 3,\n \"price\": \"50.50\",\n \"tax\": \"0.05\",\n \"discount\": \"0.06\",\n \"date\": \"2019-07-22T07:22:38.760Z\",\n \"deleted\": false,\n \"created_at\": \"2019-07-22T07:22:38.760Z\",\n \"updated_at\": \"2019-07-22T07:22:38.760Z\"\n },\n {\n \"id\": 3,\n \"invoiceId\": \"3b229935-54bb-4a4d-854d-d907dd33a6fd\",\n \"name\": \"Pisang\",\n \"qty\": 3,\n \"price\": \"50.50\",\n \"tax\": \"0.10\",\n \"discount\": \"0.06\",\n \"date\": \"2019-07-22T07:22:38.760Z\",\n \"deleted\": false,\n \"created_at\": \"2019-07-22T07:22:38.760Z\",\n \"updated_at\": \"2019-07-22T07:22:38.760Z\"\n },\n {\n \"id\": 4,\n \"invoiceId\": \"3b229935-54bb-4a4d-854d-d907dd33a6fd\",\n \"name\": \"Ayam Goreng\",\n \"qty\": 3,\n \"price\": \"50.50\",\n \"tax\": \"0.07\",\n \"discount\": \"0.06\",\n \"date\": \"2019-07-22T07:22:38.760Z\",\n \"deleted\": false,\n \"created_at\": \"2019-07-22T07:22:38.760Z\",\n \"updated_at\": \"2019-07-22T07:22:38.760Z\"\n },\n {\n \"id\": 5,\n \"invoiceId\": \"3b229935-54bb-4a4d-854d-d907dd33a6fd\",\n \"name\": \"Laksa\",\n \"qty\": 3,\n \"price\": \"50.50\",\n \"tax\": \"0.04\",\n \"discount\": \"0.06\",\n \"date\": \"2019-07-22T07:22:38.760Z\",\n \"deleted\": false,\n \"created_at\": \"2019-07-22T07:22:38.760Z\",\n \"updated_at\": \"2019-07-22T07:22:38.760Z\"\n },\n {\n \"id\": 6,\n \"invoiceId\": \"3b229935-54bb-4a4d-854d-d907dd33a6fd\",\n \"name\": \"Teh Ais\",\n \"qty\": 5,\n \"price\": \"3.00\",\n \"tax\": \"0.20\",\n \"discount\": \"0.01\",\n \"date\": \"2019-07-22T07:22:38.760Z\",\n \"deleted\": false,\n \"created_at\": \"2019-07-22T07:22:38.760Z\",\n \"updated_at\": \"2019-07-22T07:22:38.760Z\"\n }\n ],\n \"id\": \"3b229935-54bb-4a4d-854d-d907dd33a6fd\",\n \"totalPrice\": \"0.00\",\n \"totalPaid\": \"0.00\",\n \"deleted\": false,\n \"created_at\": \"2019-07-22T07:22:38.760Z\",\n \"updated_at\": \"2019-07-22T07:22:38.760Z\"\n }\n}"}],"_postman_id":"937bafe0-55b5-4e5a-9f63-24cb7b17d392"}],"id":"17c2999c-698e-4a91-bf4e-ea103b689a13","_postman_id":"17c2999c-698e-4a91-bf4e-ea103b689a13","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}}},{"name":"Webhook","item":[{"name":"Subscribe to webhook","id":"276a0848-0ec0-4857-a732-762117aa402b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Attributes
\n- \n
- event \n
- url \n
Attributes
\n- \n
- event \n
- url \n
You can use webhook subscriptions to receive notifications about particular events. After you've subscribed to a webhook, you can let your app execute code immediately after specific events occur, instead of having to make API calls periodically to check their status. For example, you can rely on webhooks to trigger an action in your app when order tracking has been updated, or when an order details is updated. By using webhooks subscriptions you can make fewer API calls overall, which makes sure that your apps are more efficient and update quickly.
\nHow it works?
\nAfter you configure a webhook subscription, the events that you specified will trigger a webhook notification each time they occur. This notification contains a JSON payload, and HTTP headers that provide context. For example, the order.created webhook includes the following headers:
\n- \n
X-Delyvax-Event:
\norder.created\nX-Delyvax-Hmac-Sha256:
\n0eGwdG9HEY/jFARUIr0BlYxhrp2dFRb5T3+ceQ3YUso=\n
Your application needs to respond with 200 (Success) code within 30 seconds or it will assume the request has failed and will retry POSTing again several times an hour. DelyvaX will stop trying after 10 failed attempts.
Verifying webhook
\nWebhooks created are verified by calculating a digital signature. Each webhook request includes a base64-encoded X-Delyvax-Hmac-SHA256 header, which is generated using the user's api secret (user.apiSecret) along with the data sent in the request.
\nTo verify that the request came from DelyvaX, compute the HMAC digest according to the following algorithm and compare it to the value in the X-Delyvax-Hmac-SHA256 header. If they match, then you can be sure that the webhook was sent from DelyvaX.
\nExample (Express.js)
\nrouter.post('/test', (req, res) => {\n const apiSecret = '2fa0a5f9-c4f4-45b4-ac54-aa1cccfb8822';\n const crypto = require('crypto');\n const hash = crypto\n .createHmac('sha256', apiSecret)\n .update(JSON.stringify(req.body), 'utf8', 'hex')\n .digest('base64');\n const isVerified = (hash === req.headers['x-delyva-hmac-sha256']);\n console.log(`Webhook verified: ${isVerified}`);\n res.status(200).send('OK');\n});\n\nList of supported webhook
\n","event":[{"listen":"prerequest","script":{"id":"08476c1a-b7aa-4247-8066-416a04254fa0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9394f3c4-fe2b-4ce5-93d0-2a8ba98446f1","type":"text/javascript","exec":[""]}}],"_postman_id":"a207fce6-44cb-43f6-aa30-e3234aedcb3d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{currentAccessToken}}"}]},"isInherited":true,"source":{"_postman_id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","id":"99a0cf93-6205-4ef8-9e5a-f2e8dfba10f2","name":"DelyvaX SaaS","type":"collection"}}},{"name":"Customer","item":[{"name":"Get customer details","id":"20d8148c-f170-4861-9a78-20bcd774f807","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"- \n
- Tracking number wont be returned immediately, new order will first get in queue, it'll usually be processed immediately or within few seconds on peak hour. \n
- You can then get the tracking number with
GET /order/:orderIdor via order.created webhook \n
![](\"https://cdn.delyva.app/api-docs/create-order.png\")
Introduction
\nThis API implements MS 2781:2023, the Malaysian Standard for logistics dataset in e-commerce transactions and last mile delivery. The standard aims to:
\n- \n
Improve logistics efficiency to enhance buyers' online shopping experience
\n \nImprove accuracy and exchange of data transmission to reduce delivery order errors
\n \nServe as a technical reference to ease system integration
\n \n
The API facilitates data exchange between e-commerce platforms and Logistics Service Providers (LSP), implementing the base dataset requirements for:
\n- \n
Sender information
\n \nReceiver information
\n \nParcel details
\n \nDelivery service information
\n \nDelivery status
\n \n
Create Delivery Order
\nEndpoint: /order/ms2781/create (POST)
Request Fields
\nSender/Receiver Object
\nLocation Object
\nParcel Object
\nInventory Item
\nDelivery Service
\nCancel Delivery Order
\nEndpoint: /order/ms2781/cancel (POST)
Request Fields
\nNotes
\n- \n
For weight units: 'kg', 'g', 'mg' (default: 'kg')
\n \nFor dimension units: 'm', 'cm'
\n \nFor currency: 3-letter code (default: 'MYR')
\n \nAll decimal numbers use 2 decimal places unless specified otherwise
\n \nDates format: \"YYYY-MM-DD HH:mm:ss\"
\n \nCountry codes: 2 letters, uppercase
\n \n
Example Payloads
\nCreate Delivery Order Request
\n{\n \"orderNumber\": \"ORDER123456\",\n \"sender\": {\n \"contactName\": \"John Doe\",\n \"contactNumber\": \"+60123456789\",\n \"contactEmail\": \"john@example.com\",\n \"companyName\": \"ABC Company\",\n \"location\": {\n \"address\": \"123 Jalan Example\",\n \"address2\": \"Taman Example\",\n \"postcode\": \"50000\",\n \"city\": \"Kuala Lumpur\",\n \"state\": \"Wilayah Persekutuan\",\n \"country\": \"MY\",\n \"coordinates\": {\n \"lon\": \"101.6869\",\n \"lat\": \"3.1390\"\n }\n }\n },\n \"receiver\": {\n \"contactName\": \"Jane Smith\",\n \"contactNumber\": \"+60198765432\",\n \"contactEmail\": \"jane@example.com\",\n \"location\": {\n \"address\": \"456 Jalan Sample\",\n \"postcode\": \"80100\",\n \"city\": \"Johor Bahru\",\n \"state\": \"Johor\",\n \"country\": \"MY\"\n }\n },\n \"parcel\": {\n \"quantity\": 1,\n \"orderRemarks\": \"Handle with care\",\n \"weight\": {\n \"unit\": \"kg\",\n \"parcelWeight\": 2.0\n },\n \"dimension\": {\n \"unit\": \"cm\",\n \"width\": 30.5,\n \"length\": 40.5,\n \"height\": 20.0\n },\n \"itemValue\": {\n \"amount\": 189.70,\n \"currency\": \"MYR\"\n }\n },\n \"inventory\": [\n {\n \"name\": \"Premium T-Shirt\",\n \"price\": {\n \"amount\": 49.90,\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 0.25,\n \"unit\": \"kg\"\n },\n \"quantity\": 2,\n \"description\": \"Cotton T-Shirt Size M\",\n \"hsCode\": \"610910\"\n },\n {\n \"name\": \"Casual Pants\",\n \"price\": {\n \"amount\": 89.90,\n \"currency\": \"MYR\"\n },\n \"weight\": {\n \"value\": 1.5,\n \"unit\": \"kg\"\n },\n \"quantity\": 1,\n \"description\": \"Khaki Pants Size 32\",\n \"hsCode\": \"620342\"\n }\n ],\n \"deliveryService\": {\n \"serviceType\": \"EXPRESS\",\n \"pickupDateTime\": \"2024-12-21 10:00:00\",\n \"cod\": {\n \"amount\": 239.70,\n \"currency\": \"MYR\"\n },\n \"insurance\": {\n \"amount\": 10.00,\n \"currency\": \"MYR\"\n },\n \"itemType\": \"PARCEL\"\n },\n \"customerId\": 12345,\n \"isDraft\": false\n}\n\nCreate Delivery Order Response
\n{\n \"orderNumber\": \"ORDER123456\",\n \"deliveryService\": {\n \"status\": \"created\",\n \"statusCode\": 100,\n \"createdDateTime\": \"2024-12-16 15:59:33\",\n \"trackingNumber\": \"TN987654321\",\n \"orderId\": \"9b96ffe3-62d6-4eb8-a38d-4d464d398168\",\n \"deliveryCost\": {\n \"amount\": 10.75,\n \"currency\": \"MYR\"\n }\n }\n}\n\nCancel Delivery Order Request
\n{\n \"trackingNumber\": \"TN987654321\",\n \"reason\": \"Customer requested cancellation due to wrong size ordered\"\n}\n\nCancel Delivery Order Response
\n{\n \"orderId\": \"9b96ffe3-62d6-4eb8-a38d-4d464d398168\",\n \"trackingNumber\": \"TN987654321\",\n \"status\": \"cancelled\"\n}\n\nEncrypted Payload Integration Guide
\n\n
Overview
\nThis guide explains how to send encrypted payloads to the DelyvaX API using hybrid RSA + AES encryption. This feature allows you to protect sensitive data (e.g., phone numbers, addresses) before transmission.
\nStep 1: Get Public Key
\nGET https://api.delyva.app/v1.0/encryption/public-key\n\nResponse:
\n{\n \"publicKey\": \"-----BEGIN PUBLIC KEY-----\\nMIIBI...\\n-----END PUBLIC KEY-----\",\n \"algorithm\": \"RSA-OAEP + AES-256-GCM\",\n \"usage\": { ... }\n}\n\nSave this public key. You can cache it and refresh periodically (e.g., daily).
\n\n
Step 2: Encrypt Your Payload
\nEncryption Steps:
\n- \n
Generate a random 256-bit AES key
\n \nGenerate a random 128-bit IV (initialization vector)
\n \nEncrypt your JSON payload using AES-256-GCM
\n \nEncrypt the AES key using RSA-OAEP with DelyvaX's public key
\n \nSend all components to the DelyvaX API
\n \n
Node.js Example
\nconst crypto = require('crypto');\nfunction encryptPayload(payload, publicKey) {\n // 1. Generate random AES key and IV\n const aesKey = crypto.randomBytes(32); // 256 bits\n const iv = crypto.randomBytes(16); // 128 bits\n // 2. Encrypt payload with AES-256-GCM\n const cipher = crypto.createCipheriv('aes-256-gcm', aesKey, iv);\n const jsonString = JSON.stringify(payload);\n const encrypted = Buffer.concat([\n cipher.update(jsonString, 'utf8'),\n cipher.final(),\n ]);\n const authTag = cipher.getAuthTag();\n // 3. Encrypt AES key with RSA public key\n const encryptedKey = crypto.publicEncrypt(\n {\n key: publicKey,\n padding: crypto.constants.RSA_PKCS1_OAEP_PADDING,\n oaepHash: 'sha256',\n },\n aesKey\n );\n // 4. Return encrypted components\n return {\n encryptedKey: encryptedKey.toString('base64'),\n encryptedPayload: encrypted.toString('base64'),\n iv: iv.toString('base64'),\n authTag: authTag.toString('base64'),\n };\n}\n// Usage\nconst payload = { phone: '0123456789', orderId: 'ORD-123' };\nconst encrypted = encryptPayload(payload, publicKey);\n// Send to DelyvaX API\nfetch('https://api.delyva.app/v1.0/order', {\n method: 'POST',\n headers: { 'Content-Type': 'application/json' },\n body: JSON.stringify(encrypted),\n});\n\nPython Example
\nimport json\nimport base64\nimport os\nfrom cryptography.hazmat.primitives import serialization, hashes\nfrom cryptography.hazmat.primitives.asymmetric import padding\nfrom cryptography.hazmat.primitives.ciphers.aead import AESGCM\ndef encrypt_payload(payload: dict, public_key_pem: str) -> dict:\n # Load public key\n public_key = serialization.load_pem_public_key(public_key_pem.encode())\n # 1. Generate random AES key and IV\n aes_key = os.urandom(32) # 256 bits\n iv = os.urandom(16) # 128 bits (use 12 bytes for GCM standard)\n # 2. Encrypt payload with AES-256-GCM\n aesgcm = AESGCM(aes_key)\n json_bytes = json.dumps(payload).encode('utf-8')\n # Note: AESGCM in cryptography library uses 12-byte nonce by default\n iv_12 = os.urandom(12)\n ciphertext_with_tag = aesgcm.encrypt(iv_12, json_bytes, None)\n # Split ciphertext and auth tag (last 16 bytes)\n ciphertext = ciphertext_with_tag[:-16]\n auth_tag = ciphertext_with_tag[-16:]\n # 3. Encrypt AES key with RSA-OAEP\n encrypted_key = public_key.encrypt(\n aes_key,\n padding.OAEP(\n mgf=padding.MGF1(algorithm=hashes.SHA256()),\n algorithm=hashes.SHA256(),\n label=None\n )\n )\n return {\n 'encryptedKey': base64.b64encode(encrypted_key).decode(),\n 'encryptedPayload': base64.b64encode(ciphertext).decode(),\n 'iv': base64.b64encode(iv_12).decode(),\n 'authTag': base64.b64encode(auth_tag).decode(),\n }\n\nPHP Example
\nfunction encryptPayload(array $payload, string $publicKey): array {\n // 1. Generate random AES key and IV\n $aesKey = openssl_random_pseudo_bytes(32);\n $iv = openssl_random_pseudo_bytes(16);\n // 2. Encrypt payload with AES-256-GCM\n $jsonString = json_encode($payload);\n $encrypted = openssl_encrypt(\n $jsonString,\n 'aes-256-gcm',\n $aesKey,\n OPENSSL_RAW_DATA,\n $iv,\n $authTag\n );\n // 3. Encrypt AES key with RSA-OAEP\n openssl_public_encrypt($aesKey, $encryptedKey, $publicKey, OPENSSL_PKCS1_OAEP_PADDING);\n return [\n 'encryptedKey' => base64_encode($encryptedKey),\n 'encryptedPayload' => base64_encode($encrypted),\n 'iv' => base64_encode($iv),\n 'authTag' => base64_encode($authTag),\n ];\n}\n\n\n
Step 3: Send Encrypted Request
\nPOST /v1.0/order\nContent-Type: application/json\n{\n \"encryptedKey\": \"base64-encoded-rsa-encrypted-aes-key\",\n \"encryptedPayload\": \"base64-encoded-aes-encrypted-json\",\n \"iv\": \"base64-encoded-iv\",\n \"authTag\": \"base64-encoded-auth-tag\"\n}\n\nDelyvaX will:
\n- \n
Decrypt the AES key using its RSA private key
\n \nDecrypt the payload using the AES key
\n \nProcess your request normally
\n \n
\n
Non-Encrypted Requests
\nEncryption is optional. You can still send normal JSON requests:
\nPOST /v1.0/order\nContent-Type: application/json\n{\n \"phone\": \"0123456789\",\n \"orderId\": \"ORD-123\"\n}\n\n\n
Encryption Specifications
\n\n
Troubleshooting
\n\n
Support
\nFor integration support, contact us at:
\n- \n
- Email: dev@delyva.com \n