Interface AttributeResponse<CustomFields>

An attribute on the product service

interface AttributeResponse {
    categoryIds?: string[];
    customFields: CustomFields;
    groupName?: string;
    id: string;
    itemGroups?: {
        categoryIds?: string[];
        key: string;
        value: string;
    }[];
    items?: {
        groupName?: string;
        key: string;
        value: string;
    }[];
    name: string;
    order?: number;
    type: "Boolean" | "Text" | "Number" | "Select" | "MultiSelect";
}

Type Parameters

  • CustomFields = unknown

Properties

categoryIds? customFields groupName? id itemGroups? items? name order? type

Properties

Optional categoryIds

categoryIds?: string[]

The category IDs this attribute is associated with

customFields

customFields: CustomFields

The custom fields for this attribute

Optional groupName

groupName?: string

The named group of this attribute

id

id: string

The unique identifier for this attribute

Optional itemGroups

itemGroups?: {
    categoryIds?: string[];
    key: string;
    value: string;
}[]

The list of attribute item groups that items can be in (for type = Select | MultiSelect)

Type declaration

  • Optional categoryIds?: string[]
  • key: string
  • value: string

Optional items

items?: {
    groupName?: string;
    key: string;
    value: string;
}[]

The list of attribute items (for type = Select | MultiSelect)

Type declaration

  • Optional groupName?: string
  • key: string
  • value: string

name

name: string

The name of this attribute

Optional order

order?: number

The sort order of this attribute

type

type: "Boolean" | "Text" | "Number" | "Select" | "MultiSelect"

The type of this attribute

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc