Product Relationship (ProductSubstitute) table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Information about the selling relationship between two products, including the relationship type, such as up-sell, cross-sell, substitute, or accessory.

Added by: Product Management Solution

Messages

Message	Web API Operation	SDK class or method
Create	POST /productsubstitutes See Create	CreateRequest or Create
CreateMultiple	CreateMultiple	CreateMultipleRequest
Delete	DELETE /productsubstitutes(productsubstituteid) See Delete	DeleteRequest or Delete
Retrieve	GET /productsubstitutes(productsubstituteid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET /productsubstitutes See Query Data	RetrieveMultipleRequest or RetrieveMultiple
Update	PATCH /productsubstitutes(productsubstituteid) See Update	UpdateRequest or Update
UpdateMultiple	UpdateMultiple	UpdateMultipleRequest

Properties

Property	Value
CollectionSchemaName	ProductSubstitutes
DisplayCollectionName	Product Relationships
DisplayName	Product Relationship
EntitySetName	productsubstitutes
IsBPFEntity	False
LogicalCollectionName	productsubstitutes
LogicalName	productsubstitute
OwnershipType	OrganizationOwned
PrimaryIdAttribute	productsubstituteid
PrimaryNameAttribute	name
SchemaName	ProductSubstitute

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• Direction
• ImportSequenceNumber
• Name
• OverriddenCreatedOn
• ProductId
• ProductSubstituteId
• SalesRelationshipType
• statuscode
• SubstitutedProductId
• TimeZoneRuleVersionNumber
• TransactionCurrencyId
• UTCConversionTimeZoneCode

Direction

Property	Value
Description	Select whether the relationship is unidirectional or bidirectional.
DisplayName	Direction
IsValidForForm	True
IsValidForRead	True
LogicalName	direction
RequiredLevel	SystemRequired
Type	Picklist

Direction Choices/Options

Value	Label	Description
0	Uni-Directional
1	Bi-Directional

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
Format	None
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	importsequencenumber
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	None
Type	Integer

Name

Property	Value
Description	name
DisplayName	name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

OverriddenCreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time that the record was migrated.
DisplayName	Record Created On
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime

ProductId

Property	Value
Description	Shows the product that the relationship is defined for.
DisplayName	Product
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	productid
RequiredLevel	SystemRequired
Targets	product
Type	Lookup

ProductSubstituteId

Property	Value
Description	Shows the unique identifier of the product relationship.
DisplayName	Product Relationship ID
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	productsubstituteid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SalesRelationshipType

Property	Value
Description	Select the type of the product relationship.
DisplayName	Sales Relationship Type
IsValidForForm	True
IsValidForRead	True
LogicalName	salesrelationshiptype
RequiredLevel	SystemRequired
Type	Picklist

SalesRelationshipType Choices/Options

Value	Label	Description
0	Up-sell
1	Cross-sell
2	Accessory
3	Substitute

statuscode

Property	Value
Description	Shows whether the product relationship is active or inactive.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

statuscode Choices/Options

Value	Label	State
1	Active	0
2	Inactive	1

SubstitutedProductId

Property	Value
Description	Select the related product that the relationship needs to be defined for.
DisplayName	Related Product
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	substitutedproductid
RequiredLevel	SystemRequired
Targets	product
Type	Lookup

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

TransactionCurrencyId

Property	Value
Description	Shows the currency associated with the record.
DisplayName	Currency
IsValidForForm	True
IsValidForRead	True
LogicalName	transactioncurrencyid
RequiredLevel	None
Targets	transactioncurrency
Type	Lookup

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ExchangeRate
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OrganizationId
• OrganizationIdName
• ProductIdName
• statecode
• SubstitutedProductIdName
• TransactionCurrencyIdName
• VersionNumber

CreatedBy

Property	Value
Description	Shows who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyyominame
MaxLength	100
RequiredLevel	None
Type	String

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was created.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime

CreatedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ExchangeRate

Property	Value
Description	Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName	Exchange Rate
IsValidForForm	True
IsValidForRead	True
LogicalName	exchangerate
MaxValue	100000000000
MinValue	0.000000000001
Precision	12
RequiredLevel	None
Type	Decimal

ModifiedBy

Property	Value
Description	Shows who last updated the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyyominame
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime

ModifiedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	None
Type	String

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	SystemRequired
Targets	organization
Type	Lookup

OrganizationIdName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationidname
MaxLength	100
RequiredLevel	None
Type	String

ProductIdName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	productidname
MaxLength	100
RequiredLevel	None
Type	String

statecode

Property	Value
Description	Select the product relationship's status.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

statecode Choices/Options

Value	Label	DefaultStatus	InvariantName
0	Active	1	Active
1	Inactive	2	Inactive

SubstitutedProductIdName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	substitutedproductidname
MaxLength	100
RequiredLevel	None
Type	String

TransactionCurrencyIdName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	transactioncurrencyidname
MaxLength	100
RequiredLevel	None
Type	String

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

• product_ProductSubstitute_substitutedproductid
• product_ProductSubstitute_productid

product_ProductSubstitute_substitutedproductid

See the product_ProductSubstitute_substitutedproductid one-to-many relationship for the product table/entity.

product_ProductSubstitute_productid

See the product_ProductSubstitute_productid one-to-many relationship for the product table/entity.

Related information

Dataverse table/entity reference
Web API Reference