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

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.

PARAMS	REQUIRED	DATA TYPE	DESCRIPTION	EXAMPLE
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	No	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	boolean		true
igstPaymentStatus	YES	char	possible values are 'A'- not applicable, 'B'- LUT or Export under Bond, 'C'- Export Against Payment of IGST	A
Terms_Of_Invoice	no	string	The term of invoice either FOB and CIF	FOB

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_last_name`	String	No
`sub_total`	Number	No
`is_document`	Number	No
`breadth`	Number	No
`landmark`	String	No
`shipping_city`	String	No
`payment_method`	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
`billing_phone`	Number	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.