Class: module:api/ProductSearchApi

module:api/ProductSearchApi(apiClient)

new module:api/ProductSearchApi(apiClient)

Constructs a new ProductSearchApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.

Source:

Methods

getProductSearch(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link and name in the product search hit. Other search hit properties can be added by using the expand parameter. The search result contains only products that are online and assigned to site catalog. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). htypes: Allow to refine by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'. orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

expand Array.<String>

The expand parameter. A comma separated list with the allowed values (availability, images, prices, represented_products, variations)

currency String

The currency mnemonic specified for price. This parameter is effective only if specified expand parameter value contains prices.

locale String

The locale context.

Source:
Returns:
Type
Promise

getProductSearchAvailability(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link, name and availability information in the product search hit. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

locale String

The locale context.

Source:
Returns:
Type
Promise

getProductSearchAvailabilityWithHttpInfo(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link, name and availability information in the product search hit. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

locale String

The locale context.

Source:
Returns:

a Promise, with an object containing data of type module:models/ProductSearchResult and HTTP response

Type
Promise

getProductSearchImages(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link, name and image information in the product search hit. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

locale String

The locale context.

Source:
Returns:
Type
Promise

getProductSearchImagesWithHttpInfo(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link, name and image information in the product search hit. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

locale String

The locale context.

Source:
Returns:

a Promise, with an object containing data of type module:models/ProductSearchResult and HTTP response

Type
Promise

getProductSearchPrices(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link, name and price information in the product search hit. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

currency String

The currency mnemonic specified for price.

locale String

The locale context.

Source:
Returns:
Type
Promise

getProductSearchPricesWithHttpInfo(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link, name and price information in the product search hit. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

currency String

The currency mnemonic specified for price.

locale String

The locale context.

Source:
Returns:

a Promise, with an object containing data of type module:models/ProductSearchResult and HTTP response

Type
Promise

getProductSearchRepresentedProducts(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link, name and represented product information in the product search hit. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

locale String

The locale context.

Source:
Returns:
Type
Promise

getProductSearchRepresentedProductsWithHttpInfo(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link, name and represented product information in the product search hit. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

locale String

The locale context.

Source:
Returns:

a Promise, with an object containing data of type module:models/ProductSearchResult and HTTP response

Type
Promise

getProductSearchVariations(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, name and variation information in the product search hit. This resource does not return detailed information about variation products. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

locale String

The locale context.

Source:
Returns:
Type
Promise

getProductSearchVariationsWithHttpInfo(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, name and variation information in the product search hit. This resource does not return detailed information about variation products. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

locale String

The locale context.

Source:
Returns:

a Promise, with an object containing data of type module:models/ProductSearchResult and HTTP response

Type
Promise

getProductSearchWithHttpInfo(opts) → {Promise}

Provides keyword and refinement search functionality for products. Only returns the product id, link and name in the product search hit. Other search hit properties can be added by using the expand parameter. The search result contains only products that are online and assigned to site catalog. This resource does not return detailed information about variation products. If a variation product matches the query, basic information for the parent master product is returned. Use the products resource to retrieve more details about a variation product.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
q String

The query phrase to search for.

refine Array.<String>

Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by '='. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = &quot;|&quot;). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. The following system refinement attribute ids are supported: cgid: Allows to refine per single category id. Multiple category ids are not supported. price: Allows to refine per single price range. Multiple price ranges are not supported. pmid: Allows to refine per promotion id(s). htypes: Allow to refine by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'. orderable_only: Unavailable products will be excluded from the search results if true is set. Multiple refinement values are not supported.

sort String

The id of the sorting option to sort the search hits.

start Number

The result set index to return the first instance for. Default value is 0.

count Number

The maximum number of instances per request. Default value is 25.

expand Array.<String>

The expand parameter. A comma separated list with the allowed values (availability, images, prices, represented_products, variations)

currency String

The currency mnemonic specified for price. This parameter is effective only if specified expand parameter value contains prices.

locale String

The locale context.

Source:
Returns:

a Promise, with an object containing data of type module:models/ProductSearchResult and HTTP response

Type
Promise