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

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:

PARAMS	REQUIRED	DATA TYPE	DESCRIPTION	EXAMPLE
`mode`	NO	string	The mode of shipment, either surface or air. Value: Surface or Air	Air
`request_pickup`	NO	boolean	Use false if you dont want to request pickup. Default value is true.	true
`print_label`	NO	boolean	Use false if you dont want to print label. Default value is true.	true
`generate_manifest`	NO	boolean	Use false if you dont want to generate manifest. Default value is true.	true
`ewaybill_no`	NO	string	Details relating to the shipment of goods.	K92373490
`courier_id`	NO	integer	The courier id of the courier you want to assign. Refer to the servicability API to get id.	10
`reseller_name`	NO	string	The 'from' name if you want to print. Use 'Reseller: [name]'	Reseller: Divine
`order_id`	YES	string	The custom reference id you want to assign to the order.	2477
`isd_code`	NO	string	The isd code	91
`billing_isd_code`	NO	string	The billing isd code.	91
`order_date`	YES	string	The date of the creation of order.	2019-08-04
`channel_id`	NO	integer	The channel id of the specific channel. Use the Channels API to get id.	72505
`company_name`	NO	string	Name of the company.	Amazon
`billing_customer_name`	YES	string	The first name of customer to be billed.	John
`billing_last_name`	NO	string	The last name of the billing customer.	Doe
`billing_address`	YES	string	The primary billing address.	House no 21
`billing_address_2`	NO	string	Additional billing address details.	Street 2, Dwarka
`billing_city`	YES	string	The billing city.	Delhi
`billing_state`	YES	string	The billing address state.	New Delhi
`billing_country`	YES	string	The billing address country.	India
`billing_pincode`	YES	integer	The pincode of the billing address.	110002
`billing_email`	YES	string	The billing customer email.	john@doe.com
`billing_phone`	YES	integer	The billing customer phone.	9999998899
`billing_alternate_phone`	NO	integer	The billing customer alternate phone.	8404690454
`shipping_is_billing`	YES	boolean	Whether shipping details are the same as billing details. true for yes false for no.	true
`shipping_customer_name`	CONDITIONAL YES	string	Shipping customer's first name.	Jane
`shipping_last_name`	NO	string	Shipping customer's last name.	Doe
`shipping_address`	CONDITIONAL YES	string	The shipping address.	House no X
`shipping_address_2`	NO	string	Additional shipping address details.	Street X
`shipping_city`	CONDITIONAL YES	string	The shipping city.	Mumbai
`shipping_state`	CONDITIONAL YES	string	The state of the shipping address.	Maharashtra
`shipping_country`	CONDITIONAL YES	string	The shipping address country.	India
`shipping_pincode`	CONDITIONAL YES	integer	Shipping pincode.	230023
`shipping_email`	CONDITIONAL YES	string	The email of the shipping customer.	Jane@Doe.com
`shipping_phone`	CONDITIONAL YES	integer	The phone number of the shipping customer.	8877997799
`order_items`	YES	/	Array containing further parameters.	/
`name`	YES	string	The name of the product.	Jeans
`sku`	YES	string	sku Code of the product.	Bat
`units`	YES	integer	Number of units.	10
`hsn`	NO	integer	HSN code if available.	4412
`selling_price`	YES	string	The selling price of each unit inclusive of GST.	200
`tax`	NO	integer	The tax applied in percent.	20
`discount`	NO	integer	The discount amount inclusive of tax.	20
`payment_method`	YES	string	If the payment method is Cash on delivery (COD) or Prepaid.	COD
`shipping_charges`	NO	integer	The shipping charges if any in rupees.	5
`giftwrap_charges`	NO	integer	The gift-wrap charges if any in rupees.	5
`transaction_charges`	NO	integer	The transaction charges if any in rupees.	10
`total_discount`	NO	integer	The discount amount in rupees.	15
`sub_total`	YES	integer	The sub total amount in rupees.	1800
`weight`	YES	string	The weight of the shipment in kgs.	2
`length`	YES	integer	The length of the shipment in cms. Must be more than 0.5	10
`breadth`	YES	integer	The breadth of the shipment in cms. Must be more than 0.5	15
`height`	YES	integer	The height of the shipment in cms. Must be more than 0.5	20
`pickup_location`	YES	string	The 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_gstin`	NO	string	Goods and Services Tax Identification Number.	29ABCDE1234F2Z5
`vendor_details`	NO	/	Array containing further parameters. Use to assign/add a new pickup location to your account.	/
`email`	CONDITIONAL YES	string	The shipper's email address.	john@doe.com
`phone`	CONDITIONAL YES	integer	The shipper's phone number.	8888999888
`name`	CONDITIONAL YES	string	The shipper's name.	John Doe
`address`	CONDITIONAL YES	string	The pickup location address. Min 10 characters.	Office Building
`address_2`	NO	string	Additional address details. Min 10 characters.	Street 2 house 4
`city`	CONDITIONAL YES	string	The pickup location city.	Pune
`state`	CONDITIONAL YES	string	The pickup state.	Maharashtra
`country`	CONDITIONAL YES	string	The pickup location country.	India
`pin_code`	CONDITIONAL YES	integer	The pickup pincode.	200099
`pickup_location`	CONDITIONAL YES	string	New pickup location name. Max: 36 char. Alphanumeric only.	New Office
`order_type`	NO	string	Key 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
`longitude`	NO	float	Destination (Shipping address) Longitude.	69.0747
`latitude`	NO	float	Destination (Shipping address) Latitude	22.4064
`what3words_address`	NO	string	What3words 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

Servers

https://apiv2.shiprocket.in

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required
`billing_email`	String	No
`height`	Number	No
`channel_id`	String	No
`sub_total`	Number	No
`breadth`	Number	No
`shipping_is_billing`	Boolean	No
`payment_method`	String	No
`vendor_details`	Object	No
`vendor_details.pickup_location`	String	No
`vendor_details.email`	String	No
`vendor_details.name`	String	No
`vendor_details.phone`	Number	No
`vendor_details.address_2`	String	No
`vendor_details.country`	String	No
`vendor_details.pin_code`	String	No
`vendor_details.state`	String	No
`vendor_details.address`	String	No
`vendor_details.city`	String	No
`order_id`	String	No
`order_items[]`	Array	No
`order_items[].units`	Number	No
`order_items[].name`	String	No
`order_items[].sku`	String	No
`order_items[].selling_price`	String	No
`billing_pincode`	String	No
`length`	Number	No
`billing_last_name`	String	No
`billing_phone`	String	No
`billing_city`	String	No
`billing_state`	String	No
`order_date`	String	No
`weight`	Number	No
`billing_country`	String	No
`billing_address`	String	No
`billing_customer_name`	String	No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.