commerce/catalog/admin/locationinventory

Use the Location Inventory resource to manage the level of active product inventory maintained at each defined location, at the location 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.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

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 %7blocationCode%7d%3fperformUpserts%3d%7bperformUpserts%7d

Creates an array of product inventory definitions for the location specified in the request. When adding a new inventory definition, you must specify the productCode and stockOnHand value in each array you define. All other properties are system-supplied and read only.

DeleteLocationInventory DELETE %7blocationCode%7d%2f%7bproductCode%7d

Deletes the product code inventory definition for the location specified in the request.

GetLocationInventories GET %7blocationCode%7d%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26filterFunctions%3d%7bfilterFunctions%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of all product inventory definitions for the location code specified in the request.

GetLocationInventory GET %7blocationCode%7d%2f%7bproductCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a product's active inventory at the location specified in the request.

UpdateLocationInventory PUT %7blocationCode%7d

Updates the active stock on hand inventory of products for the location code specified in the request.