Magento Core API

Last modified by erikwest on Mon, October 3, 2011 16:57
Source|Old Revisions  

This is an old revision of the document!


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.

Mage_Customer

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

Customer

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

Resource Name: customer

Methods:

Customer's Groups

Retrieve a customer’s groups.

Resource Name: customer_group

Methods:

Customer Address

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

Resource Name: customer_address

Methods:

Mage_Directory

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

Country

Retrieve a list of countries.

Resource Name: directory_country

Aliases:

  • country

Methods:

Region

Retrieve a list of regions within a country.

Resource Name: directory_region

Aliases:

  • region

Methods:

Mage_Catalog

The Mage_Catalog module allows you to manage categories and products.

Category

Manage categories and how products are assigned to categories

Resource Name: catalog_category

Aliases:

  • category

Methods:

Category Attributes

Retrieve category attributes and options



Resource Name: catalog_category_attribute

Aliases:

  • category_attribute

Methods:

Product

Manage products

Resource Name: catalog_product

Aliases:

  • product

Methods:

Product Attributes

Retrieve category attributes and options

Resource Name: catalog_product_attribute

Aliases:

  • product_attribute

Methods:

Product Attribute Sets

Retrieve product attribute sets

Resource Name: catalog_product_attribute_set

Aliases:

  • product_attribute_set

Methods:

Product types

Retrieve product types

Resource Name: catalog_product_type

Aliases:

  • product_type

Methods:

Product Images

Manage product images

Resource Name: catalog_product_attribute_media

Aliases:

  • product_attribute_media
  • product_media

Methods:

Product Tier Price

Retrieve and update product tier prices

Resource Name: catalog_product_attribute_tier_price

Aliases:

  • product_attribute_tier_price
  • product_tier_price

Methods:

Product Links

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

Resource Name: catalog_product_link

Aliases:

  • product_link

Methods:

Mage_Sales

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

Order

Manages orders

Resource Name: sales_order

Aliases:

  • order

Methods:

Shipment

Manage shipments and tracking numbers

Resource Name: sales_order_shipment

Aliases:

  • order_shipment

Methods:

Invoice

Manage invoices

Resource Name: sales_order_invoice

Aliases:

  • order_invoice

Methods:

Mage_CatalogInventory

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

Inventory

Retrieve and update stock data

Resource Name: cataloginventory_stock_item

Aliases:

  • product_stock

Methods:

Mage_Checkout

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.

Shopping Cart

Manage shopping carts

Resource Name: cart

Methods:

Cart Product

Manage products in a shopping cart

Resource Name: cart_product

Methods:

Cart Customer

Add customer information and addresses into a shopping cart

Resource Name: cart_customer

Methods:

Cart Shipping

Retrieve and set shipping methods for a shopping cart

Resource Name: cart_shipping

Methods:

Cart Payment

Retrieve and set payment methods for a shopping cart

Resource Name: cart_payment

Methods:

Cart Coupon

Add and remove coupon codes for a shopping cart

Resource Name: cart_coupon

Methods:

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.




 

Magento 2 GitHub Repository

Magento Job Board - Some sort of tag line goes here

Latest Posts| View all Jobs