PATCH /v1/external/orders/fulfill
Use this API to add inventory for ordered products that are out of stock or low on quantity. You have to pass the order id and order product id. You can also specify the number of items.
Notes:
- Inventory sync of your account must be turned on to use this API.
- The order_id to be passed is the shiprocket order id. If you don't know the product id, Use the 'Get Product Details' API to get details about all the existing products.
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|---|
order_id | YES | integer | The Shiprocket order_id specified to the order. | 16167171 |
order_product_id | YES | integer | The product id of the product to be added. | 17171717 |
quantity | YES | string | The number of items you want to add. | 10 |
action | YES | string | The action you want to carry out. Is 'add'. | add |
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 |
|---|---|---|---|
data[] |
Array | No | |
data[].order_id |
Number | No | |
data[].action |
String | No | |
data[].quantity |
String | No | |
data[].order_product_id |
Number | 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.