Share via

Commerce Foundation InventoryItem

  • Article

An inventory item is the inventory information for a product or product variant. This object is only accessible by using the inventory relationship of a product or product variant.

Model

This commerce entity can be modified, as required. This model, taken from the out-of-the-box site, is provided as an example.

<CommerceEntity name="InventoryItem">
        <DisplayName value="InventoryItem"/>
        <EntityMappings>
          <EntityMapping csType="Microsoft.CommerceServer.Inventory.InventorySku"
csAssembly="Microsoft.CommerceServer.Inventory">
            <PropertyMappings>
              <PropertyMapping property="Id" csProperty="SkuOid"/>
              <PropertyMapping property="Backorderable" csProperty="Backorderable"/>
              <PropertyMapping property="BackorderAvailabilityDate" csProperty="BackorderAvailabilityDate"/>
              <PropertyMapping property="BackorderedQuantity" csProperty="BackorderedQuantity"/>
              <PropertyMapping property="BackorderLimit" csProperty="BackorderLimit"/>
              <PropertyMapping property="DateModified" csProperty="SkuLastModified"/>
              <PropertyMapping property="ExcessOnHandQuantity" csProperty="ExcessOnHandQuantity"/>
              <PropertyMapping property="InventoryCatalogName" csProperty="InventoryCatalogName"/>
              <PropertyMapping property="LastRestocked" csProperty="LastRestocked"/>
              <PropertyMapping property="Memo" csProperty="Memo"/>
              <PropertyMapping property="Preorderable" csProperty="Preorderable"/>
              <PropertyMapping property="PreorderAvailabilityDate" csProperty="PreorderAvailabilityDate"/>
              <PropertyMapping property="PreorderedQuantity" csProperty="PreorderedQuantity"/>
              <PropertyMapping property="PreorderLimit" csProperty="PreorderLimit"/>
              <PropertyMapping property="ProductId" csProperty="SkuId"/>
              <PropertyMapping property="ProductCatalogName" csProperty="ProductCatalogName"/>
              <PropertyMapping property="Quantity" csProperty="OnHandQuantity"/>
              <PropertyMapping property="ReorderPoint" csProperty="ReorderPoint"/>
              <PropertyMapping property="StockStatus" csProperty="Status"/>
              <PropertyMapping property="StockOutThreshold" csProperty="StockOutThreshold"/>
              <PropertyMapping property="TargetQuantity" csProperty="TargetQuantity"/>
              <PropertyMapping property="UnitOfMeasure" csProperty="UnitOfMeasure"/>
              <PropertyMapping property="VariantId" csProperty="SkuVariantId"/>
            </PropertyMappings>
          </EntityMapping>
        </EntityMappings>
        <Properties>
          <Property name="Id" dataType="String"/>
          <Property name="Backorderable" dataType="Boolean"/>
          <Property name="BackorderAvailabilityDate" dataType="DateTime"/>
          <Property name="BackorderedQuantity" dataType="Decimal"/>
          <Property name="BackorderLimit" dataType="Decimal"/>
          <Property name="DateModified" dataType="DateTime"/>
          <Property name="ExcessOnHandQuantity" dataType="Decimal"/>
          <Property name="InventoryCatalogName" dataType="String"/>
          <Property name="LastRestocked" dataType="DateTime"/>
          <Property name="Memo" dataType="String"/>
          <Property name="Preorderable" dataType="Boolean"/>
          <Property name="PreorderAvailabilityDate" dataType="DateTime"/>
          <Property name="PreorderedQuantity" dataType="Decimal"/>
          <Property name="PreorderLimit" dataType="Decimal"/>
          <Property name="ProductId" dataType="String"/>
          <Property name="ProductCatalogName" dataType="String"/>
          <Property name="Quantity" dataType="Decimal"/>
          <Property name="ReorderPoint" dataType="Decimal"/>
          <Property name="StockStatus" dataType="Integer">
            <EnumeratedValues >
              <EnumerationEntry value ="0">
                <DisplayName value="Disabled">
                </DisplayName>
              </EnumerationEntry>
            </EnumeratedValues>
          </Property>
          <Property name="StockOutThreshold" dataType="Decimal"/>
          <Property name="TargetQuantity" dataType="Decimal"/>
          <Property name="UnitOfMeasure" dataType="String"/>
          <Property name="VariantId" dataType="String"/>
      </Properties>
</CommerceEntity>

Properties

Property

Type

Description

BackOrderable

bool?

Describes the ability to backorder this object's related product(s).

BackOrderAvailabilityDate

DateTime?

Date when this product is expected to become available.

BackOrderQuantity

decimal?

Number of back ordered products.

BackOrderLimit

decimal?

Maximum number of back ordered products.

ExcessOnHandQuanity

decimal?

Quantity of this related product's inventory in excess.

InventoryCatalogName

String

Inventory catalog name.

LastReStockedDate

DateTime?

Date this products was last restocked.

Memo

String

Free data field.

Preorderable

bool?

Specifies if this product can be ordered before it is available.

PreorderAvailabilityDate

DateTime?

Expected availability date.

PreorderQuantity

decimal?

Quantity pre-ordered.

PreorderLimit

decimal?

Maximum quantity that can be pre-ordered.

ProductCatalogName

String

Product catalog for which this stock-keeping unit (SKU) is associated.

ProductId

String

Product ID for the SKU.

Quantity

decimal?

Quantity on hand.

ReorderPoint

decimal?

Quantity at which this item should be re-ordered.

StockStatus

int?

The status of the inventory item. Options are:

0 - Disabled. The SKU is considered out of stock regardless of its current quantity.

StockOutThreshold

decimal?

Quantity at which this product should be considered out of stock.

TargetQuantity

decimal?

Desired quantity on hand.

UnitOfMeasure

String

Unit of measure for the quantity.

VariantId

String

SKU's product variant ID if this SKU is related to a variant.

Properties

PropertyCollection

Dictionary that holds all of the simple properties, for example, strings or integers, that are associated with the commerce entity.

Id

String

Unique identifier of the commerce entity. This value is derived from the SKU ID.

DateCreated

DateTime?

Gets or sets the date the commerce entity was created. Always Null for this object.

DateModified

DateTime?

Gets or sets the date the commerce entity was modified. This value is derived from LastModifed.

ModifiedBy

String

Gets or sets the modified by user. Always Null for this object.

Supported Operations

Commerce Foundation Product CommerceQuery

See Also

Other Resources

Commerce Foundation Product

Commerce Foundation Variant