magento-nodejs
Version:
Magento SOAP API wrapper for Node.js
147 lines (106 loc) • 3.91 kB
Markdown
# Catalog Category
## [assignedProducts](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.assignedProducts.html)
Retrieve the list of products assigned to a required category.
```js
magento.catalogCategory.assignedProducts({
categoryId: val
}, callback);
```
## [assignProduct](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.assignProduct.html)
Create a new category and return its ID.
```js
magento.catalogCategory.assignProduct({
categoryId: val,
product: val,
position: val /* optional */
}, callback);
```
## [create](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.create.html)
Create a new category and return its ID.
`data` is a catalogCategoryEntityCreate object.
```js
magento.catalogCategory.create({
categoryId: val,
data: val,
storeView: val /* optional */
}, callback);
```
## [currentStore](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.currentStore.html)
Allows you to set/get the current store view.
```js
magento.catalogCategory.currentStore({
storeView: val
}, callback);
```
## [delete](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.delete.html)
Allows you to delete the required category.
```js
magento.catalogCategory.delete({
categoryId: val
}, callback);
```
## [info](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.info.html)
Allows you to retrieve information about the required category.
```js
magento.catalogCategory.info({
categoryId: val,
storeView: val, /* optional */
attributes: val /* optional */
}, callback);
```
## [level](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.level.html)
Allows you to retrieve one level of categories by a website, a store view, or a parent category.
```js
magento.catalogCategory.level(callback);
// or
magento.catalogCategory.level({
website: val, /* optional */
storeView: val, /* optional */
parentCategory: val /* optional */
}, callback);
```
## [move](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.move.html)
Allows you to move the required category in the category tree.
```js
magento.catalogCategory.move({
categoryId: val,
parentId: val,
afterId: val /* optional */
}, callback);
```
## [removeProduct](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.removeProduct.html)
Allows you to remove the product assignment from the category.
```js
magento.catalogCategory.removeProduct({
categoryId: val,
productId: val
}, callback);
```
## [tree](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.tree.html)
Allows you to retrieve the hierarchical tree of categories.
```js
magento.catalogCategory.tree(callback);
// or
magento.catalogCategory.tree({
parentId: val, /* optional */
storeView: val /* optional */
}, callback);
```
## [update](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.update.html)
Update the required category. Note that you should specify only those parameters which you want to be updated.
```js
magento.catalogCategory.update({
categoryId: val,
categoryData: val,
storeView: val /* optional */
}, callback);
```
## [updateProduct](http://www.magentocommerce.com/api/soap/catalog/catalogCategory/catalog_category.updateProduct.html)
Allows you to update the product assigned to a category. The product position is updated.
```js
magento.catalogCategory.updateProduct({
categoryId: val,
productId: val,
position: val /* optional */
}, callback);
```