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

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:

PARAMS	REQUIRED	DATA TYPE	DESCRIPTION	EXAMPLE
`order_id`	YES	string	The 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_date`	YES	string	The date of order creation in yyyy-mm-dd format. Time is additional.	2019-07-24 11:11
`pickup_location`	YES	string	The name of the pickup location added in your Shiprocket account. This cannot be a new location.	Jammu
`channel_id`	NO	integer	Mention this in case you need to assign the order to a particular channel. Deafult is 'Custom'.	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
`reseller_name`	NO	string	The 'from' name if you want to print. Use 'Reseller: [name]'	Reseller: Divine
`company_name`	NO	string	Name of the company.	Amazon
`billing_customer_name`	YES	string	First name of the billed customer.	John
`billing_last_name`	NO	string	Last name of the billed customer.	Doe
`billing_address`	NO	string	address details of the billed customer.	Civil line, House 20
`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	The phone number of the billing customer.	9856321472
`billing_alternate_phone`	NO	integer	Alternate phone number of the billing customer.	8604690454
`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 number 69
`shipping_address_2`	NO	string	Further address details of shipping customer.	Andheri
`billing_isd_code`	NO	string	ISD code of the billing address.	+91
`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.
`longitude`	NO	float	Destination (Shipping address) Longitude.	69.0747
`latitude`	NO	float	Destination (Shipping address) Latitude	22.4064
`order_items`	YES	/	List of items and their relevant fields in the form of Array.	/
`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 after deductions.	9010
`length`	YES	float	The length of the item in cms. Must be more than 0.5.	10
`breadth`	YES	float	The breadth of the item in cms. Must be more than 0.5.	10
`height`	YES	float	The height of the item in cms. Must be more than 0.5.	10
`weight`	YES	float	The weight of the item in kgs. Must be more than 0.	2.5
`ewaybill_no`	NO	string	Details relating to the shipment of goods. .	K92373490
`customer_gstin`	NO	string	Goods and Services Tax Identification Number.	29ABCDE1234F2Z5
`invoice_number`	NO	string
`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
`checkout_shipping_method`	NO	string	Only 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_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
purpose_of_shipment	NO	interger	The purpose of the shipment. values are 0 - gift, 1- sample, commercial - 2.	1
currency	YES	string	The currency of the order. Possible values are INR,USD,GBP, EUR, AUD, CAD, SAR, AED,SGD	USD
reasonOfExport	YES	integer	The reason for the export. Possible values are 0 - BONAFIDE_SAMPLE, 1 - SAMPLE, 2 - GIFT, 3 - COMMERCIAL	2
commodity	NO	boolean	Indicates if the order is a commodity or not	true
mies	NO			true
igstPaymentStatus	NO	char	possible values are 'A'- not applicable, 'B'- LUT or Export under Bond, 'C'- Export Against Payment of IGST	A
Terms_Of_Invoice	YES	string	FOB and CIF	FOB
ioss	YES	string
eori	YES	string

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"
	String	No

Request body fields

Name	Type	Required
`shipping_last_name`	String	No
`sub_total`	Number	No
`is_document`	Number	No
`breadth`	Number	No
`landmark`	String	No
`shipping_city`	String	No
`shipping_charges`	Number	No
`order_items[]`	Array	No
`order_items[].units`	String	No
`order_items[].tax`	String	No
`order_items[].name`	String	No
`order_items[].sku`	String	No
`order_items[].selling_price`	String	No
`order_items[].category_id`	String	No
`order_items[].hsn`	String	No
`order_items[].caetgroy_code`	String	No
`order_items[].category_name`	String	No
`order_items[].discount`	String	No
`order_type`	Number	No
`shipping_address_2`	String	No
`billing_last_name`	String	No
`billing_alternate_phone`	String	No
`is_insurance_opt`	Boolean	No
`billing_address`	String	No
`shipping_pincode`	String	No
`height`	Number	No
`channel_id`	Number	No
`billing_address_2`	String	No
`order_tag`	String	No
`shipping_state`	String	No
`pickup_location_id`	Number	No
`order_id`	Number	No
`company_name`	String	No
`billing_city`	String	No
`weight`	Number	No
`shipping_country`	String	No
`reasonOfExport`	Number	No
`shipping_phone`	Number	No
`shipping_is_billing`	Number	No
`purpose_of_shipment`	Number	No
`currency`	String	No
`total_discount`	Number	No
`isd_code`	String	No
`length`	Number	No
`giftwrap_charges`	Number	No
`billing_state`	String	No
`billing_isd_code`	String	No
`shipping_address`	String	No
`reseller_name`	String	No
`customer_gstin`	String	No
`ewaybill_no`	String	No
`shipping_customer_name`	String	No
`delivery_challan`	Boolean	No
`is_order_revamp`	Number	No
`transaction_charges`	Number	No
`product_category`	String	No
`billing_pincode`	String	No
`order_date`	String	No
`shipping_email`	String	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.