Salesforce Docs Portal

ProductAttributeDefinition

Represents the relationship of an attribute to a product and the default configuration for the product to which they are assigned. For example, the Polo T-shirt product is associated with the T-shirt Size attribute. This object is available in API version 56.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

Field Service must be enabled.

Fields

AttributeDefinitionId

  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Description: The attribute ID associated with the product attribute definition.

    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: Name to display for the attribute when shown for this object. This display name overrides the name on the attribute. For example, the attribute Color is overriden to display as Laptop Color. Maximum size is 255 alphanumeric characters. Can include the following special characters: @ ! - < > * ? + = % # ( ) / \ & ‘ £ € $ ”.

DateTimeValue

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The value for a product attribute that has a DateTime data type.

DateValue

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The value for a product attribute that has a Date data type.

DefaultValue

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The default value for the attribute for the product. The attribute value can be changed. This default overrides the default value set for a picklist for the attribute.

Description

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A description of the attribute definition. Maximum size is 32000 alphanumeric characters. Can include the following special characters: @ ! - < > * ? + = % # ( ) / \ & ‘ £ € $ ”.

FormatMask

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The format mask governing data entry for the attribute value. For example, a user enters 1234567899 as a value. If the format is NNN-NN-NNNN and the value is saved as 1234-56-7899.

HelpText

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Help text to display when end users configure the attribute for this product. This text overrides the help text defined for the attribute. Maximum size is 32000 alphanumeric characters. The default is AtrributeDefinition.DefaultHelpText.

IsBooleanValue

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The Boolean value for the product attribute that has a Boolean data type.
  • Default value: false

IsConfigurable

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether users can configure the attribute after adding the product to the order capture page.
  • Default value: false

IsEncrypted

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the attribute value must be encrypted. Use to ensure privacy, such as Personally Identifiable Information (PII).
  • Default value: false

IsHidden

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether to hide the attribute from users in the order capture interface.
  • Default value: false

IsOverride

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Represents whether a record is default or a overridden record.
  • Default value: false

IsReadOnly

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the product attribute is read-only for end-users in the order capture page.
  • Default value: false

IsRequired

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether a value for the attribute is required for the assigned parent object (usually a product).
  • Default value: false

IsValueCloneable

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether to duplicate the attribute value when a line item is cloned.
  • Default value: false

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The date the product attribute definition was last referenced.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The date the product attribute definition was last viewed.

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the product attribute definition.

NumberValue

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The numeric value for the product attribute that has a Number data type.

OverriddenProductAttributeDefinitionId

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Lookup to the Overriden Product Attribute Definition.

    This field is a relationship field.

  • Relationship Name: OverriddenProductAttributeDefinition

  • Relationship Type: Lookup

  • Refers To: ProductAttributeDefinition

OverrideContextId

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Lookup to a root bundle product or promotion.

    This field is a polymorphic relationship field.

  • Relationship Name: OverrideContext

  • Relationship Type: Lookup

  • Refers To: Product2

OwnerId

  • Type: reference

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description: The ID of the user or group that owns the product attribute definition.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner

  • Relationship Type: Lookup

  • Refers To: Group, User

Product2Id

  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Description: The product ID associated with the product attribute definition.

    This field is a relationship field.

  • Relationship Name: Product2

  • Relationship Type: Lookup

  • Refers To: Product2

Status

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Lifecycle state of the product attribute definition.

  • Default value: Draft

  • Possible values:

    • Active
    • Draft
    • Inactive

TextValue

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The value for the product attribute that has a Text data type.

ValueDescription

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Description of the value assigned to this attribute. Defaulted 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.