Skip to main content

ProductsResponse

Paginated response containing product search results with filtering and aggregation data.

Provides a comprehensive response for product queries including matching items, pagination metadata, price ranges, and available filters for building rich product discovery interfaces.

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

Fields​

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

Collection of products and clusters matching the search criteria.

Array of product and cluster entities that match the applied filters and search parameters, ordered according to the specified sorting criteria. Can contain both individual products and product clusters.

ProductsResponse.itemsFound ● Int! non-null scalar​

Total number of products found across all pages.

Complete count of products that match the search criteria, regardless of pagination limits. Used for calculating total pages and displaying result counts to users.

ProductsResponse.offset ● Int! non-null scalar​

Number of items displayed per page.

Maximum number of products returned in a single page of results. Used for pagination controls and determining page boundaries in user interfaces.

ProductsResponse.page ● Int! non-null scalar​

Current page number in the result set.

One-based page number indicating which page of results is currently being displayed. Used for pagination navigation and result positioning.

ProductsResponse.pages ● Int! non-null scalar​

Total number of pages available.

Calculated value representing the total number of pages needed to display all matching products based on the current page size. Used for pagination controls.

ProductsResponse.start ● Int! non-null scalar​

Starting position of items on the current page.

One-based index of the first item displayed on the current page within the complete result set. Used for displaying result position information.

ProductsResponse.end ● Int! non-null scalar​

Ending position of items on the current page.

One-based index of the last item displayed on the current page within the complete result set. Used for displaying result range information.

ProductsResponse.minPrice ● Int! non-null scalar​

Lowest price found among all matching products.

Minimum price value across all products in the search results, used for price range filtering and displaying price bounds to customers.

ProductsResponse.maxPrice ● Int! non-null scalar​

Highest price found among all matching products.

Maximum price value across all products in the search results, used for price range filtering and displaying price bounds to customers.

ProductsResponse.filters ● [AttributeFilter!] list object​

Available attribute filters for refining search results.

Collection of filterable attributes with their available values and counts, used for building faceted search interfaces and allowing customers to narrow down product results.

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