Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
101 lines (58 sloc) 3.98 KB
---
layout: m1x_rest
title: Resources
---
<ul class="introduction-menu">
<li><a href="Products/products.html" title="REST API - Resource - Products">Products</a>
<ul>
<li><a href="Products/product_categories.html" title="REST API - Resource - Product Categories">Product Categories</a></li>
<li><a href="Products/product_images.html" title="REST API - Resource - Product Images">Product Images</a></li>
<li><a href="Products/product_websites.html" title="REST API - Resource - Product Websites">Product Websites</a></li>
</ul>
</li>
<li><a href="resource_customers.html" title="REST API - Resource - Customers">Customers</a></li>
<li><a href="resource_customer_addresses.html" title="REST API - Resource - Customer Addresses">Customer Addresses</a></li>
<li><a href="inventory.html" title="REST API - Resource - Stock Items">Inventory</a></li>
<li><a href="Orders/sales_orders.html" title="REST API - Resource - Sales Orders">Sales Orders</a>
<ul>
<li><a href="Orders/order_addresses.html" title="REST API - Resource - Order Addresses">Order Addresses</a></li>
<li><a href="Orders/order_comments.html" title="REST API - Resource - Order Comments">Order Comments</a></li>
<li><a href="Orders/order_items.html" title="REST API - Resource - Order Items">Order Items</a></li>
</ul>
</li>
</ul>
<p>The Magento REST API allows you to manage customers, customer addresses, sales orders, inventory, and products. REST API is organized into the following categories:</p>
<h5><a name="Resources-Products"></a>Products</h5>
<p>Retrieve the list of products, create, update, delete a product.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/products</p>
<h6><a name="Resources-ProductCategories"></a>Product Categories</h6>
<p>Retrieve the list of categories assigned to a product, assign and unassign the category from a product.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/products/:id/categories</p>
<h6><a name="Resources-ProductImages"></a>Product Images</h6>
<p>Retrieve the list of images assigned to a product, add, update, remove an image to/from a product.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/products/:id/images</p>
<h6><a name="Resources-ProductWebsites"></a>Product Websites</h6>
<p>Retrieve the list of websites assigned to a product, assign, unassign a website to/from a product.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/products/:id/websites</p>
<h5><a name="Resources-Customers"></a>Customers</h5>
<p>Retrieve the list of customers, create, delete a customer, and update the customer information.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/customers</p>
<h5><a name="Resources-CustomerAddresses"></a>Customer Addresses</h5>
<p>Retrieve the list of customer addresses, create, update, and delete the customer address.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/customers/:id/addresses</p>
<h5><a name="Resources-Inventory"></a>Inventory</h5>
<p>Retrieve the list of stock items, update required stock items.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/stockitems</p>
<h5><a name="Resources-SalesOrders"></a>Sales Orders</h5>
<p>Retrieve the list of sales orders with detailed information on order addresses, items, and comments.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/orders</p>
<h6><a name="Resources-OrderAddresses"></a>Order Addresses</h6>
<p>Retrieve information on order billing and shipping addresses.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/orders/:id/addresses</p>
<h6><a name="Resources-OrderComments"></a>Order Comments</h6>
<p>Retrieve information on the specified order comments.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/orders/:id/comments</p>
<h6><a name="Resources-OrderItems"></a>Order Items</h6>
<p>Retrieve information on specified order items.</p>
<p><b>Resource Structure</b>: http://magentohost/api/rest/orders/:id/items</p>
<?php include(__ROOT__ . 'footer.php'); ?>
You can’t perform that action at this time.