ProductInventoryDTO Object

Overview

The REST API makes extensive use of the ProductInventoryDTO object whenever working with product inventory.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

ProductInventoryDTO

The ProductInventoryDTO object will contain all of the details of a single product's inventory in your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the ProductInventoryDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
Bvin (empty string) This is the unique ID or primary key of the product inventory record.
LastUpdated UtcNow The last updated date is used for auditing purposes to know when the product inventory was last updated.
LowStockPoint 0 Determines when a product has hit a point to where it is considered to be low on stock.
OutOfStockPoint 0 The value that signifies that the product should be considered out of stock.
ProductBvin (empty string) The unique ID or Bvin of the product that this inventory relates to.
QuantityOnHand 0 The total physical count of items on hand.
QuantityReserved 0 Count of items in stock but reserved for carts or orders.
VariantId (empty string) When populated, the variant ID specifies that this record relates to a specific variant of the product.

 

Example of ProductInventoryDTO

{
   "Errors":[

   ],
   "Content":{
      "Bvin":"f82bcaad-97e4-4e03-8683-998a09346009",
      "LastUpdated":"\/Date(1401919593954)\/",
      "ProductBvin":"dfcae0ee-8bcf-4321-8b31-7883b5434285",
      "VariantId":"",
      "QuantityOnHand":100,
      "QuantityReserved":0,
      "LowStockPoint":10,
      "OutOfStockPoint":3
   }
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.