product EntityType

Information about products and their pricing information.

Entity Set Path
[organization URI]/api/data/v9.0/products
Base Type
crmbaseentity
Display Name
Product
Primary Key
productid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
currentcost Edm.Decimal

Current cost for the product item. Used in price calculations.

Display Name: Current Cost

currentcost_base Edm.Decimal

Value of the Current Cost in base currency.

Display Name: Current Cost (Base)

Read Only
description Edm.String

Description of the product.

Display Name: Description

dmtimportstate Edm.Int32

Internal Use Only

Display Name: Internal Use Only

entityimage Edm.Binary

Shows the default image for the record.

Display Name: Entity Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid
Read Only
exchangerate Edm.Decimal

Exchange rate for the currency associated with the product with respect to the base currency.

Display Name: Exchange Rate

Read Only
hierarchypath Edm.String

Hierarchy path of the product.

Display Name: Hierarchy Path

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

iskit Edm.Boolean

Information that specifies whether the product is a kit.

Display Name: Is Kit

Default Options
Value Label
1 Yes
0 No
isstockitem Edm.Boolean

Information about whether the product is a stock item.

Display Name: Stock Item

Default Options
Value Label
1 Yes
0 No
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
msdyn_converttocustomerasset Edm.Boolean

Specify whether a product is to be converted to a customer asset. When a product is used on a work order, the system will automatically convert it into a customer asset when the work order is closed.

Display Name: Convert to Customer Asset

Default Options
Value Label
1 Yes
0 No
msdyn_fieldserviceproducttype Edm.Int32

Display Name: Field Service Product Type

Default Options
Value Label
690970000 Inventory
690970001 Non-Inventory
690970002 Service
msdyn_purchasename Edm.String

Type the name for the product when used on a purchase order.

Display Name: Purchase Name

msdyn_taxable Edm.Boolean

Select whether the item is taxable. If an item is set as not taxable, it won't be taxable even on a taxable work order.

Display Name: Taxable

Default Options
Value Label
1 Yes
0 No
msdyn_upccode Edm.String

Shows the UPC Code for product. Used for bar code scanning.

Display Name: UPC Code

name Edm.String

Name of the product.

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

price Edm.Decimal

List price of the product.

Display Name: List Price

price_base Edm.Decimal

Value of the List Price in base currency.

Display Name: List Price (Base)

Read Only
processid Edm.Guid

Contains the id of the process associated with the entity.

Display Name: Process Id

productid Edm.Guid

Unique identifier of the product.

Display Name: Product

productnumber Edm.String

User-defined product ID.

Display Name: Product ID

productstructure Edm.Int32

Product Structure.

Display Name: Product Structure

Default Options
Value Label
1 Product
2 Product Family
3 Product Bundle
producttypecode Edm.Int32

Type of product.

Display Name: Product Type

Default Options
Value Label
1 Sales Inventory
2 Miscellaneous Charges
3 Services
4 Flat Fees
producturl Edm.String

URL for the Website associated with the product.

Display Name: URL

quantitydecimal Edm.Int32

Number of decimal places that can be used in monetary amounts for the product.

Display Name: Decimals Supported

quantityonhand Edm.Decimal

Quantity of the product in stock.

Display Name: Quantity On Hand

size Edm.String

Product size.

Display Name: Size

stageid Edm.Guid

Contains the id of the stage where the entity is located.

Display Name: Stage Id

standardcost Edm.Decimal

Standard cost of the product.

Display Name: Standard Cost

standardcost_base Edm.Decimal

Value of the Standard Cost in base currency.

Display Name: Standard Cost (Base)

Read Only
statecode Edm.Int32

Status of the product.

Display Name: Status

Default Options
Value Label
0 Active
1 Retired
2 Draft
3 Under Revision
statuscode Edm.Int32

Reason for the status of the product.

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Retired
0 Draft
3 Under Revision
stockvolume Edm.Decimal

Stock volume of the product.

Display Name: Stock Volume

stockweight Edm.Decimal

Stock weight of the product.

Display Name: Stock Weight

suppliername Edm.String

Name of the product's supplier.

Display Name: Supplier Name

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

traversedpath Edm.String

A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.

Display Name: Traversed Path

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

validfromdate Edm.Date

Date from which this product is valid.

Display Name: Valid From

validtodate Edm.Date

Date to which this product is valid.

Display Name: Valid To

vendorid Edm.String

Unique identifier of vendor supplying the product.

Display Name: Vendor ID

vendorname Edm.String

Name of the product vendor.

Display Name: Vendor

vendorpartnumber Edm.String

Unique part identifier in vendor catalog of this product.

Display Name: Vendor Name

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

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.

_createdbyexternalparty_value createdby

Shows the external party who created the record.

_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.

_modifiedbyexternalparty_value createdby

Shows the external party who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the product.

_msdyn_defaultvendor_value msdyn_defaultvendor

Default vendor that supplies this product

_msdyn_transactioncategory_value msdyn_TransactionCategory

Select the transaction category for this product.

_organizationid_value organizationid

Unique identifier for the organization

