CatalogCustomAttributeValue

An instance of a custom attribute.

Custom attributes can be defined and added to ITEM and ITEM_VARIATION type catalog objects. Read more about custom attributes.

Link to section

Properties

Link to section

name

string

The name of the custom attribute.

Link to section

string_value

string

The string value of the custom attribute. Populated if type = STRING.

Link to section

custom_attribute_definition_id

string

Read only The id of the CatalogCustomAttributeDefinition this value belongs to.

Link to section

type

string

Read only A copy of type from the associated CatalogCustomAttributeDefinition.

Link to section

number_value

string

Populated if type = NUMBER. Contains a string representation of a decimal number, using a . as the decimal separator.

Link to section

boolean_value

boolean

A true or false value. Populated if type = BOOLEAN.

Link to section

selection_uid_values

string [ ]

One or more choices from allowed_selections. Populated if type = SELECTION.

Link to section

key

string

Read only If the associated CatalogCustomAttributeDefinition object is defined by another application, this key is prefixed by the defining application ID. For example, if the CatalogCustomAttributeDefinition has a key attribute of "cocoa_brand" and the defining application ID is "abcd1234", this key is "abcd1234:cocoa_brand" when the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply "cocoa_brand".