Skip to main content

Update Product Local Inventory

Legacy Documentation

You are viewing legacy documentation. These APIs are maintained for partners with existing implementations. New projects should use v2.

View the current GraphQL API Reference → | View the current REST API Reference →

PATCH 
/products/:lookupkey/:key/inventory/local

This endpoint allows updating local inventory data for a product based on a lookup key.

Available fields​

NameRequired
quantity (integer)no
warehouseId (integer)no
Default value is 0
company (InventoryCompanyUsergroupResource)no
usergroup (InventoryCompanyUsergroupResource)no
location (string)no
Default value is empty
costPrice (integer)no
Default value is product costprice
nextDeliveryDate (date)no
notes (string)no

dateModified is always updated with the current date and time.

Inventory will be updated if record is found, matching on: product sku, warehouseId and location. Error is thrown if record can't be found.

Fields warehouseId and location can't be updated, used only to find the correct inventory record.

Request​

Responses​

Update Product Local Inventory - 200 / Update Product Local Inventory for a usergroup - 200

Response Headers
    Connection
    Content-Length
    Date
    Keep-Alive
    Return-Format