Masterarbeit

Search

SearchSearch

Shiprocket API

Jun 20, 202443 min read

Search Link: https://www.google.com/search?channel=fs&client=ubuntu-sn&q=postman+collection+8407119-f5af337c-69fc-49c7-8418-e2f6ee461674

Overview

POST /v1/external/auth/login

Summary: Generate Token

Generate Token

POST /v1/external/orders/create/adhoc

Summary: Create Custom Order

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.

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.

Note:

  • In case the ‘shipping_is_billing’ field is false, further shipping detail fields are required.

If 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.

  • order_id field cannot be equal to an already existing id. Doing so does not change or affect the existing order.
  • New 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.
  • Be sure to input the correct calculated sub_total amount. The total is not calculated automatically through the API.
  • The ‘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.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESstringThe order id you want to specify to the order. Max char: 50. (Avoid passing character values as this contradicts some other API calls).224477 or 224-477
order_dateYESstringThe date of order creation in yyyy-mm-dd format. Time is additional.2019-07-24 11:11
pickup_locationYESstringThe name of the pickup location added in your Shiprocket account. This cannot be a new location.Jammu
channel_idNOintegerMention this in case you need to assign the order to a particular channel. Deafult is ‘Custom’.27022
commentNOstringOption to add ‘From’ field to the shipment. To do this, enter the name in the following format: ‘Reseller: [name]‘.Reseller: Divine
reseller_nameNOstringThe ‘from’ name if you want to print. Use ‘Reseller: [name]‘Reseller: Divine
company_nameNOstringName of the company.Amazon
billing_customer_nameYESstringFirst name of the billed customer.John
billing_last_nameNOstringLast name of the billed customer.Doe
billing_addressNOstringaddress details of the billed customer.Civil line, House 20
billing_address_2NOstringFurther address details of the billed customer.Near Hokage House
billing_cityYESstringBilling address city. Max char: 30.New Delhi
billing_pincodeYESintegerPincode of the billing address.110002
billing_stateYESstringBilling address state.Delhi
billing_countryYESstringBilling address country.India
billing_emailYESstringEmail address of the billed customer.John@doe.com
billing_phoneYESintegerThe phone number of the billing customer.9856321472
billing_alternate_phoneNOintegerAlternate phone number of the billing customer.8604690454
shipping_is_billingYESbooleanWhether the shipping address is the same as billing address. 1 or ‘true’ for yes and 0 or ‘false’ for no.true
shipping_customer_nameCONDITIONAL YESstringName of the customer the order is shipped to. Required in case billing is not same as shipping.Jane
shipping_last_nameNOstringLast name of the shipping customer.Doe
shipping_addressCONDITIONAL YESstringAddress of the Shipping customer. Required in case billing is not same as shipping.Lane number 69
shipping_address_2NOstringFurther address details of shipping customer.Andheri
billing_isd_codeNOstringISD code of the billing address.+91
shipping_cityCONDITIONAL YESstringShipping address city.Mumbai
shipping_pincodeCONDITIONAL YESintegerShipping address pincode.200912
shipping_countryCONDITIONAL YESstringShipping address country.India
shipping_stateCONDITIONAL YESstringShipping address state.Maharashtra
shipping_emailNOstringEmail of the shipping customer.Jane@doe.com
shipping_phoneCONDITIONAL YESintegerPhone no. of the shipping customer.
longitudeNOfloatDestination (Shipping address) Longitude.69.0747
latitudeNOfloatDestination (Shipping address) Latitude22.4064
order_itemsYES/List of items and their relevant fields in the form of Array./
nameYESstringName of the product.Jeans
skuYESstringThe sku id of the product.cbs123
unitsYESintegerNo of units that are to be shipped.10
selling_priceYESintegerThe selling price per unit in Rupee. Inclusive of GST.900
discountNOintegerThe discount amount in Rupee. Inclusive of tax.10
taxNOintegerThe tax percentage on the item.5
hsnNOintegerHarmonised System Nomenclature code. Used to determine the category of taxation the goods fall under.44122
payment_methodYESstringThe method of payment. Can be either COD (Cash on delivery) Or Prepaid.COD
shipping_chargesNOintegerShipping charges if any in Rupee.5
giftwrap_chargesNOintegerGiftwrap charges if any in Rupee.5
transaction_chargesNOintegerTransaction charges if any in Rupee.5
total_discountNOintegerThe total discount amount in Rupee.15
sub_totalYESintegerCalculated sub total amount in Rupee after deductions.9010
lengthYESfloatThe length of the item in cms. Must be more than 0.5.10
breadthYESfloatThe breadth of the item in cms. Must be more than 0.5.10
heightYESfloatThe height of the item in cms. Must be more than 0.5.10
weightYESfloatThe weight of the item in kgs. Must be more than 0.2.5
ewaybill_noNOstringDetails relating to the shipment of goods. .K92373490
customer_gstinNOstringGoods and Services Tax Identification Number.29ABCDE1234F2Z5
invoice_numberNOstring
order_typeNOstringKey to differentiate between Essentials or Non Essentials Shipments. Order type can only be ESSENTIALS or NON ESSENTIALS. Please note it is case sensitive and blank values are allowed.ESSENTIALS
checkout_shipping_methodNOstringOnly for SRF users.a. SR_RUSH: SDD, NDD
b. SR_STANDARD: Surface Delivery
c. SR_EXPRESS: Air Delivery
d. SR_QUICK: 3 hrs delivery
what3words_addressNOstringWhat3words is a proprietary geocode system designed to identify any location on the surface of Earth with a resolution of about 3 meters. The system encodes geographic coordinates into three permanently fixed dictionary words.toddler.geologist.animated
is_insurance_optNObooleanTo secure shipments above the order value of Rs 2500true

POST /v1/external/orders/create

Summary: Create Channel Specific Order

This 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.

The order created will be added under the specified channel. All the other parameters are the same.

Note:

  • Channel_id field is required.
  • Order_id cannot be the same as the already existing order id.
  • Inventory 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.
  • Inventory details of your Shiprocket account can be accessed using the ‘Get Inventory Details’ API.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESstringThe order id you want to specify to the order. Max char: 20. (Avoid passing character values as this contradicts some other API calls).224477 or 224-477
