{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0709dbeb-7905-4454-9f1d-52dd9118b9e6","name":"Proship B2C APIs","description":"### **Introduction**\n\nWelcome to the Proship API Documents! Here, you will find comprehensive resources and documentation to help you integrate and leverage the powerful capabilities of Proship's API. Our API is designed to streamline your shipping and logistics operations, providing you with real-time access to shipping rates, label generation, tracking information, and more.\n\nOur APIs are based around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) architecture and use the basic [HTTP](https://www.tutorialspoint.com/http/http_status_codes) request methods. Our APIs accept [JSON](https://www.w3schools.com/whatis/whatis_json.asp) - encoded body requests and return data in the same form.\n\n### **Getting Started**\n\nBefore you can start using the API's, a signup on proship is mandatory. Once the account is approved, you can use the signup credentials to use the API's.\n\nAlternatively, you can create a new user via proship with limited set of access(es). Please login to proship panel and navigate to **\"Settings -> Manage Users -> Create New User\"** to create a new user.\n\n# **Shipping Status Codes**\n\n| **Status** | **Code** | **Description** |\n| --- | --- | --- |\n| ORDER_PLACED | 1 | Order Has Been Placed / Manifested on Courier Partner |\n| PICKUP_PENDING | 2 | Pickup Pending |\n| PICKUP_FAILED | 3 | Pickup Failed |\n| PICKED_UP | 4 | Pickup Has Been Done |\n| INTRANSIT | 5 | In Transit |\n| OUT_FOR_DELIVERY | 6 | Shipment Out For Delivery |\n| NOT_SERVICEABLE | 7 | Area For Delivery Is Not Servicable |\n| DELIVERED | 8 | Shipment Delivered |\n| FAILED_DELIVERY | 9 | Delivery Failed |\n| CANCELLED_ORDER | 10 | Order Has Been Cancelled |\n| RTO_REQUESTED | 11 | Rto For Shipment has been Requested |\n| RTO | 12 | Marked As Return |\n| RTO_OUT_FOR_DELIVERY | 13 | Shipment Is Out For Delivery For RTO |\n| RTO_DELIVERED | 14 | RTO Delivered |\n| RTO_FAILED | 15 | RTO Failed |\n| LOST | 16 | Shipment is Lost |\n| DAMAGED | 17 | Shipment is damaged |\n| SHIPMENT_DELAYED | 18 | Shipment Is Delayed Or Misroute |\n| CONTACT_CUSTOMER_CARE | 19 | Contact To The Customer Care |\n| SHIPMENT_HELD | 20 | Shipment Is being held |\n| RTO_INTRANSIT | 21 | RTO In Transit |\n| OUT_FOR_PICKUP | 25 | Shipment Out For Pickup |\n| RTO_CONTACT_CUSTOMER_CARE | 26 | RTO Contact Customer Care |\n| RTO_SHIPMENT_DELAY | 27 | RTO Shipment Delayed |\n| AWB_REGISTERED | 28 | AWB registered on proship |\n| EXCHANGE_PICKUP | 30 | Exchange successful, Shipment delivered and picked up from the customer |\n| EXCHANGE_INTRANSIT | 31 | Exchanged shipment In Transit to warehouse |\n| EXCHANGE_DELIVERED | 32 | When an exchange shipment is delivered back |\n| MANIFESTED | 33 | When shipment is manifested |\n| RETURN_ORDER_PLACED | 101 | Rto For Shipment has been Requested |\n\n# **Webhooks**\n\nWith Proship Webhooks, you can seamlessly receive automated updates on shipping statuses, delivery confirmations, and other critical events directly to your preferred endpoint. Our webhooks can be be configured for the all shipping status(es) mentioned in \"Shipping Status\" section.\n\n#### JSON Structure and StatusCodes\n\nLets say the provided url to be configured for webhook is [http://www.abc.xyz/api/consumestatus](http://www.abc.xyz/api/consumestatus)\n\nThe corresponding curl for testing will be as given below:  \ncurl -X POST [http://www.abc.xyz/api/consumestatus](http://www.abc.xyz/api/consumestatus) -d '{\"orderStatusCode\": 6, \"orderStatusDescription\": \"OutForDelivery\", \"currentLocation\": \"DEL_GeetaColony\", \"courierPartnerId\": 9, \"remark\": \"Shipment is Out for Delivery\", \"isRvp\": false, \"courierPartnerEdd\": \"2020-03-25T00:00:00.000Z\", \"ndrStatusCode\": null, \"ndrStatusDescription\": null, \"timestamp\": \"2019-05-06T10:04:20.000Z\", \"creationDate\": \"2022-08-23T08:05:36.764Z\", \"waybill\": \"244089221142123\", \"courierPartnerEdd_dateStr\": \"2020-03-25\", \"reference\": \"orderABC-123\"}'\n\n#### Status Update JSON Structure\n\n{  \n\"orderStatusCode\": 6,  \n\"orderStatusDescription\": \"OutForDelivery\",  \n\"currentLocation\": \"DEL_GeetaColony\",  \n\"courierPartnerId\": 9,  \n\"remark\": \"Shipment is Out for Delivery\",  \n\"isRvp\": false,  \n\"courierPartnerEdd\": \"2020-03-25T00:00:00.000Z\",  \n\"ndrStatusCode\": null,  \n\"ndrStatusDescription\": null,  \n\"timestamp\": \"2019-05-06T10:04:20.000Z\",  \n\"creationDate\": \"2022-08-23T08:05:36.764Z\",  \n\"waybill\": \"244089221142123\",  \n\"courierPartnerEdd_dateStr\": \"2020-03-25\",  \n\"reference\": \"orderABC-123\"  \n}\n\nPlease send an email to [techsupport@prozo.com](https://mailto:techsupport@prozo.com) to configure the same for your account.\n\n### Support:\n\n- For any integration and API-related support, you can feel free to drop us an email at [<b>techsupport@prozo.com</b>](https://mailto:techsupport@prozo.com).\n    \n- For any other issues, please email us at: [<i><b>helpdesk@prozo.com</b></i>](https://mailto:helpdesk@prozo.com)_._","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"27749698","team":5194189,"collectionId":"0709dbeb-7905-4454-9f1d-52dd9118b9e6","publishedId":"2s93mBwyZ1","public":true,"publicUrl":"https://documenter-api.postman.tech/view/27749698/2s93mBwyZ1","privateUrl":"https://go.postman.co/documentation/27749698-0709dbeb-7905-4454-9f1d-52dd9118b9e6","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.11.6","publishDate":"2025-04-11T10:58:04.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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"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://documenter.gw.postman.com/view/metadata/2s93mBwyZ1"}