This document is divided into 2 sections:
\nTesting Endpoint: https://api-staging.loadshare.net
\n{{customer-code}} and {{token}} will be shared during integration.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20331024","collectionId":"82db8c5f-fce2-4332-a5e0-5180770c4e20","publishedId":"Uyxeqoqq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-05-10T21:33:53.000Z"},"item":[{"name":"Core Systems","item":[{"name":"Serviceability Check API","event":[{"listen":"prerequest","script":{"id":"c1cf2594-278a-483e-8050-975d4e0f64c7","exec":["var CryptoJS = require(\"crypto-js\");","","//Staging","var customerCode = pm.globals.get(\"customer-code\"); ","var token = pm.globals.get(\"token\");","","var genearteRandomOrderId = () =>{"," var min = 1111111111;"," var max = 5555555555;",""," min = Math.ceil(min);"," max = Math.floor(max);"," return `Test-${Math.floor(Math.random() * (max - min + 1)) + min}`;","}","","var orderId = genearteRandomOrderId();","console.log(orderId);","","var checkSum = CryptoJS.SHA256(`${token}|${customerCode}|${orderId}`).toString();","","console.log(checkSum);","","pm.environment.set(\"checksum\", checkSum);","pm.environment.set(\"requestID\", orderId);",""],"type":"text/javascript"}}],"id":"19875926-5001-419e-aa63-e6db85638d41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Checksum","value":"{{checksum}}","type":"text"},{"key":"Customer-Code","value":"{{customer-code}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\": \"{{orderId}}\",\n \"shipmentValue\": {\n \"value\": 690,\n \"unit\": \"INR\"\n },\n \"shipmentType\": \"FOOD\",\n \"tasks\": [\n {\n \"type\": \"PICK_UP\",\n \"capabilitiesRequired\": [],\n \"address\": {\n \"outletName\": \"Taco Bell, Koramangala\",\n \"address\": \"Sony World Junction, 36, 100 Feet Rd, Venkappa Garden, Koramangala, Bengaluru, Karnataka 560095\"\n },\n \"pay\": {\n \"value\": 0,\n \"unit\": \"INR\"\n },\n \"location\": {\n \"latitude\": 30.33535,\n \"longitude\": 76.38285399999995\n },\n \"items\": [\n {\n \"id\": \"29270869\",\n \"name\": \"Double Chicken Wrap\",\n \"quantity\": 1,\n \"price\": {\n \"value\": 295,\n \"unit\": \"INR\"\n }\n },\n {\n \"id\": \"39095353\",\n \"name\": \"Butter Chicken Burger\",\n \"quantity\": 1,\n \"price\": {\n \"value\": 220,\n \"unit\": \"INR\"\n }\n },\n {\n \"id\": \"81736359\",\n \"name\": \"French Fries\",\n \"quantity\": 1,\n \"price\": {\n \"value\": 155,\n \"unit\": \"INR\"\n }\n }\n ]\n },\n {\n \"type\": \"DROP\",\n \"capabilitiesRequired\": [],\n \"collect\": {\n \"value\": 0,\n \"unit\": \"INR\"\n },\n \"location\": {\n \"latitude\": 30.317538175857635,\n \"longitude\": 76.3537372648716\n },\n \"items\": [\n {\n \"id\": \"29270869\",\n \"name\": \"Double Chicken Wrap\",\n \"quantity\": 1,\n \"price\": {\n \"value\": 295,\n \"unit\": \"INR\"\n }\n },\n {\n \"id\": \"39095353\",\n \"name\": \"Butter Chicken Burger\",\n \"quantity\": 1,\n \"price\": {\n \"value\": 220,\n \"unit\": \"INR\"\n }\n },\n {\n \"id\": \"81736359\",\n \"name\": \"French Fries\",\n \"quantity\": 1,\n \"price\": {\n \"value\": 155,\n \"unit\": \"INR\"\n }\n }\n ],\n \"predictedDistanceInMetre\": 4200\n }\n ],\n \"promisedSlaInEpoch\": {\n \"assignment\": 1676010804000,\n \"total\": 1676013859000\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/hyperlocal/v2/order/checkServiceability","description":"NOTE:
\n200 OK
\nNon 200 in case of errors
\n","urlObject":{"path":["hyperlocal","v2","order","{{orderId}}","cancel"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"1f4e1f4c-28f9-4815-9803-c4110d12e7f3","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Checksum","value":"{{checksum}}","type":"text"},{"key":"Customer-Code","value":"{{customer-code}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cancellationReason\": \"Items out of stock\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/hyperlocal/v2/order/{{orderId}}/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"5cd25341-45aa-493e-a787-666a89500927","name":"Error","originalRequest":{"method":"PUT","header":[{"key":"Checksum","value":"{{checksum}}","type":"text"},{"key":"Customer-Code","value":"{{customer-code}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cancellationReason\": \"Items out of stock\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/hyperlocal/v2/order/{{orderId}}/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"HPL_CHKCMN_304\",\n \"message\": \"Invalid checksum.\",\n \"referenceId\": \"03a21c59-feb0-4e1f-b346-f0c1bb2c9681\"\n}"}],"_postman_id":"36dcb542-42df-48c4-8b9b-c735274a23d8"},{"name":"Order Location Tracking","event":[{"listen":"prerequest","script":{"id":"3a2903cc-8bab-4812-a2d0-e704472bee12","exec":[""],"type":"text/javascript"}}],"id":"9f70b627-d0ad-4253-a502-076258e564fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Checksum","value":"{{checksum}}","type":"text"},{"key":"Customer-Code","value":"{{customer-code}}","type":"text"}],"url":"{{endpoint}}/hyperlocal/v2/order/{{orderID}}/track","description":"NOTE:
\n200 OK
\n","urlObject":{"path":["hyperlocal","v2","order","{{orderId}}","issue"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9a5ced3a-7bf7-4a7e-9764-e9b60bc3af73","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Checksum","value":"{{checksum}}","type":"text"},{"key":"Customer-Code","value":"{{customer-code}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"issueCode\": \"MARKED_DELIVERED_INCORRECTLY\",\n \"issueType\": \"FOOD_ISSUES\",\n \"metadata\": {\n \"gratification\": true\n },\n \"comments\": \"Delivery incomplete\",\n \"initiator\": \"CUSTOMER\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/hyperlocal/v2/order/{{orderId}}/issue"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0e6a19da-68b9-4bd2-9819-9d8a4611c719"}],"id":"b308f7f8-aa62-438e-b960-15c274494320","description":"There are 4 APIs that form the core system. All of these are required in order to accept, process & fulfill any delivery.
\nNOTE:
\nNOTE: This API can be called multiple times.
\nHowever, in order to trigger an actual booking, you will need to call the Serviceability Check API, get a true response & then create an order.
\nA true status check does not guarantee a true serviceability check.
\nThis is sent by Loadshare to your system via a webhook. You will need to provide a webhook endpoint to us in order to get these updates.
\nNOTE:
\n200 OK
\n","urlObject":{"path":["shipment","delocation","bulkUpdate"],"host":["{{clientEndpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7532bcef-3402-41af-91ed-c2736374d699"},{"name":"Call Client Customer Support","id":"a20c5683-06ab-46f1-8a51-afa5ae166f66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{client-api-key}}","type":"text"},{"key":"shipper-id","value":"Loadshare","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"135266456315\",\n \"name\": \"Ranjeeth _Amaraexpress\",\n \"contact\": \"9999999999\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientEndpoint}}/shipment/{{shipmentId}}/deAssistance/callDE","description":"This API should trigger a phone call to the delivery executive from the client's customer support team.
\nRequest Fields:
\nResponse Fields : 200 OK
\n","urlObject":{"path":["shipment","{{shipmentId}}","deAssistance","callDE"],"host":["{{clientEndpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a20c5683-06ab-46f1-8a51-afa5ae166f66"},{"name":"triggerOTP","id":"5b448e7e-0e10-4fb1-a07b-87d9eb5682e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{client-api-key}}","type":"text"},{"key":"shipper-id","value":"Loadshare","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\": \"TESTORDER-12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientEndpoint}}/{{shipmentId}}/otp/trigger","description":"Generates OTP for the given orderId.
\nRequest Fields
\nResponse Fields :
\n","urlObject":{"path":["{{shipmentId}}","otp","trigger"],"host":["{{clientEndpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b448e7e-0e10-4fb1-a07b-87d9eb5682e8"},{"name":"verifyOTP","id":"fa8cb32b-2afd-4331-bdf1-b5b4036298df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{client-api-key}}","type":"text"},{"key":"shipper-id","value":"Loadshare","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\": \"TESTORDER-12345\",\n \"otp\": \"1234\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientEndpoint}}/{{shipmentId}}/otp/verify","description":"Validates OTP for the given orderId and a OTP entered by the field executive.
\nRequest Fields
\nResponse Fields :
\n","urlObject":{"path":["{{shipmentId}}","otp","verify"],"host":["{{clientEndpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa8cb32b-2afd-4331-bdf1-b5b4036298df"},{"name":"Call End Customer","id":"396286fc-c3b8-44c8-a1fb-add86681e04e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{client-api-key}}","type":"text"},{"key":"shipper-id","value":"Loadshare","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"135266456315\",\n \"name\": \"Ranjeeth _Amaraexpress\",\n \"contact\": \"9999999999\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientEndpoint}}/shipment/{{shipmentId}}/deAssistance/callCustomer","description":"NEGOTIABLE**
\nThis API should trigger a phone call to the delivery executive from the end customer to whom the DE is trying to deliver the order.
\nRequest Fields:
\nResponse Fields : 200 OK
\n","urlObject":{"path":["shipment","{{shipmentId}}","deAssistance","callCustomer"],"host":["{{clientEndpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"396286fc-c3b8-44c8-a1fb-add86681e04e"}],"id":"75c48f50-649e-4e6f-83cc-8d1f706257e6","description":"These items are optional, but they help improve the overall delivery experience.
\nThe current list of additional features includes:
\n