POST /v1/external/orders/address/update
You can update the customer's name and delivery address through this API by passing the Shiprocket order id and the necessary customer details.
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|
order_id | YES | integer | The Shiprocket order_id specified to the order. | 16178831 |
shipping_customer_name | YES | string | The name of the customer. | John Doe |
shipping_phone | YES | integer | Phone number of the customer. | 9988998899 |
shipping_address | YES | string | Primary address of the customer. | House no 123 |
shipping_address_2 | NO | string | Further address details of the customer. | Beside CM house |
shipping_city | YES | string | Shipping city name. | Pune |
shipping_state | YES | string | Shipping state name. | Maharashtra |
shipping_country | YES | string | Shipping country name. | India |
shipping_pincode | YES | integer | Shipping address pincode. | 120023 |
shipping_email | NO | string | Customer's email address. | john@doe.com |
billing_alternate_phone | NO | string | The customer alternate phone. | 8604690454 |
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 |
Description |
shipping_address |
String |
No |
|
shipping_state |
String |
No |
|
shipping_country |
String |
No |
|
shipping_pincode |
Number |
No |
|
order_id |
Number |
No |
|
shipping_address_2 |
String |
No |
|
shipping_phone |
String |
No |
|
shipping_city |
String |
No |
|
shipping_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.
