ProductClassificationAttr

Represents the relationship between a product classification and its attributes. This is the default configuration for products based on the product classification. 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()

Special Access Rules

Product Catalog Management must be enabled to access this object.

Fields

Field Details
AttributeCategoryId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the attribute category assigned to the parent object.
This field is a relationship field.
Relationship Name
AttributeCategory
Relationship Type
Lookup
Refers To
AttributeCategory
AttributeDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the attribute assigned to the parent object.
This field is a relationship field.
Relationship Name
AttributeDefinition
Relationship Type
Lookup
Refers To
AttributeDefinition
AttributeNameOverride
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The overridden attribute name to display for the attribute when shown for this object. For example, "Color" overridden to "Laptop Color."
DefaultValue
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The default value of the attribute for a product based on the product classification. This value can be changed.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of this product classification attribute definition.
DisplayType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type to display data for the selected data type.
Valid values are:
  • CheckBox—Checkbox
  • ComboBox—Combobox
  • Date
  • Datetime—Date Time
  • Number
  • RadioButton—Radio Button
  • Slider—Available in API version 61.0 and later
  • Text
  • Toggle
ExcludedPicklistValues
Type
textarea
Properties
Create, Nillable, Update
Description
The picklist values excluded from the attribute picklist. This field ensures that the product classification attribute only has valid values.
HelpText
Type
textarea
Properties
Create, Nillable, Update
Description
The help text to display when end users are configuring this attribute. This field overrides the help text defined for the attribute itself.
IsHidden
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if this product attribute is hidden from end users in the run time (true) or not (false).
The default value is false.
IsPriceImpacting
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this attribute dictates the price of a product (true) or not (false).
The default value is false.
IsReadOnly
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the attribute is read-only for users in the run time (true) or not (false).
The default value is false.
IsRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this attribute requires a value when assigned to a parent object (true) or not (false).
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date the product classification attribute was last referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date the product classification attribute was last viewed.
MaximumCharacterCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum number of characters that can be entered for an attribute value.
MaximumValue
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum value that can be entered as an attribute value.
MinimumCharacterCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The minimum number of characters that can be entered for an attribute value.
MinimumValue
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The minimum value that can be entered as an attribute value.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the product classification attribute.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the product classification attribute owner.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ProductClassificationId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the product classification that the attribute is associated with. This field is unique within your organization.
This field is a relationship field.
Relationship Name
ProductClassification
Relationship Type
Lookup
Refers To
ProductClassification
Sequence
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The display sequence of the attribute when configuring the product during run time.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The lifecycle status of the product classification attribute.
Valid values are:
  • Active
  • Draft
  • Inactive
The default value is Draft.
StepValue
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The increment or decrement by which a slider's value changes as the user adjusts the product classification attribute value. Available in API version 61.0 and later.
ValueDescription
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the value assigned to this attribute. This field takes on the value description from the attribute definition.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ProductClassificationAttrFeed
Feed tracking is available for the object.
ProductClassificationAttrHistory
History is available for tracked fields of the object.
Sharing rules are available for the object.
ProductClassificationAttrShare
Sharing is available for the object.