order_dateYESstringThe date of order creation in yyyy-mm-dd format. Time is an additional option.2019-07-24 11:11
pickup_locationNOstringThe name of the pickup location added in your Shiprocket account. This cannot be a new location. Default Pickup location is selected in case the parameter is not filled.Jammu
channel_idYESintegerThe id of the specific channel to be selected.27022
commentNOstringOption to add ‘From’ field to the shipment. To do this, enter the name in the following format: ‘Reseller: [name].’Reseller: Divine
billing_customer_nameYESstringFirst name of the customer who is billed.John
billing_last_nameNOstringLast name of the billed customer.Doe
billing_addressYESstringPrimary address of the billed customer. Min char: 3.House 221B, Leaf Village
billing_address_2NOstringFurther address details of the billed customer.Near Hokage House
billing_cityYESstringBilling address city. Max char: 30.New Delhi
billing_pincodeYESintegerPincode of the billing address.110002
billing_stateYESstringBilling address state.Delhi
billing_countryYESstringBilling address country.India
billing_emailYESstringEmail address of the billed customer.John@doe.com
billing_phoneYESintegerPhone number of the billed customer.9876543210
shipping_is_billingYESbooleanWhether the shipping address is the same as billing address. 1 or ‘true’ for yes and 0 or ‘false’ for no.true
shipping_customer_nameCONDITIONAL YESstringName of the customer the order is shipped to. Required in case billing is not same as shipping.Jane
shipping_last_nameNOstringLast name of the shipping customer.Doe
shipping_addressCONDITIONAL YESstringAddress of the Shipping customer. Required in case billing is not same as shipping.Lane 69
shipping_address_2NOstringFurther address details of shipping customer.Andheri
shipping_cityCONDITIONAL YESstringShipping address city.Mumbai
shipping_pincodeCONDITIONAL YESintegerShipping address pincode.200912
shipping_countryCONDITIONAL YESstringShipping address country.India
shipping_stateCONDITIONAL YESstringShipping address state.Maharashtra
shipping_emailCONDITIONAL YESstringEmail of the shipping customer.jane@doe.com
shipping_phoneCONDITIONAL YESintegerPhone no. of the shipping customer9887655432
order_itemsYES/Array containing further fields./
nameYESstringName of the product.Jeans
skuYESstringThe sku id of the product.cbs123
unitsYESintegerNo. of units that are to be shipped.10
selling_priceYESintegerThe selling price per unit in Rupee. Inclusive of GST.900
discountNOintegerThe discount amount in Rupee. Inclusive of tax.10
taxNOintegerThe tax percentage on the item.5
hsnNOintegerHarmonised System Nomenclature code. Used to determine the category of taxation the goods fall under.44122
payment_methodYESstringThe method of payment. Can be either COD (Cash on delivery) Or Prepaid.COD
shipping_chargesNOintegerShipping charges if any in Rupee.5
giftwrap_chargesNOintegerGiftwrap charges if any in Rupee.5
transaction_chargesNOintegerTransaction charges if any in Rupee.5
total_discountNOintegerThe total discount amount in Rupee.15
sub_totalYESintegerCalculated sub total amount in Rupee.9010
lengthYESintegerThe length of the item in cms. Must be more than 0.5.10
breadthYESintegerThe breadth of the item in cms. Must be more than 0.5.10
heightYESintegerThe height of the item in cms. Must be more than 0.5.10
weightYESintegerThe weight of the item in kgs. Must be more than 0.2.5

PATCH /v1/external/orders/address/pickup

Summary: Change/Update Pickup Location of Created Orders

Using 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.

Note:

  • Pickup location can only be changed/updated to an already existing pickup location in your account.
  • The ‘order_id’ to be passed is the Shiprocket order_id received at the time of order creation.
  • Multiple order ids can be passed as an array, separated by commas. eg: [“141414,142424,143434”]

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESintegerThe Shiprocket order_id specified to the order.16167171
pickup_locationYESstringThe pickup location you want to change your current pickup location to.Delhi

POST /v1/external/orders/address/update

Summary: Update Customer Delivery Address

You can update the customer’s name and delivery address through this API by passing the Shiprocket order id and the necessary customer details.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESintegerThe Shiprocket order_id specified to the order.16178831
shipping_customer_nameYESstringThe name of the customer.John Doe
shipping_phoneYESintegerPhone number of the customer.9988998899
shipping_addressYESstringPrimary address of the customer.House no 123
shipping_address_2NOstringFurther address details of the customer.Beside CM house
shipping_cityYESstringShipping city name.Pune
shipping_stateYESstringShipping state name.Maharashtra
shipping_countryYESstringShipping country name.India
shipping_pincodeYESintegerShipping address pincode.120023
shipping_emailNOstringCustomer’s email address.john@doe.com
billing_alternate_phoneNOstringThe customer alternate phone.8604690454

POST /v1/external/orders/update/adhoc

Summary: Update Order

Use 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.

You 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.

POST /v1/external/orders/cancel

Summary: Cancel an Order

Use this API to cancel a created order. Multiple order_ids can be passed together as an array to cancel them simultaneously.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
idsYESintegerThe Shiprocket order id/ids of the orders that need to be canceled.16178831

PATCH /v1/external/orders/fulfill

Summary: Add Inventory for Ordered Product

Use 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.

Notes:

  • Inventory sync of your account must be turned on to use this API.
  • The order_id to be passed is the shiprocket order id. If you don’t know the product id, Use the ‘Get Product Details’ API to get details about all the existing products.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESintegerThe Shiprocket order_id specified to the order.16167171
order_product_idYESintegerThe product id of the product to be added.17171717
quantityYESstringThe number of items you want to add.10
actionYESstringThe action you want to carry out. Is ‘add’.add

PATCH /v1/external/orders/mapping

Summary: Map Unmapped Products

This API maps your unmapped inventory products.

Note:

  • Products must be unmapped to run this API successfully.
  • Inventory sync must be turned on to use this API.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESintegerThe Shiprocket order_id specified to the order.16167171
order_product_idYESintegerThe product id of the product to be mapped.17171717
master_skuYESstringThe sku id of the product. In the case of a single integrated channel, master sku is the same as channel_sku; Otherwise, it can be found using the ‘Get All Products’ API.chakra123

POST /v1/external/orders/import

Summary: Import Orders in Bulk

Use 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.

POST /v1/external/courier/assign/awb

Summary: Generate AWB for Shipment

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.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
shipment_idYESintegerThe shipment id of the order you want to create the AWB for.16016920
courier_idNOintegerThe courier id of the courier service you want to select. The default courier is selected in case no id is specified.10
statusNOstringUse this to change the courier of a shipment. Value: reassign. Note that this can be done only once in 24 hours.reassign

GET /v1/external/courier/courierListWithCounts

Summary: List of Couriers

Use this API to check the list of couriers and the related information with Shiprocket based on the search criteria.
Note:

  • This API will work on a company level.
  • You can use filters to sort your data. By default, all the couriers are shown if no filter is used.
  • total_courier_count will change based on the filter used.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
typeNOstringUse this as a parameter. Possible values are : active/inactive/allhttps://apiv2.shiprocket.in/v1/external/courier/courierListWithCounts?type=active

GET /v1/external/courier/serviceability/

Summary: Check Courier Serviceability

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:

  • One 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.
  • You can add further fields to add the shipment details and filter the search.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pickup_postcodeYESintegerPostcode from where the order will be picked.110030
