{"info":{"_postman_id":"fed26126-48a7-44c3-80db-6c6cd01b5e5a","name":"Sharkship API Documentation","description":"

Welcome to Sharkship's API Documentation. We've crafted this document to assist developers and Sharkship users in comprehending and seamlessly integrating our API for efficient implementation. Our APIs enable users to fully utilize the extensive features available in your Sharkship account.

We've provided a comprehensive list of APIs, their requisite parameters, along with example requests and responses for clear comprehension.

Sharkship APIs adhere to the REST architecture and utilize standard HTTP request methods. They accept JSON-encoded body requests and return data in the same format.

Navigate through the following sections to smoothly proceed with the integration process.

Getting Started

To begin, please register or login on Sharkship via the provided link: https://www.sharkship.in/.
\n
Next, navigate to the \"Integrations\" portal, locate \"Sharkship Retail API\" and find the means to contact Sharkship's team to get started with our Retail API Services.
\n
Upon contacting, Sharkship's team will verify your account and subsequently provide your API key and API secret via email.
\n
Utilize the provided API key and API secret to generate an access token, enabling access to our APIs.
\n

API Usage Guidelines

Sharkship's APIs support the fundamental HTTP methods: POST, GET, PATCH, PUT and DELETE.
\n
To specify the desired language for request and response codes, simply select it from the dropdown menu provided.
\n
You can seamlessly import and evaluate our entire API collection within the Postman application by clicking on the 'Run in Postman' button.
\n
Kindly note that any requests executed with valid API credentials will directly impact the real-time data within your Sharkship account.
\n
Authorization: Bearer
\n
Each API is accompanied by example requests and responses, illustrating both successful and unsuccessful scenarios.
\n

Errors and Response Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

RESPONSE CODES	DESCRIPTION
200 & 201 - Ok & Accepted	API worked as expected, and the client will get a response.
400 - Bad Request	Indicates that the client's request to the API contains invalid syntax or parameters.
401 - Unauthorized	The client lacks valid authentication credentials for accessing the requested resource.
404 - Not Found	The requested resource could not be found on the server.
429 - Too Many Requests	The client has sent too many requests to the server within a given timeframe.
500 - Internal Server Error	An unexpected condition occurred on the server, preventing it from fulfilling the request.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"API Usage Guidelines","slug":"api-usage-guidelines"},{"content":"Errors and Response Codes","slug":"errors-and-response-codes"}],"owner":"50875083","collectionId":"fed26126-48a7-44c3-80db-6c6cd01b5e5a","publishedId":"2sB3dVMn11","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-17T09:57:50.000Z"},"item":[{"name":"Authentication API","item":[{"name":"Generate API Token","id":"46acc475-279c-4cee-ade8-9924a6490082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"api_secret\": \"string\",\r\n \"api_key\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/auth/api/login","description":"

This endpoint generates an API token for authentication. Provide your API secret and key in the request body to obtain access token and refresh token.

\n","urlObject":{"protocol":"https","path":["v1","auth","api","login"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"838a1321-e745-436f-bda5-c5805e4189a7","name":"Generate API Token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"api_secret\": \"APOORV\",\r\n \"api_key\": \"d5510227-90a5-4ed1-acee-8a581cd13094\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/auth/api/login"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:16:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"960"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"3c0-6b0k67fcC5gCOxgddbbaYrXhaQs\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"api_access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8\",\n \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsInJlZnJlc2hfdG9rZW5faWQiOjE3NjMyLCJpYXQiOjE3MTQxNDgxNzEsImV4cCI6MTcxNDE1NTM3MSwiYXVkIjoiYXBpIiwiaXNzIjoiQmhlam9vbyIsInN1YiI6ImN1c3RvbWVyLXJlZnJlc2gtdG9rZW4ifQ.8-TXEH_Zq6rOdYSgsZjMNCCP-1ChXybLT-paTfPb9Tk\",\n \"expires_in\": \"1h\",\n \"refresh_expires_in\": \"2h\"\n}"}],"_postman_id":"46acc475-279c-4cee-ade8-9924a6490082"}],"id":"60a29dcb-8c7a-4411-95be-baa84231d299","description":"

Authentication is required to access the endpoints of the Sharkship API securely. The authentication token can be used from any system to validate API calls and access Sharkship's resources.

