{"info":{"_postman_id":"9c6b9622-40e0-2ece-9307-117b600a1fb9","name":"eCourierz Shipping Staging APIs","description":"<html><head></head><body><h1 id=\"ecourierz-shipping-api-library\">eCourierz Shipping API Library</h1>\n<p>For Staging, Kindly reach out to us for your Staging API details</p>\n<ol>\n<li><p>The Booking Process would be a 2 step flow: </p>\n<p> i) Find the List of Services Available between 2 pincodes for the provided Weight, Mode (Pre-Paid ) , Value etc.\n  <a href=\"https://www.qa.ecourierz.com/api/v1/courier-services/domestic/\">https://www.qa.ecourierz.com/api/v1/courier-services/domestic/</a> will provide You the list of services.</p>\n<p> From the response, </p>\n<p> Request Body:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>   {\n      \"pickup_pincode\": \"400010\",             \n       \"delivery_pincode\": \"560001\",\n        \"quantity\": 1,\n        \"packages\": [\n                  {\n                   \"length\": \"10\",          # (measured In cms )\n                   \"height\": 10,             # (measured In cms )\n                    \"width\": 10,             # (measured In cms )\n                    \"weight\": 500,         # Weight in Grams\n                    \"value\": 50             # Value of the Parcel in Rs\n                }\n         ],\n      \"is_cod_booking\": false,\n      \"is_commercial\": true,\n      \"is_document\": false # To Be set to True, in-case of a Document\n }\n</code></pre><p>ii) Each of the Vendor Services' returned in the above API call, would have an dynamically generated attribute by name \"product_id\". eg. \"product_id\": \"9c26ba2e-9ea1-4e04-91af-dac976b32ccd\" . This acts like a virtual identifier or equivalent to what we call as a 'SKU' for an ecommerce store.</p>\n</li>\n</ol>\n<p>  Now, this \"product_id\" is used while Placing the Booking into eCourierz Systems' via the Booking API ( <a href=\"https://www.qa.ecourierz.com/api/v1/bookings/\">https://www.qa.ecourierz.com/api/v1/bookings/</a>). The Request structure is as on the provided Postman link.  </p>\n<p> While placing the Test Bookings, ensure \"is_test_booking\": true, is set to True.</p>\n<hr>\n<h2 id=\"the-following-are-the-list-of-http-status-codes-one-might-encounter-with-the-current-set-of-apis-we-have------400---in-case-of-a-bad-request-this-might-arise-if-there-are-any-mandatory-attributes-missing-in-the-request-json-----401---in-case-of-wrong-or-missing-api-key---402---in-case-of-less-balance--payment-required-for-pre-paidwallet--customers-the-response-will-also-contain-the-payment-link-to-deposit-into-his-walletecourierz-wallet---405---in-case-a-method-is-not-allowed-for-a-particular-endpoint-eg-we-dont-allow-put--delete-etc-on-rate-shop-api-if-rates-shop-is-tried-with-a-put--delete-a-response-with-405-status-code-would-be-returned\">The following are the list of Http Status Codes one might encounter with the current set of APIs we have:\n \n   400 -&gt; In case of a Bad Request. This might arise if there are any Mandatory attributes missing in the request JSON \n<br><br>   401 -&gt; In case of Wrong or Missing API Key\n<br><br>  402 -&gt; In case of Less Balance / Payment Required for Pre-Paid/Wallet  Customers. The Response will also contain the Payment Link to deposit into his Wallet(ecourierz Wallet)\n<br><br>  405 -&gt; In case a method is not allowed for a Particular Endpoint. eg., We don't allow PUT / DELETE, etc on Rate Shop API. If Rates Shop is tried with a PUT / DELETE, a response with 405 Status Code would be returned\n  </h2>\n<p>  Once the Staging Integration is done, for the PRODUCTION Integrations, please use the following details:</p>\n<p>   Base EndPoint - <a href=\"https://ship.ecourierz.com\">https://ship.ecourierz.com</a> </p>\n<p>   Use your API Key available on <a href=\"https://ship.ecourierz.com/account/details/#developer\">https://ship.ecourierz.com/account/details/#developer</a> \n  </p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"eCourierz Shipping API Library","slug":"ecourierz-shipping-api-library"}],"owner":"528834","collectionId":"9c6b9622-40e0-2ece-9307-117b600a1fb9","publishedId":"SWEDyZQb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-12-19T09:43:23.000Z"},"item":[{"name":"Manifest","item":[{"name":"Create Manifest","id":"768c3121-7583-b8f3-c22f-3e22a41889f3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"raw","raw":"{\"order_ids\": \"ECZ292466,ECZ674255\"}"},"url":"https://www.qa.ecourierz.com/api/v1/manifests/ECZ_MNFST23218","description":"<p>/manifests/</p>\n","urlObject":{"protocol":"https","path":["api","v1","manifests","ECZ_MNFST23218"],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"768c3121-7583-b8f3-c22f-3e22a41889f3"},{"name":"GET Manifest","id":"1bd00b0e-839c-adde-1f04-1ef5c4ea804e","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"raw","raw":"{\"order_ids\": \"ECZ821172,ECZ147268\"}"},"url":"https://www.qa.ecourierz.com/api/v1/manifests/ECZ_MNFST32628","description":"<p>/manifests/ECZ_MNFST98009</p>\n","urlObject":{"protocol":"https","path":["api","v1","manifests","ECZ_MNFST32628"],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1bd00b0e-839c-adde-1f04-1ef5c4ea804e"},{"name":"Manifest","id":"ed42794f-6ab8-0e34-c381-0c6026d796ab","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"raw","raw":"{\"order_ids\": \"ECZ55667,ECZ71886\"}"},"url":"https://www.qa.ecourierz.com/api/v1/manifests/ECZ_MNFST16354","description":"<p>/manifest/</p>\n","urlObject":{"protocol":"https","path":["api","v1","manifests","ECZ_MNFST16354"],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed42794f-6ab8-0e34-c381-0c6026d796ab"}],"id":"3563d0f6-38dd-0a0e-23f9-f689a917e7bd","_postman_id":"3563d0f6-38dd-0a0e-23f9-f689a917e7bd","description":""},{"name":"Shipping Related APIs ( Labels, Pickup, Cancellation)","item":[{"name":"Bookings","id":"08af511b-dba2-b2fc-bd8a-756fb973b946","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"raw","raw":"{\r\n  \"shipper\": {\r\n    \"name\": \"jutti_owner\",\r\n    \"phone\": \"9999991111\",\r\n    \"email\": \"jutti@gmail.com\",\r\n    \"address\": {\r\n      \"company_name\": \"sender\",\r\n      \"street1\": \"shipper addresss line 1\",\r\n      \"street2\": \"Shipper addresss line 2\",\r\n      \"city\": \"c1\",\r\n      \"state\": \"State\",\r\n      \"country\": \"india\",\r\n      \"postal_code\": \"600001\"\r\n    }\r\n  },\r\n  \"receiver\": {\r\n    \"name\": \"Ajay\",\r\n    \"phone\": \"9886895431\",\r\n    \"email\": \"aja@aa.com\",\r\n    \"address\": {\r\n      \"company_name\": \"receiver\",\r\n      \"street1\": \"receiver addresss line 1\",\r\n      \"street2\": \"receiver addresss line 2\",\r\n      \"city\": \"c1\",\r\n      \"state\": \"State\",\r\n      \"country\": \"india\",\r\n      \"postal_code\": \"560001\"\r\n    }\r\n  },\r\n  \"collect_on_delivery\": 0, \r\n  \"customer_reference\": \"CUSTOMER_REF\",\r\n  \"invoice_number\": \"INV00012\",\r\n  \"ewaybill_number\": \"ewaybill_number\",\r\n  \"tax_info\": {\r\n        \"tax_id\": \"\",\r\n        \"tax_id_type\": \"gstn\",\r\n        \"tax_registered_name\": \"Name as per the records\"\r\n    },\r\n\r\n  \"product_id\": \"10870af6-aabd-4628-81c1-cc47564a08c5\",\r\n  \"is_multi_packet_shipment\": false,\r\n  \"parcel_contents\": \"Parcel Contents\",\r\n  \"is_test_booking\": true,\r\n  \"send_confirmation_mail\": true,\r\n  \"alert_receiver\": false,\r\n  \"generate_label\": true\r\n\r\n}"},"url":"https://www.qa.ecourierz.com/api/v2/bookings/","description":"<p>Add a Shipping Request Booking to eCourierz Platform.</p>\n<p>The getDomesticCourierServices Request has to be made first and 'product_id' from the Response of the getDomesticCourierServices API call has to be used for Placing the Booking.</p>\n<p>=============================================================================</p>\n<p>customer_reference  : Mandatory - Customer's Reference Number</p>\n<p>invoice_amount      : Mandatory - Total Invoice Value   </p>\n<p>product_id          : Mandatory - To be chosen from the Services Check API</p>\n<p>collect_on_delivery : Mandatory for COD Shipments, Non-Mandatory for Prepaid shipments</p>\n<p>parcel_contents     : Mandatory </p>\n<p>is_multi_packet_shipment: Set this to True, in case of a Multi-piece shipment</p>\n<p>generate_label      : Set this to true, if you would want to Generate a Shipping Label with tracking number at the time of placing the booking. Or an extra GET labels call would generate a Shipping label and assign a tracking number</p>\n<p>tax_id_type        : gsnt, pan</p>\n","urlObject":{"protocol":"https","path":["api","v2","bookings",""],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"08af511b-dba2-b2fc-bd8a-756fb973b946"},{"name":"Labels","id":"c6ff6432-6e87-4820-46ae-61244bb84ff4","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://www.qa.ecourierz.com/api/v2/labels/ECZ691024","description":"<p>Fetches the Shipping Labels for the Provided Orders</p>\n<p>Fetches the Shipping Labels for the Provided Order ID or Comma Separated List of Order IDs. The Response Contains the Links of the Shipping Labels</p>\n","urlObject":{"protocol":"https","path":["api","v2","labels","ECZ691024"],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6ff6432-6e87-4820-46ae-61244bb84ff4"},{"name":"Entire Orders List","id":"02fdce75-d86e-3329-6fe2-5464351abd00","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://www.qa.ecourierz.com/api/v1/bookings/","description":"<p>Returns the List of Orders Placed by the User</p>\n","urlObject":{"protocol":"https","path":["api","v1","bookings",""],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"02fdce75-d86e-3329-6fe2-5464351abd00"},{"name":"Bookings' Info","id":"7e3e9ac0-f193-bafa-26b6-bbd90056fa7e","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://www.qa.ecourierz.com/api/v2/bookings/ECZ83227","description":"<p>/bookings/</p>\n<p>Get Info about Booking based on the provided Order IDs</p>\n<p>Get Info about Booking based on the provided Order ID or Comma Separated List of Order IDs</p>\n","urlObject":{"protocol":"https","path":["api","v2","bookings","ECZ83227"],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e3e9ac0-f193-bafa-26b6-bbd90056fa7e"},{"name":"Cancel Bookings","id":"4a9ee21a-396e-0e43-611e-d0b0377fdffb","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"formdata","formdata":[]},"url":"https://www.qa.ecourierz.com/api/v1/bookings/ECZ22448","description":"<p>Cancel a Booking based on the provided Order IDs</p>\n<p>Cancel Booking(s) based on the provided Order ID or Comma Separated List of Order IDs</p>\n","urlObject":{"protocol":"https","path":["api","v1","bookings","ECZ22448"],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a9ee21a-396e-0e43-611e-d0b0377fdffb"},{"name":"Schedule Pickup","id":"f1ae5c8c-e2de-db1f-27eb-5f5d9aa6f81f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"raw","raw":"{\"order_ids\": \"ECZ28712\", \"pickup_date\": \"2019-12-27\"} "},"url":"https://www.qa.ecourierz.com/api/v1/schedule-pickup/","description":"<p>/schedule-pickup/</p>\n<p>Schedule Pickup for the provided Order ID</p>\n<p>Schedule Pickup for the Provided Order ID or Comma Separated Order IDs</p>\n","urlObject":{"protocol":"https","path":["api","v1","schedule-pickup",""],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1ae5c8c-e2de-db1f-27eb-5f5d9aa6f81f"}],"id":"e3e949cc-fe5d-83f7-aa83-c61ea067513b","_postman_id":"e3e949cc-fe5d-83f7-aa83-c61ea067513b","description":""},{"name":"Service Check","item":[{"name":"getInternationalCourierServices","id":"3cf499e7-df9d-7982-690b-28a4a7129cff","request":{"method":"POST","header":[{"key":"X-API-Token","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\r\n\"pickup_pincode\": \"400010\",\r\n\"delivery_pincode\": \"ARE\",\r\n\"quantity\": 1,\r\n\"packages\": [{\"length\": \"10\", \"height\": 10, \"width\": 10, \"weight\": 500, \"value\": 50.0}],\r\n \"is_cod_booking\": false,\r\n\"is_commercial\": false,\r\n\"is_document\": false\r\n}\r\n\r\n"},"url":"https://www.qa.ecourierz.com/api/v1/courier-services/international/","description":"<p>Find the List of International Services offered by various Companies, Based on Source &amp; Destination Pincodes, Type of Service Requested ( Pre-Paid / COD ), Value of the Product being sent, Dimensions of the Packed Parcel</p>\n","urlObject":{"protocol":"https","path":["api","v1","courier-services","international",""],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3cf499e7-df9d-7982-690b-28a4a7129cff"},{"name":"getDomesticCourierServices","id":"d6a933d4-2a2f-3fcf-3061-8fd178afbe93","request":{"method":"POST","header":[{"key":"X-API-Token","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\"pickup_pincode\": \"560085\",\r\n\"delivery_pincode\": \"560064\",\r\n\"quantity\": 1,\r\n\"packages\": [{\"length\": \"10\", \"height\": 10, \"width\": 10, \"weight\": 500, \"value\": 50.0}],\r\n \"is_cod_booking\": false,\r\n\"need_insurance\": false,\r\n\"is_commercial\": true,\r\n\"is_document\": false\r\n}\r\n\r\n"},"url":"https://www.qa.ecourierz.com/api/v1/courier-services/domestic/","description":"<p>Find the List of Domestic Services offered by various Companies, Based on Source &amp; Destination Pincodes, Type of Service Requested ( Pre-Paid / COD ), Value of the Product being sent, Dimensions of the Packed Parcel.</p>\n<p>Send a List of Packages in case of a Multi-Piece Shipments &amp; set the corresponding Quantity</p>\n<p>Note:\nis_cod_booking - Mandatory - Set to true if its a COD Shipment. Otherwise set it to false </p>\n<p>is_commercial  - Mandatory - Set to true if its a Commercial Shipment.</p>\n<p>is_document    - Mandatory - Set to true if its a Document. For Parcels, set it to false</p>\n<p>quantity       - Mandatory </p>\n<p>packages       - Mandatory </p>\n<p>need_insurance - Non-Mandatory</p>\n","urlObject":{"protocol":"https","path":["api","v1","courier-services","domestic",""],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6a933d4-2a2f-3fcf-3061-8fd178afbe93"}],"id":"3131017f-b20d-a0ed-27de-4085ae067833","_postman_id":"3131017f-b20d-a0ed-27de-4085ae067833","description":""},{"name":"Others","item":[{"name":"Fetch Customer Info","id":"bdc6f3a7-6db1-2fc3-97e6-9654856484fb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"raw","raw":""},"url":"https://www.qa.ecourierz.com/api/v1/customers/info/","description":"<p>/customers/info/</p>\n<p>Provides the Customer Information, Bank Details, Configured Warehouse Details</p>\n","urlObject":{"protocol":"https","path":["api","v1","customers","info",""],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bdc6f3a7-6db1-2fc3-97e6-9654856484fb"}],"id":"e19dcb48-d00c-63f9-bac2-6e08dd68bc36","_postman_id":"e19dcb48-d00c-63f9-bac2-6e08dd68bc36","description":""},{"name":"Track Orders","id":"cd2c51c6-293e-2994-d7a3-c4e4185a1419","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-API-Token","value":""}],"body":{"mode":"raw","raw":"{\"order_ids\": \"ECZ28712\"}"},"url":"https://www.qa.ecourierz.com/api/v1/tracking/","description":"<p>/tracking/</p>\n<p>Track Shipment for the provided Order ID</p>\n<p>Track Shipments for the Provided Order ID or Comma Separated Order IDs</p>\n","urlObject":{"protocol":"https","path":["api","v1","tracking",""],"host":["www","qa","ecourierz","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd2c51c6-293e-2994-d7a3-c4e4185a1419"}]}