delivery_postcodeYESintegerPostcode where the order will be delivered122002
order_idNOintegerIf order id is already created in Shiprocket panel then you can use this shiprocket order id in servicibility123456
codCONDITIONAL YESboolean1 for Cash on Delivery and 0 for Prepaid orders.1
weightCONDITIONAL YESstringThe weight of shipment in kgs.2
lengthNOintegerThe length of the shipment in cms.15
breadthNOintegerThe breadth of the shipment in cms.10
heightNOintegerThe height of the shipment in cms.5
declared_valueNOintegerThe price of the order shipment in rupees.50
modeNOstringThe mode of travel. Either: Surface or AirAir
is_returnNOintegerWhether the order is a return order or not. 1 in case of Yes and 0 for No. (declared_value field is required in case you use this parameter)0
couriers_typeNOintegerUse this to filter out and show only “documents” couriers like XB documents, etc. The only accepted value is 1.1
only_localNOintegerUse this to filter out and show only Hyperlocal couriers. The only accepted value is 1.1
qc_checkCONDITIONAL YESintegerUse this filter to show only the QC-enabled couriers. is_return has to be set to 11

POST /v1/external/courier/generate/pickup

Summary: Request for Shipment Pickup

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:

  • The AWB must be already generated for the shipment id to generate the pickup request.
  • Only one shipment_id can be passed at a time.
  • In case the pickup_date falls on a holiday or Sunday, the shipment will be booked for the next available date.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
shipment_idYESintegerThe shipment id of the shipment which is requested for pickup.[16090109]
statusNOstringUse this field to retry if the pickup request fails. Value: retryretry
pickup_dateNOArray of DatesUse this field to schedule a pickup for a future date. The date format would be YYYY-MM-DD. You can reschedule the date till that date has not passed[“2022-06-04”]

GET /v1/external/orders

Summary: Get all Orders

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.

You 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.

You can also fetch the data based on the order update date. PFB the validations:

1. if updated_to => passed and updated_from not passed =>, error will come => Please send update_from date along with update_to date
2. 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.
3. if updated_From < 30 then error => Updated_from date should not be less than 30 days from current date

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pageNOintegerThe page number to display.5
per_pageNOintegerThe number of entries per page.5
sortNOstringSort conditions: ASC or DESCASC
sort_byNOstringThe Field to sort by: id or statusid
toNOstringThe end date.2018-07-24
fromNOstringThe start date.2019-07-24
filter_byNOstringField to filter by.status, payment_method, delivery_country, channel_order_id
filterNOstringValue of the field
searchNOstringSearch for AWB or by Channel order_id (order id specified by you).224477
pickup_locationNOstringSearch Orders on the basis of pickup location.xyz
channel_idNOintegerChannel ID Returned in Get Integrated Channels API123
fbsNOintegerUse this filter if you want to view and filter the SRF orders0 or 1

GET /v1/external/orders/show

Summary: Get Specific Order Details

Get 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}.

No other body parameters are required.

Note:

For SRF orders, you’ll receive an extra parameter viz., fulfillment_status. This key will have four values:

  • Ready to Pack, 
  • Packed
  • Added to Picklist
  • Picked up

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/orders/show/16167171

POST /v1/external/orders/export

Summary: Export your orders

This 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.

The CSV file containing is accessible via this URL. No parameters are required to access this API.

POST /v1/external/orders/create/return

Summary: Create a Return Order

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.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESstringThe order id you want to specify to the order. Max char: 50. (Avoid passing character values as this contradicts some other API calls)99711997
order_dateYESstringThe date of order creation in yyyy-mm-dd format. Time is an additional option.2019-08-05
channel_idYESintegerId of the desired channel where the order is to be placed. ‘Custom’ channel id is selected in case parameter is not filled.768903
pickup_customer_nameYESstringThe customer’s first name.John
pickup_last_nameNOstringThe customer’s last name.Doe
pickup_addressYESstringThe customer’s primary address.Home
pickup_address_2NOstringAdditional customer address details.DDA
pickup_cityYESstringThe customer’s city name.Delhi
pickup_stateYESstringThe customer’s state.New Delhi
pickup_countryYESstringCustomer’s country name.India
pickup_pincodeYESintegerPincode of the customer address.110002
pickup_emailYESstringCustomer’s email address.john@doe.com
pickup_phoneYESstringCustomer’s phone number.9999999999
pickup_isd_codeNOstringISD code.91
pickup_location_idNOintegerReturn pickup location address ID.41514
shipping_customer_nameYESstringThe name of the seller the package is shipped back to.Jane
shipping_last_nameNOstringThe last name of the seller.Doe
shipping_addressYESstringThe address the package is shipped to.Castle
shipping_address_2NOstringFurther shipping address details.Bridge
shipping_cityYESstringThe shipping address city.Mumbai
shipping_countryYESstringThe shipping address country.India
shipping_pincodeYESintegerThe shipping pincode.220022
shipping_stateYESstringShipping address state.Maharashtra
shipping_emailNOstringThe email of the seller the package is shipped to.jane@doe.com
shipping_isd_codeNOstringThe shipping isd code.91
shipping_phoneYESintegerPhone no. of the shipping customer8888888888
order_itemsYES/Array containing further fields./
nameYESstringName of the product.ball123
skuYESstringThe sku id of the product.Tennis Ball
unitsYESintegerNo of units that are to be shipped.1
selling_priceYESintegerThe selling price per unit in Rupee. Inclusive of GST.10
discountNOintegerThe discount amount in Rupee. Inclusive of tax.0
hsnNOstringHarmonised System Nomenclature code. Used to determine the category of taxation the goods fall under.4412
qc_enableCONDITIONAL YESstringIf True, QC will be performed for that product and QC will be performed only for a single SKU per ordertrue/false
qc_colorNOvarchar(180)The color of the product can be passed in this parameterRed
qc_brandNOvarchar(255)The brand of the product can be passed in this parameter768903
qc_serial_noNOvarchar(255)The serial number of the product can be passed in this parameterT13123124
qc_ean_barcodeNOvarchar(255)EAN/Barcode of the product can be passed in this parameterQWRE123
qc_sizeNOvarchar(180)The size of the product can be passed in this parameter8
qc_product_nameNOvarchar(255)If qc_enable set True, then Product name should be passed in this parameterShoes
qc_product_imageNOvarchar(255)If qc_enable set True, then Product image should be passed in this parameter (only png/jpg format supported)https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/1636713733zxjaV.png
payment_methodYESstringThe method of payment. Can be either COD (Cash on delivery) Or Prepaid.Prepaid
total_discountNOstringThe total discount amount in Rupee.0
sub_totalYESintegerCalculated sub total amount in Rupee after deductions.10
lengthYESfloatThe length of the shipment in cms.10
breadthYESfloatThe breadth of the shipment in cms.15
heightYESfloatThe height of the shipment in cms.20
weightYESfloatThe shipment weight in kgs.1

GET /v1/external/orders/processing/return

Summary: Get All Return Orders

Using this API, you can get a list of all created return orders in your Shiprocket account, along with their details.

No parameters are required to use the API. However, further parameters can be defined to sort and filter the data.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pageNOintegerThe page number to display.1
per_pageNOintegerThe number of orders per page.2
toNOstringEnding date of search.2019-08-04
fromNOstringStarting date of search.2019-08-05