When making API calls to Sharkship, you must include a token in the request headers to authenticate your identity.

\n","_postman_id":"60a29dcb-8c7a-4411-95be-baa84231d299"},{"name":"Create Orders","item":[{"name":"Create Order","id":"0f7abdc8-dce3-447d-8ea8-831ce9b39c5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customer\": {\r\n \"name\": \"string\",\r\n \"mobile_no\": \"string\",\r\n \"email\": \"string\",\r\n \"address\": {\r\n \"address_lane1\": \"string\",\r\n \"address_lane2\": \"string\",\r\n \"landmark\": \"string\",\r\n \"Pin\": 0,\r\n \"city\": \"string\",\r\n \"state\": \"string\",\r\n \"name\": \"string\",\r\n \"phoneNo\": \"string\"\r\n }\r\n },\r\n \"order\": {\r\n \"product_name\": \"string\",\r\n \"product_price\": 0,\r\n \"product_quantity\": 0,\r\n \"product_category\": \"string\",\r\n \"product_sku_no\": \"string\",\r\n \"payment_mode\": \"COD\",\r\n \"client_orderId\": \"string\",\r\n \"shopify_order_id\": \"string\",\r\n \"shopify_store\": \"string\",\r\n \"integration\": {}\r\n },\r\n \"shipment_details\": {\r\n \"weight\": 0,\r\n \"volumetric_weight\": {\r\n \"length\": 0,\r\n \"width\": 0,\r\n \"height\": 0\r\n },\r\n \"carrier\": {\r\n \"carrier\": \"string\",\r\n \"courier_type\": \"string\"\r\n },\r\n \"pickup_date\": \"2024-02-26T09:16:32.310Z\"\r\n },\r\n \"pickup_details\": {\r\n \"address_id\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/order/create","description":"

This endpoint facilitates the creation of a new order. The request should include a JSON payload specifying order details.

\n","urlObject":{"protocol":"https","path":["v1","b2c","order","create"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"0f99661b-884f-45b0-83fa-7ef2da5365e8","name":"Create Order","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customer\": {\r\n \"name\": \"Apoorv\",\r\n \"mobile_no\": \"8178XXXXXX\",\r\n \"email\": \"apoorv@gmail.com\",\r\n \"address\": {\r\n \"address_lane1\": \"ABCD21\",\r\n \"address_lane2\": \"SHARK\",\r\n \"landmark\": \"NEAR SHARKSHIP\",\r\n \"Pin\": 110092,\r\n \"city\": \"DELHI\",\r\n \"state\": \"DELHI\",\r\n \"name\": \"Apoorv\",\r\n \"phoneNo\": \"8765423456\"\r\n }\r\n },\r\n \"order\": {\r\n \"product_name\": \"Jeans\",\r\n \"product_price\": 2000,\r\n \"product_quantity\": 1,\r\n \"product_category\": \"Clothing\",\r\n \"product_sku_no\": \"ACD123\",\r\n \"payment_mode\": \"Prepaid\",\r\n \"client_orderId\": \"string\",\r\n \"shopify_order_id\": \"string\",\r\n \"shopify_store\": \"string\",\r\n \"integration\": {}\r\n },\r\n \"shipment_details\": {\r\n \"weight\": 1.5,\r\n \"volumetric_weight\": {\r\n \"length\": 12,\r\n \"width\": 12,\r\n \"height\": 32\r\n },\r\n \"carrier\": {\r\n \"carrier\": \"BlueDart\",\r\n \"courier_type\": \"SURFACE\"\r\n },\r\n \"pickup_date\": \"2024-02-21T09:16:32.310Z\"\r\n },\r\n \"pickup_details\": {\r\n \"address_id\": \"1147\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/order/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:24:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2b-PiYzhe4tmCHb5DGDT40Vr5f7xc4\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"order_id\": 7226574,\n \"awb_no\": \"77047855511\"\n}"}],"_postman_id":"0f7abdc8-dce3-447d-8ea8-831ce9b39c5d"}],"id":"89aee887-4295-4c10-b4c3-73d70c7db1d0","description":"

These APIs allow you to create new orders in your Sharkship account, as well as get order details from Sharkship's system.

