initial commit

Author: tmarshall

.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+*/node_modules/
+.DS_Store
+*/.DS_Store
+*.txt
+*.log

README.md

@@ -0,0 +1,60 @@
+# Magento SOAP API Wrapper
+
+This wrapper lets you talk to Magento via SOAP.
+
+```js
+var magento = require('magento')({
+  host: 'your.host',
+  port: 80,
+  path: '/api/xmlrpc/',
+  login: 'your_username',
+  pass: 'your_pass'
+});
+
+magento.login(function(err, sessId) {
+  if (err) {
+    // deal with error
+    return;
+  }
+
+  // use magento
+});
+```
+
+All of the API methods take an object of params as the first argument, and a callback as the second.
+
+Or, if no params are sent, just a callback as the first argument.
+
+## Methods
+
++ [Catalog Category](./readmes/catalog_category.md)
++ [Catalog Category Attribute](./readmes/catalog_category_attribute.md)
++ [Catalog Product](./readmes/catalog_product.md)
++ [Catalog Product Attribute](./readmes/catalog_product_attribute.md)
++ [Catalog Product Attribute Media](./readmes/catalog_product_attribute_media.md)
++ [Catalog Product Attribute Set](./readmes/catalog_product_attribute_set.md)
++ [Catalog Product Custom Option](./readmes/catalog_product_custom_option.md)
++ [Catalog Product Custom Option Value](./readmes/catalog_product_custom_option_value.md)
++ [Catalog Product Downloadable Link](./readmes/catalog_product_downloadable_link.md)
++ [Catalog Product Link](./readmes/catalog_product_link.md)
++ [Catalog Product Tag](./readmes/catalog_product_tag.md)
++ [Catalog Product Tier Price](./readmes/catalog_product_tier_price.md)
++ [Catalog Product Type](./readmes/catalog_product_type.md)
++ [Catalog Inventory Stock Item](./readmes/catalogInventory_stock_item.md)
++ [Checkout Cart](./readmes/checkout_cart.md)
++ [Checkout Cart Coupon](./readmes/checkout_cart_coupon.md)
++ [Checkout Cart Customer](./readmes/checkout_cart_customer.md)
++ [Checkout Cart Payment](./readmes/checkout_cart_payment.md)
++ [Checkout Cart Product](./readmes/checkout_cart_product.md)
++ [Checkout Cart Shipping](./readmes/checkout_cart_shipping.md)
++ [Core](./readmes/core.md)
++ [Customer](./readmes/customer.md)
++ [Customer Address](./readmes/customer_address.md)
++ [Customer Group](./readmes/customer_group.md)
++ [Directory Country](./readmes/directory_country.md)
++ [Directory Region](./readmes/directory_region.md)
++ [Sales Order](./readmes/sales_order.md)
++ [Sales Order Credit Memo](./readmes/sales_order_credit_memo.md)
++ [Sales Order Invoice](./readmes/sales_order_invoice.md)
++ [Sales Order Shipment](./readmes/sales_order_shipment.md)
++ [Store](./readmes/store.md)

package.json

@@ -0,0 +1,28 @@
+{
+  "name": "Magento",
+  "author": "Tim Marshall <timothyjmarshall@gmail.com>",
+  "description": "Magento SOAP API wrapper for Node.js",
+  "version": "0.0.0",
+  "main": "./src/magento",
+  "contributors": [
+    {
+      "name": "Tim Marshall",
+      "email": "timothyjmarshall@gmail.com"
+    }
+  ],
+  "engines": {
+    "node": ">=0.10.20"
+  },
+  "dependencies" : {
+    "request": "2.34.0",
+    "xmlrpc": "1.2.0"
+  },
+  "keywords": [
+    "magento",
+    "soap",
+    "api",
+    "xml"
+  ],
+  "repository": "git://github.com/MadisonReed/magentoapi",
+  "license": "MIT"
+}

readmes/catalogInventory_stock_item.md

@@ -0,0 +1,30 @@
+# Catalog Inventory Stock Item
+
+## [list](http://www.magentocommerce.com/api/soap/catalogInventory/cataloginventory_stock_item.list.html)
+
+Allows you to retrieve the list of stock data by product IDs.
+
+```js
+magento.catalogInventoryStockItem.list({
+  products: [ val, val, val ]
+}, callback);
+
+// or a single product
+
+magento.catalogInventoryStockItem.list({
+  products: val
+}, callback);
+```
+
+## [update](http://www.magentocommerce.com/api/soap/catalogInventory/cataloginventory_stock_item.update.html)
+
+Allows you to update the required product stock data.
+
+`data` is a catalogInventoryStockItemUpdateEntity object.
+
+```js
+magento.catalogInventoryStockItem.update({
+  product: val,
+  data: val
+}, callback);
+```

readmes/catalog_category.md

@@ -0,0 +1,147 @@
+# 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);
+```

readmes/catalog_category_attribute.md

@@ -0,0 +1,30 @@
+# Catalog Category Attribute
+
+## [currentStore](http://www.magentocommerce.com/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.currentStore.html)
+
+Allows you to set/get the current store view.
+
+```js
+magento.catalogCategoryAttribute.currentStore({
+  storeView: val
+}, callback);
+```
+
+## [list](http://www.magentocommerce.com/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.list.html)
+
+Allows you to retrieve the list of category attributes.
+
+```js
+magento.catalogCategoryAttribute.list(callback);
+```
+
+## [options](http://www.magentocommerce.com/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.options.html)
+
+Allows you to retrieve the attribute options.
+
+```js
+magento.catalogCategoryAttribute.options({
+  attributeId:  val,
+  storeView:    val
+}, callback);
+```