GET /v1/external/shipments

Summary: Get All Shipment Details

Use this API to get the shipment details of all the shipments in your Shiprocket account.

The 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.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
sortNOstringThe sort format: ASC or DESCASC
sort_byNOstringThe field to sort by.id
filterNOstringThe filter value.141121
filter_byNOstringThe filed to filter by.id

POST /v1/external/orders/cancel/shipment/awbs

Summary: Cancel a Shipment

Use 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.

Limit: 2000 AWBs

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
awbsYESstringThe AWB/List of AWBs that need to be canceled.19041211125783

POST /v1/external/manifests/generate

Summary: Generate Manifest

Using this API, you can generate the manifest for your order. This API generates the manifest and displays the download URL of the same.

Note:

  • Multiple ids can also be passed as an array for bulk generation of manifests.
  • AWB must be assigned and pickup requested on the shipment id to generate manifest.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
shipment_idYESintegerThe shipment id of the order. Multiple ids can be passed as an array, separated by commas.[16090109]

POST /v1/external/manifests/print

Summary: Print Manifest

Use this API to print the generated manifest of orders at an individual level.

Note

  • Manifest needs to be generated first for this API to print it. Use the ‘Generate Manifest’ API to do the same.
  • Multiple order ids can be passed together.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idsYESintegerThe Shiprocket order id of whose manifest is to be generated. Multiple ids can be passed together as an array.[16090109]

POST /v1/external/courier/generate/label

Summary: Generate Label

Generate the label of order by passing the shipment id in the form of an array. This API displays the URL of the generated label.

Note:

  • The AWB must be assigned to the shipment to generate the label.
  • ‘shipment_id’ must be passed as an array.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
shipment_idYESintegerThe shipment id of the order whose label is to be generated. Multiple ids can be passed together as an array.[16104408,16104409]

POST /v1/external/orders/print/invoice

Summary: Generate Invoice

Use this API to generate the invoice for your order by passing the respective Shiprocket order ids.

The generated invoice URL is displayed as a response. Multiple ids can be passed together as an array.

Note

  • Order ids must be passed as an array.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
idsYESintegerThe Shiprocket order id of the orders whose invoices are to be created. Multiple ids can be passed together as an array.[16255275,16255276]

POST /v1/external/shipments/create/forward-shipment

Summary: Forward

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.

This API integrates several other APIs to perform all these tasks together.

Notes:

  • Use the ‘vendor_details’ array to add a new pickup location to your account and assign it to your order.
  • The ‘pickup_location’ field must contain a new pickup location name for adding a new pickup location to your Shiprocket account.
  • In case of multiple items per order, please pass the final weight (sum total weight of items) of the shipment.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
modeNOstringThe mode of shipment, either surface or air. Value: Surface or AirAir
request_pickupNObooleanUse false if you dont want to request pickup. Default value is true.true
print_labelNObooleanUse false if you dont want to print label. Default value is true.true
generate_manifestNObooleanUse false if you dont want to generate manifest. Default value is true.true
ewaybill_noNOstringDetails relating to the shipment of goods.K92373490
courier_idNOintegerThe courier id of the courier you want to assign. Refer to the servicability API to get id.10
reseller_nameNOstringThe ‘from’ name if you want to print. Use ‘Reseller: [name]‘Reseller: Divine
order_idYESstringThe custom reference id you want to assign to the order.2477
isd_codeNOstringThe isd code91
billing_isd_codeNOstringThe billing isd code.91
order_dateYESstringThe date of the creation of order.2019-08-04
channel_idNOintegerThe channel id of the specific channel. Use the Channels API to get id.72505
company_nameNOstringName of the company.Amazon
billing_customer_nameYESstringThe first name of customer to be billed.John
billing_last_nameNOstringThe last name of the billing customer.Doe
billing_addressYESstringThe primary billing address.House no 21
billing_address_2NOstringAdditional billing address details.Street 2, Dwarka
billing_cityYESstringThe billing city.Delhi
billing_stateYESstringThe billing address state.New Delhi
billing_countryYESstringThe billing address country.India
billing_pincodeYESintegerThe pincode of the billing address.110002
billing_emailYESstringThe billing customer email.john@doe.com
billing_phoneYESintegerThe billing customer phone.9999998899
billing_alternate_phoneNOintegerThe billing customer alternate phone.8404690454
shipping_is_billingYESbooleanWhether shipping details are the same as billing details. true for yes false for no.true
shipping_customer_nameCONDITIONAL YESstringShipping customer’s first name.Jane
shipping_last_nameNOstringShipping customer’s last name.Doe
shipping_addressCONDITIONAL YESstringThe shipping address.House no X
shipping_address_2NOstringAdditional shipping address details.Street X
shipping_cityCONDITIONAL YESstringThe shipping city.Mumbai
shipping_stateCONDITIONAL YESstringThe state of the shipping address.Maharashtra
shipping_countryCONDITIONAL YESstringThe shipping address country.India
shipping_pincodeCONDITIONAL YESintegerShipping pincode.230023
shipping_emailCONDITIONAL YESstringThe email of the shipping customer.Jane@Doe.com
shipping_phoneCONDITIONAL YESintegerThe phone number of the shipping customer.8877997799
order_itemsYES/Array containing further parameters./
nameYESstringThe name of the product.Jeans
skuYESstringsku Code of the product.Bat
unitsYESintegerNumber of units.10
hsnNOintegerHSN code if available.4412
selling_priceYESstringThe selling price of each unit inclusive of GST.200
taxNOintegerThe tax applied in percent.20
discountNOintegerThe discount amount inclusive of tax.20
payment_methodYESstringIf the payment method is Cash on delivery (COD) or Prepaid.COD
shipping_chargesNOintegerThe shipping charges if any in rupees.5
giftwrap_chargesNOintegerThe gift-wrap charges if any in rupees.5
transaction_chargesNOintegerThe transaction charges if any in rupees.10
total_discountNOintegerThe discount amount in rupees.15
sub_totalYESintegerThe sub total amount in rupees.1800
weightYESstringThe weight of the shipment in kgs.2
lengthYESintegerThe length of the shipment in cms. Must be more than 0.510
breadthYESintegerThe breadth of the shipment in cms. Must be more than 0.515
heightYESintegerThe height of the shipment in cms. Must be more than 0.520
pickup_locationYESstringThe pickup location name. Equal to an existing pickup location. If you use ‘vendor details’ to add a new location, it must be equal to the new pickup location name.Office
customer_gstinNOstringGoods and Services Tax Identification Number.29ABCDE1234F2Z5
vendor_detailsNO/Array containing further parameters. Use to assign/add a new pickup location to your account./
emailCONDITIONAL YESstringThe shipper’s email address.john@doe.com
phoneCONDITIONAL YESintegerThe shipper’s phone number.8888999888
nameCONDITIONAL YESstringThe shipper’s name.John Doe
addressCONDITIONAL YESstringThe pickup location address. Min 10 characters.Office Building
address_2NOstringAdditional address details. Min 10 characters.Street 2 house 4
cityCONDITIONAL YESstringThe pickup location city.Pune
stateCONDITIONAL YESstringThe pickup state.Maharashtra
countryCONDITIONAL YESstringThe pickup location country.India
pin_codeCONDITIONAL YESintegerThe pickup pincode.200099
pickup_locationCONDITIONAL YESstringNew pickup location name. Max: 36 char. Alphanumeric only.New Office
order_typeNOstringKey to differentiate between Essentials or Non Essentials Shipments. Order type can only be ESSENTIALS or NON ESSENTIALS. Please note it is case sensitive and blank values are allowedESSENTIALS
longitudeNOfloatDestination (Shipping address) Longitude.69.0747
latitudeNOfloatDestination (Shipping address) Latitude22.4064
what3words_addressNOstringWhat3words is a proprietary geocode system designed to identify any location on the surface of Earth with a resolution of about 3 meters. The system encodes geographic coordinates into three permanently fixed dictionary words.toddler.geologist.animated