\n","_postman_id":"89aee887-4295-4c10-b4c3-73d70c7db1d0"},{"name":"Cancel Orders","item":[{"name":"Cancel Order","id":"672fcb4d-1faf-4c07-b8e1-d97539823065","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"move_to","value":"CANCELLED","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n \"string\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/order","description":"

This endpoint allows you to cancel an order. The request should include a JSON payload in the raw request body type with an array of order IDs of orders which are to be cancelled.

Request Body

order_ids (array of strings): The IDs of the orders to be cancelled.

Response

The response will include a message indicating the status of the request.

Example

{\"message\":\"\"}\n\n

\n","urlObject":{"protocol":"https","path":["v1","b2c","order"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"00df5252-7b8e-47f5-86b1-2e9e5f076237","name":"Cancel Order","originalRequest":{"method":"PUT","header":[{"key":"move_to","value":"CANCELLED","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n \"7226574\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:50:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"17-UTZmyGtLz1PuVtyGGQQ79s+ynTk\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"CANCELLED\"\n}"}],"_postman_id":"672fcb4d-1faf-4c07-b8e1-d97539823065"}],"id":"dbebfdc0-27ac-47f7-8cf8-6251d1aadb28","description":"

These APIs allow you to cancel an existing order and cancel multiple orders in your Sharkship account.

\n","_postman_id":"dbebfdc0-27ac-47f7-8cf8-6251d1aadb28"},{"name":"Shipping Label","item":[{"name":"Download Shipping Label","id":"fc83e8c6-4ea3-4540-8d26-29b1777212c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n \"string\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/document/shipping_label","description":"

This API allows you to download shipping labels for specific orders. To do so, provide the order IDs for which you need labels in the request body as a JSON payload. Please note that only orders that are in a processed state can be included; shipping labels for CANCELLED and TO_BE_PROCESSED orders cannot be downloaded.

\n","urlObject":{"protocol":"https","path":["v1","b2c","document","shipping_label"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"dede7adf-4342-4807-ac06-c2cf88f32938","name":"Download Shipping Label","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI3NHBhMjJzeCIsImtleSI6IjQ0ZDFiMWZmLTdmNjMtNGEyNC04ZmI0LWQ0ZDYyNzViZDcwZCIsInNlY3JldCI6IkFOVVNIS0FfQ09NUEFOWSIsImNhdCI6IlNJTFZFUiIsImlzQWRtaW4iOmZhbHNlLCJzZXNzaW9uX2lkIjoiNzQzMDc5YzgtZmNhYi00OGQ3LWEzMTEtMmM0YjI4ODVjYjI1IiwiaWF0IjoxNzEyOTI1NTkzLCJleHAiOjE3MTI5MjkxOTMsImF1ZCI6ImN1c3RvbWVyIiwiaXNzIjoiQmhlam9vbyIsInN1YiI6Ijc0cGEyMnN4In0.a6mdvHyyeXm0GhfphGiniULOJjp5OPbrQ3op7_LcFwc","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n \"1746129\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/document/shipping_label"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"116"},{"key":"ETag","value":"W/\"74-rK1OaFv+NkeHYWbwL09sQzTNOWY\""},{"key":"Date","value":"Fri, 12 Apr 2024 12:51:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 500,\n \"message\": \"Order status must not be CANCELLED or TO_BE_PROCESSED\",\n \"error\": \"Internal Server Error\"\n}"}],"_postman_id":"fc83e8c6-4ea3-4540-8d26-29b1777212c3"},{"name":"Shipping Label Configurations","id":"d5605a70-5957-40a7-b771-4640147a0885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/document/shipping_label_configuration","description":"

This API endpoint retrieves the configurations related to shipping labels.

\n","urlObject":{"protocol":"https","path":["v1","b2c","document","shipping_label_configuration"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"bdad0cd5-6f75-46a5-82ac-847f12157abe","name":"Shipping Label Configurations","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/document/shipping_label_configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:46:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"151"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"97-hcC9UJJpX8CP0zfAdzAT/Wj+vPg\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"rto_visibility\": 1,\n \"sharkship_visibility\": 0,\n \"logo_visibility\": 0,\n \"gst_visibility\": 0,\n \"client_visibility\": 0,\n \"sku_visibility\": 0,\n \"alter_name\": 0,\n \"newName\": \"\"\n}"}],"_postman_id":"d5605a70-5957-40a7-b771-4640147a0885"},{"name":"Update Shipping Label Configurations","id":"a2ebc3a9-7dad-4ca8-b655-33f62f7284f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"rtoAddressVisible\": 0,\r\n \"sharkshipVisible\": 0,\r\n \"clientIdVisible\": 0,\r\n \"sellerLogoVisible\": 0,\r\n \"gstVisible\": 0,\r\n \"skuVisible\": 0,\r\n \"alterName\": 0,\r\n \"newName\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/document/shipping_label_configuration","description":"

This API endpoint allows you to update shipping label configurations.

\n","urlObject":{"protocol":"https","path":["v1","b2c","document","shipping_label_configuration"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"22e2a549-5944-4b25-92f3-d8c131797a39","name":"Update Shipping Label Configurations","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"rtoAddressVisible\": 1,\r\n \"sharkshipVisible\": 1,\r\n \"clientIdVisible\": 0,\r\n \"sellerLogoVisible\": 1,\r\n \"gstVisible\": 0,\r\n \"skuVisible\": 0,\r\n \"alterName\": 0,\r\n \"newName\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/document/shipping_label_configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:47:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"15-JmbICdPM4IvRvh+NOYgFm7Ve/xE\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"UPDATED\"\n}"}],"_postman_id":"a2ebc3a9-7dad-4ca8-b655-33f62f7284f4"}],"id":"8ab82109-045f-4e6f-abdd-800f7374ef69","description":"

