Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Data API documents 23.2

ObjectAttributeDefinition document (Data API 23.2)

Document representing a attribute definition

Property Type Constraints Description
default_value ObjectAttributeValueDefinition   The default value of this attribute. It can be updated, but not created.
description Localized<String>   The localized description of the attribute.
display_name Localized<String>   The localized name presented to the user in forms.
effective_id String   The effective ID, which is c_id if the attribute is custom, and just the id otherwise. It is read only.
externally_defined Boolean   Flag indicating if this attribute is externally defined.
externally_managed Boolean   Flag indicating if this attribute is externally managed.
field_height Integer   The height of the field for this attribute in the editor.
field_length Integer   The length of the field for this attribute in the editor.
id String   The user supplied ID of the attribute.
key Boolean   Flag indicating if this is a key attribute.
link String   The URL that is used to get this instance. Value is computed and read-only.
localizable Boolean   Flag indicating if this attribute can be localized.
mandatory Boolean   Flag indicating if a value is mandatory for the attribute.
max_value Double   The maximum possible value for this attribute.
min_length Integer   The minimum length of the field for this attribute.
min_value Double   The minimum possible value for this attribute.
multi_value_type Boolean  

True if the attribute can have multiple values.

Attributes of the following types are multi-value capable:

  • set_of_int
  • set_of_number
  • set_of_string

Additionally, attributes of the following types can be multi-value enabled:

  • enum_of_int
  • enum_of_string
order_required Boolean   Flag indicating if this attribute is required for order of the attribute model's product. The set of these can be used in order line items.
queryable Boolean   Returns true if the attribute definition is explicitly marked queryable. If no explicit queryable is found and the attribute value type belongs to a queryable type, true is returned too. In all other cases false is returned. Value is computed and read-only.
read_only Boolean   Flag indicating if this attribute is read-only. It is read only.
regular_expression String   A regular expression that defines the legal values for this attribute.
requires_encoding Boolean   Flag indicating if this attribute can be encoded using the encoding="off" flag in ISML templates. It is read only.
scale Integer   The minimum number of fraction digits for a value of this attribute.
searchable Boolean   Flag indicating if this attribute is searchable.
set_value_type Boolean   Flag indicating if this attribute is of type 'Set of'. It is read only.
site_specific Boolean   Flag indicating if this attribute is site-specific.
system Boolean   Flag indicating if this attribute is a system attribute.
unit Localized<String>   The unit of measure for this attribute.
value_definitions [ObjectAttributeValueDefinition]   A set of values that are possible for this attribute. It is read only.
value_type Enum {string, int, double, text, html, date, image, boolean, money, quantity, datetime, email, password, set_of_string, set_of_int, set_of_double, enum_of_string, enum_of_int, unknown}   The type of this attribute.
visible Boolean   Flag indicating if this attribute is visible.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.