POST /v1/external/shipments/create/return-shipment

Summary: Return

Use 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:

  • pickup_location field is not required.
  • Label and Manifest are not required in case of returns.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESstringThe order id you want to specify to the order. Max char: 20. (Avoid passing character values as this contradicts some other API calls)99711997
order_dateYESstringThe date of order creation in yyyy-mm-dd format. Time is an additional option.2019-08-05
channel_idNOintegerId of the desired channel where the order is to be placed. ‘Custom’ channel id is selected in case parameter is not filled.768903
pickup_customer_nameYESstringThe customer’s first name.John
pickup_last_nameNOstringThe customer’s last name.Doe
company_nameNOstringName of the companyAmazon
pickup_addressYESstringThe customer’s primary address.Home
pickup_address_2NOstringAdditional customer address details.DDA
pickup_cityYESstringThe customer’s city name.Delhi
pickup_stateYESstringThe customer’s state.New Delhi
pickup_countryYESstringCustomer’s country name.India
pickup_pincodeYESintegerPincode of the customer address.110002
pickup_emailYESstringCustomer’s email address.john@doe.com
pickup_phoneYESstringCustomer’s phone number.9999999999
pickup_isd_codeNOstringISD code.91
shipping_customer_nameYESstringThe name of the seller the package is shipped back to.Jane
shipping_last_nameNOstringThe last name of the seller.Doe
shipping_addressYESstringThe address the package is shipped to.Castle
shipping_address_2NOstringFurther shipping address details.Bridge
shipping_cityYESstringThe shipping address city.Mumbai
shipping_countryYESstringThe shipping address country.India
shipping_pincodeYESintegerThe shipping pincode.220022
shipping_stateYESstringShipping address state.Maharashtra
shipping_emailYESstringThe email of the seller the package is shipped to.jane@doe.com
shipping_isd_codeNOstringThe shipping isd code.91
shipping_phoneYESintegerPhone no. of the shipping customer8888888888
order_itemsYES/Array containing further fields./
nameYESstringName of the product.ball123
skuYESstringThe sku id of the product.Tennis Ball
unitsYESintegerNo of units that are to be shipped.1
selling_priceYESintegerThe selling price per unit in Rupee. Inclusive of GST.10
discountNOintegerThe discount amount in Rupee. Inclusive of tax.0
hsnNOstringHarmonised System Nomenclature code. Used to determine the category of taxation the goods fall under.4412
qc_enableCONDITIONAL YESstringIf True, QC will be performed for that product and QC will be performed only for a single SKU per orderTRUE/FALSE
qc_colorNOvarchar(180)The color of the product can be passed in this parameterRed
qc_brandNOvarchar(255)The brand of the product can be passed in this parameter768903
qc_serial_noNOvarchar(255)The serial number of the product can be passed in this parameterT13123124
qc_ean_barcodeNOvarchar(255)EAN/Barcode of the product can be passed in this parameterQWRE123
qc_sizeNOvarchar(180)The size of the product can be passed in this parameter8
qc_product_nameNOvarchar(255)If qc_enable set True, then Product name should be passed in this parameterShoes
qc_product_imageNOvarchar(255)If qc_enable set True, then Product image should be passed in this parameter (only png/jpg format supported)https://s3-ap-southeast-1.amazonaws.com/kr-multichannel/1636713733zxjaV.png
payment_methodYESstringThe method of payment. Can be either COD (Cash on delivery) Or Prepaid.Prepaid
total_discountNOstringThe total discount amount in Rupee.0
sub_totalYESintegerCalculated sub total amount in Rupee after deductions.10
lengthYESintegerThe length of the shipment in cms.10
breadthYESintegerThe breadth of the shipment in cms.15
heightYESintegerThe height of the shipment in cms.20
weightYESintegerThe shipment weight in kgs.1
request_pickupNObooleanUse false if you dont want to request pickup. Default value is true.true

GET /v1/external/ndr/all

Summary: Get All NDR Shipments

This API call will display a list of all the shipments that are in NDR in your Shiprocket account.

You 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.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pageNOintegerThe page number to display.5
per_pageNOintegerThe number of entries per page.5
toNOstringThe end date.2021-08-02
fromNOstringThe start date.2021-08-02
searchNOstringSearch for AWB.224477

GET /v1/external/ndr/{AWB}

Summary: Get Specific NDR Shipment Details

Get 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.

Type in your AWB code in place of {AWB}. No other body parameters are required.

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/ndr/94711332

PARAMETERS /v1/external/ndr/{AWB}

POST /v1/external/ndr/{awb}/action

Summary: Action NDR

This API will let you take actions like Reattempt and RTO on the shipments that are in NDR.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
actionYESstringThe action needs to be specified‘fake-attempt’ or ‘re-attempt’ or ‘return’
commentsYESstringAny comment can be mentionedThe Byer does not want the product
phoneNOstringThe phone number will be updated at the time of re-attempt and fake-attempt9999988888
proof_audioCONDITIONAL YESstringURL of the audio which will be updated at the time of the fake attempthttps://s3-ap-southeast-1.amazonaws.com/kr-multichannel/imports/ndr/1655100133_file_example_MP3_700KB.mp3
proof_imageCONDITIONAL YESstringURL of the image which will be updated at the time of the fake attempthttps://s3-ap-southeast-1.amazonaws.com/kr-multichannel/imports/ndr/img_7687678678.jpg
remarksCONDITIONAL YESstringRemarks will be updated at the time of a fake attemptDelivery Requested
address1NOstringaddress1 will be updated at the time of re-attempt and fake-attemptU-56, sector-23, Noida, India
address2NOstringaddres2 will be updated at the time of re-attempt and fake-attemptU-56, sector-23, Noida, India
deferred_dateNOdate(string)Deferred date will be updated as preferred_date at the time of fake-attempt and re-attempt2022-08-10

PARAMETERS /v1/external/ndr/{awb}/action

