Newer Version Available

This content describes an older version of this product. View Latest

ProductItem

Represents the stock of a product at a particular inventory location, such as a warehouse or a distribution lot. Product item records represent your inventory. A product item is associated with an inventory location and stores the quantity of products at that location. This object is available in API version 60.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
IsProduct2Serialized
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies if the product associated with the product item is a serialized product (true) or not (false).
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly.
LocationId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The location that’s associated with the product item. This usually indicates where the product item is stored.
This field is a relationship field.
Relationship Name
Location
Relationship Type
Lookup
Refers To
Location
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the product item.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
Product2Id
Type
reference
Properties
Create, Filter, Group, Sort
Description
The product that’s associated with the product item. This usually represents the type of product in your inventory.
This field is a relationship field.
Relationship Name
Product2
Relationship Type
Lookup
Refers To
Product2
ProductItemNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The auto-generated number identifying the product item.
ProductName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the product item. We recommend you use a name that indicates the name of the product along with its location.
QuantityOnHand
Type
double
Properties
Create, Filter, Sort, Update
Description
The quantity at the location. If you want to add a serial number, this value must be 1.
QuantityUnitOfMeasure
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unit of the quantity of the product that’s consumed. For example, kilograms or liters. Quantity Unit of Measure values are inherited from the Quantity Unit of Measure field on products.
Possible values are:
  • Each
SerialNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A unique number for identification purposes. If you want to enter a serial number, the Quantity on Hand must be 1.