The shipping label API lets users to retrieve single shipping or multiple shipping labels associated with their order(s) from Sharkship's system.

Users can obtain printable shipping labels that consists of essential shipment details, including sender and recipient information, tracking numbers, barcode representations etc.

\n","_postman_id":"8ab82109-045f-4e6f-abdd-800f7374ef69"},{"name":"Shipment Tracking","item":[{"name":"Tracking","id":"29ecd981-5a36-4a46-be29-317888cea6c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/order/fetch/awb?tracking_id=string","description":"

This API allows users to retrieve real-time updates on the movement of their shipments, including expected delivery dates, current locations, and any relevant status updates such as out for delivery or delivered.

\n","urlObject":{"protocol":"https","path":["v1","b2c","order","fetch","awb"],"host":["api","sharkship","in"],"query":[{"key":"tracking_id","value":"string"}],"variable":[]}},"response":[{"id":"cbcdd5b6-0c69-40a2-813b-9a46bceba796","name":"Tracking","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"url":{"raw":"https://api.sharkship.in/v1/b2c/order/fetch/awb?tracking_id=77047855511","protocol":"https","host":["api","sharkship","in"],"path":["v1","b2c","order","fetch","awb"],"query":[{"key":"tracking_id","value":"77047855511"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:30:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"424"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"1a8-96J9bhXf+UJ9RZhXJhVdD4EyfH8\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"tracking_id\": \"77047855511\",\n \"sharkship_order_id\": 7226574,\n \"sharkship_status\": \"PROCESSED\",\n \"courier_status\": \"Manifested\",\n \"last_event_at\": \"2024-04-26T22:00:06.000Z\",\n \"raw_status\": \"Manifested\",\n \"latest_event\": \"Manifested\",\n \"tracking_info\": [\n {\n \"location\": null,\n \"data_time\": \"26-04-2024 22:00:06\",\n \"status_code\": 4,\n \"remark\": \"Manifested\"\n },\n {\n \"location\": null,\n \"data_time\": \"26-04-2024 21:54:30\",\n \"status_code\": 3,\n \"remark\": \"Shipping Label Generated\"\n }\n ]\n}"}],"_postman_id":"29ecd981-5a36-4a46-be29-317888cea6c9"}],"id":"5837f0d3-cadc-4b86-b4dd-d8a2fab11520","description":"

The Shipment Tracking API provides functionality to track the status and location of shipments within Sharkship's system.

\n","_postman_id":"5837f0d3-cadc-4b86-b4dd-d8a2fab11520"},{"name":"Couriers","item":[{"name":"Courier Partners","id":"d0c73b07-4189-48fb-8080-9de01aabcecc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/courier/courierPartner","description":"

This API allows you to retreive a list of all available courier services in your Sharkship account.