GET /v1/external/courier/track/awb/{awb_code}

Summary: Get Tracking through AWB

Get the tracking details of your shipment by entering the AWB code of the same in the endpoint URL itself. No other body parameters are required to access this API.

The response is displayed in JSON format.

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/courier/track/awb/788830567028

PARAMETERS /v1/external/courier/track/awb/{awb_code}

POST /v1/external/courier/track/awbs

Summary: Get Tracking Data for Multiple AWBS

Get the tracking details of multiple shipments by entering their AWB codes together as an array.

The response is displayed in JSON format.

Notes:

  • Data must be passed as a string array.
  • Maximum of 50 AWB codes is supported at a time.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
awbsYESstringThe AWB codes of the shipments. Must be passed as an array.[“788830567028”,“788829354408”]

GET /v1/external/courier/track/shipment/{shipment_id}

Summary: Get Tracking through Shipment ID

Get the tracking details of your shipment by entering the shipment_id of the same in the endpoint URL. No other body parameters are required to access this API.

The response is displayed in JSON format.

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/courier/track/shipment/16104408

PARAMETERS /v1/external/courier/track/shipment/{shipment_id}

GET /v1/external/courier/track

Summary: Get Tracking Data through Order iD

Get the tracking details of your shipment by entering the Order ID of the same in the endpoint URL itself. If you have the same order ID in more than one channel, then use the param channel_id.

The response is displayed in JSON format.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESstringThe order ID/number of your store.NO-123
channel_idNOintegerChannel ID corresponding to the store12345

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/courier/track?order_id=123&channel_id=12345

GET /v1/external/settings/company/pickup

Summary: Get All Pickup Locations

Get a list of all pickup locations that have been added to your Shiprocket account through this API.

No parameters are required to use this API.

POST /v1/external/settings/company/addpickup

Summary: Add a New Pickup Location

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.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pickup_locationYESstringThe nickname of the new pickup location. Max 36 characters.Home
nameYESstringThe shipper’s name.Deadpool
emailYESstringThe shipper’s email address.deadpool@chimichanga.com
phoneYESintegerShipper’s phone number.9777777779
addressYESstringShipper’s primary address. Max 80 characters.Mutant Facility, Sector 3
address_2NOstringAdditional address details.House number 34
cityYESstringPickup location city name.Pune
stateYESstringPickup location state name.Maharashtra
countryYESstringPickup location country.India
pin_codeYESintegerPickup location pincode.110022
latNOfloatPickup location Latitude.22.4064
longNOfloatPickup location Longitude.69.0747
address_typeNOstringTo be given if address of different vendor is to be provided with pickup addressvendor
vendor_nameNOstringName of vendor if address_type is vendorJohn
gstinNOstringgstin of vendor09XXXCH7409R1XXX

GET /v1/external/international/orders/track

Summary: Tracking

Get the tracking details of your shipments. No other body parameters are required to access this API.

POST /v1/external/international/settings/international_kyc

Summary: International KYC

Use this API for your international KYC. This API return your KYC status.
Please check the documentation for the documents for KYC.

PARAMSREQUIRED DATADATA TYPEDESCRIPTIONEXAMPLE
organization_typeYesstringSeller organizationcompany
ip_addressYesint unsignedSeller’s ip_address192.168.1.1.0
documentsYesarrayDocumentaion for organization type
(document size is not greater than 3 MB)		Please check request

POST /v1/external/international/settings/add-bank-details

Summary: Add Bank Details

ThisdocumentationprovidesinformationabouttheBankDetailsAPI,whichallowsyouto
addbankdetailsforinternationalsettings.TheAPIendpoint, parameters, request sample
data, success response , and failed response are outlined below.

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
bank_account_typeYESstringankaccounttype.Mustbe
either”saving”or”current”.		“saving”
beneficiary_nameYESstringBeneficiaryname.
Alphabetsandspacesonly		”JohnDoe”
bank_ifsc_codeYESstringBankIFSCcode.Must
followaspecificpattern		”ABCD0123456”
bank_account_numberYESintegerBankaccountnumber.
Shouldbebetween9and
18digits.		1234567890

POST /v1/external/international/orders/create/adhoc

Summary: Create order

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.

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.

Note:

  • In case the ‘shipping_is_billing’ field is false, further shipping detail fields are required.

If 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.

  • order_id field cannot be equal to an already existing id. Doing so does not change or affect the existing order.
  • New 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.
  • Be sure to input the correct calculated sub_total amount. The total is not calculated automatically through the API.
  • The ‘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.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
