InventoryItemLocations
Returns and updates the inventory settings for catalog items at each location.
Table Specific Information
Select
The add-in uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Sku supports the = and IN comparisons.
- VariantId supports the = and IN comparisons.
- ProductId supports the = and IN comparisons.
- LocationId supports the = and IN comparisons.
- LocationCode supports the = and IN comparisons.
The rest of the filter is executed client-side within the add-in.
For example, the following queries are processed server-side:
SELECT * FROM InventoryItemLocations WHERE Sku = 'SKU-1'
SELECT * FROM InventoryItemLocations WHERE LocationId = 1
Update
InventoryItemLocations does not support creating or deleting inventory records; only the inventory settings for an existing item at a location can be updated. InventoryItemLocations has no single Id column; a value for LocationId is required, along with either Sku, ProductId, or VariantId to identify the item.
UPDATE InventoryItemLocations SET SafetyStock = 5, WarningLevel = 10 WHERE Sku = 'SKU-1' AND LocationId = 1
Columns
| Name | Type | ReadOnly | Description |
| Sku [KEY] | String | False |
The SKU of the catalog item. A value for this column, ProductId, or VariantId is required, along with LocationId, to update the inventory settings for this item. |
| VariantId | Integer | True |
The Id of the product variant. |
| ProductId | Integer | True |
The Id of the product. |
| LocationId [KEY] | Integer | True |
The Id of the location this inventory record belongs to. |
| LocationCode | String | True |
The code of the location this inventory record belongs to. |
| LocationName | String | True |
The name of the location this inventory record belongs to. |
| LocationEnabled | Boolean | True |
Whether the location is active. |
| AvailableToSell | Integer | True |
The quantity on hand minus safety stock, available to sell. |
| TotalInventoryOnHand | Integer | True |
The total quantity of inventory on hand at this location. |
| SafetyStock | Integer | False |
The quantity to reserve as a buffer that is not available to sell. |
| IsInStock | Boolean | False |
Whether the item is marked as in stock at this location. |
| WarningLevel | Integer | False |
The low-stock warning threshold for this item at this location. |
| BinPickingNumber | String | False |
The bin picking number for this item at this location. |