Magento

The Magento Core API gives you the ability to manage customers, categories, products, sales, and the checkout process. It is also used to retrieve counties and the regions that those countries contain.

Note: This reference material applies to the v1 of the API.

To create your own API or to extend the Core API, follow the Custom API Tutorial.

For general information about the Magento API, go to the Introduction.

The Mage_Customer module allows you to create, retrieve, update, and delete customers and customer addresses.

Create, retrieve, update, and delete data about customers.

Resource Name: customer

Methods:

• customer.list - Retrieve customers
• customer.create - Create a new customer
• customer.info - Retrieve a customer’s data
• customer.update - Update a customer’s data
• customer.delete - Delete a customer

Retrieve a customer’s groups.

Resource Name: customer_group

Methods:

• customer_group.list - Retrieve a customer’s groups

Create, retrieve, update, and delete address data for a customer.

Resource Name: customer_address

Methods:

• customer_address.list - Retrieve a customer’s addresses
• customer_address.create - Create a new address for a customer
• customer_address.info - Retrieve the specified customer address
• customer_address.update - Update a customer’s address
• customer_address.delete - Delete a customer’s address

The Mage_Directory module allows you to retrieve country and region data.

Retrieve a list of countries.

Resource Name: directory_country

Aliases:

• country

Methods:

• directory_country.list - Retrieve a list of countries

Retrieve a list of regions within a country.

Resource Name: directory_region

Aliases:

• region

Methods:

• directory_region.list - Retrieve a list of regions in specified country

The Mage_Catalog module allows you to manage categories and products.

Manage categories and how products are assigned to categories

Resource Name: catalog_category

Aliases:

• category

Methods:

• catalog_category.currentStore - Set/Get the current store view
• catalog_category.tree - Retrieve the hierarchical category tree
• catalog_category.level - Retrieve one level of categories by website/store view/parent category
• catalog_category.info - Retrieve a category’s data
• catalog_category.create - Create a new category
• catalog_category.update - Update a category
• catalog_category.move - Move a category in its tree
• catalog_category.delete - Delete a category
• catalog_category.assignedProducts - Retrieve a list of products assigned to a category
• catalog_category.assignProduct - Assign product to a category
• catalog_category.updateProduct - Update an assigned product
• catalog_category.removeProduct - Remove a product assignment

Retrieve category attributes and options

Resource Name: catalog_category_attribute

Aliases:

• category_attribute

Methods:

• catalog_category_attribute.currentStore - Set/Get the current store view
• catalog_category_attribute.list - Retrieve a category’s attributes
• catalog_category_attribute.options - Retrieve attribute options

Manage products

Resource Name: catalog_product

Aliases:

• product

Methods:

• catalog_product.currentStore - Set/Get the current store view
• catalog_product.list - Retrieve products list using filters
• catalog_product.info - Retrieve a product
• catalog_product.create - Create a new product
• catalog_product.update - Update a product
• catalog_product.setSpecialPrice - Set special price for a product
• catalog_product.getSpecialPrice - Get special price for a product
• catalog_product.delete - Delete a product

Retrieve category attributes and options

Resource Name: catalog_product_attribute

Aliases:

• product_attribute

Methods:

• catalog_product_attribute.currentStore - Set/Get current store view
• catalog_product_attribute.list - Retrieve attribute list
• catalog_product_attribute.options - Retrieve attribute options

Retrieve product attribute sets

Resource Name: catalog_product_attribute_set

Aliases:

• product_attribute_set

Methods:

• catalog_product_attribute_set.list - Retrieve a product’s attribute sets

Retrieve product types

Resource Name: catalog_product_type

Aliases:

• product_type

Methods:

• catalog_product_type.list - Retrieve product types

Manage product images

Resource Name: catalog_product_attribute_media

Aliases:

• product_attribute_media
• product_media

Methods:

• catalog_product_attribute_media.currentStore - Set/Get the current store view
• catalog_product_attribute_media.list - Retrieve a product’s images
• catalog_product_attribute_media.info - Retrieve the specified product image
• catalog_product_attribute_media.types - Retrieve product image types
• catalog_product_attribute_media.create - Upload a new image for a product
• catalog_product_attribute_media.update - Update an image for a product
• catalog_product_attribute_media.remove - Remove an image for a product

Retrieve and update product tier prices

Resource Name: catalog_product_attribute_tier_price

Aliases:

• product_attribute_tier_price
• product_tier_price

Methods:

• catalog_product_attribute_tier_price.info - Retrieve a product’s tier prices
• catalog_product_attribute_tier_price.update - Update a product’s tier prices

Manage links for products, including related, cross sells, up sells, and grouped

Resource Name: catalog_product_link

Aliases:

• product_link

Methods:

• catalog_product_link.list - Retrieve products linked to the specified product
• catalog_product_link.assign - Link a product to another product
• catalog_product_link.update - Update a product link
• catalog_product_link.remove - Remove a product link
• catalog_product_link.types - Retrieve product link types
• catalog_product_link.attributes - Retrieve product link type attributes

The Mage_Sales module allows you to manage sales orders, invoices, shipments, and credit memos.

Manages orders

Resource Name: sales_order

Aliases:

• order

Methods:

• sales_order.list - Retrieve list of orders using filters
• sales_order.info - Retrieve an order’s information
• sales_order.addComment - Add comment to an order
• sales_order.hold - Hold an order
• sales_order.unhold - Unhold an order
• sales_order.cancel - Cancel an order

Manage shipments and tracking numbers

Resource Name: sales_order_shipment

Aliases:

• order_shipment

Methods:

• sales_order_shipment.list - Retrieve a list of shipments using filters
• sales_order_shipment.info - Retrieve a shipment’s information
• sales_order_shipment.create - Create a new shipment for an order
• sales_order_shipment.addComment - Add a new comment to a shipment
• sales_order_shipment.addTrack - Add new tracking number to a shipment
• sales_order_shipment.removeTrack - Remove tracking number from a shipment
• sales_order_shipment.getCarriers - Retrieve a list of allowed carriers for an order

Manage Credit Memo

Manage invoices

Resource Name: sales_order_invoice

Aliases:

• order_invoice

Methods:

• sales_order_invoice.list - Retrieve a list of invoices using filters
• sales_order_invoice.info - Retrieve an invoice’s information
• sales_order_invoice.create - Create new invoice for an order
• sales_order_invoice.addComment - Add new comment to an invoice
• sales_order_invoice.capture - Capture an invoice
• sales_order_invoice.void - Void an invoice
• sales_order_invoice.cancel - Cancel an invoice

The Mage_CatalogInventory module allows you to retrieve and update stock attributes, such as status and quantity.

Retrieve and update stock data

Resource Name: cataloginventory_stock_item

Aliases:

• product_stock

Methods:

• cataloginventory_stock_item.list - Retrieve stock data given a list of product IDs
• cataloginventory_stock_item.update - Update stock data for a list of products

The Mage_Checkout module allows you to manage shopping carts and the checkout process. This module allows you to create an order once filling the shopping cart is complete.

Manage shopping carts

Resource Name: cart

Methods:

• cart.create - Create a blank shopping cart
• cart.order - Create an order from a shopping cart
• cart.info - Get full information about the current shopping cart
• cart.totals - Get all available prices for items in shopping cart, using additional parameters
• cart.licenseAgreement - Get website license agreement

Manage products in a shopping cart

Resource Name: cart_product

Methods:

• cart_product.add - Add one or more products into a shopping cart
• cart_product.update - Update one or more products in a shopping cart
• cart_product.remove - Remove one or more products from a shopping cart
• cart_product.list - Get a list of products in a shopping cart
• cart_product.moveToCustomerQuote - Move one or more products from Quote To Customer Shopping cart

Add customer information and addresses into a shopping cart

Resource Name: cart_customer

Methods:

• cart_customer.set - Add customer information into a shopping cart
• cart_customer.addresses - Set customer’s addresses (shipping and billing) into a shopping cart

Retrieve and set shipping methods for a shopping cart

Resource Name: cart_shipping

Methods:

• cart_shipping.method - Set a shipping method for a shopping cart
• cart_shipping.list - Retrieve list of available shipping methods for a shopping cart

Retrieve and set payment methods for a shopping cart

Resource Name: cart_payment

Methods:

• cart_payment.method - Set a payment method for a shopping cart
• cart_payment.list - Get list of available payment methods for a shopping cart

Add and remove coupon codes for a shopping cart

Resource Name: cart_coupon

Methods:

• cart_coupon.add - Add coupon code to a quote
• cart_coupon.remove - Remove coupon code from a quote

Note: In Magento quotes and shopping carts are logically related, but technically different. The shopping cart is a wrapper for a quote, and it is used primarily by front-end logic. The cart is represented by the Mage_Checkout_Model_Cart class and the quote is represented by the Mage_Sales_Model_Quote class.