\n","urlObject":{"protocol":"https","path":["v1","b2c","courier","courierPartner"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"677fb16d-05aa-490c-98a7-2902d6f74ea9","name":"Courier Partners","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/courier/courierPartner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:27:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"788"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"314-G5EzuMeNnrsuMT46S8+JasxCLfM\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"carrier\": \"Delhivery_Preferred\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"Delhivery\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"BlueDart\",\n \"carrier_type\": \"EXPRESS\"\n },\n {\n \"carrier\": \"Shadowfax\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"Sharkship\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"Ekart\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"Ecom\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"Sharkship_Preferred\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"Shree_Maruti\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"Amazon_ATS\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"ExpressBees\",\n \"carrier_type\": \"EXPRESS\"\n },\n {\n \"carrier\": \"Dtdc\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"Dtdc\",\n \"carrier_type\": \"EXPRESS\"\n },\n {\n \"carrier\": \"Delhivery\",\n \"carrier_type\": \"EXPRESS\"\n },\n {\n \"carrier\": \"ExpressBees\",\n \"carrier_type\": \"SURFACE\"\n },\n {\n \"carrier\": \"BlueDart\",\n \"carrier_type\": \"SURFACE\"\n }\n]"}],"_postman_id":"d0c73b07-4189-48fb-8080-9de01aabcecc"}],"id":"dcb41cfd-1773-4263-8f14-eb72da160d05","description":"

This API provides information about courier partners that are available. By making a GET request to the specified endpoint, you can access details regarding various courier service providers.

\n","_postman_id":"dcb41cfd-1773-4263-8f14-eb72da160d05"},{"name":"NDR","item":[{"name":"Reattempt NDR","id":"f5977496-dcdc-4671-b354-7137ad97816e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"move_to","value":"RE_ATTEMPTED","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n \"string\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/order","description":"

This endpoint facilitates the reattempt of Non-Delivery Report (NDR) for orders. Include the order IDs for which you want to trigger the reattempt in the request body. Additionally, set the header \"move_to\" to \"RE_ATTEMPTED\" to specify the action to be taken.

\n","urlObject":{"protocol":"https","path":["v1","b2c","order"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"6c6917cf-07e9-42c7-8a1d-2bf305c30f0c","name":"Reattempt NDR","originalRequest":{"method":"PUT","header":[{"key":"move_to","value":"RE_ATTEMPTED","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n \"7226574\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/order"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:34:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"131"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"83-jl7k/IF2Z/OZFakswIW8Ha3D3EE\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"errorCode\": \"ORD-0014\",\n \"message\": \"No processing records found for the provided order, shipped/delivered orders cannot be updated\"\n}"}],"_postman_id":"f5977496-dcdc-4671-b354-7137ad97816e"}],"id":"232ffe31-4efa-4788-9663-725fe8638277","description":"

This API provides access to details about shipments in NDR status within your Sharkship account. You can fetch NDR shipments from your account, either all or specific ones based on AWB number.

\n","_postman_id":"232ffe31-4efa-4788-9663-725fe8638277"},{"name":"Pickup Addresses","item":[{"name":"Pickup Hub ids","id":"b102a6a4-5a17-4660-adcf-4f922fe051a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/address/pickupAddress","description":"

This endpoint allows you to fetch the IDs of pickup hubs associated with your Sharkship account. By making a GET request to this URL, you can obtain a list of pickup locations available for selection.