order_idYESstringThe order id you want to specify to the order. Max char: 50. (Avoid passing character values as this contradicts some other API calls).224477 or 224-477
order_dateYESstringThe date of order creation in yyyy-mm-dd format. Time is additional.2019-07-24 11:11
pickup_locationYESstringThe name of the pickup location added in your Shiprocket account. This cannot be a new location.Jammu
channel_idNOintegerMention this in case you need to assign the order to a particular channel. Deafult is ‘Custom’.27022
commentNOstringOption to add ‘From’ field to the shipment. To do this, enter the name in the following format: ‘Reseller: [name]‘.Reseller: Divine
reseller_nameNOstringThe ‘from’ name if you want to print. Use ‘Reseller: [name]‘Reseller: Divine
company_nameNOstringName of the company.Amazon
billing_customer_nameYESstringFirst name of the billed customer.John
billing_last_nameNOstringLast name of the billed customer.Doe
billing_addressNOstringaddress details of the billed customer.Civil line, House 20
billing_address_2NOstringFurther address details of the billed customer.Near Hokage House
billing_cityYESstringBilling address city. Max char: 30.New Delhi
billing_pincodeYESintegerPincode of the billing address.110002
billing_stateYESstringBilling address state.Delhi
billing_countryYESstringBilling address country.India
billing_emailYESstringEmail address of the billed customer.John@doe.com
billing_phoneYESintegerThe phone number of the billing customer.9856321472
billing_alternate_phoneNOintegerAlternate phone number of the billing customer.8604690454
shipping_is_billingYESbooleanWhether the shipping address is the same as billing address. 1 or ‘true’ for yes and 0 or ‘false’ for no.true
shipping_customer_nameCONDITIONAL YESstringName of the customer the order is shipped to. Required in case billing is not same as shipping.Jane
shipping_last_nameNOstringLast name of the shipping customer.Doe
shipping_addressCONDITIONAL YESstringAddress of the Shipping customer. Required in case billing is not same as shipping.Lane number 69
shipping_address_2NOstringFurther address details of shipping customer.Andheri
billing_isd_codeNOstringISD code of the billing address.+91
shipping_cityCONDITIONAL YESstringShipping address city.Mumbai
shipping_pincodeCONDITIONAL YESintegerShipping address pincode.200912
shipping_countryCONDITIONAL YESstringShipping address country.India
shipping_stateCONDITIONAL YESstringShipping address state.Maharashtra
shipping_emailCONDITIONAL YESstringEmail of the shipping customer.Jane@doe.com
shipping_phoneCONDITIONAL YESintegerPhone no. of the shipping customer.
longitudeNOfloatDestination (Shipping address) Longitude.69.0747
latitudeNOfloatDestination (Shipping address) Latitude22.4064
order_itemsYES/List of items and their relevant fields in the form of Array./
nameYESstringName of the product.Jeans
skuYESstringThe sku id of the product.cbs123
unitsYESintegerNo of units that are to be shipped.10
selling_priceYESintegerThe selling price per unit in Rupee. Inclusive of GST.900
discountNOintegerThe discount amount in Rupee. Inclusive of tax.10
taxNOintegerThe tax percentage on the item.5
hsnNOintegerHarmonised System Nomenclature code. Used to determine the category of taxation the goods fall under.44122
payment_methodYESstringThe method of payment. Can be either COD (Cash on delivery) Or Prepaid.COD
shipping_chargesNOintegerShipping charges if any in Rupee.5
giftwrap_chargesNOintegerGiftwrap charges if any in Rupee.5
transaction_chargesNOintegerTransaction charges if any in Rupee.5
total_discountNOintegerThe total discount amount in Rupee.15
sub_totalYESintegerCalculated sub total amount in Rupee after deductions.9010
lengthYESfloatThe length of the item in cms. Must be more than 0.5.10
breadthYESfloatThe breadth of the item in cms. Must be more than 0.5.10
heightYESfloatThe height of the item in cms. Must be more than 0.5.10
weightYESfloatThe weight of the item in kgs. Must be more than 0.2.5
ewaybill_noNOstringDetails relating to the shipment of goods. .K92373490
customer_gstinNOstringGoods and Services Tax Identification Number.29ABCDE1234F2Z5
invoice_numberNOstring
order_typeNOstringKey to differentiate between Essentials or Non Essentials Shipments. Order type can only be ESSENTIALS or NON ESSENTIALS. Please note it is case sensitive and blank values are allowed.ESSENTIALS
checkout_shipping_methodNOstringOnly for SRF users.
a. SR_RUSH: SDD, NDD
b. SR_STANDARD: Surface Delivery
c. SR_EXPRESS: Air Delivery
d. SR_QUICK: 3 hrs delivery
what3words_addressNOstringWhat3words is a proprietary geocode system designed to identify any location on the surface of Earth with a resolution of about 3 meters. The system encodes geographic coordinates into three permanently fixed dictionary words.toddler.geologist.animated
purpose_of_shipmentNOintergerThe purpose of the shipment. values are 0 - gift, 1- sample, commercial - 2.1
currencyYESstringThe currency of the order. Possible values are INR,USD,GBP, EUR, AUD, CAD, SAR, AED,SGDUSD
reasonOfExportYESintegerThe reason for the export. Possible values are 0 - BONAFIDE_SAMPLE, 1 - SAMPLE, 2 - GIFT, 3 - COMMERCIAL2
commodityNObooleanIndicates if the order is a commodity or nottrue
miesNOtrue
igstPaymentStatusNOcharpossible values are ‘A’- not applicable, ‘B’- LUT or Export under Bond, ‘C’- Export Against Payment of IGSTA
Terms_Of_InvoiceYESstringFOB and CIFFOB
iossYESstring
eoriYESstring

POST /v1/external/international/orders/update/adhoc

Summary: Update order

Use 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.

You 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.

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
purpose_of_shipmentNOintergerThe purpose of the shipment. values are 0 - gift, 1- sample, commercial - 2.1
currencyYESstringThe currency of the order. Possible values are INR,USD,GBP, EUR, AUD, CAD, SAR, AED,SGDUSD
reasonOfExportNointegerThe reason for the export. Possible values are 0 - BONAFIDE_SAMPLE, 1 - SAMPLE, 2 - GIFT, 3 - COMMERCIAL2
commodityNObooleanIndicates if the order is a commodity or nottrue
miesNobooleantrue
igstPaymentStatusYEScharpossible values are ‘A’- not applicable, ‘B’- LUT or Export under Bond, ‘C’- Export Against Payment of IGSTA
Terms_Of_InvoicenostringThe term of invoice either FOB and CIFFOB

POST /v1/external/international/shipments/create/forward-shipment

Summary: International Wrapper API

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.

This API integrates several other APIs to perform all these tasks together.

GET /v1/external/international/courier/serviceability

Summary: Serviceability

This API checks courier serviceability for international orders and displays them as a list.

Notes:

  • ‘cod’ field must be 0 as COD is not available for international orders.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
weightYESintegerThe weight of the shipment.10
codYESintegerCash on delivery status. Must be 0.0
delivery_countryYESstringThe destination country ISO Alpha 2 code.US
order_idNOintegerThe Shiprocket order_id of the shipment if available.1
pickup_postcodeNOintegerUse this field to select a different pickup postcode other than the primary pickup address.2

POST /v1/external/international/courier/assign/awb

Summary: AWB Assignment

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.

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
shipment_idyesintegerThe shipment id of the order you want to create the AWB for.1603434
courier_idnointegerThe courier id of the courier service you want to select. The default courier is selected in case no id is specified.35
statusnostringUse this to change the courier of a shipment. Value: reassign. Note that this can be done only once in 24 hours.reassign

POST /v1/external/international/manifests/generate

Summary: Manifest Generation

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:

  • The AWB must be already generated for the shipment id to generate the pickup request.
  • Only one shipment_id can be passed at a time.
PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
shipment_idyesintegerThe shipment id of the shipment which is requested for pickup.1603434
statusnostringUse this field to retry if the pickup request fails. Value: retryretry

GET /v1/external/account/details/wallet-balance

Summary: Get Wallet Balance

Use this API to get the Wallet balance details of your Shiprocket account. No parameters are required to access this API.

GET /v1/external/products

Summary: Get All Products

This API can be used to display a detailed list of all the products that you have in your Shiprocket account.

There are no required parameters to access this API. However, the displayed result can be filtered or sorted using additional parameters.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pageNOintegerThe page number you want to display.5
per_pageNOintegerThe number of products to get per page.2
sortNOstringThe order to sort by. Value: ASC or DESCASC
sort_byNOstringAllows you to choose the value field by which the items will be sorted. Could be sorted by id, by sku, time created etc.sku
filterNOstringThe data to be matched for the filter value.11223344
filter_byNOstringThe filter value field . Can be id, sku, etc.id

POST /v1/external/products

Summary: Add New Products

