browse

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

Methods

(inner) getBrowseFacetOptions(facetName, parametersopt, userParametersopt, networkParametersopt) → {Promise}

Description:
  • Retrieve facet options from API
Source:
See:
Example
constructorio.browse.getBrowseFacetOptions('price', {
    fmtOptions: { ... },
});
Parameters:
Name Type Attributes Description
facetName string Name of the facet whose options to return
parameters object <optional>
 Additional parameters to refine result set
Properties
Name Type Attributes Default Description
section string <optional>
 'Products' The section name for results
fmtOptions object <optional>
 The format options used to refine result groups
Properties
Name Type Attributes Description
show_hidden_facets boolean <optional>
 Include facets configured as hidden
show_protected_facets boolean <optional>
 Include facets configured as protected
userParameters object <optional>
 Parameters relevant to the user request
Properties
Name Type Attributes Description
sessionId number <optional>
 Session ID, utilized to personalize results
clientId string <optional>
 Client ID, utilized to personalize results
userId string <optional>
 User ID, utilized to personalize results
segments Array.<string> <optional>
 User segments
testCells object <optional>
 User test cells
userIp string <optional>
 Origin user IP, from client
userAgent string <optional>
 Origin user agent, from client
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) getBrowseFacets(parametersopt, userParametersopt, networkParametersopt) → {Promise}

Description:
  • Retrieve facets from API
Source:
See:
Example
constructorio.browse.getBrowseFacets({
    page: 1,
    resultsPerPage: 10,
});
Parameters:
Name Type Attributes Description
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'
section string <optional>
 'Products' The section name for results
resultsPerPage number <optional>
 The number of results per page to return
fmtOptions object <optional>
 The format options used to refine result groups
Properties
Name Type Attributes Description
show_hidden_facets boolean <optional>
 Include facets configured as hidden
show_protected_facets boolean <optional>
 Include facets configured as protected
userParameters object <optional>
 Parameters relevant to the user request
Properties
Name Type Attributes Description
sessionId number <optional>
 Session ID, utilized to personalize results
clientId string <optional>
 Client ID, utilized to personalize results
userId string <optional>
 User ID, utilized to personalize results
segments Array.<string> <optional>
 User segments
testCells object <optional>
 User test cells
userIp string <optional>
 Origin user IP, from client
userAgent string <optional>
 Origin user agent, from client
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) getBrowseGroups(userParametersopt, networkParametersopt) → {Promise}

Description:
  • Retrieve browse groups from API
Source:
See:
Example
constructorio.browse.getBrowseGroups({
    filters: {
        group_id: 'drill_collection'
    },
    fmtOptions: {
        groups_max_depth: 2
    }
});
Parameters:
Name Type Attributes Default Description
parameters.filters object <optional>
 Filters used to refine results
parameters.section string <optional>
 'Products' The section name for results
parameters.fmtOptions object <optional>
 The format options used to refine result groups
userParameters object <optional>
 Parameters relevant to the user request
Properties
Name Type Attributes Description
sessionId number <optional>
 Session ID, utilized to personalize results
clientId string <optional>
 Client ID, utilized to personalize results
userId string <optional>
 User ID, utilized to personalize results
segments Array.<string> <optional>
 User segments
testCells object <optional>
 User test cells
userIp string <optional>
 Origin user IP, from client
userAgent string <optional>
 Origin user agent, from client
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) getBrowseResults(filterName, filterValue, parametersopt, userParametersopt, networkParametersopt) → {Promise}

Description:
  • Retrieve browse results from API
Source:
See:
Example
constructorio.browse.getBrowseResults('group_id', 't-shirts', {
    resultsPerPage: 40,
    filters: {
        size: 'medium'
    },
});
Parameters:
Name Type Attributes Description
filterName string Filter name to display results from
filterValue string Filter value to display results from
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>
 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
hiddenFields Array.<string> <optional>
 Hidden metadata fields to return
hiddenFacets Array.<string> <optional>
 Hidden facet fields 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
preFilterExpression object <optional>
 Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections/#add-items-dynamically 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/browse/queries for details
userParameters object <optional>
 Parameters relevant to the user request
Properties
Name Type Attributes Description
sessionId number <optional>
 Session ID, utilized to personalize results
clientId string <optional>
 Client ID, utilized to personalize results
userId string <optional>
 User ID, utilized to personalize results
segments Array.<string> <optional>
 User segments
testCells object <optional>
 User test cells
userIp string <optional>
 Origin user IP, from client
userAgent string <optional>
 Origin user agent, from client
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) getBrowseResultsForItemIds(itemIds, parametersopt, userParametersopt, networkParametersopt) → {Promise}

Description:
  • Retrieve browse results from API using item IDs
Source:
See:
Example
constructorio.browse.getBrowseResultsForItemIds(['shirt-123', 'shirt-456', 'shirt-789'], {
    filters: {
        size: 'medium'
    },
});
Parameters:
Name Type Attributes Description
itemIds Array.<string> Item IDs of results to fetch
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>
 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
hiddenFields Array.<string> <optional>
 Hidden metadata fields to return
hiddenFacets Array.<string> <optional>
 Hidden facet fields 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
userParameters object <optional>
 Parameters relevant to the user request
Properties
Name Type Attributes Description
sessionId number <optional>
 Session ID, utilized to personalize results
clientId string <optional>
 Client ID, utilized to personalize results
userId string <optional>
 User ID, utilized to personalize results
segments Array.<string> <optional>
 User segments
testCells object <optional>
 User test cells
userIp string <optional>
 Origin user IP, from client
userAgent string <optional>
 Origin user agent, from client
networkParameters object <optional>
 Parameters relevant to the network request
Properties
Name Type Attributes Description
timeout number <optional>
 Request timeout (in milliseconds)
Returns:
Type
Promise