search

Description:
  • Interface to search related API calls
Source:
Interface to search related API calls

Methods

(inner) getSearchResults(query, parametersopt, networkParametersopt) → {Promise}

Description:
  • Retrieve search results from Constructor.io API
Source:
See:
Example
constructorio.search.getSearchResults('t-shirt', {
    resultsPerPage: 40,
    filters: {
        size: 'medium'
    },
});
Parameters:
Name Type Attributes Description
query string Term to use to perform a search
parameters object <optional>
 Additional parameters to refine result set
Properties
Name Type Attributes Default Description
page number <optional>
 The page number of the results(Can't be used together with offset)
offset number <optional>
 The number of results to skip from the beginning (Can't be used together with page)
resultsPerPage number <optional>
 The number of results per page to return
filters object <optional>
 Key / value mapping (dictionary) of filters used to refine results
sortBy string <optional>
 'relevance' The sort method for results
sortOrder string <optional>
 'descending' The sort order for results
section string <optional>
 'Products' The section name for results
fmtOptions object <optional>
 The format options used to refine result groups. Please refer to https://docs.constructor.io/rest_api/search/queries for details
preFilterExpression object <optional>
 Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections#add-items-dynamically
hiddenFields Array.<string> <optional>
 Hidden metadata fields to return
hiddenFacets Array.<string> <optional>
 Hidden facets to return
variationsMap object <optional>
 The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
qsParam object <optional>
 Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/search/queries/
networkParameters object <optional>
 Parameters relevant to the network request
Properties
Name Type Attributes Description
timeout number <optional>
 Request timeout (in milliseconds)
Returns:
Type
Promise

(inner) getVoiceSearchResults(query, parametersopt, networkParametersopt) → {Promise}

Description:
  • Retrieve voice search results from Constructor.io API
Source:
See:
Example
constructorio.search.getVoiceSearchResults('show me lipstick');
Parameters:
Name Type Attributes Description
query string Term to use to perform a voice search
parameters object <optional>
 Additional parameters to refine result set
Properties
Name Type Attributes Default Description
page number <optional>
 The page number of the results (Can't be used together with offset)
offset number <optional>
 The number of results to skip from the beginning (Can't be used together with page)
resultsPerPage number <optional>
 The number of results per page to return
section string <optional>
 'Products' The section name for results
fmtOptions object <optional>
 The format options used to refine result groups. Please refer to https://docs.constructor.io/rest_api/search/queries for details
preFilterExpression object <optional>
 Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections#add-items-dynamically
variationsMap object <optional>
 The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
hiddenFields Array.<string> <optional>
 Hidden metadata fields to return
hiddenFacets Array.<string> <optional>
 Hidden facets to return
qsParam object <optional>
 Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/search/queries/
networkParameters object <optional>
 Parameters relevant to the network request
Properties
Name Type Attributes Description
timeout number <optional>
 Request timeout (in milliseconds)
Returns:
Type
Promise