Shipment API Documentation
\nWelcome to the Shipment API Documentation. This document is designed to help developers and users easily understand and integrate our APIs for creating, updating, retrieving, and managing shipments. With our APIs, you can seamlessly interact with your shipment management system.
\nOur APIs use the REST architecture and support the following HTTP methods:
\nPOST: Create a new resource (e.g., create a shipment).
\nGET: Retrieve details of a resource (e.g., get shipment details).
\nPUT: Update an existing resource (e.g., update shipment status).
\nRequest body: JSON format
\nResponse body: JSON format
\nEnsure all requests include valid API credentials.
\nAny changes made through the API will directly reflect in your account.
\nBelow are the standard response codes you may encounter:
\nThese APIs can be used to get shipment details. You can either get all shipment details at once or the details of a particular shipment. You can create and update the shipment also.
\nBelow are some associated status codes related to the shipments:
\nBelow are some associated NDR reasons related to the shipments:
\nBelow are some associated NPR reasons related to the shipments:
\nBelow are some associated RTO_NDR reasons related to the shipments:
\nThis api is use to log in to your account and it gives use authorization token.
\n","urlObject":{"path":["user","login"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f6f59dc0-db36-4d16-99fe-2824240a3cd0","name":"Generate Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n{\n \"projectName\":\"LAPP\",\n \"userEmail\": \"john@example.in\",\n \"password\": \"john@123456\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://lap.techeagle.in/api/v1/user/login"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"445"},{"key":"ETag","value":"W/\"1bd-iz+IN1o0tFG9GQHoKjwm8WDh1Oo\""},{"key":"Date","value":"Wed, 01 Jan 2025 13:13:42 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"msg\": \"User login successful\",\n \"data\": {\n \"access_token\": \"xxx\",\n \"userName\": \"john.david\",\n \"userEmail\": \"john@example.in\",\n \"projectName\": \"LAPP\",\n \"approved\": \"incomplete\",\n \"userProfile\": \"default user\"\n }\n}"}],"_postman_id":"6305be1b-10c8-420a-8a13-f567136cf977"}],"id":"f20474c0-d223-4cb8-8f57-7a6a47f88570","description":"The authentication token is an alphanumeric code, unique to your Shipment account, can be used from any system to validate your API calls to access Shipment's resources. Shipment API uses JWT tokens for validation.
\nUse this API to validate your API user and obtain the authentication token. Copy this token and use it further to validate your API calls.
\nSteps To Use Token:
\nCopy the token received in response.
\nInclude 'Authorization: yourtokenvalue' in the appropriate field of your code.
\nThat's all! In case of any error, try checking your parameters.
\nThis API retrieves a comprehensive list of all webhook events available for shipment services. These events represent the actions or changes that the shipment system monitors and notifies through webhooks.
\n","urlObject":{"path":["user","shipment","getAllEvents"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"94fbb8ce-c352-4021-881f-88d4c00e9fc8","name":"GetAllEvents","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"The Register Callback API allows users to register a webhook URL to receive event notifications for specific actions or updates within the system. By providing the appropriate webhook URL, users can enable seamless and automated communication between the system and their application, ensuring real-time updates. The callback URL is recommended to use the HTTPS protocol to ensure secure communication. Using HTTPS helps protect sensitive data and maintain the integrity of the communication.
\nParameters:
\n","urlObject":{"path":["user","webhook"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"7b47308b-5bf7-4ca5-8721-fa0b616273db","name":"RegisterCallback","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"This folder contains two key API endpoints for managing webhooks in our system:
\nEndpoint: /shipment/getAllEvents
Description:
This API endpoint retrieves a list of all available events that can be subscribed to using webhooks. These events represent specific actions or updates in the system that can trigger a webhook. Use this endpoint to explore the event types and their details before registering a webhook.
Endpoint: /user/webhook
Description:
This API endpoint is used to register a callback URL for a specific event. Once registered, the system will send an HTTP request to the provided URL whenever the specified event occurs.
This api is used to create the new shipment.
\nParameters:
\n","urlObject":{"path":["user","shipment","new"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c25d9260-9dbb-4e24-ba7c-6701d6de0398","name":"create new shipment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Get the details of a specific Shipment by passing the awb number in the endpoint URL. No other body parameters are required.
\n","urlObject":{"path":["user","shipment","get","TEL00098773"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"cd1e3e1b-5058-4fdb-9afe-5456f3a217a4","name":"get shipment by awb","originalRequest":{"method":"GET","header":[],"url":"https://lap.techeagle.in/api/v1/user/shipment/get/TEL00098773"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2011"},{"key":"ETag","value":"W/\"7db-f3nw1Ag4+hYfb6DG8mxAys3Ba2w\""},{"key":"Date","value":"Wed, 01 Jan 2025 13:35:25 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Shipment found successfully\",\n \"data\": [\n {\n \"s_Status\": {\n \"name\": \"CREATED\",\n \"statusCode\": 1\n },\n \"imageUrls\": [],\n \"droneTrackLink\": null,\n \"isNPR\": true,\n \"isNDR\": true,\n \"isCancelled\": false,\n \"pickUpDetails\": {\n \"isDone\": false,\n \"scheduledDate\": null,\n \"otpRequired\": true,\n \"otpVerified\": false,\n \"current_TS\": null,\n \"itemImage\": [],\n \"statusIdx\": 0,\n \"status\": \"Pending\"\n },\n \"deliveryDetails\": {\n \"isDone\": false,\n \"scheduledDate\": \"2025-01-18T06:06:28.288Z\",\n \"otpRequired\": true,\n \"otpVerified\": false,\n \"current_TS\": null,\n \"itemImage\": null,\n \"statusIdx\": 0,\n \"status\": \"Pending\"\n },\n \"products\": [\n {\n \"SKU\": \"SKU1234\",\n \"price\": 500,\n \"quantity\": 2,\n \"productId\": \"ProductId\"\n }\n ],\n \"d_Status\": [\n {\n \"statusCode\": 1,\n \"lat\": \"NA\",\n \"lng\": \"NA\",\n \"TS_status\": \"2025-01-10T07:06:28.275Z\",\n \"title\": \"Shipment Entry Created\",\n \"currentLocation\": \"NA\",\n \"remarks\": \"Shipment Entry Created\"\n },\n {\n \"statusCode\": 11,\n \"lat\": \"NA\",\n \"lng\": \"NA\",\n \"TS_status\": \"2025-01-10T07:12:55.725Z\",\n \"title\": \"PICKED_UP\",\n \"currentLocation\": \"Gurgaon\",\n \"remarks\": \"Shipment PICKED_UP\"\n },\n {\n \"statusCode\": 21,\n \"lat\": \"NA\",\n \"lng\": \"NA\",\n \"TS_status\": \"2025-01-10T07:13:14.638Z\",\n \"title\": \"No Pickup Reason\",\n \"currentLocation\": \"NA\",\n \"remarks\": \"No Pickup Reason\"\n },\n {\n \"statusCode\": 20,\n \"lat\": \"NA\",\n \"lng\": \"NA\",\n \"TS_status\": \"2025-01-10T07:13:35.643Z\",\n \"title\": \"Non Delivery Report\",\n \"currentLocation\": \"NA\",\n \"remarks\": \"Non Delivery Report\"\n }\n ],\n \"assignedAWBNumbers\": \"TEL00098773\",\n \"senderDetails\": {\n \"email\": \"sender@example.in\",\n \"address\": {\n \"city\": \"gurgaon\",\n \"state\": \"Haryana\",\n \"addressLine\": \"sample sender address line\",\n \"pincode\": \"123456\"\n },\n \"pincode\": \"123456\",\n \"phoneNo\": \"9999999999\",\n \"altPhoneNo\": \"9898989898\",\n \"TS_updated\": \"2025-01-10T07:06:28.275Z\"\n },\n \"receiverDetails\": {\n \"email\": \"john@example.in\",\n \"address\": {\n \"city\": \"mumbai\",\n \"state\": \"Maharashtra\",\n \"addressLine\": \"sample receiver address line\",\n \"pincode\": \"654321\"\n },\n \"pincode\": \"654321\",\n \"phoneNo\": \"8888888888\",\n \"altPhoneNo\": \"5656565656\",\n \"TS_updated\": \"2025-01-10T07:06:28.275Z\"\n },\n \"shipmentDetails\": {\n \"weight\": 500,\n \"dimensions\": {\n \"length\": 50,\n \"width\": 50,\n \"height\": 50\n },\n \"vWeight\": 500,\n \"eWayBillNo\": \"NA\",\n \"TS_updated\": \"2025-01-10T07:06:28.275Z\"\n },\n \"invoiceDate\": \"2023-10-06T06:26:39.000Z\",\n \"invoiceNumber\": \"Ship15454\"\n }\n ]\n}"}],"_postman_id":"7d5b9c72-619f-4710-9e34-2fbf6ddb0b74"},{"name":"get shipment bulk","id":"f30e0287-8ad1-42f6-aa78-fc7e97aff82a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Get the details of a specific Shipment by passing the multiple awb number quama seperated in the endpoint URL. No other body parameters are required.
\n","urlObject":{"path":["user","shipment","get","TEL00098773,TEL00098784"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6a884be6-efe8-43f4-a110-a7be958bd665","name":"get shipment bulk","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"This function updates the shipment details using provided AWB number. This function can update the Payment details, Reciever details, Shipment details, Sender details.
\nParameters:
\n","urlObject":{"path":["user","shipment","updatedetailsbyawb"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"036fa68c-dc3e-4dc2-b9a0-b7bdb76969d3","name":"update by AWB","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"This api cancel the shipment using awb number.
\nParameters:
\n","urlObject":{"path":["user","shipment","cancel"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"ff02f378-a531-4ef7-8410-bf428f4634b2","name":"Cancel","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"This API allows users to reschedule the pickup of a shipment. By providing the required details, such as the Air Waybill (AWB) number and the new pickup date, users can update the pickup schedule for an existing shipment.
\nParamters:
\n","urlObject":{"path":["user","shipment","rescheduledPickup"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[]}},"response":[{"id":"68493b4b-d467-4e6e-9d30-62da6a42e393","name":"New Request","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"This API facilitates the resolution of shipments categorized under NPR (Non-Pickup Reason) or NDR (Non-Delivery Reason). By specifying the type (NPR or NDR), the shipment's Air Waybill (AWB) number, and the necessary update details, users can efficiently take corrective actions to manage and address issues with such shipments.
\n","urlObject":{"path":["user","shipment","resolve",":type",":awb"],"host":["https://lap.techeagle.in/api/v1"],"query":[],"variable":[{"id":"54c418ce-0095-48ca-bcf7-5f0ea90aa832","type":"any","value":"NPR / NDR","key":"type"},{"id":"13a489c3-5eb6-425d-95f5-b5bc508547df","type":"any","value":"TE012345678","key":"awb"}]}},"response":[{"id":"940a3bc7-870d-45b4-9945-5c3d15a1e574","name":"Resolve","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"This API is used to upload photos related to a shipment. By calling this endpoint, you can add images such as proof of shipment, delivery photos, or condition images to associate them with a specific shipment record.
\nParameters:
\n","urlObject":{"protocol":"https","path":["images","new-add"],"host":["cdn","techeagle","in"],"query":[],"variable":[]}},"response":[{"id":"b9a53c46-efa8-4baa-8a3d-08a89ef03be7","name":"Post image","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"