PUT /v1/external/inventory/{product_id}/update
This API is used to update your product inventory details.
First, you need to pass the product_id of the product in the endpoint URL.
You can then set the quantity and action you want to perform on the existing inventory of the specified product.
Note:
- The product_id can be found using the 'Get Inventory Details' API.
- The id is to be passed in the endpoint URL itself.
Path:
EXAMPLE |
---|
https://apiv2.shiprocket.in/v1/external/inventory/17454637/update |
Parameters:
PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
---|
quantity | YES | integer | The quantity of the product you want. | 2 |
action | YES | integer | The action you want to perform. Value: - add : Adds the specific quantity to the product inventory. - replace : Replaces the existing quantity with the specified number. - remove : Removes the specific number from the product inventory. | add |
Servers
- https://apiv2.shiprocket.in
Path parameters
Name |
Type |
Required |
Description |
product_id |
String |
Yes |
|
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 |
action |
String |
No |
|
quantity |
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.