POST /v1/external/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.

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`	String	No
`order_items[].tax`	String	No
`order_items[].name`	String	No
`order_items[].sku`	String	No
`order_items[].selling_price`	Number	No
`order_items[].hsn`	String	No
`order_items[].discount`	String	No
`length`	Number	No
`shipping_address_2`	String	No
`billing_last_name`	String	No
`giftwrap_charges`	Number	No
`billing_alternate_phone`	String	No
`billing_state`	String	No
`billing_isd_code`	String	No
`billing_address`	String	No
`shipping_address`	String	No
`shipping_pincode`	String	No
`reseller_name`	String	No
`height`	Number	No
`channel_id`	String	No
`customer_gstin`	String	No
`ewaybill_no`	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
`company_name`	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.