\n","urlObject":{"protocol":"https","path":["v1","b2c","address","pickupAddress"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"612eae16-3eaa-465e-9fa1-b8db8fa4dd12","name":"Pickup Hub ids","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/address/pickupAddress"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:36:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"180"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"b4-D4EzN9DICvbVO9QTuHZJlJL7e00\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"pickup_hub_id\": 1147,\n \"hub_address\": \"A-123 Nirman Vihar\",\n \"hub_landmark\": \"Near V3S Mall\",\n \"hub_pin\": 110092,\n \"hub_city\": \"Delhi\",\n \"hub_state\": \"Delhi\",\n \"hub_contact_number\": \"8178629242\"\n }\n]"}],"_postman_id":"b102a6a4-5a17-4660-adcf-4f922fe051a6"},{"name":"Create Pickup Hub Id","id":"61dbde54-f4a4-4d25-a5f7-a54a0261ace0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"address_lane1\": \"string\",\r\n \"address_lane2\": \"string\",\r\n \"landmark\": \"string\",\r\n \"Pin\": 0,\r\n \"city\": \"string\",\r\n \"state\": \"string\",\r\n \"name\": \"string\",\r\n \"phoneNo\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/address/pickupAddress","description":"

This endpoint enables the creation of a new pickup hub ID. Provide the necessary details including address, landmark, PIN code, city, state, and a name for the pickup hub in the request body as a JSON payload.

\n","urlObject":{"protocol":"https","path":["v1","b2c","address","pickupAddress"],"host":["api","sharkship","in"],"query":[],"variable":[]}},"response":[{"id":"1b12f505-cd3c-419d-8c1c-e3a3e3a523cd","name":"Create Pickup Hub Id","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI5M2FuMzNoaCIsImtleSI6ImQ1NTEwMjI3LTkwYTUtNGVkMS1hY2VlLThhNTgxY2QxMzA5NCIsInNlY3JldCI6IkFOVVNIS0EiLCJjYXQiOiJTSUxWRVIiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjM3NzY3ZTcxLTY3YjItNGFmMi1hZDdhLTA5MjY3MWNiNTAwMyIsImlhdCI6MTcxNDE0ODE3MSwiZXhwIjoxNzE0MTUxNzcxLCJhdWQiOiJhcGkiLCJpc3MiOiJCaGVqb29vIiwic3ViIjoiOTNhbjMzaGgifQ.BhQxChEUXX0FsAa_KZU5jM90wdI8e30LK9bdeB4vki8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"address_lane1\": \"H-34\",\r\n \"address_lane2\": \"Sharkship\",\r\n \"landmark\": \"Near Sharkship\",\r\n \"Pin\": 110001,\r\n \"city\": \"Delhi\",\r\n \"state\": \"Delhi\",\r\n \"name\": \"Apoorv\",\r\n \"phoneNo\": \"9876543219\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sharkship.in/v1/b2c/address/pickupAddress"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:39:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"171"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"ab-TvfPMJgvhueX+KQhKRXdwDPCnjg\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"pickup_hub_id\": 1182,\n \"hub_address\": \"H-34 Sharkship\",\n \"hub_landmark\": \"Near Sharkship\",\n \"hub_pin\": 110001,\n \"hub_city\": \"Delhi\",\n \"hub_state\": \"Delhi\",\n \"hub_contact_number\": \"9876543219\"\n}"}],"_postman_id":"61dbde54-f4a4-4d25-a5f7-a54a0261ace0"},{"name":"Pickup Hub Id","id":"7575c0c4-2dc4-456a-a07a-aaa725c33270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/address/pickupAddress/:id","description":"

This endpoint allows you to delete a specific pickup hub identified by its unique ID. Replace :id in the URL with the actual ID of the pickup hub you want to delete. This action removes the pickup hub from your Sharkship account.

\n","urlObject":{"protocol":"https","path":["v1","b2c","address","pickupAddress",":id"],"host":["api","sharkship","in"],"query":[{"disabled":true,"key":"","value":""}],"variable":[{"id":"747127c2-5bba-438f-928b-3772a3812a02","description":{"content":"

Number

\n","type":"text/plain"},"type":"any","value":"1182","key":"id"}]}},"response":[{"id":"6eaf0835-be95-4b55-87b8-d8a53ac3d73c","name":"Pickup Hub Id","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"https://api.sharkship.in/v1/b2c/address/pickupAddress/:id","protocol":"https","host":["api","sharkship","in"],"path":["v1","b2c","address","pickupAddress",":id"],"query":[{"key":"","value":"","disabled":true}],"variable":[{"key":"id","value":"","description":"Number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Apr 2024 16:42:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"55"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"37-PgCVwXHnmkYYTwoiScjPxI4xOhU\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Pickup hub with 1182 successfully deleted\"\n}"}],"_postman_id":"7575c0c4-2dc4-456a-a07a-aaa725c33270"}],"id":"21864e37-c590-4a71-9bfc-32b855eb2283","description":"

Utilize these APIs to retrieve a list of all available pickup locations in your Sharkship account or add a new pickup location.

\n","_postman_id":"21864e37-c590-4a71-9bfc-32b855eb2283"},{"name":"Shipping Rates","item":[{"name":"Get Shipping Rate (Retail)","id":"1bac8d3c-4fbb-4db2-9c66-cc530f4a3231","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"length","value":"10","description":"

Package length in cm

