POST /v1/external/settings/company/addpickup
This API can be used to add a new pickup location to your account.
Pass the minimum required parameters to add the location.
Further details to the address can be added if required.
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|
pickup_location | YES | string | The nickname of the new pickup location. Max 36 characters. | Home |
name | YES | string | The shipper's name. | Deadpool |
email | YES | string | The shipper's email address. | deadpool@chimichanga.com |
phone | YES | integer | Shipper's phone number. | 9777777779 |
address | YES | string | Shipper's primary address. Max 80 characters. | Mutant Facility, Sector 3 |
address_2 | NO | string | Additional address details. | House number 34 |
city | YES | string | Pickup location city name. | Pune |
state | YES | string | Pickup location state name. | Maharashtra |
country | YES | string | Pickup location country. | India |
pin_code | YES | integer | Pickup location pincode. | 110022 |
lat | NO | float | Pickup location Latitude. | 22.4064 |
long | NO | float | Pickup location Longitude. | 69.0747 |
address_type | NO | string | To be given if address of different vendor is to be provided with pickup address | vendor |
vendor_name | NO | string | Name of vendor if address_type is vendor | John |
gstin | NO | string | gstin of vendor | 09XXXCH7409R1XXX
|
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 |
|
email |
String |
No |
|
name |
String |
No |
|
phone |
String |
No |
|
address_2 |
String |
No |
|
country |
String |
No |
|
pin_code |
String |
No |
|
state |
String |
No |
|
address |
String |
No |
|
city |
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.
