Skip to main content
The Search module provides methods to retrieve search results from the Constructor.io API. It supports both traditional text-based search and natural language voice search.

​
Available Methods

Get Search Results

Retrieve search results for a text query with advanced filtering and sorting options

Get Voice Search Results

Retrieve search results for natural language voice queries

​
Basic Usage

import ConstructorIO from '@constructor-io/constructorio-client-javascript';

const constructorio = new ConstructorIO({
  apiKey: 'YOUR_API_KEY'
});

// Simple search
const results = await constructorio.search.getSearchResults('red shoes');

// Search with filters
const filteredResults = await constructorio.search.getSearchResults('t-shirt', {
  resultsPerPage: 40,
  filters: {
    size: 'medium',
    color: 'blue'
  },
  sortBy: 'price',
  sortOrder: 'ascending'
});

​
Common Features

All search methods support:
  • Pagination - Control result sets with page, offset, and resultsPerPage
  • Filtering - Refine results using faceted filters
  • Sorting - Order results by relevance, price, or custom fields
  • Facets - Retrieve available filter options
  • Variations - Aggregate product variations
  • Hidden Fields - Request additional metadata fields

​
Response Structure

Search responses include:
  • results - Array of matching products
  • facets - Available filter options with counts
  • total_num_results - Total number of matching items
  • result_id - Unique identifier for tracking
  • sort_options - Available sorting methods
  • groups - Product groupings/categories
  • features - Active personalization features

​
Next Steps

Get Search Results

Learn about the full search API

Tracking Events

Track user interactions with search results

Build docs developers (and LLMs) love

Get started for freeTalk to us