PUT products/{productid}/stocklocationinventory

This call allows you to update the inventory of an individual product by Product ID. If a stock location is supplied that the product is not yet associated with, the product is automatically added to that stock location before the adjustment is applied - there is no need to associate the location with the product first. The stock location must be in a warehouse that the product already exists in - unlike the bulk call, this one will not add the product to a new warehouse.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
productid The product ID to update integer Required

Body Parameters

The type of adjustment that you would like to perform

StockLocationInventoryUpdateModel
NameDescriptionTypeAdditional information
AdjustmentType This type of adjustment that you wish to perform. This can either be absolute or relative. InventoryAdjustmentTypeEnum Required
AdjustmentAmount The amount that you want to adjust by. integer Required
StockLocationID The stock location that you want to apply the inventory update to. Leave null for Unspecified Location StockLocationProductIDTypeModel None.
Reason This is an optional value. This is the reason that you made the adjustment. string None.

Request Formats

application/json, text/json

Sample: 
{
  "AdjustmentType": "RelativeAdjustment",
  "AdjustmentAmount": -1,
  "StockLocationID": {
    "IDType": "StockLocationReference",
    "Value": "A-1"
  },
  "Reason": "Wastage 1 item was damaged."
}

application/xml, text/xml

Sample: 
<StockLocationInventoryUpdateModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AdjustmentType>RelativeAdjustment</AdjustmentType>
  <AdjustmentAmount>-1</AdjustmentAmount>
  <StockLocationID>
    <IDType>StockLocationReference</IDType>
    <Value>A-1</Value>
  </StockLocationID>
  <Reason>Wastage 1 item was damaged.</Reason>
</StockLocationInventoryUpdateModel>

Response Information

Resource Description

This call allows you to update the inventory of an individual product by Product ID. If a stock location is supplied that the product is not yet associated with, the product is automatically added to that stock location before the adjustment is applied - there is no need to associate the location with the product first. The stock location must be in a warehouse that the product already exists in - unlike the bulk call, this one will not add the product to a new warehouse.

StockLocationInventoryUpdateModelResponse
NameDescriptionTypeAdditional information
Adjustment The adjustment that was to be made StockLocationInventoryUpdateModel None.
NewStockLocationInventory If the adjustment was successful this will contain the new Stock Location Inventory integer None.
NewProductTotalInventory If the adjustment was successful this will contain the new Total Product Inventory integer None.
Success Whether the action was successful boolean None.
Error Any errors that were received Success will always be false if an error is returned. string None.

Response Formats

application/json, text/json

Sample: 
{
  "Adjustment": {
    "AdjustmentType": "RelativeAdjustment",
    "AdjustmentAmount": -1,
    "StockLocationID": {
      "IDType": "StockLocationReference",
      "Value": "A-1"
    },
    "Reason": "Wastage 1 item was damaged."
  },
  "NewStockLocationInventory": 9,
  "NewProductTotalInventory": 19,
  "Success": true,
  "Error": ""
}

application/xml, text/xml

Sample: 
<StockLocationInventoryUpdateModelResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <Error />
  <Adjustment>
    <AdjustmentType>RelativeAdjustment</AdjustmentType>
    <AdjustmentAmount>-1</AdjustmentAmount>
    <StockLocationID>
      <IDType>StockLocationReference</IDType>
      <Value>A-1</Value>
    </StockLocationID>
    <Reason>Wastage 1 item was damaged.</Reason>
  </Adjustment>
  <NewStockLocationInventory>9</NewStockLocationInventory>
  <NewProductTotalInventory>19</NewProductTotalInventory>
</StockLocationInventoryUpdateModelResponse>