From 53fc9b547e1e7cf499dc95489a7a7606b2e615fd Mon Sep 17 00:00:00 2001
From: Fiona Hoyer Welcome to the Magento 1.x REST API home page.
\ No newline at end of file
diff --git a/guides/m1x/api/rest/Resources/Orders/order_addresses.html b/guides/m1x/api/rest/Resources/Orders/order_addresses.html
index 1b0bd68f3c..ce36d34a85 100644
--- a/guides/m1x/api/rest/Resources/Orders/order_addresses.html
+++ b/guides/m1x/api/rest/Resources/Orders/order_addresses.html
@@ -9,26 +9,26 @@
-
-
-
-
-
-
@@ -43,10 +43,10 @@ Allows you to retrieve information about billing and shipping addresses of the required order.
URL Structure: http://magentohost/api/rest/orders/:orderid/addresses
+
URL Structure: http://magentohost/api/rest/orders/:orderid/addresses
Version: 1
Description: Allows you to retrieve information on billing and shipping addresses from the required order.
Notes: Customers can retrieve addresses only from their orders.
Example:
- +| GET http://magentohost/api/rest/orders/32/addresses |
Response Body:
Description: Not allowed.
-Description: Not allowed.
-Description: Not allowed.
Description: Allows you to retrieve information on the order billing address.
Notes: Customers can retrieve information on billing addresses only from their own orders.
Example:
- +| GET http://magentohost/api/rest/orders/32/addresses/billing |
Response example:
Description: Not allowed.
-Description: Not allowed.
-Description: Not allowed.
Description: Allows you to retrieve information on the order shipping address.
Notes: Customers can retrieve information on shipping addresses only from their own orders.
Example:
- +| GET http://magentohost/api/rest/orders/32/addresses/shipping |
Response example:
Description: Not allowed.
-Description: Not allowed.
-Description: Not allowed.
diff --git a/guides/m1x/api/rest/Resources/Orders/order_comments.html b/guides/m1x/api/rest/Resources/Orders/order_comments.html index 9306f1f6e8..8264051168 100644 --- a/guides/m1x/api/rest/Resources/Orders/order_comments.html +++ b/guides/m1x/api/rest/Resources/Orders/order_comments.html @@ -26,7 +26,7 @@Allows you to retrieve information about comments of the required order.
-URL Structure: http://magentohost/api/rest/orders/:orderid/comments
+
URL Structure: http://magentohost/api/rest/orders/:orderid/comments
Version: 1
Example:
- +| GET http://magentohost/api/rest/orders/33/comments |
Response Body:
<?xml version="1.0"?> <magento_api> <data_item> @@ -75,12 +75,12 @@HTTP Method: GET
Example:
- +
GET http://magentohost/api/rest/orders/33/comments Response Body:
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -145,4 +145,4 @@Order C - + diff --git a/guides/m1x/api/rest/Resources/Orders/order_items.html b/guides/m1x/api/rest/Resources/Orders/order_items.html index cdb99eb12f..c42caad4bc 100644 --- a/guides/m1x/api/rest/Resources/Orders/order_items.html +++ b/guides/m1x/api/rest/Resources/Orders/order_items.html @@ -27,7 +27,7 @@
URI: /o
Allows you to retrieve information about order items.
-URL Structure: http://magentohost/api/rest/orders/:orderId/items
+URL Structure: http://magentohost/api/rest/orders/:orderId/items
Version: 1HTTP Method: GET
@@ -42,12 +42,12 @@HTTP Method: GETResponse Example: XML - +
GET http://magentohost/api/rest/orders/410/items Response Body:
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -118,12 +118,12 @@HTTP Method: GETResponse Example: XML - +
GET http://magentohost/api/rest/orders/410/items Response Body:
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -175,4 +175,4 @@HTTP Method: DEL - + diff --git a/guides/m1x/api/rest/Resources/Orders/sales_orders.html b/guides/m1x/api/rest/Resources/Orders/sales_orders.html index c54d6284e0..74247b8cc1 100644 --- a/guides/m1x/api/rest/Resources/Orders/sales_orders.html +++ b/guides/m1x/api/rest/Resources/Orders/sales_orders.html @@ -37,7 +37,7 @@
URI: /orders
Allows you to retrieve information on existing order/orders.
-URL Structure: http://magentohost/api/rest/orders
+URL Structure: http://magentohost/api/rest/orders
Version: 1HTTP Method: GET /orders
@@ -50,11 +50,11 @@HTTP Method
Response Example: XML
- +
GET http://magentohost/api/rest/orders -+<?xml version="1.0"?> <magento_api> <data_item_1> @@ -231,7 +231,7 @@URI: /orders/:id<
Allows you to retrieve information on a single order.
-
The list of attributes that will be returned for the order is configured in the Magento Admin Panel.URL Structure: http://magentohost/api/rest/orders/:id
+URL Structure: http://magentohost/api/rest/orders/:id
Version: 1HTTP Method: GET /orders/:id
@@ -242,11 +242,11 @@HTTP Me
Response Example: XML
- +
GET http://magentohost/api/rest/orders/32 -+<?xml version="1.0"?> <magento_api> <customer_id>3</customer_id> @@ -364,4 +364,4 @@HTTP - + diff --git a/guides/m1x/api/rest/Resources/Products/product_categories.html b/guides/m1x/api/rest/Resources/Products/product_categories.html index baf0b6bc4a..4366fd409c 100644 --- a/guides/m1x/api/rest/Resources/Products/product_categories.html +++ b/guides/m1x/api/rest/Resources/Products/product_categories.html @@ -30,7 +30,7 @@
http://magentohost/api/rest/products/productid/categories
+URL Structure: http://magentohost/api/rest/products/productid/categories
Version: 1HTTP Method: GET
@@ -45,12 +45,12 @@HTTP Method:
Example:
- +
GET http://magentohost/api/rest/products/8/categories Response Body:
-+{ category_id: 8 }@@ -92,12 +92,12 @@HTTP Method
Example:
- +
POST http://magentohost/api/rest/products/8/categories Request Body:
-+{ "category_id":"2" }@@ -122,7 +122,7 @@HTTP Meth
Example:
- +
DELETE http://magentohost/api/rest/products/8/categories/2 Possible HTTP Status Codes
@@ -152,4 +152,4 @@Pos - + diff --git a/guides/m1x/api/rest/Resources/Products/product_images.html b/guides/m1x/api/rest/Resources/Products/product_images.html index f79264cb0f..50210923e8 100644 --- a/guides/m1x/api/rest/Resources/Products/product_images.html +++ b/guides/m1x/api/rest/Resources/Products/product_images.html @@ -10,28 +10,28 @@
@@ -46,10 +46,10 @@
- URI: /products/:product_id/images
- URI: /products/:product_id/images/store/:store_id
- URI: /products/:product_id/images/:image_id
- URI: /products/:product_id/images/:image_id/store/:store_id
Allows you to manage images of the required product. -
URL Structure: http://magentohost/api/rest/products/:product_id/images
+URL Structure: http://magentohost/api/rest/products/:product_id/images
-
Version: 1HTTP Method: GET
+HTTP Method: GET
Description: Allows you to retrieve information about all images of a specified product.
@@ -62,12 +62,12 @@
Notes: If there are custom attributes with the Catalog Input Type for Store Owner option set to Media Image, these attributes will be also returned in the response as an image type.HTTP Method: GET
Example:
- +
GET http://magentohost/api/rest/products/8/images Response Body:
- -HTTP Method: POST
+HTTP Method: POST
Description: Allows you to add an image for the required product.
@@ -143,12 +143,12 @@HTTP Method: PO
Example:
- +
POST http://magentohost/api/rest/products/1/images Request Body:
-+<?xml version="1.0"?> <magento_api> <file_mime_type>image/jpeg</file_mime_type> <file_content>iVBORw0KGgoAAAANSUhEUgAAACgAAAAoCAYAAACM/rhtAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAWtJREFUeNpi/P//P8NgBkwMgxyMOnDUgTDAyMhIDNYF4vNA/B+IDwCxHLoakgEoFxODiQRXQUYi4e3k2gfDjMRajsP3zED8F8pmA+JvUDEYeArEMugOpFcanA/Ef6A0CPwC4uNoag5SnAjJjGI2tKhkg4rLAfFGIH4IxEuBWIjSKKYkDfZCHddLiwChVhokK8YGohwEZYy3aBmEKmDEhOCgreomo+VmZHxsMEQxIc2MAx3FO/DI3RxMmQTZkI9ALDCaSUYdOOrAIeRAPzQ+PxCHUM2FFDb5paGNBPRa5C20bUhxc4sSB4JaLnvxVHWHsbVu6OnACjyOg+HqgXKgGRD/JMKBoD6LDb0dyAPE94hwHAw/hGYcujlwEQmOg+EV9HJgLBmOg+FMWjsQVKR8psCBoDSrQqoDSSmoG6Hpj1wA6ju30LI9+BBX4UsC+Ai0T4BWVd1EIL5PgeO+APECmoXgaGtm1IE0AgABBgAJAICuV8dAUAAAAABJRU5ErkJggg==</file_content> @@ -164,10 +164,10 @@http://magentohost/api/rest/products/:product_id/images/store/:store_id
+URL Structure: http://magentohost/api/rest/products/:product_id/images/store/:store_id
-
Version: 1HTTP Method: GET
+HTTP Method: GET
Description: Allows you to retrieve information about product images for a specified store view.
@@ -180,12 +180,12 @@
Notes: Images can have different labels for different stores. For example, image label "flower" in the English store view can be set as "fleur" in the French store view. If there are custom attributes with the Catalog Input Type for Store Owner option set to Media Image, these attributes will be also returned in the response as an image type.HTTP Method: GET
Example:
- +
GET http://magentohost/api/rest/products/8/images/store/2 Response Body:
- -HTTP Method: POST
+HTTP Method: POST
Description: Allows you to add an image for the required product with image settings for a specific store.
@@ -252,12 +252,12 @@
Notes: The image is added on the Global level; specified image parameters are set for a specific store.HTTP Method: PO
Example:
- +
POST http://magentohost/api/rest/products/8/images/store/3 Request Body:
-+<?xml version="1.0"?> <magento_api> <file_mime_type>image/jpeg</file_mime_type> <file_content>iVBORw0KGgoAAAANSUhEUgAAACgAAAAoCAYAAACM/rhtAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAWtJREFUeNpi/P//P8NgBkwMgxyMOnDUgTDAyMhIDNYF4vNA/B+IDwCxHLoakgEoFxODiQRXQUYi4e3k2gfDjMRajsP3zED8F8pmA+JvUDEYeArEMugOpFcanA/Ef6A0CPwC4uNoag5SnAjJjGI2tKhkg4rLAfFGIH4IxEuBWIjSKKYkDfZCHddLiwChVhokK8YGohwEZYy3aBmEKmDEhOCgreomo+VmZHxsMEQxIc2MAx3FO/DI3RxMmQTZkI9ALDCaSUYdOOrAIeRAPzQ+PxCHUM2FFDb5paGNBPRa5C20bUhxc4sSB4JaLnvxVHWHsbVu6OnACjyOg+HqgXKgGRD/JMKBoD6LDb0dyAPE94hwHAw/hGYcujlwEQmOg+EV9HJgLBmOg+FMWjsQVKR8psCBoDSrQqoDSSmoG6Hpj1wA6ju30LI9+BBX4UsC+Ai0T4BWVd1EIL5PgeO+APECmoXgaGtm1IE0AgABBgAJAICuV8dAUAAAAABJRU5ErkJggg==</file_content> @@ -272,11 +272,11 @@http://magentohost/api/rest/products/:product_id/images/:image_id
+URL Structure: http://magentohost/api/rest/products/:product_id/images/:image_id
-
Version: 1HTTP Method: GET
+HTTP Method: GET
Description: Allows you to retrieve information about a specified product image.
@@ -289,12 +289,12 @@
Notes: If there are custom attributes with the Catalog Input Type for Store Owner option set to Media Image, these attributes will be also returned in the response as an image type.HTTP Method: GET
Example:
- +
GET http://magentohost/api/rest/products/8/images/7 Response Body:
- -HTTP Method: PUT
+HTTP Method: PUT
Description: Allows you to update information for the specified product image.
@@ -386,12 +386,12 @@
Notes: When updating information, you need to pass only those parameters that you want to be updated. Parameters that were not passed in the request, will preserve the previous values.HTTP Method: PUT
Example:
- +
PUT http://magentohost/api/rest/products/8/images/7 Request Body:
-+<?xml version="1.0"?> <magento_api> <label>English store image</label> @@ -413,7 +413,7 @@HTTP Method: PUT -
HTTP Method: DELETE
+HTTP Method: DELETE
Description: Allows you to remove the specified image from a product.
@@ -426,7 +426,7 @@
Notes: The image will not be deleted physically, the image parameters will be set to No Image.HTTP Method:
Example:
- +@@ -435,11 +435,11 @@
DELETE http://magentohost/api/rest/products/14/images/6 http://magentohost/api/rest/products/:product_id/images/:image_id/store/:store_id
+URL Structure: http://magentohost/api/rest/products/:product_id/images/:image_id/store/:store_id
-
Version: 1HTTP Method: GET
+HTTP Method: GET
Description: Allows you to retrieve information about the specified product image from a specified store.
@@ -452,12 +452,12 @@
Notes: If there are custom attributes with the Catalog Input Type for Store Owner option set to Media Image, these attributes will be also returned in the response as an image type.HTTP Method: GET
Example:
- +
GET http://magentohost/api/rest/products/8/images/7/store/3 Response Body:
-+<?xml version="1.0"?> <magento_api> <id>10</id> @@ -474,7 +474,7 @@HTTP Method: GET -
HTTP Method: PUT
+HTTP Method: PUT
Description: Allows you to update the specified product image information for s specified store.
@@ -549,12 +549,12 @@
Notes: When updating information, you need to pass only those parameters that you want to be updated. Parameters that were not passed in the request will preserve the previous values.HTTP Method: PUT
Example:
- +
PUT http://magentohost/api/rest/products/8/images/7/store/3 Request Body:
-+<?xml version="1.0"?> <magento_api> Â <position>3</position> @@ -569,7 +569,7 @@HTTP Method: PUT -
HTTP Method: DELETE
+HTTP Method: DELETE
Description: Allows you to remove an image from the required product in the specified store.
@@ -581,7 +581,7 @@
Notes: The image will not be deleted physically, the image parameters will be set to No Image for the current store.HTTP Method:
Example:
- +@@ -648,4 +648,4 @@
DELETE http://magentohost/api/rest/products/14/images/6/store/3 Possibl - + diff --git a/guides/m1x/api/rest/Resources/Products/product_websites.html b/guides/m1x/api/rest/Resources/Products/product_websites.html index 44ddde880b..ceb9027f84 100644 --- a/guides/m1x/api/rest/Resources/Products/product_websites.html +++ b/guides/m1x/api/rest/Resources/Products/product_websites.html @@ -37,7 +37,7 @@
Allows you to retrieve information about websites assigned to a product, assign a website to a product, and copy data for a product from a specified store view. -
URL Structure: http://magentohost/api/rest/products/:product_id/websites
+URL Structure: http://magentohost/api/rest/products/:product_id/websites
Version: 1HTTP Method: GET
@@ -52,12 +52,12 @@HTTP Method: G
Example:
- +
GET http://magentohost/api/rest/products/8/websites Response Body:
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -104,12 +104,12 @@Website Ass
Example:
- +
POST http://magentohost/api/rest/products/8/websites Request Body:
-+<?xml version="1.0"?> <magento_api> Â Â <website_id>1</website_id> @@ -122,7 +122,7 @@Website Ass
-++<?xml version="1.0"?> <magento_api> <success> @@ -188,12 +188,12 @@http://magentohost/api/rest/products/8/websites
POST http://magentohost/api/rest/products/8/websites Request Body:
-+<?xml version="1.0"?> <magento_api> <website_id>2</website_id> @@ -245,12 +245,12 @@Multi-
Example:
- +
POST http://magentohost/api/rest/products/8/websites Request Body:
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -268,7 +268,7 @@Multi-
-++<?xml version="1.0"?> <magento_api> <success> @@ -338,12 +338,12 @@http://magentohost/api/rest/products/8/websites
POST http://magentohost/api/rest/products/8/websites Request Body:
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -373,7 +373,7 @@
-+<?xml version="1.0"?> <magento_api> <success> @@ -407,7 +407,7 @@http://magentohost/api/rest/products/:product_id/websites/:website_id
+URL Structure: http://magentohost/api/rest/products/:product_id/websites/:website_id
Version: 1HTTP Method: DELETE
@@ -422,7 +422,7 @@HTTP Method
Example:
- +@@ -484,4 +484,4 @@
DELETE http://magentohost/api/rest/products/8/websites/1 Possi - + diff --git a/guides/m1x/api/rest/Resources/Products/products.html b/guides/m1x/api/rest/Resources/Products/products.html index e12d2c1394..85ab7fefcd 100644 --- a/guides/m1x/api/rest/Resources/Products/products.html +++ b/guides/m1x/api/rest/Resources/Products/products.html @@ -35,7 +35,7 @@
URI: /products
Allows you to retrieve the list of all products with detailed information.
-URL Structure: http://magentohost/api/rest/products
+URL Structure: http://magentohost/api/rest/products
@@ -52,13 +52,13 @@
Version: 1HTTP Method: - +
GET http://magentohost/api/rest/products Response Example: XML
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -112,7 +112,7 @@HTTP Method:
-@@ -127,13 +127,13 @@+{"1":{"entity_id":"1","type_id":"simple","sku":"dress_test","status":"1","visibility":"4","tax_class_id":"2","weight":"1.0000","price":"1500.0000","special_price":"1000.0000","name":"Wedding dress","url_key":"dress","country_of_manufacture":"AO","msrp_display_actual_price_type":"2","gift_message_available":"1","news_from_date":"2012-03-21 00:00:00","news_to_date":"2012-03-24 00:00:00","special_from_date":"2012-03-21 00:00:00","special_to_date":"2012-03-24 00:00:00","description":"White wedding dress"},"2":{"entity_id":"2","type_id":"simple","sku":"black_sunglasses","status":"1","visibility":"4","tax_class_id":"2","weight":"0.2000","price":"500.0000","special_price":"300.0000","name":"Sunglasses","url_key":"sunglasses","country_of_manufacture":"AR","msrp_display_actual_price_type":"2","gift_message_available":null,"news_from_date":null,"news_to_date":null,"special_from_date":"2012-03-21 00:00:00","special_to_date":"2012-03-24 00:00:00","description":"Black sunglasses"}}HTTP Method: - +
GET http://magentohost/api/rest/products Response Example: XML
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -179,7 +179,7 @@HTTP Method:
-@@ -192,13 +192,13 @@+{"1":{"entity_id":"1","type_id":"simple","sku":"dress_test","description":"White wedding dress","short_description":"dress","meta_keyword":"white, dress","name":"Wedding dress","meta_title":"dress","meta_description":"A nice wedding dress","regular_price_with_tax":1500,"regular_price_without_tax":1500,"final_price_with_tax":1000,"final_price_without_tax":1000,"is_saleable":"1","image_url":"http:\/\/magentohost\/media\/catalog\/product\/cache\/0\/image\/9df78eab33525d08d6e5fb8d27136e95\/1\/2\/wedding_dress.jpg"},"2":{"entity_id":"2","type_id":"simple","sku":"black_sunglasses","description":"Black sunglasses","short_description":"Black sunglasses","meta_keyword":"sunglasses, black","name":"Sunglasses","meta_title":"sunglasses","meta_description":"black sunglasses","regular_price_with_tax":500,"regular_price_without_tax":500,"final_price_with_tax":300,"final_price_without_tax":300,"is_saleable":"1","image_url":"http:\/\/magentohost\/media\/catalog\/product\/cache\/0\/image\/9df78eab33525d08d6e5fb8d27136e95\/a\/l\/sunglasses-1.jpg"}}<
In the following example, product with ID=4 has position equal to 7 and the product with ID=3 has position equal to 1. The list of products, therefore, is sorted by the product position in the category.
- +
GET http://magentohost/api/rest/products?category_id=5 Response Example: XML
-+<?xml version="1.0"?> <magento_api> <data_item> @@ -718,13 +718,13 @@HTTP Method - +
POST http://magentohost/api/rest/products Request Example: JSON
-+{ "custom_design" : "default/blank", "custom_design_from" : "02/16/2012", @@ -781,7 +781,7 @@HTTP Method
-+<?xml version="1.0"?> <magento_api> <attribute_set_id>4</attribute_set_id> @@ -808,7 +808,7 @@URI: /products/:id
Allows you to retrieve, update, and delete a specified product in Magento.
-URL Structure: http://magentohost/api/rest/products/:id
+URL Structure: http://magentohost/api/rest/products/:id
Version: 1HTTP Method: GET /products/:id
@@ -823,14 +823,14 @@HTTP Met No Parameters - +
GET http://magentohost/api/rest/products/8 Response Example: XML
-+<?xml version="1.0"?> <magento_api> <entity_id>8</entity_id> @@ -895,7 +895,7 @@HTTP Met
-@@ -909,14 +909,14 @@+{"entity_id":"8","attribute_set_id":"4","type_id":"simple","sku":"dress","name":"Dress","url_key":"my-new-dress","country_of_manufacture":"AD","msrp_display_actual_price_type":"2","gift_message_available":"1","price":"2000.0000","weight":"0.5000","status":"1","visibility":"4","tax_class_id":"7","description":"dress","group_price":[{"website_id":"0","cust_group":"1","price":"1400.0000"}],"tier_price":[{"website_id":"0","cust_group":"1","price":"1300.0000","price_qty":"1.0000"}],"stock_data":{"qty":"50.0000","min_qty":"0.0000","use_config_min_qty":"1","is_qty_decimal":"0","backorders":"0","use_config_backorders":"1","min_sale_qty":"1.0000","use_config_min_sale_qty":"1","max_sale_qty":"0.0000","use_config_max_sale_qty":"1","is_in_stock":"1","notify_stock_qty":null,"use_config_notify_stock_qty":"1","manage_stock":"0","use_config_manage_stock":"1","use_config_qty_increments":"1","qty_increments":"0.0000","use_config_enable_qty_inc":"1","enable_qty_increments":"0","is_decimal_divided":"0","use_config_enable_qty_increments":"1"}}HTTP Met No Parameters - +
GET http://magentohost/api/rest/products/8 Response Example: XML
-+<?xml version="1.0"?> <magento_api> <entity_id>1</entity_id> @@ -949,7 +949,7 @@HTTP Met
-@@ -967,14 +967,14 @@+{"entity_id":"1","type_id":"simple","sku":"dress_test","name":"Wedding dress","meta_title":"dress","meta_description":"A nice wedding dress","description":"White wedding dress","short_description":"dress","meta_keyword":"white, dress","tier_price":[],"is_in_stock":"1","regular_price_with_tax":1500,"regular_price_without_tax":1500,"final_price_with_tax":1000,"final_price_without_tax":1000,"is_saleable":"1","image_url":"http:\/\/magento\/media\/catalog\/product\/cache\/0\/image\/9df78eab33525d08d6e5fb8d27136e95\/1\/2\/wedding_dress.jpg","url":"http:\/\/magento\/index.php\/catalog\/product\/view\/id\/1\/s\/dress\/","buy_now_url":"http:\/\/magento\/index.php\/checkout\/cart\/add\/uenc\/aHR0cDovLzEyNy4wLjAuMS9Tb3VyY2VzL2FwaS9yZXN0L3Byb2R1Y3RzLzE,\/product\/1\/","total_reviews_count":"0","has_custom_options":false}HTTP Met Enter only those parameters which you want to update. -
+
PUT http://magentohost/api/rest/products/8
-PUT for specific store http://magentohost/api/rest/products/8/store/3
PUT http://magentohost/api/rest/products/8
+PUT for specific store http://magentohost/api/rest/products/8/store/3Request Example: JSON