IAttributeFilter

No description

interface IAttributeFilter {
  id: String!
  searchId: String!
  description: String!
  type: AttributeType!
  isSearchable: Boolean!
  isPublic: Boolean!
  isHidden: Boolean
  textFilter: [AttributeTextFilter!]
  integerRangeFilter: AttributeIntegerRangeFilter
  decimalRangeFilter: AttributeDecimalRangeFilter
}

Fields

IAttributeFilter.id ● String! non-null scalar

The Name or Id of the Atribute as it's defined in the Database

IAttributeFilter.searchId ● String! non-null scalar

Lowercased representation of the id with an attr_ prefix that can be used in query parameters. The attr_ prefix is to avoid potential naming conflict with regular product fields

IAttributeFilter.description ● String! non-null scalar

The human readable description of the attribute's name. This is a language specific value.

IAttributeFilter.type ● AttributeType! non-null enum

The type of the attribute. Possible values:

• text
• list
• enum
• enumlist
• color
• date
• datetime
• object
• integer
• decimal

IAttributeFilter.isSearchable ● Boolean! non-null scalar

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

IAttributeFilter.isPublic ● Boolean! non-null scalar

Flags whether this attribute should be used when generating product specs.

IAttributeFilter.isHidden ● Boolean scalar

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

IAttributeFilter.textFilter ● [AttributeTextFilter!] list object

All available attribute text values within this search result for this particulat attribute.

IAttributeFilter.integerRangeFilter ● AttributeIntegerRangeFilter object

Minumum and maximum value range for integer attributes

IAttributeFilter.decimalRangeFilter ● AttributeDecimalRangeFilter object

Minumum and maximum value range for decimal attributes

Implemented By

AttributeFilter object