\n","type":"text"},{"key":"width","value":"10","description":"

Package width in cm

\n","type":"text"},{"key":"height","value":"10","description":"

Package height in cm

\n","type":"text"},{"key":"service_type","value":"PAN_INDIA","description":"

Service type: PAN_INDIA, SDD, NDD

\n","type":"text"}],"url":"https://api.sharkship.in/v1/b2c/order/shipping-rate-retail?source=201307&destination=452001&payment_type=COD&weight=0.5&productValue=1000","description":"

This endpoint retrieves retail shipping rates for a shipment based on source and destination pincodes, payment type, weight, and product value. Dimensions (length, width, height) are passed as request headers.

Query Parameters

source (number): Source pincode
destination (number): Destination pincode
payment_type (string): COD or PREPAID
weight (number): Package weight in kg
productValue (number): Declared product value

Headers

length (number): Package length in cm
width (number): Package width in cm
height (number): Package height in cm
service_type (string): PAN_INDIA, SDD, or NDD

Response

Returns a rates array containing available carrier rates with pricing breakdown, zone info, COD charges, and weight calculation details.

\n","urlObject":{"protocol":"https","path":["v1","b2c","order","shipping-rate-retail"],"host":["api","sharkship","in"],"query":[{"description":{"content":"

Source pincode

\n","type":"text/plain"},"key":"source","value":"201307"},{"description":{"content":"

Destination pincode

\n","type":"text/plain"},"key":"destination","value":"452001"},{"description":{"content":"

Payment type: COD or PREPAID

\n","type":"text/plain"},"key":"payment_type","value":"COD"},{"description":{"content":"

Weight of the package in kg

\n","type":"text/plain"},"key":"weight","value":"0.5"},{"description":{"content":"

Declared value of the product

