Skip to main content
The Browse module provides methods to retrieve and navigate product catalog data. Browse is ideal for category pages, faceted navigation, and building product listing experiences.

Available Methods

getBrowseResults

Retrieve browse results filtered by facet name and value

getBrowseResultsForItemIds

Retrieve browse results for specific item IDs

getBrowseGroups

Retrieve browse groups (categories and collections)

Common Use Cases

Category Pages

Use getBrowseResults() to display products in a specific category:
const results = await constructorio.browse.getBrowseResults(
  'group_id',
  'mens-shirts',
  {
    resultsPerPage: 24,
    sortBy: 'relevance'
  }
);

Faceted Navigation

Apply filters and filter match types for advanced filtering:
const results = await constructorio.browse.getBrowseResults(
  'category',
  'electronics',
  {
    filters: {
      brand: ['Apple', 'Samsung'],
      price: '100-500'
    },
    filterMatchTypes: {
      brand: 'any'
    }
  }
);

Product Collections

Retrieve specific products by their IDs:
const results = await constructorio.browse.getBrowseResultsForItemIds(
  ['prod-123', 'prod-456', 'prod-789'],
  {
    section: 'Products'
  }
);

Response Structure

All browse methods return a Promise that resolves to a response object with the following structure:
request
object
Information about the request that was made
response
object
The browse results data
result_id
string
Unique identifier for this result set (used for analytics tracking)

Additional Resources

Build docs developers (and LLMs) love