Skip to main content

Inventory

Inventory API gives you access to your warehouses and warehouse locations, so you can adjust inventory quantities and review inventory changes for products in your catalog. Inventory API allows you to update the local and supplier inventory of each product.

Can work with multiple warehouses, but also organize your warehouse and divide it to as many locations as you want to easily find the products.

Inventory allows you to track stock quantities per SKU and optionally per supplier and supplier product code. That's why there are two types of inventory: local and supplier.

Inventory can also be customer specific, i.e. reserved for a given company and/ or usergroup.

Inventory item fields

NameDescriptionRequired
id (integer)Propeller inventory record unique id.yes
productId (integer)Propeller product unique id.yes
quantity (integer)Available stock quantity.yes
costPrice (integer)Product cost price.no
Default value is 0.00
supplier (string)Supplier name. For local stock this value is always INTERN and for supplier stock by default this is the product supplier value, but also can create stock for a different suppliersyes
supplierCode (string)Suppliers' unique identifier for the productyes
sku (string)Product unique codeyes
dateModified (date)Date and time when the stock record is modified.yes
warehouseId (integer)Warehouse unique id. If warehouseId is not specified, it's set to 0 by default.yes
companyId (integer)Company specific (reserved) inventory. Quantity reserved for a given companyno
Defaults to 0
usergroupId (integer)Usergroup specific (reserved) inventory. Quantity reserved for a given usergroup. Will be deprecated in cloudno
Defaults to 0
location (string)Racks and shelves in the warehouse can be named and keep track of product stock location name.no
nextDeliveryDate (date)Expected date to receive new product stockno
notes (string)Inventory record notes.no

Identifiers

NameDescriptionRequired
id (integer)Propeller inventory record unique id.yes

Expands

NameDescriptionRequired
inventoryBalanceWith inventoryBalance expanded, detailed view of all inventory records is returned for every product.no

Inventory Errors

This section describes error codes specific for the Inventory resource.

CodeError TypeStatus CodeMessageReason
13004InventoryExists400Inventory already existsInventory already exists
13005InventoryMultipleFound400Multiple inventories found. Please provide additional filtersMultiple inventory records with such search criteria exist
13006InventoryNotFound404Inventory does not existInventory with such lookup key not found
13007InvalidInventoryType400Invalid inventory typeNot a valid inventory type