POST /v1/external/orders/create

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:

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).	224477 or 224-477
`order_date`	YES	string	The date of order creation in yyyy-mm-dd format. Time is an additional option.	2019-07-24 11:11
`pickup_location`	NO	string	The 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_id`	YES	integer	The id of the specific channel to be selected.	27022
`comment`	NO	string	Option to add 'From' field to the shipment. To do this, enter the name in the following format: 'Reseller: [name].'	Reseller: Divine
`billing_customer_name`	YES	string	First name of the customer who is billed.	John
`billing_last_name`	NO	string	Last name of the billed customer.	Doe
`billing_address`	YES	string	Primary address of the billed customer. Min char: 3.	House 221B, Leaf Village
`billing_address_2`	NO	string	Further address details of the billed customer.	Near Hokage House
`billing_city`	YES	string	Billing address city. Max char: 30.	New Delhi
`billing_pincode`	YES	integer	Pincode of the billing address.	110002
`billing_state`	YES	string	Billing address state.	Delhi
`billing_country`	YES	string	Billing address country.	India
`billing_email`	YES	string	Email address of the billed customer.	John@doe.com
`billing_phone`	YES	integer	Phone number of the billed customer.	9876543210
`shipping_is_billing`	YES	boolean	Whether the shipping address is the same as billing address. 1 or 'true' for yes and 0 or 'false' for no.	true
`shipping_customer_name`	CONDITIONAL YES	string	Name of the customer the order is shipped to. Required in case billing is not same as shipping.	Jane
`shipping_last_name`	NO	string	Last name of the shipping customer.	Doe
`shipping_address`	CONDITIONAL YES	string	Address of the Shipping customer. Required in case billing is not same as shipping.	Lane 69
`shipping_address_2`	NO	string	Further address details of shipping customer.	Andheri
`shipping_city`	CONDITIONAL YES	string	Shipping address city.	Mumbai
`shipping_pincode`	CONDITIONAL YES	integer	Shipping address pincode.	200912
`shipping_country`	CONDITIONAL YES	string	Shipping address country.	India
`shipping_state`	CONDITIONAL YES	string	Shipping address state.	Maharashtra
`shipping_email`	CONDITIONAL YES	string	Email of the shipping customer.	jane@doe.com
`shipping_phone`	CONDITIONAL YES	integer	Phone no. of the shipping customer	9887655432
`order_items`	YES	/	Array containing further fields.	/
`name`	YES	string	Name of the product.	Jeans
`sku`	YES	string	The sku id of the product.	cbs123
`units`	YES	integer	No. of units that are to be shipped.	10
`selling_price`	YES	integer	The selling price per unit in Rupee. Inclusive of GST.	900
`discount`	NO	integer	The discount amount in Rupee. Inclusive of tax.	10
`tax`	NO	integer	The tax percentage on the item.	5
`hsn`	NO	integer	Harmonised System Nomenclature code. Used to determine the category of taxation the goods fall under.	44122
`payment_method`	YES	string	The method of payment. Can be either COD (Cash on delivery) Or Prepaid.	COD
`shipping_charges`	NO	integer	Shipping charges if any in Rupee.	5
`giftwrap_charges`	NO	integer	Giftwrap charges if any in Rupee.	5
`transaction_charges`	NO	integer	Transaction charges if any in Rupee.	5
`total_discount`	NO	integer	The total discount amount in Rupee.	15
`sub_total`	YES	integer	Calculated sub total amount in Rupee.	9010
`length`	YES	integer	The length of the item in cms. Must be more than 0.5.	10
`breadth`	YES	integer	The breadth of the item in cms. Must be more than 0.5.	10
`height`	YES	integer	The height of the item in cms. Must be more than 0.5.	10
`weight`	YES	integer	The weight of the item in kgs. Must be more than 0.	2.5

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
`shipping_country`	String	No
`shipping_last_name`	String	No
`shipping_phone`	String	No
`sub_total`	Number	No
`breadth`	Number	No
`shipping_city`	String	No
`shipping_is_billing`	Boolean	No
`payment_method`	String	No
`shipping_charges`	Number	No
`total_discount`	Number	No
`order_items[]`	Array	No
`order_items[].units`	Number	No
`order_items[].tax`	String	No
`order_items[].name`	String	No
`order_items[].sku`	String	No
`order_items[].selling_price`	String	No
`order_items[].hsn`	Number	No
`order_items[].discount`	String	No
`length`	Number	No
`shipping_address_2`	String	No
`billing_last_name`	String	No
`giftwrap_charges`	Number	No
`billing_state`	String	No
`billing_address`	String	No
`shipping_address`	String	No
`shipping_pincode`	String	No
`height`	Number	No
`channel_id`	String	No
`billing_address_2`	String	No
`shipping_customer_name`	String	No
`pickup_location`	String	No
`transaction_charges`	Number	No
`comment`	String	No
`shipping_state`	String	No
`order_id`	String	No
`billing_pincode`	String	No
`billing_phone`	String	No
`billing_city`	String	No
`order_date`	String	No
`shipping_email`	String	No
`weight`	Number	No
`billing_country`	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.