Use 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:

  • ‘sku’ Id has to be unique. It cannot be the same as an existing sku.
  • In case no category code is added, the code should be default.
  • ‘type’ field should be either ‘single’ or ‘multiple.‘

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
skuYESstringStock Keeping Unit or the identification unit of an individual product (generally alphanumeric).bat123
HSNNOstringHarmonised System Nomenclature. A code number is used to classify goods for taxation purposes. Done to determine which category of taxes do the goods come under.4412
nameYESstringName of the product.Batman Toy
tax_codeNOstringThe percentage of tax that is to be imposed.10
typeYESstringIf there is only one product or multiple types of products. Single or MultipleSingle.
qtyYESintegerTotal Quantity of the products to be shipped.5
low_stockNOstringSpecifies when the low stock notification should come on/
category_codeYESstringYou can add a category code to your ShipRocket account from “add category”default
descriptionNOstringGives a description of the product.Batman plastic toy.
brandNOstringThe product brand name.Bat
sizeNOintegerThe size of the product.25
weightNOintegerThe weight of the product in kgs.0.5
lengthNOintegerThe length of the product in cms.10
widthNOintegerThe width of the product in cms.5
heightNOintegerThe height of the product in cms.15
eanNOstringEuropean Article Number - A barcode for product identification (which helps manufacturers identify how many products have been sold once a sale is made). It is 13 digits long and required for international selling./
upcNOstringUniversal Product Code – Barcode for product identification which is used across the world. It is 12 digits long./
isbnNOstringInternational Standard Book Number – Identification barcode for books, magazines, e-books and other published media. It is 10 digits long./
colorNOstringThe colour of the product.Black
imei_serialnumberNOstringThe International Mobile Equipment Identity Number, which is used by a network to identify valid devices. E.g. if two iPhones have to be shipped, they will have 2 IMEI numbers/
cost_priceNOintegerThe manufacture cost price of the product.500
mrpNOstringMaximum Retail Price. How much is the maximum price which the product can be sold at.1000
statusNObooleanIn Boolean, if the product details have been successfully or unsuccessfully added.1
image_urlNOstringShows the URL of the product images which have been uploaded./

GET /v1/external/products/show/{product_id}

Summary: Get Specific Product Details

Use this API to get the details of a specific product. The product details will be displayed in JSON format.

You need to pass the product id in the endpoint URL for the successful call of the API. No other body parameters are required.

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/products/show/17484610

PARAMETERS /v1/external/products/show/{product_id}

POST /v1/external/products/import

Summary: Bulk Import Products

Use 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.

GET /v1/external/products/sample

Summary: Get Sample .csv Format

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.

No additional parameters are required.

GET /v1/external/listings

Summary: Get All Listings

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.

No 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.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pageNOintegerThe page number you want to display.5
per_pageNOintegerThe number of listings to get per page.2
sortNOstringThe order to sort by. Value: ASC or DESCASC
sort_byNOstringAllows you to choose the value field by which the listings will be sorted. Could be sorted by id, by sku, time created etc.sku
filterNOstringThe data to be matched for the filter value.11223344
filter_byNOstringThe filter value field . Can be id, sku, etc.id

POST /v1/external/listings/link

Summary: Map Channel Product

Use this API to map a product present in the channel catalogue to a product present in the master catalogue.

Pass the product and listing id for the successful call of the API

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
product_idYESintegerThe id of item in the master catalog.17908342
listing_idYESintegerThe id of the product in the channel catalog.15897064
IDNOintegerThe id placed in the respective ‘GET’ codes.15897064

POST /v1/external/listings/import

Summary: Import Catalog Mappings

Use this API to import a CSV file containing channel catalogue to the master catalogue mappings.

No other body parameters are required.

GET /v1/external/listings/export/mapped

Summary: Export Mapped Products

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.

The downloaded CSV file URL is shared as the response. No other body parameters are required.

GET /v1/external/listings/export/unmapped

Summary: Export Unmapped Products

Get a list of all the unmapped products in your channel catalogue using this API.

The list is downloaded into a CSV file, and the download URL is displayed as the response. No other body parameters are required.

GET /v1/external/listings/sample

Summary: Export Catalog Sample

This API displays the download link of a sample catalogue sheet for reference purposes.

No additional parameters are required.

GET /v1/external/channels

Summary: Get Integrated Channel Details

This API shows a list of all the channels that have already been integrated with your Shiprocket account.

No parameters are required to access this API.

GET /v1/external/inventory

Summary: Get Inventory Details

This API can be used to check the inventory details of a product sku. There are no required parameters for this API, but additional parameters can be used to sort and filter the data.

In case no filter conditions are passed, the details are displayed in the default JSON format.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pageNOintegerThe page number to be displayed.4
per_pageNOintegerThe total products you want to diplay in each page.2
sortNOstringSort conditions if any. Value: ASC or DESCASC
sort_byNOintegerAllows you to choose the field by which the data will be sorted. Could be sorted by id, by sku, time created etc.sku

PUT /v1/external/inventory/{product_id}/update

Summary: Update Your Inventory

This API is used to update your product inventory details.

First, you need to pass the product_id of the product in the endpoint URL. You can then set the quantity and action you want to perform on the existing inventory of the specified product.

Note:

  • The product_id can be found using the ‘Get Inventory Details’ API.
  • The id is to be passed in the endpoint URL itself.

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/inventory/17454637/update

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
quantityYESintegerThe quantity of the product you want.2
actionYESintegerThe action you want to perform. Value: - add : Adds the specific quantity to the product inventory. - replace : Replaces the existing quantity with the specified number. - remove : Removes the specific number from the product inventory.add

PARAMETERS /v1/external/inventory/{product_id}/update

GET /v1/external/countries

Summary: Get Country Codes

This API lists all the countries present in the Shiprocket database and the respective country ids, ISO 2 and ISO 3 codes.

There 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.

No parameters are required to access this API.

GET /v1/external/countries/show/{country_id}

Summary: Get All Zones

Use this API to get a further list of all the available zones within a country, along with their ids and details.

The country ID must be passed as a path parameter to access this API. No other body parameters are required.

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/countries/show/4

PARAMETERS /v1/external/countries/show/{country_id}

GET /v1/external/open/postcode/details

Summary: Get Locality Details

Use this API to get further locality details of any given postcode. Just pass the valid locality Pincode, and the details will be displayed in JSON format.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
postcodeYESintegerThe Pincode you want to get the locality details.110077

GET /v1/external/account/details/statement

Summary: Get Stament Details

Use this API to get the account statement details of your Shiprocket account. No parameters are required to access this API. However, you sort and filter the data displayed using the optional parameters.

Parameters:

PARAMSREQUIREDDATA TYPEDESCRIPTIONEXAMPLE
pageNOintegerThe page number you want to display.5
per_pageNOintegerThe number of orders to get per request.2
fromNOstringFrom a specific date.2017-08-12
toNOstringTo a specific date.2017-09-12

GET /v1/external/billing/discrepancy

Summary: Get Dicrepancy Data

Get the discrepancy data associated with your account, if any. No parameters are required to use this API.

The data is displayed in JSON format.

GET /v1/external/errors/{import_id}/check

Summary: Get File import Results

Check the import response of various file imports for any error, including bulk order imports, products and product listings.

You 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. No other body parameters are required.

Path:

EXAMPLE
https://apiv2.shiprocket.in/v1/external/errors/20212061/check

PARAMETERS /v1/external/errors/{import_id}/check

Graph View

Backlinks

  • No backlinks found