CatalogCustomAttributeValue

April 22, 2020 ยท View on GitHub

Description

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.

Properties

NameGetterSetterTypeDescriptionNotes
namegetName()setName($value)stringThe name of the custom attribute.[optional]
string_valuegetStringValue()setStringValue($value)stringThe string value of the custom attribute. Populated if `type` = `STRING`.[optional]
custom_attribute_definition_idgetCustomAttributeDefinitionId()setCustomAttributeDefinitionId($value)stringRead-only. The id of the `CatalogCustomAttributeDefinition` this value belongs to.[optional]
typegetType()setType($value)stringRead-only. A copy of type from the associated `CatalogCustomAttributeDefinition`. See CatalogCustomAttributeDefinitionType for possible values[optional]
number_valuegetNumberValue()setNumberValue($value)stringPopulated if `type` = `NUMBER`. Contains a string representation of a decimal number, using a `.` as the decimal separator.[optional]
boolean_valuegetBooleanValue()setBooleanValue($value)boolA `true` or `false` value. Populated if `type` = `BOOLEAN`.[optional]
selection_uid_valuesgetSelectionUidValues()setSelectionUidValues($value)string[]One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`.[optional]
keygetKey()setKey($value)stringRead-only. A copy of key from the associated `CatalogCustomAttributeDefinition`.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]