Increase or decrease the product's stock quantity by a delta quantity.
When your integration changes in stock quantity of products in a store pretty often, it becomes harder and harder to keep track of how many items are actually in stock. For example, when at one point of time you have 3 items in stock and 5 in the very next second, then using the specific values can result in incorrect stock quantity.
This method solves this very problem: you can increase or decrease the product's stock quantity by a delta quantity. For example, if you need to decrease quantity by 10 items, you can use this method.
This method is also available for the variation inventory
You can use the checkLowStockNotification as a request parameter. If true, makes Ecwid check whether the low stock email notification needs to be sent to merchant after request is sent.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token. |
Request
A JSON object of type 'Inventory' with the following fields:
Inventory
| Field | Type | Description |
|---|---|---|
| quantityDelta | number | Delta value used to update product quantity. Negative value will decrease quantity, positive one will increase it. |
Response
A JSON object of type 'InventoryAdjustmentStatus' with the following fields:
InventoryAdjustmentStatus
| Field | Type | Description |
|---|---|---|
| updateCount | number | The number of updated products (1 or 0 depending on whether the update was successful) |
| warning | string | Inventory update warning(optional). For example, the warning will display if the stock became negative |
Errors
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
HTTP codes
| HTTP Status | Description |
|---|---|
| 400 | Request parameters are malformed |
| 403 | Access token doesn't have update_catalog scope |
| 404 | Product not found |
| 415 | Unsupported content-type: expected application/json or text/json |
| 500 | Could not process the request, internal server error |
Error response body (optional)
| Field | Type | Description |
|---|---|---|
| errorMessage | string | Error message |