![](\"http://amit.nimbuspost.com/assets/company_logo/Nimbus_Logo.png\"){kind=logo}
\n\nFirst you need to register with Nimbuspost and create an account. Click on this link to complete the simple sign up process.
\nAfter the signup process is complete, follow the enlisted steps to create an API user and get started with using our APIs:
\nPass your API key in header with 'NP-API-KEY' key with each request.
\nExample NP-API-KEY: {api_key}
\nReplace {api_key} with your account API key
\n
Rate Limit: 10 requests/second
\n\nThis API will list orders from your Nimbuspost account.
\nYou can also sort and filter the data according to your needs by passing the optional parameters. Not passing anything will display the data in the default format.
\nGet the order details of a particular order through this API by passing the Nimbuspost order id in the endpoint URL itself. Type Nimbuspost Order id in place of {id}.
\nNo other body parameters are required.
\nUse this API to Create custom order in your Nimbuspost account
\nUse this API to Create and ship custom order using a single API
\nUse this API to cancel a created order.
\nUse this API to Generate AWB for any order with courier of your choice.
\nThese API's can be used to get details about your created orders, cancel any order and ship an order
\n","event":[{"listen":"prerequest","script":{"id":"6b8fcf5c-fc42-48c4-b6ce-acf0df600a38","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d4a7cb34-34fd-4909-b12c-accb9795e576","type":"text/javascript","exec":[""]}}],"_postman_id":"f61ff5c5-6bad-4c12-b467-7e0f4b801310"},{"name":"Shipments","item":[{"name":"Create New Shipment","id":"af41c1b6-8c02-432d-9586-08eb28fa26db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"NP-API-KEY","type":"text","value":"{{api_key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"consignee\": {\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\": {\n \"order_number\": \"#001\",\n \"shipping_charges\" : 40,\n \"discount\" : 100,\n \"cod_charges\" : 30,\n \"payment_type\": \"cod\",\n \"total\" : 1000,\n \"package_weight\": 300,\n \"package_length\" : 10,\n \"package_height\" : 10,\n \"package_breadth\" : 10\n },\n \"order_items\": [{\n \"name\" : \"product 1\",\n \"qty\" : \"1\",\n \"price\" : \"100\",\n \"sku\":\"sku001\"\n }],\n \"pickup_warehouse_id\": \"3\",\n \"rto_warehouse_id\": \"3\"\n \n}"},"url":"https://ship.nimbuspost.com/api/shipments/create","description":"Use this API to do multiple tasks in one go, namely creating a enw order, request AWB for its shipment.
\nMake sure to create order allocation rules before using this API. Allcoation rules can be set inside Nimbuspost dashboard by visiting Addons->Order allocation engine.
\nBe sure to input the correct calculated total amount. This is not calculated automatically through the API.
\nCourier ID is optional while making request using this API. If courier ID is passed then system will try to generate AWB using that courier ID. If AWB generation fail because of any reason then order allocaiton engine will choose courier partner as per matchin rule.
\n","urlObject":{"protocol":"https","path":["api","shipments","create"],"host":["ship","nimbuspost","com"],"query":[],"variable":[]}},"response":[{"id":"6e513dc7-8443-43d6-bbdf-9a0cdf06ec8d","name":"Create New Shipment","originalRequest":{"method":"POST","header":[{"key":"NP-API-KEY","type":"text","value":"{{api_key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"consignee\": {\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\": {\n \"order_number\": \"#001\",\n \"shipping_charges\" : 40,\n \"discount\" : 100,\n \"cod_charges\" : 30,\n \"payment_type\": \"cod\",\n \"total\" : 1000,\n \"package_weight\": 300,\n \"package_length\" : 10,\n \"package_height\" : 10,\n \"package_breadth\" : 10\n },\n \"order_items\": [{\n \"name\" : \"product 1\",\n \"qty\" : \"1\",\n \"price\" : \"100\",\n \"sku\":\"sku001\"\n }],\n \"pickup_warehouse_id\": \"3\",\n \"rto_warehouse_id\": \"3\"\n \n}"},"url":"https://ship.nimbuspost.com/api/shipments/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Dec 2020 09:36:39 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":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"07549ac07b0000174cb09e7000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=YU4BHhj84WNi9g0ngt385HRQ6PwJEXYU1KClmJVwMcJbJaCa4qtUBDntPfWJFsFXZLKSl0KcpZb0iQl8zS6h23AiP7MZinEAVyUO1vfOnBj1DnV9\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"609ac713fe39174c-SIN"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"data\": {\n \"order_id\": 3099321,\n \"shipment_id\": 1790593,\n \"awb_number\": \"59616858350\",\n \"courier_id\": \"5\",\n \"courier_name\": \"Bluedart\",\n \"status\": \"booked\",\n \"additional_info\": \"GGN / GED\",\n \"payment_type\": \"cod\"\n }\n}"}],"_postman_id":"af41c1b6-8c02-432d-9586-08eb28fa26db"},{"name":"Get All Shipments","event":[{"listen":"prerequest","script":{"id":"f5888666-aa77-4791-8735-df04cf1318a5","exec":[""],"type":"text/javascript"}}],"id":"375acfea-0222-459b-aa64-f74786a4d0f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"NP-API-KEY","type":"text","value":"{api_key}"}],"url":"https://ship.nimbuspost.com/api/shipments","description":"This API will list shipments from your Nimbuspost account.
\nYou can also sort and filter the data according to your needs by passing the optional parameters. Not passing anything will display the data in the default format.
\nGet the shipment details of a particular shipment through this API by passing the Nimbuspost shipment id in the endpoint URL itself. Type Nimbuspost shipment id in place of {id}.
\nNo other body parameters are required.
\nRaise a pickup request when shipments are ready for pickup.
\nUse this API to generate PDF shipping label for your shipments
\nGet the tracking history a particular shipment through this API by passing the Nimbuspost shipment id in the endpoint URL itself. Type Nimbuspost shipment id in place of {id}.
\nNo other body parameters are required.
\nGet 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}.
\nNo other body parameters are required.
\nUse this API to cancel a created Shipment.
\nShipments which are in transit can't be cancelled.
\nThese API's can be used to get shipment details. You can either get all shipment details at once or the details of a particular shipment.
\n","_postman_id":"060a2e4c-2059-4140-9f15-0769d4768b74"},{"name":"Couriers","item":[{"name":"List All Couriers","event":[{"listen":"prerequest","script":{"id":"f5888666-aa77-4791-8735-df04cf1318a5","exec":[""],"type":"text/javascript"}}],"id":"5f4cd28f-841f-4a89-a5a7-d3af962f6e1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"NP-API-KEY","type":"text","value":"{api_key}"}],"url":"https://ship.nimbuspost.com/api/couriers","description":"This API will list all couriers from your Nimbuspost account.
\nNo other body parameters are required.
\n","urlObject":{"protocol":"https","path":["api","couriers"],"host":["ship","nimbuspost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f4cd28f-841f-4a89-a5a7-d3af962f6e1c"}],"id":"581b65cb-4006-4991-8a17-24d300832f44","description":"These API's can be used to list all the available couriers.
\n","_postman_id":"581b65cb-4006-4991-8a17-24d300832f44"},{"name":"Warehouse","item":[{"name":"List All Warehouses","event":[{"listen":"prerequest","script":{"id":"8657c580-b38b-476a-bc4a-33293ff981c1","exec":[""],"type":"text/javascript"}}],"id":"42d8f354-c80a-47d9-9e51-49ac513818c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"NP-API-KEY","type":"text","value":"{api_key}"}],"url":"https://ship.nimbuspost.com/api/warehouse","description":"This API will list all warehouses from your Nimbuspost account.
\nNo other body parameters are required.
\n","urlObject":{"protocol":"https","path":["api","warehouse"],"host":["ship","nimbuspost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"42d8f354-c80a-47d9-9e51-49ac513818c5"},{"name":"Create Warehouse","id":"dc3ae3c6-6050-48e0-ae05-df7afcb281aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"NP-API-KEY","type":"text","value":"{api_key}"}],"url":"https://ship.nimbuspost.com/api/warehouse/create","description":"Use this API to Create warehouse in your Nimbuspost account
\nThese API's can be used to list all the pickup locations added to your account.
\n","event":[{"listen":"prerequest","script":{"id":"6d1f3371-0422-4ef7-aebe-2f59cda16377","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"25c176ba-7dbf-4043-bd00-8e32e256c945","type":"text/javascript","exec":[""]}}],"_postman_id":"bb709838-692b-4d9f-846d-21714f456d92"}],"event":[{"listen":"prerequest","script":{"id":"f24cdb45-9bc0-4fd4-9f7a-cde9654c1072","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"897f1518-0e8a-4d8d-8970-765e3772fe59","type":"text/javascript","exec":[""]}}]}