Skip to content

ProductList_Adjust_Inventory#


Description#

This function allows you to add or subtract from your product inventory count.

Note

This function does not replace the total inventory count value. Instead, it adds or subtracts from the inventory count by the value sent. If you need to update the total inventory count, use the Product_Update function.

Request Body Parameters#

Parameter
Type Description
Inventory_Adjustments Object Object containing products id and adjustments to make
product_id
Edit_Product
Product_Code
Product_SKU
Number
String
String
String
ID Number of product
Product code string
Product code string
Product SKU string
adjustment Number Amount (positive or negative) to adjust the total inventory count by.

Response Parameters#

Parameter
Type Description
success boolean Boolean value for if the request was successful

Example Request#

{
    "Store_code": "beta",
    "Function": "ProductList_Adjust_Inventory",
    "Inventory_Adjustments": [
        {
            "product_id": 1,
            "adjustment": -10
        },
        {
            "product_code": "shirt",
            "adjustment": 9
        },
        {
            "product_sku": "shirt-red-blue",
            "adjustment": 0
        }
    ]
}

Example Response#

{
    "success": 1
}