new module:api/ProductsApi(apiClient)
Constructs a new ProductsApi.
Parameters:
| Name | Type | Description |
|---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, default to module:ApiClient#instance if unspecified. |
- Source:
Methods
getProduct(productCode, opts) → {Promise}
getProduct Returns details of a single product according to a product code.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/ProductOCC1
- Type
- Promise
getProductExpressupdate(opts) → {Promise}
getProductExpressupdate Returns products added to the express update feed. Returns only elements updated after the provided timestamp.The queue is cleared using a defined cronjob. Security: Permitted only for trusted client
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/ProductExpressUpdateElementList
- Type
- Promise
getProductReferences(productCode, opts) → {Promise}
getProductReferences Returns references for a product with a given product code. Reference type specifies which references to return. Security: Permitted only for trusted client
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/ProductReferenceList
- Type
- Promise
getProductReviews(productCode) → {Promise}
getProductReviews Returns the reviews for a product with a given product code.
Parameters:
| Name | Type | Description |
|---|---|---|
productCode |
String | Product identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/ReviewList
- Type
- Promise
getProductSearch(opts) → {Promise}
ProductsSearch Returns a list of products and additional data such as: available facets, available sorting and pagination options. It can include spelling suggestions.To make spelling suggestions work you need to: <ul> <li>Make sure enableSpellCheck on the SearchQuery is set to true. By default it should be already set to true. </li> <li>Have indexed properties configured to be used for spellchecking.</li> </ul>
Parameters:
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/ProductSearchPage
- Type
- Promise
getProductsStockByProductCodeAndStoreName(productCode, storeName, opts) → {Promise}
getProductsStockByProductCodeAndStoreName Returns product's stock level for a particular store (POS).
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
||||||
storeName |
String | Store identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/Stock
- Type
- Promise
getProductStock(productCode, opts) → {Promise}
ProductsStockByProductCode Returns product's stock levels sorted by distance from specific location passed by free-text parameter or longitude and latitude parameters. The following two sets of parameters are available: <ul> <li>location (required), currentPage (optional), pageSize (optional) or</li>> <li>longitude (required), latitude (required), currentPage (optional), pageSize(optional).</li> </ul>
Parameters:
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
|||||||||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/StoreFinderStockSearchPage
- Type
- Promise
getProductSuggestions(max, term, opts) → {Promise}
getProductSuggestions Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
max |
String | Specifies the limit of results. |
||||||
term |
String | Specified term |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/SuggestionList
- Type
- Promise
postProductReview(productCode, body, opts) → {Promise}
postProductReview Creates a new customer review as an anonymous user.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
||||||
body |
module:models/ReviewOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/ReviewOCC
- Type
- Promise
productsByProductCodeWithHttpInfo(productCode, opts) → {Promise}
getProduct Returns details of a single product according to a product code.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/ProductOCC1 and HTTP response
- Type
- Promise
productsExpressupdateWithHttpInfo(opts) → {Promise}
getProductExpressupdate Returns products added to the express update feed. Returns only elements updated after the provided timestamp.The queue is cleared using a defined cronjob. Security: Permitted only for trusted client
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/ProductExpressUpdateElementList and HTTP response
- Type
- Promise
productsReferencesByProductCodeWithHttpInfo(productCode, opts) → {Promise}
getProductReferences Returns references for a product with a given product code. Reference type specifies which references to return. Security: Permitted only for trusted client
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/ProductReferenceList and HTTP response
- Type
- Promise
productsReviewsByProductCode1WithHttpInfo(productCode, body, opts) → {Promise}
postProductReview Creates a new customer review as an anonymous user.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
||||||
body |
module:models/ReviewOCC | |||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/ReviewOCC and HTTP response
- Type
- Promise
productsReviewsByProductCodeWithHttpInfo(productCode) → {Promise}
getProductReviews Returns the reviews for a product with a given product code.
Parameters:
| Name | Type | Description |
|---|---|---|
productCode |
String | Product identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/ReviewList and HTTP response
- Type
- Promise
productsSearch1WithHttpInfo(opts) → {Promise}
ProductsSearch Returns a list of products and additional data such as: available facets, available sorting and pagination options. It can include spelling suggestions.To make spelling suggestions work you need to: <ul> <li>Make sure enableSpellCheck on the SearchQuery is set to true. By default it should be already set to true. </li> <li>Have indexed properties configured to be used for spellchecking.</li> </ul>
Parameters:
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/ProductSearchPage and HTTP response
- Type
- Promise
productsStockByProductCode1WithHttpInfo(productCode, opts) → {Promise}
ProductsStockByProductCode Returns product's stock levels sorted by distance from specific location passed by free-text parameter or longitude and latitude parameters. The following two sets of parameters are available: <ul> <li>location (required), currentPage (optional), pageSize (optional) or</li>> <li>longitude (required), latitude (required), currentPage (optional), pageSize(optional).</li> </ul>
Parameters:
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
|||||||||||||||||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/StoreFinderStockSearchPage and HTTP response
- Type
- Promise
productsStockByProductCodeAndStoreNameWithHttpInfo(productCode, storeName, opts) → {Promise}
getProductsStockByProductCodeAndStoreName Returns product's stock level for a particular store (POS).
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
productCode |
String | Product identifier |
||||||
storeName |
String | Store identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Stock and HTTP response
- Type
- Promise
productsSuggestionsWithHttpInfo(max, term, opts) → {Promise}
getProductSuggestions Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
max |
String | Specifies the limit of results. |
||||||
term |
String | Specified term |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/SuggestionList and HTTP response
- Type
- Promise