Product Relationship (ProductSubstitute) entity reference
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 | SDK class or method |
---|---|
Create | CreateRequest or Create |
Delete | DeleteRequest or Delete |
Retrieve | RetrieveRequest or Retrieve |
RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
Update | UpdateRequest or Update |
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 attributes
These 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 attributes
These 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.0000000001 |
Precision | 10 |
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 |
One-To-Many Relationships
Listed by SchemaName.
- ProductSubstitute_SyncErrors
- ProductSubstitute_AsyncOperations
- productsubstitute_MailboxTrackingFolders
- ProductSubstitute_ProcessSession
- ProductSubstitute_BulkDeleteFailures
- ProductSubstitute_PrincipalObjectAttributeAccess
ProductSubstitute_SyncErrors
Added by: System Solution Solution
Same as the ProductSubstitute_SyncErrors many-to-one relationship for the syncerror entity.
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | ProductSubstitute_SyncErrors |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade |
ProductSubstitute_AsyncOperations
Added by: System Solution Solution
Same as the ProductSubstitute_AsyncOperations many-to-one relationship for the asyncoperation entity.
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | ProductSubstitute_AsyncOperations |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
productsubstitute_MailboxTrackingFolders
Added by: System Solution Solution
Same as the productsubstitute_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder entity.
Property | Value |
---|---|
ReferencingEntity | mailboxtrackingfolder |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | productsubstitute_MailboxTrackingFolders |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
ProductSubstitute_ProcessSession
Added by: System Solution Solution
Same as the ProductSubstitute_ProcessSession many-to-one relationship for the processsession entity.
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | ProductSubstitute_ProcessSession |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
ProductSubstitute_BulkDeleteFailures
Added by: System Solution Solution
Same as the ProductSubstitute_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
Property | Value |
---|---|
ReferencingEntity | bulkdeletefailure |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | ProductSubstitute_BulkDeleteFailures |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
ProductSubstitute_PrincipalObjectAttributeAccess
Added by: System Solution Solution
Same as the ProductSubstitute_PrincipalObjectAttributeAccess many-to-one relationship for the principalobjectattributeaccess entity.
Property | Value |
---|---|
ReferencingEntity | principalobjectattributeaccess |
ReferencingAttribute | objectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | ProductSubstitute_PrincipalObjectAttributeAccess |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
- lk_ProductSubstitute_createdby
- lk_ProductSubstitute_createdonbehalfby
- lk_ProductSubstitute_modifiedby
- lk_ProductSubstitute_modifiedonbehalfby
- organization_ProductSubstitute
- product_ProductSubstitute_substitutedproductid
- product_ProductSubstitute_productid
- transactioncurrency_ProductSubstitute
lk_ProductSubstitute_createdby
Added by: System Solution Solution
See the lk_ProductSubstitute_createdby one-to-many relationship for the systemuser entity.
lk_ProductSubstitute_createdonbehalfby
Added by: System Solution Solution
See the lk_ProductSubstitute_createdonbehalfby one-to-many relationship for the systemuser entity.
lk_ProductSubstitute_modifiedby
Added by: System Solution Solution
See the lk_ProductSubstitute_modifiedby one-to-many relationship for the systemuser entity.
lk_ProductSubstitute_modifiedonbehalfby
Added by: System Solution Solution
See the lk_ProductSubstitute_modifiedonbehalfby one-to-many relationship for the systemuser entity.
organization_ProductSubstitute
Added by: System Solution Solution
See the organization_ProductSubstitute one-to-many relationship for the organization entity.
product_ProductSubstitute_substitutedproductid
See the product_ProductSubstitute_substitutedproductid one-to-many relationship for the product entity.
product_ProductSubstitute_productid
See the product_ProductSubstitute_productid one-to-many relationship for the product entity.
transactioncurrency_ProductSubstitute
Added by: System Solution Solution
See the transactioncurrency_ProductSubstitute one-to-many relationship for the transactioncurrency entity.