Skip to main content

ProductsResponse

No description

type ProductsResponse {
  items: [IBaseProduct!]!
  itemsFound: Int!
  offset: Int!
  page: Int!
  pages: Int!
  start: Int!
  end: Int!
  minPrice: Int!
  maxPrice: Int!
  filterCoverage: FilterCoverage
  filters(input: FilterAvailableAttributeInput): [AttributeFilter!]
}

Fields​

ProductsResponse.items ● [IBaseProduct!]! non-null interface​

List of items of type ProductResultUnion

ProductsResponse.itemsFound ● Int! non-null scalar​

Total number of items found

ProductsResponse.offset ● Int! non-null scalar​

The amount of items to show per page

ProductsResponse.page ● Int! non-null scalar​

The current page

ProductsResponse.pages ● Int! non-null scalar​

Total amount of pages

ProductsResponse.start ● Int! non-null scalar​

Start position of the current page

ProductsResponse.end ● Int! non-null scalar​

End position of the current page

ProductsResponse.minPrice ● Int! non-null scalar​

The lowest price of a product in this productlist

ProductsResponse.maxPrice ● Int! non-null scalar​

The highest price of a product in this productlist

ProductsResponse.filterCoverage ● FilterCoverage object​

Coverage of the filters field.

Null when filters were not requested. Otherwise reports how many attribute descriptions matched this request and whether the limit left any of them out.

ProductsResponse.filters ● [AttributeFilter!] list object​

Available attribute filters for faceted search.

Returns the available attribute filters that can be applied to refine the product search results. These filters are dynamically generated based on the current search context and available product attributes.

**Limit:** at most 200 attribute descriptions are considered when building filters, and the tenant's most recently created attributes take precedence. Tenants that define more searchable attributes than this receive no filters for the remainder, and the field returns an empty list when none of the attributes within the limit apply to the result set. Pass input.ids to request filters for specific attributes regardless of this limit.

ProductsResponse.filters.input ● FilterAvailableAttributeInput input​

Filter configuration for determining available attributes.

Used to customize which attribute filters are returned based on the current search context and user preferences.

Returned By​

products query

Member Of​

Category object ● FavoriteList object ● Orderlist object