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

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:

PARAMS	REQUIRED	DATA TYPE	DESCRIPTION	EXAMPLE
`order_id`	YES	string	The 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_date`	YES	string	The date of order creation in yyyy-mm-dd format. Time is an additional option.	2019-08-05
`channel_id`	NO	integer	Id 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_name`	YES	string	The customer’s first name.	John
`pickup_last_name`	NO	string	The customer’s last name.	Doe
`company_name`	NO	string	Name of the company	Amazon
`pickup_address`	YES	string	The customer's primary address.	Home
`pickup_address_2`	NO	string	Additional customer address details.	DDA
`pickup_city`	YES	string	The customer's city name.	Delhi
`pickup_state`	YES	string	The customer's state.	New Delhi
`pickup_country`	YES	string	Customer's country name.	India
`pickup_pincode`	YES	integer	Pincode of the customer address.	110002
`pickup_email`	YES	string	Customer's email address.	john@doe.com
`pickup_phone`	YES	string	Customer's phone number.	9999999999
`pickup_isd_code`	NO	string	ISD code.	91
`shipping_customer_name`	YES	string	The name of the seller the package is shipped back to.	Jane
`shipping_last_name`	NO	string	The last name of the seller.	Doe
`shipping_address`	YES	string	The address the package is shipped to.	Castle
`shipping_address_2`	NO	string	Further shipping address details.	Bridge
`shipping_city`	YES	string	The shipping address city.	Mumbai
`shipping_country`	YES	string	The shipping address country.	India
`shipping_pincode`	YES	integer	The shipping pincode.	220022
`shipping_state`	YES	string	Shipping address state.	Maharashtra
`shipping_email`	YES	string	The email of the seller the package is shipped to.	jane@doe.com
`shipping_isd_code`	NO	string	The shipping isd code.	91
`shipping_phone`	YES	integer	Phone no. of the shipping customer	8888888888
`order_items`	YES	/	Array containing further fields.	/
`name`	YES	string	Name of the product.	ball123
`sku`	YES	string	The sku id of the product.	Tennis Ball
`units`	YES	integer	No of units that are to be shipped.	1
`selling_price`	YES	integer	The selling price per unit in Rupee. Inclusive of GST.	10
`discount`	NO	integer	The discount amount in Rupee. Inclusive of tax.	0
`hsn`	NO	string	Harmonised System Nomenclature code. Used to determine the category of taxation the goods fall under.	4412
`qc_enable`	CONDITIONAL YES	string	If True, QC will be performed for that product and QC will be performed only for a single SKU per order	TRUE/FALSE
`qc_color`	NO	varchar(180)	The color of the product can be passed in this parameter	Red
`qc_brand`	NO	varchar(255)	The brand of the product can be passed in this parameter	768903
`qc_serial_no`	NO	varchar(255)	The serial number of the product can be passed in this parameter	T13123124
`qc_ean_barcode`	NO	varchar(255)	EAN/Barcode of the product can be passed in this parameter	QWRE123
`qc_size`	NO	varchar(180)	The size of the product can be passed in this parameter	8
`qc_product_name`	NO	varchar(255)	If qc_enable set True, then Product name should be passed in this parameter	Shoes
`qc_product_image`	NO	varchar(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_method`	YES	string	The method of payment. Can be either COD (Cash on delivery) Or Prepaid.	Prepaid
`total_discount`	NO	string	The total discount amount in Rupee.	0
`sub_total`	YES	integer	Calculated sub total amount in Rupee after deductions.	10
`length`	YES	integer	The length of the shipment in cms.	10
`breadth`	YES	integer	The breadth of the shipment in cms.	15
`height`	YES	integer	The height of the shipment in cms.	20
`weight`	YES	integer	The shipment weight in kgs.	1
`request_pickup`	NO	boolean	Use false if you dont want to request pickup. Default value is true.	true

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
`pickup_city`	String	No
`pickup_phone`	String	No
`shipping_country`	String	No
`shipping_last_name`	String	No
`pickup_email`	String	No
`shipping_phone`	Number	No
`sub_total`	Number	No
`request_pickup`	Boolean	No
`breadth`	Number	No
`shipping_city`	String	No
`payment_method`	String	No
`total_discount`	String	No
`pickup_state`	String	No
`pickup_last_name`	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`	Number	No
`order_items[].qc_product_name`	String	No
`order_items[].qc_brand`	String	No
`order_items[].qc_enable`	Boolean	No
`order_items[].qc_product_image`	String	No
`order_items[].discount`	Number	No
`length`	Number	No
`shipping_address_2`	String	No
`pickup_address`	String	No
`shipping_address`	String	No
`pickup_address_2`	String	No
`shipping_pincode`	Number	No
`height`	Number	No
`channel_id`	String	No
`shipping_isd_code`	String	No
`shipping_customer_name`	String	No
`pickup_isd_code`	String	No
`pickup_pincode`	Number	No
`shipping_state`	String	No
`order_id`	String	No
`pickup_customer_name`	String	No
`company_name`	String	No
`order_date`	String	No
`shipping_email`	String	No
`weight`	Number	No
`pickup_country`	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.