\n","type":"text/plain"},"key":"productValue","value":"1000"}],"variable":[]}},"response":[{"id":"e7018c64-5328-46c5-915c-268fdb8221bb","name":"Get Shipping Rate (Retail)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0NnNyNTVxZyIsImtleSI6IjY2Y2UyMTIxLWEzYjEtNDMwNC1iNGI3LTViNmIyYzI2M2FiYyIsInNlY3JldCI6Imdpd2stNWdqdy1ibTQ5LWNuc28iLCJjYXQiOiJNQVgiLCJpc0FkbWluIjpmYWxzZSwic2Vzc2lvbl9pZCI6IjI4OTNkOTg1LTAxZjctNDVjNS04NDBiLWQ1OTU1MGY1ZjNhOSIsImlhdCI6MTc3MjQzMDU5OCwiZXhwIjoxNzcyNDM0MTk4LCJhdWQiOiJhcGkiLCJpc3MiOiJTaGFya3NoaXAiLCJzdWIiOiI0NnNyNTVxZyJ9.z0kqt8V07Jo2Jg7j5OUagT65WIXE1M7F5h3hX8wCGP4","type":"text"},{"key":"length","value":"10","type":"text"},{"key":"width","value":"10","type":"text"},{"key":"height","value":"10","type":"text"},{"key":"service_type","value":"PAN_INDIA","type":"text"}],"url":{"raw":"https://api.sharkship.in/v1/b2c/order/shipping-rate-retail?source=201307&destination=452001&payment_type=COD&weight=0.5&productValue=1000","protocol":"https","host":["api","sharkship","in"],"path":["v1","b2c","order","shipping-rate-retail"],"query":[{"key":"source","value":"201307"},{"key":"destination","value":"452001"},{"key":"payment_type","value":"COD"},{"key":"weight","value":"0.5"},{"key":"productValue","value":"1000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"rates\": [\n {\n \"id\": \"8c8a91ab-3fae-4c40-b03b-2aa03ff6fa85\",\n \"carrier\": \"Amazon_ATS\",\n \"carrierId\": 1,\n \"courier_type\": \"SURFACE\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 89,\n \"cod\": 34,\n \"base_weight_rate\": 41,\n \"additional_weight_rate\": 24,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 41\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"f10661f3-ebd9-4e0e-8a23-e705f0c082b0\",\n \"carrier\": \"Amazon_ATS\",\n \"carrierId\": 1,\n \"courier_type\": \"SURFACE\",\n \"base_weight\": 2,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 1,\n \"rate\": 174,\n \"cod\": 34,\n \"base_weight_rate\": 113,\n \"additional_weight_rate\": 49,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 2kg). Base rate applied: 113\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"3fdcfd58-1b59-4821-93af-fdcb125579c1\",\n \"carrier\": \"BlueDart\",\n \"carrierId\": 8,\n \"courier_type\": \"EXPRESS\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 126,\n \"cod\": 36,\n \"base_weight_rate\": 70,\n \"additional_weight_rate\": 70,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 70\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"a56dc460-1663-437e-9fc0-af6750154b61\",\n \"carrier\": \"BlueDart\",\n \"carrierId\": 8,\n \"courier_type\": \"SURFACE\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 104,\n \"cod\": 36,\n \"base_weight_rate\": 52,\n \"additional_weight_rate\": 52,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 52\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"c47d091f-cd0c-49ca-bc7b-539b42ea483e\",\n \"carrier\": \"Delhivery\",\n \"carrierId\": 7,\n \"courier_type\": \"EXPRESS\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 114,\n \"cod\": 34,\n \"base_weight_rate\": 62,\n \"additional_weight_rate\": 60,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 62\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"71c2e8f4-eef2-44c3-8ba9-c66bc09b4dee\",\n \"carrier\": \"Delhivery\",\n \"carrierId\": 7,\n \"courier_type\": \"SURFACE\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 95,\n \"cod\": 34,\n \"base_weight_rate\": 46,\n \"additional_weight_rate\": 42,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 46\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"4d9dceb9-872e-45eb-b475-a5ede463b975\",\n \"carrier\": \"Ekart\",\n \"carrierId\": 6,\n \"courier_type\": \"EXPRESS\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 117,\n \"cod\": 35,\n \"base_weight_rate\": 64,\n \"additional_weight_rate\": 47,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 64\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"70c24b68-ae7f-47cb-a8de-b7d7864f951c\",\n \"carrier\": \"Ekart\",\n \"carrierId\": 6,\n \"courier_type\": \"SURFACE\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 91,\n \"cod\": 35,\n \"base_weight_rate\": 42,\n \"additional_weight_rate\": 33,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 42\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"1b585c27-3e4a-4da2-9bc1-70ca38fbff22\",\n \"carrier\": \"Shadowfax\",\n \"carrierId\": 2,\n \"courier_type\": \"SURFACE\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 88,\n \"cod\": 34,\n \"base_weight_rate\": 40,\n \"additional_weight_rate\": 36,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 40\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"86a75566-d1c3-4c9a-bede-ec3c0012b48e\",\n \"carrier\": \"Shree_Maruti\",\n \"carrierId\": 4,\n \"courier_type\": \"EXPRESS\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 140,\n \"cod\": 35,\n \"base_weight_rate\": 83,\n \"additional_weight_rate\": 83,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 83\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"d278ea39-305e-42ce-997f-d1eb586e66a6\",\n \"carrier\": \"Shree_Maruti\",\n \"carrierId\": 4,\n \"courier_type\": \"SURFACE\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 104,\n \"cod\": 35,\n \"base_weight_rate\": 53,\n \"additional_weight_rate\": 53,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 53\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n },\n {\n \"id\": \"62b17174-fa76-4f42-b092-5450d8598bb7\",\n \"carrier\": \"XpressBees\",\n \"carrierId\": 3,\n \"courier_type\": \"SURFACE\",\n \"base_weight\": 0.5,\n \"service_type\": \"PAN_INDIA\",\n \"additional_weight\": 0.5,\n \"rate\": 93,\n \"cod\": 34,\n \"base_weight_rate\": 44,\n \"additional_weight_rate\": 36,\n \"weight_calculation\": \"Weight is within base weight (0.5kg <= 0.5kg). Base rate applied: 44\",\n \"source\": 201307,\n \"destination\": 452001,\n \"zone\": \"zone4\"\n }\n ]\n}"}],"_postman_id":"1bac8d3c-4fbb-4db2-9c66-cc530f4a3231"}],"id":"07b1b09d-eff0-4ff9-8499-35d54bab0279","description":"

These APIs allow you to calculate shipping rates for retail shipments based on source/destination pincodes, weight, dimensions, payment type, and service type.

\n","_postman_id":"07b1b09d-eff0-4ff9-8499-35d54bab0279"}]}