{"info":{"_postman_id":"78ed1daf-bc84-4578-a516-25a1fb55e2c6","name":"Nimbuspost Partners API","description":"\n\n

Getting Started

\n\n

Follow below given steps to get started:

\n\n

Authentication

\n\n

Use your email and password to generate token using Users->Login endpoint.

\n\n

Use generated token in request header as Authorization: Bearer {token} with each API request.

\n\n

Support

\n\n\n\n

Request Format

\n\n

Any data sent in any API endpoints is raw JSON format. No POST/GET data is accepted.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Authentication","slug":"authentication"},{"content":"Support","slug":"support"},{"content":"Request Format","slug":"request-format"}],"owner":"9692837","collectionId":"78ed1daf-bc84-4578-a516-25a1fb55e2c6","publishedId":"TW6wHnoz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-01-27T08:36:34.000Z"},"item":[{"name":"Users","item":[{"name":"Login","id":"04765e4f-80d1-4cd3-a73f-10f0d22dd5fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\" : \"abc@gmail.com\",\n \"password\" : \"12376767\"\n}"},"url":"https://api.nimbuspost.com/v1/users/login","description":"

Use this API endpoint to generate autorization token.

\n\n

Parameters:

\n
\n\n \n \n \n \n \n \n \n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n
Params\n Required\n Data Type\n Description/Example\n
emailYesstringabc@mail.com
passwordYesstring123456789
\n
","urlObject":{"path":["login"],"host":["https://api.nimbuspost.com/v1/users"],"query":[],"variable":[]}},"response":[{"id":"182939c7-bec6-4a42-a9b0-28740b1edb9c","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\" : \"abc@gmail.com\",\n \"password\" : \"12376767\"\n}"},"url":"https://api.nimbuspost.com/v1/users/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 08:39:18 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"54"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Invalid email or password\"\n}"},{"id":"3479b947-1c66-47b7-90ba-eefc4e6c71b3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\" : \"abc@gmail.com\",\n \"password\" : \"1223432\"\n}"},"url":"https://api.nimbuspost.com/v1/users/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 08:38:28 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=duetvjdjkp7ufeuojfong2fe130ucvf6; expires=Wed, 27-Jan-2021 10:38:28 GMT; Max-Age=7200; path=/; HttpOnly"},{"key":"Content-Length","value":"345"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2MTE3MzY3MDgsImp0aSI6IjNvQnJQd1k3bVQ0ME82RFwvVmJBdWNhbDZ3bjFRZEpCYnk2QU45TnFIUVhVPSIsIm5iZiI6MTYxMTczNjcwOCwiZXhwIjoxNjExNzQ3NTA4LCJkYXRhIjp7InVzZXJfaWQiOiI1NzQiLCJwYXJlbnRfaWQiOiIwIn19.-MCCK3kTSWdk8F-jH-Z0CbVQsxsLN70g6iRQvuHxMxgiPccKYW0RdYL0jM_f_w-BABP0sVV-Fq1fCMOl9-BOAw\"\n}"}],"_postman_id":"04765e4f-80d1-4cd3-a73f-10f0d22dd5fb"}],"id":"c57ebce1-8a4e-4f53-9e95-218fb259aea2","_postman_id":"c57ebce1-8a4e-4f53-9e95-218fb259aea2","description":""},{"name":"Shipments","item":[{"name":"Create Shipment","id":"3d1dd145-c6c3-4dc4-9e3a-31769e45e9ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"cod\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"request_auto_pickup\" : \"yes\",\n \"consignee\": {\n \"name\": \"Customer Name\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ],\n \"courier_id\" : \"1\",\n \"is_insurance\" : \"0\",\n \"tags\" : \"tag1, tag2\"\n}"},"url":"https://api.nimbuspost.com/v1/shipments","description":"

Use this API endpoint to generate AWB/tracking number for your order.

\n\n

Note: Order total is not automatically calculated in API request. Be sure to input the correct calculated order_amount.

\n\n

Parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n \n \n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n \n\n\n \n\n\n \n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n\n
ParamsRequiredDescriptionExample
order_numberYesstring - max length: 201234
payment_typeYesValid Values - cod, prepaid & reversecod
package_weightNoWeight in grams400
package_lengthNoPackage length in cm.12
package_breadthNoPackage breadth in cm.12
package_heightNoPackage height in cm.12
request_auto_pickupNoUse Yes to send auto pickup request to courier.Yes
shipping_chargesNoShipping chages applied.40
cod_chargesNoCOD chages applied.40
discountNoDiscount applied.40
order_amountYesTotal Order Amont.999
consignee[name]YesString - max length: 200Amit Kumar
consignee[company_name]NoString - max length: 200ABC Company
consignee[address]YesString - max length: 200140, ABC Road
consignee[address_2]NoString - max length: 200Near Metro Station
consignee[city]YesString - max length: 40Gurgaon
consignee[state]YesString - max length: 40Haryana
consignee[pincode]Yes6 digit numeric122002
consignee[phone]Yes10 digit numeric9999999999
pickup[warehouse_name]YesString - max length: 20Warehouse 1
pickup[name]YesString - max length: 200Amit Kumar
pickup[address]YesString - max length: 200140, ABC Road
pickup[address_2]NoString - max length: 200Near Metro Station
pickup[city]YesString - max length: 40Gurgaon
pickup[state]YesString - max length: 40Haryana
pickup[pincode]Yes6 digit numeric122002
pickup[phone]Yes10 digit numeric9999999999
pickup[gst_umber]No15 digit alpha numeric18AABCU9603R1ZM
is_rto_differentNoWhen Pickup & RTO address are different.
If yes then rto[] array is required.
\n Valid values - yes,no		no
rto[warehouse_name]ConditionalString - max length: 20Warehouse 1
rto[name]ConditionalString - max length: 200Amit Kumar
rto[address]ConditionalString - max length: 200140, ABC Road
rto[address_2]ConditionalString - max length: 200Near Metro Station
rto[city]ConditionalString - max length: 40Gurgaon
rto[state]ConditionalString - max length: 40Haryana
rto[pincode]Conditional6 digit numeric122002
rto[phone]Conditional10 digit numeric9999999999
courier_idNonumeric courier id5
is_insurance0numeric 0 or 11
tagsNocomma separated values. max length: 200tag1, tag2
\n
","urlObject":{"host":["https://api.nimbuspost.com/v1/shipments"],"query":[],"variable":[]}},"response":[{"id":"5d09299a-c34c-43eb-b8d9-1c859325abfb","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"cod\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"consignee\": {\n \"name\": \"Customer Name\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ]\n}"},"url":"https://api.nimbuspost.com/v1/shipments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 08:31:57 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=o6g00uru78h2gllh2p8o8619ks8fhfmd; expires=Wed, 27-Jan-2021 10:31:57 GMT; Max-Age=7200; path=/; HttpOnly"},{"key":"Content-Length","value":"286"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"order_id\": 3351555,\n \"shipment_id\": 1929242,\n \"awb_number\": \"59632220664\",\n \"courier_id\": \"5\",\n \"courier_name\": \"Bluedart\",\n \"status\": \"booked\",\n \"additional_info\": \"BOM / TEC\",\n \"payment_type\": \"cod\",\n \"label\": \"http://nimubs-assets.s3.amazonaws.com/labels/20210127140158-79.pdf\"\n }\n}"},{"id":"8643df09-b1df-4e73-b683-7c553bfa5a35","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"NP-API-KEY","type":"text","value":"624e82985beb9943010498bd036cf462f816e6c5574"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"cod\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"consignee\": {\n \"name\": \"\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ]\n}"},"url":"https://api.nimbuspost.com/v1/shipments"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 08:33:30 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"57"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Consignee name is required\\n\"\n}"},{"id":"82293332-1c2c-481d-bd8a-e56f81438642","name":"Different Pickup & RTO Address","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"cod\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"consignee\": {\n \"name\": \"Customer Name\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ],\n \"is_rto_different\" : \"yes\",\n \"rto\": {\n \"warehouse_name\": \"Warehouse 2\",\n \"name\" : \"Neeraj Yadav \",\n \"address\": \"234 Address\",\n \"address_2\": \"Near ABC\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122002\",\n \"phone\": \"8888888888\"\n }\n}"},"url":"https://api.nimbuspost.com/v1/shipments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 08:34:59 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"286"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"order_id\": 3351556,\n \"shipment_id\": 1929243,\n \"awb_number\": \"59632223744\",\n \"courier_id\": \"5\",\n \"courier_name\": \"Bluedart\",\n \"status\": \"booked\",\n \"additional_info\": \"BOM / TEC\",\n \"payment_type\": \"cod\",\n \"label\": \"http://nimubs-assets.s3.amazonaws.com/labels/20210127140503-21.pdf\"\n }\n}"},{"id":"75b51492-5b33-46e8-aa0a-a6bdfa2f7e6c","name":"With Pickup Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"cod\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"request_auto_pickup\" : \"yes\",\n \"consignee\": {\n \"name\": \"Customer Name\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ]\n}"},"url":"https://api.nimbuspost.com/v1/shipments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 10 Mar 2021 11:56:24 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"374"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"order_id\": 4493905,\n \"shipment_id\": 2555632,\n \"awb_number\": \"59655096200\",\n \"courier_id\": \"5\",\n \"courier_name\": \"Bluedart\",\n \"status\": \"booked\",\n \"additional_info\": \"BOM / TEC\",\n \"payment_type\": \"cod\",\n \"label\": \"https://nimubs-assets.s3.amazonaws.com/labels/20210310172625-19.pdf\",\n \"manifest\": \"https://nimubs-assets.s3.amazonaws.com/manifest/20210310172627-39.pdf\"\n }\n}"},{"id":"663bc24e-0fa2-4363-b21a-11afc7f83393","name":"Using Courier ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"cod\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"request_auto_pickup\" : \"yes\",\n \"consignee\": {\n \"name\": \"Customer Name\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ],\n \"courier_id\" : \"5\"\n}"},"url":"https://api.nimbuspost.com/v1/shipments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Apr 2021 10:47:50 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"374"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"order_id\": 5124428,\n \"shipment_id\": 2911980,\n \"awb_number\": \"59669772131\",\n \"courier_id\": \"5\",\n \"courier_name\": \"Bluedart\",\n \"status\": \"booked\",\n \"additional_info\": \"BOM / TEC\",\n \"payment_type\": \"cod\",\n \"label\": \"https://nimubs-assets.s3.amazonaws.com/labels/202104094161755-69.pdf\",\n \"manifest\": \"https://nimubs-assets.s3.amazonaws.com/manifest/202120409161757-55.pdf\"\n }\n}"}],"_postman_id":"3d1dd145-c6c3-4dc4-9e3a-31769e45e9ea"},{"name":"Track Single Shipment","event":[{"listen":"prerequest","script":{"id":"61c760c7-6bad-4aa7-be4c-ff238875968d","exec":[""],"type":"text/javascript"}}],"id":"420ad390-6c6b-4f9d-98bc-6f49c8b41120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.nimbuspost.com/v1/shipments/track/","description":"

Get the tracking history a particular shipment through this API by passing the Nimbuspost AWB Number in the endpoint URL itself. Type Nimbuspost shipment AWB Number in place of {awb}.

\n

No other body parameters are required.

\n

Parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n
EXAMPLE
../shipments/track/N123456789
\n
\n\n

Response Status Codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Status CodeStatus
PPPending Pickup
ITIn Transit
EXException
OFDOut For Delivery
DLDelivered
RTRTO
RT-ITRTO In Transit
RT-DLRTO Delivered
\n
","urlObject":{"path":["track",""],"host":["https://api.nimbuspost.com/v1/shipments"],"query":[],"variable":[]}},"response":[{"id":"43b64a66-e8f4-462f-b3a8-9987c3dd3bd0","name":"Failed","originalRequest":{"method":"GET","header":[],"url":"https://api.nimbuspost.com/v1/shipments/track/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 10:47:26 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Record not found\"\n}"},{"id":"87d97972-73b2-4903-89c0-f2b8aebc6b63","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api.nimbuspost.com/v1/shipments/track/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Apr 2021 10:31:21 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=i0hsk251qkk1g8i37i1bomnonofpsrlt; expires=Fri, 09-Apr-2021 12:31:21 GMT; Max-Age=7200; path=/; HttpOnly"},{"key":"Content-Length","value":"3891"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"id\": \"2482000\",\n \"order_id\": \"4340000\",\n \"order_number\": \"#JS5897\",\n \"created\": \"2021-03-01\",\n \"awb_number\": \"59650109492\",\n \"rto_awb\": \"75312963180\",\n \"courier_id\": \"24\",\n \"warehouse_id\": \"21135\",\n \"rto_warehouse_id\": \"21135\",\n \"status\": \"rto\",\n \"rto_status\": \"delivered\",\n \"shipment_info\": \"DEL / VED\",\n \"history\": [\n {\n \"status_code\": \"IT\",\n \"location\": \"BAREJA EPU (NCX)\",\n \"event_time\": \"2021-03-02 18:19\",\n \"message\": \"SHIPMENT ARRIVED\"\n },\n {\n \"status_code\": \"IT\",\n \"location\": \"BAREJA EPU (NCX)\",\n \"event_time\": \"2021-03-02 22:07\",\n \"message\": \"SHIPMENT FURTHER CONNECTED\"\n },\n {\n \"status_code\": \"IT\",\n \"location\": \"AHMEDABAD HUB (AUB)\",\n \"event_time\": \"2021-03-02 23:50\",\n \"message\": \"SHIPMENT ARRIVED AT HUB\"\n },\n {\n \"status_code\": \"IT\",\n \"location\": \"AHMEDABAD HUB (AUB)\",\n \"event_time\": \"2021-03-03 03:20\",\n \"message\": \"SHIPMENT FURTHER CONNECTED\"\n },\n {\n \"status_code\": \"IT\",\n \"location\": \"DELHI HUB (DUB)\",\n \"event_time\": \"2021-03-03 07:27\",\n \"message\": \"SHIPMENT ARRIVED AT HUB\"\n },\n {\n \"status_code\": \"IT\",\n \"location\": \"GOPINATH BAZAR HUB (GNH)\",\n \"event_time\": \"2021-03-03 13:14\",\n \"message\": \"SHIPMENT FURTHER CONNECTED\"\n },\n {\n \"status_code\": \"IT\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-03 14:50\",\n \"message\": \"SHIPMENT ARRIVED\"\n },\n {\n \"status_code\": \"OFD\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-03 14:51\",\n \"message\": \"SHIPMENT OUT FOR DELIVERY\"\n },\n {\n \"status_code\": \"EX\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-03 16:03\",\n \"message\": \"REFUSAL CONFIRMATION CODE VERIFIED\"\n },\n {\n \"status_code\": \"EX\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-03 16:04\",\n \"message\": \"CONSIGNEE REFUSED TO ACCEPT\"\n },\n {\n \"status_code\": \"IT\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-04 09:55\",\n \"message\": \"UNDELIVERED SHIPMENT HELD AT LOCATION\"\n },\n {\n \"status_code\": \"IT\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-05 10:16\",\n \"message\": \"UNDELIVERED SHIPMENT HELD AT LOCATION\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-05 17:18\",\n \"message\": \"RETURNED TO ORIGIN AT SHIPPER'S REQUEST\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-05 17:18\",\n \"message\": \"SHIPMENT ARRIVED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"PASCHIM VIHAR ETAIL (VED)\",\n \"event_time\": \"2021-03-05 19:52\",\n \"message\": \"SHIPMENT FURTHER CONNECTED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"DELHI HUB (DUB)\",\n \"event_time\": \"2021-03-05 23:57\",\n \"message\": \"SHIPMENT ARRIVED AT HUB\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"DELHI HUB (DUB)\",\n \"event_time\": \"2021-03-06 02:05\",\n \"message\": \"SHIPMENT FURTHER CONNECTED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"DEL ETAIL HUB (DEH)\",\n \"event_time\": \"2021-03-06 02:54\",\n \"message\": \"SHIPMENT IN TRANSIT\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"DEL ETAIL HUB (DEH)\",\n \"event_time\": \"2021-03-06 03:35\",\n \"message\": \"SHIPMENT ARRIVED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"DEL ETAIL HUB (DEH)\",\n \"event_time\": \"2021-03-06 05:10\",\n \"message\": \"SHIPMENT FURTHER CONNECTED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"COD PROCESSING CENTRE II (ITG)\",\n \"event_time\": \"2021-03-06 07:05\",\n \"message\": \"SHIPMENT IN TRANSIT\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"COD PROCESSING CENTRE II (ITG)\",\n \"event_time\": \"2021-03-06 07:06\",\n \"message\": \"SHIPMENT ARRIVED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"COD PROCESSING CENTRE II (ITG)\",\n \"event_time\": \"2021-03-07 05:00\",\n \"message\": \"SHIPMENT FURTHER CONNECTED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"ASLALI WAREHOUSE (ASL)\",\n \"event_time\": \"2021-03-08 00:12\",\n \"message\": \"SHIPMENT ARRIVED AT HUB\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"ASLALI WAREHOUSE (ASL)\",\n \"event_time\": \"2021-03-08 04:46\",\n \"message\": \"SHIPMENT FURTHER CONNECTED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"AHMEDABAD (PMX)\",\n \"event_time\": \"2021-03-08 06:24\",\n \"message\": \"SHIPMENT ARRIVED\"\n },\n {\n \"status_code\": \"RT-IT\",\n \"location\": \"AHMEDABAD (PMX)\",\n \"event_time\": \"2021-03-08 07:21\",\n \"message\": \"SHIPMENT OUT FOR DELIVERY\"\n },\n {\n \"status_code\": \"RT-DL\",\n \"location\": \"AHMEDABAD (PMX)\",\n \"event_time\": \"2021-03-08 11:24\",\n \"message\": \"SHIPMENT DELIVERED\"\n }\n ]\n }\n}"}],"_postman_id":"420ad390-6c6b-4f9d-98bc-6f49c8b41120"},{"name":"Bulk Shipment Tracking","event":[{"listen":"prerequest","script":{"id":"800bfd72-7904-4472-b234-0c8614565f8b","exec":[""],"type":"text/javascript"}}],"id":"59b456cd-278c-4a0a-83b5-e95fa2eb8520","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"awb\": [\n \"41529196242631\",\n \"896239973521\"\n ]\n}"},"url":"https://api.nimbuspost.com/v1/shipments/track/bulk","description":"

Use this API endpoint to track upto 100 AWBs in one API call.

\n","urlObject":{"path":["track","bulk"],"host":["https://api.nimbuspost.com/v1/shipments"],"query":[],"variable":[]}},"response":[{"id":"e54ec387-5db8-42ad-a14a-2c67ef1acb3f","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"awb\": [\n \"4152919624263\",\n \"89623997352\"\n ]\n}"},"url":"https://api.nimbuspost.com/v1/shipments/track/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Aug 2022 07:52:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"712"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"5a4c8475-2f84-42f4-8cc2-db259f0197e0"},{"key":"x-amz-apigw-id","value":"XaOJgGTqhcwFRrA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-63072a3c-5edbb37c053e0a98600b88fb"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": [\n {\n \"id\": \"123\",\n \"order_id\": \"456\",\n \"order_number\": \"#001\",\n \"created\": \"2022-08-25\",\n \"awb_number\": \"4152919624263\",\n \"rto_awb\": \"\",\n \"courier_id\": \"1\",\n \"warehouse_id\": \"113\",\n \"rto_warehouse_id\": \"113\",\n \"status\": \"pending pickup\",\n \"rto_status\": \"\",\n \"shipment_info\": \"MUM/KCK\",\n \"history\": [\n {\n \"status_code\": \"PP\",\n \"location\": \"Gurgaon_Behrampur_C (Haryana)\",\n \"event_time\": \"2022-08-25 12:01\",\n \"message\": \"Manifest uploaded\"\n }\n ]\n },\n {\n \"id\": \"13011034\",\n \"order_id\": \"22894468\",\n \"order_number\": \"170-Copy-Copy\",\n \"created\": \"2022-08-25\",\n \"awb_number\": \"89623997352\",\n \"rto_awb\": \"\",\n \"courier_id\": \"5\",\n \"warehouse_id\": \"96372\",\n \"rto_warehouse_id\": \"96372\",\n \"status\": \"pending pickup\",\n \"rto_status\": \"\",\n \"shipment_info\": \"GGN / DLE\",\n \"history\": []\n }\n ]\n}"}],"_postman_id":"59b456cd-278c-4a0a-83b5-e95fa2eb8520"},{"name":"Manifest","id":"31f3e7ea-66ce-4244-a40b-d15b191f4969","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"awbs\": [\n \"4152911775885\",\n \"NMBC0001789312\"\n ]\n}"},"url":"https://api.nimbuspost.com/v1/shipments/manifest","urlObject":{"path":["manifest"],"host":["https://api.nimbuspost.com/v1/shipments"],"query":[],"variable":[]}},"response":[{"id":"3f9b14ea-0759-4f27-b1bd-419633363ab1","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"awbs\": [\n \"4152911775845\"\n ]\n}"},"url":"https://api.nimbuspost.com/v1/shipments/manifest"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 11:40:59 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"45"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"No records found\"\n}"},{"id":"67d02771-3f70-49ae-bdc0-ed1ece229d92","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"awbs\": [\n \"4152911775885\",\n \"NMBC0001789312\"\n ]\n}"},"url":"https://api.nimbuspost.com/v1/shipments/manifest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 11:38:20 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=3sna930jmiv93sld87v6v27iv13sjel2; expires=Wed, 27-Jan-2021 13:38:20 GMT; Max-Age=7200; path=/; HttpOnly"},{"key":"Content-Length","value":"98"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": \"https://nimubs-assets.s3.amazonaws.com/manifest/202101271708221-91.pdf\"\n}"}],"_postman_id":"31f3e7ea-66ce-4244-a40b-d15b191f4969"},{"name":"Cancel Shipment","id":"074cda17-f8f6-491f-bb35-47274e20eee6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"awb\" : \"59632218892\"\n}"},"url":"https://api.nimbuspost.com/v1/shipments/cancel","urlObject":{"path":["cancel"],"host":["https://api.nimbuspost.com/v1/shipments"],"query":[],"variable":[]}},"response":[{"id":"d0be2cff-f54b-437f-a522-6eb09dd40d1c","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"awb\" : \"59632220664\"\n}"},"url":"https://api.nimbuspost.com/v1/shipments/cancel"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Jan 2021 09:29:18 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"45"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Unable to cancel\"\n}"},{"id":"e9542d64-009a-41ef-bd74-43bf2e4cd9b9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"awb\" : \"59632218892\"\n}"},"url":"https://api.nimbuspost.com/v1/shipments/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Jan 2021 09:30:08 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"46"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Shipment Cancelled\"\n}"}],"_postman_id":"074cda17-f8f6-491f-bb35-47274e20eee6"},{"name":"Create Hyperlocal Shipment","id":"b883a9c4-0e64-49e3-ad62-f096592b14a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"prepaid\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"request_auto_pickup\" : \"yes\",\n \"consignee\": {\n \"name\": \"Customer Name\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\",\n \"latitude\": \"28.48131\",\n \"longitude\": \"77.09312\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\",\n \"latitude\": \"28.48131\",\n \"longitude\": \"77.09312\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ],\n \"courier_id\" : \"autoship\",\n \"is_insurance\" : \"0\",\n \"tags\" : \"tag1, tag2\"\n}"},"url":"https://api.nimbuspost.com/v1/shipments/hyperlocal","description":"

Use this API endpoint to generate AWB/tracking number for Hyperlocal.

\n\n

Note: Order total is not automatically calculated in API request. Be sure to input the correct calculated order_amount.

\n\n

Parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n\n \n\n\n\n\n\n\n \n\n\n\n\n\n \n \n \n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n\n \n\n\n\n\n\n\n \n\n\n\n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n\n
ParamsRequiredDescriptionExample
order_numberYesstring - max length: 201234
payment_typeYesValid Values - cod, prepaidcod
package_weightNoWeight in grams400
package_lengthNoPackage length in cm.12
package_breadthNoPackage breadth in cm.12
package_heightNoPackage height in cm.12
request_auto_pickupNoUse Yes to send auto pickup request to courier.Yes
shipping_chargesNoShipping chages applied.40
cod_chargesNoCOD chages applied.40
discountNoDiscount applied.40
order_amountYesTotal Order Amont.999
consignee[name]YesString - max length: 200Amit Kumar
consignee[company_name]NoString - max length: 200ABC Company
consignee[address]YesString - max length: 200140, ABC Road
consignee[address_2]NoString - max length: 200Near Metro Station
consignee[city]YesString - max length: 40Gurgaon
consignee[state]YesString - max length: 40Haryana
consignee[pincode]Yes6 digit numeric122002
consignee[phone]Yes10 digit numeric9999999999
consignee[latitude]YesDelivery location latitude28.48131
consignee[longitude]YesDelivery location Longitude28.48131
pickup[warehouse_name]YesString - max length: 20Warehouse 1
pickup[name]YesString - max length: 200Amit Kumar
pickup[address]YesString - max length: 200140, ABC Road
pickup[address_2]NoString - max length: 200Near Metro Station
pickup[city]YesString - max length: 40Gurgaon
pickup[state]YesString - max length: 40Haryana
pickup[pincode]Yes6 digit numeric122002
pickup[phone]Yes10 digit numeric9999999999
pickup[gst_umber]No15 digit alpha numeric18AABCU9603R1ZM
pickup[latitude]YesPickup location latitude28.48131
pickup[longitude]YesPickup location Longitude28.48131
courier_idNonumeric courier id / \"autoship\"5
is_insurance0numeric 0 or 11
tagsNocomma separated values. max length: 200tag1, tag2
\n
","urlObject":{"path":["hyperlocal"],"host":["https://api.nimbuspost.com/v1/shipments"],"query":[],"variable":[]}},"response":[{"id":"add3f170-dad9-4911-b053-f513b56011ac","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"prepaid\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"request_auto_pickup\" : \"yes\",\n \"consignee\": {\n \"name\": \"Customer Name\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\",\n \"latitude\": \"28.48131\",\n \"longitude\": \"77.09312\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\",\n \"latitude\": \"28.48131\",\n \"longitude\": \"77.09312\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ],\n \"courier_id\" : \"1\",\n \"is_insurance\" : \"0\",\n \"tags\" : \"tag1, tag2\"\n}"},"url":"https://api.nimbuspost.com/v1/shipments/hyperlocal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 28 Sep 2022 10:21:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=VNmekzLX7t%2BZb2eVbSGOEwB0zM2P7KIkRt%2BeNaZ7Kn5M3OoUa3BiNhMET%2B6O%2BEfd3tcAgbYZ97v11VZBm1%2F%2Fvk51KHzCIiRcz8%2BPD%2FTzEeNj%2BjYfBovUdXMCTVEK8sK%2Fwtq5xIHE\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"751bbf528aaa92a7-FRA"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"order_id\": 24648143,\n \"shipment_id\": 13915745,\n \"awb_number\": \"180052342\",\n \"courier_id\": \"48\",\n \"courier_name\": \"Shadowfax\",\n \"status\": \"booked\",\n \"additional_info\": \"\",\n \"payment_type\": \"prepaid\",\n \"label\": \"https://nimubs-assets.s3.amazonaws.com/labels/20220928155110-16960.pdf\",\n \"manifest\": \"\"\n }\n}"},{"id":"e91b894c-cf77-456d-aade-e3395723950e","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"NP-API-KEY","type":"text","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n \"order_number\": \"#001\",\n \"shipping_charges\": 40,\n \"discount\": 100,\n \"cod_charges\": 30,\n \"payment_type\": \"prepaid\",\n \"order_amount\": 1000,\n \"package_weight\": 300,\n \"package_length\": 10,\n \"package_breadth\": 10,\n \"package_height\": 10,\n \"request_auto_pickup\" : \"yes\",\n \"consignee\": {\n \"name\": \"\",\n \"address\": \"190, ABC Road\",\n \"address_2\": \"Near Bus Stand\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharastra\",\n \"pincode\": \"400001\",\n \"phone\": \"9999999999\",\n \"latitude\": \"28.48131\",\n \"longitude\": \"77.09312\"\n },\n \"pickup\": {\n \"warehouse_name\": \"warehouse 1\",\n \"name\" : \"Vikalp Sharma\",\n \"address\": \"140, MG Road\",\n \"address_2\": \"Near metro station\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"pincode\": \"122001\",\n \"phone\": \"9999999999\",\n \"latitude\": \"28.48131\",\n \"longitude\": \"77.09312\"\n },\n \"order_items\": [\n {\n \"name\": \"product 1\",\n \"qty\": \"18\",\n \"price\": \"100\",\n \"sku\": \"sku001\"\n }\n ],\n \"courier_id\" : \"1\",\n \"is_insurance\" : \"0\",\n \"tags\" : \"tag1, tag2\"\n}"},"url":"https://api.nimbuspost.com/v1/shipments/hyperlocal"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Jan 2021 08:33:30 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"57"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Consignee name is required\\n\"\n}"}],"_postman_id":"b883a9c4-0e64-49e3-ad62-f096592b14a7"}],"id":"cee1f470-b917-4d47-b84f-e27b61863e53","_postman_id":"cee1f470-b917-4d47-b84f-e27b61863e53","description":""},{"name":"Couriers","item":[{"name":"Courier List","id":"2665632a-c9b6-419b-a696-dc599f3affa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.nimbuspost.com/v1/courier","description":"

Use this API endpoint to Get the list of available couriers for your account.

\n\n

No parameters are required.

","urlObject":{"host":["https://api.nimbuspost.com/v1/courier"],"query":[],"variable":[]}},"response":[{"id":"b336d3de-e3e9-4356-b1ab-5c502535f67c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.nimbuspost.com/v1/courier"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Apr 2021 11:01:39 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"909"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": [\n {\n \"id\": \"5\",\n \"name\": \"Bluedart Express\"\n },\n {\n \"id\": \"24\",\n \"name\": \"Bluedart IND\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Delhivery Air\"\n },\n {\n \"id\": \"6\",\n \"name\": \"Delhivery Surface\"\n },\n {\n \"id\": \"13\",\n \"name\": \"Delhivery Surface 10 K.G\"\n },\n {\n \"id\": \"7\",\n \"name\": \"Delhivery Surface 2 K.G\"\n },\n {\n \"id\": \"35\",\n \"name\": \"Delhivery Surface 20 K.G\"\n },\n {\n \"id\": \"11\",\n \"name\": \"Delhivery Surface 5 K.G\"\n },\n {\n \"id\": \"8\",\n \"name\": \"DTDC Air\"\n },\n {\n \"id\": \"9\",\n \"name\": \"DTDC Surface\"\n },\n {\n \"id\": \"30\",\n \"name\": \"DTDC Surface 1 K.G\"\n },\n {\n \"id\": \"31\",\n \"name\": \"DTDC Surface 10 K.G\"\n },\n {\n \"id\": \"29\",\n \"name\": \"DTDC Surface 5 K.G\"\n },\n {\n \"id\": \"15\",\n \"name\": \"Ekart\"\n },\n {\n \"id\": \"25\",\n \"name\": \"Ekart 1 K.G\"\n },\n {\n \"id\": \"27\",\n \"name\": \"Ekart 2 K.G\"\n },\n {\n \"id\": \"28\",\n \"name\": \"Ekart 5 K.G\"\n },\n {\n \"id\": \"4\",\n \"name\": \"Shadowfax\"\n },\n {\n \"id\": \"21\",\n \"name\": \"Shadowfax - VH\"\n },\n {\n \"id\": \"32\",\n \"name\": \"Shadowfax 1 K.G\"\n },\n {\n \"id\": \"33\",\n \"name\": \"Shadowfax 2 K.G\"\n },\n {\n \"id\": \"34\",\n \"name\": \"Shadowfax 5 K.G\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Xpressbees Air\"\n },\n {\n \"id\": \"14\",\n \"name\": \"Xpressbees Surface\"\n }\n ]\n}"}],"_postman_id":"2665632a-c9b6-419b-a696-dc599f3affa1"},{"name":"Servicable Pincodes","id":"e4c0510d-6380-4fca-966e-1f6822ca922f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.nimbuspost.com/v1/courier/serviceability","description":"

Use this API endpoint to Get the list of all available pincode with serviceability.

\n\n

No parameters are required.

","urlObject":{"path":["serviceability"],"host":["https://api.nimbuspost.com/v1/courier"],"query":[],"variable":[]}},"response":[{"id":"9aec0014-0a08-4d41-8e63-2c7892537de8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://api.nimbuspost.com/v1/courier/serviceability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 19 Aug 2022 10:04:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"55267"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"7adaf229-5f04-406f-9b8b-e522dca05b45"},{"key":"CF-RAY","value":"73d2111e8c154d8e-SIN"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Content-Encoding","value":"br"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Authorization"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"XGv5jH9LhcwFQEw="},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"x-amzn-Remapped-Server","value":"cloudflare"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=XtxV5qbKXRZRaprhyA5%2BNNGijE3TrzKIs0oHcwezACvJa2OTBvjHVWw3i3ch4OE9hWQJKplQ41pQFeJkN0rDu%2FZdo11lavuTlRD919XwJyae07z9XVjW06XY%2FGCjmjYs94F3Je9j\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"},{"key":"Pragma","value":"no-cache"},{"key":"x-amzn-Remapped-Date","value":"Fri, 19 Aug 2022 10:04:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 29070,\n \"data\": [\n {\n \"pincode\": \"100003\",\n \"cod\": \"Y\",\n \"prepaid\": \"Y\"\n },\n {\n \"pincode\": \"101213\",\n \"cod\": \"Y\",\n \"prepaid\": \"Y\"\n },\n {\n \"pincode\": \"110000\",\n \"cod\": \"Y\",\n \"prepaid\": \"Y\"\n },\n {\n \"pincode\": \"999994\",\n \"cod\": \"N\",\n \"prepaid\": \"N\"\n }\n ]\n}"}],"_postman_id":"e4c0510d-6380-4fca-966e-1f6822ca922f"},{"name":"Rate & Serviceability","id":"4dc571fd-6edb-4e59-a1c4-7ed39e9cc2f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"origin\" : \"122001\",\n \"destination\" : \"122001\",\n \"payment_type\" : \"cod\",\n \"order_amount\" : \"999\",\n \"weight\" : \"600\",\n \"length\" : \"10\",\n \"breadth\" : \"10\",\n \"height\" : \"10\"\n}"},"url":"https://api.nimbuspost.com/v1/courier/serviceability","description":"

Use this API endpoint to Check serviceablity and get Freight Charges between origin and destination pincodes.

\n\n

Parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n\n\n\n\n \n\n
ParamsRequiredDescriptionExample
originYesPickup pincode / integer - length: 6123456
destinationYesDestination pincode / integer - length: 6123456
payment_typeYesValid Values - cod, prepaidcod
order_amountYes for COD orderTotal Order Amont.999
weightNoWeight in grams. Default: 500400
lengthNoPackage length in cm. Default: 1012
breadthNoPackage breadth in cm. Default: 1012
heightNoPackage height in cm. Default: 1012
\n
\n","urlObject":{"path":["serviceability"],"host":["https://api.nimbuspost.com/v1/courier"],"query":[],"variable":[]}},"response":[{"id":"8166ba0a-8369-48b6-9e9b-623bfbd1e229","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"origin\" : \"122001\",\n \"destination\" : \"122001\",\n \"payment_type\" : \"cod\",\n \"order_amount\" : \"999\",\n \"weight\" : \"600\",\n \"length\" : \"10\",\n \"breadth\" : \"10\",\n \"height\" : \"10\"\n}"},"url":"https://api.nimbuspost.com/v1/courier/serviceability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Apr 2021 08:10:10 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"3219"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": [\n {\n \"id\": \"8\",\n \"name\": \"DTDC Air\",\n \"freight_charges\": 61.36,\n \"cod_charges\": 40.12,\n \"total_charges\": 101.48,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"1\",\n \"name\": \"Delhivery Air\",\n \"freight_charges\": 75.52,\n \"cod_charges\": 42.48,\n \"total_charges\": 118,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"13\",\n \"name\": \"Delhivery Surface 10 K.G\",\n \"freight_charges\": 194.7,\n \"cod_charges\": 42.48,\n \"total_charges\": 237.18,\n \"min_weight\": 10000,\n \"chargeable_weight\": 10000\n },\n {\n \"id\": \"6\",\n \"name\": \"Delhivery Surface\",\n \"freight_charges\": 75.52,\n \"cod_charges\": 42.48,\n \"total_charges\": 118,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"7\",\n \"name\": \"Delhivery Surface 2 K.G\",\n \"freight_charges\": 81.42,\n \"cod_charges\": 42.48,\n \"total_charges\": 123.9,\n \"min_weight\": 2000,\n \"chargeable_weight\": 2000\n },\n {\n \"id\": \"11\",\n \"name\": \"Delhivery Surface 5 K.G\",\n \"freight_charges\": 169.92,\n \"cod_charges\": 42.48,\n \"total_charges\": 212.4,\n \"min_weight\": 5000,\n \"chargeable_weight\": 5000\n },\n {\n \"id\": \"21\",\n \"name\": \"Shadowfax - VH\",\n \"freight_charges\": 63.72,\n \"cod_charges\": 35.4,\n \"total_charges\": 99.12,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"14\",\n \"name\": \"Xpressbees Surface\",\n \"freight_charges\": 66.08,\n \"cod_charges\": 40.12,\n \"total_charges\": 106.2,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"5\",\n \"name\": \"Bluedart Express\",\n \"freight_charges\": 90,\n \"cod_charges\": 44.84,\n \"total_charges\": 134.84,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"29\",\n \"name\": \"DTDC Surface 5 K.G\",\n \"freight_charges\": 161.66,\n \"cod_charges\": 40.12,\n \"total_charges\": 201.78,\n \"min_weight\": 5000,\n \"chargeable_weight\": 5000\n },\n {\n \"id\": \"3\",\n \"name\": \"Xpressbees Air\",\n \"freight_charges\": 67.4,\n \"cod_charges\": 41.3,\n \"total_charges\": 108.7,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"25\",\n \"name\": \"Ekart 1 K.G\",\n \"freight_charges\": 75.52,\n \"cod_charges\": 40.12,\n \"total_charges\": 115.64,\n \"min_weight\": 1000,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"4\",\n \"name\": \"Shadowfax\",\n \"freight_charges\": 63.72,\n \"cod_charges\": 35.4,\n \"total_charges\": 99.12,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"27\",\n \"name\": \"Ekart 2 K.G\",\n \"freight_charges\": 87.32,\n \"cod_charges\": 40.12,\n \"total_charges\": 127.44,\n \"min_weight\": 2000,\n \"chargeable_weight\": 2000\n },\n {\n \"id\": \"28\",\n \"name\": \"Ekart 5 K.G\",\n \"freight_charges\": 165.2,\n \"cod_charges\": 40.12,\n \"total_charges\": 205.32,\n \"min_weight\": 5000,\n \"chargeable_weight\": 5000\n },\n {\n \"id\": \"15\",\n \"name\": \"Ekart\",\n \"freight_charges\": 75.52,\n \"cod_charges\": 42.48,\n \"total_charges\": 118,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"9\",\n \"name\": \"DTDC Surface\",\n \"freight_charges\": 68.44,\n \"cod_charges\": 40.12,\n \"total_charges\": 108.56,\n \"min_weight\": 500,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"30\",\n \"name\": \"DTDC Surface 1 K.G\",\n \"freight_charges\": 49.56,\n \"cod_charges\": 40.12,\n \"total_charges\": 89.68,\n \"min_weight\": 1000,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"32\",\n \"name\": \"Shadowfax 1 K.G\",\n \"freight_charges\": 50.74,\n \"cod_charges\": 35.4,\n \"total_charges\": 86.14,\n \"min_weight\": 1000,\n \"chargeable_weight\": 1000\n },\n {\n \"id\": \"33\",\n \"name\": \"Shadowfax 2 K.G\",\n \"freight_charges\": 76.7,\n \"cod_charges\": 35.4,\n \"total_charges\": 112.1,\n \"min_weight\": 2000,\n \"chargeable_weight\": 2000\n },\n {\n \"id\": \"34\",\n \"name\": \"Shadowfax 5 K.G\",\n \"freight_charges\": 141.6,\n \"cod_charges\": 35.4,\n \"total_charges\": 177,\n \"min_weight\": 5000,\n \"chargeable_weight\": 5000\n },\n {\n \"id\": \"35\",\n \"name\": \"Delhivery Surface 20 K.G\",\n \"freight_charges\": 343.38,\n \"cod_charges\": 42.48,\n \"total_charges\": 385.86,\n \"min_weight\": 20000,\n \"chargeable_weight\": 20000\n }\n ]\n}"},{"id":"d2f696c1-45c7-4e01-82b5-c973bbd8b49f","name":"Not Servicable","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"origin\" : \"199001\",\n \"destination\" : \"122001\",\n \"payment_type\" : \"cod\",\n \"order_amount\" : \"999\",\n \"weight\" : \"600\",\n \"length\" : \"10\",\n \"breadth\" : \"10\",\n \"height\" : \"10\"\n}"},"url":"https://api.nimbuspost.com/v1/courier/serviceability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Apr 2021 08:10:45 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=u657nahipggbck0bl5ldvfd1q1n1mjb4; expires=Thu, 08-Apr-2021 10:10:45 GMT; Max-Age=7200; path=/; HttpOnly"},{"key":"Content-Length","value":"25"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": []\n}"},{"id":"0e104b75-b651-42d2-82f0-660bab1d2391","name":"Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"origin\" : \"1001\",\n \"destination\" : \"122001\",\n \"payment_type\" : \"cod\",\n \"order_amount\" : \"999\",\n \"weight\" : \"600\",\n \"length\" : \"10\",\n \"breadth\" : \"10\",\n \"height\" : \"10\"\n}"},"url":"https://api.nimbuspost.com/v1/courier/serviceability"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 08 Apr 2021 08:11:08 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"87"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"The Origin field must be exactly 6 characters in length.\\n\"\n}"}],"_postman_id":"4dc571fd-6edb-4e59-a1c4-7ed39e9cc2f0"}],"id":"1b74be89-bc93-4ed4-ad05-219de02c5d53","_postman_id":"1b74be89-bc93-4ed4-ad05-219de02c5d53","description":""},{"name":"NDR","item":[{"name":"NDR List","id":"a22d1ac8-6b15-4a42-bebb-4e52dce1be21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.nimbuspost.com/v1/ndr","urlObject":{"protocol":"https","path":["v1","ndr"],"host":["api","nimbuspost","com"],"query":[{"disabled":true,"description":{"content":"

Comma separated AWB list to filter

\n","type":"text/plain"},"key":"awb_number","value":"1122335577"},{"disabled":true,"description":{"content":"

page number

\n","type":"text/plain"},"key":"per_page","value":"1"},{"disabled":true,"description":{"content":"

maximum 250 records

\n","type":"text/plain"},"key":"page_no","value":"50"}],"variable":[]}},"response":[{"id":"6f363cd8-0781-4f5a-a362-6f34cf5a7f77","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nimbuspost.com/v1/ndr","protocol":"https","host":["api","nimbuspost","com"],"path":["v1","ndr"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Jun 2021 12:40:02 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=749dq3urjms524kc7cgmo488k9onccvp; expires=Wed, 02-Jun-2021 14:40:02 GMT; Max-Age=7200; path=/; HttpOnly"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Content-Length","value":"2277"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": [\n {\n \"awb_number\": \"NMBC0002111111\",\n \"event_date\": \"2021-04-05\",\n \"courier_remarks\": \"Customer Not Responding\",\n \"total_attempts\": \"1\"\n },\n {\n \"awb_number\": \"4152913111112\",\n \"event_date\": \"2021-04-05\",\n \"courier_remarks\": \"No customer response from IVR call\",\n \"total_attempts\": \"2\"\n },\n {\n \"awb_number\": \"59666111113\",\n \"event_date\": \"2021-04-05\",\n \"courier_remarks\": \"CONSIGNEE REFUSED TO ACCEPT\",\n \"total_attempts\": \"1\"\n }\n ]\n}"},{"id":"dba894d4-41d3-4a43-bfeb-1ff39dda8c43","name":"Failed","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nimbuspost.com/v1/ndr","protocol":"https","host":["api","nimbuspost","com"],"path":["v1","ndr"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Jun 2021 12:40:02 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=749dq3urjms524kc7cgmo488k9onccvp; expires=Wed, 02-Jun-2021 14:40:02 GMT; Max-Age=7200; path=/; HttpOnly"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Content-Length","value":"2277"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\" : \"No record found\"\n}"}],"_postman_id":"a22d1ac8-6b15-4a42-bebb-4e52dce1be21"},{"name":"Submit NDR Action","id":"7155e42e-df2d-4832-9a24-1e9a6c9a7c90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"awb\" : \"NMBC0002111111\",\n \"action\" : \"re-attempt\",\n \"action_data\" : {\n \"re_attempt_date\" : \"2021-06-03\"\n }\n\n },\n {\n \"awb\" : \"NMBC0002111112\",\n \"action\" : \"change_address\",\n \"action_data\" : {\n \"name\" : \"customer name here\",\n \"address_1\" : \"Address 1 here\",\n \"address_2\" : \"Address 2 here\"\n }\n\n },\n {\n \"awb\" : \"NMBC0002111113\",\n \"action\" : \"change_phone\",\n \"action_data\" : {\n \"phone\" : \"99999999\"\n }\n\n }\n]"},"url":"https://api.nimbuspost.com/v1/ndr/action","description":"

Use this API endpoint to generate Take action against any AWB. Action against 100 AWBs are allowed in one request.

\n\n

Note: Action is allowed only when Exception is raised by courier company.

\n\n

Supported Action Types : re-attempt, change_address, change_phone

\n\n

Check sample request body for supported action_data for each action type.

\n","urlObject":{"protocol":"https","path":["v1","ndr","action"],"host":["api","nimbuspost","com"],"query":[],"variable":[]}},"response":[{"id":"ca6bbd95-5926-4abf-aa5d-f50b36f8dc63","name":"Result","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"awb\" : \"NMBC0002111111\",\n \"action\" : \"re-attempt\",\n \"action_data\" : {\n \"re_attempt_date\" : \"2021-06-03\"\n }\n\n },\n {\n \"awb\" : \"NMBC0002111112\",\n \"action\" : \"change_address\",\n \"action_data\" : {\n \"name\" : \"customer name here\",\n \"address_1\" : \"Address 1 here\",\n \"address_2\" : \"Address 2 here\"\n }\n\n },\n {\n \"awb\" : \"NMBC0002111113\",\n \"action\" : \"change_phone\",\n \"action_data\" : {\n \"phone\" : \"9999999999\"\n }\n\n }\n]"},"url":"https://api.nimbuspost.com/v1/ndr/action"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Jun 2021 13:02:24 GMT"},{"key":"Server","value":"Apache/2.4.46 (Ubuntu)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"Content-Length","value":"245"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"status\": true,\n \"awb\": \"NMBC0002111111\",\n \"message\": \"NDR Submitted Successfully\"\n },\n {\n \"status\": false,\n \"awb\": \"NMBC0002111112\",\n \"message\": \"No Courier Exception Available\"\n },\n {\n \"status\": false,\n \"awb\": \"NMBC0002111113\",\n \"message\": \"Mobile number should be 10 digits long\"\n }\n]"}],"_postman_id":"7155e42e-df2d-4832-9a24-1e9a6c9a7c90"}],"id":"94d48388-1e36-4f44-bf7a-7254fc273351","_postman_id":"94d48388-1e36-4f44-bf7a-7254fc273351","description":""}],"event":[{"listen":"prerequest","script":{"id":"29a63fd8-ff8f-4d4e-8998-7832f91efb4d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"50eaeed7-3488-4179-a2c9-20912da9af0f","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BASE_URL","value":"https://api.nimbuspost.com/v1/"},{"key":"API_SHIPMENT_CLASS","value":"shipments"},{"key":"AWB","value":""}]}