Products | Inventory

Patch an inventory item - update only the values present in the request. Only updates items that already exist - does not create new inventory entries. The item is identified by SkuId and WarehouseCode (and optionally VirtualWarehouseCode). Quantities (Inventory / ReservedInventory) are not patchable here - use ProcessInventoryTransactions (delta) or UpdateMany (total) for those.

patch/api/Inventory

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Inventory
  • Auth: API key in header Authorization

Request body

skuIdstring required

Primary identifier for the inventory item, should represent the product SKU / Code / Variant / ID. Required to identify the item to patch.

warehouseCodestring required

Warehouse Code / ID. Required to identify the item to patch.

virtualWarehouseCodestring nullable

Only in use with virtual stock locations in Omnium. Specifies the virtual warehouse location of a virtual inventory item.

locationstring nullable

Item (warehouse) location

costnumber nullable

The cost price per unit for this inventory item

costCurrencystring nullable

The currency of the cost price

minQuantitynumber nullable

Minimum inventory quantity

maxQuantitynumber nullable

Max inventory quantity

reorderMinQuantitynumber nullable

Minimum number of items to order

disableReorderSuggestionsboolean nullable

When true, no reorder suggestions are generated for this inventory item (SKU/warehouse combination). Supports FieldsToForceNull.

calculatedInventorynumber nullable

Calculated inventory (used for packages where available inventory is calculated from components)

keepExistingPropertiesboolean nullable

Set to 'false' if you want to replace the whole 'Properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.

fieldsToForceNullstring[] nullable

Force nullable fields to null. Use the property path, e.g. "Location", "CostCurrency", "Properties" or "Atp".

Response

Inventory item patch processed (see result for details)

totalCountinteger

Total number of inventory items processed

updatedCountinteger

Number of inventory items updated

unchangedCountinteger

Number of inventory items unchanged

notFoundCountinteger

Number of inventory items not found

notFoundIdsstring[] nullable

List of inventory item IDs that were not found

errorCountinteger

Number of errors encountered

errorMessagestring nullable

Error messages

isModifiedboolean

True if any inventory item was modified

Changes

No recorded changes to this operation across all 1 revision of this API.