{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"95f6e127-c940-4ef4-99ee-624716b92374","name":"SHIPMENT Copy","description":"**Shipment API Documentation**\n\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.\n\n---\n\n### **API Guidelines**\n\nOur APIs use the REST architecture and support the following HTTP methods:\n\n- **POST**: Create a new resource (e.g., create a shipment).\n    \n- **GET**: Retrieve details of a resource (e.g., get shipment details).\n    \n- **PUT**: Update an existing resource (e.g., update shipment status).\n    \n\n#### **Request and Response Format**\n\n- Request body: JSON format\n    \n- Response body: JSON format\n    \n\n#### **Important Notes**\n\n- Ensure all requests include valid API credentials.\n    \n- Any changes made through the API will directly reflect in your account.\n    \n\n---\n\n### **Common Errors and Response Codes**\n\nBelow are the standard response codes you may encounter:\n\n| **Code** | **Description** |\n| --- | --- |\n| 200 | Success: The request was processed successfully. |\n| 400 | Bad Request: Invalid request format or parameters. |\n| 401 | Unauthorized: Authentication failed. |\n| 404 | Not Found: The requested resource does not exist. |\n| 500 | Internal Server Error: An unexpected error occurred. |\n\n---\n\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.\n\nBelow are some associated status codes related to the shipments:\n\n##### Shipment Status Codes:\n\n| **Status Code** | **Description** |\n| --- | --- |\n| 1 | SHIPMENT_CREATED |\n| 2 | PICKUP_RESCHEDULED |\n| 3 | OUT_FOR_PICKUP |\n| 4 | PICKED_UP |\n| 5 | SHIPPED |\n| 6 | IN_TRANSIT |\n| 7 | REACHED_DESTINATION_HUB |\n| 8 | OUT_FOR_DELIVERY |\n| 9 | DELIVERED |\n| 10 | LOST |\n| 11 | DAMAGED |\n| 12 | PICKUP_EXCEPTION |\n| 13 | DELIVERY_EXCEPTION |\n| 14 | RTO_NDR |\n| 15 | RTO_INITIATED |\n| 16 | RTO_OFD |\n| 17 | RTO_IN_TRANSIT |\n| 18 | RTO_DELIVERED |\n| 19 | CANCELLED |\n| 20 | NDR |\n| 21 | NPR |\n| 22 | NDR_RESOLVED |\n| 23 | NPR_RESOLVED |\n\nBelow are some associated NDR reasons related to the shipments:\n\n### NPR Reasons:\n\n| Reason Code | Reason Description |\n| --- | --- |\n| 1 | Seller Not Available / Phone no. Not Contactable |\n| 2 | Incomplete Address/vendor Shifted |\n| 3 | No Pickup / Shipment Not Ready |\n| 4 | Vehicle Issue / Space Constraint |\n| 5 | Regulatory non-compliance |\n| 6 | Pickup request cancelled by Seller |\n| 7 | Seller Requested Future Pick up |\n| 8 | Awb rejected |\n| 9 | Duplicate Pickup Request |\n| 10 | No Attempt / Pick up Delay |\n| 11 | Non Servicable Location |\n| 12 | Pick Failed Due to Dangerous Goods |\n| 13 | Product packaging Issue |\n| 14 | RTO |\n| 15 | Shipment Handedover to other courier |\n| 16 | Shipper Premises Closed |\n| 17 | Bar Code Issue |\n| 18 | Seller Closed |\n| 19 | COVID-Access Restricted |\n| 20 | Pick up Request Expired |\n| 21 | Partial Pickup |\n| 22 | Entry not Permitted |\n| 23 | Customer wants refund/replacement first |\n\nBelow are some associated NPR reasons related to the shipments:\n\n### NDR Reasons:\n\n| Reason Code | Reason Description |\n| --- | --- |\n| 1 | Consignee Uncontactable |\n| 2 | Wrong Address |\n| 3 | COD Not Ready |\n| 4 | Customer Asked For Future Delivery |\n| 5 | Customer Asked For Self Collect |\n| 6 | Customer Refused |\n| 7 | Auto Reattempt |\n| 8 | Office/Residence Closed |\n| 9 | Others |\n| 10 | Entry Restricted Area |\n| 11 | Out of Delivery Area |\n| 12 | Payment/Qty/Bill/OTP Dispute |\n| 13 | Reattempt Next Day |\n| 14 | Customer Requested Open Delivery |\n| 15 | Customer did not show ID card |\n| 16 | Customer Not Available |\n| 17 | COVID - Access Restricted |\n| 18 | Customer Refused - OTP Verified |\n| 19 | Customer Refused - IVR Verified |\n\nBelow are some associated RTO_NDR reasons related to the shipments:\n\n### RTO_NDR Reasons\n\n| Reason Code | Reason Description |\n| --- | --- |\n| 1 | Seller Wants Open Delivery |\n| 2 | Seller Premise / Warehouse Closed |\n| 3 | Seller Not Contactable & the address is not locatable |\n| 4 | Address Not Correct |\n| 5 | Seller / Warehouse Refused to Accept Delivery |\n| 6 | Other |\n| 7 | Wrong Address |\n| 8 | Seller Refused - Shipment Damaged/Short Received |\n| 9 | Seller Refused - Content Missing/Content Mismatch |\n| 10 | Seller Refused - Invoice Missing |\n| 11 | Seller Uncontactable |\n| 12 | Seller Not Available |\n| 13 | Seller Asked For Future Delivery |\n| 14 | Seller Asked For Self Collect |\n| 15 | Entry Restricted Area |\n| 16 | Payment/Qty/Bill/OTP Dispute |\n| 17 | Seller did not show ID card |\n| 18 | COVID - Access Restricted |\n| 19 | Seller Refused - OTP Verified |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"40785460","team":6630933,"collectionId":"95f6e127-c940-4ef4-99ee-624716b92374","publishedId":"2sAYQZHsEU","public":true,"publicUrl":"https://postman.techeagle.in","privateUrl":"https://go.postman.co/documentation/40785460-95f6e127-c940-4ef4-99ee-624716b92374","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-01-16T11:34:54.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/6422a142cbd148a2619b9224ebcfc36667bc24c6f3b23b8eb2dc6a0010b33158","favicon":"https://techeagle.in/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://postman.techeagle.in/view/metadata/2sAYQZHsEU"}