_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 systemuser lk_productbase_createdby
createdonbehalfby systemuser lk_product_createdonbehalfby
defaultuomid uom unit_of_measurement_products
defaultuomscheduleid uomschedule unit_of_measurement_schedule_products
modifiedby systemuser lk_productbase_modifiedby
modifiedonbehalfby systemuser lk_product_modifiedonbehalfby
msdyn_defaultvendor account msdyn_account_product_DefaultVendor
msdyn_TransactionCategory msdyn_transactioncategory msdyn_msdyn_transactioncategory_product_TransactionCategory
organizationid organization organization_products
parentproductid product product_parent_product
pricelevelid pricelevel price_level_products
stageid_processstage processstage processstage_products
subjectid subject subject_products
transactioncurrencyid transactioncurrency 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 campaign campaignproduct_association
competitorproduct_association competitor competitorproduct_association
leadproduct_association lead leadproduct_association
msdyn_product_msdyn_actual_Product msdyn_actual msdyn_Product
msdyn_product_msdyn_agreementbookingproduct_Product msdyn_agreementbookingproduct msdyn_product
msdyn_product_msdyn_agreementbookingservice_Service msdyn_agreementbookingservice msdyn_service
msdyn_product_msdyn_agreementinvoiceproduct_Product msdyn_agreementinvoiceproduct msdyn_product
msdyn_product_msdyn_customerasset_Product msdyn_customerasset msdyn_product
msdyn_product_msdyn_estimateline_Product msdyn_estimateline msdyn_Product
msdyn_product_msdyn_fact_Product msdyn_fact msdyn_Product
msdyn_product_msdyn_fieldcomputation_ProductId msdyn_fieldcomputation msdyn_ProductId
msdyn_product_msdyn_fieldservicepricelistitem_ProductService msdyn_fieldservicepricelistitem msdyn_productservice
msdyn_product_msdyn_fieldservicesetting msdyn_fieldservicesetting msdyn_travelchargeitemid
msdyn_product_msdyn_incidenttypeproduct_Product msdyn_incidenttypeproduct msdyn_product
msdyn_product_msdyn_incidenttypeservice_Service msdyn_incidenttypeservice msdyn_service
msdyn_product_msdyn_inventoryadjustmentproduct_Product msdyn_inventoryadjustmentproduct msdyn_product
msdyn_product_msdyn_inventoryjournal_Product msdyn_inventoryjournal msdyn_product
msdyn_product_msdyn_invoicelinetransaction_Product msdyn_invoicelinetransaction msdyn_Product
msdyn_product_msdyn_journalline_Product msdyn_journalline msdyn_Product
msdyn_product_msdyn_opportunitylinetransaction_Product msdyn_opportunitylinetransaction msdyn_Product
msdyn_product_msdyn_orderinvoicingproduct_Product msdyn_orderinvoicingproduct msdyn_Product
msdyn_product_msdyn_orderlinetransaction_Product msdyn_orderlinetransaction msdyn_Product
msdyn_product_msdyn_productinventory_Product msdyn_productinventory msdyn_product
msdyn_product_msdyn_purchaseorderproduct_Product msdyn_purchaseorderproduct msdyn_product
msdyn_product_msdyn_quotebookingproduct_Product msdyn_quotebookingproduct msdyn_product
msdyn_product_msdyn_quotebookingservice_Service msdyn_quotebookingservice msdyn_Service
msdyn_product_msdyn_quoteinvoicingproduct_Product msdyn_quoteinvoicingproduct msdyn_Product
msdyn_product_msdyn_quotelinetransaction_Product msdyn_quotelinetransaction msdyn_Product
msdyn_product_msdyn_rmaproduct_Product msdyn_rmaproduct msdyn_product
msdyn_product_msdyn_rtvproduct_Product msdyn_rtvproduct msdyn_product
msdyn_product_msdyn_workorderproduct_Product msdyn_workorderproduct msdyn_product
msdyn_product_msdyn_workorderservice_Service msdyn_workorderservice msdyn_service
opportunity_products opportunityproduct productid
Product_Annotation annotation objectid_product
Product_AsyncOperations asyncoperation regardingobjectid_product
Product_BulkDeleteFailures bulkdeletefailure regardingobjectid_product
product_connections1 connection record1id_product
product_connections2 connection record2id_product
product_contract_line_items contractdetail productid
Product_DynamicProperty dynamicproperty regardingobjectid_product
Product_DynamicPropertyAssociation dynamicpropertyassociation regardingobjectid_product
product_entitlement_association entitlement product_entitlement_association
product_entitlementtemplate_association entitlementtemplate product_entitlementtemplate_association
product_incidents incident productid
product_invoice_details invoicedetail productid
product_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_product
product_order_details salesorderdetail productid
product_parent_product product parentproductid
product_price_levels productpricelevel productid
product_principalobjectattributeaccess principalobjectattributeaccess objectid_product
Product_ProcessSessions processsession regardingobjectid_product
Product_ProductAssociation_AssocProd productassociation associatedproduct
Product_ProductAssociation_Prod productassociation productid
product_ProductSubstitute_productid productsubstitute productid
product_ProductSubstitute_substitutedproductid productsubstitute substitutedproductid
product_quote_details quotedetail productid
Product_SharepointDocumentLocation sharepointdocumentlocation regardingobjectid_product
Product_SyncErrors syncerror regardingobjectid_product_syncerror
productsalesliterature_association salesliterature productsalesliterature_association

Operations

The following operations can be used with the product entity type.

Name Binding
AddItemCampaign Entity
CloneProduct Entity
PublishProductHierarchy Entity
RetrieveByTopIncidentProductKbArticle Entity
RevertProduct Not Bound

Solutions

The following solutions include the product entity type.

Name Description
Field Service Microsoft Dynamics 365 for Field Service allows organizations of any size to deliver intelligent, world class field service, managing all aspects of the end-to-end field service management cycle. Features include scheduling, mobile, asset management, inventory control, customer notifications, and resource utilization controls that help maximize efficiency and minimize costs.
Product Management Dynamics 365 workload for product management.
Project Service Automation Microsoft Dynamics 365 for Project Service Automation is an end-to-end solution that helps sales and delivery teams engage customers and deliver billable projects on time and within budget. Project Service gives you the tools you need to: Estimate, quote, and contract work; Plan and assign resources; Enable team collaboration; Capture time, expense, and progress data for real-time insights and accurate invoicing.

See also