Welcome to Shiprocket's API Documentation. We've designed this document to help developers and Shiprocket users fully understand and integrate our API for a seamless and easy deployment. These APIs enable you to utilize most of your Shiprocket account's panel features fully.
\nWe've listed all the APIs, their required parameters, and their example requests and responses on the right for easy understanding. The easiest way to start using the Shiprocket APIs is by clicking the Run in Postman button above. The Postman is a free tool that helps developers run and debug API requests.
\nOur APIs are based around REST architecture and use the basic HTTP request methods. Our APIs accept JSON - encoded body requests and return data in the same form.
\nRead through the following sections for the integration process.
\nFirst, you need to register with ShipRocket and create an account. Click on this link to complete the sign-up process.
\nAfter the sign-up process is complete, follow the steps listed below to create an API user:
\nLog in to your Shiprocket account.
\nFrom the left-hand menu, go to:
Settings → API → Add New API User
Click on \"Create API User.\"
\nIn the pop-up form:
. Enter a unique email address (must be different from the one used for your main Shiprocket login).
. Under Modules to Access, select the relevant API modules you want your user to access.
. Under Buyer's Details Access, choose either \"Allowed\" or \"Not Allowed\" based on your requirement.
Click on \"Create User.\"
\nThe password for the API user will be sent to your registered email address (not the API user email ID).
\nOnce created, you can proceed to generate an auth token using the Authentication API for further integration.
\nOur APIs use the basic HTTP request codes: POST, GET, PATCH, & PUT.
\nYou can select the required response and request code language by selecting it from the drop-down menu on the top.
\nYou can import and test all our full API collection in the Postman app by clicking on the ' Run in Postman' button.
\nNote: Any requests made using the valid API credentials will affect the real-time data in your Shiprocket account.
\nAuthorization: Bearer
\nAll the APIs are provided with their appropriate example requests and responses for successful and failed calls. The example definitions are:
\nSuccessful Call: The API call was correct.
\nInvalid Data: The data entered was incorrect.
\nMissing Fields: Some of the required fields are missing.
\nWrong Format: There is a syntax error in the code.
\nNote: The order_id defined by you at the time of order creation is your reference order id. The order_id returned in the API response is the Shiprocket order id. All our APIs will use this Shiprocket order id to access your created order unless stated otherwise.
While using Shiprocket's APIs, you may run into some standard response and error codes. The most common ones are listed along with their descriptions as follows:
\nYou can set up a webhook with Shiprocket to get tracking updates. We will proactively notify your system whenever there is a new tracking event for an order.
\nSetup:
\nLog in to your Shiprocket account
\nGo to Settings > API > Webhooks
\nAdd the webhook URL
\nEnable the toggle
\nAdd the security token (not mandatory)
\nWhen we get a new tracking event, a POST request is made to the callback URL you added to your Shiprocket account.
\nWebhook Specifications:
\nMethod: POST
\nThe Content-Type header should be set to application/json
Please do not use keywords like shiprocket, kartrocket, sr, or kr in your webhook URL
\nSecurity token should be anx-api-key
The URL should be set to send only code 200 in response.
\n{\n \"awb\":\"19041424751540\",\n \"courier_name\":\"Delhivery Surface\",\n \"current_status\":\"IN TRANSIT\",\n \"current_status_id\":20,\n \"shipment_status\":\"IN TRANSIT\",\n \"shipment_status_id\":18,\n \"current_timestamp\":\"23 05 2023 11:43:52\",\n \"order_id\":\"1373900_150876814\",\n \"sr_order_id\":348456385,\n \"awb_assigned_date\":\"2023-05-19 11:59:16\",\n \"pickup_scheduled_date\":\"2023-05-19 11:59:17\",\n \"etd\":\"2023-05-23 15:40:19\",\n \"scans\":[\n {\n \"date\":\"2023-05-19 11:59:16\",\n \"status\":\"X-UCI\",\n \"activity\":\"Manifested - Manifest uploaded\",\n \"location\":\"Chomu_SamodRd_D (Rajasthan)\",\n \"sr-status\":\"5\",\n \"sr-status-label\":\"MANIFEST GENERATED\"\n },\n {\n \"date\":\"2023-05-19 15:32:17\",\n \"status\":\"X-PPOM\",\n \"activity\":\"In Transit - Shipment picked up\",\n \"location\":\"Chomu_SamodRd_D (Rajasthan)\",\n \"sr-status\":\"42\",\n \"sr-status-label\":\"PICKED UP\"\n },\n {\n \"date\":\"2023-05-19 16:40:19\",\n \"status\":\"X-PIOM\",\n \"activity\":\"In Transit - Shipment Recieved at Origin Center\",\n \"location\":\"Chomu_SamodRd_D (Rajasthan)\",\n \"sr-status\":\"6\",\n \"sr-status-label\":\"SHIPPED\"\n },\n {\n \"date\":\"2023-05-19 17:19:14\",\n \"status\":\"X-DBL1F\",\n \"activity\":\"In Transit - Added to Bag\",\n \"location\":\"Chomu_SamodRd_D (Rajasthan)\",\n \"sr-status\":\"NA\",\n \"sr-status-label\":\"NA\"\n },\n {\n \"date\":\"2023-05-20 10:27:56\",\n \"status\":\"X-DLL2F\",\n \"activity\":\"In Transit - Bag Added To Trip\",\n \"location\":\"Chomu_SamodRd_D (Rajasthan)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-20 12:23:44\",\n \"status\":\"X-ILL2F\",\n \"activity\":\"In Transit - Trip Arrived\",\n \"location\":\"Jaipur_Sez_GW (Rajasthan)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-20 14:24:50\",\n \"status\":\"X-ILL1F\",\n \"activity\":\"In Transit - Bag Received at Facility\",\n \"location\":\"Jaipur_Sez_GW (Rajasthan)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-20 15:23:38\",\n \"status\":\"X-IBD3F\",\n \"activity\":\"In Transit - Shipment Received at Facility\",\n \"location\":\"Jaipur_Sez_GW (Rajasthan)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-20 15:23:38\",\n \"status\":\"X-DWS\",\n \"activity\":\"In Transit - System weight captured\",\n \"location\":\"Jaipur_Sez_GW (Rajasthan)\",\n \"sr-status\":\"NA\",\n \"sr-status-label\":\"NA\"\n },\n {\n \"date\":\"2023-05-20 16:01:22\",\n \"status\":\"X-DBL1F\",\n \"activity\":\"In Transit - Added to Bag\",\n \"location\":\"Jaipur_Sez_GW (Rajasthan)\",\n \"sr-status\":\"NA\",\n \"sr-status-label\":\"NA\"\n },\n {\n \"date\":\"2023-05-21 09:50:45\",\n \"status\":\"X-DLL2F\",\n \"activity\":\"In Transit - Bag Added To Trip\",\n \"location\":\"Jaipur_Sez_GW (Rajasthan)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-22 22:01:12\",\n \"status\":\"X-ILL2F\",\n \"activity\":\"In Transit - Trip Arrived\",\n \"location\":\"Bhiwandi_Mega_GW (Maharashtra)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-23 02:55:34\",\n \"status\":\"X-ILL1F\",\n \"activity\":\"In Transit - Bag Received at Facility\",\n \"location\":\"Bhiwandi_Mega_GW (Maharashtra)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-23 07:38:08\",\n \"status\":\"X-DLL2F\",\n \"activity\":\"In Transit - Bag Added To Trip\",\n \"location\":\"Bhiwandi_Mega_GW (Maharashtra)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-23 09:48:27\",\n \"status\":\"X-ILL2F\",\n \"activity\":\"In Transit - Trip Arrived\",\n \"location\":\"Mumbai_MiraRdIndEstate_I (Maharashtra)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"date\":\"2023-05-23 10:14:27\",\n \"status\":\"X-ILL1F\",\n \"activity\":\"In Transit - Bag Received at Facility\",\n \"location\":\"Mumbai_MiraRdIndEstate_I (Maharashtra)\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n },\n {\n \"location\":\"Mumbai_MiraRdIndEstate_I (Maharashtra)\",\n \"date\":\"2023-05-23 11:43:46\",\n \"activity\":\"In Transit - Shipment Received at Facility\",\n \"status\":\"X-IBD3F\",\n \"sr-status\":\"18\",\n \"sr-status-label\":\"IN TRANSIT\"\n }\n ],\n \"is_return\":0,\n \"channel_id\":3422553,\n \"pod_status\":\"OTP Based Delivery\",\n \"pod\":\"Not Available\"\n}\n\nBusinesses can enhance their internal and customer-facing applications using Sense intelligence through our API products. For more information, please visit https://www.console.shiprocket.in
\nSense RTO Score API - Predicts return-to-origin (RTO) events
\nSenseAddress API - Provides address standardization and validation
\nOnline retail platforms
\nLogistics or delivery apps/journeys
\nE-commerce customer service tools
\nOperational efficiency
\nDelivery success
\nAddress quality and accuracy
\nBFSI: Doorstep banking, KYC processes
\nRetail: Enhancing customer experiences
\nFinTech: Improving service accuracy
\nE-commerce: Ensuring delivery accuracy
\nLocation Intelligence: Various industry applications
\nAddress Score API: Evaluates and scores addresses for overall quality and suitability.
\nAddress Verification API: Validates and ensures accuracy by comparing addresses with past entries.
\nRTO Prediction API: Uses machine learning, historical data, and key parameters to forecast if an order will return to its origin efficiently.
\nAll the required information on integration is in this document. Please read it thoroughly.
\nFor any integration and API-related support, you can feel free to drop us an email at integration@shiprocket.com.
For any other issues, please email us at: support@shiprocket.com.
The Shiprocket terms of service are listed here: Terms Of Service
\nA Model Context Protocol (MCP) server that enables AI clients (like Claude or Cursor) to interact with Shiprocket’s logistics platform through natural language. Using this AI, clients can create conversational requests into authenticated API calls, covering shipping rates, order creation, tracking, cancellations, pickups, and label generation
\nGet real-time shipping rates for any pincode, city, or state with a simple command.
\nCreate or update orders instantly with details like dimensions, weight, and address.
\nAssign couriers and schedule pickups effortlessly—just tell it what, where, and when.
\nGenerate shipping labels for your orders in one step.
\nCancel orders or shipments before they're dispatched.
\nTrack shipments live using AWB, Shiprocket Order ID, or your source order ID.
\nManage your entire order workflow—from creation to delivery—through natural prompts.
\nGoal: You want to know how much it would cost to ship a parcel from Delhi to Bangalore.
\nUser Command (Natural Language):
\n\"How much does it cost to send a 1kg package from Delhi to Bangalore with COD?\"
\nBehind the scenes (Tool Used):
\nTool: shipping_rate_calculator
Inputs:
\nPickup Pincode: 110001 (Delhi)
\nDelivery Pincode: 560001 (Bangalore)
\nWeight: 1kg
\nCOD: Yes
\nAI Response (Simplified Output):
\nYou have 3 courier options:
\nDelhivery Express: ₹85, Delivery in 2 days
\nBluedart: ₹110, Delivery in 1 day
\nXpressbees: ₹90, Delivery in 3 days
\nCOD available with all options.
\nThis allows the user to choose the best courier based on cost and speed, all without logging into a dashboard.
\nGoal: You’ve received an order on your website and now want to ship it via Shiprocket.
\nUser Command:
\n\"Create a shipment for a 2kg item from Mumbai to Pune. COD ₹999. Customer name is Ramesh, phone is 9876543210.\"
\nBehind the scenes (Tool Used):
\nTool: order_create
Inputs:
\nPickup Address: Mumbai (400001)
\nDelivery Address: Pune (411001)
\nWeight: 2kg
\nCOD Amount: ₹999
\nCustomer: Ramesh, 9876543210
\nAI Response:
\nNew Order created successfully with Shiprocket Order ID: SR123456.
\nNext Command (User):
\n\"Ship the order using the fastest courier.\"
\nBehind the scenes:
\nTool: order_ship
Logic: Auto-select fastest courier based on shipping_rate_calculator
\nResult: Courier assigned, AWB generated.
\nAI Response:
\nShipped via Delhivery. AWB Number: DLV987654321
\nGoal: You’ve created an order and want to schedule a pickup and download the label.
\nUser Command:
\n\"Schedule a pickup for Order SR123456 for tomorrow.\"
\nTool Used: order_pickup_schedule
Inputs:
\nOrder ID: SR123456
\nDate: Tomorrow
\nPickup Slot: Default (morning/afternoon)
\nAI Response:
\nPickup scheduled for 24 July, 10 AM to 1 PM.
\nNext Command:
\n\"Download the shipping label for Order SR123456.\"
\nTool Used: generate_shipment_label
AI Response:
\nHere’s your label (PDF): Download Label
\nYou can now print the label and attach it to the package—done!
\nPrerequisites:
\nNode.js v22.14.0 or higher (but < v23)
\nClaude Desktop or Cursor app for integrating MCP servers.
\nClone the Repository
\ngit clone https://github.com/bfrs/shiprocket-mcp.git\ncd shiprocket-mcp\n\n1. Install Dependencies
\nnpm install\nnpm run build\n\n2. Configure AI Client Integration
\nAdd your credentials in your client’s MCP config file:
\n{\n \"mcpServers\": {\n \"shiprocket\": {\n \"command\": \"npm\",\n \"args\": [\"--prefix\", \"{{PATH_TO_SRC}}\", \"start\", \"--silent\"],\n \"env\": {\n \"SELLER_EMAIL\": \"<Your Shiprocket Email>\",\n \"SELLER_PASSWORD\": \"<Your Shiprocket Password>\"\n }\n }\n }\n}\n\nClaude: save as ~/Library/Application Support/Claude/claude_desktop_config.json
\nCursor: save as ~/.cursor/mcp.json
\n3. Run & Use
\nOpen/restart Claude or Cursor. You’ll see “Shiprocket” as an available MCP integration.
\nMCP Protocol via STDIO: Communicates with AI clients using standard I/O streams
\nCore Components:
\nHTTP Client: Authenticates with Shiprocket using email/password to fetch a bearer token.
\nTool Mapper: Receives MCP calls → runs validation → dispatches to Shiprocket’s REST endpoints.
\nError Handling: Wraps API calls with structured responses to AI clients.
\nCode Layout:
\n\nhttps://apiv2.shiprocket.in/v1/external/auth/logout
\n","urlObject":{"protocol":"https","path":["v1","external","auth","logout"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0e17a85-18c9-43e7-bc56-edb04b4ca014"}],"id":"8a56b4d6-b418-43cf-be25-ead62532aa18","description":"The authentication token is an alphanumeric code, unique to your Shiprocket account, can be used from any system to validate your API calls to access Shiprocket's resources. Shiprocket API uses JWT tokens for validation.
\nUse this API to validate your API user and obtain the authentication token. Copy this token and use it further to validate your API calls. The validity of this token is 10 days.
\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret token in publicly accessible areas such as GitHub, client-side code, and so forth.
\nSteps To Use Token:
\nCopy the token received in response.
\nInclude 'Authorization: Bearer [yourtokenvalue]' in the appropriate field of your code.
\nThat's all! In case of any error, try checking your parameters.
\nUse this API to create a quick custom order. Quick orders are the ones where we do not store the product details in the master catalogue.
\nYou have to pass all the required params at the minimum to create a quick custom order. You can add additional parameters as per your preference.
\nNote:
\nIf no channel id is passed, the order will be assigned to the default custom channel. If the channel id is not known, use the 'Get All Channels' API to get the list of all integrated channels in your Shiprocket account.
\norder_id field cannot be equal to an already existing id. Doing so does not change or affect the existing order.
\nNew orders cannot be created with order id's same as that of cancelled orders. If error 422 shows up despite filling in the correct details, consider changing the order_id.
\nBe sure to input the correct calculated sub_total amount. The total is not calculated automatically through the API.
\nThe 'order_id' returned in the response is the Shiprocket order_id. Please save this order ID as we will use this in future API calls.
\nThis API can be used to create a custom order, the same as the Custom order API, except that you have to specify and select a custom channel to create the order.
\nThe order created will be added under the specified channel. All the other parameters are the same.
\nNote:
\nChannel_id field is required.
\nOrder_id cannot be the same as the already existing order id.
\nInventory Sync must be turned on to use this API. This can be done under the 'Channels' portion on the left-hand panel of your Shiprocket account.
\nInventory details of your Shiprocket account can be accessed using the 'Get Inventory Details' API.
\nUsing this API, you can modify the pickup location of an already created order. Multiple order ids can be passed to update their pickup location together.
\nNote:
\nYou can update the customer's name and delivery address through this API by passing the Shiprocket order id and the necessary customer details.
\nUse this API to update your orders. You have to pass all the required params at the minimum to create a quick custom order. You can add additional parameters as per your preference.
\nYou can update only the order_items details before assigning the AWB (before Ready to Ship status). You can only update these key-value pairs i.e., increase/decrease the quantity, update tax/discount, add/remove product items. We've also enabled changing the nature of the order from a non-document to a document. You jus t need to pass the is_document key with the value of 1 in the payload.
\n","urlObject":{"protocol":"https","path":["v1","external","orders","update","adhoc"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"e2804dcf-249c-409f-8bfe-1232e783c8a4","name":"Successful Call","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"4TestOrderOct28\",\n \"order_date\": \"2024-10-28\",\n \"pickup_location\": \"23659_7026\",\n \"channel_id\": \"\",\n \"comment\": \"Reseller: M/s Goku\",\n \"billing_customer_name\": \"Naruto\",\n \"billing_last_name\": \"Uzumaki\",\n \"billing_address\": \"House 221B, Leaf Village\",\n \"billing_address_2\": \"Near Hokage House\",\n \"billing_city\": \"New Delhi\",\n \"billing_pincode\": \"110002\",\n \"billing_state\": \"Delhi\",\n \"billing_country\": \"India\",\n \"billing_email\": \"naruto@uzumaki.com\",\n \"billing_phone\": \"9876543210\",\n \"shipping_is_billing\": true,\n \"shipping_customer_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_address\": \"\",\n \"shipping_address_2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_pincode\": \"\",\n \"shipping_country\": \"\",\n \"shipping_state\": \"\",\n \"shipping_email\": \"\",\n \"shipping_phone\": \"\",\n \"is_document\":\"0\",\n \"order_items\": [\n {\n \"name\": \"Agreement\",\n \"sku\": \"chakra123\",\n \"units\": 1,\n \"selling_price\": \"900\",\n \"discount\": \"\",\n \"tax\": \"\",\n \"hsn\": 441122\n }\n ],\n \"payment_method\": \"Prepaid\",\n \"shipping_charges\": 0,\n \"giftwrap_charges\": 0,\n \"transaction_charges\": 0,\n \"total_discount\": 0,\n \"sub_total\": 9000,\n \"length\": 10,\n \"breadth\": 15,\n \"height\": 20,\n \"weight\": 2.5\n}"},"url":"{{url}}/v1/external/orders/update/adhoc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 12:02:38 GMT","enabled":true},{"key":"ETag","value":"W/\"87d6ae3fb3dfd10d4ddfcb948af0129172450585\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"64","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n\"success\": true,\n\"partially_update\": true,\n\"not_updated_fields\": \"order_date ,pickup_location ,channel_id ,comment ,reseller_name ,company_name ,billing_customer_name ,billing_last_name ,billing_address ,billing_address_2 ,billing_isd_code ,billing_city ,billing_pincode ,billing_state ,billing_country ,billing_email ,billing_phone ,billing_alternate_phone ,shipping_is_billing ,shipping_customer_name ,shipping_last_name ,shipping_address ,shipping_address_2 ,shipping_city ,shipping_pincode ,shipping_country ,shipping_state ,shipping_email ,shipping_phone ,payment_method ,ewaybill_no ,customer_gstin\",\n\"order_id\": 79491,\n\"shipment_id\": 77906,\n\"new_order_status\": \"NEW\",\n\"old_order_status\": 1,\n\"awb_code\": \"\",\n\"courier_company_id\": \"\",\n\"courier_name\": \"\"\n}"}],"_postman_id":"f08900fe-ea38-485d-b50c-3ec2fbc5644a"},{"name":"Cancel an Order","id":"5c0e41ca-d868-44c4-8ddb-73a8de239401","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ids\": []\n}"},"url":"https://apiv2.shiprocket.in/v1/external/orders/cancel","description":"Use this API to cancel a created order. Multiple order_ids can be passed together as an array to cancel them simultaneously.
\nUse this API to add inventory for ordered products that are out of stock or low on quantity. You have to pass the order id and order product id. You can also specify the number of items.
\nNotes:
\nThis API maps your unmapped inventory products.
\nNote:
\nUse this API to import orders in bulk to your Shiprocket account from an existing '.csv' file. The imported orders are automatically added to your panel.
\n","urlObject":{"protocol":"https","path":["v1","external","orders","import"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"1862b365-da8d-483b-a3fb-938f6fada54c","name":"Successful Call","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]},"url":"https://apiv2.shiprocket.in/v1/external/orders/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 10:44:04 GMT","enabled":true},{"key":"ETag","value":"W/\"4e6e512d76f7d14f121a811bb74f4ce1b802f5db\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"35","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 19739203\n}"},{"id":"559ddcca-9c6a-455d-ae1b-d6deed6a09aa","name":"Invalid Data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]},"url":"{{url}}/v1/external/orders/import"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 10:46:32 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Content-Length","value":"73","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Sorry, text/x-c file type is not allowed\",\n \"status_code\": 400\n}"},{"id":"8762101c-9bdd-42bc-9285-a0989852d52d","name":"Missing Fields","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[],"disabled":true}]},"url":"{{url}}/v1/external/orders/import"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 10:44:57 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Content-Length","value":"109","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Oops! Something went wrong.\",\n \"errors\": {\n \"file\": [\n \"The file field is required.\"\n ]\n },\n \"status_code\": 422\n}"}],"_postman_id":"e8350afd-ec64-4705-9d50-0e234cb3e7a7"}],"id":"639199eb-4fed-4770-9057-c8b3e32b2cd6","description":"Using these APIs, you can create new orders in your Shiprocket account or update existing orders.
You can also cancel an order, bulk import orders from a CSV file and update inventory for an ordered product.
This API can be used to assign the AWB (Air Waybill Number) to your shipment. The AWB is a unique number that helps you track the shipment and get details about it.
\nUse this API to check the list of couriers and the related information with Shiprocket based on the search criteria.
Note:
Use this API to check the availability of couriers between the pickup and delivery postal codes.
Further details like the estimated time of delivery, the rates along with the ids are also shown.
Note:
\nUse this API to create a pickup request for your order shipment. The API returns the pickup status along with the estimated pickup time.
You will have to call the 'Generate Manifest' API after the successful response of this API.
Note:
\nAdds pincodes to the seller's delivery‑block list, or removes them.
\nThe block action runs per‑pincode classification — valid entries are saved, invalid or duplicate entries are recorded in Activity Logs as a downloadable CSV instead of failing the whole request. The unblock action is all‑or‑nothing: the first invalid pincode aborts the call.
Pass the bearer token via header or query parameter:
\nblock is naturally idempotent. unblock is similarly idempotent for already‑removed pincodes.block produces a per‑pincode result CSV; unblock surfaces the first malformed entry inline in the response.Asia/Kolkata).Reads the seller's delivery‑block list. Multi‑mode — the mode is selected by query parameters:
\n\n\nOnly
\ndelivery_blockeddata is exposed.
Pass the bearer token via header or query parameter:
\nis_download=1 — wins over everything
search (non‑empty after trim) — wins over pagination
Default — paginated list
\nSearch isn't validated server‑side — pass any string; the server does prefix matching as‑is.
\nCSV download URL is presigned for 24 hours — generate a fresh link by calling the endpoint again after expiry.
\nper_page is silently capped at 15; values above 15 are treated as 15.
Use these APIs to assign AWB to your order, check for courier serviceability, and request for the pickup of your order.
\nAll available couriers, along with their codes, are mentioned below:
\n","event":[{"listen":"prerequest","script":{"id":"5b9b7a3c-4bc9-4e8e-a77f-2fb4ba197561","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c894ea92-75ce-4a81-a91e-44b4e4a32829","type":"text/javascript","exec":[""]}}],"_postman_id":"a091dfc1-f882-466a-96a1-e245d3c80c5b"},{"name":"Orders","item":[{"name":"Get all Orders","id":"d4f48023-b0b2-40af-8072-1adf97227d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/orders","description":"This API call will display a list of all created and available orders in your Shiprocket account. The product and shipment details are displayed as sub-arrays within each order detail.
\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.
\nYou can also fetch the data based on the order update date. PFB the validations:
\n1. if updated_to => passed and updated_from not passed =>, error will come => Please send update_from date along with update_to date\n2. if updated_from => passed and updated_to => paased => and from-to > 30 then error => Difference between updated_from and update_to date should not be greater than 30 days.\n3. if updated_From < 30 then error => Updated_from date should not be less than 30 days from current date\n\nGet the order and shipment details of a particular order through this API by passing the Shiprocket order_id in the endpoint URL itself — type in your order_id in place of {id}.
\nNo other body parameters are required.
\nNote:
\nFor SRF orders, you'll receive an extra parameter viz., fulfillment_status. This key will have four values:
\nThis API downloads and creates a CSV file of all the orders in your Shiprocket account and sends the download URL to the linked email account of the API user.
\nThe CSV file containing is accessible via this URL.\nNo parameters are required to access this API.
\n","urlObject":{"protocol":"https","path":["v1","external","orders","export"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"b25ebdca-4b19-478b-bf7a-fa55343cc02c","name":"Successful Call","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\n}"},"url":"{{url}}/v1/external/orders/export"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 12:02:38 GMT","enabled":true},{"key":"ETag","value":"W/\"87d6ae3fb3dfd10d4ddfcb948af0129172450585\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"64","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"is_background_downloading\": 1\n}"},{"id":"d61dc78f-6aec-4333-b49a-f88797827fb9","name":"Invalid Endpoint","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\n}"},"url":"{{url}}/v1/external/orders/expor"},"status":"Bad Gateway","code":502,"_postman_previewlanguage":"html","header":[{"key":"Content-Type","value":"text/html; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 12:15:24 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Content-Length","value":"166","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"\n \nThese APIs can be used to get details about your created orders, as well as manage them, which include fetching orders from your channel, syncing their status, and exporting them to a CSV file.
\nThe 'filter' values are mentioned below. Use these to filter your data:
\n","event":[{"listen":"prerequest","script":{"id":"9d79dc91-2834-4b5c-86a1-fb7d21e64b92","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96ba9a73-3214-4ccd-ab32-fbb325f3e130","type":"text/javascript","exec":[""]}}],"_postman_id":"fe000ead-c32f-47d2-a4ef-2a23e7ef5461"},{"name":"Return & Exchange Orders","item":[{"name":"Create a Return Order","id":"81b2135b-d43c-4002-8f7f-a670aa5210fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"r121579B09ap3o\",\n \"order_date\": \"2021-12-30\",\n \"channel_id\": \"27202\",\n \"pickup_customer_name\": \"iron man\",\n \"pickup_last_name\": \"\",\n \"company_name\":\"iorn pvt ltd\",\n \"pickup_address\": \"b 123\",\n \"pickup_address_2\": \"\",\n \"pickup_city\": \"Delhi\",\n \"pickup_state\": \"New Delhi\",\n \"pickup_country\": \"India\",\n \"pickup_pincode\": 110030,\n \"pickup_email\": \"deadpool@red.com\",\n \"pickup_phone\": \"9810363552\",\n \"pickup_isd_code\": \"91\",\n \"shipping_customer_name\": \"Jax\",\n \"shipping_last_name\": \"Doe\",\n \"shipping_address\": \"Castle\",\n \"shipping_address_2\": \"Bridge\",\n \"shipping_city\": \"ghaziabad\",\n \"shipping_country\": \"India\",\n \"shipping_pincode\": 201005,\n \"shipping_state\": \"Uttarpardesh\",\n \"shipping_email\": \"kumar.abhishek@shiprocket.com\",\n \"shipping_isd_code\": \"91\",\n \"shipping_phone\": 8888888888,\n \"order_items\": [\n {\n \"sku\": \"WSH234\",\n \"name\": \"shoes\",\n \"units\": 2,\n \"selling_price\": 100,\n \"discount\": 0,\n \"qc_enable\":true,\n \"hsn\": \"123\",\n \"brand\":\"\",\n \"qc_size\":\"43\"\n }\n ],\n \"payment_method\": \"PREPAID\",\n \"total_discount\": \"0\",\n \"sub_total\": 400,\n \"length\": 11,\n \"breadth\": 11,\n \"height\": 11,\n \"weight\": 0.5\n}"},"url":"https://apiv2.shiprocket.in/v1/external/orders/create/return","description":"Use this API to create a new return order in your Shiprocket panel. Return orders are created in case the buyer refuses/rejects/returns a specific order.
The parameter specifications are the same as the custom order API, with a few exceptions.
![https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/1636713733zxja.png](\"https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/1636713733zxja.png\"){kind=link}
1. Bought by Mistake\n2. Better price available\n3. Performance or quality not adequate\n4. Incompatible or not useful\n5. Product damaged, but shipping box OK\n6. Item arrived too late\n7. Missing parts or accessories\n8. Both product and shipping box damaged\n9. Wrong item was sent\n10. Item defective or doesn't work\n11. No longer needed\n12. Didn't approve purchase\n13. Inaccurate website description\n14. Return against replacement\n15. Delay Refund\n16. Delivered Late\n17. Product does not Match Description on Website\n18. Both Product & Outer Box Damaged\n19. Defective or does not work\n20. Product damaged, but outer Box OK\n21. Missing Parts or Accessories\n22. Incorrect Item Delivered\n23. Product Defective or Doesn't Work\n24. Product performance/quality is not up to my expectations\n25. Other\n26. Changed my mind\n27. Does not fit\n28. Size not as expected\n29. Item is damaged\n30. Received wrong item\n31. Parcel damaged on arrival\n32. Quality not as expected\n33. Missing Item or accessories\n34. Performance not adequate\n35. Not as described\n36. Arrived too late\n37. Order Not Received\n38. Empty Package\n39. Wrong item or Wrong colour was sent\n40. Item defective, expired, spoilt or does not work\n41. Items or parts missing\n42. Size or Quantity issues\n43. Status as delivered but order not received\n44. N/A\n\nUse this API to create a new exchange order in your Shiprocket panel. Exchange orders are created in case the buyer needs to replace an item due to reasons such as size mismatch, wrong product received, or defective product. This API helps sellers seamlessly process exchange requests while ensuring the correct quality checks and logistics handling
\nUse this API to update your return orders. Please specify the parameters based on the \"action\" key.
\nUsing this API, you can get a list of all created return orders in your Shiprocket account, along with their details.
\nNo parameters are required to use the API. However, further parameters can be defined to sort and filter the data.
\nUse this API to check the availability of couriers between the pickup and delivery postal codes.
Further details like the estimated time of delivery, the rates along with the ids are also shown.
Note:
\nOne of either the 'order_id' or 'cod' and 'weight' is required. If you specify the order id, the cod and weight fields are not required and vice versa.
\nYou can add further fields to add the shipment details and filter the search.
\nThis API can be used to assign the AWB (Air Waybill Number) to your shipment. The AWB is a unique number that helps you track the shipment and get details about it.
\nUse this API to get the shipment details of all the shipments in your Shiprocket account.
\nThe data is displayed in the default format if no filter or sort condition is passed. You can use the filter and sort conditions to streamline your data.
\nGet the details of a specific Shipment by passing the value of shipment_id in the endpoint URL.\nNo other body parameters are required.
\nUse this API to cancel a created shipment before the \"Out for Pickup\" state. Multiple AWBs can be passed together as an array to cancel them simultaneously.
\nLimit: 2000 AWBs
\nThese APIs can be used to get shipment details. You can either get all shipment details at once or the details of a particular shipment.
\nBelow are some associated status codes related to the shipments:
\nUsing this API, you can generate the manifest for your order.\nThis API generates the manifest and displays the download URL of the same.
\nNote:
\nUse this API to print the generated manifest of orders at an individual level.
\nNote
\nGenerate the label of order by passing the shipment id in the form of an array.\nThis API displays the URL of the generated label.
\nNote:
\nUse this API to generate the invoice for your order by passing the respective Shiprocket order ids.
\nThe generated invoice URL is displayed as a response.\nMultiple ids can be passed together as an array.
\nNote
\nThese APIs are designed for the generation of manifests, invoices and labels for your shipment. You can also get manifest details and print a manifest using the respective API's.
\n","_postman_id":"a9f708ec-5861-43b9-a510-8c1bba074cb5"},{"name":"Wrapper API","item":[{"name":"Forward","id":"6339172b-495f-4d2c-b1cf-2f8f493b6412","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mode\": \"\",\n \"request_pickup\": \"\",\n \"print_label\": \"\",\n \"generate_manifest\": \"\",\n \"ewaybill_no\": \"\",\n \"courier_id\": \"\",\n \"reseller_name\": \"\",\n \"order_id\": \"\",\n \"isd_code\": \"\",\n \"billing_isd_code\": \"\",\n \"order_date\": \"\",\n \"channel_id\": \"\",\n \"company_name\": \"\",\n \"billing_customer_name\": \"\",\n \"billing_last_name\": \"\",\n \"billing_address\": \"\",\n \"billing_address_2\": \"\",\n \"billing_city\": \"\",\n \"billing_state\": \"\",\n \"billing_country\": \"\",\n \"billing_pincode\": \"\",\n \"billing_email\": \"\",\n \"billing_phone\": \"\",\n \"billing_alternate_phone\": \"\",\n \"shipping_is_billing\": \"1\",\n \"shipping_customer_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_address\": \"\",\n \"shipping_address_2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_country\": \"\",\n \"shipping_pincode\": \"\",\n \"shipping_email\": \"\",\n \"shipping_phone\": \"\",\n \"order_items\": [\n {\n \"name\": \"\",\n \"sku\": \"\",\n \"units\": \"\",\n \"hsn\": \"\",\n \"selling_price\": \"\",\n \"tax\": \"\",\n \"discount\": \"\"\n }\n ],\n \"payment_method\": \"\",\n \"shipping_charges\": \"\",\n \"giftwrap_charges\": \"\",\n \"transaction_charges\": \"\",\n \"total_discount\": \"\",\n \"sub_total\": \"\",\n \"weight\": \"\",\n \"length\": \"\",\n \"breadth\": \"\",\n \"height\": \"\",\n \"pickup_location\": \"\",\n \"customer_gstin\": \"\",\n \"vendor_details\": {\n \"email\": \"\",\n \"phone\": \"\",\n \"name\": \"\",\n \"address\": \"\",\n \"address_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"pin_code\": \"\",\n \"pickup_location\": \"\"\n }\n}"},"url":"https://apiv2.shiprocket.in/v1/external/shipments/create/forward-shipment","description":"Use this API to do multiple tasks in one go, namely creating a quick order, requesting its shipment, and finally generating the label and the manifest for the same order.
\nThis API integrates several other APIs to perform all these tasks together.
\nNotes:
\nUse the 'vendor_details' array to add a new pickup location to your account and assign it to your order.
\nThe 'pickup_location' field must contain a new pickup location name for adding a new pickup location to your Shiprocket account.
\nIn case of multiple items per order, please pass the final weight (sum total weight of items) of the shipment.
\nUse this API to perform multiple tasks like Create, AWB generation & scheduling reverse pickups for your Returns.
The specifications are the same as the custom return order API, with a few exceptions.
Notes:
\npickup_location field is not required.
\nLabel and Manifest are not required in case of returns.
\nThis is an all-in-one API to create an order, ship the order, add a new pickup location and generate a label along with the manifest for the same.
\n","event":[{"listen":"prerequest","script":{"id":"330f4562-9694-4bdc-9eb9-6369b4389a41","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d1d0d7a7-3e16-41f2-8b09-c1bee4214029","type":"text/javascript","exec":[""]}}],"_postman_id":"7bd788f4-63ba-49c3-889e-960a379d090f"},{"name":"NDR","item":[{"name":"Get All NDR Shipments","id":"2958f079-0ac2-4a03-bfdd-99bc95d51f0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/ndr/all","description":"This API call will display a list of all the shipments that are in NDR in your Shiprocket 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 order through this API by passing the AWB number in the endpoint URL itself. You can get the details like AWB, NDR Attempt, NDR Reason, Customer Details, Product Details, Courier.
\nType in your AWB code in place of {AWB}. No other body parameters are required.
\nThis API will let you take actions like Reattempt and RTO on the shipments that are in NDR.
\nThese APIs can be used to get details about your shipments that are in NDR, as well as manage them, which includes fetching NDR shipments from your account (all or specific) and taking actions such as Reattempt and RTO based on the reason.
\n","_postman_id":"dd312b8d-92d8-4f93-a3dc-88700b061e8b"},{"name":"Tracking","item":[{"name":"Get Tracking through AWB ","id":"f2ac0962-4c34-4fe4-8266-50f8a1e8eab0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/courier/track/awb/{awb_code}\n","description":"Get the tracking details of your shipment by entering the AWB code of the same in the endpoint URL itself.\nNo other body parameters are required to access this API.
\nThe response is displayed in JSON format.
\nGet the tracking details of multiple shipments by entering their AWB codes together as an array.
\nThe response is displayed in JSON format.
\nNotes:
\nGet the tracking details of your shipment by entering the shipment_id of the same in the endpoint URL.\nNo other body parameters are required to access this API.
\nThe response is displayed in JSON format.
\nGet the tracking details of your shipment by entering the Order ID of the same in the endpoint URL itself.\nIf you have the same order ID in more than one channel, then use the param channel_id.
\nThe response is displayed in JSON format.
\nUse these APIs to get the tracking details of your shipments through the AWB code or the Shipment ID.
\nGet a list of all pickup locations that have been added to your Shiprocket account through this API.
\nNo parameters are required to use this API.
\n","urlObject":{"protocol":"https","path":["v1","external","settings","company","pickup"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"2b6bdeac-8214-4662-bcdd-324ddd6a7ec0","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"https://apiv2.shiprocket.in/v1/external/settings/company/pickup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Fri, 02 Aug 2019 09:56:01 GMT","enabled":true},{"key":"ETag","value":"W/\"cc6d67cf1428ac9d35933b9bad26061a34d6505c\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"593","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shipping_address\": [\n {\n \"id\": 4984500,\n \"pickup_location\": \"Casa Moderna\",\n \"address_type\": null,\n \"address\": \"1900 GF, Sector 45\",\n \"address_2\": \"near Park 1\",\n \"updated_address\": false,\n \"old_address\": \"\",\n \"old_address2\": \"\",\n \"tag\": \"\",\n \"tag_value\": \"\",\n \"instruction\": \"\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"country\": \"India\",\n \"pin_code\": \"122003\",\n \"email\": \"abcxyz@gmail.com\",\n \"is_first_mile_pickup\": 0,\n \"phone\": \"9667667496\",\n \"name\": \"CASA MODERNA\",\n \"company_id\": 1138022,\n \"gstin\": null,\n \"vendor_name\": null,\n \"status\": 2,\n \"phone_verified\": 1,\n \"lat\": \"28.44786453607\",\n \"long\": \"77.074250297017\",\n \"open_time\": null,\n \"close_time\": null,\n \"warehouse_code\": null,\n \"alternate_phone\": \"\",\n \"rto_address_id\": 4984500,\n \"lat_long_status\": 1,\n \"new\": 1,\n \"associated_rto_address\": null,\n \"is_primary_location\": 1\n }\n ],\n \"allow_more\": \"true\",\n \"is_blackbox_seller\": false,\n \"company_name\": \"CASA MODERNA\",\n \"recent_addresses\": []\n }\n}"},{"id":"addcf91b-4f88-4de7-b507-2b75848cee73","name":"Wrong Endpoint","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/settings/company/picku"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Tue, 06 Aug 2019 09:59:28 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Content-Length","value":"62","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"3bd67de6-8f00-435f-a708-c0c3ab252fee"},{"name":"Add a New Pickup Location","id":"6fbe81f5-c3d5-462e-b18f-d6316dde7779","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"pickup_location\": \"\",\n\t\"name\": \"\",\n\t\"email\": \"\",\n\t\"phone\": \"\",\n\t\"address\": \"\",\n\t\"address_2\": \"\",\n\t\"city\": \"\",\n\t\"state\":\"\",\n\t\"country\": \"\",\n\t\"pin_code\": \"\"\n\t\n}"},"url":"https://apiv2.shiprocket.in/v1/external/settings/company/addpickup","description":"This API can be used to add a new pickup location to your account.
Pass the minimum required parameters to add the location.
Further details to the address can be added if required.
Use these APIs to get a list of all available pickup locations in your account or add a new pickup location.
\n","_postman_id":"6949d954-d0ba-4749-99aa-2435ab7aaf4f"},{"name":"Hyperlocal","item":[{"name":"Orders","item":[{"name":"Create Custom Order","id":"239e82c3-29bc-4155-b124-d6f6884fb924","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"\",\n \"order_date\": \"\",\n \"pickup_location\": \"\",\n \"channel_id\": \"\",\n \"comment\": \"\",\n \"reseller_name\": \"\",\n \"company_name\": \"\",\n \"billing_customer_name\": \"\",\n \"billing_last_name\": \"\",\n \"billing_address\": \"\",\n \"billing_address_2\": \"\",\n \"billing_isd_code\": \"\",\n \"billing_city\": \"\",\n \"billing_pincode\": \"\",\n \"billing_state\": \"\",\n \"billing_country\": \"\",\n \"billing_email\": \"\",\n \"billing_phone\": \"\",\n \"billing_alternate_phone\":\"\",\n \"shipping_is_billing\": \"\",\n \"shipping_customer_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_address\": \"\",\n \"shipping_address_2\": \"\",\n \"shipping_city\": \"\",\n \"shipping_pincode\": \"\",\n \"shipping_country\": \"\",\n \"shipping_state\": \"\",\n \"shipping_email\": \"\",\n \"shipping_phone\": \"\",\n \"order_items\": [\n {\n \"name\": \"\",\n \"sku\": \"\",\n \"units\": \"\",\n \"selling_price\": \"\",\n \"discount\": \"\",\n \"tax\": \"\",\n \"hsn\": \"\"\n }\n ],\n \"payment_method\": \"\",\n \"shipping_charges\": \"\",\n \"giftwrap_charges\": \"\",\n \"transaction_charges\": \"\",\n \"total_discount\": \"\",\n \"sub_total\": \"\",\n \"length\": \"\",\n \"breadth\": \"\",\n \"height\": \"\",\n \"weight\": \"\",\n \"ewaybill_no\": \"\",\n \"customer_gstin\": \"\",\n \"invoice_number\":\"\",\n \"order_type\":\"\",\n}"},"url":"https://apiv2.shiprocket.in/v1/external/orders/create/adhoc","description":"Use this API to create a quick custom order. Quick orders are the ones where we do not store the product details in the master catalogue.
\nYou have to pass all the required params at the minimum to create a quick custom order. You can add additional parameters as per your preference.
\nNote:
\nIf no channel id is passed, the order will be assigned to the default custom channel. If the channel id is not known, use the 'Get All Channels' API to get the list of all integrated channels in your Shiprocket account.
\norder_id field cannot be equal to an already existing id. Doing so does not change or affect the existing order.
\nNew orders cannot be created with order id's same as that of cancelled orders. If error 422 shows up despite filling in the correct details, consider changing the order_id.
\nBe sure to input the correct calculated sub_total amount. The total is not calculated automatically through the API.
\nThe 'order_id' returned in the response is the Shiprocket order_id. Please save this order ID as we will use this in future API calls.
\nThis API call will display a list of all created and available orders in your Shiprocket account. The product and shipment details are displayed as sub-arrays within each order detail.
\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.
\nYou can also fetch the data based on the order update date. PFB the validations:
\n![https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/imports/ndr/img_7687678678.jpg](\"https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/imports/ndr/img_7687678678.jpg\"){kind=link}
1. if updated_to => passed and updated_from not passed =>, error will come => Please send update_from date along with update_to date\n2. if updated_from => passed and updated_to => paased => and from-to > 30 then error => Difference between updated_from and update_to date should not be greater than 30 days.\n3. if updated_From < 30 then error => Updated_from date should not be less than 30 days from current date\n\nGet the order and shipment details of a particular order through this API by passing the Shiprocket order_id in the endpoint URL itself — type in your order_id in place of {id}.
\nNo other body parameters are required.
\nNote:
\nFor SRF orders, you'll receive an extra parameter viz., fulfillment_status. This key will have four values:
\nThis API downloads and creates a CSV file of all the orders in your Shiprocket account and sends the download URL to the linked email account of the API user.
\nThe CSV file containing is accessible via this URL.\nNo parameters are required to access this API.
\n","urlObject":{"protocol":"https","path":["v1","external","orders","export"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"fef0650c-76b5-4f34-8eca-b268c3c7b33a","name":"Successful Call","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\n}"},"url":"{{url}}/v1/external/orders/export"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 12:02:38 GMT","enabled":true},{"key":"ETag","value":"W/\"87d6ae3fb3dfd10d4ddfcb948af0129172450585\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"64","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"is_background_downloading\": 1\n}"},{"id":"a9d9826c-f3d9-4a77-9561-c5230ae5e239","name":"Invalid Endpoint","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\n}"},"url":"{{url}}/v1/external/orders/expor"},"status":"Bad Gateway","code":502,"_postman_previewlanguage":"html","header":[{"key":"Content-Type","value":"text/html; charset=utf-8","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 12:15:24 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Content-Length","value":"166","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"\n \nThese APIs can be used to get details about your created orders, as well as manage them, which include fetching orders from your channel, syncing their status, and exporting them to a CSV file.
\nThe 'filter' values are mentioned below. Use these to filter your data:
\n","event":[{"listen":"prerequest","script":{"id":"9d79dc91-2834-4b5c-86a1-fb7d21e64b92","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96ba9a73-3214-4ccd-ab32-fbb325f3e130","type":"text/javascript","exec":[""]}}],"_postman_id":"25daf791-ebf2-427a-b84f-f8e4f292c1db"},{"name":"Couriers","item":[{"name":"Generate AWB for Shipment","id":"a74b0f30-fbff-4a84-8411-49f1369cee8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"shipment_id\": \"\",\n \"courier_id\": \"\",\n \"status\": \"\"\n \n}"},"url":"https://apiv2.shiprocket.in/v1/external/courier/assign/awb","description":"This API can be used to assign the AWB (Air Waybill Number) to your shipment. The AWB is a unique number that helps you track the shipment and get details about it.
\nUse this API to check the availability of couriers between the pickup and delivery postal codes.
Further details like the estimated time of delivery, the rates along with the ids are also shown.
Note:
\nOne of either the 'order_id' or 'cod' and 'weight' is required. If you specify the order id, the cod and weight fields are not required and vice versa.
\nYou can add further fields to add the shipment details and filter the search.
\nUse these APIs to assign AWB to your order, check for courier serviceability, and request for the pickup of your order.
\n","event":[{"listen":"prerequest","script":{"id":"5b9b7a3c-4bc9-4e8e-a77f-2fb4ba197561","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c894ea92-75ce-4a81-a91e-44b4e4a32829","type":"text/javascript","exec":[""]}}],"_postman_id":"9712aa46-aaa2-46a9-82e1-5147af6d3a9b"},{"name":"Tracking","item":[{"name":"Get Tracking through AWB ","id":"f9d3ec7b-728a-4a65-9392-1d96e675b464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/courier/track/awb/{awb_code}\n","description":"Get the tracking details of your shipment by entering the AWB code of the same in the endpoint URL itself.\nNo other body parameters are required to access this API.
\nThe response is displayed in JSON format.
\nGet the tracking details of multiple shipments by entering their AWB codes together as an array.
\nThe response is displayed in JSON format.
\nNotes:
\nGet the tracking details of your shipment by entering the shipment_id of the same in the endpoint URL.\nNo other body parameters are required to access this API.
\nThe response is displayed in JSON format.
\nGet the tracking details of your shipment by entering the Order ID of the same in the endpoint URL itself.\nIf you have the same order ID in more than one channel, then use the param channel_id.
\nThe response is displayed in JSON format.
\nUse these APIs to get the tracking details of your shipments through the AWB code or the Shipment ID.
\nGet a list of all pickup locations that have been added to your Shiprocket account through this API.
\nNo parameters are required to use this API.
\n","urlObject":{"protocol":"https","path":["v1","external","settings","company","pickup"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"5d86d7e7-10f9-4752-9512-5772b09d8f13","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"https://apiv2.shiprocket.in/v1/external/settings/company/pickup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Fri, 02 Aug 2019 09:56:01 GMT","enabled":true},{"key":"ETag","value":"W/\"cc6d67cf1428ac9d35933b9bad26061a34d6505c\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"593","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shipping_address\": [\n {\n \"id\": 4984500,\n \"pickup_location\": \"Casa Moderna\",\n \"address_type\": null,\n \"address\": \"1900 GF, Sector 45\",\n \"address_2\": \"near Park 1\",\n \"updated_address\": false,\n \"old_address\": \"\",\n \"old_address2\": \"\",\n \"tag\": \"\",\n \"tag_value\": \"\",\n \"instruction\": \"\",\n \"city\": \"Gurgaon\",\n \"state\": \"Haryana\",\n \"country\": \"India\",\n \"pin_code\": \"122003\",\n \"email\": \"abcxyz@gmail.com\",\n \"is_first_mile_pickup\": 0,\n \"phone\": \"9667667496\",\n \"name\": \"CASA MODERNA\",\n \"company_id\": 1138022,\n \"gstin\": null,\n \"vendor_name\": null,\n \"status\": 2,\n \"phone_verified\": 1,\n \"lat\": \"28.44786453607\",\n \"long\": \"77.074250297017\",\n \"open_time\": null,\n \"close_time\": null,\n \"warehouse_code\": null,\n \"alternate_phone\": \"\",\n \"rto_address_id\": 4984500,\n \"lat_long_status\": 1,\n \"new\": 1,\n \"associated_rto_address\": null,\n \"is_primary_location\": 1\n }\n ],\n \"allow_more\": \"true\",\n \"is_blackbox_seller\": false,\n \"company_name\": \"CASA MODERNA\",\n \"recent_addresses\": []\n }\n}"},{"id":"19795e49-3719-4e69-8d04-fbe5c432e610","name":"Wrong Endpoint","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/settings/company/picku"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Tue, 06 Aug 2019 09:59:28 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Content-Length","value":"62","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"3b9e3a84-7036-47f3-a79f-4d7180c349c5"},{"name":"Add a New Pickup Location","id":"5c990ea0-6c04-48da-8cc0-c231e1e6ded9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"pickup_location\": \"\",\n\t\"name\": \"\",\n\t\"email\": \"\",\n\t\"phone\": \"\",\n\t\"address\": \"\",\n\t\"address_2\": \"\",\n\t\"city\": \"\",\n\t\"state\":\"\",\n\t\"country\": \"\",\n\t\"pin_code\": \"\"\n\t\n}"},"url":"https://apiv2.shiprocket.in/v1/external/settings/company/addpickup","description":"This API can be used to add a new pickup location to your account.
Pass the minimum required parameters to add the location.
Further details to the address can be added if required.
Use these APIs to get a list of all available pickup locations in your account or add a new pickup location.
\n","_postman_id":"54129ee6-fbc6-4b82-8ef7-607045ed9fee"}],"id":"2fe757ce-e268-4b28-8763-d6dbb8640e45","_postman_id":"2fe757ce-e268-4b28-8763-d6dbb8640e45","description":""},{"name":"International","item":[{"name":"Tracking","item":[{"name":"Get Tracking through AWB","id":"19d91f90-fe89-4b91-ba9f-e15f70abdab6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/courier/track/awb/{awb_code}\n","description":"Get the tracking details of your shipment by entering the AWB code of the same in the endpoint URL itself.\nNo other body parameters are required to access this API.
\nThe response is displayed in JSON format.
\nGet the tracking details of your shipment by entering the shipment_id of the same in the endpoint URL.\nNo other body parameters are required to access this API.
\nThe response is displayed in JSON format.
\nGet the tracking details of your shipment by entering the Order ID of the same in the endpoint URL itself.\nIf you have the same order ID in more than one channel, then use the param channel_id.
\nThe response is displayed in JSON format.
\nGet the tracking details of your shipments. No other body parameters are required to access this API.
\n","urlObject":{"protocol":"https","path":["v1","external","international","orders","track"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"f3fcc9d9-2ede-49bd-a90b-af0d34565e7c","name":"Tracking Successful","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/external/international/orders/track"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Powered-By","value":"PHP/7.2.34","enabled":true},{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Date","value":"Tue, 10 May 2022 13:58:47 GMT","enabled":true},{"key":"X-RateLimit-Limit","value":"100000","enabled":true},{"key":"X-RateLimit-Remaining","value":"99999","enabled":true},{"key":"ETag","value":"\"cbf730fe9a816a57e5ce32f70c2e60d6475b9265\"","enabled":true},{"key":"X-Clockwork-Id","value":"1652191126.4717.1823548748","enabled":true},{"key":"X-Clockwork-Version","value":"1.14.5","enabled":true},{"key":"Server-Timing","value":"app=1651.2451171875; \"Application\", db=252.51; \"Database\", timeline-event-total=1652.2181034088; \"Total execution time.\", timeline-event-initialisation=465.93499183655; \"Application initialisation.\", timeline-event-boot=294.47412490845; \"Framework booting.\", timeline-event-run=1186.2790584564; \"Framework running.\"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 153210141,\n \"channel_id\": 2252386,\n \"channel_name\": \"CUSTOM\",\n \"base_channel_code\": \"CS\",\n \"channel_order_id\": \"7022318826\",\n \"customer_name\": \"Shubham OworldInt \",\n \"customer_email\": \"shubham.tyagi+1@shiprocket.com\",\n \"customer_phone\": \"8923309680\",\n \"customer_address\": \"223, alaKam, Aramex\",\n \"customer_address_2\": \"\",\n \"customer_city\": \"UPTON\",\n \"customer_state\": \"New York\",\n \"customer_pincode\": \"11973\",\n \"customer_country\": \"United States\",\n \"customer_latitude\": null,\n \"customer_longitude\": null,\n \"customer_alternate_phone\": \"\",\n \"pickup_location\": \"SR International\",\n \"package_instructions\": null,\n \"order_type\": 0,\n \"payment_status\": \"\",\n \"total\": \"1000.00\",\n \"tax\": \"0.00\",\n \"sla\": \"2 days\",\n \"shipping_method\": \"SR\",\n \"expedited\": 0,\n \"status\": \"DELIVERED\",\n \"status_code\": 7,\n \"awd_etds\": null,\n \"master_status\": \"FULFILLED\",\n \"payment_method\": \"prepaid\",\n \"change_payment_mode\": false,\n \"is_international\": 1,\n \"purpose_of_shipment\": 0,\n \"channel_created_at\": \"16 Dec 2021, 09:16 AM\",\n \"created_at\": \"16 Dec 2021, 09:16 AM\",\n \"updated_at\": \"3 Jan 2022, 09:55 AM\",\n \"pickup_boy_name\": \"\",\n \"pickup_boy_contact_no\": \"\",\n \"products\": [\n {\n \"id\": 212990291,\n \"channel_order_product_id\": \"212990291\",\n \"name\": \"Tshirt\",\n \"channel_sku\": \"sku300\",\n \"quantity\": 1,\n \"product_id\": 84244695,\n \"available\": 1,\n \"status\": \"UNDEFINED\",\n \"price\": \"1000.00\",\n \"product_cost\": \"1000.00\",\n \"status_code\": 1,\n \"hsn\": \"\"\n }\n ],\n \"shipments\": [\n {\n \"id\": 152757127,\n \"isd_code\": \"\",\n \"courier\": \"SR International\",\n \"courier_id\": 140,\n \"shipping_charges\": \"\",\n \"weight\": \"0.45\",\n \"dimensions\": \"10x10x10\",\n \"shipped_date\": \"2021-11-27 23:52:19\",\n \"pickup_scheduled_date\": \"27/11/2021\",\n \"pickup_token_number\": null,\n \"awb\": \"1527571275\",\n \"return_awb\": \"\",\n \"volumetric_weight\": 0.2,\n \"pod\": null,\n \"etd\": \"NA\",\n \"saral_etd\": \"NA\",\n \"rto_delivered_date\": \"0000-00-00 00:00:00\",\n \"delivered_date\": \"2021-12-08 05:40:00\",\n \"etd_escalation_btn\": false,\n \"rto_initiated_date\": \"0000-00-00 00:00:00\",\n \"package_images\": \"\",\n \"weight_action\": null,\n \"status\": 7,\n \"pickup_id\": \"\",\n \"delivery_executive_name\": \"\",\n \"delivery_executive_number\": \"\"\n }\n ],\n \"cod\": 0,\n \"activities\": [\n \"ORDER_CREATED\",\n \"LABEL_GENERATED\",\n \"LABEL_GENERATED\",\n \"LABEL_GENERATED\",\n \"ORDER_DELIVERED\"\n ],\n \"allow_return\": 0,\n \"is_incomplete\": 0,\n \"errors\": [],\n \"pickup_exception_reason\": \"\",\n \"rto_prediction\": \"\",\n \"show_escalation_btn\": 0,\n \"escalation_status\": \"\",\n \"pii_removed\": 0,\n \"allow_multiship\": true,\n \"others\": {\n \"weight\": 0.45,\n \"isd_code\": \"+1\",\n \"quantity\": 1,\n \"self_ship\": false,\n \"buyer_psid\": null,\n \"dimensions\": \"10x10x10\",\n \"billing_city\": \"UPTON\",\n \"billing_name\": \"Shubham OworldInt \",\n \"company_name\": \"\",\n \"billing_email\": \"shubham.tyagi+1@shiprocket.com\",\n \"billing_phone\": \"\",\n \"billing_state\": \"New York\",\n \"currency_code\": \"INR\",\n \"package_count\": 1,\n \"reseller_name\": \"\",\n \"customer_gstin\": \"\",\n \"billing_address\": \"223, alaKam, Aramex\",\n \"billing_country\": \"United States\",\n \"billing_pincode\": \"11973\",\n \"billing_isd_code\": \"+1\",\n \"shipping_charges\": \"0\",\n \"billing_address_2\": \"\",\n \"is_order_verified\": 0,\n \"order_verified_at\": \"\",\n \"billing_alternate_phone\": \"\"\n },\n \"package_list\": {\n \"packages\": [],\n \"selected\": false,\n \"select_item\": false,\n \"all_packages\": []\n },\n \"pickup_address_detail\": {\n \"id\": 1883284,\n \"pickup_code\": \"SR International\",\n \"gstin\": null,\n \"invoice_prefix\": null,\n \"invoice_serial\": null,\n \"address\": \"123, tetsing line\",\n \"address_2\": \"\",\n \"address_type\": null,\n \"city\": \"East Delhi\",\n \"state\": \"Delhi\",\n \"country\": \"India\",\n \"pin_code\": \"110032\",\n \"email\": \"shubham.tyagi@shiprocket.com\",\n \"phone\": \"8923309680\",\n \"phone_verified\": 1,\n \"alternate_phone\": \"\",\n \"name\": \"Shubham\",\n \"company_id\": 2,\n \"status\": 1,\n \"rto_address_id\": 1883284,\n \"delhivery_clientware_id\": null,\n \"delhivery_surface_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_standard_clientware_id\": \"KARTROCKETSMALL SURFACE-East Delhi-110032-Shubham-2-1883284\",\n \"delhivery_surface_lite_clientware_id\": \"KARTROCKETMEDIUM SURFACE-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_10kg_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_20kg_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"sx_delhivery_clientware_id\": null,\n \"sx_delhivery_surface_clientware_id\": null,\n \"sx4_delhivery_surface_clientware_id\": null,\n \"sx3_delhivery_surface_clientware_id\": null,\n \"sx2_delhivery_surface_clientware_id\": null,\n \"sx1_delhivery_surface_clientware_id\": null,\n \"created_at\": \"2021-11-15 11:13:56\",\n \"updated_at\": \"2022-05-10 19:15:43\",\n \"gati_surface_customer_vendor_code\": null,\n \"gati_sg_customer_vendor_code\": null,\n \"delhivery_flash_air_clientware_id\": null,\n \"updated_on\": \"2022-05-10 13:45:43\",\n \"lat\": \"\",\n \"long\": \"\",\n \"delhivery_essential_5kg_clientware_id\": null,\n \"warehouse_code\": null,\n \"gati_surface_10kg_customer_vendor_code\": null,\n \"extra_info\": \"{\\\"source\\\": 1}\",\n \"delhivery_documents_clientware_id\": null,\n \"delhivery_documents_250gm_clientware_id\": null\n },\n \"rto_address\": [],\n \"re_escalate\": 0,\n \"seller_request\": {\n \"show_pod_actions\": false,\n \"can_request_pod\": false,\n \"pod_dispute\": \"\",\n \"pod_requested\": false,\n \"status\": \"\",\n \"lops_remark\": \"\",\n \"status_value\": \"\",\n \"can_raise_dispute\": false\n },\n \"engage\": \"NA\",\n \"total_dead_weight\": null,\n \"total_volumetric_weight\": null,\n \"total_order_value\": null,\n \"boxes\": null,\n \"order_tag\": [],\n \"is_return\": 0,\n \"is_b2b\": false,\n \"is_insurance_opt\": false,\n \"manifest_id\": \"\",\n \"manifest_generated\": false,\n \"awb_data\": {\n \"charges\": {\n \"zone\": \"\",\n \"cod_charges\": \"\",\n \"applied_weight_amount\": \"1486.00\",\n \"freight_charges\": \"1486.00\",\n \"applied_weight\": \"0.450\",\n \"charged_weight\": \"\",\n \"charged_weight_amount\": \"\",\n \"charged_weight_amount_rto\": \"0.00\",\n \"applied_weight_amount_rto\": \"0.00\",\n \"billing_amount\": \"\",\n \"service_type_id\": \"\"\n }\n },\n \"escalation_history\": []\n },\n {\n \"id\": 153210135,\n \"channel_id\": 2252386,\n \"channel_name\": \"CUSTOM\",\n \"base_channel_code\": \"CS\",\n \"channel_order_id\": \"4327343108\",\n \"customer_name\": \"Shubham NARAmex \",\n \"customer_email\": \"shubham.tyagi+1@shiprocket.com\",\n \"customer_phone\": \"8923309680\",\n \"customer_address\": \"223, alaKam, Aramex\",\n \"customer_address_2\": \"\",\n \"customer_city\": \"UPTON\",\n \"customer_state\": \"New York\",\n \"customer_pincode\": \"11973\",\n \"customer_country\": \"United States\",\n \"customer_latitude\": null,\n \"customer_longitude\": null,\n \"customer_alternate_phone\": \"\",\n \"pickup_location\": \"SR International\",\n \"package_instructions\": null,\n \"order_type\": 0,\n \"payment_status\": \"\",\n \"total\": \"1000.00\",\n \"tax\": \"0.00\",\n \"sla\": \"2 days\",\n \"shipping_method\": \"SR\",\n \"expedited\": 0,\n \"status\": \"DELIVERED\",\n \"status_code\": 7,\n \"awd_etds\": null,\n \"master_status\": \"FULFILLED\",\n \"payment_method\": \"prepaid\",\n \"change_payment_mode\": false,\n \"is_international\": 1,\n \"purpose_of_shipment\": 0,\n \"channel_created_at\": \"1 Dec 2021, 10:09 AM\",\n \"created_at\": \"1 Dec 2021, 10:10 AM\",\n \"updated_at\": \"3 Jan 2022, 09:48 AM\",\n \"pickup_boy_name\": \"\",\n \"pickup_boy_contact_no\": \"\",\n \"products\": [\n {\n \"id\": 212990285,\n \"channel_order_product_id\": \"212990285\",\n \"name\": \"Tshirt\",\n \"channel_sku\": \"sku300\",\n \"quantity\": 1,\n \"product_id\": 84244695,\n \"available\": 1,\n \"status\": \"UNDEFINED\",\n \"price\": \"1000.00\",\n \"product_cost\": \"1000.00\",\n \"status_code\": 1,\n \"hsn\": \"\"\n }\n ],\n \"shipments\": [\n {\n \"id\": 152757121,\n \"isd_code\": \"\",\n \"courier\": \"SR International\",\n \"courier_id\": 140,\n \"shipping_charges\": \"\",\n \"weight\": \"0.31\",\n \"dimensions\": \"11x10x10\",\n \"shipped_date\": \"2021-11-04 05:25:57\",\n \"pickup_scheduled_date\": \"01/12/2021\",\n \"pickup_token_number\": \"Pickup confirmation number: L01B2FA, GUID: 02462e3d-b203-46c8-a823-dfa320a43577, Reference: Shipment Pickup - 2021-12-01\",\n \"awb\": \"1527571212\",\n \"return_awb\": \"\",\n \"volumetric_weight\": 0.22,\n \"pod\": null,\n \"etd\": \"NA\",\n \"saral_etd\": \"NA\",\n \"rto_delivered_date\": \"0000-00-00 00:00:00\",\n \"delivered_date\": \"2021-11-29 08:07:00\",\n \"etd_escalation_btn\": false,\n \"rto_initiated_date\": \"0000-00-00 00:00:00\",\n \"package_images\": \"\",\n \"weight_action\": null,\n \"status\": 7,\n \"pickup_id\": \"\",\n \"delivery_executive_name\": \"\",\n \"delivery_executive_number\": \"\"\n }\n ],\n \"cod\": 0,\n \"activities\": [\n \"ORDER_CREATED\",\n \"INVOICED\",\n \"LABEL_GENERATED\",\n \"PICKUP_QUEUE\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"ORDER_DELIVERED\"\n ],\n \"allow_return\": 0,\n \"is_incomplete\": 0,\n \"errors\": [],\n \"pickup_exception_reason\": \"\",\n \"rto_prediction\": \"\",\n \"show_escalation_btn\": 0,\n \"escalation_status\": \"\",\n \"pii_removed\": 0,\n \"allow_multiship\": true,\n \"others\": {\n \"weight\": 0.311,\n \"isd_code\": \"+1\",\n \"quantity\": 1,\n \"self_ship\": false,\n \"buyer_psid\": null,\n \"dimensions\": \"11x10x10\",\n \"billing_city\": \"UPTON\",\n \"billing_name\": \"Shubham NARAmex \",\n \"company_name\": \"\",\n \"billing_email\": \"shubham.tyagi+1@shiprocket.com\",\n \"billing_phone\": \"\",\n \"billing_state\": \"New York\",\n \"currency_code\": \"INR\",\n \"package_count\": 1,\n \"reseller_name\": \"\",\n \"customer_gstin\": \"\",\n \"billing_address\": \"223, alaKam, Aramex\",\n \"billing_country\": \"United States\",\n \"billing_pincode\": \"11973\",\n \"billing_isd_code\": \"+1\",\n \"shipping_charges\": \"0\",\n \"billing_address_2\": \"\",\n \"is_order_verified\": 0,\n \"order_verified_at\": \"\",\n \"billing_alternate_phone\": \"\"\n },\n \"package_list\": {\n \"packages\": [],\n \"selected\": false,\n \"select_item\": false,\n \"all_packages\": []\n },\n \"pickup_address_detail\": {\n \"id\": 1883284,\n \"pickup_code\": \"SR International\",\n \"gstin\": null,\n \"invoice_prefix\": null,\n \"invoice_serial\": null,\n \"address\": \"123, tetsing line\",\n \"address_2\": \"\",\n \"address_type\": null,\n \"city\": \"East Delhi\",\n \"state\": \"Delhi\",\n \"country\": \"India\",\n \"pin_code\": \"110032\",\n \"email\": \"shubham.tyagi@shiprocket.com\",\n \"phone\": \"8923309680\",\n \"phone_verified\": 1,\n \"alternate_phone\": \"\",\n \"name\": \"Shubham\",\n \"company_id\": 2,\n \"status\": 1,\n \"rto_address_id\": 1883284,\n \"delhivery_clientware_id\": null,\n \"delhivery_surface_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_standard_clientware_id\": \"KARTROCKETSMALL SURFACE-East Delhi-110032-Shubham-2-1883284\",\n \"delhivery_surface_lite_clientware_id\": \"KARTROCKETMEDIUM SURFACE-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_10kg_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_20kg_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"sx_delhivery_clientware_id\": null,\n \"sx_delhivery_surface_clientware_id\": null,\n \"sx4_delhivery_surface_clientware_id\": null,\n \"sx3_delhivery_surface_clientware_id\": null,\n \"sx2_delhivery_surface_clientware_id\": null,\n \"sx1_delhivery_surface_clientware_id\": null,\n \"created_at\": \"2021-11-15 11:13:56\",\n \"updated_at\": \"2022-05-10 19:15:43\",\n \"gati_surface_customer_vendor_code\": null,\n \"gati_sg_customer_vendor_code\": null,\n \"delhivery_flash_air_clientware_id\": null,\n \"updated_on\": \"2022-05-10 13:45:43\",\n \"lat\": \"\",\n \"long\": \"\",\n \"delhivery_essential_5kg_clientware_id\": null,\n \"warehouse_code\": null,\n \"gati_surface_10kg_customer_vendor_code\": null,\n \"extra_info\": \"{\\\"source\\\": 1}\",\n \"delhivery_documents_clientware_id\": null,\n \"delhivery_documents_250gm_clientware_id\": null\n },\n \"rto_address\": [],\n \"re_escalate\": 0,\n \"seller_request\": {\n \"show_pod_actions\": false,\n \"can_request_pod\": false,\n \"pod_dispute\": \"\",\n \"pod_requested\": false,\n \"status\": \"\",\n \"lops_remark\": \"\",\n \"status_value\": \"\",\n \"can_raise_dispute\": false\n },\n \"engage\": \"NA\",\n \"total_dead_weight\": null,\n \"total_volumetric_weight\": null,\n \"total_order_value\": null,\n \"boxes\": null,\n \"order_tag\": [],\n \"is_return\": 0,\n \"is_b2b\": false,\n \"is_insurance_opt\": false,\n \"manifest_id\": \"MANIFEST-0032\",\n \"manifest_generated\": true,\n \"awb_data\": {\n \"charges\": {\n \"zone\": \"\",\n \"cod_charges\": \"\",\n \"applied_weight_amount\": \"1297.00\",\n \"freight_charges\": \"1297.00\",\n \"applied_weight\": \"0.310\",\n \"charged_weight\": \"\",\n \"charged_weight_amount\": \"\",\n \"charged_weight_amount_rto\": \"0.00\",\n \"applied_weight_amount_rto\": \"0.00\",\n \"billing_amount\": \"\",\n \"service_type_id\": \"\"\n }\n },\n \"escalation_history\": []\n },\n {\n \"id\": 153210130,\n \"channel_id\": 2252386,\n \"channel_name\": \"CUSTOM\",\n \"base_channel_code\": \"CS\",\n \"channel_order_id\": \"7850384358\",\n \"customer_name\": \"Shubham NAramex \",\n \"customer_email\": \"shubham.tyagi+1@shiprocket.com\",\n \"customer_phone\": \"8923309680\",\n \"customer_address\": \"223, alaKam, Aramex\",\n \"customer_address_2\": \"\",\n \"customer_city\": \"UPTON\",\n \"customer_state\": \"New York\",\n \"customer_pincode\": \"11973\",\n \"customer_country\": \"United States\",\n \"customer_latitude\": null,\n \"customer_longitude\": null,\n \"customer_alternate_phone\": \"\",\n \"pickup_location\": \"SR International\",\n \"package_instructions\": null,\n \"order_type\": 0,\n \"payment_status\": \"\",\n \"total\": \"990.00\",\n \"tax\": \"0.00\",\n \"sla\": \"2 days\",\n \"shipping_method\": \"SR\",\n \"expedited\": 0,\n \"status\": \"DELIVERED\",\n \"status_code\": 7,\n \"awd_etds\": null,\n \"master_status\": \"FULFILLED\",\n \"payment_method\": \"prepaid\",\n \"change_payment_mode\": false,\n \"is_international\": 1,\n \"purpose_of_shipment\": 0,\n \"channel_created_at\": \"25 Nov 2021, 05:02 AM\",\n \"created_at\": \"25 Nov 2021, 05:03 AM\",\n \"updated_at\": \"3 Jan 2022, 09:48 AM\",\n \"pickup_boy_name\": \"\",\n \"pickup_boy_contact_no\": \"\",\n \"products\": [\n {\n \"id\": 212990280,\n \"channel_order_product_id\": \"212990280\",\n \"name\": \"Tshirt\",\n \"channel_sku\": \"sku300\",\n \"quantity\": 1,\n \"product_id\": 84244695,\n \"available\": 1,\n \"status\": \"UNDEFINED\",\n \"price\": \"1000.00\",\n \"product_cost\": \"1000.00\",\n \"status_code\": 1,\n \"hsn\": \"\"\n }\n ],\n \"shipments\": [\n {\n \"id\": 152757115,\n \"isd_code\": \"\",\n \"courier\": \"SR International\",\n \"courier_id\": 140,\n \"shipping_charges\": \"\",\n \"weight\": \"0.301\",\n \"dimensions\": \"10x10x10\",\n \"shipped_date\": \"2021-11-04 05:25:33\",\n \"pickup_scheduled_date\": \"01/12/2021\",\n \"pickup_token_number\": \"Pickup confirmation number: L018C2A, GUID: 88da068e-fc6e-43ee-86db-2b09f1b1a4a4, Reference: Shipment Pickup - 2021-12-01\",\n \"awb\": \"1527571157\",\n \"return_awb\": \"\",\n \"volumetric_weight\": 0.2,\n \"pod\": null,\n \"etd\": \"NA\",\n \"saral_etd\": \"NA\",\n \"rto_delivered_date\": \"0000-00-00 00:00:00\",\n \"delivered_date\": \"2021-11-11 05:16:00\",\n \"etd_escalation_btn\": false,\n \"rto_initiated_date\": \"0000-00-00 00:00:00\",\n \"package_images\": \"\",\n \"weight_action\": null,\n \"status\": 7,\n \"pickup_id\": \"\",\n \"delivery_executive_name\": \"\",\n \"delivery_executive_number\": \"\"\n }\n ],\n \"cod\": 0,\n \"activities\": [\n \"ORDER_CREATED\",\n \"DIMENSIONS_EDITED\",\n \"INVOICED\",\n \"LABEL_GENERATED\",\n \"PICKUP_QUEUE\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\",\n \"MANIFEST_SCHEDULED\"\n ],\n \"allow_return\": 0,\n \"is_incomplete\": 0,\n \"errors\": [],\n \"pickup_exception_reason\": \"\",\n \"rto_prediction\": \"\",\n \"show_escalation_btn\": 0,\n \"escalation_status\": \"\",\n \"pii_removed\": 0,\n \"allow_multiship\": true,\n \"others\": {\n \"weight\": 0.301,\n \"isd_code\": \"+1\",\n \"quantity\": 1,\n \"self_ship\": false,\n \"buyer_psid\": null,\n \"dimensions\": \"10x10x10\",\n \"billing_city\": \"UPTON\",\n \"billing_name\": \"Shubham NAramex \",\n \"company_name\": \"\",\n \"billing_email\": \"shubham.tyagi+1@shiprocket.com\",\n \"billing_phone\": \"\",\n \"billing_state\": \"New York\",\n \"currency_code\": \"USD\",\n \"package_count\": 1,\n \"reseller_name\": \"\",\n \"customer_gstin\": \"\",\n \"billing_address\": \"223, alaKam, Aramex\",\n \"billing_country\": \"United States\",\n \"billing_pincode\": \"11973\",\n \"billing_isd_code\": \"+1\",\n \"shipping_charges\": \"0\",\n \"billing_address_2\": \"\",\n \"is_order_verified\": 0,\n \"order_verified_at\": \"\",\n \"billing_alternate_phone\": \"\"\n },\n \"package_list\": {\n \"packages\": [],\n \"selected\": false,\n \"select_item\": false,\n \"all_packages\": []\n },\n \"pickup_address_detail\": {\n \"id\": 1883284,\n \"pickup_code\": \"SR International\",\n \"gstin\": null,\n \"invoice_prefix\": null,\n \"invoice_serial\": null,\n \"address\": \"123, tetsing line\",\n \"address_2\": \"\",\n \"address_type\": null,\n \"city\": \"East Delhi\",\n \"state\": \"Delhi\",\n \"country\": \"India\",\n \"pin_code\": \"110032\",\n \"email\": \"shubham.tyagi@shiprocket.com\",\n \"phone\": \"8923309680\",\n \"phone_verified\": 1,\n \"alternate_phone\": \"\",\n \"name\": \"Shubham\",\n \"company_id\": 2,\n \"status\": 1,\n \"rto_address_id\": 1883284,\n \"delhivery_clientware_id\": null,\n \"delhivery_surface_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_standard_clientware_id\": \"KARTROCKETSMALL SURFACE-East Delhi-110032-Shubham-2-1883284\",\n \"delhivery_surface_lite_clientware_id\": \"KARTROCKETMEDIUM SURFACE-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_10kg_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"delhivery_surface_20kg_clientware_id\": \"Kart Rocket Surface-East Delhi-110032-Shiprocket-2-1883284\",\n \"sx_delhivery_clientware_id\": null,\n \"sx_delhivery_surface_clientware_id\": null,\n \"sx4_delhivery_surface_clientware_id\": null,\n \"sx3_delhivery_surface_clientware_id\": null,\n \"sx2_delhivery_surface_clientware_id\": null,\n \"sx1_delhivery_surface_clientware_id\": null,\n \"created_at\": \"2021-11-15 11:13:56\",\n \"updated_at\": \"2022-05-10 19:15:43\",\n \"gati_surface_customer_vendor_code\": null,\n \"gati_sg_customer_vendor_code\": null,\n \"delhivery_flash_air_clientware_id\": null,\n \"updated_on\": \"2022-05-10 13:45:43\",\n \"lat\": \"\",\n \"long\": \"\",\n \"delhivery_essential_5kg_clientware_id\": null,\n \"warehouse_code\": null,\n \"gati_surface_10kg_customer_vendor_code\": null,\n \"extra_info\": \"{\\\"source\\\": 1}\",\n \"delhivery_documents_clientware_id\": null,\n \"delhivery_documents_250gm_clientware_id\": null\n },\n \"rto_address\": [],\n \"re_escalate\": 0,\n \"seller_request\": {\n \"show_pod_actions\": false,\n \"can_request_pod\": false,\n \"pod_dispute\": \"\",\n \"pod_requested\": false,\n \"status\": \"\",\n \"lops_remark\": \"\",\n \"status_value\": \"\",\n \"can_raise_dispute\": false\n },\n \"engage\": \"NA\",\n \"total_dead_weight\": null,\n \"total_volumetric_weight\": null,\n \"total_order_value\": null,\n \"boxes\": null,\n \"order_tag\": [],\n \"is_return\": 0,\n \"is_b2b\": false,\n \"is_insurance_opt\": false,\n \"manifest_id\": \"MANIFEST-0032\",\n \"manifest_generated\": true,\n \"awb_data\": {\n \"charges\": {\n \"zone\": \"\",\n \"cod_charges\": \"\",\n \"applied_weight_amount\": \"1297.00\",\n \"freight_charges\": \"1297.00\",\n \"applied_weight\": \"0.301\",\n \"charged_weight\": \"\",\n \"charged_weight_amount\": \"\",\n \"charged_weight_amount_rto\": \"0.00\",\n \"applied_weight_amount_rto\": \"0.00\",\n \"billing_amount\": \"\",\n \"service_type_id\": \"\"\n }\n },\n \"escalation_history\": []\n }\n ],\n \"meta\": {\n \"counts\": {\n \"nofilter_pickup_count\": 1,\n \"awbs\": 1,\n \"nofilter_manifested_count\": 1,\n \"nofilter_readytoship_count\": 1,\n \"shipped\": 1,\n \"total\": 1,\n \"nofilter_processing_count\": 1,\n \"is_first\": false\n },\n \"pagination\": {\n \"total\": 3,\n \"count\": 3,\n \"per_page\": 15,\n \"current_page\": 1,\n \"total_pages\": 1,\n \"links\": {}\n }\n }\n}"}],"_postman_id":"778b14b6-444d-4941-982a-8809bd1275a3"}],"id":"12b1cc4b-de0b-436b-ac5b-359f62f3514b","description":"Use these APIs to get the tracking details of your shipments through the AWB code or the Shipment ID.
\n","_postman_id":"12b1cc4b-de0b-436b-ac5b-359f62f3514b"},{"name":"International KYC","id":"e5fd2056-db19-4b46-a58c-0f89f7d311b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Use this API for your international KYC. This API return your KYC status.
Please check the documentation for the documents for KYC.
ThisdocumentationprovidesinformationabouttheBankDetailsAPI,whichallowsyouto
addbankdetailsforinternationalsettings.TheAPIendpoint, parameters, request sample
data, success response , and failed response are outlined below.
Use this API to create a quick custom order. Quick orders are the ones where we do not store the product details in the master catalogue.
\nYou have to pass all the required params at the minimum to create a quick custom order. You can add additional parameters as per your preference.
\nNote:
\nIf no channel id is passed, the order will be assigned to the default custom channel. If the channel id is not known, use the 'Get All Channels' API to get the list of all integrated channels in your Shiprocket account.
\nUse this API to update your orders. You have to pass all the required params at the minimum to create a quick custom order. You can add additional parameters as per your preference.
\nYou can update only the order_items details before assigning the AWB (before Ready to Ship status). You can only update these key-value pairs i.e increase/decrease the quantity, update tax/discount, add/remove product items. Some params specific to international order are.
\n","urlObject":{"protocol":"https","path":["v1","external","international","orders","update","adhoc"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"ab252b26-bd9c-45d1-a47d-b6d253af6629","name":"Update order (Sucess Response)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_id\":1726470481,\r\n \"isd_code\":\"+1\",\r\n \"billing_isd_code\":\"\",\r\n \"order_date\":\"2022-03-30T00:34:12.311Z\",\r\n \"channel_id\":2252386,\r\n \"billing_customer_name\":\"Elena \",\r\n \"billing_last_name\":\"\",\r\n \"billing_address\":\"Plot No. 348, 134113, India\",\r\n \"billing_address_2\":\"\",\r\n \"billing_city\":\"Panchkula\",\r\n \"billing_state\":\"Haryana\",\r\n \"billing_country\":\"India\",\r\n \"billing_pincode\":\"134113\",\r\n \"billing_email\":\"test.test@shiprocket.com\",\r\n \"billing_phone\":9761858933,\r\n \"landmark\":\"\",\r\n \"shipping_is_billing\":1,\r\n \"shipping_customer_name\":\"Elena \",\r\n \"shipping_last_name\":\"\",\r\n \"shipping_address\":\"Plot 1, Panchkula, Haryana 134113, India\",\r\n \"shipping_address_2\":\"\",\r\n \"shipping_city\":\"Dallas\",\r\n \"order_type\":1,\r\n \"shipping_country\":\"United States\",\r\n \"shipping_pincode\":\"134090\",\r\n \"shipping_state\":\"Texas\",\r\n \"shipping_email\":\"test.test@shiprocket.com\",\r\n \"product_category\":\"\",\r\n \"shipping_phone\":9711153722,\r\n \"billing_alternate_phone\":\"\",\r\n \"order_items\":[\r\n {\r\n \"name\":\"Combo of 4 Way Spanner and Hydraulic trolly Jack\",\r\n \"sku\":\"5-47606\",\r\n \"category_name\":\"Default Category\",\r\n \"tax\":\"\",\r\n \"hsn\":\"\",\r\n \"units\":\"1\",\r\n \"selling_price\":\"100\",\r\n \"discount\":\"\",\r\n \"category_id\":\"\",\r\n \"caetgroy_code\":\"\"\r\n }\r\n ],\r\n \"payment_method\":\"Prepaid\",\r\n \"shipping_charges\":0,\r\n \"giftwrap_charges\":0,\r\n \"transaction_charges\":0,\r\n \"total_discount\":0,\r\n \"sub_total\":100,\r\n \"weight\":0.51,\r\n \"length\":20,\r\n \"breadth\":20,\r\n \"height\":20,\r\n \"pickup_location_id\":255,\r\n \"reseller_name\":\"\",\r\n \"company_name\":\"\",\r\n \"ewaybill_no\":\"\",\r\n \"customer_gstin\":\"\",\r\n \"is_order_revamp\":1,\r\n \"is_document\":0,\r\n \"delivery_challan\":false,\r\n \"order_tag\":\"\",\r\n \"purpose_of_shipment\":0,\r\n \"currency\":\"EUR\",\r\n \"reasonOfExport\":2,\r\n \"is_insurance_opt\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apiv2.shiprocket.in/v1/external/international/orders/update/adhoc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.5","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Powered-By","value":"PHP/7.2.34","enabled":true},{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Date","value":"Wed, 27 Apr 2022 04:57:18 GMT","enabled":true},{"key":"X-RateLimit-Limit","value":"100000","enabled":true},{"key":"X-RateLimit-Remaining","value":"99999","enabled":true},{"key":"ETag","value":"\"43fbe8a78b3099699713b930b4e8a22859f90bca\"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"partially_update\": true,\n \"not_updated_fields\": \"isd_code ,billing_isd_code ,order_date ,channel_id ,billing_customer_name ,billing_last_name ,billing_address ,billing_address_2 ,billing_city ,billing_state ,billing_country ,billing_pincode ,billing_email ,billing_phone ,landmark ,shipping_is_billing ,shipping_customer_name ,shipping_last_name ,shipping_address ,shipping_address_2 ,shipping_city ,order_type ,shipping_country ,shipping_pincode ,shipping_state ,shipping_email ,product_category ,shipping_phone ,billing_alternate_phone ,payment_method ,pickup_location_id ,reseller_name ,company_name ,ewaybill_no ,customer_gstin ,is_order_revamp ,is_document ,delivery_challan ,order_tag ,purpose_of_shipment ,currency ,reasonOfExport ,is_insurance_opt ,is_web\",\n \"order_id\": 153210169,\n \"shipment_id\": 152757155,\n \"new_order_status\": \"NEW\",\n \"old_order_status\": 1,\n \"awb_code\": \"\",\n \"courier_company_id\": \"\",\n \"courier_name\": \"\"\n}"},{"id":"2a39aa9a-76bd-4675-9595-0a951fbae598","name":"Update order (Failure Response)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_id\":1726470381,\r\n \"isd_code\":\"+1\",\r\n \"billing_isd_code\":\"\",\r\n \"order_date\":\"2022-03-30T00:34:12.311Z\",\r\n \"channel_id\":846,\r\n \"billing_customer_name\":\"Elena \",\r\n \"billing_last_name\":\"\",\r\n \"billing_address\":\"Plot No. 348, Panchkula, Haryana 134113, India\",\r\n \"billing_address_2\":\"\",\r\n \"billing_city\":\"Panchkula\",\r\n \"billing_state\":\"Haryana\",\r\n \"billing_country\":\"India\",\r\n \"billing_pincode\":\"134113\",\r\n \"billing_email\":\"test.test@shiprocket.com\",\r\n \"billing_phone\":9760856722,\r\n \"landmark\":\"\",\r\n \"shipping_is_billing\":1,\r\n \"shipping_customer_name\":\"Elena \",\r\n \"shipping_last_name\":\"\",\r\n \"shipping_address\":\"Plot No. 348, Panchkula, 134113, India\",\r\n \"shipping_address_2\":\"\",\r\n \"shipping_city\":\"Dallas\",\r\n \"order_type\":1,\r\n \"shipping_country\":\"United States\",\r\n \"shipping_pincode\":\"134090\",\r\n \"shipping_state\":\"Texas\",\r\n \"shipping_email\":\"ruchi.parijat@shiprocket.com\",\r\n \"product_category\":\"\",\r\n \"shipping_phone\":9760833322,\r\n \"billing_alternate_phone\":\"\",\r\n \"order_items\":[\r\n {\r\n \"name\":\"Combo of 4 Way Spanner and Hydraulic trolly Jack\",\r\n \"sku\":\"5-47606\",\r\n \"category_name\":\"Default Category\",\r\n \"tax\":\"\",\r\n \"hsn\":\"\",\r\n \"units\":\"1\",\r\n \"selling_price\":\"100\",\r\n \"discount\":\"\",\r\n \"category_id\":\"\",\r\n \"caetgroy_code\":\"\"\r\n }\r\n ],\r\n \"payment_method\":\"Prepaid\",\r\n \"shipping_charges\":0,\r\n \"giftwrap_charges\":0,\r\n \"transaction_charges\":0,\r\n \"total_discount\":0,\r\n \"sub_total\":100,\r\n \"weight\":0.41,\r\n \"length\":10,\r\n \"breadth\":10,\r\n \"height\":10,\r\n \"pickup_location_id\":255,\r\n \"reseller_name\":\"\",\r\n \"company_name\":\"\",\r\n \"ewaybill_no\":\"\",\r\n \"customer_gstin\":\"\",\r\n \"is_order_revamp\":1,\r\n \"is_document\":0,\r\n \"delivery_challan\":false,\r\n \"order_tag\":\"\",\r\n \"purpose_of_shipment\":0,\r\n \"currency\":\"USD\",\r\n \"reasonOfExport\":2,\r\n \"is_insurance_opt\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apiv2.shiprocket.in/v1/external/international/orders/update/adhoc"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.5","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Powered-By","value":"PHP/7.2.34","enabled":true},{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Date","value":"Wed, 27 Apr 2022 04:53:43 GMT","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Order Update for this channel is not allowed\",\n \"status_code\": 400\n}"}],"_postman_id":"9ed12abd-859c-4b7b-99c3-69fdd30622e1"},{"name":"International Wrapper API","id":"b3bfb960-e845-47a3-a3df-c7667c05e003","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Use this API to do multiple tasks in one go, namely creating a quick order, requesting its shipment, pickup generation generating the label and the manifest for the same order.
\nThis API integrates several other APIs to perform all these tasks together.
\n","urlObject":{"protocol":"https","path":["v1","external","international","shipments","create","forward-shipment"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"df33f9b9-4beb-4fb6-9740-1d8f70cc5832","name":"International Wrapper API","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"320988727\",\n \"order_date\": \"2022-05-08 12:23\",\n \"channel_id\": \"\",\n \"billing_customer_name\": \"Jax\",\n \"billing_last_name\": \"Tank\",\n \"billing_address\": \"Dust2\",\n \"billing_city\": \"New Delhi\",\n \"billing_pincode\": \"442001\",\n \"billing_state\": \"Delhi\",\n \"billing_country\": \"India\",\n \"billing_email\": \"jax@counterstike.com\",\n \"billing_phone\": \"9988998899\",\n \"shipping_is_billing\": false,\n \"shipping_customer_name\": \"Elena \",\n \"shipping_last_name\": \"\",\n \"shipping_address\": \"Plot 1, Panchkula, Haryana 134113, India\",\n \"shipping_address_2\": \"\",\n \"shipping_city\": \"UPTON\",\n \"order_type\": 1,\n \"shipping_country\": \"United States\",\n \"shipping_pincode\": \"11973\",\n \"shipping_state\": \"New York\",\n \"shipping_email\": \"test.test@shiprocket.com\",\n \"product_category\": \"\",\n \"shipping_phone\": 9760853722,\n \"order_items\": [\n {\n \"name\": \"Delta\",\n \"sku\": \"delta123\",\n \"units\": 10,\n \"selling_price\": \"1000\",\n \"hsn\": \"24567870\"\n }\n ],\n \"payment_method\": \"PREPAID\",\n \"sub_total\": 40,\n \"length\": 10,\n \"breadth\": 10,\n \"height\": 10,\n \"weight\": 0.7,\n \"pickup_location\": \"rtryttest\",\n \"vendor_details\": {\n \"email\": \"mayur.p@iksula.com\",\n \"phone\": 9879879879,\n \"name\": \"Coco Cookie\",\n \"address\": \"F2004 Street Street 1 Street \",\n \"address_2\": \"\",\n \"city\": \"delhi\",\n \"state\": \"new delhi\",\n \"country\": \"india\",\n \"pin_code\": \"442001\",\n \"pickup_location\": \"rtryttest\"\n },\n \"purpose_of_shipment\": 0,\n \"currency\": \"INR\",\n \"igstPaymentStatus\": \"A\",\n \"Terms_Of_Invoice\": \"Paid\",\n \"igst_amount\": 10,\n \"ioss\": \"IM1234567890\",\n \"pickup_location_id\": 647\n}"},"url":"https://apiv2.shiprocket.in/v1/external/international/shipments/create/forward-shipment"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"pickup_location_added\": 0,\n \"order_created\": 1,\n \"awb_generated\": 1,\n \"label_generated\": 1,\n \"pickup_generated\": 1,\n \"manifest_generated\": 1,\n \"pickup_scheduled_date\": \"2022-12-16 09:00:00\",\n \"pickup_booked_date\": null,\n \"order_id\": 53861,\n \"shipment_id\": 52367,\n \"awb_code\": \"8329468061579\",\n \"courier_company_id\": 140,\n \"courier_name\": \"Shiprocket Premium\",\n \"assigned_date_time\": \"2023-10-10T08:14:00.278336Z\",\n \"applied_weight\": 1,\n \"cod\": 0,\n \"label_url\": \"https://kr-multichannel.s3.ap-southeast-1.amazonaws.com/1049/labels/1671100520_shipping-label-52367-8329468061579.pdf\",\n \"manifest_url\": \"https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/1049/manifest/MANIFEST-0032.pdf\",\n \"routing_code\": \"\",\n \"rto_routing_code\": \"\",\n \"pickup_token_number\": 102725472\n}"}],"_postman_id":"b3bfb960-e845-47a3-a3df-c7667c05e003"},{"name":"Serviceability","id":"9e3a0095-f3d6-486f-a62b-3f7b7ce82a53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"This API checks courier serviceability for international orders and displays them as a list.
\nNotes:
\nThis API can be used to assign the AWB (Air Waybill Number) to your shipment. The AWB is a unique number that helps you track the shipment and get details about it.
\n","urlObject":{"protocol":"https","path":["v1","external","international","courier","assign","awb"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"9cb686a9-cfcd-4946-8752-9fa574f6c814","name":"AWB Assignment Successfully","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipment_id\": 160169474,\n \"courier_id\": 332,\n \"status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apiv2.shiprocket.in/external/international/courier/assign/awb"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"awb_assign_status\": 1,\n \"response\": {\n \"data\": {\n \"courier_company_id\": 10,\n \"awb_code\": \"1091208940593\",\n \"cod\": 0,\n \"order_id\": 181771297,\n \"shipment_id\": 160169474,\n \"awb_code_status\": 1,\n \"assigned_date_time\": {\n \"date\": \"2022-05-10 11:18:37.397226\",\n \"timezone_type\": 3,\n \"timezone\": \"Asia/Kolkata\"\n },\n \"applied_weight\": 1,\n \"company_id\": 25149,\n \"courier_name\": \"Delhivery\",\n \"child_courier_name\": null,\n \"routing_code\": \"DEL/KIS\",\n \"rto_routing_code\": \"\",\n \"invoice_no\": \"test5769122383\",\n \"transporter_id\": \"06AAPCS9575E1ZR\",\n \"transporter_name\": \"Delhivery\",\n \"shipped_by\": {\n \"shipper_company_name\": \"New RtO\",\n \"shipper_address_1\": \"34- house\",\n \"shipper_address_2\": \"\",\n \"shipper_city\": \"South West Delhi\",\n \"shipper_state\": \"Delhi\",\n \"shipper_country\": \"India\",\n \"shipper_postcode\": \"110030\",\n \"shipper_first_mile_activated\": 0,\n \"shipper_phone\": \"7777777777\",\n \"lat\": \"28.517677\",\n \"long\": \"77.175261\",\n \"shipper_email\": \"new@rto.com\",\n \"rto_company_name\": \"New RtO\",\n \"rto_address_1\": \"34- house\",\n \"rto_address_2\": \"\",\n \"rto_city\": \"South West Delhi\",\n \"rto_state\": \"Delhi\",\n \"rto_country\": \"India\",\n \"rto_postcode\": \"110030\",\n \"rto_phone\": \"8888888888\",\n \"rto_email\": \"new@rto.com\"\n }\n }\n }\n}"},{"id":"de01a888-9b4f-4fc0-be1c-8ec6269566dc","name":"AWB Assignment Failed","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipment_id\": [152757126],\n \"courier_id\": 140,\n \"status\": \"reassign\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apiv2.shiprocket.in/external/international/courier/assign/awb"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Powered-By","value":"PHP/7.2.34","enabled":true},{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Date","value":"Tue, 10 May 2022 13:50:54 GMT","enabled":true},{"key":"X-RateLimit-Limit","value":"100000","enabled":true},{"key":"X-RateLimit-Remaining","value":"99999","enabled":true},{"key":"ETag","value":"\"7a3bb431e5fa58a77e1745bed27bac5e71138f06\"","enabled":true},{"key":"X-Clockwork-Id","value":"1652190650.6256.1777938530","enabled":true},{"key":"X-Clockwork-Version","value":"1.14.5","enabled":true},{"key":"Server-Timing","value":"app=4234.7939014435; \"Application\", db=416.33; \"Database\", timeline-event-total=4235.5630397797; \"Total execution time.\", timeline-event-initialisation=398.08487892151; \"Application initialisation.\", timeline-event-boot=287.53113746643; \"Framework booting.\", timeline-event-run=3837.4688625336; \"Framework running.\"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"awb_assign_status\": 0,\n \"response\": {\n \"data\": {\n \"awb_assign_error\": \"Awb Assignment Failed\"\n }\n }\n}"},{"id":"7c45e770-266e-4432-ac38-5116f462d899","name":"Invalid Courier Provided","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipment_id\": [152757135],\n \"courier_id\": 32\n}","options":{"raw":{"language":"json"}}},"url":"https://apiv2.shiprocket.in/external/international/courier/assign/awb"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Powered-By","value":"PHP/7.2.34","enabled":true},{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Date","value":"Wed, 11 May 2022 06:38:56 GMT","enabled":true},{"key":"X-Clockwork-Id","value":"1652251132.9924.875478717","enabled":true},{"key":"X-Clockwork-Version","value":"1.14.5","enabled":true},{"key":"Server-Timing","value":"app=4284.4910621643; \"Application\", db=284.89; \"Database\", timeline-event-total=4285.2931022644; \"Total execution time.\", timeline-event-initialisation=1137.1619701385; \"Application initialisation.\", timeline-event-boot=567.54994392395; \"Framework booting.\", timeline-event-run=3148.1449604034; \"Framework running.\"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Uh-oh! Invalid Courier for international shipment!\"\n}"}],"_postman_id":"f67c6cef-3669-4a13-badc-582485558c5b"},{"name":"Manifest Generation","id":"47237a00-0df1-4a66-880a-39b0b38ef00b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipment_id\": [12345]\n}","options":{"raw":{"language":"json"}}},"url":"https://apiv2.shiprocket.in/v1/external/international/manifests/generate","description":"Use this API to create a pickup request for your order shipment. The API returns the pickup status along with the estimated pickup time.
You will have to call the 'Generate Manifest' API after the successful response of this API.
Note:
\nUse this API to create a pickup request for your order shipment. The API returns the pickup status along with the estimated pickup time.
You will have to call the 'Generate Manifest' API after the successful response of this API.
Note:
\nThese endpoints are used for operations related to international orders and shipments.
\n","_postman_id":"0a3baf38-ea29-47a2-affc-c8e922d8b492"},{"name":"Account","item":[{"name":"Get Wallet Balance","id":"341bd458-5d80-4978-8e30-13651be2a652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://apiv2.shiprocket.in/v1/external/account/details/wallet-balance","description":"Use this API to get the Wallet balance details of your Shiprocket account. No parameters are required to access this API.
\n","urlObject":{"protocol":"https","path":["v1","external","account","details","wallet-balance"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"9c0e5812-12f1-42d4-a793-cc4539a34ebd","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/account/details/wallet-balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Sun, 04 Aug 2019 13:52:11 GMT","enabled":true},{"key":"ETag","value":"W/\"e035e559ccf03640dd9a7411a1298c28c995e978\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"178","enabled":true},{"key":"Content-Length","value":"189","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"balance_amount\": \"-291539.83\"\n }\n}\n \n"}],"_postman_id":"341bd458-5d80-4978-8e30-13651be2a652"}],"id":"142ea62c-9f62-464e-a2f3-dda27ce4968a","_postman_id":"142ea62c-9f62-464e-a2f3-dda27ce4968a","description":""},{"name":"Products","item":[{"name":"Get All Products","id":"0b8d1f26-3abd-4f4e-9cd8-3928bcfcf30b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://apiv2.shiprocket.in/v1/external/products","description":"This API can be used to display a detailed list of all the products that you have in your Shiprocket account.
\nThere are no required parameters to access this API. However, the displayed result can be filtered or sorted using additional parameters.
\nUse this API to get the details of a specific product. The product details will be displayed in JSON format.
\nYou need to pass the product id in the endpoint URL for the successful call of the API. No other body parameters are required.
\nUse this API to add a new product to your Shiprocket account.
Provide the required product details and any additional info to successfully add a new product to your product list.
Notes:
\n'sku' Id has to be unique. It cannot be the same as an existing sku.
\nIn case no category code is added, the code should be default.
\n'type' field should be either 'single' or 'multiple.'
\nUse this API to convert an existing product to a QC product. The {productID} will be the \"id\" from the \"Get all products\" or \"Get specific product details\" API.
\nUse this API to import your products in bulk from a .csv file.
No parameters are required. Choose the target file as required. You will receive an import id upon successful import operation.
This API will provide a sample format for a CSV file that can be used for importing orders. You can use this format to create your CSV file, which you want to use to import products into your Shiprocket account.
\nNo additional parameters are required.
\n","urlObject":{"protocol":"https","path":["v1","external","products","sample"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"90f3eeeb-46d7-4099-89fb-5a81aa483467","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/products/sample"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Cache-Control","value":"cache, must-revalidate","enabled":true},{"key":"Content-Disposition","value":"attachment; filename=\"export-2019-08-051564989042.csv\"","enabled":true},{"key":"Content-Type","value":"application/csv; charset=UTF-8","enabled":true},{"key":"Date","value":"Mon, 05 Aug 2019 07:10:42 GMT","enabled":true},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT","enabled":true},{"key":"Last-Modified","value":"Mon, 05 Aug 2019 12:40:42","enabled":true},{"key":"Pragma","value":"public","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Content-Length","value":"1086","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"\"Category Name\",\"*Master Sku Code\",\"*Product Name\",\"Low Stock Warning At\",\"Description\",\"Length (cm)\",\"Width (cm)\",\"Height (cm)\",\"Weight (kgs)\",\"ean\",\"upc\",\"isbn\",\"Color\",\"Brand\",\"Size\",\"Tax Code\",\"Image Url\",\"Custom Detail Fields (IMEI/SerialNumber)\",\"MRP\",\"Cost Price\",\"Active(True/False)\",\"Type(Single)\",\"HSN code\"\r\n\"Below given is the sample data. Please delete the same and create/upload data as per you requirements. \",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\"\r\n\"Default\",\"Tshirt-Blue-42\",\"Blue tshirt 42 size\",\"2\",\"blue polo tshirt with round collor large size\",\"50\",\"42\",\"\",\"500\",\"1235467891111\",\"\",\"\",\"blue\",\"nike\",\"42\",\"5\",\"http://www.onlinebachat.com/photos/MjAxNi0wMy0yMCAwNzowMzo1Nw==_tshirt%20yellow.jpg\",\"\",\"2500\",\"1500\",\"\",\"\",\"\"\r\n\"Electronics\",\"Iphone5s\",\"Iphone5s\",\"1\",\"iphone 5s with 1 year warranty...\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"Black\",\"Iphone\",\"\",\"\",\"\",\"IMEI\",\"20000\",\"\",\"\",\"\",\"\"\r\n\"Electronics\",\"Iphone6\",\"Iphone6\",\"1\",\"iphone 6 with 1 year manufacturer warranty..\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"Silver\",\"Iphone\",\"\",\"\",\"\",\"IMEI\",\"50000\",\"\",\"True\",\"\",\"\"\r\n"},{"id":"782a4803-c828-42c1-81ab-2868c30d56f3","name":"Wrong Endpoint","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/products/sampl"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Mon, 05 Aug 2019 07:14:33 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Content-Length","value":"62","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"4dd4e689-34e5-4b8e-9234-3e5ff0a40fda"}],"id":"5046ae90-2014-4453-90d5-2ce776567f47","description":"Use these APIs to get information on your added products or update their details. You can also add a new product or import them in bulk.
\n","_postman_id":"5046ae90-2014-4453-90d5-2ce776567f47"},{"name":"Listings","item":[{"name":"Get All Listings","id":"4fcd7340-009b-472d-b5f6-3050ef6a924e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://apiv2.shiprocket.in/v1/external/listings","description":"This API can be used to get a JSON representation of all the product listings in your Shiprocket account, i.e., all the products associated with a specific channel.
\nNo parameters are required to access this API. However, the displayed data can be filtered and sorted using further parameters. If no sort parameter is used, the data is displayed in the default format.
\nUse this API to map a product present in the channel catalogue to a product present in the master catalogue.
\nPass the product and listing id for the successful call of the API
\nUse this API to import a CSV file containing channel catalogue to the master catalogue mappings.
\nNo other body parameters are required.
\n","urlObject":{"protocol":"https","path":["v1","external","listings","import"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"b6b6414e-8d3d-4e1d-9a96-66d8b1d64e8f","name":"Successful Call","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]},"url":"https://apiv2.shiprocket.in/v1/external/listings/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Mon, 05 Aug 2019 07:35:52 GMT","enabled":true},{"key":"ETag","value":"W/\"2b51965e2c73defe5036a3b8c334f100b1ec3d2a\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"35","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 20294650\n}"},{"id":"6db0e0b1-5074-40ca-a2f0-709bd5f52d34","name":"Missing Fields","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]},"url":"{{url}}/v1/external/listings/import"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"File required\",\n \"status_code\": 400\n}"}],"_postman_id":"416c1ff1-b9b0-4ceb-96ec-a82a58ea42bb"},{"name":"Export Mapped Products","id":"dc5a2f21-a8b5-4650-9d85-654f695dafed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://apiv2.shiprocket.in/v1/external/listings/export/mapped","description":"This API downloads the list of mapped items in your channel catalogue sheet. After mapping the items, you can see the number of products in one channel present in the Master Catalogue.
\nThe downloaded CSV file URL is shared as the response.\nNo other body parameters are required.
\n","urlObject":{"protocol":"https","path":["v1","external","listings","export","mapped"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"33232303-919f-4bff-8a19-1d9dbb0ffe2e","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/listings/export/mapped"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Mon, 05 Aug 2019 07:41:27 GMT","enabled":true},{"key":"ETag","value":"W/\"e1759cf929984697e726baed841a2b2cfabcd88d\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"135","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"download_url\": \"https://s3-ap-southeast-1.amazonaws.com/kr-shipmultichannel/imports/c_67216/export-2019-08-051564990885.csv\"\n}"},{"id":"7b192f78-3e83-4967-b6c1-97b6e9e4ec67","name":"Wrong Endpoint","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/listings/export/mappe"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Mon, 05 Aug 2019 07:44:17 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Content-Length","value":"62","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"dc5a2f21-a8b5-4650-9d85-654f695dafed"},{"name":"Export Unmapped Products","id":"5aa8c7ae-1498-4fbe-8f51-1c2307e4df46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://apiv2.shiprocket.in/v1/external/listings/export/unmapped","description":"Get a list of all the unmapped products in your channel catalogue using this API.
\nThe list is downloaded into a CSV file, and the download URL is displayed as the response.\nNo other body parameters are required.
\n","urlObject":{"protocol":"https","path":["v1","external","listings","export","unmapped"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"9a29f217-e08c-4cae-8107-61ecd2851351","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/listings/export/unmapped"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Mon, 05 Aug 2019 08:00:35 GMT","enabled":true},{"key":"ETag","value":"W/\"740132329a57056a08a086abb436ed176a2f0183\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"135","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"download_url\": \"https://s3-ap-southeast-1.amazonaws.com/kr-shipmultichannel/imports/c_67216/export-2019-08-051564992035.csv\"\n}"},{"id":"268fbfa2-8617-4255-8f35-11247820e0b4","name":"Wrong Endpoint","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/listings/export/unmappe"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Mon, 05 Aug 2019 08:05:57 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Content-Length","value":"62","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"5aa8c7ae-1498-4fbe-8f51-1c2307e4df46"},{"name":"Export Catalog Sample","id":"e3702d94-5f0e-426c-a7d6-ea19bf90561c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/listings/sample","description":"This API displays the download link of a sample catalogue sheet for reference purposes.
\nNo additional parameters are required.
\n","urlObject":{"protocol":"https","path":["v1","external","listings","sample"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"06214bcd-43cb-450b-a341-9e84619ef375","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/listings/sample"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Mon, 05 Aug 2019 07:56:16 GMT","enabled":true},{"key":"ETag","value":"W/\"90b25d196c3779e731ab7ea04f0af3cd40053c6c\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"134","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"download_url\": \"https://s3-ap-southeast-1.amazonaws.com/kr-shipmultichannel/imports/c_67216/export-2019-08-051564991776.csv\"\n}"},{"id":"97faf15d-2ac4-4c49-b19e-8914ddfff0b7","name":"Wrong Endpoint","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/listings/sampl"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"e3702d94-5f0e-426c-a7d6-ea19bf90561c"}],"id":"8e302e63-cbe7-40ee-bd2d-b37b3905c300","_postman_id":"8e302e63-cbe7-40ee-bd2d-b37b3905c300","description":""},{"name":"Channels","item":[{"name":"Get Integrated Channel Details","id":"b9b9bcbe-923c-4ccd-a46e-d9f089622a80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/channels","description":"This API shows a list of all the channels that have already been integrated with your Shiprocket account.
\nNo parameters are required to access this API.
\n","urlObject":{"protocol":"https","path":["v1","external","channels"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"76c17959-0903-4b83-a3e0-b23585e6b519","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/channels"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Wed, 31 Jul 2019 07:19:52 GMT","enabled":true},{"key":"ETag","value":"W/\"c77ed1f214bb3a6e009edb23a3c26558df9be8f9\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"177","enabled":true},{"key":"Content-Length","value":"3282","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 76893,\n \"name\": \"CUSTOM\",\n \"status\": \"Active\",\n \"connection_response\": null,\n \"channel_updated_at\": \"2018-05-24 11:55:28\",\n \"status_code\": 1,\n \"settings\": {\n \"dimensions\": \"0x0x0\",\n \"weight\": 0,\n \"order_status\": \"\"\n },\n \"auth\": [],\n \"connection\": 1,\n \"orders_sync\": 0,\n \"inventory_sync\": 0,\n \"catalog_sync\": 0,\n \"orders_synced_on\": \"Not Available\",\n \"inventory_synced_on\": \"Not Available\",\n \"base_channel_code\": \"CS\",\n \"base_channel\": {\n \"id\": 4,\n \"name\": \"MANUAL\",\n \"code\": \"CS\",\n \"type\": \"Carts\",\n \"logo\": \"custom.png\",\n \"settings_sample\": {\n \"name\": \"Channels Settings\",\n \"help\": \"\",\n \"settings\": {\n \"brand_name\": {\n \"code\": \"brand_name\",\n \"name\": \"Brand Name\",\n \"placeholder\": \"Your brand name\",\n \"type\": \"text\"\n },\n \"brand_logo\": {\n \"code\": \"brand_logo\",\n \"name\": \"Brand Logo\",\n \"placeholder\": \"Your brand logo\",\n \"type\": \"file\"\n }\n }\n },\n \"auth_sample\": [],\n \"description\": \"Manual channel\"\n },\n \"catalog_synced_on\": \"31 Jul 12:49 PM\",\n \"order_status_mapper\": \"\",\n \"payment_status_mapper\": \"\",\n \"brand_name\": \"\",\n \"brand_logo\": \"\"\n }\n]\n \n}"},{"id":"8e39f40d-44bc-4bd4-b0ad-76960256a90a","name":"Wrong Endpoint Name","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/channel"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"b9b9bcbe-923c-4ccd-a46e-d9f089622a80"},{"name":"Create Custom Channel","id":"ddcffded-b6d2-491d-8d7e-8677d954cfaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{jwt_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MANUAL-25149\",\n \"brand_name\": \"SIORA-12\"\n}","options":{"raw":{"language":"json"}}},"url":"https://apiv2.shiprocket.in/v1/external/channels","description":"Creates a new manual (custom) channel in the seller's Shiprocket account.
\nPre-condition: This endpoint is gated. Your account must be allow-listed for \"Channel Creation by API\" by the Shiprocket Tech Support / KAM team before it will work.
\nUse this API to get details about all the integrated channels in your Shiprocket account, including channel id.\nThis channel id can be used to select or specify a custom channel at the time of order creation.
\n","_postman_id":"6233e207-6de3-4960-a59c-b34ebe3fe33d"},{"name":"Inventory","item":[{"name":"Get Inventory Details","id":"8ec158e6-971f-4c8e-a5ca-28ab08d03b92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/inventory","description":"This API can be used to check the inventory details of a product sku.\nThere are no required parameters for this API, but additional parameters can be used to sort and filter the data.
\nIn case no filter conditions are passed, the details are displayed in the default JSON format.
\nThis API is used to update your product inventory details.
\nFirst, you need to pass the product_id of the product in the endpoint URL.\nYou can then set the quantity and action you want to perform on the existing inventory of the specified product.
\nNote:
\nUse this API to update and get Inventory details.
\n","_postman_id":"a11e837a-176c-4889-905d-7c01c81d401c"},{"name":"Countries","item":[{"name":"Get Country Codes","id":"e2939f12-1ac7-41ef-b80d-bdf6d1497f9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/countries","description":"This API lists all the countries present in the Shiprocket database and the respective country ids, ISO 2 and ISO 3 codes.
\nThere are a total of 44 available countries in the database. You can use these codes to check the serviceability and use them in your dropdown menu.
\nNo parameters are required to access this API.
\n","urlObject":{"protocol":"https","path":["v1","external","countries"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"d18e06eb-c9d4-4255-95ad-b0816a864833","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/countries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Sun, 04 Aug 2019 15:31:49 GMT","enabled":true},{"key":"ETag","value":"W/\"ff49553bf8c2e4530806693f344b41706ea3c70f\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"177","enabled":true},{"key":"Content-Length","value":"5191","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Afghanistan\",\n \"iso_code_2\": \"AF\",\n \"iso_code_3\": \"AFG\",\n \"isd_code\": \"+93\",\n \"address_format\": \"\",\n \"postcode_required\": 1,\n \"status\": 1\n },\n {\n \"id\": 2,\n \"name\": \"Albania\",\n \"iso_code_2\": \"AL\",\n \"iso_code_3\": \"ALB\",\n \"isd_code\": \"+355\",\n \"address_format\": \"\",\n \"postcode_required\": 1,\n \"status\": 1\n },\n {\n \"id\": 3,\n \"name\": \"Algeria\",\n \"iso_code_2\": \"DZ\",\n \"iso_code_3\": \"DZA\",\n \"isd_code\": \"+213\",\n \"address_format\": \"\",\n \"postcode_required\": 1,\n \"status\": 1\n },\n {\n \"id\": 4,\n \"name\": \"American Samoa\",\n \"iso_code_2\": \"AS\",\n \"iso_code_3\": \"ASM\",\n \"isd_code\": \"+1\",\n \"address_format\": \"\",\n \"postcode_required\": 1,\n \"status\": 1\n },\n {\n \"id\": 5,\n \"name\": \"Andorra\",\n \"iso_code_2\": \"AD\",\n \"iso_code_3\": \"AND\",\n \"isd_code\": \"+376\",\n \"address_format\": \"\",\n \"postcode_required\": 1,\n \"status\": 1\n }\n \t.\n \t.\n \t.\n \t.\n ]\n}"},{"id":"3d9db8d0-b17d-415b-bc9a-8af99d0a1791","name":"Wrong Endpoint","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/countries"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"e2939f12-1ac7-41ef-b80d-bdf6d1497f9b"},{"name":"Get All Zones","id":"1f5157e4-68c3-4208-8982-a2ee1a8ee785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/countries/show/{country_id}","description":"Use this API to get a further list of all the available zones within a country, along with their ids and details.
\nThe country ID must be passed as a path parameter to access this API.\nNo other body parameters are required.
\nUse this API to get further locality details of any given postcode.\nJust pass the valid locality Pincode, and the details will be displayed in JSON format.
\nThe following APIs provide details about the various country codes and their respective zone details along with the locality details.
\n","_postman_id":"6140ae65-d995-4a56-b6c2-e89c2b7db5e2"},{"name":"Statement Details ","item":[{"name":"Get Statement Details","id":"d910662e-1adb-4536-8a98-b68bc5300278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://apiv2.shiprocket.in/v1/external/account/details/statement","description":"Use this API to get the account statement details of your Shiprocket account.\nNo parameters are required to access this API. However, you sort and filter the data displayed using the optional parameters.
\nGet your Shiprocket account's statement details using this API.
\n","_postman_id":"02df57a4-9dca-4eac-96de-ee2226c93397"},{"name":"Discrepancy Details","item":[{"name":"Get Dicrepancy Data","id":"d8e38c75-b492-410c-94e2-486a3dbea782","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://apiv2.shiprocket.in/v1/external/billing/discrepancy","description":"Get the discrepancy data associated with your account, if any.\nNo parameters are required to use this API.
\nThe data is displayed in JSON format.
\n","urlObject":{"protocol":"https","path":["v1","external","billing","discrepancy"],"host":["apiv2","shiprocket","in"],"query":[],"variable":[]}},"response":[{"id":"18d054dc-2983-4b1f-b50f-b9e0f0967ec3","name":"Successful Call","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/billing/discrepancy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private, must-revalidate","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Sun, 04 Aug 2019 14:03:30 GMT","enabled":true},{"key":"ETag","value":"W/\"ebed61c17ed337283f877e6a95f42d64e474b2a6\"","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-RateLimit-Limit","value":"180","enabled":true},{"key":"X-RateLimit-Remaining","value":"179","enabled":true},{"key":"Content-Length","value":"249","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [],\n \"upper_fold_text\": \"The entered weight for the below given shipment was incorrect. Please allow us to make deduction on the basis of correct charged weight as shared by the courier company.\",\n \"lower_fild_text\": \"To raise a ticket for your queries, please call us on 011-39595108 or email us at support@shiprocket.in\"\n}"},{"id":"40c136b1-814e-4c61-a1e6-a3c08a9b8240","name":"Wrong Endpoint","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{url}}/v1/external/billing/discrepanc"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Date","value":"Sun, 04 Aug 2019 14:03:51 GMT","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Content-Length","value":"62","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"404 Not Found\",\n \"status_code\": 404\n}"}],"_postman_id":"d8e38c75-b492-410c-94e2-486a3dbea782"}],"id":"93fb0bb7-24b5-497c-a396-42b006f89742","description":"Use this API to get the discrepancy details of your account.
\n","_postman_id":"93fb0bb7-24b5-497c-a396-42b006f89742"},{"name":"File Imports","item":[{"name":"Get File import Results","id":"05b36ce9-ffe6-47ed-b9d8-fe69782e8fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://apiv2.shiprocket.in/v1/external/errors/{import_id}/check","description":"Check the import response of various file imports for any error, including bulk order imports, products and product listings.
\nYou will have to pass the file import id as a path parameter in the endpoint URL. This id is provided at the time of importing the file.\nNo other body parameters are required.
\nCheck the status response of files that have been imported using the API.
\n","_postman_id":"3849acf4-8155-44e5-bcbf-414fec7d3fa4"}],"event":[{"listen":"prerequest","script":{"id":"38d9a7e1-5692-4128-a0ba-3dc6402c692e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"97b3d373-aedf-4be2-8567-4b6db1396223","type":"text/javascript","exec":[""]}}]}![https://abc/xyz.jpg](\"https://abc/xyz.jpg\"){kind=link}