product EntityType
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Description: Information about products and their pricing information.
Entity Set path:[organization URI]/api/data/v8.2/products
Base Type: crmbaseentity EntityType
Display Name: Product
Primary Key: productid
Primary Name Attribute: name
Properties
Lookup Properties
Single-valued navigation properties
Collection-valued navigation properties
Operations bound to product
Operations using the product entity type.
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
Name |
Type |
Details |
|---|---|---|
createdon |
Edm.DateTimeOffset |
Description: Date and time when the product was created. Display Name: Created On Read-only property |
currentcost |
Edm.Decimal |
Description: Current cost for the product item. Used in price calculations. Display Name: Current Cost |
currentcost_base |
Edm.Decimal |
Description: Base currency equivalent of the current cost for the product item. Display Name: Current Cost (Base) Read-only property |
description |
Edm.String |
Description: Description of the product. Display Name: Description |
dmtimportstate |
Edm.Int32 |
Description: Internal Use Only Display Name: Internal Use Only |
entityimage |
Edm.Binary |
Description: Shows the default image for the record. Display Name: Entity Image |
entityimage_timestamp |
Edm.Int64 |
Description: Read-only property |
entityimage_url |
Edm.String |
Description: Read-only property |
entityimageid |
Edm.Guid |
Description: For internal use only. Display Name: Entity Image Id Read-only property |
exchangerate |
Edm.Decimal |
Description: Exchange rate for the currency associated with the product with respect to the base currency. Display Name: Exchange Rate Read-only property |
hierarchypath |
Edm.String |
Description: Hierarchy path of the product. Display Name: Hierarchy Path Read-only property |
importsequencenumber |
Edm.Int32 |
Description: Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
iskit |
Edm.Boolean |
Description: Information that specifies whether the product is a kit. Default Options: 1 : Yes Display Name: Is Kit |
isstockitem |
Edm.Boolean |
Description: Information about whether the product is a stock item. Default Options: 1 : Yes Display Name: Stock Item |
modifiedon |
Edm.DateTimeOffset |
Description: Date and time when the product was last modified. Display Name: Modified On Read-only property |
name |
Edm.String |
Description: Name of the product. Display Name: Name |
overriddencreatedon |
Edm.DateTimeOffset |
Description: Date and time that the record was migrated. Display Name: Record Created On |
price |
Edm.Decimal |
Description: List price of the product. Display Name: List Price |
price_base |
Edm.Decimal |
Description: Base currency equivalent of the list price of the product Display Name: List Price (Base) Read-only property |
processid |
Edm.Guid |
Description: Shows the ID of the process. Display Name: Process |
productid |
Edm.Guid |
Description: Unique identifier of the product. Display Name: Product |
productnumber |
Edm.String |
Description: User-defined product ID. Display Name: Product ID |
productstructure |
Edm.Int32 |
Description: Product Structure. Default Options: 1 : Product Display Name: Product Structure |
producttypecode |
Edm.Int32 |
Description: Type of product. Default Options: 1 : Sales Inventory Display Name: Product Type |
producturl |
Edm.String |
Description: URL for the Website associated with the product. Display Name: URL |
quantitydecimal |
Edm.Int32 |
Description: Number of decimal places that can be used in monetary amounts for the product. Display Name: Decimals Supported |
quantityonhand |
Edm.Decimal |
Description: Quantity of the product in stock. Display Name: Quantity On Hand |
size |
Edm.String |
Description: Product size. Display Name: Size |
stageid |
Edm.Guid |
Description: Shows the ID of the stage. Display Name: Process Stage |
standardcost |
Edm.Decimal |
Description: Standard cost of the product. Display Name: Standard Cost |
standardcost_base |
Edm.Decimal |
Description: Base currency equivalent of the standard cost of the product. Display Name: Standard Cost (Base) Read-only property |
statecode |
Edm.Int32 |
Description: Status of the product. Default Options: 0 : Active Display Name: Status |
statuscode |
Edm.Int32 |
Description: Reason for the status of the product. Default Options: 1 : Active Display Name: Status Reason |
stockvolume |
Edm.Decimal |
Description: Stock volume of the product. Display Name: Stock Volume |
stockweight |
Edm.Decimal |
Description: Stock weight of the product. Display Name: Stock Weight |
suppliername |
Edm.String |
Description: Name of the product's supplier. Display Name: Supplier Name |
timezoneruleversionnumber |
Edm.Int32 |
Description: For internal use only. Display Name: Time Zone Rule Version Number |
traversedpath |
Edm.String |
Description: For internal use only. Display Name: Traversed Path |
utcconversiontimezonecode |
Edm.Int32 |
Description: Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code |
validfromdate |
Edm.Date |
Description: Date from which this product is valid. Display Name: Valid From |
validtodate |
Edm.Date |
Description: Date to which this product is valid. Display Name: Valid To |
vendorid |
Edm.String |
Description: Unique identifier of vendor supplying the product. Display Name: Vendor ID |
vendorname |
Edm.String |
Description: Name of the product vendor. Display Name: Vendor |
vendorpartnumber |
Edm.String |
Description: Unique part identifier in vendor catalog of this product. Display Name: Vendor Name |
versionnumber |
Edm.Int64 |
Description: Version number of the product. Display Name: Version Number Read-only property |
Lookup Properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties
Name |
Single-valued navigation property |
Description |
|---|---|---|
_createdby_value |
createdby |
Unique identifier of the user who created the product. |
_createdonbehalfby_value |
createdonbehalfby |
Unique identifier of the delegate user who created the product. |
_defaultuomid_value |
defaultuomid |
Default unit for the product. |
_defaultuomscheduleid_value |
defaultuomscheduleid |
Default unit group for the product. |
_modifiedby_value |
modifiedby |
Unique identifier of the user who last modified the product. |
_modifiedonbehalfby_value |
modifiedonbehalfby |
Unique identifier of the delegate user who last modified the product. |
_organizationid_value |
organizationid |
Unique identifier of the organization associated with the product. |
_parentproductid_value |
parentproductid |
Specifies the parent product family hierarchy. |
_pricelevelid_value |
pricelevelid |
Select the default price list for the product. |
_subjectid_value |
subjectid |
Select a category for the product. |
_transactioncurrencyid_value |
transactioncurrencyid |
Unique identifier of the currency associated with the product. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
Name |
Type |
Partner |
|---|---|---|
createdby |
lk_productbase_createdby |
|
createdonbehalfby |
lk_product_createdonbehalfby |
|
defaultuomid |
unit_of_measurement_products |
|
defaultuomscheduleid |
unit_of_measurement_schedule_products |
|
modifiedby |
lk_productbase_modifiedby |
|
modifiedonbehalfby |
lk_product_modifiedonbehalfby |
|
organizationid |
organization_products |
|
parentproductid |
product_parent_product |
|
pricelevelid |
price_level_products |
|
stageid_processstage |
processstage_products |
|
subjectid |
subject_products |
|
transactioncurrencyid |
transactioncurrency_product |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
Name |
Type |
Partner |
|---|---|---|
campaignproduct_association |
campaignproduct_association |
|
competitorproduct_association |
competitorproduct_association |
|
leadproduct_association |
leadproduct_association |
|
opportunity_products |
productid |
|
Product_Annotation |
objectid_product |
|
Product_AsyncOperations |
regardingobjectid_product |
|
Product_BulkDeleteFailures |
regardingobjectid_product |
|
product_connections1 |
record1id_product |
|
product_connections2 |
record2id_product |
|
product_contract_line_items |
productid |
|
Product_DynamicProperty |
regardingobjectid_product |
|
Product_DynamicPropertyAssociation |
regardingobjectid_product |
|
product_entitlement_association |
product_entitlement_association |
|
product_entitlementtemplate_association |
product_entitlementtemplate_association |
|
product_incidents |
productid |
|
product_invoice_details |
productid |
|
product_order_details |
productid |
|
product_parent_product |
parentproductid |
|
product_price_levels |
productid |
|
Product_ProductAssociation_AssocProd |
associatedproduct |
|
Product_ProductAssociation_Prod |
productid |
|
product_ProductSubstitute_productid |
productid |
|
product_ProductSubstitute_substitutedproductid |
substitutedproductid |
|
product_quote_details |
productid |
|
Product_SharepointDocumentLocation |
regardingobjectid_product |
|
Product_SyncErrors |
regardingobjectid_product_syncerror |
|
productsalesliterature_association |
productsalesliterature_association |
Operations bound to product
The following operations are bound to the product entity type.
Name |
Bound to |
|---|---|
Entity |
|
Entity |
|
Entity |
|
Entity |
Operations using the product entity type.
The following operations use the product entity type in a parameter or return type.
Name |
How used |
Description |
|---|---|---|
entity Parameter |
Adds an item to a campaign. |
|
entity Parameter |
Copies an existing product family, product, or bundle under the same parent record. |
|
ReturnType |
Copies an existing product family, product, or bundle under the same parent record. |
|
entity Parameter |
Publishes a product family record and all its child records. |
|
Product Parameter |
Gets the quantity decimal value of a product for the specified entity in the target. |
|
entity Parameter |
Retrieves the top-ten articles about a specified product from the knowledge base of articles for the organization |
See Also
Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright