Skip to main content

Interface: AttributeDescriptionCreateInput

Defined in: type/AttributeDescriptionCreateInput.ts:8

Input object for AttributeDescriptionCreateInput

Properties​

attributeClass​

attributeClass: AttributeDescriptionClass

Defined in: type/AttributeDescriptionCreateInput.ts:18

Attribute class. One of: [product, category, cluster, customer, contact, company]

defaultValue​

defaultValue: AttributeValueInput

Defined in: type/AttributeDescriptionCreateInput.ts:32

The default value for this attribute

descriptions​

descriptions: LocalizedStringInput[]

Defined in: type/AttributeDescriptionCreateInput.ts:12

Attribute descriptions per language

group?​

optional group?: string

Defined in: type/AttributeDescriptionCreateInput.ts:22

The attribute group

isHidden?​

optional isHidden?: boolean

Defined in: type/AttributeDescriptionCreateInput.ts:30

Flags whether this attribute is hidden and should only be used for background operations

isPublic?​

optional isPublic?: boolean

Defined in: type/AttributeDescriptionCreateInput.ts:26

Flags whether this attribute should be used when generating product specifications

isSearchable?​

optional isSearchable?: boolean

Defined in: type/AttributeDescriptionCreateInput.ts:24

Flags whether this attribute should be used when generating catalog page filters

isSystem?​

optional isSystem?: boolean

Defined in: type/AttributeDescriptionCreateInput.ts:28

Flags whether this attribute is only available to system users

name​

name: string

Defined in: type/AttributeDescriptionCreateInput.ts:10

Descriptive identifier (Screaming Snake Case)

type​

type: AttributeType

Defined in: type/AttributeDescriptionCreateInput.ts:16

Attribute type. One of: [text, enum, color, datetime, integer, decimal]

units?​

optional units?: LocalizedStringInput[]

Defined in: type/AttributeDescriptionCreateInput.ts:14

Attribute unit per language

valuesetId?​

optional valuesetId?: number

Defined in: type/AttributeDescriptionCreateInput.ts:20

The ID of the connected valueset to use when type is ENUM