PATCH /v1/external/orders/address/pickup
Using this API, you can modify the pickup location of an already created order. Multiple order ids can be passed to update their pickup location together.
Note:
- Pickup location can only be changed/updated to an already existing pickup location in your account.
- The 'order_id' to be passed is the Shiprocket order_id received at the time of order creation.
- Multiple order ids can be passed as an array, separated by commas. eg: ["141414,142424,143434"]
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|---|
order_id | YES | integer | The Shiprocket order_id specified to the order. | 16167171 |
pickup_location | YES | string | The pickup location you want to change your current pickup location to. | Delhi |
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 |
|---|---|---|---|
pickup_location |
String | No | |
order_id |
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.