commerce/catalog/admin/products/LocationInventory
Use the Product Location Inventory resource to manage the levels of active product inventory to maintain across defined locations at the product level.
JSON Example
LocationInventory Properties
| Property | Description |
|---|---|
| auditInfo |
type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. |
| auditInfo |
type: string Identifier of the user that created the object. System created and read only. |
| auditInfo |
type: DateTime The date and time in UTC format set when the object was created. |
| auditInfo |
type: string Identifier of the user that updated the entity most recently. |
| auditInfo |
type: DateTime The date and time in UTC format the object was updated most recently. |
| baseProductCode |
type: string Product code defined by the tenant administrator to use as a base prefix when generating product codes for any variations of this product. |
| locationCode |
type: string The unique, user-defined code that identifies a location. This location can be the location where the order was entered, location for newly in-stock products, and where products are returned. |
| productCode |
type: string The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product. |
| productName |
type: string The name of the product that represents a line item in a taxable order or product bundle. |
| stockAvailable |
type: int The stock level for the associated product currently available, at specified locations, and based on the number of pending product reservations as applicable. System-supplied and read only. |
| stockOnBackOrder |
type: int The stock level for the associated product currently on back order for this location, based on the number of pending product reservations. System-supplied and read only. |
| stockOnHand |
type: int The current physical stock level for the associated product, which does not account for pending product reservations. |
Operations
| Operation Name | Request URI | Description |
|---|---|---|
| AddLocationInventory | POST %7bProductCode%7d%2fLocationInventory%3fperformUpserts%3d%7bperformUpserts%7d |
Creates a new location inventory definition for the product code specified in the request. |
| DeleteLocationInventory | DELETE %7bProductCode%7d%2fLocationInventory%2f%7bLocationCode%7d |
Deletes the location inventory definition for the product code specified in the request. |
| GetLocationInventories | GET %7bProductCode%7d%2fLocationInventory%2f%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d |
Retrieves all locations for which a product has inventory defined and displays the inventory definition properties of each location. |
| GetLocationInventory | GET %7bProductCode%7d%2fLocationInventory%2f%7bLocationCode%7d%3fresponseFields%3d%7bresponseFields%7d |
Retrieves the details of the inventory of the product in the location specified in the request. |
| UpdateLocationInventory | PUT %7bProductCode%7d%2fLocationInventory |
Updates the current level of stock at each location associated with the product code specified in the request. |