Skip to main content

FilterAvailableAttributeInput

Filtering criteria for retrieving available product attributes.

Enables filtering the list of available attributes based on their properties such as visibility, searchability, and data types. Used to discover which attributes can be used for product filtering and search.

input FilterAvailableAttributeInput {
  isPublic: Boolean
  isSearchable: Boolean
  ids: [String!]
  types: [AttributeType!]
}

Fields​

FilterAvailableAttributeInput.isPublic ● Boolean scalar​

Filter attributes by public visibility status.

When true, returns only attributes that are publicly visible to customers. When false, returns only attributes that are private or internal. When not specified, returns attributes regardless of visibility status.

FilterAvailableAttributeInput.isSearchable ● Boolean scalar​

Filter attributes by searchability status.

When true, returns only attributes that can be used in search queries. When false, returns only attributes that are not searchable. When not specified, returns attributes regardless of searchability status.

FilterAvailableAttributeInput.ids ● [String!] list scalar​

Filter attributes by specific IDs.

List of attribute IDs to include in the results. When provided, only attributes with matching IDs will be returned.

FilterAvailableAttributeInput.types ● [AttributeType!] list enum​

Filter attributes by data types.

List of attribute data types to include in the results. When provided, only attributes with matching data types will be returned.