====== Magento Core API (per module) ====== ==== Mage_Customer ==== ... Allows to export/import customer/customer addresses from/into Magento ... API resources: === Customer API === **Resource Name:** [[doc:webservices-api:api:customer|customer]] **Methods:** * [[doc:webservices-api:api:customer#customer.list|customer.list]] - Retrieve customers * [[doc:webservices-api:api:customer#customer.create|customer.create]] - Create customer * [[doc:webservices-api:api:customer#customer.info|customer.info]] - Retrieve customer data * [[doc:webservices-api:api:customer#customer.update|customer.update]] - Update customer data * [[doc:webservices-api:api:customer#customer.delete|customer.delete]] - Delete customer === Customer's Groups API === **Resource Name:** [[doc:webservices-api:api:customer_group|customer_group]] **Methods:** * [[doc:webservices-api:api:customer_group#list|customer_group.list]] - Retrieve customer's groups === Customer Address API === **Resource Name:** [[doc:webservices-api:api:customer_address|customer_address]] **Methods:** * [[doc:webservices-api:api:customer_address#customer_address.list|customer_address.list]] - Retrieve customer addresses * [[doc:webservices-api:api:customer_address#customer_address.create|customer_address.create]] - Create customer address * [[doc:webservices-api:api:customer_address#customer_address.info|customer_address.info]] - Retrieve customer address * [[doc:webservices-api:api:customer_address#customer_address.update|customer_address.update]] - Update customer address * [[doc:webservices-api:api:customer_address#customer_address.delete|customer_address.delete]] - Delete customer address ==== Mage_Directory ==== Allows to retrieve countries and regions from magento. API resources: === Country API === **Resource Name:** [[doc:webservices-api:api:directory_country|directory_country]] **Aliases:** * country **Methods:** * [[doc:webservices-api:api:directory_country#directory_country.list|directory_country.list]] - List of countries === Region API === **Resource Name:** [[doc:webservices-api:api:directory_region|directory_region]] **Aliases:** * region **Methods:** * [[doc:webservices-api:api:directory_region#directory_region.list|directory_region.list]] - List of regions in specified country ==== Mage_Catalog ==== ... Allows to export/import categories and products from/into Magento ... API resources: === Category API === **Resource Name:** [[doc:webservices-api:api:catalog_category|catalog_category]] **Aliases:** * category **Methods:** * [[doc:webservices-api:api:catalog_category#catalog_category.currentStore|catalog_category.currentStore]] - Set/Get current store view * [[doc:webservices-api:api:catalog_category#catalog_category.tree|catalog_category.tree]] - Retrieve hierarchical tree * [[doc:webservices-api:api:catalog_category#catalog_category.level|catalog_category.level]] - Retrieve one level of categories by website/store view/parent category * [[doc:webservices-api:api:catalog_category#catalog_category.info|catalog_category.info]] - Retrieve category data * [[doc:webservices-api:api:catalog_category#catalog_category.create|catalog_category.create]] - Create new category * [[doc:webservices-api:api:catalog_category#catalog_category.update|catalog_category.update]] - Update category * [[doc:webservices-api:api:catalog_category#catalog_category.move|catalog_category.move]] - Move category in tree * [[doc:webservices-api:api:catalog_category#catalog_category.delete|catalog_category.delete]] - Delete category * [[doc:webservices-api:api:catalog_category#catalog_category.assignedProducts|catalog_category.assignedProducts]] - Retrieve list of assigned products * [[doc:webservices-api:api:catalog_category#catalog_category.assignProduct|catalog_category.assignProduct]] - Assign product to category * [[doc:webservices-api:api:catalog_category#catalog_category.updateProduct|catalog_category.updateProduct]] - Update assigned product * [[doc:webservices-api:api:catalog_category#catalog_category.removeProduct|catalog_category.removeProduct]] - Remove product assignment === Category attributes API === **Resource Name:** [[doc:webservices-api:api:catalog_category_attribute|catalog_category_attribute]] **Aliases:** * category_attribute **Methods:** * [[doc:webservices-api:api:catalog_category_attribute#catalog_category_attribute.currentStore|catalog_category_attribute.currentStore]] - Set/Get current store view * [[doc:webservices-api:api:catalog_category_attribute#catalog_category_attribute.list|catalog_category_attribute.list]] - Retrieve category attributes * [[doc:webservices-api:api:catalog_category_attribute#catalog_category_attribute.options|catalog_category_attribute.options]] - Retrieve attribute options === Product API === **Resource Name:** [[doc:webservices-api:api:catalog_product|catalog_product]] **Aliases:** * product **Methods:** * [[doc:webservices-api:api:catalog_product#catalog_product.currentStore|catalog_product.currentStore]] - Set/Get current store view * [[doc:webservices-api:api:catalog_product#catalog_product.list|catalog_product.list]] - Retrieve products list by filters * [[doc:webservices-api:api:catalog_product#catalog_product.info|catalog_product.info]] - Retrieve product * [[doc:webservices-api:api:catalog_product#catalog_product.create|catalog_product.create]] - Create new product * [[doc:webservices-api:api:catalog_product#catalog_product.update|catalog_product.update]] - Update product * [[doc:webservices-api:api:catalog_product#catalog_product.setSpecialPrice|catalog_product.setSpecialPrice]] - Set special price for product * [[doc:webservices-api:api:catalog_product#catalog_product.getSpecialPrice|catalog_product.getSpecialPrice]] - Get special price for product * [[doc:webservices-api:api:catalog_product#catalog_product.delete|catalog_product.delete]] - Delete product === Product attributes API === **Resource Name:** [[doc:webservices-api:api:catalog_product_attribute|catalog_product_attribute]] **Aliases:** * product_attribute **Methods:** * [[doc:webservices-api:api:catalog_product_attribute#catalog_product_attribute.currentStore|catalog_product_attribute.currentStore]] - Set/Get current store view * [[doc:webservices-api:api:catalog_product_attribute#catalog_product_attribute.list|catalog_product_attribute.list]] - Retrieve attribute list * [[doc:webservices-api:api:catalog_product_attribute#catalog_product_attribute.options|catalog_product_attribute.options]] - Retrieve attribute options === Product attribute sets API === **Resource Name:** [[doc:webservices-api:api:catalog_product_attribute_set|catalog_product_attribute_set]] **Aliases:** * product_attribute_set **Methods:** * [[doc:webservices-api:api:catalog_product_attribute_set#catalog_product_attribute_set.list|catalog_product_attribute_set.list]] - Retrieve product attribute sets === Product types API === **Resource Name:** [[doc:webservices-api:api:catalog_product_type|catalog_product_type]] **Aliases:** * product_type **Methods:** * [[doc:webservices-api:api:catalog_product_type#catalog_product_type.list|catalog_product_type.list]] - Retrieve product types === Product Images API === **Resource Name:** [[doc:webservices-api:api:catalog_product_attribute_media|catalog_product_attribute_media]] **Aliases:** * product_attribute_media * product_media **Methods:** * [[doc:webservices-api:api:catalog_product_attribute_media#catalog_product_attribute_media.currentStore|catalog_product_attribute_media.currentStore]] - Set/Get current store view * [[doc:webservices-api:api:catalog_product_attribute_media#catalog_product_attribute_media.list|catalog_product_attribute_media.list]] - Retrieve product image list * [[doc:webservices-api:api:catalog_product_attribute_media#catalog_product_attribute_media.info|catalog_product_attribute_media.info]] - Retrieve product image * [[doc:webservices-api:api:catalog_product_attribute_media#catalog_product_attribute_media.types|catalog_product_attribute_media.types]] - Retrieve product image types * [[doc:webservices-api:api:catalog_product_attribute_media#catalog_product_attribute_media.create|catalog_product_attribute_media.create]] - Upload new product image * [[doc:webservices-api:api:catalog_product_attribute_media#catalog_product_attribute_media.update|catalog_product_attribute_media.update]] - Update product image * [[doc:webservices-api:api:catalog_product_attribute_media#catalog_product_attribute_media.remove|catalog_product_attribute_media.remove]] - Remove product image === Product Tier Price API === **Resource Name:** [[doc:webservices-api:api:catalog_product_attribute_tier_price|catalog_product_attribute_tier_price]] **Aliases:** * product_attribute_tier_price * product_tier_price **Methods:** * [[doc:webservices-api:api:catalog_product_attribute_tier_price#catalog_product_attribute_tier_price.list|catalog_product_attribute_tier_price.info]] - Retrieve product tier prices * [[doc:webservices-api:api:catalog_product_attribute_tier_price#catalog_product_attribute_tier_price.update|catalog_product_attribute_tier_price.update]] - Update product tier prices === Product links API (related, cross sells, up sells) === **Resource Name:** [[doc:webservices-api:api:catalog_product_link|catalog_product_link]] **Aliases:** * product_link **Methods:** * [[doc:webservices-api:api:catalog_product_link#catalog_product_link.list|catalog_product_link.list]] - Retrieve linked products * [[doc:webservices-api:api:catalog_product_link#catalog_product_link.assign|catalog_product_link.assign]] - Assign product link * [[doc:webservices-api:api:catalog_product_link#catalog_product_link.update|catalog_product_link.update]] - Update product link * [[doc:webservices-api:api:catalog_product_link#catalog_product_link.remove|catalog_product_link.remove]] - Remove product link * [[doc:webservices-api:api:catalog_product_link#catalog_product_link.types|catalog_product_link.types]] - Retrieve product link types * [[doc:webservices-api:api:catalog_product_link#catalog_product_link.attributes|catalog_product_link.attributes]] - Retrieve product link type attributes ==== Mage_Sales ==== ... Allows to export/import sales orders from/into Magento, to create invoices, shipments, credit memos ... === Order API === **Resource Name:** [[doc:webservices-api:api:sales_order|sales_order]] **Aliases:** * order **Methods:** * [[doc:webservices-api:api:sales_order#sales_order.list|sales_order.list]] - Retrieve list of orders by filters * [[doc:webservices-api:api:sales_order#sales_order.info|sales_order.info]] - Retrieve order information * [[doc:webservices-api:api:sales_order#sales_order.addComment|sales_order.addComment]] - Add comment to order * [[doc:webservices-api:api:sales_order#sales_order.hold|sales_order.hold]] - Hold order * [[doc:webservices-api:api:sales_order#sales_order.unhold|sales_order.unhold]] - Unhold order * [[doc:webservices-api:api:sales_order#sales_order.cancel|sales_order.cancel]] - Cancel order === Shipment API === **Resource Name:** [[doc:webservices-api:api:sales_order_shipment|sales_order_shipment]] **Aliases:** * order_shipment **Methods:** * [[doc:webservices-api:api:sales_order_shipment#sales_order_shipment.list|sales_order_shipment.list]] - Retrieve list of shipments by filters * [[doc:webservices-api:api:sales_order_shipment#sales_order_shipment.info|sales_order_shipment.info]] - Retrieve shipment information * [[doc:webservices-api:api:sales_order_shipment#sales_order_shipment.create|sales_order_shipment.create]] - Create new shipment for order * [[doc:webservices-api:api:sales_order_shipment#sales_order_shipment.addComment|sales_order_shipment.addComment]] - Add new comment to shipment * [[doc:webservices-api:api:sales_order_shipment#sales_order_shipment.addTrack|sales_order_shipment.addTrack]] - Add new tracking number * [[doc:webservices-api:api:sales_order_shipment#sales_order_shipment.removeTrack|sales_order_shipment.removeTrack]] - Remove tracking number * [[doc:webservices-api:api:sales_order_shipment#sales_order_shipment.getCarriers|sales_order_shipment.getCarriers]] - Retrieve list of allowed carriers for order === Invoice API === **Resource Name:** [[doc:webservices-api:api:sales_order_invoice|sales_order_invoice]] **Aliases:** * order_invoice **Methods:** * [[doc:webservices-api:api:sales_order_invoice#sales_order_invoice.list|sales_order_invoice.list]] - Retrieve list of invoices by filters * [[doc:webservices-api:api:sales_order_invoice#sales_order_invoice.info|sales_order_invoice.info]] - Retrieve invoice information * [[doc:webservices-api:api:sales_order_invoice#sales_order_invoice.create|sales_order_invoice.create]] - Create new invoice for order * [[doc:webservices-api:api:sales_order_invoice#sales_order_invoice.addComment|sales_order_invoice.addComment]] - Add new comment to shipment * [[doc:webservices-api:api:sales_order_invoice#sales_order_invoice.capture|sales_order_invoice.capture]] - Capture invoice * [[doc:webservices-api:api:sales_order_invoice#sales_order_invoice.void|sales_order_invoice.void]] - Void invoice * [[doc:webservices-api:api:sales_order_invoice#sales_order_invoice.cancel|sales_order_invoice.cancel]] - Cancel invoice ==== Mage_CatalogInventory ==== ... Allows to update stock attributes (status, quantity) ... === Inventory API === **Resource Name:** [[doc:webservices-api:api:cataloginventory_stock_item|cataloginventory_stock_item]] **Aliases:** * product_stock **Methods:** * [[doc:webservices-api:api:cataloginventory_stock_item#cataloginventory_stock_item.list|cataloginventory_stock_item.list]] - Retrieve stock data by product ids * [[doc:webservices-api:api:cataloginventory_stock_item#cataloginventory_stock_item.update|cataloginventory_stock_item.update]] - Update product stock data