- For Magento Commerce 1, Magento is providing software support through June 2020. Depending on your Magento Commerce 1 version, software support may include both quality fixes and security patches. Please review our Magento Software Lifecycle Policy to see how your version of Magento Commerce 1 is supported.
-
-
- For Magento Open Source 1.5 to 1.9, Magento is providing software security patches through June 2020 to ensure those sites remain secure and compliant. Visit our information page for more details about our software maintenance policy and other considerations for your business.
-
-
diff --git a/_includes/v1x/eol_message.html b/_includes/v1x/eol_message.html
new file mode 100644
index 0000000000..04c82db230
--- /dev/null
+++ b/_includes/v1x/eol_message.html
@@ -0,0 +1,9 @@
+
+
Magento 1.x Software Support Notice
+
+ For Magento Commerce 1, Magento is providing software support through June 2020. Depending on your Magento Commerce 1 version, software support may include both quality fixes and security patches. Please review our Magento Software Lifecycle Policy to see how your version of Magento Commerce 1 is supported.
+
+
+After its End of Life, Magento 1 will not be available for the general public. Adobe will remove all download links, links to the documentation and will stop releasing patches even for critical bugs and security issues. That’s where OpenMage comes in, keeping Magento CE healthy and up to the current standards.
+
OpenMage LTS is designed to take place of Magento 1 and benefit its community. Please visit us at OpenMage Project
+
diff --git a/_includes/v1x/header-scripts.html b/_includes/v1x/header-scripts.html
new file mode 100644
index 0000000000..78ae074aa6
--- /dev/null
+++ b/_includes/v1x/header-scripts.html
@@ -0,0 +1,20 @@
+
+
\ No newline at end of file
diff --git a/_includes/v1x/header.html b/_includes/v1x/header.html
new file mode 100644
index 0000000000..81195edbdb
--- /dev/null
+++ b/_includes/v1x/header.html
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+ {% include v1x/header-scripts.html %}
+ {{ page.title }}
+
\ No newline at end of file
diff --git a/_layouts/m1x.html b/_layouts/m1x.html
deleted file mode 100644
index db79a9c048..0000000000
--- a/_layouts/m1x.html
+++ /dev/null
@@ -1,41 +0,0 @@
-
-
-
-
-
-
-
-
-
-
- {{ page.title }}
-
-
-
-
-
Description: Allows you to retrieve information on billing and shipping addresses from the required order.
-Notes: Customers can retrieve addresses only from their orders.
-
-
Authentication: Admin, Customer
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/orders/32/addresses
Description: Allows you to retrieve information on the order billing address.
-Notes: Customers can retrieve information on billing addresses only from their own orders.
-
-
Authentication: Admin, Customer
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/orders/32/addresses/billing
Description: Allows you to retrieve information on the order shipping address.
-Notes: Customers can retrieve information on shipping addresses only from their own orders.
-
-
Authentication: Admin, Customer
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/orders/32/addresses/shipping
Description: Allows you to retrieve information about comments of the required order.
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/orders/33/comments
-
-
Response Body:
-
-
-
-
<?xml version="1.0"?>
-<magento_api>
- <data_item>
- <created_at>2012-03-09 11:20:49</created_at>
- <comment></comment>
- <is_customer_notified>1</is_customer_notified>
- <is_visible_on_front>0</is_visible_on_front>
- <status>pending</status>
- </data_item>
- <data_item>
- <created_at>2012-03-09 11:21:32</created_at>
- <comment>This is a new order for John Doe.</comment>
- <is_customer_notified>1</is_customer_notified>
- <is_visible_on_front>1</is_visible_on_front>
- <status>pending</status>
- </data_item>
-</magento_api>
-
-
-
-
-
-
Authentication: Customer
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/orders/33/comments
-
-
Response Body:
-
-
-
-
<?xml version="1.0"?>
-<magento_api>
- <data_item>
- <created_at>2012-03-09 11:21:32</created_at>
- <comment>This is a new order for John Doe.</comment>
- </data_item>
-</magento_api>
-
-
-
-
-
-
HTTP Method: POST
-
-
Description: Not allowed.
-
-
HTTP Method: PUT
-
-
Description: Not allowed.
-
-
HTTP Method: DELETE
-
-
Description: Not allowed.
-
-
-
-
Order Comments Attributes
-
-
-
-
-
Attribute Name
-
Attribute Description
-
Notes
-
-
-
Comment Date
-
Date when the comment was added
-
Admin and Customer
-
-
-
Comment Text
-
Comment text
-
Admin and Customer
-
-
-
Is Customer Notified
-
Defines whether the customer is notified about the comment. Can have the following values: 0 - Customer is not notified, 1 - Customer is notified.
-
Admin only
-
-
-
Is Comment Visible on Frontend
-
Defines whether the comment is visible on the frontend. Can have the following values: 0 - Comment is not visible, 1 - Comment is visible.
Description: Allows you to retrieve the list of existing order items with detailed items information.
-Notes: The list of attributes that will be returned for order items is configured in the Magento Admin Panel.
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-No Parameters
Description: Allows you to retrieve the list of existing orders. Each order contains the following information: general order information, information on ordered items, order comments, and order addresses (both billing and shipping).
-The list of attributes that will be returned for the order is configured in the Magento Admin Panel.
-
-
Authentication: Admin, Customer, Guest
-Default Format: XML
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.
Description: Allows you to retrieve information about all images of a specified product.
-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.
-
-
-
Authentication: Admin, Customer, Guest
-Default Format: XML
-Parameters:
-No Parameters
Note: If the file_name parameter is not defined, the original file name is set for the image. The first created image will be called "image", the second created image will be called "image_2", etc.
-
-
Example:
-
-
POST http://magentohost/api/rest/products/1/images
Description: Allows you to retrieve information about product images for a specified store view.
-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.
-
-
-
Authentication: Admin, Customer, Guest
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/products/8/images/store/2
Description: Allows you to add an image for the required product with image settings for a specific store.
-Notes: The image is added on the Global level; specified image parameters are set for a specific store.
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-
-
-
-
-
Name
-
Description
-
Required
-
Type
-
Example Value
-
-
-
file_mime_type
-
File mime type. Can have the following values: image/jpeg, image/png, etc.
Note: If the file_name parameter is not defined, the original file name is set for the image. The first created image will be called "image", the second created image will be called "image_2", etc.
-
-
Example:
-
-
POST http://magentohost/api/rest/products/8/images/store/3
Description: Allows you to retrieve information about a specified product image.
-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.
-
-
-
Authentication: Admin, Customer, Guest
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/products/8/images/7
Description: Allows you to update information for the specified product image.
-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.
-
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-
-
-
-
-
Name
-
Description
-
Required
-
Type
-
Example
-
-
-
exclude
-
Defines whether the image will associate only to one of the three image types.
-
optional
-
int
-
0
-
-
-
file_content
-
Image file content (base_64 encoded).
-
optional
-
string
-
base_64 encoded file content
-
-
-
file_mime_type
-
File mime type. Can have the following values: image/jpeg, image/png, etc.
-
optional
-
string
-
image/png
-
-
-
file_name
-
Image file name.
-
optional
-
string
-
test name
-
-
-
label
-
A label that will be displayed on the frontend when pointing to the image
-
optional
-
string
-
test label
-
-
-
position
-
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
-
optional
-
int
-
1
-
-
-
types
-
Array of image types. Can have the following values: image, small_image, and thumbnail.
-
optional
-
array
-
thumbnail
-
-
-
-
-
-
-
Example:
-
-
PUT http://magentohost/api/rest/products/8/images/7
Description: Allows you to remove the specified image from a product.
-Notes: The image will not be deleted physically, the image parameters will be set to No Image.
-
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-No Parameters
Description: Allows you to retrieve information about the specified product image from a specified store.
-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.
-
-
-
Authentication: Admin, Customer, Guest
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/products/8/images/7/store/3
Description: Allows you to update the specified product image information for s specified store.
-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.
-
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-
-
-
-
-
Name
-
Description
-
Required
-
Type
-
Example
-
-
-
exclude
-
Defines whether the image will associate only to one of the three image types.
-
optional
-
int
-
0
-
-
-
file_content
-
Image file content (base_64 encoded).
-
optional
-
string
-
base_64 encoded file content
-
-
-
file_mime_type
-
File mime type. Can have the following values: image/jpeg, image/png, etc.
-
optional
-
string
-
image/png
-
-
-
file_name
-
Image file name.
-
optional
-
string
-
test name
-
-
-
label
-
A label that will be displayed on the frontend when pointing to the image
-
optional
-
string
-
test label
-
-
-
position
-
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
-
optional
-
int
-
1
-
-
-
types
-
Array of image types. Can have the following values: image, small_image, and thumbnail.
-
optional
-
array
-
thumbnail
-
-
-
-
-
-
-
Example:
-
-
PUT http://magentohost/api/rest/products/8/images/7/store/3
-
-
Request Body:
-
-
-
-
<?xml version="1.0"?>
-<magento_api>
-Â <position>3</position>
-Â <exclude>0</exclude>
-Â <types>
-Â Â Â <data_item>image</data_item>
-Â Â </types>
-</magento_api>
-
-
-
-
-
-
-
HTTP Method: DELETE
-
-
Description: Allows you to remove an image from the required product in the specified store.
-Notes: The image will not be deleted physically, the image parameters will be set to No Image for the current store.
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-No Parameters
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.
Description: Allows you to assign a website and copy product data from the attached store to the one being attached. Only product data that is set on the Store View level is copied. All other data set on the Website or Global levels is not copied.
-
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-
-
-
-
-
Name
-
Description
-
Required
-
Type
-
Example Value
-
-
-
website_id
-
The website ID
-
required
-
int
-
2
-
-
-
store_from
-
The store ID from which data will be copied
-
required
-
int
-
1
-
-
-
store_to
-
The store ID to which data will be copied
-
required
-
int
-
2
-
-
-
-
-
Notes: The store_to parameter must belong to the website which we want to assign to a product.
-
-
Example:
-
-
POST http://magentohost/api/rest/products/8/websites
Multi-Website Assignment with Product Data Copying
-
-
Description: Allows you to assign multiple websites to a product together with copying product data from the attached store to the one being attached. Only product data that is set on the Store View level is copied. All other data set on the Website or Global levels is not copied.
-
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-
-
-
-
-
Name
-
Description
-
Required
-
Type
-
Example Value
-
-
-
website_id
-
The website ID
-
required
-
int
-
2
-
-
-
store_from
-
The store ID from which data will be copied
-
required
-
int
-
1
-
-
-
store_to
-
The store ID to which data will be copied
-
required
-
int
-
2
-
-
-
-
-
Example:
-
-
POST http://magentohost/api/rest/products/8/websites
Description: Allows you to retrieve the list of all products with detailed information.
-Notes: The list of attributes that will be returned in the response is configured in the Magento Admin Panel. The list of attributes differs for each type of user.
-
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-No Parameters
Description: Allows you to retrieve the list of products of a specified category. These products will be returned in the product position ascending order.
-
-
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
Description: Allows you to retrieve information on a required simple product.
-Notes: The list of attributes that will be returned in the response is configured in the Magento Admin Panel. The list of attributes differs for each type of user.
-
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-No Parameters
Some requests use GET parameters in the URL. These are as follows:
-
-
-
filter - specifies the filters for returned data
-
page - specifies the page number which items will be returned
-
-
e.g., http://magentohost/api/rest/products?page=1
-
-
-
order, dir - specifies the sort order of returned items and the order direction: 'asc' - returns items in the ascending order; 'dsc' - returns items in the descending order.
-
limit - limits the number of returned items in the response. Note that by default, 10 items are returned in the response. The maximum number is 100 items.
-
- Important: The default response for all APIs is JSON; however, this page currently uses mostly XML examples. We don't maintain this documentation much anymore so if you'd like to contribute some JSON, we'll acknowledge your help on this page. Edit this page on GitHub if you can help us out.
-
-
-
REST API: Stock Items
-
-
URI: /stockitems
-
-
Allows you to manage existing stock items. Inventory management is available only for Admin.
Description: Allows you to retrieve the list of existing stock items.
- Notes: The list of attributes that will be returned for stock items is configured in the Magento Admin Panel.
-
Description: Allows you to update existing stock items.
-
-
-
Authentication: Admin
- Default Format: JSON
-
-
Notes: The Content-Type: text/xml parameter must be added to the request header.
-
-
Parameters:
-
-
-
-
-
Name
-
Description
-
Type
-
Example Value
-
-
-
item_id
-
Item ID
-
int
-
1
-
-
-
product_id
-
Product ID
-
int
-
1
-
-
-
stock_id
-
Stock ID
-
int
-
1
-
-
-
qty
-
Quantity of stock items for the current product
-
string
-
20
-
-
-
min_qty
-
Quantity for stock items to become out of stock
-
string
-
0
-
-
-
use_config_min_qty
-
Choose whether the Config settings will be applied for the Qty for Item's Status to Become Out of Stock
- option
-
-
int
-
1
-
-
-
is_qty_decimal
-
Choose whether the product can be sold using decimals (e.g., you can buy 2.5 product)
-
int
-
0
-
-
-
backorders
-
The customer can place the order for products that are out of stock at the moment (0 - No Backorders, 1 -
- Allow Qty Below 0, and 2 - Allow Qty Below 0 and Notify Customer)
-
-
int
-
0
-
-
-
use_config_backorders
-
Choose whether the Config settings will be applied for the Backorders option
-
int
-
1
-
-
-
min_sale_qty
-
Minimum number of items in the shopping cart to be sold
-
string
-
10
-
-
-
use_config_min_sale_qty
-
Choose whether the Config settings will be applied for the Minimum Qty Allowed in Shopping Cart option
-
int
-
0
-
-
-
max_sale_qty
-
Maximum number of items in the shopping cart to be sold
-
string
-
100
-
-
-
use_config_max_sale_qty
-
Choose whether the Config settings will be applied for the Maximum Qty Allowed in Shopping Cart option
-
int
-
0
-
-
-
is_in_stock
-
Defines whether the product is available for selling (0 - Out of Stock, 1 - In Stock)
-
int
-
1
-
-
-
low_stock_date
-
Date when the number of stock items became lower than the number defined in the Notify for Quantity Below
- option
-
-
string
-
2012-02-24 12:37:51
-
-
-
notify_stock_qty
-
The number of inventory items below which the customer will be notified via the RSS feed
-
string
-
10
-
-
-
use_config_notify_stock_qty
-
Choose whether the Config settings will be applied for the Notify for Quantity Below option
-
int
-
0
-
-
-
manage_stock
-
Choose whether to view and specify the product quantity and availability and whether the product is in
- stock management( 0 - No, 1 - Yes)
-
-
int
-
0
-
-
-
use_config_manage_stock
-
Choose whether the Config settings will be applied for the Manage Stock option
-
int
-
1
-
-
-
stock_status_changed_auto
-
Defines whether products can be automatically returned to stock when the refund for an order is created
-
-
int
-
0
-
-
-
use_config_qty_increments
-
Choose whether the Config settings will be applied for the Enable Qty Increments option
-
int
-
1
-
-
-
qty_increments
-
The product quantity increment value
-
string
-
5
-
-
-
use_config_enable_qty_inc
-
Choose whether the Config settings will be applied for the Qty Increments option
-
int
-
1
-
-
-
enable_qty_increments
-
Defines whether the customer can add products only in increments to the shopping cart
-
int
-
0
-
-
-
is_decimal_divided
-
Defines whether the stock items can be divided into multiple boxes for shipping.
Allows you to update, delete, or retrieve information on a single stock item.
- Notes: The list of attributes that will be returned for stock items is configured in the Magento Admin Panel.
-
Description: Allows you to update existing stock item data.
- Notes: The Content-Type: text/xml parameter must be added to the request header.
- Authentication: Admin
- Default Format: JSON
- Parameters:
- Enter only those parameters which you want to update.
Description: Not allowed. The DELETE method is not allowed because you cannot delete a stock item. The
- required stock item is deleted together with the product which it is associated to.
-
-
-
Possible HTTP Status Codes:
-
-
-
-
-
Error Code
-
Error Message
-
Error Description
-
-
-
200
-
Resource updated successful.
-
The required resource was successfully updated.
-
-
-
404
-
Resource not found.
-
The required resource is not found or does not exist.
-
-
-
400
-
Empty value for <name of the parameter> in request.
-
Value is not defined for the specified parameter in the request body.
-
-
-
400
-
Invalid value for "item_id" in request.
-
The specified value for "item_id" is not valid.
-
-
-
400
-
Missing <name of the parameter> in request.
-
The specified parameter is missing in the request body.
-
-
-
500
-
Resource internal error.
-
Resource internal error.
-
-
-
-
-
-
diff --git a/guides/m1x/api/rest/Resources/resource_customer_addresses.html b/guides/m1x/api/rest/Resources/resource_customer_addresses.html
deleted file mode 100644
index e65d46693f..0000000000
--- a/guides/m1x/api/rest/Resources/resource_customer_addresses.html
+++ /dev/null
@@ -1,510 +0,0 @@
----
-layout: m1x_rest
-title: Customer Addresses
----
-
-JSON responses on this page contributed by Tim Reynolds
-
-
-
HTTP Method: GET /customers/:customer_id/addresses
-
-
Description: Allows you to retrieve the list of existing customer addresses.
-Notes: The list of attributes that will be returned for customer addresses is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses. Also, Admin can add additional non-system customer address attributes by selecting Customers > Attributes > Manage Customer Address Attributes (available only in Magento Enterprise Edition). If these attributes are set as visible on frontend, they will be returned in the response.
-
-
-
-
Authentication: Admin, Customer
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/customers/1/addresses
Notes: If the customer has more than two street addresses, they will be returned in the following form: first address in the first string and all other addresses in the second string separated with a semicolon (like in the example above).
-
-
HTTP Method: POST /customers/:customer_id/addresses
-
-
Description: Allows you to create a new address for the required customer.
-Notes: The Customer user type can create addresses only for themselves.
-
-
When adding a street address for the customer, it should look like the following:
Description: Allows you to retrieve an existing customer address.
-Notes: The list of attributes that will be returned for customer address is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses. Also, Admin can add additional non-system customer address attributes by selecting Customers > Attributes > Manage Customer Address Attributes (available only in Magento Enterprise Edition). If these attributes are set as visible on frontend, they will be returned in the response.
-
-
-
-
Authentication: Admin, Customer
-Default Format: XML
-Parameters:
-No Parameters
-
-
Example:
-
-
GET http://magentohost/api/rest/customers/addresses/2
HTTP Method: POST /customers/addresses/:address_id
-
-
Description: Not allowed.
-
-
HTTP Method: PUT /customers/addresses/:address_id
-
-
Description: Allows you to update an existing customer address.
-Notes: The list of attributes that will be updated for customer address is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses.
-
-
If you want to add more addresses, it should look like the following:
-
-
-
-
<street>
-Â Â <data_item>street address 1</data_item>
-Â Â <data_item>street address 2</data_item>
-Â Â <data_item>street address 3</data_item>
-</street>
-
-
-
-
-
-
-
Authentication: Admin, Customer
-Default Format: XML
-
-
-
Example:
-
-
PUT http://magentohost/api/rest/customers/addresses/7
Description: Allows you to retrieve the list of existing customers.
-Notes:: Only Admin user can retrieve the list of customers with all their attributes.
-
-
Authentication: Admin
-Default Format: XML
-Parameters:
-No Parameters
Description: Allows you to create a new customer.
-Authentication: Admin
-Default Format: XML
-Parameters:
-
-
-
-
-
Name
-
Description
-
Required
-
Type
-
Example Value
-
-
-
firstname
-
The customer first name
-
required
-
string
-
John
-
-
-
lastname
-
The customer last name
-
required
-
string
-
Doe
-
-
-
email
-
The customer email address
-
required
-
string
-
johny@example.com
-
-
-
password
-
The customer password. The password must contain minimum 7 characters
-
required
-
string
-
123123q
-
-
-
website_id
-
Website ID
-
required
-
int
-
1
-
-
-
group_id
-
Customer group ID
-
required
-
int
-
1
-
-
-
disable_auto_group_change
-
Defines whether the automatic group change for the customer will be disabled
-
optional
-
int
-
0
-
-
-
prefix
-
Customer prefix
-
optional
-
string
-
Mr.
-
-
-
middlename
-
Customer middle name or initial
-
optional
-
string
-
R.
-
-
-
suffix
-
Customer suffix
-
optional
-
string
-
Sr.
-
-
-
taxvat
-
Customer Tax or VAT number
-
optional
-
string
-
GB999 9999 73
-
-
-
-
-
Notes: The list of parameters may change depending on the attributes settings in Customers > Attributes > Manage Customer Attributes page in Magento Admin Panel. For example, a required status of the middlename attribute (Middle Name/Initial) may be changed to 'YES". Please note that managing customer attributes is available only in Magento Enterprise Edition.
Response:
-If the customer was created successfully, we receive Response HTTP Code = 200, empty Response Body and Location header like '/api/rest/customers/555' where '555' - an entity id of the new customer.
Description: Allows you to retrieve information on an existing customer.
-Notes:: The list of attributes that will be returned for customers is configured in the Magento Admin Panel. The Customer user type has access only to his/her own information. Also, Admin can add additional non-system customer attributes by selecting Customers > Attributes > Manage Customer Attributes. If these attributes are set as visible on frontend, they will be returned in the response. Also, custom attributes will be returned in the response only after the customer information is updated in the Magento Admin Panel or the specified custom attribute is updated via API (see the PUT method below). Please note that managing customer attributes is available only in Magento Enterprise Edition.
-
-
Authentication: Admin, Customer
-Default Format: XML
-Parameters:
-No Parameters
Description: Allows you to update an existing customer.
-Notes: The list of attributes that will be updated for customer is configured in the Magento Admin Panel. The Customer user type has access only to his/her own information.
-
-
Authentication: Admin, Customer
-Default Format: XML
-Parameters:
-You must specify only those parameters which you want to update. Parameters that are not defined in the request body will preserve the previous values. The website_id and created_in attributes are not allowed for updating.
The Magento REST API allows you to manage customers, customer addresses, sales orders, inventory, and products. REST API is organized into the following categories:
-
-
-
-
Products
-
-
Retrieve the list of products, create, update, delete a product.
In most cases, the third-party application must be authenticated to use the Magento API. But users never reveal their credentials to the application to preserve their privacy. So, the question is as follows: how is your application going to authenticate users if it does not know user credentials. OAuth is the solution.
-
-
Magento authentication is based on OAuth, an open standard for secure API authentication. OAuth is a token-passing mechanism that allows users to control which applications have access to their data without revealing their passwords or other credentials.
-
-
The OAuth concept lies in three basic elements that can be easily described in the following picture:
-
-
-
-
-
To learn more about OAuth, you can visit the official OAuth site.
-
-
-
Using OAuth
-
-
The current API supports OAuth 1.0a.
-
-
The OAuth authentication works by asking the user to authorize their application. When the user authorizes the application, the application can access that user protected resources by using an access token. This token will be used in each further request. Access tokens are long-lived and will not expire unless the user revokes access to the application.
-
-
OAuth is completely invisible for the site visitors.
-
-
Why Do You Need OAuth?
-
-
Magento uses OAuth to allow access to its data. You need to use OAuth if you want to use any of the following Magento APIs:
-
-
-
Products
-
Inventory
-
Orders
-
Customers
-
Customer Addresses
-
Categories
-and a lot more
-
-
-
-
-
OAuth Definitions
-
-
There are some definitions you need to get familiar with before you start using OAuth. These are as follows:
-
-
User - A customer who has an account with Magento and can use the services via the Magento API.
-
Consumer - A third-party application that uses OAuth to access the Magento API. This application must be registered in the Magento system to receive the Consumer Key and Consumer Secret.
-
Consumer Key - A value used by the Consumer to identify itself with Magento.
-
Consumer Secret - A secret used by the Consumer to guarantee the ownership of the Consumer Key. This value is not passed in requests.
-
Request Token - A value used by the Consumer to obtain authorization from the User (when needed). The Request Token is exchanged for an Access Token when permission is granted.
-
Access Token - A value used by the Consumer to call Magento APIs on behalf of the User.
-
-
-
-
-
OAuth Process
-
-
The OAuth process consists of several steps:
-
-
Getting an Unauthorized Request Token.
-
Requesting user authorization.
-
Getting an Access Token by exchanging the Request Token for it.
-
-
-
-
-
The application that requires access to data is known as the Consumer and Magento is the Service Provider.
-
-
-
Registering an Application
-
-
Before starting to make API requests, you need to register the application. After the registration, you will receive the Consumer Key that will identify you in Magento. Also, you will receive a Consumer Secret. This secret will be used when requesting for a Request Token.
-
-
You can register your application by selecting System > Web Services > REST - OAuth Consumers and clicking Add New in the Admin Panel.
-
-
When registering the application, you also need to define the callback URL, to which the user will be redirected after he/she successfully authorizes your application.
-
-
Authentication Endpoints
-
-
The authentication endpoints include the following ones:
-
-
-
/oauth/initiate - this endpoint is used for retrieving the Request Token.
-
/oauth/authorize - this endpoint is used for user authorization (Customer).
-
/admin/oauth_authorize - this endpoint is used for user authorization (Admin).
-
/oauth/token - this endpoint is used for retrieving the Access Token.
-
-
-
-
Also, the simple form can be used for authentication. To use a simple form, add the /simple endpoint to the authentication endpoint. For example: /oauth/authorize/simple
-
-
-
Getting an Unauthorized Request Token
-
-
The first step to authenticate the user is to retrieve a Request Token from Magento. This is a temporary token that will be exchanged for the Access Token.
-
-
-
-
-
-
Endpoint:
-
/oauth/initiate
-
-
-
Description:
-
The first step of authentication. Allows you to obtain the Request Token used for the rest of the authentication process.
The following request parameters should be present in the Authorization header:
-
-
oauth_callback - an URI to which the Service Provider will redirect the resource owner (user) after the authorization is complete.
-
oauth_consumer_key - the Consumer Key value, retrieved after the registration of the application.
-
oauth_nonce - a random value, uniquely generated by the application.
-
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
-
oauth_signature - a generated value (signature).
-
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
-
oauth_version - OAuth version.
-
-
-
-
User Authorization
-
-
The second step is to request user authorization. After receiving the Request Token from Magento, the application provides an authorization page to the user. The only required parameter for this step is the Request Token (oauth_token value) received from the previous step. The endpoint is followed by an oauth_token parameter with the value set to the oauth_token value.
-
-
After this, the user is asked to enter their credentials and authorize. When the user is granted the access, he/she is redirected to the URL specified in the oauth_callback parameter. This URL is followed by two parameters:
-
-
oauth_token - the Request Token value.
-
oauth_verifier - a verification code that is tied to the Request Token.
-
-
-
-
-
-
-
-
Endpoint:
-
/oauth/authorize
-
-
-
Description:
-
The second step of authentication. Without the user authorization in this step, it is impossible for your application to obtain an Access Token.
The final third authentication step. After the application access is authorized, the application needs to exchange the Request Token for an Access Token. For this step, you will need the Request Token (the oauth_token and oauth_token_secret values) and the oauth_verifier value from the previous step.
-
-
-
-
-
-
Endpoint:
-
/oauth/token
-
-
-
Description:
-
The third step of authentication. Getting an Access Token.
-
-
-
Method:
-
POST
-
-
-
Returns:
-
An access token and the corresponding access token secret, URL-encoded.
The following components should be present in the Authorization header:
-
-
oauth_consumer_key - the Consumer Key value provided after the registration of the application.
-
oauth_nonce - a random value, uniquely generated by the application.
-
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
-
oauth_signature - a generated value (signature).
-
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
-
oauth_token - the oauth_token value (Request Token) received from the previous steps.
-
oauth_verifier - the verification code that is tied to the Request Token.
-
oauth_version - OAuth version.
-
-
-
-
-
The response will contain the following response parameters:
-
-
oauth_token - the Access Token that provides access to protected resources.
-
oauth_token_secret - the secret that is associated with the Access Token.
-
-
-
-
-
-
OAuth Error Codes
-
-
When the third-party application performs invalid requests to Magento, the following errors related to OAuth can occur:
-
-
-
-
-
HTTP Code
-
Error Code
-
Text Representation
-
Description
-
-
-
400
-
1
-
version_rejected
-
This error is used when the oauth_version parameter does not correspond to the "1.0a" value.
-
-
-
400
-
2
-
parameter_absent
-
This error is used there is no required parameter in the request. The name of the missing parameter is specified additionally in the response.
-
-
-
400
-
3
-
parameter_rejected
-
This error is used when the type of the parameter or its value does not meet the protocol requirements (e.g., array is passed instead of the string).
-
-
-
400
-
4
-
timestamp_refused
-
This error is used if there is incorrect value of the timestamp in the oauth_timestamp parameter.
-
-
-
401
-
5
-
nonce_used
-
This error is used if the nonce-timestamp combination has already been used.
-
-
-
400
-
6
-
signature_method_rejected
-
This error is used for unsupported signature method. The following methods are supported: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
-
-
-
401
-
7
-
signature_invalid
-
This error is used if the signature is invalid.
-
-
-
401
-
8
-
consumer_key_rejected
-
This error is used if the Consumer Key has incorrect length or does not exist.
-
-
-
401
-
9
-
token_used
-
This error is used if there is an attempt of authorization of an already authorized token or an attempt to exchange a not temporary token for a permanent one.
-
-
-
401
-
10
-
token_expired
-
This error is used if the temporary token has expired. At the moment, the mechanism of expiration of temporary tokens is not implemented and the current error is not used.
-
-
-
401
-
11
-
token_revoked
-
This error is used if the token is revoked by the user who authorized it.
-
-
-
401
-
12
-
token_rejected
-
This error is used if the token is not valid, or does not exist, or is not valid for using in the current type of request.
-
-
-
401
-
13
-
verifier_invalid
-
This error is used if the confirmation string does not correspond to the token.
-
-
-
-
-
-
-
PHP Examples
-
-
Retrieve the list of products for Admin user with OAuth authentication
Before starting to use OAuth, you need to perform several steps in the Magento Admin Panel. These steps allow you to enable the OAuth functionality for further actions.
-
-
Working with Consumers
-
-
Adding a New Consumer
-
-
First, you need to create a Consumer in the Admin Panel. Creating a new consumer means registering the application. To do this, perform the following steps:
-
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
-
On the OAuth Consumers page, click Add New in the top right corner to add a new consumer.
-
The New Consumer page opens. The Key and Secret fields are filled automatically and cannot be edited. These values are generated automatically and will be used to identify the Consumer in Magento.
-
-
Fill in the following fields:
-
-
Name: Enter the name of the application to be registered. This field is required.
-
Callback URL: Enter the URL address to which the Consumer will be redirected after the authorization is passed successfully. This URL address implies the path to the application. This field is optional.
-
Rejected Callback URL: Enter the URL address to which the user will be redirected if he/she rejects authorization. This field is optional.
-
-
-
Click Save in the top right corner to save the created Consumer.
-
-
-
-
Editing an Existing Consumer
-
-
To edit an existing consumer, perform the following steps:
-
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
-
The OAuth Consumers page opens. In the grid, select the consumer to be edited and click it.
-
The Edit Consumer page opens. On this page, you can edit the following fields:
-
-
Name: Enter a new name for the application.
-
Callback URL: Enter a new URL address to which the user will be redirected after successful authorization. This URL address implies the path to the application.
-
Rejected Callback URL: Enter another URL address to which the user will be redirected after he/she rejects authorization proceeding.
-
The Key and Secret fields cannot be edited.
-
-
-
Click Save in the top right corner to save changes.
-
-
-
-
Deleting an Existing Consumer
-
-
To delete the required consumer, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
-
The OAuth Consumers page opens. In the grid, select the consumer to be deleted and click it.
-
The Edit Consumer page opens. Click Delete in the top right corner to delete the selected consumer.
-
-
-
-
Searching for a Consumer
-
-
You can search for a required consumer by several parameters: ID, consumer name, and date of creation.
-To search for a consumer, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
-
The OAuth Consumers page opens. The list of consumers is displayed in a grid with the following fields: ID, Consumer Name, and Created At.
-
In the search field below the column header in a grid, enter the required value by which the search will be performed. Click Search in the top right corner.
-
-
-
-
-
Working with Tokens (Admin Panel)
-
-
Viewing Authorized Tokens
-
-
To view authorized tokens in the Admin panel, perform the following steps:
-
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Authorized Tokens.
-
The Authorized OAuth Tokens page opens. In the grid, the list of all authorized tokens is displayed.
-
Tokens are displayed in the grid with the following columns: ID, Application Name (name of consumer for which the token is created), User Type (type of the user, Customer or Admin), User ID, and the Revoked status.
-
-
-
-
From the Authorized OAuth Tokens page, you can enable, revoke, or delete the required token.
-
-
Viewing Applications
-
-
To view the list of applications, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - My Apps.
-
The My Applications page opens. Registered applications are displayed in a grid with the following columns: ID, Application Name, and Revoked.
-
-
-
-
-
Enabling Tokens
-
-
If a token is revoked (the Yes value in the Revoked column on the Authorized OAuth Tokens page), you can enable it. To do this, perform the following steps:
-
-
In the Authorized OAuth Tokens grid, select the token with the Revoked status set to Yes and select the checkbox next to it.
-
You can select more than one token with the Revoked status and enable all of them by using the mass action.
-
In the Actions drop-down list, select the Enable option and click Submit.
-
The required token is enabled.
-
-
-
-
Revoking Tokens
-
-
If a token is enabled (the No value in the Revoked column), you can revoke it. To do this, perform the following steps:
-
-
In the Authorized OAuth Tokens grid, select the token with the Revoked status set to No and select the checkbox next to it.
-
You can select more than one token with the Revoked status set to No and revoke all of them by using the mass action.
-
In the Actions drop-down list, select the Revoke option and click Submit.
-
The required token is revoked.
-
-
-
-
Deleting Tokens
-
-
To delete the required token, perform the following steps:
-
-
In the Authorized OAuth Tokens grid, select the token to be deleted and select the checkbox next to it.
-
You can select more than one token and delete all of them by using the mass action.
-
In the Actions drop-down list, select the Delete option and click Submit.
-
The required token is deleted.
-
-
-
-
-
Working with Tokens (Frontend)
-
-
Viewing Applications
-
-
To view the authorized applications from the frontend, perform the following steps:
-
-
-
On the frontend, click My Account and then select the My Applications tab on the left.
-
On the My Applications page, the list of registered applications will be displayed.
-
-
-
-
-
-
From this page, you can enable, revoke, or delete the required token.
-
-
Enabling Tokens
-
-
-
In the list of consumers, select the consumer to be enabled.
-
If the token is revoked, there will be the Disabled status next to it.
-
Click Enable next to the consumer name.
-
The token is enabled.
-
-
-
-
Disabling Tokens
-
-
-
In the list of consumers, select the consumer to be disabled.
-
If the token is enabled, there will be the Enabled status next to it.
-
Click Disable next to the consumer name.
-
The token is disabled.
-
-
-
-
Deleting Tokens
-
-
-
In the list of consumers, select the consumer to be deleted.
-
Click Delete next to the consumer name.
-
The token is deleted.
-
-
-
-
-
Working with Email Templates
-
-
Setting Up the Default Email Template
-
-
You can set the email template that will be used for user notification if the token status changes. Also, you can set different email templates for different store views. For example, you have two store views: English and German. Magento allows you to set one email template for the English store view and another one for the German store view.
-To set the email template, perform the following steps:
-
-
On the Admin Panel menu, select System > Configuration.
-
Select Services > OAuth on the left.
-
-
In the Email panel, from the Token Status Change Email Template drop-down list, select the required template and click Save Config in the top right corner.
-
The template is saved.
-
-
-
-
Creating a New Email Template
-
-
You can also create your own email template that will be used for user notification if the token status changes.
-To create a new template, perform the following steps:
-
-
On the Admin Panel menu, select System > Transactional Emails.
-
The Transactional Emails page opens. Click Add New Template in the top right corner.
-
The New Email template page opens. In the Load default template panel, in the Template drop-down list, select the Token Status Change option.
-
Specify the Locale option and click Load Template.
-
In the Template Information panel, the template data is loaded. You can specify your own template name, subject, and content.
-
When the email template is created, click Save Template in the top right corner.
-
Set the newly created template as it was described above.
-
-
-
-
Cleanup Configuration
-
-
You can configure the cleanup functionality for temporary tokens. These tokens can be deleted after a certain period of time or after a certain number of OAuth requests.
-To configure cleanup, perform the following steps:
-
-
On the Admin Panel menu, select System > Configuration.
-
Select Services > OAuth on the left.
-
-
In the Cleanup Statistics panel, you can set the following values:
-
-
Cleanup Probability: Define the threshold of OAuth requests after which the cleanup will be performed. Only temporary credentials will be removed. Enter 0 to disable the cleanup.
-
Expiration Period: Define the period (in minutes) on the expiry of which entries will be deleted from the database.
-
-
-
Click Save Config in the top right corner to save changes.
HTTP status codes are an essential part of the REST concept. You can get familiar with all of them on Wikipedia.
-
-
The Magento API attempts to return appropriate HTTP status codes for all requests. Any information is returned in the form of a standard HTTP response with an HTTP status code describing the error and the body message.
-
-
HTTP Status Codes
-
-
The following table contains possible common HTTP status codes:
-
-
-
-
Status Code
-
Message
-
-
-
200 OK
-
-
-
-
-
201 Created
-
Resource was partially created
-
-
-
-
207 Multi-Status
-
-
-
-
-
400 Bad Request
-
Resource data pre-validation error.
-Resource data invalid.
-Resource unknown error.
-The request data is invalid.
-Resource collection paging error.
-The paging limit exceeds the allowed number.
-Resource collection ordering error.
-Resource collection filtering error.
-Resource collection including additional attributes error.
-
-
-
403 Forbidden
-
Access denied.
-
-
-
404 Not Found
-
Resource not found.
-
-
-
405 Method Not Allowed
-
Resource does not support method.
-Resource method not implemented yet.
When the Magento API returns an error message, it returns it in your requested format. For example, an error in the XML format might look like the following:
An error in the JSON format might look like the following:
-
-
-
-
{"messages":{"error":[{"code":404,"message":"Resource not found."}]}}
-
-
-
-
-
diff --git a/guides/m1x/api/rest/get_filters.html b/guides/m1x/api/rest/get_filters.html
deleted file mode 100644
index 3c5f8ad9c9..0000000000
--- a/guides/m1x/api/rest/get_filters.html
+++ /dev/null
@@ -1,77 +0,0 @@
----
-layout: m1x_rest
-title: GET Filters
----
-
-JSON responses on this page contributed by Tim Reynolds
-
-
Some requests use GET parameters in the URL. These are as follows:
-
-
-
filter - specifies the filters for returned data
-
page - specifies the page number which items will be returned
-
-
e.g., http://magentohost/api/rest/products?page=1
-
-
-
order, dir - specifies the sort order of returned items and the order direction: 'asc' - returns items in the ascending order; 'dsc' - returns items in the descending order.
-
limit - limits the number of returned items in the response. Note that by default, 10 items are returned in the response. The maximum number is 100 items.
-
Accessing API is performed via HTTP. When you enter a URL into a web browser address bar, the browser performs an HTTP GET request to the URL. This usually returns a web page in the form of an HTTP response that the browser displays. But the GET method is one of several HTTP request methods. Magento REST API uses the four main HTTP methods: GET, POST, PUT, and DELETE. The most widespread methods are GET and POST. The other methods are less known but they became widely known due to the popularity of REST web services. An important concept of the REST architecture is that different HTTP request methods perform different actions when applied to the same URL.
The HTTP GET method is defined in section 9.3 of the RFC2616 document:
-
-
-
The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the entity in the response and not the source text of the process, unless that text happens to be the output of the process.
-
You can retrieve a representation of a resource by getting its URL.
-
-
-
-
POST and PUT
-
-
Creating or Updating Resources with the HTTP POST and PUT Methods
-
-
The POST method is defined in section 9.5 of the RFC2616 document:
-
-
-
The POST method is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. POST is designed to allow a uniform method to cover the following functions:
-
-
-
Annotation of existing resources;
-
-
-
-
-
Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles;
-
-
-
-
-
Providing a block of data, such as the result of submitting a form, to a data-handling process;
-
-
-
-
-
Extending a database through an append operation.
-
-
-
-
-
-
The PUT method is defined in section 9.6 of the RFC2616 document:
-
-
The PUT method requests that the enclosed entity be stored under the supplied Request-URI. If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a modified version of the one residing on the origin server.
-
-
-
Creating or updating a resource involves performing an HTTP POST or HTTP PUT to a resource URL.
-
-
-
-
DELETE
-
-
Deleting Resources with the HTTP DELETE Method
-
-
The DELETE method is defined in section 9.7 of the RFC2616 document:
-
-
The DELETE method requests that the origin server delete the resource identified by the Request-URI. This method MAY be overridden by human intervention (or other means) on the origin server.
-
-
-
Deleting a resource is performed by means of making an HTTP DELETE request to the resource URL.
-
-
-
diff --git a/guides/m1x/api/rest/introduction.html b/guides/m1x/api/rest/introduction.html
deleted file mode 100644
index 0f666856b0..0000000000
--- a/guides/m1x/api/rest/introduction.html
+++ /dev/null
@@ -1,510 +0,0 @@
----
-layout: m1x_rest
-title: Introduction to the Magento 1.x REST API
----
-
-
-
What is REST API? To make it simple, REST API defines a set of functions to which the developers can perform requests
- and receive responses. The interaction is performed via the HTTP protocol. An advantage of such an approach is the
- wide usage of HTTP. That is why REST API can be used practically for any programming language.
-
-
Common characteristics of Magento REST API resources are as follows: (magentohost is your domain)
-
-
-
You access the resource by sending an HTTP request to the Magento API server. The server replies with a response
- that contains either the data you requested, or the status indicator, or even both.
All resources may return different HTTP status codes (e.g., HTTP Status Code 200 for success response or HTTP
- Status Code 400 for the bad request).
-
You request a particular resource by adding a particular path to the base URL that specifies the resource.
-
-
-
-
Overall Capabilities
-
-
Magento REST API allows managing a number of features, namely:
-
-
-
Managing customers.
-
Managing customer addresses.
-
Managing products.
-
Retrieving sales orders.
-
Managing inventory.
-
-
-
-
-
Authentication
-
-
Magento REST API uses 3-legged OAuth 1.0a protocol to authenticate
- the application to access the Magento service.
-
-
-
Output Formats
-
-
The REST API supports the response in two formats, which are XML and JSON.
-
-
HTTP Verbs
-
-
HTTP verbs are used to manage the state of resources. In Magento REST API, there are four verbs used to manage
- resources: GET, POST, PUT, and DELETE. You can get the contents of the data using HTTP GET, delete the data using
- HTTP DELETE, and create or update the data using POST/PUT.
-
-
Request Structure
-
-
All URLs in REST API have the following base URL.
-
-
http://magentohost/api/rest/
-
-
-
Example
-
-
Supposing, you want to retrieve the list of customers from Magento. To do this, you need to use the GET HTTP method.
- The GET request to retrieve the list of customers will look as follows:
-
-
-
-
http://magentohost/api/rest/customers
-
-
-
-
where
-
-
-
http://magentohost/api/rest/ - endpoint
-
/customers - action URL
-
-
-
-
REST Resources
-
-
The Magento REST API allows you to manage customers, customer addresses, sales orders, inventory, and products. REST
- API is organized into the following categories:
-
-
Products
-
-
-
Retrieve the list of products, create, update, and delete a product.
- Resource Structure: http://magentohost/api/rest/products
-
-
-
-
Product Categories
-
-
-
Retrieve the list of categories assigned to a product, assign, and unassign the category to/from the specific
- product.
- Resource Structure: http://magentohost/api/rest/products/:productId/categories
-
-
-
-
Product Images
-
-
-
Retrieve the list of images assigned to a product, add, update, and remove an image to/from the specific
- product.
- Resource Structure: http://magentohost/api/rest/products/:productId/images
-
-
-
-
Product Websites
-
-
-
Retrieve the list of websites assigned to a product, assign, and unassign a website to/from the specific
- product.
- Resource Structure: http://magentohost/api/rest/products/:productId/websites
-
-
-
-
Customers
-
-
-
Retrieve the list of customers, create, delete a customer, and update the customer information.
- Resource Structure: http://magentohost/api/rest/customers
-
-
-
-
Customer Addresses
-
-
-
Retrieve the list of customer addresses, create, update, and delete the customer address.
- Resource Structure: http://magentohost/api/rest/customers/:customerId/addresses
-
-
-
-
Inventory
-
-
-
Retrieve the list of stock items and update required stock items.
- Resource Structure: http://magentohost/api/rest/stockitems
-
-
-
-
Sales Orders
-
-
-
Retrieve the list of sales orders as well as the specific order information.
- Resource Structure: http://magentohost/api/rest/orders
-
-
-
-
Order Items
-
-
-
Retrieve order items for the specific order.
- Resource Structure: http://magentohost/api/rest/orders/:orderId/items
-
-
-
-
Order Addresses
-
-
-
Retrieve information on order billing and shipping addresses for the specific order.
- Resource Structure: http://magentohost/api/rest/orders/:orderid/addresses
-
-
-
-
Order Comments
-
-
-
Retrieve order comments for the specific order
- Resource Structure: http://magentohost/api/rest/orders/:orderid/comments
-
-
-
-
Preparing for REST API
-
-
These steps are required for utilizing REST API resources:
-
-
-
Set up permissions for REST resource operations from Magento Admin Panel.
-
Configure the attributes for different users types in Magento Admin Panel. There are 3 different types of users
- in accessing the data: Admin, Customer, and Guest. Admin is the backend logged in user, Customer is the fronted
- logged in user, and Guest is a non-logged in fronted user.
-
-
-
-
Preparing REST API for the Third-Party
- Application
-
-
-
Register the third-party application (Consumer) in Magento Admin Panel.
-
The third-party application will utilize the provided consumer credentials to call Magento store for getting the
- access token to access the data.
-
-
-
-
-
-
PHP Examples
-
-
-
Create a simple product
- as an Admin user with OAuth authentication
-
-
-
-
-
<?php
-/**
-* Example of simple product POST using Admin account via Magento REST API. OAuth authorization is used.
-*
-* This file is a stand-alone OAuth client PHP file, which handles everything with the OAuth three-legged authentication.
-* It uses PHP session to persist the current authentication state (step), the OAuth request token with its secret
-* and the OAuth access token with its secret.
-*
-* Create this file oauth_admin.php in your Magento 1.x instance root folder to run this oauth authentication example.
-*
-* oauth_admin.php
-*
-*/
-
-$callbackUrl = "http://yourhost/oauth_admin.php";
-$temporaryCredentialsRequestUrl = "http://magentohost/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
-$adminAuthorizationUrl = 'http://magentohost/admin/oauth_authorize';
-$accessTokenRequestUrl = 'http://magentohost/oauth/token';
-$apiUrl = 'http://magentohost/api/rest';
-$consumerKey = 'yourconsumerkey';
-$consumerSecret = 'yourconsumersecret';
-
-session_start();
-if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
- $_SESSION['state'] = 0;
-}
-try {
- $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
- $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
- $oauthClient->enableDebug();
-
- if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
- // step 1 (state 1) - Get the initial temporary request token.
- $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
-
- // persist the request token secret in the session variable for step 3 to get the access token and secret.
- $_SESSION['secret'] = $requestToken['oauth_token_secret'];
- $_SESSION['state'] = 1;
-
- // step 2 (state 2) - redirect to the Oauth admin authorization url to validate and confirm / reject the admin Oauth authorization request.
- // variable $requestToken['oauth_token'] has the temporary request token
- header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
- exit;
- } elseif ($_SESSION['state'] == 1) {
- //step 3 (state 3) Exchange the temporary request token and secret to get the final access token and secret.
- $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
- $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
-
- // persist the access token and its secret in the session variable
- $_SESSION['state'] = 2;
- $_SESSION['token'] = $accessToken['oauth_token'];
- $_SESSION['secret'] = $accessToken['oauth_token_secret'];
-
- // redirect back to the callback url which is the same file
- header('Location: ' . $callbackUrl);
- exit;
- } else {
-
- // send a POST request to create a simple product
- $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
- $resourceUrl = "$apiUrl/products";
- $productData = json_encode(array(
- 'type_id' => 'simple',
- 'attribute_set_id' => 4,
- 'sku' => 'simple' . uniqid(),
- 'weight' => 1,
- 'status' => 1,
- 'visibility' => 4,
- 'name' => 'Simple Product',
- 'description' => 'Simple Description',
- 'short_description' => 'Simple Short Description',
- 'price' => 99.95,
- 'tax_class_id' => 0,
- ));
- $headers = array('Content-Type' => 'application/json');
- $oauthClient->fetch($resourceUrl, $productData, OAUTH_HTTP_METHOD_POST, $headers);
- print_r($oauthClient->getLastResponseInfo());
- }
-} catch (OAuthException $e) {
- print_r($e);
-}
-
-
-
-
-
Retrieve the list
- of products as a Customer user with OAuth authentication
-
-
-
-
-
<?php
-/**
-* Example of products list retrieve using Customer account via Magento REST API. OAuth authorization is used
-*
-* This file is a stand-alone Oauth client PHP file, which handles everything with the Oauth three-legged authentication.
-* It uses PHP session to persist the current authentication state (step), the oauth request token with its secret
-* and the oauth access token with its secret.
-*
-* Create this file oauth_customer in your Magento 1.x instance root folder to run this oauth authentication example.
-*
-* oauth_customer.php
-*
-*/
-$callbackUrl = "http://yourhost/oauth_customer.php";
-$temporaryCredentialsRequestUrl = "http://magentohost/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
-$adminAuthorizationUrl = 'http://magentohost/oauth/authorize';
-$accessTokenRequestUrl = 'http://magentohost/oauth/token';
-$apiUrl = 'http://magentohost/api/rest';
-$consumerKey = 'yourconsumerkey';
-$consumerSecret = 'yourconsumersecret';
-
-session_start();
-if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
- $_SESSION['state'] = 0;
-}
-try {
- $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
- $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
- $oauthClient->enableDebug();
-
- if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
- // step 1 (state 1) - Get the initial temporary request token.
- $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
-
- // persist the request token secret in the session variable for step 3 to get the access token and secret.
- $_SESSION['secret'] = $requestToken['oauth_token_secret'];
- $_SESSION['state'] = 1;
-
- // step 2 (state 2) - redirect to the Oauth customer authorization url.
- // variable $requestToken['oauth_token'] has the temporary request token
- header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
- exit;
- } elseif ($_SESSION['state'] == 1) {
- //step 3 (state 3) Exchange the temporary request token and secret to get the final access token and secret.
- $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
- $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
-
- // persist the access token and its secret in the session variable to access the products resource
- $_SESSION['state'] = 2;
- $_SESSION['token'] = $accessToken['oauth_token'];
- $_SESSION['secret'] = $accessToken['oauth_token_secret'];
-
- // redirect back to the callback url which is the same file
- header('Location: ' . $callbackUrl);
- exit;
- } else {
- // send a GET request to list all the products
- $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
- $resourceUrl = "$apiUrl/products";
- $oauthClient->fetch($resourceUrl, array(), 'GET', array('Content-Type' => 'application/json', 'Accept' => '*/*'));
- $productsList = json_decode($oauthClient->getLastResponse());
- print_r($productsList);
- }
-} catch (OAuthException $e) {
- print_r($e);
-}
-
-
-
-
-
REST Client Example
-
-
Retrieving the list of Products as a Guest
-
-
-
Use the REST Client that is a Firefox
- add-on. In the REST Client, in the Method drop-down list, select the GET option.
-
In the URL field, enter the following URL: http://magentohost/api/rest/products?limit=2.
-
Click Send. Information about the products will be displayed in the response body. Example in the XML
- format is as follows:
-
-
-
-
Example: XML
-
-
-
-
<?xml version="1.0"?>
-<magento_api>
- <data_item>
- <entity_id>16</entity_id>
- <type_id>simple</type_id>
- <sku>n2610</sku>
- <description>The Nokia 2610 is an easy to use device that combines multiple messaging options including email, instant messaging, and more. You can even download MP3 ringtones, graphics, and games straight to the phone, or surf the Internet with Cingular's MEdia Net service. It's the perfect complement to Cingular service for those even remotely interested in mobile Web capabilities in an affordable handset.
-Design
-Compact and stylish, the 2610 features a candybar design sporting a bright 128 x 128 pixel display capable of displaying over 65,000 colors. Most of the phone's features and on-screen menus are controlled by a center toggle on the control pad. A standard hands-free headphone jack is provided, as are volume control keys, and there's even a "Go-To" button that can be assigned by the user for quick access to favorite applications. Lastly, the included speakerphone allows you to talk handsfree, and because the phone sports an internal antenna, there's nothing to snag or break off.
-</description>
- <meta_keyword>Nokia 2610, cell, phone, </meta_keyword>
- <short_description>The words "entry level" no longer mean "low-end," especially when it comes to the Nokia 2610. Offering advanced media and calling features without breaking the bank</short_description>
- <name>Nokia 2610 Phone</name>
- <meta_title>Nokia 2610</meta_title>
- <meta_description>Offering advanced media and calling features without breaking the bank, The Nokia 2610 is an easy to use</meta_description>
- <regular_price_with_tax>149.99</regular_price_with_tax>
- <regular_price_without_tax>149.99</regular_price_without_tax>
- <final_price_with_tax>149.99</final_price_with_tax>
- <final_price_without_tax>149.99</final_price_without_tax>
- <is_saleable>1</is_saleable>
- <image_url>http://magentohost/imageulr/nokia.jpg</image_url>
- </data_item>
- <data_item>
- <entity_id>17</entity_id>
- <type_id>simple</type_id>
- <sku>bb8100</sku>
- <description> Like the BlackBerry 7105t, the BlackBerry 8100 Pearl is
-The BlackBerry 8100 Pearl sports a large 240 x 260 screen that supports over 65,000 colors-- plenty of real estate to view your e-mails, Web browser content, messaging sessions, and attachments. The venerable BlackBerry trackwheel has been replaced on this model with an innovative four-way trackball placed below the screen. On the rear of the handheld, you'll find a 1.3-megapixel camera and a self portrait mirror. The handheld's microSD memory card slot is located inside the device, behind the battery. There's also a standard 2.5mm headset jack that can be used with the included headset, as well as a mini-USB port for data connectivity.</description>
- <meta_keyword>Blackberry, 8100, pearl, cell, phone</meta_keyword>
- <short_description>The BlackBerry 8100 Pearl is a departure from the form factor of previous BlackBerry devices. This BlackBerry handset is far more phone-like, and RIM's engineers have managed to fit a QWERTY keyboard onto the handset's slim frame.</short_description>
- <name>BlackBerry 8100 Pearl</name>
- <meta_title>BlackBerry 8100 Pearl</meta_title>
- <meta_description>BlackBerry 8100 Pearl sports a large 240 x 260 screen that supports over 65,000 colors-- plenty of real estate to view your e-mails, Web browser content, messaging sessions, and attachments.</meta_description>
- <regular_price_with_tax>349.99</regular_price_with_tax>
- <regular_price_without_tax>349.99</regular_price_without_tax>
- <final_price_with_tax>349.99</final_price_with_tax>
- <final_price_without_tax>349.99</final_price_without_tax>
- <is_saleable>1</is_saleable>
- <image_url>http://magentohost/imageulr/blackberry.jpg</image_url>
- </data_item>
-</magento_api>
-
-
-
-
-
Additional Information
-
-
You can define the limit of items returned in the response by passing the limit parameter. By default, 10 items are
- returned and the maximum number is 100 items. You can also define the page number by passing the page parameter.
- Example:
Authorization header will be required for Admin and Customer user types. The following parameters must be provided in
- the Authorization header for the call:
-
-
oauth_consumer_key - the Consumer Key value provided after the registration of the application.
-
oauth_nonce - a random value, uniquely generated by the application.
-
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following
- values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
-
oauth_signature - a generated value (signature).
-
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
-
-
oauth_token - the oauth_token value (Request Token).
REST attributes allow specifying additional filters for different types of users. Attributes allow limiting user access more precisely.
-
-
-
REST Attributes Structure
-
-
-
-
The REST attributes tree includes the following elements (as subnodes):
-
-
Name of the resource
-
-
Read permissions (includes all elements available for the current resource)
-
Write permissions (includes all elements available for the current resource)
-
-
-
-
-
-
The Resources tree may be too immense. To avoid scrolling down when searching for the required resource, you can fold the nodes for better representation.
-
-
-
-
Managing Attributes for Guest
-
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
-
The REST Attributes page opens. From the list of user types, select the Guest type and click it.
-
The page for editing attribute rules opens.
-
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to a Guest type of user by selecting the corresponding All or Custom options.
-
If you select the Custom option, the resources tree appears.
-
Select the required options and click Save in the top right corner to apply changes.
-
-
-
-
-
Managing Attributes for Customer
-
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
-
The REST Attributes page opens. From the list of user types, select the Customer type and click it.
-
The page for editing attribute rules opens.
-
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to a Customer type of user by selecting the corresponding All or Custom options.
-
If you select the Custom option, the resources tree appears. Some resources have options for selecting read and write permissions.
-
Select the required options and click Save in the top right corner to apply changes.
-
-
-
-
Managing Attributes for Admin
-
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
-
The REST Attributes page opens. From the list of user types, select the Admin type and click it.
-
The page for editing attribute rules opens.
-
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to an Admin type of user by selecting the corresponding All or Custom options.
-
If you select the Custom option, the resources tree appears. Each resource has options for selecting read and write permissions.
-
Select the required options and click Save in the top right corner to apply changes.
-
-
-
-
-
Examples
-
-
This section provides some examples of limiting Guest and Customer access to certain resource elements.
-
-
Limiting Guest Access to Products
-
-
To allow Guests (users that are not registered in the Magento system) view only product name and final price with tax, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles and select the Guest role.
-
In the Role API Resources, specify the Retrieve option for the Product resource.
-
Click Save Role on the top right corner to save the role.
-
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes and select Guest in the list of User Types.
-
In the Resources tree, navigate to the Catalog Product node. In the Read subnode, select the Name and Final Price With Tax options.
-
Click Save in the top right corner to save the selected attributes.
-
-
-
-
-
Limiting Customer Access to Products
-
-
To allow Customers (users that are registered in the Magento system) view only product name and final price with tax, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles and select the Customer role.
-
In the Role API Resources, specify the Retrieve option for the Product resource.
-
Click Save Role on the top right corner to save the role.
-
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes and select Customer in the list of User Types.
-
In the Resources tree, navigate to the Catalog Product node. In the Read subnode, select the Name and Final Price With Tax options.
-
Click Save in the top right corner to save the selected attributes.
The following table describes REST attributes that can be managed in the Magento Admin Panel.
-To access these attributes, go to System > Web Services > REST Attributes and select the type of the user for which attributes will be managed.
-
-
-
Order/Orders
-
-
-
-
-
-
Attribute Name
-
Attribute Description
-
Notes
-
-
-
Order ID
-
Sales order ID
-
-
-
-
Order Date
-
Date when the sales order was placed
-
-
-
-
Order Status
-
Sales order status. Can have the following values: Pending, Processing, Complete, Closed, Holded, Pending PayPal, and Payment Review.
-
-
-
-
Shipping Method
-
Shipping method selected during the checkout process (e.g., Flat rate - Fixed)
-
-
-
-
Payment Method
-
Payment method selected during the checkout process (e.g., Check/money order)
-
-
-
-
Base Currency
-
Base currency code (e.g., USD)
-
-
-
-
Order Currency
-
Order currency code (e.g., EUR)
-
-
-
-
Store Name
-
Name of the store from which the order was placed
-
-
-
-
Placed from IP
-
IP address from which the order was placed
-
-
-
-
Store Currency to Base Currency Rate
-
Store currency to base currency rate
-
-
-
-
Subtotal
-
Subtotal amount in order currency (excluding shipping and tax)
-
-
-
-
Subtotal Including Tax
-
Subtotal amount including tax (in order currency)
-
-
-
-
Discount
-
Discount amount applied in the sales order in order currency
-
-
-
-
Grand Total to Be Charged
-
Total amount of money to be paid for the order in base currency (including tax)
-
-
-
-
Grand Total
-
Grand total amount in order currency (including tax and shipping)
-
-
-
-
Shipping
-
Shipping amount applied in the sales order in order currency
-
-
-
-
Shipping Including Tax
-
Shipping amount including tax (in order currency)
-
-
-
-
Shipping Tax
-
Tax amount for shipping in order currency
-
-
-
-
Tax Amount
-
Tax amount applied in the sales order in order currency
-
-
-
-
Tax Name
-
Name of the applied tax
-
-
-
-
Tax Rate
-
Tax rate applied in the order (in order currency)
-
-
-
-
Gift Cards Amount
-
Gift card pricing amount
-
This attribute is available only in Magento EE
-
-
-
Reward Points Balance
-
Reward points amount (that can be converted to currency)
-
This attribute is available only in Magento EE
-
-
-
Reward Currency Amount
-
Reward currency amount
-
This attribute is available only in Magento EE
-
-
-
Coupon Code
-
Coupon code that was applied in the order
-
-
-
-
Base Discount
-
Amount of applied discount in base currency
-
-
-
-
Base Subtotal
-
Subtotal amount for all products in the order in base currency (excluding tax and shipping)
-
-
-
-
Base Shipping
-
Amount of money to be paid for shipping in base currency
-
-
-
-
Base Shipping Tax
-
Tax amount for shipping in base currency
-
-
-
-
Base Tax Amount
-
Tax amount applied to the order items in base currency
-
-
-
-
Total Paid
-
Total amount paid for the order (in order currency)
-
-
-
-
Base Total Paid
-
Total amount paid for the order (in base currency)
-
-
-
-
Total Refunded
-
Total refunded amount in order currency
-
-
-
-
Base Total Refunded
-
Total amount refunded for the order (in base currency)
-
-
-
-
Base Subtotal Including Tax
-
Subtotal amount including tax but excluding the discount amount (in base currency)
-
-
-
-
Base Total Due
-
The rest of the money to be paid for the order in base currency (e.g., when partial invoice is applied)
-
-
-
-
Total Due
-
The rest of the money to be paid for the order in order currency (e.g., when partial invoice is applied)
-
-
-
-
Shipping Discount
-
Discount amount for shipping (in order currency)
-
-
-
-
Base Shipping Discount
-
Discount amount for shipping (in base currency)
-
-
-
-
Discount Description
-
Discount code (coupon code applied in the order)
-
-
-
-
Customer Balance
-
Customer balance (in order currency)
-
-
-
-
Base Customer Balance
-
Customer balance (in base currency)
-
-
-
-
Base Gift Cards Amount
-
Gift card pricing amount (in base currency)
-
This attribute is available only in Magento EE
-
-
-
Base Rewards Currency
-
Reward currency amount (in base currency)
-
This attribute is available only in Magento EE
-
-
-
-
-
-
Order Addresses
-
-
-
-
-
Attribute Name
-
Attribute Description
-
-
-
Customer Last Name
-
Customer last name
-
-
-
Customer First Name
-
Customer first name
-
-
-
Customer Middle Name
-
Customer middle name or initial
-
-
-
Customer Prefix
-
Customer prefix
-
-
-
Customer Suffix
-
Customer suffix
-
-
-
Company
-
Company name
-
-
-
Street
-
Street address
-
-
-
City
-
City
-
-
-
State
-
State
-
-
-
ZIP/Postal Code
-
ZIP or postal code
-
-
-
Country
-
Country name
-
-
-
Phone Number
-
Customer phone number
-
-
-
Address Type
-
Address type. Can have the following values: billing or shipping
-
-
-
-
-
-
-
Order Items
-
-
-
-
-
Attribute Name
-
Attribute Description
-
-
-
Base Discount Amount
-
Discount amount applied to the row in base currency
-
-
-
Base Item Subtotal
-
Row subtotal in base currency
-
-
-
Base Item Subtotal Including tax
-
Row subtotal including tax in base currency
-
-
-
Base Original Price
-
Original item price in base currency
-
-
-
Base Price
-
Item price in base currency
-
-
-
Base Price Including tax
-
Item price including tax in base currency
-
-
-
Base Tax Amount
-
Tax amount applied to the row in base currency
-
-
-
Canceled Qty
-
Number of canceled order items
-
-
-
Discount Amount
-
Discount amount applied to the row in order currency
-
-
-
Invoiced Qty
-
Number of invoiced order items
-
-
-
Item Subtotal
-
Row subtotal in order currency
-
-
-
Item Subtotal Including Tax
-
Row subtotal including tax in order currency
-
-
-
Order Item ID
-
Order item ID
-
-
-
Ordered Qty
-
Number of ordered items
-
-
-
Original Price
-
Original item price in order currency
-
-
-
Parent Order Item ID
-
ID of the configurable product to which the simple product is assigned
-
-
-
Price
-
Item price in order currency
-
-
-
Price Including Tax
-
Item price including tax in order currency
-
-
-
Product and Custom Options Name
-
Name of the product (custom options name)
-
-
-
Refunded Qty
-
Number of refunded order items
-
-
-
SKU
-
Product SKU
-
-
-
Shipped Qty
-
Number of shipped order items
-
-
-
Tax Amount
-
Tax amount applied to the row in order currency
-
-
-
Tax Percent
-
Tax percent applied to the row
-
-
-
-
-
-
-
Stock Item
-
-
-
-
-
Attribute Name
-
Attribute Description
-
-
-
Automatically Return Credit Memo Item to Stock
-
Defines whether products can be automatically returned to stock when the refund for an order is created
-
-
-
Backorders
-
Defines whether the customer can place the order for products that are out of stock at the moment. Can have the following values: 0 - No Backorders, 1 - Allow Qty Below 0, and 2 - Allow Qty Below 0 and Notify Customer
-
-
-
Can Be Divided into Multiple Boxes for Shipping
-
Defines whether the stock items can be divided into multiple boxes for shipping
-
-
-
Enable Qty Increments
-
Defines whether the customer can add products only in increments to the shopping cart
-
-
-
Item ID
-
Stock item ID
-
-
-
Low Stock Date
-
Date when the number of stock items became lower than the number defined in the Notify for Quantity Below option
-
-
-
Manage Stock
-
Choose whether to view and specify the product quantity and availability and whether the product is in stock management. Can have the following values: 0 - No, 1 - Yes
-
-
-
Maximum Qty Allowed in Shopping Cart
-
Maximum number of items in the shopping cart to be sold
-
-
-
Minimum Qty Allowed in Shopping Cart
-
Minimum number of items in the shopping cart to be sold
-
-
-
Notify for Quantity Below
-
The number of inventory items below which the customer will be notified via the RSS feed
-
-
-
Product ID
-
Product ID
-
-
-
Qty
-
Quantity of stock items for the current product
-
-
-
Qty Increments
-
The product quantity increment value
-
-
-
Qty Uses Decimals
-
Choose whether the product can be sold using decimals (e.g., you can buy 2.5 product)
-
-
-
Qty for Item's Status to Become Out of Stock
-
Quantity for stock items to become out of stock
-
-
-
Stock Availability
-
Defines whether the product is available for selling. Can have the following values: 0 - Out of Stock, 1 - In Stock
-
-
-
Stock ID
-
Stock ID
-
-
-
Use Config Settings for Backorders
-
Choose whether the Config settings will be applied for the Backorders option
-
-
-
Use Config Settings for Enable Qty Increments
-
Choose whether the Config settings will be applied for the Enable Qty Increments option
-
-
-
Use Config Settings for Manage Stock
-
Choose whether the Config settings will be applied for the Manage Stock option
-
-
-
Use Config Settings for Maximum Qty Allowed in Shopping Cart
-
Choose whether the Config settings will be applied for the Maximum Qty Allowed in Shopping Cart option
-
-
-
Use Config Settings for Minimum Qty Allowed in Shopping Cart
-
Choose whether the Config settings will be applied for the Minimum Qty Allowed in Shopping Cart option
-
-
-
Use Config Settings for Notify for Quantity Below
-
Choose whether the Config settings will be applied for the Notify for Quantity Below option
-
-
-
Use Config Settings for Qty Increments
-
Choose whether the Config settings will be applied for the Qty Increments option
-
-
-
Use Config Settings for Qty for Item's Status to Become Out of Stock
-
Choose whether the Config settings will be applied for the Qty for Item's Status to Become Out of Stock option
-
-
-
-
-
-
Notes: The Admin user type has restrictions concerning the WRITE operations for definite stock item attributes. These are as follows:
-
-
-
-
Attribute Name
-
Admin
-
-
-
Item ID
-
No
-
-
-
Product ID
-
No
-
-
-
Stock ID
-
No
-
-
-
Low Stock Date
-
No
-
-
-
-
-
However, these attributes are available for READ operations.
-
-
-
-
Customer
-
-
-
-
-
Attribute Name
-
Attribute Description
-
-
-
Customer ID
-
Customer ID
-
-
-
Last Logged In
-
Date when the customer was logged in last
-
-
-
Is Confirmed
-
Defines whether the email confirmation is sent to the customer
-
-
-
Created At
-
Date when the customer was created
-
-
-
Associate to Website
-
Website ID to which the customer is associated
-
-
-
Created From
-
Store view from which the customer was created
-
-
-
Group
-
Customer group ID
-
-
-
Disable automatic group change
-
Defines whether the automatic group change will be applied to the customer
-
-
-
Prefix
-
Customer prefix
-
-
-
First Name
-
Customer first name
-
-
-
Middle Name/Initial
-
Customer middle name or initial
-
-
-
Last Name
-
Customer last name
-
-
-
Suffix
-
Customer suffix
-
-
-
Email
-
Customer email address
-
-
-
Date Of Birth
-
Customer date of birth
-
-
-
Tax/VAT Number
-
Customer tax or VAT number
-
-
-
Gender
-
Customer gender (male or female)
-
-
-
-
-
-
Customer Address
-
-
-
-
-
-
Attribute Name
-
Attribute Description
-
-
-
City
-
City name
-
-
-
Company
-
Company name
-
-
-
Country
-
Country
-
-
-
Customer Address ID
-
Customer address ID
-
-
-
Fax
-
Fax number
-
-
-
First Name
-
Customer first name
-
-
-
Is Default Billing Address
-
Defines whether the address is a default one for billing
-
-
-
Is Default Shipping Address
-
Defines whether the address is a default one for shipping
-
-
-
Last Name
-
Customer last name
-
-
-
Middle Name/Initial
-
Customer middle name or initial
-
-
-
Prefix
-
Customer prefix
-
-
-
State/Province
-
Customer state/region
-
-
-
Street Address
-
Customer street address
-
-
-
Suffix
-
Customer suffix
-
-
-
Telephone
-
Customer phone number
-
-
-
VAT Number
-
Customer VAT number
-
-
-
ZIP/Postal Code
-
Customer ZIP or postal code
-
-
-
-
-
-
-
Product
-
-
Attributes for the product resource are divided into those available for the Admin type of user and those available for the Customer and Guest types of user.
-
-
-
-
-
Attribute Name
-
Attribute Description
-
Notes
-
-
-
Product ID
-
Product ID
-
Available only for Admin
-
-
-
name
-
Product Name
-
-
-
-
Product Type
-
Product type. Can have the following values: Simple, Grouped, Configurable, Virtual, Bundle, or Downloadable
-
-
-
-
Attribute Set Name
-
Name of the attribute set which the product is based on
-
Available only for Admin
-
-
-
sku
-
Product SKU
-
-
-
-
price
-
Product price
-
-
-
-
visibility
-
Product visibility in the store. Can have the following values: Catalog, Search; Search; Catalog; Not Visible Individually
-
Available only for Admin
-
-
-
description
-
Product description
-
-
-
-
short_description
-
Product short description
-
-
-
-
weight
-
Product weight
-
Available only for Admin
-
-
-
news_from_date
-
Date starting from which the product is promoted as a new product
-
Available only for Admin
-
-
-
news_to_date
-
Date till which the product is promoted as a new product
-
Available only for Admin
-
-
-
status
-
Product status in the store. Can have the following values: Enabled or Disabled
-
Available only for Admin
-
-
-
url_key
-
A friendly URL path for the product
-
Available only for Admin
-
-
-
Create Permanent Redirect for Old URL
-
Defines whether the redirect to an original URL will be applied (when the existing URL for a product is edited)
-
Available only for Admin; available only for product update
-
-
-
country_of_manufacture
-
Product country of manufacture
-
Available only for Admin
-
-
-
is_returnable
-
Defines whether the product can be returned
-
Available only for Admin
-
-
-
special_price
-
Product special price
-
Available only for Admin
-
-
-
special_from_date
-
Date starting from which the special price will be applied for the product
-
Available only for Admin
-
-
-
special_to_date
-
Date till which the special price will be applied for the product
-
Available only for Admin
-
-
-
group_price
-
Product group price
-
Available only for Admin
-
-
-
tier_price
-
Product tier price
-
-
-
-
msrp_enabled
-
The Apply MAP option. Defines whether the price in the catalog in the frontend is substituted with a Click for price link
-
Available only for Admin
-
-
-
msrp_display_actual_price_type
-
Defines how the price will be displayed in the frontend. Can have the following values: In Cart, Before Order Confirmation, and On Gesture
-
Available only for Admin
-
-
-
msrp
-
The Manufacturer's Suggested Retail Price option. The price that a manufacturer suggests to sell the product at
-
Available only for Admin
-
-
-
enable_googlecheckout
-
Defines whether the product can be purchased with the help of the Google Checkout payment service. Can have the following values: Yes and No
-
Available only for Admin
-
-
-
tax_class_id
-
The product tax class to which the product will be associated
-
Available only for Admin
-
-
-
meta_title
-
Product meta title
-
-
-
-
meta_keyword
-
Product meta keywords
-
-
-
-
meta_description
-
Product meta description
-
-
-
-
custom_design
-
Custom design applied for the product page
-
Available only for Admin
-
-
-
custom_design_from
-
Date starting from which the custom design will be applied for the product page
-
Available only for Admin
-
-
-
custom_design_to
-
Date till which the custom design will be applied for the product page
-
Available only for Admin
-
-
-
custom_layout_update
-
An XML block to alter the page layout
-
Available only for Admin
-
-
-
page_layout
-
Page template that can be applied to the product page
-
Available only for Admin
-
-
-
options_container
-
Defines how the custom options for the product will be displayed. Can have the following values: Block after Info Column or Product Info Column
-
Available only for Admin
-
-
-
gift_message_available
-
Defines whether the gift message is available for the product
-
Available only for Admin
-
-
-
Use Config Settings for Allow Gift Message
-
Defines whether the configuration settings will be used for the Allow Gift Message option
-
Available only for Admin
-
-
-
gift_wrapping_available
-
Defines whether the gift wrapping is available for the product
-
Available only for Admin. This attribute is available in Magento EE
-
-
-
Use Config Settings for Allow Gift Wrapping
-
Defines whether the configuration settings will be used for the Allow Gift Wrapping option
-
Available only for Admin. This attribute is available in Magento EE
-
-
-
gift_wrapping_price
-
Price for the gift wrapping (available in Magento EE)
-
Available only for Admin
-
-
-
Inventory Data
-
Product inventory data
-
Available only for Admin
-
-
-
Custom attr
-
Product custom attributes
-
The customer can see only attributes that are set as visible on frontend
-
-
-
Regular Price
-
The original product price displayed in the frontend
-
Available only for Customer and Guest
-
-
-
Final Price
-
The final product price
-
Available only for Customer and Guest
-
-
-
Final Price with Tax
-
The final product price with tax
-
Available only for Customer and Guest
-
-
-
Final Price Without Tax
-
The final product price without tax
-
Available only for Customer and Guest
-
-
-
Stock Status
-
The product stock status (availability)
-
Available only for Customer and Guest
-
-
-
Product Is Saleable
-
Defines whether the product can be sold
-
Available only for Customer and Guest
-
-
-
Total Reviews Number
-
The number of all reviews for a product
-
Available only for Customer and Guest
-
-
-
Product URL Link
-
A link to the product without the assigned category
-
Available only for Customer and Guest
-
-
-
Buy Now Link
-
A link that adds a product to the shopping cart
-
Available only for Customer and Guest
-
-
-
Product Has Custom Options
-
Defines whether the product has custom options or not
-
Available only for Customer and Guest
-
-
-
Default Product Image
-
Default product image
-
Available only for Customer and Guest
-
-
-
-
-
Product Category
-
-
-
-
-
-
Attribute Name
-
Attribute Description
-
-
-
Category ID
-
ID of the category to which the product is assigned
-
-
-
-
-
-
Product Image
-
-
-
-
-
-
Attribute Name
-
Attribute Description
-
Notes
-
-
-
Exclude
-
Defines whether the image will associate only to one of the three image types.
-
-
-
-
ID
-
Image file ID
-
Available only for READ operations
-
-
-
Label
-
A label that will be displayed on the frontend when pointing to the image
-
-
-
-
Position
-
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
-
-
-
-
Type
-
Image type. Can have the following values: Base Image, Small Image, or Thumbnail.
-
-
-
-
URL
-
Image file URL path
-
Available only for READ operations
-
-
-
File Content
-
Image file content (base_64 encoded)
-
Available only for WRITE operations
-
-
-
File MIME Type
-
File MIME type. Can have the following values: image/jpeg, image/png, image/gif, etc.
After the authentication is complete successfully, the Access Token is received and will be used in every API call. This key allows identifying the client that accesses the API. With the help of this key, the following information about the user can be retrieved:
-
-
-
Type of the API user
-
User ID (can be Admin ID or Customer ID)
-
-
-
Authorization
-
-
-
Access Levels
-
-
There is a three-level authorization approach in Magento REST API. These three levels are as follows:
-
-
Guest
-
Customer
-
Admin
-
-
-
-
The following graphic describes the default rights for each access level with each level obtaining more rights up to Admin who has access to everything.
-
-
-
-
-
Each user type will be described below.
-Magento grants permissions for the following three types of users:
-
-
Guest
-
-
Guest can be a type of application that does not require authentication. This application has access only to public resources.
-
-
Customer
-
-
Customer can be a registered and logged in user. This type of user can have access only to its own resources as well as to public resources.
-
-
Admin
-
-
Admin can be the store owner. This type has full set of permissions.
-
-
Understanding of access levels is the basis of the ACL work.
-
-
Access Control List (ACL)
-
-
ACL Overview
-
-
Every user has a specific role and purpose. To accomplish their goals, each user must be able to access certain resources and perform specific actions. Allowing users to access the resources without any limits can compromise Magento security.
-
-
The Access Control List (ACL) is a set of permissions (access rights) that particular users have for certain resources. When a user wants to perform a specific action with a resource (for example, update the customer information), Magento checks the permission for this combination of user, resource, and action. If the action is allowed, the user can proceed. Otherwise, the action is denied.
-
-
Understanding ACL
-
-
Access control lists include two main things: a subject and an object. Usually, the subject is the user who wants to use the resource. The object is the resource that a certain user wants to have access to. So, ACL is used to decide when the subject can have access to object.
-
-
You should remember that ACL is not the same as authentication. ACL is the next step after the authentication is passed successfully. These two concepts are closely connected but the difference lies in the following: authentication is understanding who the user is and ACL is understanding what the user can do.
-
-
-
-
ACL Structure
-
-
ACL is implemented in a tree structure. There is a tree of resources for each user type. Namely, Admin, Customer, and Guest have their own trees of resources.
-Each ACL entry specifies two instances: a subject and an action the subject can perform.
-
-
Example of the resource tree for the Admin role is as follows:
-
-
-
-
Read/Write Permissions
-
-
All REST resource attributes are divided into two categories: Read and Write. The Read category includes the operation of retrieving. So, when selecting the attributes in the Read category, you specify them for the resource retrieving. The Write category includes the operations of creating and updating. So, when selecting the attributes in the Write category, you specify them for the resource creation and updating. To illustrate the situation, let's take the following example:
-
REST roles in Magento are used to limit access to certain resources. Limiting access lies in configuration of a REST role and assigning a user to it. You can select which resources will be available for the user and which will not.
-
-
REST roles management consists in the role creation, editing, deleting, and user assignment. Note that REST role creation and deletion is available only for Admin role.
-
-
The REST Roles page initially includes two roles: Customer and Guest.
-
-
Only API Resources can be edited in the Guest and Customer roles. You cannot change the name or assigned users in these roles. Also, you cannot delete the Guest or Customer role. For example, when editing the Guest Role, the page looks as follows:
-
-
-
Viewing REST Roles
-
-
To view the list of REST roles, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens.
-
REST roles are displayed in a grid with the following columns: ID (role ID), Role Name, User Type, and Created At (date and time of the role creation).
-
-
-
-
-
Working with Admin Role
-
-
Adding a New REST Role for Admin
-
-
To add a new REST role for Admin, perform the following steps:
-
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens.
-
In the top right corner, click Add Admin Role. The Add New Role page opens.
-
There are two tabs in the Role Information panel on the left: Role Info and Role API Resources.
-
Select the Role Info tab and in the Role Information panel, enter the name for the role to be created in the corresponding Role Name field. This field is required.
-
In the Role API Resources tab, in the Resource Access drop-down list, select whether the user will have full or custom access by selecting the corresponding All or Custom options. If you select the Custom option, the Resources tree will appear where you will be able to check the required resources and actions.
-
Click Save Role in the top right corner to save the role.
-
After you saved the role, a new Role Users tab appears in the Role Information panel on the left. In this tab, you can manage users for the current role. Click Reset Filter to view all users to which the role can be assigned.
-
-
-
-
-
Editing an Existing Admin REST Role
-
-
To edit an existing Admin REST role, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens. In the roles grid, select the Admin role and click it.
-
The Edit Role <role name> page opens. You can edit the following information:
-
-
Role Info: Edit the name of the Admin role by selecting the Role Info tab to the left.
-
Role API Resources: Select or clear the resources available for this role.
-
Role Users: Assign or remove users for this role.
-
-
-
Click Save Role in the top right corner to apply changes.
-
-
-
-
-
Deleting an Existing Admin REST Role
-
-
To delete an existing Admin REST role, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens. In the roles grid, select the required Admin role to be deleted and click it.
-
The Edit Role <role name> page opens. In the top right corner, click Delete Role. The role is deleted.
-
-
-
-
-
Assigning a REST Role to Admin
-
-
To assign a REST role to admin, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Permissions > Users.
-
The Users page opens. In the users grid, select the user to which the REST Admin role will be assigned.
-
The Edit User <Name of the User> page opens. In the User Information panel, select the REST Role tab.
-
In the list of REST roles, select the Admin role to be assigned and select the option button next to it.
-
Click Save User in the top right corner to save changes.
-
-
-
-
Assigning Multiple Users to an Admin REST Role
-
-
To assign more than one user to an existing Admin REST role, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens. In the REST roles grid, select the Admin role to which users will be assigned.
-
The Edit Role <role name> page opens. In the Role Information panel, select the Role Users tab.
-
In the list of users, click Reset Filter to view the list of all users to which the role can be assigned. Select the checkboxes near the users to be assigned to the Admin role.
-
Click Save Role in the top right corner to save changes.
-
-
-
-
-
Viewing Users Assigned to an Admin REST Role
-
-
To view the list of users assigned to a REST role, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens. From the list of roles, select the Admin role whose assigned users you want to view and click it.
-
The Edit Role <role name> page opens. In the Role Information panel on the left, select the Role Users tab.
-
The list of REST role users is displayed in a grid with the following columns: ID, User Name, First Name, and Last Name.
-
-
-
-
-
-
Unassigning User from the Admin REST Role
-
-
To unassign the Admin REST role from a user, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens. From the list of roles, select the Admin role from which you want to unassign a user and click it.
-
The Edit Role <role name> page opens. In the Role Information panel on the left, select the Role Users tab.
-
Clear the checkbox next to the user which you want to unassign from the current REST role.
-
Click Save Role in the top right corner to apply the changes.
-
-
-
-
-
Working with Guest and Customer Roles
-
-
As it has been mentioned before, the Customer and Guest roles cannot be removed and can be only partially edited. You can edit only the resources and actions allowed for the user.
-
-
Editing the Guest REST Role
-
-
To edit the Guest REST role, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens. From the list of roles, select the Guest role and click it.
-
The Edit Role "Guest" page opens. In the Role Resources panel, edit the required information.
-
Click Save Role in the top right corner to apply changes.
-
-
-
-
Editing the Customer REST Role
-
-
To edit the Customer REST role, perform the following steps:
-
-
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
-
The REST Roles page opens. From the list of roles, select the Customer role and click it.
-
The Edit Role "Customer" page opens. In the Role Resources panel, edit the required information.
-
Click Save Role in the top right corner to apply changes.
If you make a Magento API call, you are guaranteed to receive some kind of a response. If you make a successful call, you will receive an HTTP response with a 200 OK status.
-
-
REST API Response Formats
-
-
You can view the response data from any Magento API call in one of the following two formats:
-
-
-
XML
-
JSON
-
-
-
-
The format of returned data is defined in the request header. The format you choose depends on what you are familiar with most or tools available to you.
-
-
-
XML Format
-
-
The XML response format is a simple XML block.
-To set the response format to XML, add the Accept request header with the text/xml value.
-
-
A successful call will return the following response (example of retrieving information about stock items):
JSON (JavaScript Object Notation) is a lightweight data-interchange format.
-To set the response format to JSON, add the Accept request header with the application/json value.
-
-
Response Structure
-
-
The JSON objects represent a direct mapping of the XML block from the XML response format.
The list of HTTP status codes that are returned in the API response is described in the Common HTTP Status Codes part of the documentation. There, you can find the list of codes themselves together with their description.
The following parameters must be provided in the Authorization header for the call:
-
-
oauth_signature_method
-
oauth_version
-
oauth_nonce
-
oauth_timestamp
-
oauth_consumer_key
-
oauth_token
-
oauth_signature
-
-
-
-
Testing
- REST resources with the REST Client plugin
- for the Mozilla Firefox browser.
-
-
-
Open the REST Client.
-
From the Authentication drop-down, select OAuth.
-
-
In the OAuth window, on the Signature for the request tab, fill in the following fields:
-
-
Consumer key: Enter the Key value provided when you created the consumer in Magento Admin Panel.
-
-
Consumer secret: Enter the Secret value provided when you created the consumer in Magento Admin
- Panel.
-
Access token: Enter the oauth_token value received when you authenticated the application.
-
Access token secret: Enter the oauth_token_secret value received when you authenticated the
- application.
-
-
-
On the OAuth setting tab, define the following options:
-
-
-
Signature Methods: From the drop-down list, select which method will be used for signatures (HMAC-SHA1
- or PLAINTEXT).
-
oAuth Version: From the drop-down list, select the 1.0 option (REST API supports OAuth 1.0a).
-
-
Leave the Realm, oAuth Nonce, and oAuth Timestamp values set by default.
-
-
-
Click Save and wait for the confirmation dialog to close.
-
Return to the Signature for the request tab and select Insert > Insert as header.
-
-
An authorization header is created on the main page of REST Client.
-
-
-
- NOTE: Click the header with authorization data and click Auto refresh in the opened pop-up in order to
- generate new values for oauth_nonce, oauth_timestamp, and oauth_signature at each request.
-
-
From the Headers drop-down, select Custom Header.
-
-
In the Request Header window, enter "Content-Type" in the Name field and "text/xml" in the
- Value field (if you want to use the XML data format). To use the JSON request data format, enter
- application/json instead of the text/xml value.
-
Click Okay.
-
-
-
-
-
-
-
Example: Retrieving the List of Products
-
-
-
From the Method drop-down list, select the GET option.
-
In the URL field, enter the following URL: http://magentohost/api/rest/products. You can limit the number
- of products returned in the response. To set the limit to 4, enter the following URL:
- http://magentohost/api/rest/products?limit=4
-
Click Send. Information about all products will be displayed in the response body. Example is as
- follows:
-
In the first field, start typing authorization. An Authorization popup appears. Click it.
-
-
When you click the fields next to the Authorization header, the Construct link appears. Click it to
- configure OAuth authentication.
-
The Authorization window opens. Select the OAuth tab.
-
-
In the Type group of options, select the Signed Request option.
-
In the signature method group of options, select which method will be used for signatures (HMAC-SHA1 or
- PLAINTEXT).
-
Fill in the following data:
-
-
-
Consumer key: Enter the Key value provided when you created the consumer in Magento Admin Panel.
-
-
Consumer secret: Enter the Secret value provided when you created the consumer in Magento Admin
- Panel.
-
Access Token: Enter the oauth_token value received when you authenticated the application.
-
Access Token Secret: Enter the oauth_token_secret value received when you authenticated the
- application.
-
-
-
Click OK.
- NOTE: Advanced REST Client does not save the Consumer secret and Access Token Secret values.
- You need to enter these values each time you make a request.
-
In the URL field, enter the URL to which the API call will be performed and select the required HTTP
- method.
-
In the Headers table, click Add row and add the Accept - application/json or Accept - text/xml
- header depending on which format you prefer for the returned data.
-
Click Send Request.
-
-
-
-
Example: Retrieving the list of customers
-
-
-
In the Method group of options, select the GET option.
-
In the URL field, enter the following URL: http://magentohost/api/rest/customers.
-
Click Send request. Information about all customers will be displayed in the response body. Note that only
- Admin type of the user can retrieve the list of customers. Example is as follows:
-
-
-
-
-
Example: Creating a customer address
-
-
-
In the Method group of options, select the POST option.
-
In the URL field, enter the following URL: http://magentohost/api/rest/customers/:id/addresses where the ":id"
- value is the customer ID in the system.
-
In the Body table, on the Raw input tab, enter the data required for customer address creation.
-
Click Send request. If the address is created, the 200 OK HTTP status code will be returned. Example is as
- follows:
-
-
\ No newline at end of file
diff --git a/guides/m1x/api/soap-api-index.html b/guides/m1x/api/soap-api-index.html
deleted file mode 100644
index 23feb66c82..0000000000
--- a/guides/m1x/api/soap-api-index.html
+++ /dev/null
@@ -1,211 +0,0 @@
----
-layout: m1x
-title: Magento 1.x SOAP API
----
-
-
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.assignProduct (SOAP V1)
-
catalogCategoryAssignProduct (SOAP V2)
-
-
-
-
Assign a product to the required category.
-
-
Aliases:
-
-
category.assignProduct
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
categoryId
-
ID of the category
-
-
-
string
-
product/productId
-
ID or SKU of the product to be assigned to the category
-
-
-
string
-
position
-
Position of the assigned product in the category (optional)
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' argument
-
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the product is assigned to the specified category
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.assignProduct', array('categoryId' => '4', 'product' => '1'));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryAssignProduct($sessionId, '4', '3');
-var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.assignedProducts (SOAP V1)
-
catalogCategoryAssignedProducts (SOAP V2)
-
-
-
-
Retrieve the list of products assigned to a required category.
-
-
Aliases:
-
-
category.assignedProducts
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
categoryId
-
ID of the required category
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogAssignedProduct
-
-
-
-
-
The catalogAssignedProduct content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
product_id
-
ID of the assigned product
-
-
-
string
-
type
-
Product type
-
-
-
int
-
set
-
Attribute set ID
-
-
-
string
-
sku
-
Product SKU
-
-
-
int
-
position
-
Position of the assigned product
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.assignedProducts', '4');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryAssignedProducts($sessionId, '4');
-var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.create (SOAP V1)
-
catalogCategoryCreate (SOAP V2)
-
-
-
-
Create a new category and return its ID.
-
-
Aliases:
-
-
category.create
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
parentId
-
Parent category ID
-
-
-
array
-
categoryData
-
Array of catalogCategoryEntityCreate
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
attribute_id
-
ID of the created category
-
-
-
-
-
The categoryData content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
name
-
Name of the created category
-
-
-
int
-
is_active
-
Defines whether the category will be visible in the frontend
-
-
-
int
-
position
-
Position of the created category (optional)
-
-
-
ArrayOfString
-
available_sort_by
-
All available options by which products in the category can be sorted
-
-
-
string
-
custom_design
-
The custom design for the category (optional)
-
-
-
int
-
custom_apply_to_products
-
Apply the custom design to all products assigned to the category (optional)
-
-
-
string
-
custom_design_from
-
Date starting from which the custom design will be applied to the category (optional)
-
-
-
string
-
custom_design_to
-
Date till which the custom design will be applied to the category (optional)
-
-
-
string
-
custom_layout_update
-
Custom layout update (optional)
-
-
-
string
-
default_sort_by
-
The default option by which products in the category are sorted
-
-
-
string
-
description
-
Category description (optional)
-
-
-
string
-
display_mode
-
Content that will be displayed on the category view page (optional)
-
-
-
int
-
is_anchor
-
Defines whether the category will be anchored (optional)
-
-
-
int
-
landing_page
-
Landing page (optional)
-
-
-
string
-
meta_description
-
Category meta description (optional)
-
-
-
string
-
meta_keywords
-
Category meta keywords (optional)
-
-
-
string
-
meta_title
-
Category meta title (optional)
-
-
-
string
-
page_layout
-
Type of page layout that the category should use (optional)
-
-
-
string
-
url_key
-
A relative URL path which can be entered in place of the standard target path (optional)
-
-
-
int
-
include_in_menu
-
Defines whether the category is visible on the top menu bar
-
-
-
string
-
filter_price_range
-
Price range of each price level displayed in the layered navigation block (optional)
-
-
-
int
-
custom_use_parent_settings
-
Defines whether the category will inherit custom design settings of the category to which it is assigned. 1 - Yes, 0 - No (optional)
-
-
-
-
-
Notes: The position parameter is deprecated, the category will be positioned anyway in the end of the list and you can not set the position directly. You should use the catalog_category.move method instead. You cannot also assign a root category to the specified store.
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-$result = $client->call($session, 'catalog_category.create', array(2, array(
- 'name' => 'Category name',
- 'is_active' => 1,
- 'position' => 1,
- //<!-- position parameter is deprecated, category anyway will be positioned in the end of list
- //and you can not set position directly, use catalog_category.move instead -->
- 'available_sort_by' => 'position',
- 'custom_design' => null,
- 'custom_apply_to_products' => null,
- 'custom_design_from' => null,
- 'custom_design_to' => null,
- 'custom_layout_update' => null,
- 'default_sort_by' => 'position',
- 'description' => 'Category description',
- 'display_mode' => null,
- 'is_anchor' => 0,
- 'landing_page' => null,
- 'meta_description' => 'Category meta description',
- 'meta_keywords' => 'Category meta keywords',
- 'meta_title' => 'Category meta title',
- 'page_layout' => 'two_columns_left',
- 'url_key' => 'url-key',
- 'include_in_menu' => 1,
-)));
-
-var_dump ($result);
-
-
-
-
-
Request Example SOAP V2
-
-
-
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-$result = $client->catalogCategoryCreate($session, 2, array(
- 'name' => 'Category name 2',
- 'is_active' => 1,
- 'position' => 1,
- //<!-- position parameter is deprecated, category anyway will be positioned in the end of list
- //and you can not set position directly, use catalog_category.move instead -->
- 'available_sort_by' => array('position'),
- 'custom_design' => null,
- 'custom_apply_to_products' => null,
- 'custom_design_from' => null,
- 'custom_design_to' => null,
- 'custom_layout_update' => null,
- 'default_sort_by' => 'position',
- 'description' => 'Category description',
- 'display_mode' => null,
- 'is_anchor' => 0,
- 'landing_page' => null,
- 'meta_description' => 'Category meta description',
- 'meta_keywords' => 'Category meta keywords',
- 'meta_title' => 'Category meta title',
- 'page_layout' => 'two_columns_left',
- 'url_key' => 'url-key',
- 'include_in_menu' => 1,
-));
-
-var_dump ($result);
-
-
diff --git a/guides/m1x/api/soap/catalog/catalogCategory/catalog_category.currentStore.html b/guides/m1x/api/soap/catalog/catalogCategory/catalog_category.currentStore.html
deleted file mode 100644
index 1b9ec70fd1..0000000000
--- a/guides/m1x/api/soap/catalog/catalogCategory/catalog_category.currentStore.html
+++ /dev/null
@@ -1,103 +0,0 @@
----
-layout: m1x_soap
-title: Current Store
----
-
-
-
Module: Mage_Catalog
-
-
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
catalog_category.currentStore (SOAP V1)
-
catalogCategoryCurrentStore (SOAP V2)
-
-
-
-
Allows you to set/get the current store view.
-
-
Aliases:
-
-
category.currentStore
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
storeView
-
Store view ID or code
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
storeView
-
Store view ID
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'category.currentStore', '1');
-var_dump ($result);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryCurrentStore($sessionId, '1');
-var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.delete (SOAP V1)
-
catalogCategoryDelete (SOAP V2)
-
-
-
-
Allows you to delete the required category.
-
-
Aliases:
-
-
category.delete
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
categoryId
-
ID of the category to be deleted
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the category is deleted
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.delete', '7');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryDelete($sessionId, '7');
-var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.info (SOAP V1)
-
catalogCategoryInfo (SOAP V2)
-
-
-
-
Allows you to retrieve information about the required category.
-
-
Aliases:
-
-
category.info
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
categoryId
-
Category ID
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
ArrayOfString
-
attributes
-
Array of attributes (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
info
-
Array of catalogCategoryInfo
-
-
-
-
-
The catalogCategoryInfo content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
category_id
-
Category ID
-
-
-
int
-
is_active
-
Defines whether the category is active
-
-
-
string
-
position
-
Category position
-
-
-
string
-
level
-
Category level
-
-
-
string
-
parent_id
-
Parent category ID
-
-
-
string
-
all_children
-
All child categories of the current category
-
-
-
string
-
children
-
Names of direct child categories
-
-
-
string
-
created_at
-
Date when the category was created
-
-
-
string
-
updated_at
-
Date when the category was updated
-
-
-
string
-
name
-
Category name
-
-
-
string
-
url_key
-
A relative URL path which can be entered in place of the standard target path (optional)
-
-
-
string
-
description
-
Category description
-
-
-
string
-
meta_title
-
Category meta title
-
-
-
string
-
meta_keywords
-
Category meta keywords
-
-
-
string
-
meta_description
-
Category meta description
-
-
-
string
-
path
-
Path
-
-
-
string
-
url_path
-
URL path
-
-
-
int
-
children_count
-
Number of child categories
-
-
-
string
-
display_mode
-
Content that will be displayed on the category view page (optional)
-
-
-
int
-
is_anchor
-
Defines whether the category is anchored
-
-
-
ArrayOfString
-
available_sort_by
-
All available options by which products in the category can be sorted
-
-
-
string
-
custom_design
-
The custom design for the category (optional)
-
-
-
string
-
custom_apply_to_products
-
Apply the custom design to all products assigned to the category (optional)
-
-
-
string
-
custom_design_from
-
Date starting from which the custom design will be applied to the category (optional)
-
-
-
string
-
custom_design_to
-
Date till which the custom design will be applied to the category (optional)
-
-
-
string
-
page_layout
-
Type of page layout that the category should use (optional)
-
-
-
string
-
custom_layout_update
-
Custom layout update (optional)
-
-
-
string
-
default_sort_by
-
The default option by which products in the category are sorted
-
-
-
int
-
landing_page
-
Landing page (optional)
-
-
-
int
-
include_in_menu
-
Defines whether the category is available on the Magento top menu bar
-
-
-
string
-
filter_price_range
-
Price range of each price level displayed in the layered navigation block
-
-
-
int
-
custom_use_parent_settings
-
Defines whether the category will inherit custom design settings of the category to which it is assigned. 1 - Yes, 0 - No
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.info', '5');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryInfo($sessionId, '5');
-var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
catalog_category.level (SOAP V1)
-
catalogCategoryLevel (SOAP V2)
-
-
-
-
Allows you to retrieve one level of categories by a website, a store view, or a parent category.
-
-
Aliases:
-
-
category.level
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
website
-
Website ID or code (optional)
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
string
-
parentCategory
-
Parent category ID (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
tree
-
Array of CatalogCategoryEntitiesNoChildren
-
-
-
-
-
The CatalogCategoryEntitityNoChildren content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
category_id
-
Category ID
-
-
-
int
-
parent_id
-
Parent category ID
-
-
-
string
-
name
-
Category name
-
-
-
int
-
is_active
-
Defines whether the category is active
-
-
-
int
-
position
-
Category position
-
-
-
int
-
level
-
Category level
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.level');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryLevel($sessionId);
-var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.move (SOAP V1)
-
catalogCategoryMove (SOAP V2)
-
-
-
-
Allows you to move the required category in the category tree.
-
-
Aliases:
-
-
category.move
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
categoryId
-
ID of the category to be moved
-
-
-
int
-
parentId
-
ID of the new parent category
-
-
-
string
-
afterId
-
ID of the category after which the required category will be moved (optional for V1 and V2)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
id
-
True if the category is moved
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.move', array('categoryId' => '4', 'parentId' => '3'));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryMove($sessionId, '4', '3');
-var_dump($result);
Note: Please make sure that you are not moving the category to any of its own children. There are no extra checks to prevent doing it through API, and you won’t be able to fix this from the admin interface later.
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.removeProduct (SOAP V1)
-
catalogCategoryRemoveProduct (SOAP V2)
-
-
-
-
Allows you to remove the product assignment from the category.
-
-
Aliases:
-
-
category.removeProduct
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
categoryId
-
Category ID
-
-
-
string
-
productId
-
ID or SKU of the product to be removed from the category
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the product is removed from the category
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.removeProduct', array('categoryId' => '4', 'product' => '3'));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryRemoveProduct($sessionId, '4', '3');
-var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.tree (SOAP V1)
-
catalogCategoryTree (SOAP V2)
-
-
-
-
Allows you to retrieve the hierarchical tree of categories.
-
-
Aliases:
-
-
category.tree
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
parentId
-
ID of the parent category (optional)
-
-
-
string
-
storeView
-
Store view (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
tree
-
Array of catalogCategoryTree
-
-
-
-
-
-
The catalogCategoryTree content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
category_id
-
Category ID
-
-
-
int
-
parent_id
-
Parent category ID
-
-
-
string
-
name
-
Category name
-
-
-
int
-
position
-
Category position
-
-
-
int
-
level
-
Category level
-
-
-
array
-
children
-
Array of CatalogCategoryEntities
-
-
-
-
-
The catalogCategoryEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
category_id
-
Category ID
-
-
-
int
-
parent_id
-
Parent category ID
-
-
-
string
-
name
-
Category name
-
-
-
int
-
is_active
-
defines whether the category is active
-
-
-
int
-
position
-
Category position
-
-
-
int
-
level
-
Category level
-
-
-
array
-
children
-
Array of CatalogCategoryEntities
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.tree');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryTree($sessionId);
-var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
-
-
Resource Name: catalog_category
-
-
Aliases:
-
-
category
-
-
-
-
Method:
-
-
-
catalog_category.updateProduct (SOAP V1)
-
catalogCategoryUpdateProduct (SOAP V2)
-
-
-
-
Allows you to update the product assigned to a category. The product position is updated.
-
-
Aliases:
-
-
category.updateProduct
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
categoryId
-
ID of the category to which the product is assigned
-
-
-
string
-
productId
-
ID or SKU of the product to be updated
-
-
-
string
-
position
-
Position of the product in the category (optional)
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the product is updated in the category
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category.updateProduct', array('categoryId' => '4', 'product' => '1', 'position' => '3'));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryUpdateProduct($sessionId, '4', '1', '3');
-var_dump($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category_attribute.currentStore', 'english');
-var_dump ($result);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryAttributeCurrentStore($sessionId, 'english');
-var_dump($result);
Allows you to retrieve the list of category attributes.
-
-
Aliases:
-
-
category_attribute.list
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogAttributeEntity
-
-
-
-
-
The catalogAttributeEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
attribute_id
-
Attribute ID
-
-
-
string
-
code
-
Attribute code
-
-
-
string
-
type
-
Attribute type
-
-
-
string
-
required
-
Defines whether the attribute is required
-
-
-
string
-
scope
-
Attribute scope: global, website, or store
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category_attribute.list',);
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryAttributeList($sessionId);
-var_dump($result);
The catalogAttributeOptionEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
label
-
Option label
-
-
-
string
-
value
-
Option value
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_category_attribute.options', '65');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogCategoryAttributeOptions($sessionId, '65');
-var_dump($result);
Allows you to create a new product and return ID of the created product.
-
-
Aliases:
-
-
product.create
-
-
-
Note:
-
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
type
-
Product type
-
-
-
string
-
set
-
ID of the product attribute set
-
-
-
string
-
sku
-
Product SKU
-
-
-
array
-
productData
-
Array of catalogProductCreateEntity
-
-
-
string
-
storeView
-
Store view ID or code
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
result
-
ID of the created product
-
-
-
-
-
The catalogProductCreateEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
ArrayOfString
-
categories
-
Array of categories
-
-
-
ArrayOfString
-
websites
-
Array of websites
-
-
-
string
-
name
-
Product name
-
-
-
string
-
description
-
Product description
-
-
-
string
-
short_description
-
Product short description
-
-
-
string
-
weight
-
Product weight
-
-
-
string
-
status
-
Product status
-
-
-
string
-
url_key
-
URL key
-
-
-
string
-
url_path
-
URL path
-
-
-
string
-
visibility
-
Product visibility on the frontend
-
-
-
ArrayOfString
-
category_ids
-
Array of category IDs
-
-
-
ArrayOfString
-
website_ids
-
Array of website IDs
-
-
-
string
-
has_options
-
Defines whether the product has options
-
-
-
string
-
gift_message_available
-
Defines whether the gift message is available for the product
-
-
-
string
-
price
-
Product price
-
-
-
string
-
special_price
-
Product special price
-
-
-
string
-
special_from_date
-
Date starting from which the special price will be applied to the product
-
-
-
string
-
special_to_date
-
Date till which the special price will be applied to the product
-
-
-
string
-
tax_class_id
-
Tax class ID
-
-
-
array
-
tier_price
-
Array of catalogProductTierPriceEntity
-
-
-
string
-
meta_title
-
Meta title
-
-
-
string
-
meta_keyword
-
Meta keyword
-
-
-
string
-
meta_description
-
Meta description
-
-
-
string
-
custom_design
-
Custom design
-
-
-
string
-
custom_layout_update
-
Custom layout update
-
-
-
string
-
options_container
-
Options container
-
-
-
array
-
additional_attributes
-
Array of catalogProductAdditionalAttributesEntity
-
-
-
array
-
stock_data
-
Array of catalogInventoryStockItemUpdateEntity
-
-
-
-
-
Notes: The "websites" and "website_ids" or "categories" and "category_ids" parameters are interchangeable. In other words, you can specify an array of website IDs (int) and then you don't need to specify the array of website codes (string) and vice versa.
-
-
The catalogProductTierPriceEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
customer_group_id
-
Customer group ID
-
-
-
string
-
website
-
Website
-
-
-
int
-
qty
-
Quantity
-
-
-
double
-
price
-
Tier price
-
-
-
-
-
The catalogInventoryStockItemUpdateEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
qty
-
Quantity of items
-
-
-
int
-
is_in_stock
-
Defines whether the item is in stock
-
-
-
int
-
manage_stock
-
Manage stock
-
-
-
int
-
use_config_manage_stock
-
Use config manage stock
-
-
-
int
-
min_qty
-
Minimum quantity for items to be in stock
-
-
-
int
-
use_config_min_qty
-
Use config settings flag (value defined in the Inventory System Configuration)
-
-
-
int
-
min_sale_qty
-
Minimum quantity allowed in the shopping cart
-
-
-
int
-
use_config_min_sale_qty
-
Use config settings flag
-
-
-
int
-
max_sale_qty
-
Maximum quantity allowed in the shopping cart
-
-
-
int
-
use_config_max_sale_qty
-
Use config settings flag
-
-
-
int
-
is_qty_decimal
-
Defines whether the quantity is decimal
-
-
-
int
-
backorders
-
Backorders status
-
-
-
int
-
use_config_backorders
-
Use config settings flag (for backorders)
-
-
-
int
-
notify_stock_qty
-
Stock quantity below which a notification will appear
-
-
-
int
-
use_config_notify_stock_qty
-
Use config settings flag (for stock quantity)
-
-
-
-
-
The catalogProductAdditionalAttributesEntity content is as follows:
-
-
-
-
-
Type
-
Name
-
-
-
associativeMultiArray
-
multi_data
-
-
-
associativeArray
-
single_data
-
-
-
-
-
Single Data: array of attributes with only single value
-Multi Data: array of attributes which could contain several values
-
-
Faults:
-
-
-
-
Fault Code
-
Fault Message
-
-
-
100
-
Requested store view not found.
-
-
-
102
-
Invalid data given. Details in error message.
-
-
-
104
-
Product type is not in allowed types.
-
-
-
105
-
Product attribute set is not existed
-
-
-
106
-
Product attribute set is not belong catalog product entity type
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-// get attribute set
-$attributeSets = $client->call($session, 'product_attribute_set.list');
-$attributeSet = current($attributeSets);
-
-
-$result = $client->call($session, 'catalog_product.create', array('simple', $attributeSet['set_id'], 'product_sku', array(
- 'categories' => array(2),
- 'websites' => array(1),
- 'name' => 'Product name',
- 'description' => 'Product description',
- 'short_description' => 'Product short description',
- 'weight' => '10',
- 'status' => '1',
- 'url_key' => 'product-url-key',
- 'url_path' => 'product-url-path',
- 'visibility' => '4',
- 'price' => '100',
- 'tax_class_id' => 1,
- 'meta_title' => 'Product meta title',
- 'meta_keyword' => 'Product meta keyword',
- 'meta_description' => 'Product meta description'
-)));
-
-var_dump ($result);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-// get attribute set
-$attributeSets = $client->catalogProductAttributeSetList($session);
-$attributeSet = current($attributeSets);
-
-$result = $client->catalogProductCreate($session, 'simple', $attributeSet->set_id, 'product_sku', array(
- 'categories' => array(2),
- 'websites' => array(1),
- 'name' => 'Product name',
- 'description' => 'Product description',
- 'short_description' => 'Product short description',
- 'weight' => '10',
- 'status' => '1',
- 'url_key' => 'product-url-key',
- 'url_path' => 'product-url-path',
- 'visibility' => '4',
- 'price' => '100',
- 'tax_class_id' => 1,
- 'meta_title' => 'Product meta title',
- 'meta_keyword' => 'Product meta keyword',
- 'meta_description' => 'Product meta description'
-));
-
-var_dump ($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product.currentStore', 'english');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductCurrentStore($sessionId, 'english');
-var_dump($result);
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean/int
-
result
-
True (1) if the product is deleted
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product.delete', '6');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductDelete($sessionId, '6');
-var_dump($result);
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductReturnEntity
-
-
-
-
-
The catalogProductReturnEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
special_price
-
Product special price
-
-
-
string
-
special_from_date
-
Date starting from which the special price is applied to the product
-
-
-
string
-
special_to_date
-
Date till which the special price is applied to the product
-
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product.getSpecialPrice', '1');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductGetSpecialPrice($sessionId, '1');
-var_dump($result);
Allows you to retrieve information about the required product.
-
-
Aliases:
-
-
product.info
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
productId
-
Product ID or SKU
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
array
-
attributes
-
Array of catalogProductRequestAttributes (optional)
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU value is passed in the "productId" parameter. (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
info
-
Array of catalogProductReturnEntity
-
-
-
-
-
The catalogProductRequestAttributes content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
ArrayOfString
-
attributes
-
Array of attributes
-
-
-
ArrayOfString
-
additional_attributes
-
Array of additional attributes
-
-
-
-
-
The catalogProductReturnEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
sku
-
Product SKU
-
-
-
string
-
set
-
Product set
-
-
-
string
-
type
-
Product type
-
-
-
ArrayOfString
-
categories
-
Array of categories
-
-
-
ArrayOfString
-
websites
-
Array of websites
-
-
-
string
-
created_at
-
Date when the product was created
-
-
-
string
-
updated_at
-
Date when the product was last updated
-
-
-
string
-
type_id
-
Type ID
-
-
-
string
-
name
-
Product name
-
-
-
string
-
description
-
Product description
-
-
-
string
-
short_description
-
Short description for a product
-
-
-
string
-
weight
-
Product weight
-
-
-
string
-
status
-
Status of a product
-
-
-
string
-
url_key
-
Relative URL path that can be entered in place of a target path
-
-
-
string
-
url_path
-
URL path
-
-
-
string
-
visibility
-
Product visibility on the frontend
-
-
-
ArrayOfString
-
category_ids
-
Array of category IDs
-
-
-
ArrayOfString
-
website_ids
-
Array of website IDs
-
-
-
string
-
has_options
-
Defines whether the product has options
-
-
-
string
-
gift_message_available
-
Defines whether the gift message is available for the product
-
-
-
string
-
price
-
Product price
-
-
-
string
-
special_price
-
Product special price
-
-
-
string
-
special_from_date
-
Date starting from which the special price is applied to the product
-
-
-
string
-
special_to_date
-
Date till which the special price is applied to the product
-
-
-
string
-
tax_class_id
-
Tax class ID
-
-
-
array
-
tier_price
-
Array of catalogProductTierPriceEntity
-
-
-
string
-
meta_title
-
Mate title
-
-
-
string
-
meta_keyword
-
Meta keyword
-
-
-
string
-
meta_description
-
Meta description
-
-
-
string
-
custom_design
-
Custom design
-
-
-
string
-
custom_layout_update
-
Custom layout update
-
-
-
string
-
options_container
-
Options container
-
-
-
associativeArray
-
additional_attributes
-
Array of additional attributes
-
-
-
string
-
enable_googlecheckout
-
Defines whether Google Checkout is applied to the product
-
-
-
-
-
The catalogProductTierPriceEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
customer_group_id
-
ID of the customer group
-
-
-
string
-
website
-
Website
-
-
-
int
-
qty
-
Quantity to which the price will be applied
-
-
-
double
-
price
-
Price that each item will cost
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product.info', '4');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductInfo($sessionId, '4');
-var_dump($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product.list');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2 (List of All Products)
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductList($sessionId);
-var_dump($result);
-
-
-
-
-
Request Example SOAP V2 (Complex Filter)
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-$complexFilter = array(
- 'complex_filter' => array(
- array(
- 'key' => 'type',
- 'value' => array('key' => 'in', 'value' => 'simple,configurable')
- )
- )
-);
-$result = $client->catalogProductList($session, $complexFilter);
-
-var_dump ($result);
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
productId
-
Product ID or SKU
-
-
-
string
-
specialPrice
-
Product special price
-
-
-
string
-
fromDate
-
Date starting from which special price will be applied
-
-
-
string
-
toDate
-
Date till which special price will be applied
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
string
-
productIdentifierType
-
Defines whether the product ID or SKU is passed in the 'productId' parameter (optional)
-
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean/int
-
result
-
True (1) if the special price is set for the product
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product.setSpecialPrice', array('product' => 'testproduct', 'specialPrice' => '77.5', 'fromDate' => '2012-03-29 12:30:51', 'toDate' => '2012-04-29 12:30:51'));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductSetSpecialPrice($sessionId, '2', '77.5', '2012-03-29 12:30:51', '2012-04-29 12:30:51');
-var_dump($result);
Allows you to update the required product. Note that you should specify only those parameters which you want to be updated.
-
-
Aliases:
-
-
product.update
-
-
-
Note:
-
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
product\productId
-
Product ID
-
-
-
array
-
productData
-
Array of catalogProductCreateEntity
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the product is updated
-
-
-
-
-
The catalogProductCreateEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
ArrayOfString
-
categories
-
Array of categories
-
-
-
ArrayOfString
-
websites
-
Array of websites
-
-
-
string
-
name
-
Product name
-
-
-
string
-
description
-
Product description
-
-
-
string
-
short_description
-
Product short description
-
-
-
string
-
weight
-
Product weight
-
-
-
string
-
status
-
Product status
-
-
-
string
-
url_key
-
A relative URL path that can be entered in place of the target path
-
-
-
string
-
url_path
-
URL path
-
-
-
string
-
visibility
-
Product visibility on the frontend
-
-
-
ArrayOfString
-
category_ids
-
Array of category IDs
-
-
-
ArrayOfString
-
website_ids
-
Array of website IDs
-
-
-
string
-
has_options
-
Defines whether the product has options
-
-
-
string
-
gift_message_available
-
Defines whether the gift message is available for the product
-
-
-
string
-
price
-
Product price
-
-
-
string
-
special_price
-
Product special price
-
-
-
string
-
special_from_date
-
Date starting from which the special price will be applied to the product
-
-
-
string
-
special_to_date
-
Date till which the special price will be applied to the product
-
-
-
string
-
tax_class_id
-
Tax class ID
-
-
-
array
-
tier_price
-
Array of catalogProductTierPriceEntity
-
-
-
string
-
meta_title
-
Meta title
-
-
-
string
-
meta_keyword
-
Meta keyword
-
-
-
string
-
meta_description
-
Meta description
-
-
-
string
-
custom_design
-
Custom design
-
-
-
string
-
custom_layout_update
-
Custom layout update
-
-
-
string
-
options_container
-
Options container
-
-
-
associativeArray
-
additional_attributes
-
Array of catalogProductAdditionalAttributesEntity
-
-
-
array
-
stock_data
-
Array of catalogInventoryStockItemUpdateEntity
-
-
-
-
-
Notes: The "websites" and "website_ids" or "categories" and "category_ids" parameters are interchangeable. In other words, you can specify an array of website IDs (int) and then you don't need to specify the array of website codes (string) and vice versa.
-
-
The catalogProductTierPriceEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
customer_group_id
-
Customer group ID
-
-
-
string
-
website
-
Website
-
-
-
int
-
qty
-
Quantity of items to which the price will be applied
-
-
-
double
-
price
-
Price that each item will cost
-
-
-
-
-
The catalogInventoryStockItemUpdateEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
qty
-
Quantity of items
-
-
-
int
-
is_in_stock
-
Defines whether the item is in stock
-
-
-
int
-
manage_stock
-
Manage stock
-
-
-
int
-
use_config_manage_stock
-
Use config manage stock
-
-
-
int
-
min_qty
-
Minimum quantity for items to be in stock
-
-
-
int
-
use_config_min_qty
-
Use config settings flag (value defined in the Inventory System Configuration)
-
-
-
int
-
min_sale_qty
-
Minimum quantity allowed in the shopping cart
-
-
-
int
-
use_config_min_sale_qty
-
Use config settings flag
-
-
-
int
-
max_sale_qty
-
Maximum quantity allowed in the shopping cart
-
-
-
int
-
use_config_max_sale_qty
-
Use config settings flag
-
-
-
int
-
is_qty_decimal
-
Defines whether the quantity is decimal
-
-
-
int
-
backorders
-
Backorders status
-
-
-
int
-
use_config_backorders
-
Use config settings flag (for backorders)
-
-
-
int
-
notify_stock_qty
-
Stock quantity below which a notification will appear
-
-
-
int
-
use_config_notify_stock_qty
-
Use config settings flag (for stock quantity)
-
-
-
-
-
The catalogProductAdditionalAttributesEntity content is as follows:
-
-
-
-
-
Type
-
Name
-
-
-
associativeMultiArray
-
multi_data
-
-
-
associativeArray
-
single_data
-
-
-
-
-
Single Data: array of attributes with only single value
-Multi Data: array of attributes which could contain several values
-
-
Faults:
-
-
-
-
Fault Code
-
Fault Message
-
-
-
100
-
Requested store view not found.
-
-
-
101
-
Product not exists.
-
-
-
102
-
Invalid data given. Details in error message.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-$result = $client->call($session, 'catalog_product.update', array('product_sku', array(
- 'categories' => array(2),
- 'websites' => array(1),
- 'name' => 'Product name new 2',
- 'description' => 'Product description',
- 'short_description' => 'Product short description',
- 'weight' => '10',
- 'status' => '1',
- 'url_key' => 'product-url-key',
- 'url_path' => 'product-url-path',
- 'visibility' => '4',
- 'price' => '100',
- 'tax_class_id' => 1,
- 'meta_title' => 'Product meta title',
- 'meta_keyword' => 'Product meta keyword',
- 'meta_description' => 'Product meta description'
-)));
-
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-$result = $client->catalogProductUpdate($session, 'product_sku', array(
- 'categories' => array(2),
- 'websites' => array(1),
- 'name' => 'Product name new',
- 'description' => 'Product description',
- 'short_description' => 'Product short description',
- 'weight' => '10',
- 'status' => '1',
- 'url_key' => 'product-url-key',
- 'url_path' => 'product-url-path',
- 'visibility' => '4',
- 'price' => '100',
- 'tax_class_id' => 1,
- 'meta_title' => 'Product meta title',
- 'meta_keyword' => 'Product meta keyword',
- 'meta_description' => 'Product meta description'
-));
-
-var_dump ($result);
The catalogProductAttributeEntityToCreate content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
attribute_code
-
Attribute code
-
-
-
string
-
frontend_input
-
Attribute type
-
-
-
string
-
scope
-
Attribute scope. Possible values are as follows: 'store', 'website', or 'global'
-
-
-
string
-
default_value
-
Attribute default value
-
-
-
int
-
is_unique
-
Defines whether the attribute is unique
-
-
-
int
-
is_required
-
Defines whether the attribute is required
-
-
-
ArrayOfString
-
apply_to
-
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
-
-
-
int
-
is_configurable
-
Defines whether the attribute can be used for configurable products
-
-
-
int
-
is_searchable
-
Defines whether the attribute can be used in Quick Search
-
-
-
int
-
is_visible_in_advanced_search
-
Defines whether the attribute can be used in Advanced Search
-
-
-
int
-
is_comparable
-
Defines whether the attribute can be compared on the frontend
-
-
-
int
-
is_used_for_promo_rules
-
Defines whether the attribute can be used for promo rules
-
-
-
int
-
is_visible_on_front
-
Defines whether the attribute is visible on the frontend
-
-
-
int
-
used_in_product_listing
-
Defines whether the attribute can be used in product listing
-
-
-
associativeArray
-
additional_fields
-
Array of additional fields
-
-
-
array
-
frontend_label
-
Array of catalogProductAttributeFrontendLabel
-
-
-
-
-
The catalogProductAttributeFrontendLabelEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
store_id
-
Store ID
-
-
-
string
-
label
-
Text label
-
-
-
-
Notes: The "label" value for the "store_id" value set to 0 must be specified. An attribute cannot be created without specifying the label for store_id=0.
-
-
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
frontend_class
-
Input Validation for Store Owner. Possible values are as follows: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
-
-
-
boolean
-
is_html_allowed_on_front
-
Defines whether the HTML tags are allowed on the frontend
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_wysiwyg_enabled
-
Enable WYSIWYG flag
-
-
-
boolean
-
is_html_allowed_on_front
-
Defines whether the HTML tags are allowed on the frontend
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_filterable
-
Defines whether it is used in layered navigation
-
-
-
boolean
-
is_filterable_in_search
-
Defines whether it is used in search results layered navigation
-
-
-
int
-
position
-
Position
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_filterable
-
Defines whether it is used in layered navigation
-
-
-
boolean
-
is_filterable_in_search
-
Defines whether it is used in search results layered navigation
-
-
-
int
-
position
-
Position
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
Faults:
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
102
-
Invalid request parameters.
-
-
-
103
-
Attribute code is invalid. Please use only letters (a-z), numbers (0-9) or underscore (_) in this field, first character should be a letter.
-
-
-Create the Magento file system owner
diff --git a/guides/m1x/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html b/guides/m1x/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html
deleted file mode 100644
index 7fad6e9e92..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html
+++ /dev/null
@@ -1,99 +0,0 @@
----
-layout: m1x_soap
-title: Current Store
----
-
-
Module: Mage_Catalog
-
-
Resource: catalog_product_attribute
-
-
Aliases:
-
-
product_attribute
-
-
-
-
Method:
-
-
catalog_product_attribute.currentStore (SOAP V1)
-
catalogProductAttributeCurrentStore (SOAP V2)
-
-
-
-
Allows you to set/get the current store view.
-
-
Aliases:
-
-
product_attribute.currentStore
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
storeView
-
Store view ID
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_attribute.currentStore', 'english');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeCurrentStore($sessionId, 'english');
-var_dump($result);
-
-
-
-
-Create the Magento file system owner
diff --git a/guides/m1x/api/soap/catalog/catalogProductAttribute/product_attribute.info.html b/guides/m1x/api/soap/catalog/catalogProductAttribute/product_attribute.info.html
deleted file mode 100644
index 0b75b0350c..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductAttribute/product_attribute.info.html
+++ /dev/null
@@ -1,410 +0,0 @@
----
-layout: m1x_soap
-title: Attribute Info
----
-
-
-
Module: Product Attributes API
-
-
Resource: product_attribute
-
-
-
Method:
-
-
product_attribute.info (SOAP V1)
-
catalogProductAttributeInfo (SOAP V2)
-
-
-
-
Allows you to get full information about a required attribute with the list of options.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
attribute
-
Attribute code or ID
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductAttributeEntity
-
-
-
-
-
The catalogProductAttributeEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
attribute_id
-
Attribute ID
-
-
-
string
-
attribute_code
-
Attribute code
-
-
-
string
-
frontend_input
-
Attribute type
-
-
-
string
-
scope
-
Attribute scope
-
-
-
string
-
default_value
-
Attribute default value
-
-
-
int
-
is_unique
-
Defines whether the attribute is unique
-
-
-
int
-
is_required
-
Defines whether the attribute is required
-
-
-
ArrayOfString
-
apply_to
-
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
-
-
-
int
-
is_configurable
-
Defines whether the attribute can be used for configurable products
-
-
-
int
-
is_searchable
-
Defines whether the attribute can be used in Quick Search
-
-
-
int
-
is_visible_in_advanced_search
-
Defines whether the attribute can be used in Advanced Search
-
-
-
int
-
is_comparable
-
Defines whether the attribute can be compared on the frontend
-
-
-
int
-
is_used_for_promo_rules
-
Defines whether the attribute can be used for promo rules
-
-
-
int
-
is_visible_on_front
-
Defines whether the attribute is visible on the frontend
-
-
-
int
-
used_in_product_listing
-
Defines whether the attribute can be used in product listing
-
-
-
associativeArray
-
additional_fields
-
Array of additional fields
-
-
-
array
-
options
-
Array of catalogAttributeOptionEntity
-
-
-
array
-
frontend_label
-
Array of catalogProductAttributeFrontendLabel
-
-
-
-
-
The catalogAttributeOptionEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
label
-
Text label
-
-
-
string
-
value
-
Option ID
-
-
-
-
-
The catalogProductAttributeFrontendLabelEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
store_id
-
Store ID
-
-
-
string
-
label
-
Text label
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
frontend_class
-
Input Validation for Store Owner. Possible values: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
-
-
-
boolean
-
is_html_allowed_on_front
-
Defines whether the HTML tags are allowed on the frontend
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_wysiwyg_enabled
-
Enable WYSIWYG flag
-
-
-
boolean
-
is_html_allowed_on_front
-
Defines whether the HTML tags are allowed on the frontend
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_filterable
-
Defines whether it used in layered navigation
-
-
-
boolean
-
is_filterable_in_search
-
Defines whether it is used in search results layered navigation
-
-
-
int
-
position
-
Position
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_filterable
-
Defines whether it used in layered navigation
-
-
-
boolean
-
is_filterable_in_search
-
Defines whether it is used in search results layered navigation
-
-
-
int
-
position
-
Position
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
Faults:
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
101
-
Requested attribute not found.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'product_attribute.info', '11');
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeInfo($sessionId, '11');
-var_dump($result);
The catalogProductAttributeEntityToUpdate content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
scope
-
Attribute scope. Possible values are as follows: 'store', 'website', or 'global'
-
-
-
string
-
default_value
-
Attribute default value
-
-
-
int
-
is_unique
-
Defines whether the attribute is unique
-
-
-
int
-
is_required
-
Defines whether the attribute is required
-
-
-
ArrayOfString
-
apply_to
-
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
-
-
-
int
-
is_configurable
-
Defines whether the attribute can be used for configurable products
-
-
-
int
-
is_searchable
-
Defines whether the attribute can be used in Quick Search
-
-
-
int
-
is_visible_in_advanced_search
-
Defines whether the attribute can be used in Advanced Search
-
-
-
int
-
is_comparable
-
Defines whether the attribute can be compared on the frontend
-
-
-
int
-
is_used_for_promo_rules
-
Defines whether the attribute can be used for promo rules
-
-
-
int
-
is_visible_on_front
-
Defines whether the attribute can be visible on the frontend
-
-
-
int
-
used_in_product_listing
-
Defines whether the attribute can be used in product listing
-
-
-
associativeArray
-
additional_fields
-
Array of additional fields
-
-
-
array
-
frontend_label
-
Array of catalogProductAttributeFrontendLabel
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
frontend_class
-
Input Validation for Store Owner. Possible values: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
-
-
-
boolean
-
is_html_allowed_on_front
-
Defines whether the HTML tags are allowed on the frontend
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_wysiwyg_enabled
-
Enable WYSIWYG flag
-
-
-
boolean
-
is_html_allowed_on_front
-
Defines whether the HTML tags are allowed on the frontend
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_filterable
-
Defines whether it used in layered navigation
-
-
-
boolean
-
is_filterable_in_search
-
Defines whether it is used in search results layered navigation
-
-
-
integer
-
position
-
Position
-
-
-
-
-
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
is_filterable
-
Defines whether it used in layered navigation
-
-
-
boolean
-
is_filterable_in_search
-
Defines whether it is used in search results layered navigation
-
-
-
integer
-
position
-
Position
-
-
-
boolean
-
used_for_sort_by
-
Defines whether it is used for sorting in product listing
-
-
-
-
-
The catalogProductAttributeFrontendLabel content is as follows:
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_attribute_media.currentStore', 'english');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeMediaCurrentStore($sessionId, 'english');
-var_dump($result);
-
-
-
-
-Create the Magento file system owner
diff --git a/guides/m1x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html b/guides/m1x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html
deleted file mode 100644
index c7bcebf980..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html
+++ /dev/null
@@ -1,197 +0,0 @@
----
-layout: m1x_soap
-title: Media Info
----
-
-
Module: Mage_Catalog
-
-
-
Resource:catalog_product_attribute_media
-
-
Aliases:
-
-
product_attribute_media
-
product_media
-
-
-
-
Method:
-
-
-
catalog_product_attribute_media.info (SOAP V1)
-
catalogProductAttributeMediaInfo (SOAP V2)
-
-
-
-
Allows you to retrieve information about the specified product image.
-
-
Aliases:
-
-
product_attribute_media.info
-
product_media.info
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
product\productId
-
Product ID or SKU
-
-
-
string
-
file
-
Name of the image file (e.g., /b/l/blackberry8100_2.jpg)
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductImageEntity
-
-
-
-
-
-
The catalogProductImageEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
file
-
Image file name
-
-
-
string
-
label
-
Image file label
-
-
-
string
-
position
-
Image file position
-
-
-
string
-
exclude
-
Defines whether the image will associate only to one of three image types
-
-
-
string
-
url
-
Image URL
-
-
-
ArrayOfString
-
types
-
Array of types
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_attribute_media.info', array('product' => '2', 'file' => '/b/l/blackberry8100_2.jpg'));
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeMediaInfo($sessionId, '2', '/b/l/blackberry8100_2.jpg');
-var_dump($result);
-
-
diff --git a/guides/m1x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html b/guides/m1x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html
deleted file mode 100644
index 26ed09b4b0..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html
+++ /dev/null
@@ -1,194 +0,0 @@
----
-layout: m1x_soap
-title: Media List
----
-
-
Module: Mage_Catalog
-
-
-
Resource:catalog_product_attribute_media
-
-
Aliases:
-
-
product_attribute_media
-
product_media
-
-
-
-
Method:
-
-
-
catalog_product_attribute_media.list (SOAP V1)
-
catalogProductAttributeMediaList (SOAP V2)
-
-
-
-
Allows you to retrieve the list of product images.
-
-
Aliases:
-
-
product_attribute_media.list
-
product_media.list
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
product\productId
-
Product ID or SKU
-
-
-
string
-
storeView
-
Store view ID or code (optional)
-
-
-
string
-
identifierType
-
Defines whether the product ID or sku is passed in the 'product' parameter
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductImageEntity
-
-
-
-
-
The catalogProductImageEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
file
-
Image file name
-
-
-
string
-
label
-
Image label
-
-
-
string
-
position
-
Image position
-
-
-
string
-
exclude
-
Defines whether the image will associate only to one of three image types
-
-
-
string
-
url
-
Image URL
-
-
-
ArrayOfString
-
types
-
Array of types
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_attribute_media.list', '2');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeMediaList($sessionId, '2');
-var_dump($result);
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean\int
-
True (1) if the image is removed from a product
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_attribute_media.remove', array('product' => '3', 'file' => '/b/l/blackberry8100_2.jpg'));
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeMediaRemove($sessionId, '3', '/b/l/blackberry8100_2.jpg');
-var_dump($result);
Allows you to retrieve product image types including standard image, small_image, thumbnail, etc. Note that if the product attribute set contains attributes of the Media Image type (Catalog Input Type for Store Owner > Media Image), it will also be returned in the response.
-
-
Aliases:
-
-
product_attribute_media.types
-
product_media.types
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
setId
-
ID of the product attribute set
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductAttributeMediaTypeEntity
-
-
-
-
-
The catalogProductAttributeMediaTypeEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
code
-
Image type code
-
-
-
string
-
scope
-
Image scope (store, website, or global)
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_attribute_media.types', '4');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeMediaTypes($sessionId, '4');
-var_dump($result);
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
Notes: You should specify only those parameters which you want to be updated. Parameters that were not specified in the request, will preserve the previous values.
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
boolean
-
result
-
Result of product image updating
-
-
-
-
-
The catalogProductAttributeMediaCreateEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
file
-
Array of catalogProductImageFileEntity
-
-
-
string
-
label
-
Product image label
-
-
-
string
-
position
-
Product image position
-
-
-
ArrayOfString
-
types
-
Array of types
-
-
-
string
-
exclude
-
Defines whether the image will associate only to one of three image types
-
-
-
string
-
remove
-
Image remove flag
-
-
-
-
-
The catalogProductImageFileEntity content is as follows:
Allows you to add a new group for attributes to the attribute set.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
attributeSetId
-
Attribute set ID
-
-
-
string
-
groupName
-
Group name
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
result
-
ID of the created group
-
-
-
-
-
Faults:
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
112
-
Requested group exist already in requested attribute set.
-
-
-
113
-
Error while adding group to attribute set. Details in error message.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'product_attribute_set.groupAdd', array('attributeSetId' => '9', 'groupName' => 'new_group'));
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeSetGroupAdd($sessionId, '9', 'new_group');
-var_dump($result);
-
-
diff --git a/guides/m1x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html b/guides/m1x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html
deleted file mode 100644
index 906022652f..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html
+++ /dev/null
@@ -1,155 +0,0 @@
----
-layout: m1x_soap
-title: Attribute Set List
----
-
-
Module:Mage_Catalog
-
-
-
Resource:catalog_product_attribute_set
-
-
Aliases:
-
-
product_attribute_set
-
-
-
-
Method:
-
-
-
catalog_product_attribute_set.list (SOAP V1)
-
catalogProductAttributeSetList (SOAP V2)
-
-
-
-
Allows you to retrieve the list of product attribute sets.
-
-
Aliases:
-
-
product_attribute_set.list
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductAttributeSetEntity
-
-
-
-
-
The catalogProductAttributeSetEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
set_id
-
ID of the attribute set
-
-
-
string
-
name
-
Attribute set name
-
-
-
-
-
Faults:
-
-
No faults.
-
-
Examples
-
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_attribute_set.list');
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductAttributeSetList($sessionId);
-var_dump($result);
Allows you to retrieve full information about the custom option in a product.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
optionId
-
Option ID
-
-
-
string
-
store
-
Store view ID or code (optional)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductCustomOptionInfoEntity
-
-
-
-
-
The catalogProductCustomOptionInfoEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
title
-
Custom option title
-
-
-
string
-
type
-
Custom option type. Can have one of the following values: "fixed" or "percent"
-
-
-
string
-
sort_order
-
Custom option sort order
-
-
-
int
-
is_require
-
Defines whether the custom option is required
-
-
-
array
-
additional_fields
-
Array of catalogProductCustomOptionAdditionalFields
-
-
-
-
-
The catalogProductCustomOptionAdditionalFields content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
title
-
Custom option title
-
-
-
string
-
price
-
Custom option price
-
-
-
string
-
price_type
-
Price type. Possible values are as follows: "fixed" or "percent"
-
-
-
string
-
sku
-
Custom option SKU
-
-
-
string
-
max_characters
-
Maximum number of characters for the customer input on the frontend (optional)
-
-
-
string
-
sort_order
-
Custom option sort order
-
-
-
string
-
file_extension
-
List of file extensions allowed to upload by the user on the frontend (optional; for the File input type)
-
-
-
string
-
image_size_x
-
Width limit for uploaded images (optional; for the File input type)
-
-
-
string
-
image_size_y
-
Height limit for uploaded images (optional; for the File input type)
-
-
-
string
-
value_id
-
Value ID
-
-
-
-
-
Faults:
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
101
-
Product with requested id does not exist.
-
-
-
104
-
Store with requested code/id does not exist.
-
-
-
105
-
Option with requested id does not exist.
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'product_custom_option.info', '1');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductCustomOptionInfo($sessionId, '1');
-var_dump($result);
Allows you to retrieve the list of custom options for a specific product.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
productId
-
Product ID
-
-
-
string
-
store
-
Store view ID or code (optional but required for WS-I mode)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductCustomOptionList
-
-
-
-
-
The catalogProductCustomOptionList content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
option_id
-
Custom option ID
-
-
-
string
-
title
-
Custom option title
-
-
-
string
-
type
-
Custom option type
-
-
-
string
-
sort_order
-
Custom option sort order
-
-
-
int
-
is_require
-
Defines whether the custom option is required
-
-
-
-
Faults:
-
-
-
-
Fault Code
-
Fault Message
-
-
-
101
-
Product with requested id does not exist.
-
-
-
104
-
Store with requested code/id does not exist.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'product_custom_option.list', '1');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductCustomOptionList($sessionId, '1');
-var_dump($result);
Allows you to retrieve the list of available custom option types.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductCustomOptionTypes
-
-
-
-
-
The catalogProductCustomOptionTypesEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
label
-
Custom option label
-
-
-
string
-
value
-
Custom option value
-
-
-
-
Faults:
-
-
No faults
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'product_custom_option.types');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductCustomOptionTypes($sessionId);
-var_dump($result);
Error while adding an option value. Details are in the error message.
-
-
-
103
-
Option with requested id does not exist.
-
-
-
104
-
Invalid option type.
-
-
-
105
-
Store with requested code/id does not exist.
-
-
-
106
-
Can not delete option.
-
-
-
107
-
Error while updating an option value. Details are in the error message.
-
-
-
108
-
Title field is required.
-
-
-
109
-
Option should have at least one value. Can not delete last value.
-
-
-
-
-
-Create the Magento file system owner
diff --git a/guides/m1x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html b/guides/m1x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html
deleted file mode 100644
index fcab8f1ab8..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html
+++ /dev/null
@@ -1,198 +0,0 @@
----
-layout: m1x_soap
-title: Product Custom Value Add
----
-
-
Module: Complex Product API
-
-
-
Resource: product_custom_option_value
-
-
-
Method:
-
-
-
product_custom_option_value.add (SOAP V1)
-
catalogProductCustomOptionValueAdd (SOAP V2)
-
-
-
-
Allows you to add a new custom option value to a custom option. Note that the custom option value can be added only to the option with the Select Input Type.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
optionId
-
Option ID
-
-
-
array
-
data
-
Array of catalogProductCustomOptionValueAdd
-
-
-
string
-
store
-
Store view ID or code (optional)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the custom option value is added
-
-
-
-
-
The catalogProductCustomOptionValueAdd content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
title
-
Custom option value title
-
-
-
string
-
price
-
Custom option value price
-
-
-
string
-
price_type
-
Type of the custom option value price. Can have one of the following values: "fixed" or "percent"
-
-
-
string
-
sku
-
Custom option value row SKU
-
-
-
string
-
sort_order
-
Custom option value sort order
-
-
-
-
-
Faults:
-
-
-
-
Fault Code
-
Fault Message
-
-
-
101
-
Option value with requested id does not exist.
-
-
-
102
-
Error while adding an option value. Details are in the error message.
Allows you to retrieve full information about the specified product custom option value.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
valueId
-
Value ID
-
-
-
string
-
store
-
Store view ID or code (optional)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductCustomOptionValueInfoEntity
-
-
-
-
-
The catalogProductCustomOptionValueInfoEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
value_id
-
Option value ID
-
-
-
string
-
option_id
-
Option ID
-
-
-
string
-
sku
-
Custom option value row SKU
-
-
-
string
-
sort_order
-
Option value sort order
-
-
-
string
-
default_price
-
Option value default price
-
-
-
string
-
default_price_type
-
Default price type. Possible values are as follows: "fixed" or "percent"
-
-
-
string
-
store_price
-
Option value store price
-
-
-
string
-
store_price_type
-
Store price type. Possible values are as follows: "fixed" or "percent"
-
-
-
string
-
price
-
Option value price
-
-
-
string
-
price_type
-
Price type. Possible values are as follows: "fixed" or "percent"
-
-
-
string
-
default_title
-
Option value default title
-
-
-
string
-
store_title
-
Option value store title
-
-
-
string
-
title
-
Option value title
-
-
-
-
-
Faults:
-
-
-
-
Fault Code
-
Fault Message
-
-
-
101
-
Option value with requested id does not exist.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'product_custom_option_value.info', '5');
-var_dump($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductCustomOptionValueInfo($sessionId, '5');
-var_dump($result);
Allows you to retrieve the list of product custom option values. Note that the method is available only for the option Select Input Type.
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
optionId
-
Option ID
-
-
-
string
-
store
-
Store view ID or code (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductCustomOptionValueList
-
-
-
-
-
The catalogProductCustomOptionValueListEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
value_id
-
Custom option value ID
-
-
-
string
-
title
-
Custom option value title
-
-
-
string
-
price
-
Option value price
-
-
-
string
-
price_type
-
Price type. Possible values: "fixed" or "percent"
-
-
-
string
-
sku
-
Custom option value SKU
-
-
-
string
-
sort_order
-
Option value sort order (optional)
-
-
-
-
-
Faults:
-
-
-
-
Fault Code
-
Fault Message
-
-
-
101
-
Provided data is invalid.
-
-
-
102
-
Error while adding an option value. Details are in the error message.
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'product_custom_option_value.list', '3');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductCustomOptionValueList($sessionId, '3');
-var_dump($result);
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
-$sessionId = $proxy->login('apiUser', 'apiKey');
-
-// Get list of related products
-var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
-
-// Assign related product
-$proxy->call($sessionId, 'product_link.assign', array('related', 'Sku', 'Sku2', array('position'=>0, 'qty'=>56)));
-
-var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
-
-// Update related product
-$proxy->call($sessionId, 'product_link.update', array('related', 'Sku', 'Sku2', array('position'=>2)));
-
-var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
-
-// Remove related product
-$proxy->call($sessionId, 'product_link.remove', array('related', 'Sku', 'Sku2'));
-
-var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
-
-
-
-
-Create the Magento file system owner
diff --git a/guides/m1x/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html b/guides/m1x/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html
deleted file mode 100644
index 9632da851d..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html
+++ /dev/null
@@ -1,176 +0,0 @@
----
-layout: m1x_soap
-title: Product Link Assign
----
-
-
Module: Mage_Catalog
-
-
-
Resource: catalog_product_link
-
-
Aliases:
-
-
product_link
-
-
-
-
Method:
-
-
-
catalog_product_link.assign (SOAP V1)
-
catalogProductLinkAssign (SOAP V2)
-
-
-
-
Allows you to assign a product link (cross_sell, grouped, related, or up_sell) to another product.
-
-
Aliases:
-
-
product_link.assign
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
type
-
Type of the link (cross_sell, grouped, related, or up_sell)
-
-
-
string
-
product\productId
-
Product ID or SKU
-
-
-
string
-
linkedProduct\linkedProductId
-
Product ID or SKU for the link
-
-
-
array
-
data
-
Array of catalogProductLinkEntity
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the link is assigned to the product
-
-
-
-
-
The catalogProductLinkEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
type
-
Type of the link (cross_sell, grouped, related, or up_sell)
-
-
-
string
-
set
-
Product attribute set
-
-
-
string
-
sku
-
Product SKU
-
-
-
string
-
position
-
Position of the product
-
-
-
string
-
qty
-
Quantity of products
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apikey');
-
-$result = $client->call($session, 'catalog_product_link.assign', array('type' => 'related', 'product' => '1', 'linkedProduct' => '4'));
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductLinkAssign($sessionId, 'related', '1', '4');
-var_dump($result);
Allows you to retrieve the product link type attributes.
-
-
Aliases:
-
-
product_link.attributes
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
type
-
Type of the link (cross_sell, up_sell, related, or grouped)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductLinkAttributeEntity
-
-
-
-
-
The catalogProductLinkAttributeEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
code
-
Attribute code
-
-
-
string
-
type
-
Attribute type
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_link.attributes', 'related');
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductLinkAttributes($sessionId, 'related');
-var_dump($result);
-
-
diff --git a/guides/m1x/api/soap/catalog/catalogProductLink/catalog_product_link.list.html b/guides/m1x/api/soap/catalog/catalogProductLink/catalog_product_link.list.html
deleted file mode 100644
index 90846f2320..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductLink/catalog_product_link.list.html
+++ /dev/null
@@ -1,192 +0,0 @@
----
-layout: m1x_soap
-title: Product Link List
----
-
-
Module: Mage_Catalog
-
-
-
Resource: catalog_product_link
-
-
Aliases:
-
-
product_link
-
-
-
-
Method:
-
-
-
catalog_product_link.list (SOAP V1)
-
catalogProductLinkList (SOAP V2)
-
-
-
-
Allows you to retrieve the list of linked products for a specific product.
-
-
Aliases:
-
-
product_link.list
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
type
-
Type of the link (cross_sell, up_sell, related, or grouped)
-
-
-
string
-
product\productId
-
Product ID or SKU
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductLinkEntity
-
-
-
-
-
The catalogProductLinkEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
type
-
Type of the link
-
-
-
string
-
set
-
Product attribute set
-
-
-
string
-
sku
-
Product SKU
-
-
-
string
-
position
-
Position
-
-
-
string
-
qty
-
Quantity
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_link.list', array('type' => 'related', 'product' => '1'));
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductLinkList($sessionId, 'related', '1');
-var_dump($result);
Allows you to remove the product link from a specific product.
-
-
Aliases:
-
-
product_link.remove
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
type
-
Type of the link (cross_sell, up_sell, related, or grouped)
-
-
-
string
-
product\productId
-
Product ID or SKU
-
-
-
string
-
linkedProduct\linkedProductId
-
Product ID or SKU for the link
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean\int
-
True (1) if the link is removed from a product
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_link.remove', array('type' => 'related', 'product' => '1', 'linkedProduct' => '4'));
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductLinkRemove($sessionId, 'related', '1', '4');
-var_dump($result);
Allows you to retrieve the list of product link types.
-
-
Aliases:
-
-
product_link.types
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
ArrayOfString
-
result
-
Array of link types
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'product_link.types');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductLinkTypes($sessionId);
-var_dump($result);
Error while removing tag. Details in error message.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_tag.remove', '3');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductTagRemove($sessionId, '3');
-var_dump($result);
Allows you to retrieve information about product tier prices.
-
-
Aliases:
-
-
product_attribute_tier_price.info
-
product_tier_price.info
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
product\productId
-
Product ID or SKU
-
-
-
string
-
identifierType
-
Defines whether the product ID or SKU is passed in the 'product' parameter
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductTierPriceEntity
-
-
-
-
-
The catalogProductTierPriceEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
customer_group_id
-
Customer group ID
-
-
-
string
-
website
-
Website
-
-
-
int
-
qty
-
Quantity of items to which the price will be applied
-
-
-
double
-
price
-
Price that each item will cost
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_attribute_tier_price.info', 'productId');
-var_dump($result);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$productId = 1;
-
-$result = $client->catalogProductAttributeTierPriceInfo(
- $session,
- $productId
-);
-
-
diff --git a/guides/m1x/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html b/guides/m1x/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html
deleted file mode 100644
index 0d747813aa..0000000000
--- a/guides/m1x/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html
+++ /dev/null
@@ -1,169 +0,0 @@
----
-layout: m1x_soap
-title: Product Type List
----
-
-
Module: Mage_Catalog
-
-
-
Resource: catalog_product_type
-
-
Aliases:
-
-
product_type
-
-
-
-
Method:
-
-
-
catalog_product_type.list (SOAP V1)
-
catalogProductTypeList (SOAP V2)
-
-
-
-
Allows you to retrieve the list of product types.
-
-
Aliases:
-
-
product_type.list
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogProductTypeEntity
-
-
-
-
-
The catalogProductTypeEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
type
-
Product type
-
-
-
string
-
label
-
Product label in the Admin Panel
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'catalog_product_type.list');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogProductTypeList($sessionId);
-var_dump($result);
The use_config_manage_stock unchecks the ‘Use Config Settings’ box which allows you to make changes to this product and not to use the global settings that are set by default.
-
-
Example 1. Working with stock update
-
-
-
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
-$sessionId = $proxy->login('apiUser', 'apiKey');
-
-// Get stock info
-var_dump($proxy->call($sessionId, 'product_stock.list', 'Sku'));
-
-// Update stock info
-$proxy->call($sessionId, 'product_stock.update', array('Sku', array('qty'=>50, 'is_in_stock'=>1)));
-
-var_dump($proxy->call($sessionId, 'product_stock.list', 'Sku'));
-
-
-Create the Magento file system owner
diff --git a/guides/m1x/api/soap/catalogInventory/cataloginventory_stock_item.list.html b/guides/m1x/api/soap/catalogInventory/cataloginventory_stock_item.list.html
deleted file mode 100644
index 7df367b365..0000000000
--- a/guides/m1x/api/soap/catalogInventory/cataloginventory_stock_item.list.html
+++ /dev/null
@@ -1,166 +0,0 @@
----
-layout: m1x_soap
-title: Inventory Item List
----
-
-
Module: Mage_CatalogInventory
-
-
-
Resource: cataloginventory_stock_item
-
-
Aliases:
-
-
product_stock
-
-
-
-
Method:
-
-
-
cataloginventory_stock_item.list (SOAP V1)
-
catalogInventoryStockItemList (SOAP V2)
-
-
-
-
Allows you to retrieve the list of stock data by product IDs.
-
-
Aliases:
-
-
product_stock.list
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
ArrayOfString
-
products/productIds (for WS-I mode)
-
List of product IDs or SKUs
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of catalogInventoryStockItemEntity
-
-
-
-
-
The catalogInventoryStockItemEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
sku
-
Product SKU
-
-
-
string
-
qty
-
Product quantity
-
-
-
string
-
is_in_stock
-
Defines whether the product is in stock
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'cataloginventory_stock_item.list', '1');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->catalogInventoryStockItemList($sessionId, array('1', '2'));
-var_dump($result);
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.
Can not make operation because store is not exists
-
-
-
1002
-
Can not make operation because quote is not exists
-
-
-
1003
-
Can not create a quote.
-
-
-
1004
-
Can not create a quote because quote with such identifier is already exists
-
-
-
1005
-
You did not set all required agreements
-
-
-
1006
-
The checkout type is not valid. Select single checkout type.
-
-
-
1007
-
Checkout is not available for guest
-
-
-
1008
-
Can not create an order.
-
-
-
-
-
Example
-
-
The following example illustrates the work with shopping cart (creation of a shopping cart, setting customer and customer addresses, adding products to the shopping cart, updating products in the shopping cart, removing products from the shopping cart, getting the list of products/shipping methods/payment methods, setting payment/shipping methods, adding/removing coupon, getting total prices/full information about shopping cart/list of licenses, and creating an order.
Allows you to retrieve full information about the shopping cart (quote).
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
quoteId
-
Shopping cart ID (quote ID)
-
-
-
string
-
store
-
Store view ID or code (optional)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of shoppingCartInfoEntity
-
-
-
-
-
The shoppingCartInfoEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
store_id
-
Store ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
converted_at
-
Date of conversion
-
-
-
int
-
quote_id
-
Quote ID
-
-
-
int
-
is_active
-
Active flag
-
-
-
int
-
is_virtual
-
Defines whether the product is a virtual one
-
-
-
int
-
is_multi_shipping
-
Defines whether multi shipping is available
-
-
-
double
-
items_count
-
Items quantity
-
-
-
double
-
items_qty
-
Total items quantity
-
-
-
string
-
orig_order_id
-
Original order ID
-
-
-
string
-
store_to_base_rate
-
Store to base rate
-
-
-
string
-
store_to_quote_rate
-
Store to quote rate
-
-
-
string
-
base_currency_code
-
Base currency code
-
-
-
string
-
store_currency_code
-
Store currency code
-
-
-
string
-
quote_currency_code
-
Quote currency code
-
-
-
string
-
grand_total
-
Grand total
-
-
-
string
-
base_grand_total
-
Base grand total
-
-
-
string
-
checkout_method
-
Checkout method
-
-
-
string
-
customer_id
-
Customer ID
-
-
-
string
-
customer_tax_class_id
-
Customer tax class ID
-
-
-
int
-
customer_group_id
-
Customer group ID
-
-
-
string
-
customer_email
-
Customer email address
-
-
-
string
-
customer_prefix
-
Customer prefix
-
-
-
string
-
customer_firstname
-
Customer first name
-
-
-
string
-
customer_middlename
-
Customer middle name
-
-
-
string
-
customer_lastname
-
Customer last name
-
-
-
string
-
customer_suffix
-
Customer suffix
-
-
-
string
-
customer_note
-
Customer note
-
-
-
string
-
customer_note_notify
-
Customer notification flag
-
-
-
string
-
customer_is_guest
-
Defines whether the customer is a guest
-
-
-
string
-
applied_rule_ids
-
Applied rule IDs
-
-
-
string
-
reserved_order_id
-
Reserved order ID
-
-
-
string
-
password_hash
-
Password hash
-
-
-
string
-
coupon_code
-
Coupon code
-
-
-
string
-
global_currency_code
-
Global currency code
-
-
-
double
-
base_to_global_rate
-
Base to global rate
-
-
-
double
-
base_to_quote_rate
-
Base to quote rate
-
-
-
string
-
customer_taxvat
-
Customer taxvat value
-
-
-
string
-
customer_gender
-
Customer gender
-
-
-
double
-
subtotal
-
Subtotal
-
-
-
double
-
base_subtotal
-
Base subtotal
-
-
-
double
-
subtotal_with_discount
-
Subtotal with discount
-
-
-
double
-
base_subtotal_with_discount
-
Base subtotal with discount
-
-
-
string
-
ext_shipping_info
-
-
-
-
string
-
gift_message_id
-
Gift message ID
-
-
-
string
-
gift_message
-
Gift message
-
-
-
double
-
customer_balance_amount_used
-
Used customer balance amount
-
-
-
double
-
base_customer_balance_amount_used
-
Used base customer balance amount
-
-
-
string
-
use_customer_balance
-
Defines whether to use the customer balance
-
-
-
string
-
gift_cards_amount
-
Gift cards amount
-
-
-
string
-
base_gift_cards_amount
-
Base gift cards amount
-
-
-
string
-
gift_cards_amount_used
-
Used gift cards amount
-
-
-
string
-
use_reward_points
-
Defines whether to use reward points
-
-
-
string
-
reward_points_balance
-
Reward points balance
-
-
-
string
-
base_reward_currency_amount
-
Base reward currency amount
-
-
-
string
-
reward_currency_amount
-
Reward currency amount
-
-
-
array
-
shipping_address
-
Array of shoppingCartAddressEntity
-
-
-
array
-
billing_address
-
Array of shoppingCartAddressEntity
-
-
-
array
-
items
-
Array of shoppingCartItemEntity
-
-
-
array
-
payment
-
Array of shoppingCartPaymentEntity
-
-
-
-
-
The shoppingCartAddressEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
address_id
-
Shopping cart address ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
customer_id
-
Customer ID
-
-
-
int
-
save_in_address_book
-
Defines whether to save the address in the address book
-
-
-
string
-
customer_address_id
-
Customer address ID
-
-
-
string
-
address_type
-
Address type
-
-
-
string
-
email
-
Email address
-
-
-
string
-
prefix
-
Customer prefix
-
-
-
string
-
firstname
-
Customer first name
-
-
-
string
-
middlename
-
Customer middle name
-
-
-
string
-
lastname
-
Customer last name
-
-
-
string
-
suffix
-
Customer suffix
-
-
-
string
-
company
-
Company name
-
-
-
string
-
street
-
Street
-
-
-
string
-
city
-
City
-
-
-
string
-
region
-
Region
-
-
-
string
-
region_id
-
Region ID
-
-
-
string
-
postcode
-
Postcode
-
-
-
string
-
country_id
-
Country ID
-
-
-
string
-
telephone
-
Telephone number
-
-
-
string
-
fax
-
Fax
-
-
-
int
-
same_as_billing
-
Defines whether the address is the same as the billing one
-
-
-
int
-
free_shipping
-
Defines whether free shipping is used
-
-
-
string
-
shipping_method
-
Shipping method
-
-
-
string
-
shipping_description
-
Shipping description
-
-
-
double
-
weight
-
Weight
-
-
-
-
-
The shoppingCartItemEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
item_id
-
Cart item ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
store_id
-
Store ID
-
-
-
string
-
parent_item_id
-
Parent item ID
-
-
-
int
-
is_virtual
-
Defines whether the product is a virtual one
-
-
-
string
-
sku
-
Product SKU
-
-
-
string
-
name
-
Product name
-
-
-
string
-
description
-
Description
-
-
-
string
-
applied_rule_ids
-
Applied rule IDs
-
-
-
string
-
additional_data
-
Additional data
-
-
-
string
-
free_shipping
-
Free shipping
-
-
-
string
-
is_qty_decimal
-
Defines whether the quantity is decimal
-
-
-
string
-
no_discount
-
Defines whether no discount is applied
-
-
-
double
-
weight
-
Weight
-
-
-
double
-
qty
-
Quantity
-
-
-
double
-
price
-
Price
-
-
-
double
-
base_price
-
Base price
-
-
-
double
-
custom_price
-
Custom price
-
-
-
double
-
discount_percent
-
Discount percent
-
-
-
double
-
discount_amount
-
Discount amount
-
-
-
double
-
base_discount_amount
-
Base discount amount
-
-
-
double
-
tax_percent
-
Tax percent
-
-
-
double
-
tax_amount
-
Tax amount
-
-
-
double
-
base_tax_amount
-
Base tax amount
-
-
-
double
-
row_total
-
Row total
-
-
-
double
-
base_row_total
-
Base row total
-
-
-
double
-
row_total_with_discount
-
Row total with discount
-
-
-
double
-
row_weight
-
Row weight
-
-
-
string
-
product_type
-
Product type
-
-
-
double
-
base_tax_before_discount
-
Base tax before discount
-
-
-
double
-
tax_before_discount
-
Tax before discount
-
-
-
double
-
original_custom_price
-
Original custom price
-
-
-
double
-
base_cost
-
Base cost
-
-
-
double
-
price_incl_tax
-
Price including tax
-
-
-
double
-
base_price_incl_tax
-
Base price including tax
-
-
-
double
-
row_total_incl_tax
-
Row total including tax
-
-
-
double
-
base_row_total_incl_tax
-
Base row total including tax
-
-
-
string
-
gift_message_id
-
Gift message ID
-
-
-
string
-
gift_message
-
Gift message
-
-
-
string
-
gift_message_available
-
Defines whether the gift message is available
-
-
-
double
-
weee_tax_applied
-
Applied fix product tax
-
-
-
double
-
weee_tax_applied_amount
-
Applied fix product tax amount
-
-
-
double
-
weee_tax_applied_row_amount
-
Applied fix product tax row amount
-
-
-
double
-
base_weee_tax_applied_amount
-
Applied fix product tax amount (in base currency)
-
-
-
double
-
base_weee_tax_applied_row_amount
-
Applied fix product tax row amount (in base currency)
-
-
-
double
-
weee_tax_disposition
-
Fixed product tax disposition
-
-
-
double
-
weee_tax_row_disposition
-
Fixed product tax row disposition
-
-
-
double
-
base_weee_tax_disposition
-
Fixed product tax disposition (in base currency)
-
-
-
double
-
base_weee_tax_row_disposition
-
Fixed product tax row disposition (in base currency)
-
-
-
string
-
tax_class_id
-
Tax class ID
-
-
-
-
-
The shoppingCartPaymentEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
payment_id
-
Payment ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
method
-
Payment method
-
-
-
string
-
cc_type
-
Credit card type
-
-
-
string
-
cc_number_enc
-
Credit card number
-
-
-
string
-
cc_last4
-
Last four digits on the credit card
-
-
-
string
-
cc_cid_enc
-
Credit card CID
-
-
-
string
-
cc_owner
-
Credit card owner
-
-
-
string
-
cc_exp_month
-
Credit card expiration month
-
-
-
string
-
cc_exp_year
-
Credit card expiration year
-
-
-
string
-
cc_ss_owner
-
Credit card owner (Switch/Solo)
-
-
-
string
-
cc_ss_start_month
-
Credit card start month (Switch/Solo)
-
-
-
string
-
cc_ss_start_year
-
Credit card start year (Switch/Solo)
-
-
-
string
-
cc_ss_issue
-
Credit card issue number (Switch/Solo)
-
-
-
string
-
po_number
-
Purchase order number
-
-
-
string
-
additional_data
-
Additional data
-
-
-
string
-
additional_information
-
Additional information
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'cart.info', '15');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->shoppingCartInfo($sessionId, '15');
-var_dump($result);
Allows you to create an order from a shopping cart (quote).
-Before placing the order, you need to add the customer, customer address, shipping and payment methods.
Allows you to retrieve total prices for a shopping cart (quote).
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
quoteId
-
Shopping cart ID (quote identifier)
-
-
-
string
-
store
-
Store view ID or code (optional)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of shoppingCartTotalsEntity
-
-
-
-
-
The shoppingCartTotalsEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
title
-
Title
-
-
-
float
-
amount
-
Total amount
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'cart.totals', '15');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->shoppingCartTotals($sessionId, '15');
-var_dump($result);
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.
-
-
Cart Coupon
-
-
Allows you to add and remove coupon codes for a shopping cart.
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 the frontend logic. The cart is represented by the Mage_Checkout_Model_Cart class and the quote is represented by the Mage_Sales_Model_Quote class.
-
-
Faults
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
1001
-
Can not make operation because store is not exists
-
-
-
1002
-
Can not make operation because quote is not exists
-
-
-
1081
-
Coupon could not be applied because quote is empty.
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.
-
-
Cart Customer
-
-
Allows you to add customer information and addresses into a shopping cart.
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.
-
-
Cart Payment
-
-
Allows you to retrieve and set payment methods for a shopping cart.
cart_payment.list - Get the list of available payment methods for a shopping cart
-
-
-
-
Faults
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
1001
-
Can not make operation because store is not exists
-
-
-
1002
-
Can not make operation because quote is not exists
-
-
-
1071
-
Payment method data is empty.
-
-
-
1072
-
Customer’s billing address is not set. Required for payment method data.
-
-
-
1073
-
Customer’s shipping address is not set. Required for payment method data.
-
-
-
1074
-
Payment method is not allowed
-
-
-
1075
-
Payment method is not set.
-
-
-
-
-
-Create the Magento file system owner
diff --git a/guides/m1x/api/soap/checkout/cartPayment/cart_payment.list.html b/guides/m1x/api/soap/checkout/cartPayment/cart_payment.list.html
deleted file mode 100644
index 66df77574c..0000000000
--- a/guides/m1x/api/soap/checkout/cartPayment/cart_payment.list.html
+++ /dev/null
@@ -1,132 +0,0 @@
----
-layout: m1x_soap
-title: Payment List
----
-
-
Mage_Checkout
-
-
-
Module: Shopping Cart API
-
-
Resource: cart_payment
-
-
Method:
-
-
cart_payment.list (SOAP V1)
-
shoppingCartPaymentList (SOAP V2)
-
-
-
-
Allows you to retrieve a list of available payment methods for a shopping cart (quote).
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
quoteId
-
Shopping cart ID
-
-
-
string
-
store
-
Store view ID or code (optional)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of shoppingCartPaymentMethodResponseEntity
-
-
-
-
-
The shoppingCartPaymentMethodResponseEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
code
-
Payment method code
-
-
-
string
-
title
-
Payment method title
-
-
-
associativeArray
-
cc_types
-
Array of credit card types
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'cart_payment.list', 'quoteId');
-var_dump($result);
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.
Allows you to create/modify shopping cart and create an order after complete filling the shopping cart. Consists of two main parts: Shopping Cart and Checkout processes.
-
-
Module: Mage_Checkout
-
-
Resource: cart_product
-
-
Method:
-
-
-
cart_product.add (SOAP V1)
-
shoppingCartProductAdd (SOAP V2)
-
-
-
-
Allows you to add one or more products to the shopping cart (quote).
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
quoteId
-
Shopping cart ID (quote ID)
-
-
-
array
-
products\productsData
-
An array with the list of shoppingCartProductEntity
-
-
-
string
-
storeId
-
Store view ID or code (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True on success (if the product is added to the shopping cart)
-
-
-
-
-
The shoppingCartProductEntity array attributes are as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
product_id
-
ID of the product to be added to the shopping cart (quote) (optional)
-
-
-
string
-
sku
-
SKU of the product to be added to the shopping cart (quote) (optional)
-
-
-
double
-
qty
-
Number of products to be added to the shopping cart (quote) (optional)
-
-
-
associativeArray
-
options
-
An array in the form of option_id => content (optional)
Allows you to retrieve the list of products in the shopping cart (quote).
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
quoteId
-
Shopping cart ID
-
-
-
string
-
store
-
Store view ID or code (optional)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of shoppingCartProductResponseEntity
-
-
-
-
-
The shoppingCartProductResponseEntity (catalogProductEntity) content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
sku
-
Product SKU
-
-
-
string
-
name
-
Product name
-
-
-
string
-
set
-
Product attribute set
-
-
-
string
-
type
-
Product type
-
-
-
ArrayOfString
-
category_ids
-
Array of category IDs
-
-
-
ArrayOfString
-
website_ids
-
Array of website IDs
-
-
-
-
Faults:
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'cart_product.list', '15');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->shoppingCartProductList($sessionId, '15');
-var_dump($result);
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.
-
-
Cart Shipping
-
-
Allows you to retrieve and set shipping methods for a shopping cart.
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.
-
-
Cart Coupon
-
-
Allows you to add and remove coupon codes for a shopping cart.
The Core API allows you to manage a set of common resources used in Magento. However, you may choose to have your own set of resources to manage, or you may wish to extend the Core API to handle additional resources.
-
-
This tutorial leads you through the process of creating a custom API for a customer module that handles basic customer information.
-
-
Note: This tutorial applies to v1 of the API.
-
-
To learn more about the Core API, to read Magento Core API calls.
-
-
For general information about the Magento API, go to the Introduction.
-
-
1. Creating an XML File that Will Define the API Resource
-
-
Create a file named api.xml in the /etc folder in the customer module. Start with the empty structure, as follows:
Add an element named customer in the <resources> element. Add a <methods> element, with elements for list, create, info, update and remove methods for customer resource.
The resource can return some faults, so add a <faults> element in the customer element, and list the various faults.
-
-
-
<config>
- <api>
-....
- <resources>
- <customer translate="title" module="customer">
-....
- <faults module="customer"> <!-- module="customer" specifies the module which will be used for translation. -->
- <data_invalid> <!-- if we get invalid input data for customers -->
- <code>100</code >
- <!-- we cannot know all the errors that can appear, their details can be found in error message for call -->
- <message>Invalid customer data. Details in error message.</message>
- </data_invalid>
- <filters_invalid>
- <code>101</code >
- <message>Invalid filters specified. Details in error message.</message>
- </filters_invalid>
- <not_exists>
- <code>102</code >
- <message>Customer doesn't exist.</message>
- </not_exists>
- <not_deleted>
- <code>103</code >
- <message>Customer was not deleted. Details in error message.</message>
- </not_deleted>
- </faults>
- </customer>
- </resources>
-....
- </api>
-</config>
-
-
-
-
4. Describing the Access Control List (ACL) for the Resource
-
-
In order to prevent unauthorized access to our custom API, you must first list the resources that are restricted within the <acl> element.
Next, write some PHP code to access the resources. Start by creating a class called Mage_Customer_Model_Customer_Api that extends Mage_Api_Model_Resource_Abstract. Save it into a file called api.php.
-
-
-
class Mage_Customer_Model_Customer_Api extends Mage_Api_Model_Resource_Abstract
-{
-
- public function create($customerData)
- {
- }
-
- public function info($customerId)
- {
- }
-
- public function items($filters)
- {
- }
-
- public function update($customerId, $customerData)
- {
- }
-
- public function delete($customerId)
- {
- }
-}
-
-
-
-
Note that you cannot create method "list" because it’s a PHP keyword, so instead the method is named items. In order to make this work, add a <method> element into the <list> element in api.xml, as shown below.
Now add some simple functionality to the Mage_Customer_Model_Api methods you created.
-
-
Create a customer:
-
-
-
public function create($customerData)
- {
- try {
- $customer = Mage::getModel('customer/customer')
- ->setData($customerData)
- ->save();
- } catch (Mage_Core_Exception $e) {
- $this->_fault('data_invalid', $e->getMessage());
- // We cannot know all the possible exceptions,
- // so let's try to catch the ones that extend Mage_Core_Exception
- } catch (Exception $e) {
- $this->_fault('data_invalid', $e->getMessage());
- }
- return $customer->getId();
- }
-
-
-
-
Retrieve customer info:
-
-
-
public function info($customerId)
- {
- $customer = Mage::getModel('customer/customer')->load($customerId);
- if (!$customer->getId()) {
- $this->_fault('not_exists');
- // If customer not found.
- }
- return $customer->toArray();
- // We can use only simple PHP data types in webservices.
- }
-
-
-
-
Retrieve list of customers using filtering:
-
-
-
public function items($filters)
- {
- $collection = Mage::getModel('customer/customer')->getCollection()
- ->addAttributeToSelect('*');
-
- if (is_array($filters)) {
- try {
- foreach ($filters as $field => $value) {
- $collection->addFieldToFilter($field, $value);
- }
- } catch (Mage_Core_Exception $e) {
- $this->_fault('filters_invalid', $e->getMessage());
- // If we are adding filter on non-existent attribute
- }
- }
-
- $result = array();
- foreach ($collection as $customer) {
- $result[] = $customer->toArray();
- }
-
- return $result;
- }
-
-
-
-
Update a customer:
-
-
-
public function update($customerId, $customerData)
- {
- $customer = Mage::getModel('customer/customer')->load($customerId);
-
- if (!$customer->getId()) {
- $this->_fault('not_exists');
- // No customer found
- }
-
- $customer->addData($customerData)->save();
- return true;
- }
-
-
-
-
Delete a customer:
-
-
-
public function delete($customerId)
- {
- $customer = Mage::getModel('customer/customer')->load($customerId);
-
- if (!$customer->getId()) {
- $this->_fault('not_exists');
- // No customer found
- }
-
- try {
- $customer->delete();
- } catch (Mage_Core_Exception $e) {
- $this->_fault('not_deleted', $e->getMessage());
- // Some errors while deleting.
- }
-
- return true;
- }
-
-
-
-
Creating a Custom Adapter
-
-
In order to create custom webservice adapter, implement the Mage_Api_Model_Server_Adapter_Interface, which is shown below.
-
-
-
interface Mage_Api_Model_Server_Adapter_Interface
-{
- /**
- * Set handler class name for webservice
- *
- * @param string $handler
- * @return Mage_Api_Model_Server_Adapter_Interface
- */
- function setHandler($handler);
-
- /**
- * Retrieve handler class name for webservice
- *
- * @return string [basc]
- */
- function getHandler();
-
- /**
- * Set webservice API controller
- *
- * @param Mage_Api_Controller_Action $controller
- * @return Mage_Api_Model_Server_Adapter_Interface
- */
- function setController(Mage_Api_Controller_Action $controller);
-
- /**
- * Retrieve webservice API controller
- *
- * @return Mage_Api_Controller_Action
- */
- function getController();
-
- /**
- * Run webservice
- *
- * @return Mage_Api_Model_Server_Adapter_Interface
- */
- function run();
-
- /**
- * Dispatch webservice fault
- *
- * @param int $code
- * @param string $message
- */
- function fault($code, $message);
-
-} // Class Mage_Api_Model_Server_Adapter_Interface End
-
-
-
-
Here is an example implementation for XML-RPC:
-
-
-
class Mage_Api_Model_Server_Adapter_Customxmlrpc
- extends Varien_Object
- implements Mage_Api_Model_Server_Adapter_Interface
-{
- /**
- * XmlRpc Server
- *
- * @var Zend_XmlRpc_Server
- */
- protected $_xmlRpc = null;
-
- /**
- * Set handler class name for webservice
- *
- * @param string $handler
- * @return Mage_Api_Model_Server_Adapter_Xmlrpc
- */
- public function setHandler($handler)
- {
- $this->setData('handler', $handler);
- return $this;
- }
-
- /**
- * Retrieve handler class name for webservice
- *
- * @return string
- */
- public function getHandler()
- {
- return $this->getData('handler');
- }
-
- /**
- * Set webservice API controller
- *
- * @param Mage_Api_Controller_Action $controller
- * @return Mage_Api_Model_Server_Adapter_Xmlrpc
- */
- public function setController(Mage_Api_Controller_Action $controller)
- {
- $this->setData('controller', $controller);
- return $this;
- }
-
- /**
- * Retrieve webservice API controller
- *
- * @return Mage_Api_Controller_Action
- */
- public function getController()
- {
- return $this->getData('controller');
- }
-
- /**
- * Run webservice
- *
- * @param Mage_Api_Controller_Action $controller
- * @return Mage_Api_Model_Server_Adapter_Xmlrpc
- */
- public function run()
- {
- $this->_xmlRpc = new Zend_XmlRpc_Server();
- $this->_xmlRpc->setClass($this->getHandler());
- $this->getController()->getResponse()
- ->setHeader('Content-Type', 'text/xml')
- ->setBody($this->_xmlRpc->handle());
- return $this;
- }
-
- /**
- * Dispatch webservice fault
- *
- * @param int $code
- * @param string $message
- */
- public function fault($code, $message)
- {
- throw new Zend_XmlRpc_Server_Exception($message, $code);
- }
-} // Class Mage_Api_Model_Server_Adapter_Customxmlrpc End
-
-
-
-
Notes: The setHandler, getHandler, setController and getController methods have a simple implementation that uses the Varien_Object getData and setData methods.
-
-
The run and fault methods are a native implementation for an XML-RPC webservice. The run method defines webservice logic in this adapter for creating an XML-RPC server to handle XML-RPC requests.
-
-
-
public function run()
-Â Â {
-Â Â Â Â $this->_xmlRpc = new Zend_XmlRpc_Server();
-Â Â Â Â $this->_xmlRpc->setClass($this->getHandler());
-Â Â Â Â $this->getController()->getResponse()
-Â Â Â Â Â Â ->setHeader('Content-Type', 'text/xml')
-Â Â Â Â Â Â ->setBody($this->_xmlRpc->handle());
-Â Â Â Â return $this;
-Â Â }
-
-
-
-
The "fault" method allows you to send fault exceptions for XML-RPC service when handling requests.
-
-
-
public function fault($code, $message)
-Â Â {
-Â Â Â Â throw new Zend_XmlRpc_Server_Exception($message, $code);
-Â Â }
-
-
-
-
Common Error Messages
-
-
The following are common error messages that you might receive when creating your own custom API.
-
-
Invalid API path
-
-
This error occurs when the methods listed in the api.xml file do not correspond exactly with those used in your PHP file.
-
-
For example, in your api.xml file, you might have this:
Allows you to export/import customers from/to Magento
-
-
Resource: customer
-
-
-
Method:
-
-
-
customer.delete (SOAP V1)
-
customerCustomerDelete (SOAP V2)
-
-
-
-
Delete the required customer.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
customerId
-
Customer ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the customer is deleted
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'customer.delete', '2');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->customerCustomerDelete($sessionId, '2');
-var_dump($result);
Allows you to export/import customers from/to Magento.
-
-
Resource: customer
-
-
-
Method:
-
-
-
customer.info (SOAP V1)
-
customerCustomerInfo (SOAP V2)
-
-
-
-
-
Retrieve information about the specified customer.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
customerId
-
ID of the required customer
-
-
-
ArrayOfString
-
attributes
-
Array of attributes
-
-
-
-
-
attributes (optional depending on the version) - only specified attributes will be returned. The customer_id value is always returned.
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
customerInfo
-
Array of customerCustomerEntity
-
-
-
-
-
The customerCustomerEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
customer_id
-
ID of the customer
-
-
-
string
-
created_at
-
Date when the customer was created
-
-
-
string
-
updated_at
-
Date when the customer was updated
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
int
-
store_id
-
Store ID
-
-
-
int
-
website_id
-
Website ID
-
-
-
string
-
created_in
-
Store view the customer was created in
-
-
-
string
-
email
-
Customer email
-
-
-
string
-
firstname
-
Customer first name
-
-
-
string
-
middlename
-
Customer middle name
-
-
-
string
-
lastname
-
Customer last name
-
-
-
int
-
group_id
-
Customer group ID
-
-
-
string
-
prefix
-
Customer prefix
-
-
-
string
-
suffix
-
Customer suffix
-
-
-
string
-
dob
-
Customer date of birth
-
-
-
string
-
taxvat
-
Tax/VAT number
-
-
-
boolean
-
confirmation
-
Confirmation flag
-
-
-
string
-
password_hash
-
Password hash
-
-
-
string
-
rp_token
-
Reset password token
-
-
-
string
-
rp_token_created_at
-
Date when the password was reset
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'customer.info', '2');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->customerCustomerInfo($sessionId, '2');
-var_dump($result);
Array of filters by customer attributes (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
storeView
-
Array of customerCustomerEntity
-
-
-
-
-
The customerCustomerEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
customer_id
-
ID of the customer
-
-
-
string
-
created_at
-
Date when the customer was created
-
-
-
string
-
updated_at
-
Date of when the customer was updated
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
int
-
store_id
-
Store ID
-
-
-
int
-
website_id
-
Website ID
-
-
-
string
-
created_in
-
Created in
-
-
-
string
-
email
-
Customer email
-
-
-
string
-
firstname
-
Customer first name
-
-
-
string
-
middlename
-
Customer middle name
-
-
-
string
-
lastname
-
Customer last name
-
-
-
int
-
group_id
-
Group ID
-
-
-
string
-
prefix
-
Customer prefix
-
-
-
string
-
suffix
-
Customer suffix
-
-
-
string
-
dob
-
Customer date of birth
-
-
-
string
-
taxvat
-
Taxvat value
-
-
-
boolean
-
confirmation
-
Confirmation flag
-
-
-
string
-
password_hash
-
Password hash
-
-
-
-
Note: The password_hash parameter will only match exactly with the same MD5 and salt as was used when Magento stored the value. If you try to match with an unsalted MD5 hash, or any salt other than what Magento used, it will not match. This is just a straight string comparison.
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'customer.list');
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
-
Request Example SOAP V2 (List of All Customers)
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->customerCustomerList($sessionId);
-var_dump($result);
-
-
-
-
-
Request Example SOAP V2 (Complex Filter)
-
-
-
-
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-$complexFilter = array(
- 'complex_filter' => array(
- array(
- 'key' => 'group_id',
- 'value' => array('key' => 'in', 'value' => '1,3')
- )
- )
-);
-$result = $client->customerCustomerList($session, $complexFilter);
-
-var_dump ($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'customer_address.delete', '4');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->customerAddressDelete($sessionId, '4');
-var_dump($result);
Retrieve information about the required customer address.
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
int
-
addressId
-
Address ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
info
-
Array of customerAddressEntityItem
-
-
-
-
-
The customerAddressEntityItem content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
customer_address_id
-
ID of the customer address
-
-
-
string
-
created_at
-
Date when the address was created
-
-
-
string
-
updated_at
-
Date when the address was updated
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
city
-
name of the city
-
-
-
string
-
company
-
Name of the company
-
-
-
string
-
country_id
-
ID of the country
-
-
-
string
-
fax
-
Fax
-
-
-
string
-
firstname
-
Customer first name
-
-
-
string
-
lastname
-
Customer last name
-
-
-
string
-
middlename
-
Customer middle name
-
-
-
string
-
postcode
-
Customer postcode
-
-
-
string
-
prefix
-
Customer prefix
-
-
-
string
-
region
-
Name of the region
-
-
-
int
-
region_id
-
Region ID
-
-
-
string
-
street
-
Name of the street
-
-
-
string
-
suffix
-
Customer suffix
-
-
-
string
-
telephone
-
Telephone number
-
-
-
boolean
-
is_default_billing
-
True if the address is the default one for billing
-
-
-
boolean
-
is_default_shipping
-
True if the address is the default one for shipping
-
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'customer_address.info', '2');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->customerAddressInfo($sessionId, '2');
-var_dump($result);
True if the address is the default one for billing
-
-
-
boolean
-
is_default_shipping
-
True if the address is the default one for shipping
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'customer_address.list', '2');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->customerAddressList($sessionId, '2');
-var_dump($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'customer_group.list');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->customerGroupList($sessionId);
-var_dump($result);
-
-
diff --git a/guides/m1x/api/soap/directory/directory_region.list.html b/guides/m1x/api/soap/directory/directory_region.list.html
deleted file mode 100644
index 8866dee39a..0000000000
--- a/guides/m1x/api/soap/directory/directory_region.list.html
+++ /dev/null
@@ -1,186 +0,0 @@
----
-layout: m1x_soap
-title: Region List
----
-
-
Region API
-
-
Allows you to export the list of regions from Magento
-
-
Module: Mage_Directory
-
-
Resource: directory_region
-
-
Aliases:
-
-
region
-
-
-
-
Method:
-
-
-
directory_region.list (SOAP V1)
-
directoryRegionList (SOAP V2)
-
-
-
-
Retrieve the list of regions in the specified country.
-
-
Aliases:
-
-
region.list
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
country
-
Country code in ISO2 or ISO3
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
directoryRegionEntityArray
-
An array of directoryRegionEntity
-
-
-
-
-
-
The directoryRegionEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
region_id
-
ID of the region
-
-
-
string
-
code
-
Region code
-
-
-
string
-
name
-
Name of the region
-
-
-
-
-
Faults:
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
101
-
Country not exists.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
-$sessionId = $proxy->login('apiUser', 'apiKey');
-$regions = $proxy->call($sessionId, 'region.list', 'US');
-
-var_dump($regions); // Region list for USA.
The Magento SOAP v1 API provides you with the ability to manage your eCommerce stores by providing calls for working with resources such as customers, categories, products, and sales orders. It also allows you to manage shopping carts and inventory.
-
-
A SOAP v2 API version has been available since Magento 1.3, and a WS-I compliant version has been available since Magento 1.6.
-
-
Supported Types
-
-
The Magento API supports SOAP and XML-RPC, where SOAP is the default protocol.
-
-
SOAP
-
-
To connect to Magento SOAP web services, load the WSDL into your SOAP client from either of these URLs:
-
-
-
-
http://magentohost/api/?wsdl
-
-
-
-
-
http://magentohost/api/soap/?wsdl
-
-
-
-
where magentohost is the domain for your Magento host.
-
-
As of v1.3, you may also use the following URL to access the Magento API v2, which has been added to improve compatibility with Java and .NET:
-
-
-
-
http://magentohost/api/v2_soap?wsdl=1
-
-
-
-
The following PHP example shows how to make SOAP calls to the Magento API v1:
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'somestuff.method');
-$result = $client->call($session, 'somestuff.method', 'arg1');
-$result = $client->call($session, 'somestuff.method', array('arg1', 'arg2', 'arg3'));
-$result = $client->multiCall($session, array(
- array('somestuff.method'),
- array('somestuff.method', 'arg1'),
- array('somestuff.method', array('arg1', 'arg2'))
-));
-
-
-// If you don't need the session anymore
-$client->endSession($session);
-
-
-
-
XML-RPC
-
-
To use XML-RPC, load the following URL into your XML-RPC client:
-
-
-
-
http://magentohost/api/xmlrpc/
-
-
-
-
where magentohost is the domain for your Magento host.
-
-
The following PHP example shows how to make XML-RPC calls:
-
-
-
-
$client = new Zend_XmlRpc_Client('http://magentohost/api/xmlrpc/');
-
-// If somestuff requires API authentication,
-// we should get session token
-$session = $client->call('login', array('apiUser', 'apiKey'));
-
-$client->call('call', array($session, 'somestuff.method', array('arg1', 'arg2', 'arg3')));
-$client->call('call', array($session, 'somestuff.method', array('arg1')));
-$client->call('call', array($session, 'somestuff.method'));
-$client->call('multiCall', array($session,
- array(
- array('somestuff.method', 'arg1'),
- array('somestuff.method', array('arg1', 'arg2')),
- array('somestuff.method')
- )
-));
-
-// If you don't need the session anymore
-$client->call('endSession', array($session));
-
-
-
-
The XML-RPC only supports the version 1 of the Magento API.
-
-
API Methods
-
-
The following table contains the API methods that can be called from your SOAP or XML-RPC client on the Magento v1 API.
-
-
-
-
-
-
Method
-
Description
-
Return Value
-
-
-
startSession()
-
Start the API session and return session ID.
-
string
-
-
-
endSession(sessionId)
-
End the API session.
-
boolean
-
-
-
login(apiUser, apiKey)
-
Start the API session, return the session ID, and authorize the API user.
-
string
-
-
-
call(sessionId, resourcePath,array arguments)
-
Call the API resource that is allowed in the current session. See Note below.
-
mixed
-
-
-
multiCall(sessionId, array calls,array options)
-
Call the API resource’s methods that are allowed for current session. See Notes below.
-
array
-
-
-
resources(sessionId)
-
Return a list of available API resources and methods allowed for the current session.
-
array
-
-
-
globalFaults(sessionId)
-
Return a list of fault messages and their codes that do not depend on any resource.
-
array
-
-
-
resourceFaults(sessionId, resourceName)
-
Return a list of the specified resource fault messages, if this resource is allowed in the current session.
-
array
-
-
-
-
Note: For call and multiCall, if no session is specified, you can call only resources that are not protected by ACL.
-
-
Note: For multiCall, if the "break" option is specified, multiCall breaks on first error.
-
-
The Magento SOAP API v2 does not support the call() and multiCall() methods, and instead provides a separate method for each API resource.
-
-
Global API Faults
-
-
The following table contains fault codes that apply to all SOAP/XML-RPC API calls.
-
-
-
-
Fault Code
-
Fault Message
-
-
-
0
-
Unknown Error
-
-
-
1
-
Internal Error. Please see log for details.
-
-
-
2
-
Access denied.
-
-
-
3
-
Invalid API path.
-
-
-
4
-
Resource path is not callable.
-
-
-
-
-
SOAP API Version v2
-
-
Since Magento 1.3, version v2 of the SOAP API has also been available. The main difference between v1 and v2 is that instead of using methods call and multiCall, it has separate methods for each action.
-
-
For example, consider the following PHP code using SOAP v1.
Note that the WSDL for SOAP v1 and SOAP v2 are different. Note that in SOAP v1, customizing the API did not involve changing the WSDL. In SOAP v2, changes to the WSDL are required.
-
-
You can configure the SOAP v2 API to be WS-I compliant in the system configuration menu. To do this, set Services > Magento Core API > WS-I Compliance to Yes.
-
-
Note that the WSDL for the SOAP v2 API is different when in WS-I compliant mode.
-
-
Using the WS-I compliant SOAP v2 API WSDL, it is easy to automatically generate client classes for Java, .NET, and other languages using standard libraries.
-
-
-
-Create the Magento file system owner
diff --git a/guides/m1x/api/soap/miscellaneous/store.info.html b/guides/m1x/api/soap/miscellaneous/store.info.html
deleted file mode 100644
index 8fea1fb417..0000000000
--- a/guides/m1x/api/soap/miscellaneous/store.info.html
+++ /dev/null
@@ -1,182 +0,0 @@
----
-layout: m1x_soap
-title: Store Info
----
-
-
Module: Store View API
-
-
Resource: store
-
-
Method:
-
-
-
store.info (SOAP V1)
-
storeInfo (SOAP V2)
-
-
-
-
Allows you to retrieve information about the required store view.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
storeId
-
Store view ID or code (optional)
-
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of storeEntity
-
-
-
-
-
The storeEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
store_id
-
Store view ID
-
-
-
string
-
code
-
Store view code
-
-
-
int
-
website_id
-
Website ID
-
-
-
int
-
group_id
-
Group ID
-
-
-
string
-
name
-
Store name
-
-
-
int
-
sort_order
-
Store view sort order
-
-
-
int
-
is_active
-
Defines whether the store is active
-
-
-
-
-
-
Faults:
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
101
-
Requested store view not found.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'store.info', '2');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->storeInfo($sessionId, '2');
-var_dump($result);
-
-
diff --git a/guides/m1x/api/soap/miscellaneous/store.list.html b/guides/m1x/api/soap/miscellaneous/store.list.html
deleted file mode 100644
index dace494d7d..0000000000
--- a/guides/m1x/api/soap/miscellaneous/store.list.html
+++ /dev/null
@@ -1,174 +0,0 @@
----
-layout: m1x_soap
-title: Store List
----
-
-
Module: Store View API
-
-
Resource: store
-
-
Method:
-
-
-
store.list (SOAP V1)
-
storeList (SOAP V2)
-
-
-
-
Allows you to retrieve the list of store views.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of storeEntity
-
-
-
-
-
The storeEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
store_id
-
Store view ID
-
-
-
string
-
code
-
Store view code
-
-
-
int
-
website_id
-
Website ID
-
-
-
int
-
group_id
-
Group ID
-
-
-
string
-
name
-
Store view name
-
-
-
int
-
sort_order
-
Store view sort order
-
-
-
int
-
is_active
-
Defines whether the store is active
-
-
-
-
-
Faults:
-No Faults
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'store.list');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->storeList($sessionId);
-var_dump($result);
Order status not changed. Details in error message.
-
-
-
-
-
Examples
-
-
Example 1. Work with orders
-
-
-
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
-$sessionId = $proxy->login('apiUser', 'apiKey');
-
-// Getting list of orders created by John Doe
-var_dump($proxy->call($sessionId, 'sales_order.list', array(array('customer_firstname'=>array('eq'=>'John'), 'customer_lastname'=>array('eq'=>'Doe')))));
-
-
-// Get order info 100000003
-var_dump($proxy->call($sessionId, 'sales_order.info', '100000003'));
-
-
-// Hold order 100000003
-$proxy->call($sessionId, 'sales_order.hold', '100000003');
-
-// Unhold order 100000003
-$proxy->call($sessionId, 'sales_order.unhold', '100000003');
-
-// Hold order and add comment 100000003
-$proxy->call($sessionId, 'sales_order.addComment', array('100000003', 'holded', 'You order is holded', true));
-
-// Unhold order and add comment 100000003
-$proxy->call($sessionId, 'sales_order.addComment', array('100000003', 'pending', 'You order is pending', true));
-
-// Get order info 100000003
-var_dump($proxy->call($sessionId, 'sales_order.info', '100000003'));
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order.addComment', array('orderIncrementId' => '200000004', 'status' => 'processing'));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderAddComment($sessionId, '200000004', 'processing');
-var_dump($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order.cancel', '200000004');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderCancel($sessionId, '200000004');
-var_dump($result);
-
-
diff --git a/guides/m1x/api/soap/sales/salesOrder/sales_order.hold.html b/guides/m1x/api/soap/sales/salesOrder/sales_order.hold.html
deleted file mode 100644
index 701ef966fb..0000000000
--- a/guides/m1x/api/soap/sales/salesOrder/sales_order.hold.html
+++ /dev/null
@@ -1,118 +0,0 @@
----
-layout: m1x_soap
-title: Order Hold
----
-
-
Module: Mage_Sales
-
-
-
Resource: sales_order
-
-
Aliases:
-
-
order
-
-
-
-
Method:
-
-
-
sales_order.hold (SOAP V1)
-
salesOrderHold (SOAP V2)
-
-
-
-
Allows you to place the required order on hold.
-
-
Aliases:
-
-
order.hold
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
orderIncrementId
-
Order increment ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean\int
-
True (1) if the order is placed on hold
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order.hold', '200000006');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderHold($sessionId, '200000006');
-var_dump($result);
-
-
-
diff --git a/guides/m1x/api/soap/sales/salesOrder/sales_order.info.html b/guides/m1x/api/soap/sales/salesOrder/sales_order.info.html
deleted file mode 100644
index f6e970c619..0000000000
--- a/guides/m1x/api/soap/sales/salesOrder/sales_order.info.html
+++ /dev/null
@@ -1,1188 +0,0 @@
----
-layout: m1x_soap
-title: Order Info
----
-
-
Module: Mage_Sales
-
-
-
Resource: sales_order
-
-
Aliases:
-
-
order
-
-
-
-
Method:
-
-
-
sales_order.info (SOAP V1)
-
salesOrderInfo (SOAP V2)
-
-
-
-
Allows you to retrieve the required order information.
-
-
Aliases:
-
-
order.info
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
orderIncrementId
-
Order increment ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of salesOrderEntity
-
-
-
-
-
The salesOrderEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
store_id
-
Store ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
is_active
-
Defines whether the order is active
-
-
-
string
-
customer_id
-
Customer ID
-
-
-
string
-
tax_amount
-
Tax amount
-
-
-
string
-
shipping_amount
-
Shipping amount
-
-
-
string
-
discount_amount
-
Discount amount
-
-
-
string
-
subtotal
-
Subtotal sum
-
-
-
string
-
grand_total
-
Grand total sum
-
-
-
string
-
total_paid
-
Total paid
-
-
-
string
-
total_refunded
-
Total refunded
-
-
-
string
-
total_qty_ordered
-
Total quantity ordered
-
-
-
string
-
total_canceled
-
Total canceled
-
-
-
string
-
total_invoiced
-
Total invoiced
-
-
-
string
-
total_online_refunded
-
Total online refunded
-
-
-
string
-
total_offline_refunded
-
Total offline refunded
-
-
-
string
-
base_tax_amount
-
Base tax amount
-
-
-
string
-
base_shipping_amount
-
Base shipping amount
-
-
-
string
-
base_discount_amount
-
Base discount amount
-
-
-
string
-
base_subtotal
-
Base subtotal
-
-
-
string
-
base_grand_total
-
Base grand total
-
-
-
string
-
base_total_paid
-
Base total paid
-
-
-
string
-
base_total_refunded
-
Base total refunded
-
-
-
string
-
base_total_qty_ordered
-
Base total quantity ordered
-
-
-
string
-
base_total_canceled
-
Base total canceled
-
-
-
string
-
base_total_invoiced
-
Base total invoiced
-
-
-
string
-
base_total_online_refunded
-
Base total online refunded
-
-
-
string
-
base_total_offline_refunded
-
Base total offline refunded
-
-
-
string
-
billing_address_id
-
Billing address ID
-
-
-
string
-
billing_firstname
-
First name in the billing address
-
-
-
string
-
billing_lastname
-
Last name in the billing address
-
-
-
string
-
shipping_address_id
-
Shipping address ID
-
-
-
string
-
shipping_firstname
-
First name in the shipping address
-
-
-
string
-
shipping_lastname
-
Last name in the shipping address
-
-
-
string
-
billing_name
-
Billing name
-
-
-
string
-
shipping_name
-
Shipping name
-
-
-
string
-
store_to_base_rate
-
Store to base rate
-
-
-
string
-
store_to_order_rate
-
Store to order rate
-
-
-
string
-
base_to_global_rate
-
Base to global rate
-
-
-
string
-
base_to_order_rate
-
Base to order rate
-
-
-
string
-
weight
-
Weight
-
-
-
string
-
store_name
-
Store name
-
-
-
string
-
remote_ip
-
Remote IP
-
-
-
string
-
status
-
Order status
-
-
-
string
-
state
-
Order state
-
-
-
string
-
applied_rule_ids
-
Applied rule IDs
-
-
-
string
-
global_currency_code
-
Global currency code
-
-
-
string
-
base_currency_code
-
Base currency code
-
-
-
string
-
store_currency_code
-
Store currency code
-
-
-
string
-
order_currency_code
-
Order currency code
-
-
-
string
-
shipping_method
-
Shipping method
-
-
-
string
-
shipping_description
-
Shipping description
-
-
-
string
-
customer_email
-
Email address of the customer
-
-
-
string
-
customer_firstname
-
Customer first name
-
-
-
string
-
customer_lastname
-
Customer last name
-
-
-
string
-
quote_id
-
Shopping cart ID
-
-
-
string
-
is_virtual
-
Defines whether the product is a virtual one
-
-
-
string
-
customer_group_id
-
Customer group ID
-
-
-
string
-
customer_note_notify
-
Customer notification
-
-
-
string
-
customer_is_guest
-
Defines whether the customer is a guest
-
-
-
string
-
email_sent
-
Defines whether the email notification is sent
-
-
-
string
-
order_id
-
Order ID
-
-
-
string
-
gift_message_id
-
Gift message ID
-
-
-
string
-
gift_message
-
Gift message
-
-
-
array
-
shipping_address
-
Array of salesOrderAddressEntity
-
-
-
array
-
billing_address
-
Array of salesOrderAddressEntity
-
-
-
array
-
items
-
Array of salesOrderItemEntity
-
-
-
array
-
payment
-
Array of salesOrderPaymentEntity
-
-
-
array
-
status_history
-
Array of salesOrderStatusHistoryEntity
-
-
-
-
-
The salesOrderAddressEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
is_active
-
Defines whether the address is active
-
-
-
string
-
address_type
-
Address type
-
-
-
string
-
firstname
-
First name
-
-
-
string
-
lastname
-
Last name
-
-
-
string
-
company
-
Company name
-
-
-
string
-
street
-
Street name
-
-
-
string
-
city
-
City
-
-
-
string
-
region
-
Region
-
-
-
string
-
postcode
-
Post code
-
-
-
string
-
country_id
-
Country ID
-
-
-
string
-
telephone
-
Telephone number
-
-
-
string
-
fax
-
Fax number
-
-
-
string
-
region_id
-
Region ID
-
-
-
string
-
address_id
-
Address ID
-
-
-
-
-
The salesOrderItemEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
item_id
-
Item ID
-
-
-
string
-
order_id
-
Order ID
-
-
-
string
-
quote_item_id
-
Shopping cart item ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
product_type
-
Product type
-
-
-
string
-
product_options
-
Product options
-
-
-
string
-
weight
-
Weight
-
-
-
string
-
is_virtual
-
Defines whether the product is a virtual one
-
-
-
string
-
sku
-
Product SKU
-
-
-
string
-
name
-
Product name
-
-
-
string
-
applied_rule_ids
-
Applied rule IDs
-
-
-
string
-
free_shipping
-
Defines whether free shipping is applied
-
-
-
string
-
is_qty_decimal
-
Defines whether the items quantity is decimal
-
-
-
string
-
no_discount
-
Defines whether no discount is applied
-
-
-
string
-
qty_canceled
-
Items quantity canceled
-
-
-
string
-
qty_invoiced
-
Items quantity invoiced
-
-
-
string
-
qty_ordered
-
Items quantity ordered
-
-
-
string
-
qty_refunded
-
Items quantity refunded
-
-
-
string
-
qty_shipped
-
Items quantity shipped
-
-
-
string
-
cost
-
Cost
-
-
-
string
-
price
-
Price
-
-
-
string
-
base_price
-
Base price
-
-
-
string
-
original_price
-
Original price
-
-
-
string
-
base_original_price
-
Base original price
-
-
-
string
-
tax_percent
-
Tax percent
-
-
-
string
-
tax_amount
-
Tax amount
-
-
-
string
-
base_tax_amount
-
Base tax amount
-
-
-
string
-
tax_invoiced
-
Tax invoiced
-
-
-
string
-
base_tax_invoiced
-
Base tax invoiced
-
-
-
string
-
discount_percent
-
Discount percent
-
-
-
string
-
discount_amount
-
Discount amount
-
-
-
string
-
base_discount_amount
-
Base discount amount
-
-
-
string
-
discount_invoiced
-
Discount invoiced
-
-
-
string
-
base_discount_invoiced
-
Base discount invoiced
-
-
-
string
-
amount_refunded
-
Amount refunded
-
-
-
string
-
base_amount_refunded
-
Base amount refunded
-
-
-
string
-
row_total
-
Row total
-
-
-
string
-
base_row_total
-
Base row total
-
-
-
string
-
row_invoiced
-
Row invoiced
-
-
-
string
-
base_row_invoiced
-
Base row invoiced
-
-
-
string
-
row_weight
-
Row weight
-
-
-
string
-
gift_message_id
-
Gift message ID
-
-
-
string
-
gift_message
-
Gift message
-
-
-
string
-
gift_message_available
-
Defines whether the gift message is available
-
-
-
string
-
base_tax_before_discount
-
Base tax before discount
-
-
-
string
-
tax_before_discount
-
Tax before discount
-
-
-
string
-
weee_tax_applied
-
Applied fixed product tax
-
-
-
string
-
weee_tax_applied_amount
-
Applied fixed product tax amount
-
-
-
string
-
weee_tax_applied_row_amount
-
Applied fixed product tax row amount
-
-
-
string
-
base_weee_tax_applied_amount
-
Applied fixed product tax amount (in base currency)
-
-
-
string
-
base_weee_tax_applied_row_amount
-
Applied fixed product tax row amount (in base currency)
-
-
-
string
-
weee_tax_disposition
-
Fixed product tax disposition
-
-
-
string
-
weee_tax_row_disposition
-
Fixed product tax row disposition
-
-
-
string
-
base_weee_tax_disposition
-
Fixed product tax disposition (in base currency)
-
-
-
string
-
base_weee_tax_row_disposition
-
Fixed product tax row disposition (in base currency)
-
-
-
-
-
The salesOrderPaymentEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
is_active
-
Active flag
-
-
-
string
-
amount_ordered
-
Amount ordered
-
-
-
string
-
shipping_amount
-
Shipping amount
-
-
-
string
-
base_amount_ordered
-
Base amount ordered
-
-
-
string
-
base_shipping_amount
-
Base shipping amount
-
-
-
string
-
method
-
Payment method
-
-
-
string
-
po_number
-
Purchase order number
-
-
-
string
-
cc_type
-
Credit card type
-
-
-
string
-
cc_number_enc
-
Credit card number
-
-
-
string
-
cc_last4
-
Credit card last 4 digits
-
-
-
string
-
cc_owner
-
Credit card owner
-
-
-
string
-
cc_exp_month
-
Credit card expiration month
-
-
-
string
-
cc_exp_year
-
Credit card expiration year
-
-
-
string
-
cc_ss_start_month
-
Credit card start month (Switch/Solo)
-
-
-
string
-
cc_ss_start_year
-
Credit card start year (Switch/Solo)
-
-
-
string
-
payment_id
-
Payment ID
-
-
-
-
-
The salesOrderStatusHistoryEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
is_active
-
Active flag
-
-
-
string
-
is_customer_notified
-
Defines whether the customer is notified
-
-
-
string
-
status
-
Order status
-
-
-
string
-
comment
-
Order comment
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order.info', 'orderIncrementId');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderInfo($sessionId, '200000006');
-var_dump($result);
-
-
diff --git a/guides/m1x/api/soap/sales/salesOrder/sales_order.list.html b/guides/m1x/api/soap/sales/salesOrder/sales_order.list.html
deleted file mode 100644
index a3a2e1841e..0000000000
--- a/guides/m1x/api/soap/sales/salesOrder/sales_order.list.html
+++ /dev/null
@@ -1,550 +0,0 @@
----
-layout: m1x_soap
-title: Order List
----
-
-
Module: Mage_Sales
-
-
-
Resource: sales_order
-
-
Aliases:
-
-
order
-
-
-
-
Method:
-
-
-
sales_order.list (SOAP V1)
-
salesOrderList (SOAP V2)
-
-
-
-
Allows you to retrieve the list of orders. Additional filters can be applied.
-
-
Aliases:
-
-
order.list
-
salesOrderList (SOAP V2 method name)
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
array
-
filters
-
Array of filters for the list of sales orders (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
name
-
Description
-
-
-
array
-
result
-
Array of salesOrderEntity
-
-
-
-
-
The salesOrderEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
store_id
-
Store ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
is_active
-
Defines whether the order is active
-
-
-
string
-
customer_id
-
Customer ID
-
-
-
string
-
tax_amount
-
Tax amount
-
-
-
string
-
shipping_amount
-
Shipping amount
-
-
-
string
-
discount_amount
-
Discount amount
-
-
-
string
-
subtotal
-
Subtotal sum
-
-
-
string
-
grand_total
-
Grand total sum
-
-
-
string
-
total_paid
-
Total paid
-
-
-
string
-
total_refunded
-
Total refunded
-
-
-
string
-
total_qty_ordered
-
Total quantity ordered
-
-
-
string
-
total_canceled
-
Total canceled
-
-
-
string
-
total_invoiced
-
Total invoiced
-
-
-
string
-
total_online_refunded
-
Total online refunded
-
-
-
string
-
total_offline_refunded
-
Total offline refunded
-
-
-
string
-
base_tax_amount
-
Base tax amount
-
-
-
string
-
base_shipping_amount
-
Base shipping amount
-
-
-
string
-
base_discount_amount
-
Base discount amount
-
-
-
string
-
base_subtotal
-
Base subtotal
-
-
-
string
-
base_grand_total
-
Base grand total
-
-
-
string
-
base_total_paid
-
Base total paid
-
-
-
string
-
base_total_refunded
-
Base total refunded
-
-
-
string
-
base_total_qty_ordered
-
Base total quantity ordered
-
-
-
string
-
base_total_canceled
-
Base total canceled
-
-
-
string
-
base_total_invoiced
-
Base total invoiced
-
-
-
string
-
base_total_online_refunded
-
Base total online refunded
-
-
-
string
-
base_total_offline_refunded
-
Base total offline refunded
-
-
-
string
-
billing_address_id
-
Billing address ID
-
-
-
string
-
billing_firstname
-
First name in the billing address
-
-
-
string
-
billing_lastname
-
Last name in the billing address
-
-
-
string
-
shipping_address_id
-
Shipping address ID
-
-
-
string
-
shipping_firstname
-
First name in the shipping address
-
-
-
string
-
shipping_lastname
-
Last name in the shipping address
-
-
-
string
-
billing_name
-
Billing name
-
-
-
string
-
shipping_name
-
Shipping name
-
-
-
string
-
store_to_base_rate
-
Store to base rate
-
-
-
string
-
store_to_order_rate
-
Store to order rate
-
-
-
string
-
base_to_global_rate
-
Base to global rate
-
-
-
string
-
base_to_order_rate
-
Base to order rate
-
-
-
string
-
weight
-
Weight
-
-
-
string
-
store_name
-
Store name
-
-
-
string
-
remote_ip
-
Remote IP
-
-
-
string
-
status
-
Order status
-
-
-
string
-
state
-
Order state
-
-
-
string
-
applied_rule_ids
-
Applied rule IDs
-
-
-
string
-
global_currency_code
-
Global currency code
-
-
-
string
-
base_currency_code
-
Base currency code
-
-
-
string
-
store_currency_code
-
Store currency code
-
-
-
string
-
order_currency_code
-
Order currency code
-
-
-
string
-
shipping_method
-
Shipping method
-
-
-
string
-
shipping_description
-
Shipping description
-
-
-
string
-
customer_email
-
Email address of the customer
-
-
-
string
-
customer_firstname
-
Customer first name
-
-
-
string
-
customer_lastname
-
Customer last name
-
-
-
string
-
quote_id
-
Shopping cart ID
-
-
-
string
-
is_virtual
-
Defines whether the product is a virtual one
-
-
-
string
-
customer_group_id
-
Customer group ID
-
-
-
string
-
customer_note_notify
-
Customer notification
-
-
-
string
-
customer_is_guest
-
Defines whether the customer is a guest
-
-
-
string
-
email_sent
-
Defines whether the email notification is sent
-
-
-
string
-
order_id
-
Order ID
-
-
-
string
-
gift_message_id
-
Gift message ID
-
-
-
string
-
gift_message
-
Gift message
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'order.list');
-var_dump ($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order.unhold', '200000006');
-var_dump($result);
Allows you to create a new credit memo for the invoiced order. Comments can be added and an email notification can be sent to the user email.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
orderIncrementId
-
Order increment ID
-
-
-
array
-
creditmemoData
-
Array of salesOrderCreditmemoData (optional)
-
-
-
string
-
comment
-
Comment text (optional)
-
-
-
int
-
notifyCustomer
-
Notify customer by email flag (optional)
-
-
-
int
-
includeComment
-
Include comment text into an email notification (optional)
-
-
-
string
-
refundToStoreCreditAmount
-
Payment amount to be refunded to the customer store credit (optional)
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
result
-
Created credit memo increment ID
-
-
-
-
-
The salesOrderCreditmemoData content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
qtys
-
Array of orderItemIdQty
-
-
-
double
-
shipping_amount
-
Refund shipping amount (optional)
-
-
-
double
-
adjustment_positive
-
Adjustment refund amount (optional)
-
-
-
double
-
adjustment_negative
-
Adjustment fee amount (optional)
-
-
-
-
-
The orderItemIdQty content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
order_item_id
-
Order item ID to be refunded
-
-
-
double
-
qty
-
Items quantity to be refunded
-
-
-
-
-
Faults:
-
-
-
-
-
Fault Code
-
Fault Message
-
-
-
102
-
Invalid data given. Details in error message.
-
-
-
103
-
Requested order does not exist.
-
-
-
105
-
Money can not be refunded to the store credit account as order was created by guest.
-
-
-
106
-
Credit memo for requested order can not be created.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'order_creditmemo.create', '200000010');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderCreditmemoCreate($sessionId, '200000010');
-var_dump($result);
Allows you to retrieve full information about the specified credit memo.
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
creditmemoIncrementId
-
Credit memo increment ID
-
-
-
-
-
Return:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of salesOrderCreditmemoEntity
-
-
-
-
-
The salesOrderCreditmemoEntity content is as follows:
-
-
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
transaction_id
-
Transaction ID
-
-
-
string
-
global_currency_code
-
Global currency code
-
-
-
string
-
base_currency_code
-
Base currency code
-
-
-
string
-
order_currency_code
-
Order currency code
-
-
-
string
-
store_currency_code
-
Store currency code
-
-
-
string
-
cybersource_token
-
Cybersource token
-
-
-
string
-
invoice_id
-
ID of the invoice for which the credit memo was created
-
-
-
string
-
billing_address_id
-
Billing address ID
-
-
-
string
-
shipping_address_id
-
Shipping address ID
-
-
-
string
-
state
-
State
-
-
-
string
-
creditmemo_status
-
Credit memo status
-
-
-
string
-
email_sent
-
Defines whether the email is sent
-
-
-
string
-
order_id
-
ID of the order for which the credit memo was created
-
-
-
string
-
tax_amount
-
Tax amount
-
-
-
string
-
shipping_tax_amount
-
Shipping tax amount
-
-
-
string
-
base_tax_amount
-
Base tax amount
-
-
-
string
-
base_adjustment_positive
-
Adjustment refund amount (using base currency)
-
-
-
string
-
base_grand_total
-
Base grand total
-
-
-
string
-
adjustment
-
Adjustment
-
-
-
string
-
subtotal
-
Subtotal
-
-
-
string
-
discount_amount
-
Discount amount
-
-
-
string
-
base_subtotal
-
Base subtotal
-
-
-
string
-
base_adjustment
-
Base adjustment
-
-
-
string
-
base_to_global_rate
-
Base to global rate
-
-
-
string
-
store_to_base_rate
-
Store to base rate
-
-
-
string
-
base_shipping_amount
-
Base shipping amount
-
-
-
string
-
adjustment_negative
-
Adjustment fee amount
-
-
-
string
-
subtotal_incl_tax
-
Subtotal including tax
-
-
-
string
-
shipping_amount
-
Shipping amount
-
-
-
string
-
base_subtotal_incl_tax
-
Base subtotal including tax
-
-
-
string
-
base_adjustment_negative
-
Adjustment fee amount (using base currency)
-
-
-
string
-
grand_total
-
Grand total
-
-
-
string
-
base_discount_amount
-
Base discount amount
-
-
-
string
-
base_to_order_rate
-
Base to order rate
-
-
-
string
-
store_to_order_rate
-
Store to order rate
-
-
-
string
-
base_shipping_tax_amount
-
Base shipping tax amount
-
-
-
string
-
adjustment_positive
-
Adjustment refund amount
-
-
-
string
-
store_id
-
Store ID
-
-
-
string
-
hidden_tax_amount
-
Hidden tax amount
-
-
-
string
-
base_hidden_tax_amount
-
Base hidden tax amount
-
-
-
string
-
shipping_hidden_tax_amount
-
Shipping hidden tax amount
-
-
-
string
-
base_shipping_hidden_tax_amnt
-
Base shipping hidden tax amount
-
-
-
string
-
shipping_incl_tax
-
Shipping including tax
-
-
-
string
-
base_shipping_incl_tax
-
Base shipping including tax
-
-
-
string
-
base_customer_balance_amount
-
Base customer balance amount
-
-
-
string
-
customer_balance_amount
-
Customer balance amount
-
-
-
string
-
bs_customer_bal_total_refunded
-
Refunded base customer balance amount
-
-
-
string
-
customer_bal_total_refunded
-
Customer balance total refunded
-
-
-
string
-
base_gift_cards_amount
-
Base gift cards amount
-
-
-
string
-
gift_cards_amount
-
Gift cards amount
-
-
-
string
-
gw_base_price
-
Gift wrapping price refunded amount (using base currency)
-
-
-
string
-
gw_price
-
Gift wrapping price refunded amount
-
-
-
string
-
gw_items_base_price
-
Gift wrapping items base price
-
-
-
string
-
gw_items_price
-
Gift wrapping items price
-
-
-
string
-
gw_card_base_price
-
Gift wrapping card base price
-
-
-
string
-
gw_card_price
-
Gift wrapping card price
-
-
-
string
-
gw_base_tax_amount
-
Gift wrapping tax amount refunded (using base currency)
-
-
-
string
-
gw_tax_amount
-
Gift wrapping tax amount refunded
-
-
-
string
-
gw_items_base_tax_amount
-
Gift wrapping items base tax amount
-
-
-
string
-
gw_items_tax_amount
-
Gift wrapping items tax amount
-
-
-
string
-
gw_card_base_tax_amount
-
Gift wrapping card base tax amount
-
-
-
string
-
gw_card_tax_amount
-
Gift wrapping card tax amount
-
-
-
string
-
base_reward_currency_amount
-
Base reward currency amount
-
-
-
string
-
reward_currency_amount
-
Reward currency amount
-
-
-
string
-
reward_points_balance
-
Reward points balance
-
-
-
string
-
reward_points_balance_refund
-
Reward points balance refund
-
-
-
string
-
creditmemo_id
-
Credit memo ID
-
-
-
array
-
items
-
Array of salesOrderCreditmemoItemEntity
-
-
-
array
-
comments
-
Array of salesOrderCreditmemoCommentEntity
-
-
-
-
-
-
The salesOrderCreditmemoItemEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
item_id
-
Credit memo item ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
weee_tax_applied_row_amount
-
Applied fixed product tax row amount
-
-
-
string
-
base_price
-
Base price
-
-
-
string
-
base_weee_tax_row_disposition
-
Fixed product tax row disposition (in base currency)
-
-
-
string
-
tax_amount
-
Tax amount
-
-
-
string
-
base_weee_tax_applied_amount
-
Applied fixed product tax amount (in base currency)
-
-
-
string
-
weee_tax_row_disposition
-
Fixed product tax row disposition
-
-
-
string
-
base_row_total
-
Base row total
-
-
-
string
-
discount_amount
-
Discount amount
-
-
-
string
-
row_total
-
Row total
-
-
-
string
-
weee_tax_applied_amount
-
Applied fixed product tax amount
-
-
-
string
-
base_discount_amount
-
Base discount amount
-
-
-
string
-
base_weee_tax_disposition
-
Fixed product tax disposition (in base currency)
-
-
-
string
-
price_incl_tax
-
Price including tax
-
-
-
string
-
base_tax_amount
-
Base tax amount
-
-
-
string
-
weee_tax_disposition
-
Fixed product tax disposition
-
-
-
string
-
base_price_incl_tax
-
Base price including tax
-
-
-
string
-
qty
-
Quantity
-
-
-
string
-
base_cost
-
Base cost
-
-
-
string
-
base_weee_tax_applied_row_amount
-
Applied fixed product tax row amount (in base currency)
-
-
-
string
-
price
-
Price
-
-
-
string
-
base_row_total_incl_tax
-
Base row total including tax
-
-
-
string
-
row_total_incl_tax
-
Row total including tax
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
order_item_id
-
Order item ID
-
-
-
string
-
additional_data
-
Additional data
-
-
-
string
-
description
-
Description
-
-
-
string
-
weee_tax_applied
-
Applied fixed product tax
-
-
-
string
-
sku
-
Item SKU
-
-
-
string
-
name
-
Name
-
-
-
string
-
hidden_tax_amount
-
Hidden tax amount
-
-
-
string
-
base_hidden_tax_amount
-
Base hidden tax amount
-
-
-
-
-
The salesOrderCreditmemoCommentEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
comment
-
Comment data
-
-
-
string
-
is_customer_notified
-
Defines whether the customer is notified
-
-
-
string
-
comment_id
-
Comment ID
-
-
-
string
-
is_visible_on_front
-
Defines whether the comment is visible on the frontend
-
-
-
-
-
Faults:
-
-
-
-
Fault Code
-
Fault Description
-
-
-
100
-
Requested credit memo does not exist.
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'order_creditmemo.info', '200000001');
-var_dump ($result);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderCreditmemoInfo($sessionId, '200000001');
-var_dump($result);
Allows you to add a new comment to the order invoice.
-
-
Aliases:
-
-
order_invoice.addComment
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
invoiceIncrementId
-
Invoice increment ID
-
-
-
string
-
comment
-
Invoice comment (optional)
-
-
-
int
-
email
-
Send invoice on email flag (optional)
-
-
-
int
-
includeComment
-
Include comment in email flag (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean
-
True if the comment is added to the invoice
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apikey');
-
-$result = $client->call($session, 'sales_order_invoice.addComment', array('invoiceIncrementId' => '200000006', 'comment' => 'invoice comment'));
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderInvoiceAddComment($sessionId, '200000006');
-var_dump($result);
Allows you to cancel the required invoice. Note that not all order invoices can be canceled. Only some payment methods support canceling the order invoice (e.g., Google Checkout, PayPal Pro, PayPal Express Checkout).
Allows you to capture the required invoice. Note that not all order invoices can be captured. Only some payment methods support capturing the order invoice (e.g., PayPal Pro).
-
-
Aliases:
-
-
order_invoice.capture
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
invoiceIncrementId
-
Invoice increment ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean\int
-
True (1) if the order invoice is captured.
-
-
-
-
-
-
Notes:
-
-
You should check the invoice to see if it can be captured before attempting to capture the invoice. Otherwise, the API call will generate an error.
-
-
Invoices have states as defined in the model Mage_Sales_Model_Order_Invoice:
-
-
STATE_OPEN = 1
-
STATE_PAID = 2
-
STATE_CANCELED = 3
-
-
-
-
Also note that there is a method call in the model that checks this for you - canCapture(). And it also verifies that the payment can be captured, so the invoice state might not be the only condition that is required to allow it to be captured.
Array of orderItemIdQty (quantity of items to invoice)
-
-
-
string
-
comment
-
Invoice comment (optional)
-
-
-
string
-
email
-
Send invoice on email (optional)
-
-
-
string
-
includeComment
-
Include comments in email (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
string
-
ID of the created invoice
-
-
-
-
-
The orderItemIdQty content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
int
-
order_item_id
-
Order item ID
-
-
-
double
-
qty
-
Quantity
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call(
- $session,
- 'sales_order_invoice.create',
- array('orderIncrementId' => '200000008', array('15' => '1', '16' => '1'))
- // orderItemIdQty Array is Keyed with Order Item ID, with Value of qty to invoice
-);
-var_dump ($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-//Create invoice for order
-
-// orderItemIdQty Array is Keyed with Order Item ID, with Value of qty to invoice
-$qty = array('15' => '1', '16' => '1');
-
-$invoiceIncrementId = $proxy->salesOrderInvoiceCreate(
- $sessionID,
- '200000008',
- Â $qty
-);
-var_dump($invoiceIncrementId);
Allows you to retrieve information about the required invoice.
-
-
Aliases:
-
-
order_invoice.info
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
invoiceIncrementId
-
Invoice increment ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of salesOrderInvoiceEntity
-
-
-
-
-
The salesOrderInvoiceEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
store_id
-
Store ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
is_active
-
Defines whether the invoice is active
-
-
-
string
-
global_currency_code
-
Global currency code
-
-
-
string
-
base_currency_code
-
Base currency code
-
-
-
string
-
store_currency_code
-
Store currency code
-
-
-
string
-
order_currency_code
-
Order currency code
-
-
-
string
-
store_to_base_rate
-
Store to base rate
-
-
-
string
-
store_to_order_rate
-
Store to order rate
-
-
-
string
-
base_to_global_rate
-
Base to global rate
-
-
-
string
-
base_to_order_rate
-
Base to order rate
-
-
-
string
-
subtotal
-
Subtotal
-
-
-
string
-
base_subtotal
-
Base subtotal
-
-
-
string
-
base_grand_total
-
Base grand total
-
-
-
string
-
discount_amount
-
Discount amount
-
-
-
string
-
base_discount_amount
-
Base discount amount
-
-
-
string
-
shipping_amount
-
Shipping amount
-
-
-
string
-
base_shipping_amount
-
Base shipping amount
-
-
-
string
-
tax_amount
-
Tax amount
-
-
-
string
-
base_tax_amount
-
Base tax amount
-
-
-
string
-
billing_address_id
-
Billing address ID
-
-
-
string
-
billing_firstname
-
First name in the billing address
-
-
-
string
-
billing_lastname
-
Last name in the billing address
-
-
-
string
-
order_id
-
Order ID
-
-
-
string
-
order_increment_id
-
Order increment ID
-
-
-
string
-
order_created_at
-
Date of order creation
-
-
-
string
-
state
-
Order state
-
-
-
string
-
grand_total
-
Grand total
-
-
-
string
-
invoice_id
-
Invoice ID
-
-
-
array
-
items
-
Array of salesOrderInvoiceItemEntity
-
-
-
array
-
comments
-
Array of salesOrderInvoiceCommentEntity
-
-
-
-
-
The salesOrderInvoiceItemEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
is_active
-
Active flag
-
-
-
string
-
weee_tax_applied
-
Applied fixed product tax
-
-
-
string
-
qty
-
Quantity
-
-
-
string
-
cost
-
Cost
-
-
-
string
-
price
-
Price
-
-
-
string
-
tax_amount
-
Tax amount
-
-
-
string
-
row_total
-
Row total
-
-
-
string
-
base_price
-
Base price
-
-
-
string
-
base_tax_amount
-
Base tax amount
-
-
-
string
-
base_row_total
-
Base row total
-
-
-
string
-
base_weee_tax_applied_amount
-
Applied fixed product tax amount (in base currency)
-
-
-
string
-
base_weee_tax_applied_row_amount
-
Applied fixed product tax row amount (in base currency)
-
-
-
string
-
weee_tax_applied_amount
-
Applied fixed product tax amount
-
-
-
string
-
weee_tax_applied_row_amount
-
Applied fixed product tax row amount
-
-
-
string
-
weee_tax_disposition
-
Fixed product tax disposition
-
-
-
string
-
weee_tax_row_disposition
-
Fixed product tax row disposition
-
-
-
string
-
base_weee_tax_disposition
-
Fixed product tax disposition (in base currency)
-
-
-
string
-
base_weee_tax_row_disposition
-
Fixed product tax row disposition (in base currency)
-
-
-
string
-
sku
-
SKU
-
-
-
string
-
name
-
Name
-
-
-
string
-
order_item_id
-
Order item ID
-
-
-
string
-
product_id
-
Product ID
-
-
-
string
-
item_id
-
Item ID
-
-
-
-
-
The salesOrderInvoiceCommentEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
parent_id
-
Parent ID
-
-
-
string
-
created_at
-
Date of creation
-
-
-
string
-
updated_at
-
Date of updating
-
-
-
string
-
is_active
-
Active flag
-
-
-
string
-
comment
-
Invoice comment
-
-
-
string
-
is_customer_notified
-
Defines whether the customer is notified
-
-
-
string
-
comment_id
-
Comment ID
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order_invoice.info', '200000006');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderInvoiceInfo($sessionId, '200000006');
-var_dump($result);
Allows you to retrieve the list of order invoices. Additional filters can also be applied.
-
-
Aliases:
-
-
order_invoice.list
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
array
-
filters
-
Array of filters for the list of invoices (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of salesOrderInvoiceEntity
-
-
-
-
-
The salesOrderInvoiceEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
created_at
-
Date of invoice creation
-
-
-
string
-
order_currency_code
-
Order currency code (e.g., EUR)
-
-
-
string
-
order_id
-
Order ID
-
-
-
string
-
state
-
Order state
-
-
-
string
-
grand_total
-
Grand total amount invoiced
-
-
-
string
-
invoice_id
-
Invoice ID
-
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order_invoice.list');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2 (List of All Invoices)
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderInvoiceList($sessionId);
-var_dump($result);
-
-
-
-
Request Example SOAP V2 (Complex Filter)
-
-
-
-
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-$complexFilter = array(
- 'complex_filter' => array(
- array(
- 'key' => 'state',
- 'value' => array('key' => 'in', 'value' => '2,3')
- )
- )
-);
-$result = $client->salesOrderInvoiceList($session, $complexFilter);
-
-var_dump ($result);
Allows you to add a new comment to the order shipment.
-
-
Aliases:
-
-
order_shipment.addComment
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
shipmentIncrementId
-
Shipment increment ID
-
-
-
string
-
comment
-
Shipment comment (optional)
-
-
-
string
-
email
-
Send email flag (optional)
-
-
-
string
-
includeInEmail
-
Include comment in email flag (optional)
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean\int
-
True (1) if the comment is added to the order shipment
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order_shipment.addComment', array('shipmentIncrementId' => '200000002', 'comment' => 'comment for the shipment', 'email' => null));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderShipmentAddComment($sessionId, '200000002');
-var_dump($result);
Allows you to add a new tracking number to the order shipment.
-
-
Aliases:
-
-
order_shipment.addTrack
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
shipmentIncrementId
-
Shipment increment ID
-
-
-
string
-
carrier
-
Carrier code (ups, usps, dhl, fedex, or dhlint)
-
-
-
string
-
title
-
Tracking title
-
-
-
string
-
trackNumber
-
Tracking number
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
int
-
Tracking number ID
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order_shipment.addTrack', array('shipmentIncrementId' => '200000002', 'carrier' => 'ups', 'title' => 'tracking title', 'trackNumber' => '123123'));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderShipmentAddTrack($sessionId, '200000002', 'ups', 'tracking title', '123123');
-var_dump($result);
Allows you to retrieve the list of allowed carriers for an order.
-
-
Aliases:
-
-
order_shipment.getCarriers
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
orderIncrementId
-
Order increment ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
associativeArray
-
result
-
Array of carriers
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order_shipment.getCarriers', '200000010');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderShipmentGetCarriers($sessionId, '200000010');
-var_dump($result);
Allows you to retrieve the list of order shipments. Additional filters can be applied.
-
-
Aliases:
-
-
order_shipment.list
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
array
-
filters
-
Array of filters for the list of shipments
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Name
-
Description
-
-
-
array
-
result
-
Array of salesOrderShipmentEntity
-
-
-
-
-
The salesOrderShipmentEntity content is as follows:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
increment_id
-
Increment ID
-
-
-
string
-
created_at
-
Date of shipment creation
-
-
-
string
-
total_qty
-
Total quantity of items to ship
-
-
-
string
-
shipment_id
-
Shipment ID
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order_shipment.list');
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2 (List of All Shipments)
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderShipmentList($sessionId);
-var_dump($result);
-
-
-
-
Request Example SOAP V2 (Complex Filter)
-
-
-
-
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
-
-// If some stuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-$complexFilter = array(
- 'complex_filter' => array(
- array(
- 'key' => 'created_at',
- 'value' => array('key' => 'in', 'value' => '2012-03-30 12:54:46')
- )
- )
-);
-$result = $client->salesOrderShipmentList($session, $complexFilter);
-
-var_dump ($result);
Allows you to remove a tracking number from the order shipment.
-
-
Aliases:
-
-
order_shipment.removeTrack
-
-
-
-
-
Arguments:
-
-
-
-
Type
-
Name
-
Description
-
-
-
string
-
sessionId
-
Session ID
-
-
-
string
-
shipmentIncrementId
-
Shipment increment ID
-
-
-
string
-
trackId
-
Track ID
-
-
-
-
-
Returns:
-
-
-
-
Type
-
Description
-
-
-
boolean\int
-
True (1) if the tracking number is removed from the shipment
-
-
-
-
-
-
Examples
-
-
Request Example SOAP V1
-
-
-
-
-
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
-
-// If somestuff requires API authentication,
-// then get a session token
-$session = $client->login('apiUser', 'apiKey');
-
-$result = $client->call($session, 'sales_order_shipment.removeTrack', array('shipmentIncrementId' => '200000002', 'trackId' => '2'));
-var_dump($result);
-
-// If you don't need the session anymore
-//$client->endSession($session);
-
-
-
-
Request Example SOAP V2
-
-
-
-
-
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
-$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
-
-$result = $proxy->salesOrderShipmentRemoveTrack($sessionId, '200000002', '2');
-var_dump($result);
Magento provides you with the ability to use two modes for SOAP API V2. These are with WS-I compliance mode enabled and WS-I compliance mode disabled. The first one was introduced to make the system flexible, namely, to increase compatibility with .NET and Java programming languages.
-
-
To enable/disable the WS-I compliance mode, perform the following steps:
-
-
In the Magento Admin Panel, go to System > Configuration > Magento Core API.
-
In the WS-I Compliance drop-down, select Yes to enable the WS-I compliance mode and No to disable the WS-I compliance mode, correspondingly.
-
-
-
-
-
The WS-I compliant mode uses the same WSDL endpoint as SOAP API V2 does. The key difference is that XML namespaces are used in WS-I compliance mode.
-
-
-
WSDL file with disabled WS-I compliance mode:
-
-
-
WSDL file with enabled WS-I compliance mode:
-
-
-
\ No newline at end of file
diff --git a/guides/m1x/ce18-ee113-home.html b/guides/m1x/ce18-ee113-home.html
deleted file mode 100644
index 89b56eadb0..0000000000
--- a/guides/m1x/ce18-ee113-home.html
+++ /dev/null
@@ -1,83 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
- Magento Community Edition (CE) 1.8 and Enterprise Edition (EE) 1.13 Documentation Home
-
-
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
-
Magento Community Edition (CE) 1.8 and Enterprise Edition (EE) 1.13 Documentation Home
Welcome to the documentation home page for the Magento Enterprise Edition (EE) 1.13 and Community Edition (CE) 1.8 releases! Let's start out by telling you a little bit about them.
-
Magento recognizes that merchants and systems integrators require higher performance in key areas—such as product search, product browsing, and checkout. Merchants and integrators are now commonly coming to Magento with:
-
Large databases (that is, more than one million products)
-
Heavy traffic volume
-
Frequent merchandising updates
-
Extensive marketing and promotion campaigns
-
Many web stores to address their customers' needs
-
To address these ever-growing needs, Magento systematically examined performance and scalability characteristics. Our engineers continually measured performance on a range of environments and use cases to identify and remove bottlenecks, and then conducted extensive testing to confirm improvements.
-
We characterized performance based on variations in deployment and business configurations to ensure improvement for a range of merchant sizes and configurations.
-
In this release, we focused primarily on improvements to indexing, tax calculations, caching, and checkout performance.
-
We're excited about the changes you'll find, including:
-
Reindexing (Enterprise Edition only):
-
Most indexing processes now run only to update products, categories, URL redirects, and so on that have changed—eliminating the need for manual full reindexing
-
Your Magento web store is not locked at any point during reindexing
-
Reindexing is now a background process.
-
-
Caching (Enterprise Edition only):
-
Full page caching now invalidates only pages that are affected by product or category changes
-
Improved cache adapter for single-host systems
-
Additional option of using Redis NoSQL for cache and session storage in multi-host deployments (recommended for new deployments)
The focus of the Magento Enterprise Edition 1.13 release is performance and scalability. The benchmarking results
- presented here demonstrate that we have addressed the following concerns:
-
-
-
The eCommerce landscape is changing, and merchants must provide customers with an online shopping experience
- that meets their performance expectations
-
-
As merchants grow their businesses and increasingly larger enterprise merchants are adopting Magento,
- Magento Enterprise Edition must scale to handle increased traffic volume and larger catalogs
-
-
-
-
Magento's Plan
-
-
We identified the following areas for enhancement in Magento Enterprise Edition 1.13:
-
-
-
Improve indexing for catalogs of all sizes
-
Make re-indexing operations invisible to the shopper by executing them in the background
-
Improve full page caching support
-
Reduce page load times for key shopping flows (checkout)
-
Enable merchants to serve heavier traffic volume without need to purchase additional hardware
-
-
-
What Magento
- Accomplished
-
-
Magento Enterprise Edition 1.13 delivers the following improvements over Magento Enterprise Edition 1.12:
-
-
-
Incremental re-indexing has been introduced with Magento Enterprise Edition 1.13, and scenarios where
- full-re-indexing was required have been limited. This means that operations that previously took hours can
- now be completed in minutes
-
-
53% improvement in completion times for a full re-index with a 500,000 SKU catalog
-
35% improvement in "Place Order" performance
-
65% improvement in page load times across shopper flow pages that were tested.
-
-
-
-
33% improvement in orders per day that can be processed on the same hardware configuration as Magento
- Enterprise Edition 1.12
-
-
31% improvement in page views per day supported on the same hardware configuration on Magento Enterprise
- Edition 1.12
-
-
-
-
Multi-Node Deployment
- Topology
-
-
Before we introduce you to the benchmarks, an overview of our multi-node benchmarking facility is in order. We
- started with a basic multi-node cluster with load balancer and caching and separate DB node, and installed
- Apache. This is a familiar hardware configuration for the Magento developer community. Once provisioned, we
- installed both Magento Enterprise Edition 1.13 and Magento Enterprise Edition 1.12 on the cluster to compare
- their performance.
-
-
This is a representation of the multi-node Magento Enterprise Edition 1.12/1.13 installation used for performance
- testing. It consists of four physical nodes, three of which are virtualized.
-
-
-
-
-
-
We used HP ProLiant SL230s Gen8 servers with 8x16GB DDR3 and 2x Intel Xeon E5â€2660 CPUs for our benchmarking.
-
-
We used a physical disk of a usable 1.2 TB managed by a RAID10 controller. The load balancer we used is
- nginx.
-
-
The cluster resides in our Las Vegas data center, connected to the Internet via a gigabit connection. We tested
- the cluster using the popular Gatling suite from our engineering offices in Austin, TX.
-
-
Software Components
-
-
-
-
-
-
-
Scenarios
-
-
This section presents the merchant scenarios we simulated for our testing. These scenarios are based on
- real-world experience and industry standards with respect to shopper flows and catalog sizes.
-
-
Shopper Flows
-
-
We used real-world, established eCommerce metrics to simulate shopper flows.
-
-
-
94% of eCommerce shoppers visited a storefront but did not purchase any products
-
65% of shoppers added items to their carts but abandoned them
-
Of the 6% who did purchase products (otherwise known as the conversion rate), half checked out as guests
- without signing in, and half signed into the storefront.
-
-
-
-
-
-
-
-
Catalog
-
-
The catalogs we simulated also reflect real-world, established eCommerce experience.
-
-
-
We simulated small and medium-sized companies with a 50,000-item catalog with 27 product categories.
-
We simulated large companies 500,000 items in the catalog with 2,000 categories.
-
As many eCommerce sites offer different types of products, we specified physical (simple) products, virtual
- products, and downloadable products, with 60% of the products in each catalog being physical.
-
-
We benchmarked each catalog on one website/storefront.
-
-
-
-
-
-
-
Target Merchant
- Profile
-
-
The simulated merchant profile we benchmarked against represents the profile of our enterprise customers. We
- established these metrics based on the day-to-day experience of large merchants operating a successful eCommerce
- business. Again, we used what we consider to be a typical hardware and software configuration.
-
-
-
50K visitors / day
-
1M Page views / day
-
18000 orders / day
-
3000 orders during peak 4 hours
-
1000 concurrent users
-
Standard HW/SW configuration
-
-
-
Benchmarking Results
-
-
-
These benchmarks were generated during extensive testing of our multi-node configuration running Magento
- Enterprise Edition 1.13 described above. Our configuration was modeled after what a commercial hosting partner
- would put into production, and the results reflect accurate gains over Magento Enterprise Edition 1.12.
-
-
The duration of the test sessions is 72 seconds, which significantly stresses the multi-node configuration.
-
-
Incremental
- Re-indexing
-
-
In Magento Enterprise Edition 1.12, any change to a product would result in a full re-index. Magento Enterprise
- Edition 1.13 introduces a new feature--incremental re-indexing. With incremental re-indexing, only those items
- that were changed or added will be re-indexed, reducing the processing time to a fraction of what was required
- before.
-
-
Take the example of a merchant with a catalog containing 500,000 products. In Magento Enterprise Edition 1.12,
- any change to a product would result in a full re-index operation. In Magento Enterprise Edition 1.13,
- incremental re-indexing means the merchant will only re-index items that were changed. The test focused on
- measuring the improvements provided by the incremental re-indexing feature in Magento Enterprise Edition 1.13.
- The table below compares improvements to common admin actions, such as changing a product description, prices or
- inventory.
-
-
-
-
-
-
Full Re-indexing
-
-
-
As part of the benchmarking effort, we also measured the improvements in the full re-indexing feature on Magento
- Enterprise Edition 1.13, where indexing a 500,000-item catalog was 53% faster than Magento Enterprise Edition
- 1.12. Faster re-indexing means less load on the system and that changes to the catalog propagate faster to the
- storefront.
-
-
-
-
-
-
-
500,000 products
-
2,000 categories
-
One store
-
One catalog update during test run
-
-
-
Individual
- Re-indexers
-
-
The Magento Enterprise Edition 1.13 indexer component contains a number of individual indexers such as Product
- Flat Data and Product Price. When a Magento admin changes the price of a product, it is only necessary to
- execute the Product Price indexer for pricing changes to propagate to the frontend. The completion times of
- these individual indexers were measured in the benchmark environment for Magento Enterprise Edition 1.13 and
- Magento Enterprise Edition 1.12.
-
-
This section presents the results for full re-index completion times for the individual indexers in Magento
- Enterprise Edition 1.13 compared to Magento Enterprise Edition 1.12.
-
-
-
-
-
-
-
URL Rewrite failed to run in Magento Enterprise Edition 1.12 but takes only 0.15 sec in Magento Enterprise
- Edition 1.13
-
-
Catalog description: 500,000 products, 2000 categories, one storefront
-
-
-
Page Load Times
-
-
When Magento Enterprise Edition 1.12 and Magento Enterprise Edition 1.13 were compared, with both running on our
- multi-node benchmarking configuration, Magento Enterprise Edition 1.13 loaded pages 65% faster than Magento
- Enterprise Edition 1.12.
-
-
Guest checkout and registered user checkout are two flows that are crucial to storefront operation. This section
- presents the results of page load time measurements for these two flows.
-
-
Guest Checkout
- Flow Page Load Times
-
-
In the guest checkout flow pages, Magento Enterprise Edition 1.13 provides a substantial decrease in load times
- over its predecessor, most of the time more than twice as fast.
-
-
-
-
-
-
Registered
- Checkout Flow Page Load Times
-
-
The bar chart below presents the improvements in page load times for registered checkout flow.
-
-
-
-
-
-
Page Views and
- Orders
-
-
In addition to page load times, the benchmark also focused on measuring throughput improvements, particularly
- page views per day and orders per day.
-
-
During our testing, which simulated a storefront running at peak hours, EE 1.13 executed 33% more orders and 31%
- more page views than Magento Enterprise Edition 1.12 on the multi-node benchmarking configuration. Notably,
- Magento Enterprise Edition 1.13 served 47K pages during the test run (10 minutes).
-
-
-
-
-
-
-
10 minute session time
-
-
-
Observations
-
-
What we noted during the benchmarking tests:
-
-
-
The MySQL instance did not show any significant signs of CPU or I/O load during the tests.
-
-
-
The CPU was under 10% and no queries exceeded a 2-second threshold.
-
-
-
Redis and Memcached instances did not exceed a CPU load of 10% during the tests.
-
Web nodes showed high levels of CPU utilization under high load.
-
We anticipate achieving stable scaling by adding additional web nodes to the cluster until the services
- themselves begin to degrade.
-
-
-
-
Conclusion
-
-
Magento Enterprise Edition 1.13 was engineered for performance--and clearly delivers on the goal as measured by
- important metrics.
-
-
-
Indexing is improved to enable faster operations without impacting shopping experience. Merchant
- administrators can add and update products as needed while ensuring product URLs, promotions, navigational
- menus, and product search tools are always up to date.
-
-
The checkout process is improved by reducing page load times for browsing and placing orders. Faster
- checkout can significantly improve your customers’ shopping experience and customer satisfaction, and
- potentially improve your conversion rate.
-
-
Faster page load times means Magento Enterprise Edition 1.13 can support more page views per day and more
- orders per day, potentially increasing your conversion rate.
-
-
-
-
In addition, we have focused on providing these benefits without the need to upgrade existing hardware, improving
- your return on assets and investment.
-
-
Appendix
-
-
Page Load Times
-
- This benchmark report presented analysis of the results produced by the Gatling load generator tool. In this
- appendix, you can see the actual results reported by Gatling. The results were obtained under the following test
- setup, which was designed to push Magento to its limit.
-
-
-
-
-
Concurrent session (users)
-
1000
-
-
-
Peak load duration
-
10 minutes
-
-
-
Session duration
-
72 seconds
-
-
-
CPU utilization
-
95%
-
-
-
-
- CPU utilization is high because session duration was set to 72 seconds for the test. Session duration was set to a
- low value to increase the active load on Magento. A typical e-commerce site will see session durations of five
- minutes or more. Preliminary experiments by the benchmark team have confirmed that using a five-minute session
- duration reduces the CPU utilization to 50-60%.
-
-
-
-
-
-
-
-
Magento EE v1.13
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Requests
-
-
Total
-
OK
-
KO
-
-
Min
-
Max
-
Mean
-
Std Dev
-
95th Pct
-
99th Pct
-
Req/s
-
-
-
Global Information0
-
-
62161
-
62087
-
74
-
-
80
-
12910
-
1735
-
1869
-
5780
-
8060
-
75
-
-
-
product page0
-
-
28573
-
28573
-
0
-
-
80
-
9390
-
709
-
996
-
2670
-
4920
-
34
-
-
-
Click add to cart1
-
-
10458
-
10458
-
0
-
-
440
-
7170
-
1868
-
1139
-
4010
-
4980
-
13
-
-
-
Click add to cart Redirect 12
-
-
10458
-
10458
-
0
-
-
960
-
12910
-
3816
-
2239
-
8050
-
9960
-
13
-
-
-
click checkout3
-
-
3486
-
3486
-
0
-
-
1100
-
10800
-
3459
-
1965
-
7130
-
8970
-
4
-
-
-
Registered Checkout:Login and Pick Address4
-
-
3366
-
3366
-
0
-
-
200
-
7380
-
1155
-
1482
-
4870
-
5900
-
4
-
-
-
Registered Checkout:Login and Pick Address Redirect 15
-
-
3366
-
3366
-
0
-
-
700
-
11440
-
2605
-
1662
-
5640
-
7710
-
4
-
-
-
Guest Checkout start6
-
-
120
-
120
-
0
-
-
360
-
2490
-
908
-
487
-
1860
-
2420
-
0
-
-
-
Registered:Pick Billing Address 17
-
-
120
-
120
-
0
-
-
390
-
4240
-
1457
-
974
-
3510
-
4210
-
0
-
-
-
Registered:Pick Billing Address 2-18
-
-
120
-
120
-
0
-
-
410
-
3690
-
1218
-
685
-
2460
-
3070
-
0
-
-
-
Registered:Pick Billing Address 2-29
-
-
120
-
120
-
0
-
-
400
-
3600
-
1201
-
714
-
2700
-
3510
-
0
-
-
-
Registered:Go to pick Shipping Method10
-
-
120
-
120
-
0
-
-
340
-
2900
-
1072
-
633
-
2330
-
2700
-
0
-
-
-
Guest:Pick Billing Address 111
-
-
120
-
120
-
0
-
-
610
-
4620
-
1688
-
941
-
3580
-
4440
-
0
-
-
-
Guest:Pick Billing Address 212
-
-
120
-
120
-
0
-
-
380
-
3530
-
1049
-
589
-
2050
-
2750
-
0
-
-
-
Guest:Go to pick Shipping Method13
-
-
120
-
120
-
0
-
-
300
-
2080
-
796
-
401
-
1530
-
1960
-
0
-
-
-
Set Shipping Method (Flatrate) 114
-
-
240
-
240
-
0
-
-
510
-
4830
-
1780
-
1066
-
3930
-
4720
-
0
-
-
-
Set Shipping Method (Flatrate): Goto Payment15
-
-
240
-
240
-
0
-
-
300
-
3150
-
905
-
516
-
1940
-
2300
-
0
-
-
-
Set Payment Method (Check/MO) 116
-
-
240
-
240
-
0
-
-
670
-
5290
-
1787
-
987
-
3660
-
4920
-
0
-
-
-
Set Payment Method (Check/MO) 217
-
-
240
-
240
-
0
-
-
300
-
2760
-
904
-
518
-
2010
-
2440
-
0
-
-
-
Set Payment Method (Check/MO) 318
-
-
220
-
220
-
0
-
-
370
-
8180
-
2696
-
1725
-
5810
-
7590
-
0
-
-
-
/checkout/../success/19
-
-
240
-
240
-
0
-
-
250
-
2830
-
931
-
583
-
1970
-
2530
-
0
-
-
-
/checkout/../success/ Redirect 120
-
-
74
-
0
-
74
-
-
1030
-
8350
-
2473
-
1620
-
5590
-
7310
-
0
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Magento EE v1.12
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Requests
-
-
Total
-
OK
-
KO
-
-
Min
-
Max
-
Mean
-
Std Dev
-
95th Pct
-
99th Pct
-
Req/s
-
-
-
Global Information0
-
-
48044
-
47887
-
157
-
-
40
-
40580
-
4985
-
3290
-
10650
-
13870
-
58
-
-
-
product page0
-
-
21327
-
21286
-
41
-
-
40
-
20040
-
4557
-
2820
-
9740
-
12350
-
26
-
-
-
Click add to cart1
-
-
8340
-
8324
-
16
-
-
40
-
12130
-
4216
-
2217
-
7520
-
9000
-
10
-
-
-
Click add to cart Redirect 12
-
-
8324
-
8320
-
4
-
-
40
-
16500
-
7022
-
3449
-
11780
-
13500
-
10
-
-
-
click checkout3
-
-
2780
-
2779
-
1
-
-
920
-
12350
-
6311
-
2829
-
9760
-
10950
-
3
-
-
-
Guest Checkout start4
-
-
90
-
90
-
0
-
-
390
-
3690
-
2103
-
795
-
3210
-
3410
-
0
-
-
-
Registered Checkout:Login and Pick Address5
-
-
2690
-
2690
-
0
-
-
180
-
19120
-
3298
-
4984
-
15470
-
16940
-
3
-
-
-
Guest:Pick Billing Address 16
-
-
90
-
90
-
0
-
-
600
-
7750
-
4348
-
1605
-
6430
-
7400
-
0
-
-
-
Registered Checkout:Login and Pick Address Redirect 17
-
-
2690
-
2688
-
2
-
-
40
-
24360
-
5433
-
3350
-
11780
-
14060
-
3
-
-
-
Guest:Pick Billing Address 28
-
-
90
-
90
-
0
-
-
520
-
8240
-
3412
-
1423
-
5480
-
6810
-
0
-
-
-
Guest:Go to pick Shipping Method9
-
-
90
-
90
-
0
-
-
310
-
4780
-
2334
-
888
-
3300
-
4450
-
0
-
-
-
Registered:Pick Billing Address 110
-
-
90
-
90
-
0
-
-
370
-
10090
-
3657
-
2453
-
8660
-
9600
-
0
-
-
-
Registered:Pick Billing Address 2-111
-
-
90
-
90
-
0
-
-
540
-
17670
-
4148
-
2741
-
10220
-
12510
-
0
-
-
-
Registered:Pick Billing Address 2-212
-
-
90
-
90
-
0
-
-
530
-
12640
-
3983
-
2411
-
8290
-
11590
-
0
-
-
-
Registered:Go to pick Shipping Method13
-
-
90
-
90
-
0
-
-
360
-
6290
-
2546
-
1401
-
5050
-
5980
-
0
-
-
-
Set Shipping Method (Flatrate) 114
-
-
180
-
180
-
0
-
-
450
-
7640
-
3926
-
1884
-
6550
-
7450
-
0
-
-
-
Set Shipping Method (Flatrate): Goto Payment15
-
-
180
-
180
-
0
-
-
380
-
6290
-
2451
-
1256
-
4270
-
4830
-
0
-
-
-
Set Payment Method (Check/MO) 116
-
-
180
-
180
-
0
-
-
570
-
8290
-
3923
-
1996
-
6460
-
7300
-
0
-
-
-
Set Payment Method (Check/MO) 217
-
-
180
-
180
-
0
-
-
330
-
5230
-
2318
-
1238
-
4210
-
4810
-
0
-
-
-
Set Payment Method (Check/MO) 318
-
-
180
-
180
-
0
-
-
940
-
40580
-
12673
-
7957
-
25910
-
29540
-
0
-
-
-
/checkout/../success/19
-
-
180
-
180
-
0
-
-
230
-
3330
-
1437
-
854
-
2870
-
3150
-
0
-
-
-
/checkout/../success/ Redirect 120
-
-
93
-
0
-
93
-
-
780
-
10470
-
5031
-
2251
-
7920
-
8880
-
0
-
-
-
-
-
-
-
-
Estimating the
- Number of Visitors
-
- Gatling does not report the number of users that cycled through during the test. However, it is possible to estimate
- the number using the following formula:
-
-
Magento Community Edition (CE) Release Notes (1.8 and later)
-
-
-
Note: We'd like to make you aware that a security patch for older versions of Magento Community Edition has been posted (in
- the Magento Community Edition Patches section). This patch resolves a remote code execution vulnerability that
- enables an attacker with Magento administrator privileges to delete files and directories on a Magento
- installation. This vulnerability was discovered through our quarterly penetration testing process and has not been
- reported by merchants.
- This issue was fixed in Magento Community Edition 1.8.0.0; no patch is necessary for versions 1.8.0.0 and later.
- Patches are available for Magento Community Edition 1.4.0.0 through 1.7.0.2. We encourage all affected merchants
- to apply the patch in their next regularly scheduled maintenance cycle.
- Magento takes security very seriously and will continue to focus on identifying potential issues and hardening our
- defenses.
-
-
-
Table of Contents
-
These Release Notes contain the following information:
Note: Some of the patches discussed in this section have
- EE_1.14.0.1 in the name. These patches were all tested against CE 1.8.x as well.
-
-
General Magento Connect Patches
-
Patch name: SUPEE-3941
-
-
- When
- you install a community-created translation package, the translation provided by the package overwrites any
- existing translations for the same items. This enables you to more easily install packages with translations.
-
-
- To
- improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
-
- Extension
- developers can now create an extensions with a dash character in the name. Merchants can install those extensions
- without issues.
-
- Magento
- administrators who attempt to install an extension with insufficient file system privileges are now informed.
- Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the
- your Magento install dir/app/code/community directory structure, the Magento administrator
- sees an error message in the Magento Connect Manager.
- To set file system permissions appropriately, see After You Install
- Magento: Recommended File System Ownership and Privileges.
-
-
-
Magento Install Page Displays After SOAP v2 Index Page Refresh
-
Patch name: SUPEE-3762.
- Refreshing the SOAP v2
- index page (http://your-magento-host-name/index.php/api/v2_soap/index/) results in all
- administrators and customers viewing the Magento installation page.
-
-
-
-
-
Discover Card Validation Patch Available
-
Magento has fixed an issue that prevented some Discover credit cards from validating properly. The issue was that
- certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover
- cards should validate properly.
-
The issue affects Magento CE versions 1.4.2.0–1.8.1.0.
Important: This is not a security threat. No data has
- been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid
- Discover card numbers.
-
-
-
PHP 5.4 Patch Available
-
You can use PHP 5.4 with Magento CE versions 1.6.0.0–1.8.1.0.
Magento CE 1.8.1.0 helps advance overall product quality and ease operations by providing significant tax
- calculation improvements, a wide range of bug fixes, and several security enhancements.
-
-
Tax Calculation Improvements
-
CE 1.8.1.0 resolves Value Added Tax (VAT) and Fixed Product Tax (FPT) issues so that Magento administrators can
- create invoices and credit memos to give merchants merchants access to accurate and consistent tax calculations
- and displays. We've also addressed:
-
-
VAT tax calculation issues for cross-border trade
-
Tax rounding issues when multiple taxes are applied
-
VAT and FPT calculation issues for bundled products
-
Support for the Waste Electrical and Electronic Equipment (W.E.E.E.) recycling tax in the EU
-
-
-
Functional Improvements
-
CE 1.8.1.0 includes bug fixes across important feature areas, including the shopping cart, checkout, content
- management system, and product import and export function. Many of these updates came from a hackathon held with
- Magento community developers, which demonstrates the vitality of our development community and their powerful
- ability to help us advance the platform.
-
-
Security Enhancements
-
CE 1.8.1.0 includes several security enhancements that were identified through our rigorous security assessment
- process. Magento complements its own comprehensive internal testing with quarterly penetration testing by expert
- consultants and actively works with the development community to identify security issues in order to harden the
- platform against potential threats.
-
-
-
-
Security Enhancements
-
Magento addressed the following security issues:
-
-
- Improved the
- password hashing algorithm.
- Magento thanks Bjorn Kraus for contributing to this fix.
-
-
- Resolved
- issues that could have resulted in Cross-Site Request Forgery (CSRF) in the web store.
-
-
-
- Resolved potential
- issues when issuing Return Materials Authorizations (RMAs).
- Magento thanks Ivan Chepurnyi for contributing to this fix.
-
- Resolved a session
- fixation issue when registering a user with the web store.
-
-
-
-
- Resolved issues
- with the expiration of file-based user sessions.
- Closed a potential
- loophole that enables another user to possibly access personal information when viewing billing
- agreements.
- Magento thanks Darryl Adie and Ampersand Commerce for contributing to this fix.
-
- Fixed the security
- settings for the frontend cookie to protect user sessions.
-
-
-
-
-
-
Issue After Upgrading to CE 1.8.1
-
- There is a known Issue After Upgrading to CE 1.8.1 that affects
- you only if you do not follow the recommended procedure to upgrade to a new environment as
- discussed in Getting Ready For
- Your Upgrade.
-
Symptom: After completing the upgrade, when you log in to the Admin Panel and click
- System > Configuration, a fatal error similar to the following displays in your
- browser:
-
Class 'Mage_Googlecheckout_Helper_Data' not found in /var/www/html/magento/app/Mage.php on line 547
-
-
Solution:
-
-
Close the Admin Panel browser window.
-
As a user with root privileges, delete all files exceptconfig.xml from the
- following directory:
-
See the following sections for a discussion of changes in this release:
-
-
-
- A tax
- configuration option for Fixed Product Tax (FPT) has changed. This option is in the Admin Panel at
- System > Configuration > SALES > Tax > Fixed Product Taxes,
- option FPT Tax Configuration. This option replaces the Apply Tax to FPT option
- in earlier CE releases.
- This option specifies how FPT is calculated as follows:
-
-
Not Taxed: Click this option if your taxing jurisdiction does not tax FPT. (For example,
- the state of California does not tax FPT.)
-
Taxed: Click this option if your taxing jurisdiction does tax FPT. (For example, Canada
- taxes FPT.)
-
Loaded and Displayed with Tax: Click this option if FPT is added to the order total
- before applying tax (for example, in EU countries).
-
-
-
- You can now
- specify a 0% tax rate. (In the Admin Panel, click Sales > Tax > Manage
- Tax Zones & Rates.).
- For more information, see the Magento User Guide.
-
- Magento changed
- its recommended setting for System > Configuration > SALES >
- Tax > Calculation Settings, option Apply Discount On Prices
- as follows:
-
-
US and Canadian merchants: Set the value of Apply Discount On Prices to Excluding
- Tax.
-
EU merchants: Set the value of Apply Discount On Prices to Including
- Tax.
-
-
-
- Magento strongly
- recommends all merchants set Apply Customer Tax to After Discount, regardless
- of all other tax-related settings. This avoids issues with calculating the total product price.
-
-
- When you specify a
- tax rate, the State list is now available whenever you choose a country that has states.
-
- You can now specify
- the asterisk (*) wildcard character for the value of State when you set up a new
- tax rate. This enables you to apply the same tax rate to all states or provinces in a particular country.
-
- Stores now display
- in the Admin Panel in System > Manage Stores as a three-column hierarchy, with
- the website in the left column, all stores associated with the website in the center column, and all store views
- associated with the store in the right column.
- This makes it easier for you to browse your stores and understand which websites, store views, and stores are
- associated with each other. The updated Manage Stores page also displays the root category for each store and
- the code for each website and store view.
- Magento thanks Fabrizio Branca for contributing to this fix. For more information, see Fabrizio's
- blog post.
-
- For the DHL
- (Deprecated) shipping method to work, you must change the gateway URL as follows:
-
-
Log in to the Admin Panel as an administrator.
-
Click System > Configuration > SALES > Shipping
- Methods.
-
In the right pane, expand DHL (Deprecated).
-
Change the value of the Gateway URL field to the following:
-
http://xmlapi.dhl-usa.com/ApiLanding.asp
-
-
In the upper right corner, click Save Config.
-
-
-
-
-
-
Tax Calculation Fixes
-
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
-
-
- Canadian customers
- now receive an e-mail with the correct totals for invoices and credit memos that include Provincial Sales Tax
- (PST) and Goods and Services Tax (GST).
-
- Resolved issues
- with incorrect prices and incorrect tax amounts when a custom price is used together with the configuration
- setting System > Configuration > SALES > Tax >
- Calculation Settings, option Apply Tax On set to Original price
- only.
-
- The tax amount is
- calculated correctly when:
-
-
The customer is in a different taxing jurisdiction than the web store
-
The configuration option System > Configuration > SALES >
- Tax > Calculation Settings, option Catalog Prices is set
- to Including Tax
-
The configuration option System > Configuration > SALES >
- Tax > Calculation Settings, option Tax Calculation Method Based
- On is set to Unit Price
-
-
-
- The row total
- including tax displayed in the shopping cart is calculated correctly when:
-
-
The configuration option System > Configuration > SALES >
- Tax > Calculation Settings, option Catalog Prices is set
- to Excluding Tax
-
The configuration option System > Configuration > SALES >
- Tax > Calculation Settings, option Tax Calculation Method Based
- On is set to Row Total
-
-
-
- The row subtotal
- displays the correct amount when reordering a product that includes a discount coupon.
-
- Multiple tax rates
- for a product display correctly in the Admin Panel when creating an invoice or credit memo.
-
- Resolved calculation
- errors when tax and currency conversion are applied. As a result, the price the customer views on a catalog or
- product page is the same as the price displayed in the shopping cart.
-
- A customer can now
- place an order when two tax rules are applied to a product, even if the tax rules specify the same tax rate.
-
-
- Resolved issues with
- calculating taxes on orders that are shipped to different countries that have different tax rates.
-
- Product prices,
- including taxes, display on category and product pages the same for a guest customer as for a logged-in
- customer. (A guest customer is a customer who does not log in to your web store; this customer belongs to the
- NOT LOGGED IN customer group.)
-
-
-
-
Rounding Issues
-
The following tax rounding issues were resolved:
-
-
- Resolved a
- rounding issue in the tax detail display in the shopping cart when more than one tax rule is used.
-
- Resolved an issue
- reported on stackoverflow where a calculation error resulted from the following configuration:
- System > Configuration > SALES > Tax > Calculation
- Settings, option Tax Calculation Method Based On set to Total
- System > Configuration > SALES > Tax > Calculation
- Settings, option Catalog Prices set to Including Tax
-
- As a result of
- allowing a 0% tax rate, rounding errors related to different VAT jurisdictions have been resolved. For example,
- if a product originates in a country with VAT but is shipped to another country that has no VAT, correct prices
- display in the shopping cart.
-
- Row totals display
- correctly in the shopping cart when:
-
-
A shopping cart discount is applied
-
The following configuration options are set in System > Configuration >
- SALES > Tax > Calculation Settings:
-
-
Catalog Prices is set to Including Tax
-
Tax Calculation Method Based On is set to Excluding Tax
-
Apply Customer Tax is set to After Discount
-
Apply Discount On Prices is set to Including Taxes
-
-
-
-
-
-
-
Display Issues
-
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
- store:
-
-
- Shipping prices
- including tax display properly in the shopping cart.
-
- A special price now
- displays correctly on the product view page.
-
- Values displayed in
- PDFs for invoices and credit memos no longer overlap each other.
-
- Orders, invoices,
- and credit memos for downloadable and virtual products display the correct row total when viewed in the Admin
- Panel.
-
- Orders display the
- FPT in the Admin Panel when the full tax summary is specified.
-
- Fixed-price
- bundled products that include FPT now display only one price for both From and To values, regardless of how you
- configured the products.
-
-
-
-
-
Bundled Products Issues
-
-
- The price of a
- dynamic bundled product is calculated correctly after being customized by the customer.
-
- The price of a
- dynamic bundled product with tiered pricing is calculated correctly after being customized by the customer.
-
- Resolved issues
- with calculating the value displayed for the price including tax for bundled products.
-
- The price
- excluding tax of a bundle product to which a discount is applied is the same:
-
-
When viewed on the customization page
-
after adding the bundled product to the shopping cart.
-
-
-
- A dynamically-priced
- bundled product's prices displayed for Unit Price in the shopping cart (that is, the price including tax and the
- price excluding tax) are now correct. Before the fix, the prices were equal, which was incorrect.
-
- The
- price of a bundled product displayed on the product view page and in the shopping cart are the same.
-
- The grand total
- including tax and the subtotal including tax displayed in the shopping cart are now identical when you specify
- that catalog prices include tax and the shopping cart is set to display prices with and without taxes for a
- dynamic bundled product that consists of two simple products.
-
-
-
-
Fixed Product Tax (FPT) Issues
-
-
- Resolved
- issues in calculating FPT on a credit memo.
-
- With both
- discounts and FPT enabled (and FPT is taxable), the subtotal including tax displayed in the shopping cart is
- correct.
-
- FPT calculation
- for bundled products that have FPT applied to them now are now correct for all FPT configuration settings.
-
- The invoice total
- is calculated correctly for an order that has both FPT and a shopping cart discount.
-
- The FPT amount is
- now included in the Subtotal (Incl.Tax) row for partial invoice.
-
- Resolved an issue
- that resulted in FPT being applied twice to the grand total in the shopping cart.
-
-
-
-
-
Fixes in Magento CE 1.8.1.0
-
Fixes in this release can be divided into the following categories:
- Resolved a new
- customer registration issue that enabled a user to register and see another customer's dashboard.
-
- Resolved issues with
- breadcrumbs disappearing or displaying incorrectly.
-
-
- The following options are available in the Admin Panel in System >
- Configuration > SALES > Sales > Gift Options:
- Allow Gift Wrapping on Order Level set to No
- Allow Gift Wrapping for Order Items set to Yes
-
- Category and
- subcategory names display correctly. Before the issue was resolved, subcategory names that were significantly
- longer than the category name did not display properly.
-
-
- If a customer adds
- more than one product that requires products to be purchased in increments, only the products that meet the
- increment requirements are added. Before the fix, all products were added.
-
- Scheduled payments
- work properly.
- Magento thanks Sylvain Raye for contributing to this fix.
-
- If a bundled or
- configurable product is out of stock, it's no longer available to check out.
- Magento thanks Francesco Marangi for contributing to this fix.
-
- Placing an order
- in the Admin Panel correctly sets the order status to Pending.
- Magento thanks GitHub user elframan for contributing to this fix.
-
-
-
-
-
Import and Export Fixes
-
-
- Scheduled export
- works properly.
-
- You can now export
- a shipment to CSV after printing its shipping label.
- Magento thanks Florinel Chis for contributing to this fix.
-
-
-
-
Shipping Fixes
-
-
- You are not
- required to enter a declared value to ship with FedEx.
-
- FedEx shipping
- labels print properly; addresses are not truncated.
-
- Fix for the USPS
- change to the names of their Priority and Express shipping options in their API made on Sunday, July 28, 2013.
-
-
-
-
-
-
-
-
-
Other Fixes
-
-
- Resolved issues that
- caused spurious errors in the Magento exception log:
- 'Zend_Date_Exception' with message 'Invalid year, it must be between -10000 and 10000'
-
-
-
-
- Widgets display
- properly on the CMS.
-
-
-
-
- The product attribute
- option Use Default Value works properly when used in a non-default store view.
-
- A category attribute
- set to store view scope displays in layered navigation.
-
- A store set for
- British Pound Sterling currency units now displays the correct currency in payment logs.
-
- Resolved an issue with
- the Mage_Catalog_Block_Product_Abstract class that caused errors to display on product view pages in
- your web store.
-
-
-
-
- Back-in-stock e-mails
- contain the correct content.
-
-
-
-
-
-
-
- You can now manage
- product ratings and reviews from the Admin Panel as well as from the web store.
- Magento thanks Fabian Blechschmidt Schrank for contributing to this fix.
-
-
- Resolved an issue
- with Mage_Page_Block_Template_Links::addLinkBlock to enable you to sort an array of results by
- position.
- Magento thanks Benjamin Marks for contributing to this fix.
-
-
-
-
Magento Community Edition (CE) 1.8.0.0 Release Notes
-
See the following sections for information about changes in this release:
- Errors are not
- displayed in a new Magento installation.
-
- Fixed a session
- fixation vulnerability in the new user registration process. Attackers can no longer abuse this flaw to take over
- new user accounts during registration.
-
- Resolved a remote
- code execution vulnerability that enabled an attacker to delete files and directories on the Magento installation.
- (The attack required access to the Admin Panel as a Magento administrator.)
-
- Prevent attacks that
- use OAuth to leak sensitive information to an attacker that knows the consumer key and user token.
-
- Resolved an issue
- that enabled attackers to gain access to billing information.
- We thank Darryl Adia (from Ampersand Commerce) for contributing to this fix.
-
- Resolved
- issues with the security of OAuth tokens and keys.
-
A remote code execution vulnerability was fixed.
- We thank Bastian Ike for contributing to this fix.
-
-
The Magento Admin Panel and web stores no longer allow web browsers to store usernames or passwords.
-
The Magento web store has additional Cross Site Request Forgery (CSRF) protections, meaning an imposter can no
- longer impersonate a newly registered customer and perform actions on the customer's behalf.
-
The cryptographic methods used to store passwords were improved to enhance security.
-
-
-
United States Postal Service (USPS) Update
-
The USPS changed the names of their Priority and Express shipping options in their API in July 2013. To enable you
- to continue utilizing USPS Priority and Express mail methods, CE 1.8 includes a patch that addresses the
- issue.
-
Important: The USPS API patch has an impact on upgrading to CE 1.8
- from earlier versions. If you're doing a new CE 1.8 installation, however, you don't need to do anything.
-
-
-
Following are details about the upgrade impact:
-
-
Print all USPS shipping labels before upgrading; after upgrading, you will not be able to print them.
-
Any shopping cart price rules that use the USPS shipping method that created before you upgrade must be re
- created after you upgrade. Pre-existing USPS shipping methods do not work with shopping cart price rules after the
- upgrade.
-
-
-
Performance Improvements
-
-
Limited the way Magento performs large database lookups.
-
-
Checkout performance improvements achieved by:
-
-
Eliminating unnecessary RSS cache cleanups when RSS functionality is disabled
-
The locale used to send a new order confirmation e-mail now first checks to see if the customer's locale is
- the same as the store's locale before attempting to localize the e-mail.
-
-
-
Improving the overall checkout process performance by loading the progress information for the current
- checkout step only
-
-
-
You can load a large number of tax codes (35,000 or so) without impacting performance.
-
-
-
-
-
Tax Calculation Fixes
-
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
-
-
Based on Magento testing and merchant experience, certain tax configuration settings have been determined to be
- susceptible to rounding issues and can be confusing to buyers. To help you avoid issues with those settings,
- warning messages display in the Admin Panel if you attempt to save such a configuration.
- Administrative users can choose to dismiss the messages and can still save the configuration; however, Magento
- strongly recommends you change the configuration in a way recommended by the details displayed in the
- message.
- For details, see the Magento
- User Guide.
-
-
-
Bundle pricing is more consistent as follows:
-
-
The calculation formula is:
- Sub item price = Sub item base price * Applicable tiered price adjustment or discount, then rounded
- Bundle price = Sum (round(sub item price * qty))
-
When non-integer quantities are multiplied by a product price, Magento rounds the resulting subtotal is as
- follows:
- round(unit price * non-integer quantity)
-
-
-
All product price information on which taxation is based are rounded to two digits of precision regardless of
- how many digits of precision have been loaded into the database (for example, $10.24 instead of $10.2385). This
- situation can occur when certain integrations enable third-party applications to send four-digit precision prices
- to Magento.
- Starting with this release those additional digits will have no impact on customer facing prices. Forcing two
- digits of precision enables more exact calculations involving Fixed Product Tax (FPT), discounts, and
- taxes—among other concerns.
-
-
-
For certain Canadian provinces and localities, calculations and methods were updated to support changing legal
- requirements in Canada:
-
The following issues relate to one-cent rounding errors in the web store or shopping cart:
-
-
Calculating taxes for bundled products with tiered pricing.
-
Calculating the price before customization for bundled products.
-
-
-
Calculating the grand total of items added to a cart in a different order.
-
Viewing an order when taxes are calculated after a discount using either row-based or unit price.
-
-
-
Applying a discount to an order with a shipping address different than the billing address.
-
-
-
Calculating the grand total based on the order in which products are added to the shopping cart.
-
-
-
Specifying that prices display in the web store excluding tax and setting a 20% tax rate (or discount rate) now
- calculates the grand total correctly. It is now possible to have grand totals in amounts like 6.99, 9.99, or
- 99.99—regardless of the currency units used in the web store.
-
-
-
Adding multiple items to a cart does not affect the accuracy with which taxation is calculated.
-
-
-
Subtotal (Incl. Tax) is now correct when catalog and shipping prices include tax. Both tax and discounts are
- applied after tax.
-
-
-
Prices displayed in the cart and on the catalog page are consistent and correct when catalog prices include tax,
- and when items in the catalog are set to display both including and excluding tax.
- (In the Admin Panel, click System > Configuration > SALES >
- Tax. In the right pane, expand Calculation Settings.)
-
-
-
Error in calculating the Grand Total Excl. Tax was resolved. This error occurred in a specific configuration:
- tax is applied to FPT, FPT is included in the subtotal, and the customer selects non-taxable flat rate shipping.
-
-
-
-
-
-
Fixed Product Tax (FPT) Fixes
-
The following issues relate to errors in calculating taxes that include FPT in the web store or shopping cart:
-
-
Price in the cart displays the correct before-tax price and grand total.
-
-
-
Subtotals displayed in the cart—both Including Tax and Excluding Tax—are now correctly calculated
- when FPT is applied.
-
Free shipping offers are now processed correctly when FPT is applied.
-
FPT taxes are calculated correctly when a discount is applied.
-
-
-
-
-
Discount Calculation Fixes
-
The following issues relate to price calculations when coupon codes or other discounts are applied in the web store
- or shopping cart:
-
-
The Row Subtotal displayed in the cart is calculated correctly (that is, both Excl. Tax and Incl. Tax are
- correct).
-
The price for bundled items now displays with tax included if the bundle is configured to do so.
-
Taxation is now correctly calculated on a product with a discounted price.
-
Taxation on discounts is now calculated correctly when the ship-to country is different from the web store's
- default country.
-
-
-
Display Fixes
-
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
- store:
-
-
Row Subtotal displays correctly in the shopping cart when:
-
-
FPT is applied.
-
-
-
A discount is applied to a situation where the tax the customer pays is different from the tax specified for
- the web store's locale (for example, when the shipping origin is different than the shipping address).
-
-
-
-
-
Subtotal including tax on a credit memo is correct when one or more items in the memo includes FPT.
-
-
-
Item subtotal displays correctly when a discount is applied to a purchase that includes FPT.
-
-
-
If the administrator sets catalog prices to exclude tax and to display product prices in catalog as including
- tax, the price of the product in your web store includes applicable taxes.
-
- (In the Admin Panel, click System > Configuration > SALES >
- Tax. In the right pane, expand Calculation Settings.)
-
The amount of tax displayed in the Order Totals section of the shopping cart is now correct when free shipping
- and a shopping cart rule discount are applied.
-
-
-
-
-
API Fixes
-
The following are fixed in the Magento SOAP v2.0 APIs (with exceptions noted):
-
-
Requesting a product using a call like the following returns the product with the specified numeric SKU value
- (8888 in the following example):
- $result = $client->call($sessionId, 'catalog_product.info', '8888', null, null, 'sku');
-
-
You can now use from-to complex filters to perform "window" filtration on a single
- field. For example, you can use from and to on the created_at return a list
- of sales orders using the salesOrderList.
-
-
-
When you use the SOAP API v.2.0 with WS-I Compliance enabled to retrieve sales orders information, the server responds with the
- correct Content-Length header.
-
-
-
The productGetSpecialPrice method returns special price information for a product, whether or not
- WS-I Compliance is
- enabled.
-
-
-
The shoppingCartPaymentList method returns the list of the available payment
- methods for the shopping cart appropriately. The following error is no longer returned:
- SOAP-ERROR: Encoding: object has no 'code' property in name
-
-
You can now add a C# web reference in Microsoft Visual Studio 2010 using the Magento WSDL.
- For example, this command no longer fails:
- C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin> wsdl /out:Magento.cs /v
- http://magentohost/api/v2_soap/?wsdl
-
-
When a product price is set with website scope and an administrative user has access to only one website, the
- default price is taken from that website scope. Also, when saving the product on the website scope, the price is
- updated only in that scope and not in the default scope.
-
-
-
An error no longer displays on your web store after a customer places an order. (The error message was
- There has been an error processing your request. Please contact us or try again later).
-
-
-
Restricted coupon codes work properly, even if the customer has selected the Remember me
- checkbox.
-
-
-
Using the Table Rates shipping option, free shipping options work properly. (In the Admin Panel, click
- System > Configuration > SALES > Shipping
- Methods. In the right pane, expand Table Rates.)
-
-
-
Issues with shipping table rates have been resolved.
-
-
-
Entering a value such as 10,50 (using a comma character and not a period) for Adjustment
- Fee now results in the correct amount of credit being applied to the transaction.
-
-
-
Unit price for bundled products is now calculated correctly.
-
-
-
The tiered price of bundled items now displays properly on the web store.
-
-
-
Composite products can be successfully reordered.
-
-
-
You can now use special characters in a product URL key.
-
-
-
After a customer visits the sitemap, web stores URLs are no longer prepended by
- /sitemap/catalog/string.
-
-
-
Welcome messages now display properly in the web store after a customer's profile information is changed.
-
-
-
Recently viewed products now display updates properly.
-
-
-
Armed Forces Middle East is now available for State when checking out.
-
-
-
Searching for a customer's orders and returns works properly.
-
-
-
Shipping is calculated correctly if you select Using origin weight (few requests) for
- Packages Request Type. (In the Admin Panel, click System >
- Configuration > SALES > Shipping Methods > DHL (Deprecated)).
-
-
-
Free shipping is no longer available to a customer during checkout if the option was disabled by an
- administrator. (In the Admin Panel, click System > Configuration >
- Sales > Shipping Method > DHL(Deprecated), click one or more
- options from the Allowed Methods list, and, from the Free Shipping with Minimum Order
- Amount list, click No.)
-
-
-
A user can navigate your web store while downloading a downloadable product.
-
-
-
You can now specify weight units in kilograms (kg) using the FedEx shipping method.
-
-
-
FedEx shipping rates are now consistent with Magento discounted rates.
-
-
-
Fixed issues with United Parcel Service (UPS) shipping rates.
-
-
-
UPS shipping labels have the word SAMPLE printed on them only when you request a sample label.
-
-
-
Changes made to United States Post Office (USPS) APIs and rates have been incorporated in Magento.
-
-
-
The products in a customer's wish list no longer disappear after one or more products are edited by an
- administrator.
-
-
-
Administrators can view the contents of a customer's shopping cart.
-
-
-
- When a customer selects a product on your web store, the assigned category is selected in the
- navigation menu.
-
-
-
-
-
Promotional Price Rule Fixes
-
The following fixes relate to administering and using shopping cart price rules and catalog price rules:
-
-
Shopping cart price rules applied to specific customer groups work properly.
-
-
-
Catalog price rules are applied properly to customer groups.
-
-
-
The scope of a product attribute is now honored by a catalog price rule.
-
-
-
Discounts specified by a shopping cart price rule are applied properly when a particular order is shipped to
- multiple addresses.
-
-
-
A discount specified by a shopping cart price rule that allows for more than one use per customer is applied the
- correct number of times if the customer has their orders shipped to more than one address.
-
-
-
-
When an administrative user whose role is restricted to only viewing catalog price rules, the user cannot add or
- edit catalog price rules.
-
-
-
Shopping cart price rules now work properly with bundled products.
-
-
-
-
-
Administrative Ordering and Credit Memo Fixes
-
-
When you create an order using the Admin Panel and you have multiple stores, the State/Province
- field updates appropriately for the country in which the order is placed.
-
-
-
When you create an order using the Admin Panel and you have specified a default billing address and a default
- shipping address, the addresses are used correctly.
-
-
-
Orders placed by an administrator display in a customer's last order list.
-
-
-
Product comparisons now display properly when an administrator makes a change using the Admin Panel (for
- example, deleting a product from a customer's comparison list).
-
-
-
You can now cancel an order using the Admin Panel.
-
-
-
Orders and invoices that include taxable shipping—when created in the Admin Panel—now calculate the
- shipping taxes properly.
-
-
-
Products added to a customer's wish list by an administrator display properly.
-
-
-
-
-
Import Fixes
-
-
The quantity (QTY) of all products imports correctly.
-
-
-
The value of Maximum Qty Allowed in Shopping Cart (use_cfg_max_sale_qty) is correct.
-
-
-
The product displays correctly in layered navigation.
-
-
-
Importing customer lists with capitalization variations in the e-mail address now imports the customer only once
- (for example, user@example.com and User@example.com).
-
-
-
- Issues with importing products with Append Complex Data selecting from a
- comma-separated value (.csv) file have been resolved.
-
-
-
-
Payment Fixes
-
-
Resolved issue sending customer e-mail when using Payflow Link.
-
-
-
Security issues with Google Checkout payments have been resolved.
-
-
-
Security issues with Authorize.net payments have been resolved.
-
-
-
Magento conforms to the latest version of the PayPal Instant Payment Notification (IPN) guidelines.
-
-
-
The contents of a shopping cart are unaffected by canceling a PayPal payment.
-
-
-
Issues with not being able to continue checkout after switching payment methods have been resolved.
-
-
-
You can now process partial refunds and invoices for orders that were placed using Payflow Pro.
-
-
-
Payflow Link and Payments Advance now capture IPN transactions properly.
-
-
-
Special characters (such as e-mail addresses) are now handled properly by the Magento Payflow API integration.
-
-
-
Resolved errors with orders placed using the Website Payments Pro payment method.
-
-
-
PayPal Express Checkout payments are handled properly when a shopping cart price rule is specified.
-
-
-
Any PayPal Name-Value Pair (NVP) payment method no longer automatically refunds an order when a chargeback is
- initiated. Magento now allows the dispute to be resolved before taking the appropriate action.
- PayPal NVP payment methods include: PayPal Payments Pro (including PayPal Payments Pro Hosted), Payments Standard,
- and all Payflow methods.
-
-
-
PayPal Pro now correctly processes the shipping address for an order.
-
-
-
PayPal Express Checkout and PayPal Pro now handle partial refunds properly.
-
-
-
Fixed rounding errors that were preventing PayPal Express Checkout transactions from completing. The error
- occurred with the following configuration:
-
-
tax calculation method based on the total
-
tax calculated based on the shipping address
-
catalog prices exclude tax
-
shipping prices exclude tax
-
customer discount applied after a discount
-
discount applied to prices excluding tax
-
tax applied to a custom price if available
- (In the Admin Panel, click System > Configuration > SALES >
- Tax. In the right pane, expand Calculation Settings.)
-
-
-
-
The order status Suspected Fraud is now supported by PayPal Payments Pro (hosted) when PayPal fraud protection
- is enabled. Using the Magento Admin Panel, the merchant can also accept or deny any Suspected Fraud orders and
- have that decision applied to the PayPal transaction.
-
-
-
- When sending payments in the United Kingdom, PayPal Payments Pro (hosted) now sends the value for
- state correctly. (Before the fix, city was sent as the value for state.)
-
-
Using the Ogone payment method, transactions display in the Magento Admin Panel after you capture them.
-
-
-
When an administrator places an order and uses PSi Gate, then cancels the order, the PSi Gate gateway displays
- both the order and the void transactions.
-
-
-
The following fields related to PayPal's Payflow Pro Gateway payment method are now implemented properly:
-
Fixed spurious Gateway error: Void error: V18A4B18E0F9 has been captured errors when canceling
- partially invoiced orders when the Payflow Pro processor was used to process the payment.
-
-
-
3-D secure fix that affects UK merchants only: 3-D Secure for UK merchants implementing Direct Payment
- works properly.
-
-
-
Partial captures are now supported for the following PayPal payment methods: Express Checkout, Payments Pro
- Payflow Edition, and PayPal Standard.
-
-
-
Using the PayPal Express Checkout method, a recently added customer can check out without the error This
- customer email already exists.
-
-
-
-
-
Other Fixes
-
-
- Issues related to
- the DHL shipping method for picking up and pricing orders on holidays have been resolved as follows:
-
-
If the current date is a weekend, Magento chooses next Monday as the pick-up date.
-
If the current date is a holiday, Magento requests from DHL information about the next five consecutive days
- to find a workday on which to pick up the order.
-
If there is no workday in the five consecutive days following a holiday, the DHL shipping method is
- unavailable.
-
-
-
- The
- .htaccess.sample provided with Magento now includes php_value memory_limit 512M to be
- consistent with the Magento system
- requirements.
-
- You can now install
- or upgrade to CE 1.8.0.0 if your Magento database had a table prefix (for example, all tables start with
- mage_ because you specified a tables prefix during installation).
When an administrative user whose role is restricted to managing products attempts to edit Inventory settings
- (Catalog > Manage Products, Inventory), only the available
- options display.
-
-
-
Related product information updates appropriately in the Admin Panel.
-
-
-
Issues with editing product inventory settings and category attributes using the Google Chrome web browser have
- been resolved.
-
-
-
Rolling back after a backup now works properly. (The Magento backup and rollback options are available in the
- Admin Panel in System > Tools > Backup.)
-
-
-
You can now fetch data for a PayPal Settlement Report using a custom Secure FTP (SFTP) server.
-
-
-
You can now save a category with the option Available Product Listing Sort By: Best value or
- Price enabled.
-
-
-
-
-
Thanks
-
Magento acknowledges and thanks everyone in the Magento Community who contributed to this release, including Colin
- Mollenhour for Redis modules.
-
-
-
-
\ No newline at end of file
diff --git a/guides/m1x/ce18-ee113/ee1.13_release-notes.html b/guides/m1x/ce18-ee113/ee1.13_release-notes.html
deleted file mode 100644
index 0f8fe0e922..0000000000
--- a/guides/m1x/ce18-ee113/ee1.13_release-notes.html
+++ /dev/null
@@ -1,2109 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
- Magento Enterprise Edition (EE) Release Notes (1.13 and later)
-
-
-
-
-
-
-
-
-
-
- {% include m1x/eol_message.html %}
-
-
-
-
Magento Enterprise Edition (EE) Release Notes (1.13 and later)
-
-
-
Table of Contents
-
These Release Notes contain the following information:
- When
- you install a community-created translation package, the translation provided by the package overwrites any
- existing translations for the same items. This enables you to more easily install packages with translations.
-
-
- To
- improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
-
- Extension
- developers can now create an extensions with a dash character in the name. Merchants can install those extensions
- without issues.
-
- Magento
- administrators who attempt to install an extension with insufficient file system privileges are now informed.
- Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the
- your Magento install dir/app/code/community directory structure, the Magento administrator
- sees an error message in the Magento Connect Manager.
- To set file system permissions appropriately, see After You Install
- Magento: Recommended File System Ownership and Privileges.
-
-
-
Magento Install Page Displays After SOAP v2 Index Page Refresh
-
Patch name: PATCH_SUPEE-3762_EE_1.14.0.1_v1.sh.
- Refreshing the SOAP v2
- index page (http://your-magento-host-name/index.php/api/v2_soap/index/) results in all
- administrators and customers viewing the Magento installation page.
-
-
Multiple Simultaneous Magento Administrators
-
Patch name: PATCH_SUPEE-3819_EE_1.14.0.1_v1.sh.
- Multiple Magento
- administrators can simultaneously add new products; or edit descriptions, edit prices, or edit stock quantities of
- existing products without causing deadlocks, key violations, or critical data errors. Together with applying the
- patch, you must set all indexers to Update when scheduled as follows:
-
-
Log in to the Magento Admin Panel as an administrator.
-
Click System > Configuration.
-
In the left navigation bar, from the ADVANCED group, click Index Management.
-
Expand Indexing Options.
-
From each list, click Update when scheduled.
-
Click Save Config in the upper right corner of the page.
-
-
-
-
-
-
-
-
Discover Card Validation Patch Available
-
Magento has fixed an issue that prevented some Discover credit cards from validating properly. The issue was that
- certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover
- cards should validate properly.
-
The issue affects EE versions 1.9.1.1 through 1.13.1.0.
Important: This is not a security threat. No data has been
- compromised or misused. It affects only the ability to validate certain credit card number ranges as valid
- Discover card numbers.
-
-
-
PHP 5.4 Patch Available
-
You can use PHP 5.4 with Magento EE versions 11.0.0.0–1.13.1.0.
This section discusses how to get patches referenced in these Release Notes. Magento has other patches available
- from the EE support portal and the partner portal; you
- can use the following instructions to install any of those patches as well.
Magento EE 1.13.1.0 helps advance overall product quality and ease operations by providing significant tax
- calculation improvements, a wide range of bug fixes, and several security enhancements.
-
-
Tax Calculation Improvements
-
EE 1.13.1.0 resolves Value Added Tax (VAT) and Fixed Product Tax (FPT) issues so that Magento administrators can
- create invoices and credit memos to give merchants merchants access to accurate and consistent tax calculations
- and displays. We've also addressed:
-
-
VAT tax calculation issues for cross-border trade
-
Tax rounding issues when multiple taxes are applied
-
VAT and FPT calculation issues for bundled products
-
Support for the Waste Electrical and Electronic Equipment (W.E.E.E.) recycling tax in the EU
-
-
-
Functional Improvements
-
EE 1.13.1.0 includes bug fixes across important feature areas, including the shopping cart, checkout, content
- management system, and product import and export function. Many of these updates came from a hackathon held with
- Magento community developers, which demonstrates the vitality of our development community and their powerful
- ability to help us advance the platform.
-
-
Security Enhancements
-
EE 1.13.1.0 includes several security enhancements that were identified through our rigorous security assessment
- process. Magento complements its own comprehensive internal testing with quarterly penetration testing by expert
- consultants and actively works with the development community to identify security issues in order to harden the
- platform against potential threats.
-
-
Security Enhancements
-
Magento addressed the following security issues:
-
-
- Improved the
- password hashing algorithm.
- Magento thanks Bjorn Kraus for contributing to this fix.
-
-
- Resolved
- issues that could have resulted in Cross-Site Request Forgery (CSRF) in the web store.
-
-
-
- Resolved potential
- issues when issuing Return Materials Authorizations (RMAs).
- Magento thanks Ivan Chepurnyi for contributing to this fix.
-
- Resolved a session
- fixation issue when registering a user with the web store.
-
-
- Closed a potential
- loophole that enables another user to possibly access personal information when viewing billing
- agreements.
- Magento thanks Darryl Adie and Ampersand Commerce for contributing to this fix.
-
- Resolved a remote
- code execution vulnerability that enabled an attacker to delete files and directories on the Magento
- installation. (The attack required access to the Admin Panel as a Magento administrator.)
-
- Fixed the security
- settings for the frontend cookie to protect user sessions.
-
-
-
-
-
-
Potential Issue After Upgrading to EE 1.13.1.0
-
There is a known issue after upgrading to EE 1.13.1 that affects you only if you do not follow
- the recommended procedure to upgrade to a new environment as discussed in Getting Ready For Your
- Upgrade.
-
Symptom: After completing the upgrade, when you log in to the Admin Panel and click
- System > Configuration, a fatal error similar to the following displays in your
- browser:
-
Class 'Mage_Googlecheckout_Helper_Data' not found in /var/www/html/magento/app/Mage.php on line 547
-
-
Solution:
-
-
Close the Admin Panel browser window.
-
As a user with root privileges, delete all files exceptconfig.xml from the
- following directory:
-
See the following sections for a discussion of changes in this release:
-
-
- EE's Payment
- Bridge module has been updated to the latest version.
- For more information, see this Magento blog post.
-
- A tax
- configuration option for Fixed Product Tax (FPT) has changed. This option is in the Admin Panel at
- System > Configuration > SALES > Tax > Fixed Product Taxes,
- option FPT Tax Configuration. This option replaces the Apply Tax to FPT option
- in earlier EE releases.
- This option specifies how FPT is calculated as follows:
-
-
Not Taxed: Click this option if your taxing jurisdiction does not tax FPT. (For example,
- the state of California does not tax FPT.)
-
Taxed: Click this option if your taxing jurisdiction does tax FPT. (For example, Canada
- taxes FPT.)
-
Loaded and Displayed with Tax: Click this option if FPT is added to the order total
- before applying tax (for example, in EU countries).
-
-
- You can now
- specify a 0% tax rate. (In the Admin Panel, click Sales > Tax > Manage
- Tax Zones & Rates.).
- For more information, see the Magento User Guide.
-
- Magento changed
- its recommended setting for System > Configuration > SALES >
- Tax > Calculation Settings, option Apply Discount On Prices
- as follows:
-
-
US and Canadian merchants: Set the value of Apply Discount On Prices to Excluding
- Tax.
-
EU merchants: Set the value of Apply Discount On Prices to Including
- Tax.
-
-
-
- Magento strongly
- recommends all merchants set Apply Customer Tax to After Discount, regardless
- of all other tax-related settings. This avoids issues with calculating the total product price.
-
-
- When you specify a
- tax rate, the State list is now available whenever you choose a country that has states.
-
- You can now specify
- the asterisk (*) wildcard character for the value of State when you set up a new
- tax rate. This enables you to apply the same tax rate to all states or provinces in a particular country.
-
- Stores now display
- in the Admin Panel in System > Manage Stores as a three-column hierarchy, with
- the website in the left column, all stores associated with the website in the center column, and all store views
- associated with the store in the right column.
- This makes it easier for you to browse your stores and understand which websites, store views, and stores are
- associated with each other. The updated Manage Stores page also displays the root category for each store and
- the code for each website and store view.
- Magento thanks Fabrizio Branca for contributing to this fix. For more information, see Fabrizio's
- blog post.
-
- For the DHL
- (Deprecated) shipping method to work, you must change the gateway URL as follows:
-
-
Log in to the Admin Panel as an administrator.
-
Click System > Configuration > SALES > Shipping
- Methods.
-
In the right pane, expand DHL (Deprecated).
-
Change the value of the Gateway URL field to the following:
-
http://xmlapi.dhl-usa.com/ApiLanding.asp
.
-
In the upper right corner, click Save Config.
-
-
-
-
-
-
Tax Calculation Fixes
-
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
-
-
- Canadian customers
- now receive an e-mail with the correct totals for invoices and credit memos that include Provincial Sales Tax
- (PST) and Goods and Services Tax (GST).
-
- Resolved issues
- with incorrect prices and incorrect tax amounts when a custom price is used together with the configuration
- setting System > Configuration > SALES > Tax >
- Calculation Settings, option Apply Tax On set to Original price
- only.
-
- The tax amount is
- calculated correctly when:
-
-
The customer is in a different taxing jurisdiction than the web store
-
The configuration option System > Configuration > SALES >
- Tax > Calculation Settings, option Catalog Prices is set
- to Including Tax
-
The configuration option System > Configuration > SALES >
- Tax > Calculation Settings, option Tax Calculation Method Based
- On is set to Unit Price
-
-
-
- The row total
- including tax displayed in the shopping cart is calculated correctly when:
-
-
The configuration option System > Configuration > SALES >
- Tax > Calculation Settings, option Catalog Prices is set
- to Excluding Tax
-
The configuration option System > Configuration > SALES >
- Tax > Calculation Settings, option Tax Calculation Method Based
- On is set to Row Total
-
-
-
- The row subtotal
- displays the correct amount when reordering a product that includes a discount coupon.
-
- Multiple tax rates
- for a product display correctly in the Admin Panel when creating an invoice or credit memo.
-
- Resolved calculation
- errors when tax and currency conversion are applied. As a result, the price the customer views on a catalog or
- product page is the same as the price displayed in the shopping cart.
-
- A customer can now
- place an order when two tax rules are applied to a product, even if the tax rules specify the same tax rate.
-
-
- Resolved issues with
- calculating taxes on orders that are shipped to different countries that have different tax rates.
-
- Product prices,
- including taxes, display on category and product pages the same for a guest customer as for a logged-in
- customer. (A guest customer is a customer who does not log in to your web store; this customer belongs to the
- NOT LOGGED IN customer group.)
-
-
-
-
Rounding Issues
-
The following tax rounding issues were resolved:
-
-
- Resolved a
- rounding issue in the tax detail display in the shopping cart when more than one tax rule is used.
-
- Resolved an issue
- reported on stackoverflow where a calculation error resulted from the following configuration:
- System > Configuration > SALES > Tax > Calculation
- Settings, option Tax Calculation Method Based On set to Total
- System > Configuration > SALES > Tax > Calculation
- Settings, option Catalog Prices set to Including Tax
-
- As a result of
- allowing a 0% tax rate, rounding errors related to different VAT jurisdictions have been resolved. For example,
- if a product originates in a country with VAT but is shipped to another country that has no VAT, correct prices
- display in the shopping cart.
-
- Row totals display
- correctly in the shopping cart when:
-
-
A shopping cart discount is applied
-
The following configuration options are set in System > Configuration >
- SALES > Tax > Calculation Settings:
-
-
Catalog Prices is set to Including Tax
-
Tax Calculation Method Based On is set to Excluding Tax
-
Apply Customer Tax is set to After Discount
-
Apply Discount On Prices is set to Including Taxes
-
-
-
-
-
-
-
-
Display Issues
-
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
- store:
-
-
- Shipping prices
- including tax display properly in the shopping cart.
-
- A special price now
- displays correctly on the product view page.
-
- Values displayed in
- PDFs for invoices and credit memos no longer overlap each other.
-
- Orders, invoices,
- and credit memos for downloadable and virtual products display the correct row total when viewed in the Admin
- Panel.
-
- Orders display the
- FPT in the Admin Panel when the full tax summary is specified.
-
- Fixed-price
- bundled products that include FPT now display only one price for both From and To values, regardless of how you
- configured the products.
-
-
-
-
-
Bundled Products Issues
-
-
- The price of a
- dynamic bundled product is calculated correctly after being customized by the customer.
-
- The price of a
- dynamic bundled product with tiered pricing is calculated correctly after being customized by the customer.
-
- Resolved issues
- with calculating the value displayed for the price including tax for bundled products.
-
- The price
- excluding tax of a bundle product to which a discount is applied is the same:
-
-
When viewed on the customization page
-
after adding the bundled product to the shopping cart.
-
-
-
- A dynamically-priced
- bundled product's prices displayed for Unit Price in the shopping cart (that is, the price including tax and the
- price excluding tax) are now correct. Before the fix, the prices were equal, which was incorrect.
-
- The
- price of a bundled product displayed on the product view page and in the shopping cart are the same.
-
- The grand total
- including tax and the subtotal including tax displayed in the shopping cart are now identical when you specify
- that catalog prices include tax and the shopping cart is set to display prices with and without taxes for a
- dynamic bundled product that consists of two simple products.
-
-
-
-
Fixed Product Tax (FPT) Issues
-
-
- Resolved
- issues in calculating FPT on a credit memo.
-
- With both
- discounts and FPT enabled (and FPT is taxable), the subtotal including tax displayed in the shopping cart is
- correct.
-
- FPT calculation
- for bundled products that have FPT applied to them now are now correct for all FPT configuration settings.
-
- The invoice total
- is calculated correctly for an order that has both FPT and a shopping cart discount.
-
- The FPT amount is
- now included in the Subtotal (Incl.Tax) row for partial invoice.
-
- Resolved an issue
- that resulted in FPT being applied twice to the grand total in the shopping cart.
-
-
-
-
-
Fixes in Magento EE 1.13.1.0
-
Fixes in this release can be divided into the following categories:
- Abandoned cart
- e-mails are sent at the scheduled time.
-
- Resolved a new
- customer registration issue that enabled a user to register and see another customer's dashboard.
-
- Resolved issues with
- breadcrumbs disappearing or displaying incorrectly.
-
- With the following
- configuration, gift pricing is applied properly for more than one item.
- The following options are available in the Admin Panel in System >
- Configuration > SALES > Sales > Gift Options:
- Allow Gift Wrapping on Order Level set to No
- Allow Gift Wrapping for Order Items set to Yes
-
- Category and
- subcategory names display correctly. Before the issue was resolved, subcategory names that were significantly
- longer than the category name did not display properly.
-
-
- If a customer adds
- more than one product that requires products to be purchased in increments, only the products that meet the
- increment requirements are added. Before the fix, all products were added.
-
- Scheduled payments
- work properly.
- Magento thanks Sylvain Raye for contributing to this fix.
-
- If a bundled or
- configurable product is out of stock, it's no longer available to check out.
- Magento thanks Francesco Marangi for contributing to this fix.
-
- Placing an order
- in the Admin Panel correctly sets the order status to Pending.
- Magento thanks GitHub user elframan for contributing to this fix.
-
-
-
-
-
Import and Export Fixes
-
-
- Scheduled export
- works properly.
-
- You can now export
- a shipment to CSV after printing its shipping label.
- Magento thanks Florinel Chis for contributing to this fix.
-
-
-
-
Shipping Fixes
-
-
- You are not
- required to enter a declared value to ship with FedEx.
-
- FedEx shipping
- labels print properly; addresses are not truncated.
-
- Fix for the USPS
- change to the names of their Priority and Express shipping options in their API made on Sunday, July 28, 2013.
-
-
-
-
Payment Fixes
-
-
- The PayFlow Pro
- payment method now allows line items with a negative value.
-
- You can now use the
- GSI Payment Service with Magento Payment Bridge.
-
-
Made the following fixes to eWay Direct:
-
-
- Updated the
- Payment Bridge console for eWay Direct.
-
- You can now
- process credit memos for eWay Direct.
-
- Capture for eWay
- direct now works as expected (that is, after the order is placed, the transaction is not captured but
- can be refunded.
-
-
-
(
- Because refunds are
- not supported by the Paybox Direct method, you cannot process refunds using the Admin Panel.
-
- After creating a
- refund for a First Data transaction, the transaction is closed.
-
- You can now pay for
- an order using Sagepay.
-
- You can now pay for
- an order using Worldpay.
-
- Line item details
- are now available for orders placed using Sage Pay.
-
- Authorize.net sends
- only one validation request per transaction with Customer Information Management (CIM) enabled.
-
-
-
-
-
Other Fixes
-
-
- Resolved issues that
- caused spurious errors in the Magento exception log:
- 'Zend_Date_Exception' with message 'Invalid year, it must be between -10000 and 10000'
-
- Merging CMS pages no
- longer results in errors.
-
- Widgets display
- properly on the CMS.
-
- Previewing a CMS page
- works properly.
-
- The product attribute
- option Use Default Value works properly when used in a non-default store view.
-
- A category attribute
- set to store view scope displays in layered navigation.
-
- A store set for
- British Pound Sterling currency units now displays the correct currency in payment logs.
-
- Resolved an issue with
- the Mage_Catalog_Block_Product_Abstract class that caused errors to display on product view pages in
- your web store.
-
- Fixed issues with
- customer segments.
-
- Back-in-stock e-mails
- contain the correct content.
-
-
-
-
-
-
-
- You can now manage
- product ratings and reviews from the Admin Panel as well as from the web store.
- Magento thanks Fabian Blechschmidt Schrank for contributing to this fix.
-
-
- Resolved an issue
- with Mage_Page_Block_Template_Links::addLinkBlock to enable you to sort an array of results by
- position.
- Magento thanks Benjamin Marks for contributing to this fix.
-
-
-
-
Magento EE 1.13.0.2 Release Notes
-
In response to customer feedback about EE 1.13.0.0 and EE 1.13.0.1, Magento has modified the functionality to
- smooth the migration path from earlier EE versions and support duplicate category URL keys.
-
See the following sections for a discussion of changes in this release:
Perform all new installations and upgrades to Magento EE 1.13.0.2—not to Magento EE
- 1.13.0.0 or 1.13.0.1—to avoid issues with missing products on your web store due to duplicate URL
- key issues during the upgrade.
The main difference introduced in EE 1.13.0.2 is that product URL keys must be globally unique among all
- websites, stores, and views. You can no longer have two different products that have the same URL key.
-
Benefit:
-
A single URL leads uniquely to a product page.
-
Discussion:
-
-
In EE 1.12, it was possible to have multiple products with the same URL key; however, every time the indexer
- ran, it silently assigned a numerical suffix to duplicates (for example, shoes became
- shoes-1 and so on).
-
Every time this happened, another URL rewrite was created, resulted in a set of chained redirects for
- the same product. Having multiple URLs for a product dilutes the effectiveness of URL in search engine
- weightings, especially if you enabled canonical URLs. (As discussed in this
- article on Google's blog, a canonical URL is a public specification of your preferred URL. The
- canonical URL is used by any search engine when crawling and indexing your site.)
-
This behavior was not clear to merchants and had the effect of diluting search engine weightings.
-
In EE 1.13.0.2, there is a single, unique way to access a product (or multiple ways if you use the category
- path in URLs).
-
-
-
-
No more chained redirects
-
-
Description:
-
Magento addressed the indexer issue that resulted in suffixes being silently added to products with duplicate
- URL keys. In EE 1.13.0.2, duplicate URL keys are not allowed.
-
Benefit:
-
Search engines recognize the canonical URL, which improves the product's weighting in search results. (All of
- the weighting goes to the canonical URL.)
-
-
-
Per-entity indexing
-
-
Description:
-
EE 1.13.0.2 uses per-entity indexing that indexes custom URL redirects, categories, and products—as
- opposed to a global indexer.
-
Benefit:
-
-
Similar to chained redirects, in EE 1.12, if a product had the same URL key as its parent category, the indexer
- assigned an incrementing numeric suffix to either the category or the product. This was done without the
- merchant's knowledge and was confusing as well.
-
-
Discussion:
-
-
In EE 1.12, if you named a top-level category slippers and had product also named
- slippers, the indexer allowed to access to the category using a URL like the following:
- http://www.example.com/slippers-1
-
In EE 1.13.0.2, the same product can be accessed using a URL like:
- http://www.example.com/slippers
-
There is a new Admin Panel setting to specify how indexing should be prioritized. This setting,
- System > Configuration > CATALOG > Catalog > Search
- Engine Optimizations > Priority for Duplicated URL Keys, is discussed in more
- detail in Prioritizing URL Resolution.
-
-
-
-
-
-
URL Key Uniqueness Rules in Magento EE 1.13.0.2
-
The following entities can be indexed and therefore have a requirement for URL key uniqueness:
-
-
Categories
-
Products (including custom URL redirects)
-
Content Management System (CMS)
-
-
Uniqueness rules for each entity type follow:
-
-
-
-
Entity type
-
Uniqueness rule
-
-
-
Product, including custom URL redirects†
-
All product URL keys must be globally unique.
-
-
-
Category
-
-
Category URL keys must be unique only in the same level in the hierarchy; for example
- website
- root category
- store view
- category tree
- *category name*
-
Note: Uniqueness rules apply to inactive categories as well. You cannot use the same URL
- key for both an active and inactive category at the same level in the category hierarchy.
-
-
-
-
CMS
-
CMS URL keys, like category URL keys, must be unique only in the same level in the
- hierarchy.
-
-
-
-
†—Custom URL redirect refers to a product's Create Custom Redirect
- for old URL option.
-
-
URL Key Examples
-
The following table shows category URL keys that are allowed. (The URL key is shoes for all entities
- in the table.)
You cannot have the same category URL key for two categories at the same level in the same store
- view.
-
You can optionally add the store code to the URL path (in the Admin Panel, click System >
- Configuration > GENERAL > Web, Add Store Code to Urls).
-
-
-
Prioritizing URL Resolution
-
Suppose you have the following set of URL keys. All of them are allowed because they're for different entity types.
-
-
-
-
-
Entity type
-
Entity name
-
URL key
-
Sample URL
-
-
-
Category
-
shoes
-
shoes
-
http://www.example.com/shoes.html
-
-
-
Product
-
shoes
-
shoes
-
http://www.example.com/shoes.html
-
-
-
Custom URL redirects
-
shoes
-
shoes
-
http://www.example.com/shoes.html
-
-
-
-
Question: What happens when a web store visitor requests
- http://www.example.com/shoes.html?
-
Answer: You control the response in the Admin Panel. Click System >
- Configuration > CATALOG > Search Engine Optimizations. In the right pane, click an
- option from the Priority for Duplicated URL Keys list. Some examples follow:
-
-
-
-
Priority setting
-
Result
-
-
-
Default setting:
-
-
Redirect†
-
Category
-
Product
-
-
-
Custom URL redirect
-
-
-
-
-
Category
-
Redirect
-
Product
-
-
-
Shoes category
-
-
-
-
†—Custom URL redirect refers to a product's Create Custom Redirect
- for old URL option.
-
The other options are:
-
-
Redirect - Product - Category
-
Category - Product - Redirect
-
Product - Redirect - Category
-
Product - Category - Redirect
-
-
In the event no URL key matches your priority setting, Magento continues through the priorities in order until a
- match is found.
- After changing the
- value for product or category suffix, previous suffixes do not work.
-
For example, if a category URL suffix was set to .html and you change it to .php,
- categories that had been using the .html suffix display an HTTP 404 (Not Found) error in your web store.
-
(In the Admin Panel, click System > Configuration > CATALOG >
- Catalog > Search Engine Optimizations. In the right pane, the options are named
- Product URL Suffix and Category URL Suffix.)
-
-
Patch Available for EE 1.13.0.2
-
The United States Postal Service (USPS) changed the names of their Priority and Express shipping options in their
- API on Sunday, July 28, 2013. Magento has a patch available; however, this patch is not included in new EE 1.13.0.2
- installations.
-
Note: If you applied the patch before you upgraded to EE 1.13.0.2, you don't
- have to do anything.
-
-
For new EE 1.13.0.2 installations to continue utilizing USPS Priority and Express mail methods, you must
- install the patch we've created to address the issue.
-
Get the patch from the EE support portal by logging in to magentocommerce.com.
-
-
Changes in EE 1.13.0.2
-
-
- You
- now have the option of specifying a store view when creating a URL redirect. There is also a Store column on the
- Catalog > URL Redirects page.
- This column specifies the store view for which the URL redirect is defined.
-
- Root categories have
- no URL Key field. The root category URL key was never used, so the field was eliminated.
-
- Validation
- for the URL key field was improved. URL keys can only contain alphanumeric characters (a-z, 0-9)
- and the hyphen or dash character (-).
-
- Categories and
- products in categories display with the full category path if the following setting is made in the Admin Panel:
- System > Configuration > CATALOG > Catalog. Set the option
- named Use Categories Path for Product URLs to Yes.
-
- When setting up a
- product URL redirect, the name of the button on the category selection page has changed from Skip choosing
- category to Skip Category Selection.
-
- There is a new
- setting in the Admin Panel to set the priority for resolving duplicate URLs for different entities (that is,
- custom URL redirects, categories, and products). For more information, see Prioritizing URL Resolution.
-
URL key uniqueness rules apply to inactive categories as well. You cannot use the same URL key for both an
- active and inactive category at the same level in the category hierarchy.
-
The Google sitemap for products and categories is updated with new or updated URL keys at the interval you
- specify in the Admin Panel: System > Configuration > CATALOG > Google
- Sitemap. In the right pane, expand Generation Settings.
-
The following apply to new products when you do not explicitly set a value for the URL key
- field:
-
-
Duplicating a results in a URL key with an appended index number. For example, if you duplicate a product
- with a URL key of testurlkey, the new product's URL key might is testurlkey-1.
-
If you create a new product with a name that matches an existing URL key, the new product's URL key has the
- product ID appended to it. For example, if there is currently a product with a URL of product1
- and you create a new product with the name Product1 and the product has an ID of 500, the new
- product's URL key is product1-500.
-
Note: To avoid having Magento specify a URL key for you,
- you can enter one yourself. Make sure the URL key you specify is unique among all products, including
- products across store views.
-
-
-
-
The following apply to enabling the canonical meta tag options for categories and products:
-
-
If Use Canonical Meta Tag for Categories is enabled, the category page on your web store
- includes a canonical URL to the full category URL. For example, http://www.example.com/mens/shoes
-
-
If Use Canonical Meta Tag for Products is enabled, the product page includes a canonical
- URL to domain-name/product-url-key because product URL keys must be globally
- unique.
- If you also enable the option Use Categories Path for Product URLs, the canonical URL is
- still domain-name/product-url-key but the product can also be accessed using
- its full URL (including the category hierarchy). Examples:
- If the product URL key is producturlkey and it's assigned to the Apparel > Womens >
- Purses category, the product can be accessed using both of the following URLs:
- http://www.example.com/producturlkey
- http://www.example.com/apparel/womens/purses/producturlkey
- The canonical URL for the product is http://www.example.com/producturlkey.
-
Notes:
-
The canonical URL options are available in the Admin Panel by clicking System >
- Configuration > CATALOG > Catalog. In the right pane, expand
- Search Engine Optimizations. The options are named Use Canonical Link Meta Tag
- For Categories and Use Canonical Link Meta Tag For Products.
-
The option to add the category path to a product URL is available in the same location in the Admin
- Panel. The option name is Use Categories Path for Product URLs.
-
-
-
-
-
Fixes in Magento EE 1.13.0.2
-
This section discusses fixes made in EE 1.13.0.2.
-
-
- Resolved a
- critical database deadlock in the URL rewrite indexer. The deadlock resulted in the following message in the
- exception log: SQLSTATE[40001]: Serialization failure: 1213 Deadlock found when trying to get
- lock.
-
- The following
- layered navigation issues were addressed:
-
-
If a subcategory contains a product that is associated with the parent category, you can view the
- subcategory in your web store.
-
Clicking a link for a product attribute in an anchor category works.
-
-
-
- You can now
- install or upgrade to EE 1.13.0.2 if your Magento database had a table prefix (for example, all tables start
- with mage_ because you specified a tables prefix during installation).
-
Resolved the following upgrade issues:
-
-
- After
- upgrading from an earlier version like EE 1.12.0.2, errors such as the following no longer display in the
- Magento exception log:
- SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry
-
-
- Resolved an
- issue that prevented web store users from viewing products that had duplicate URL keys before upgrading.
-
-
-
-
-
-
Resolved the following issues with URL keys in store views:
-
-
- Changing
- the store view no longer results in product or category 404 (Not Found) errors.
-
- Resolved an
- issue that categories created from a store view had the wrong URL format in the web store. Examples
- follow:
- Incorrect (before the fix): /catalog/category/view/s/newcategory/id/36/
- Correct: /catalog/newcategory/
-
-
-
- Resolved an
- issue where a product could be viewed using a category to which it was not assigned.
- This behavior was associated with the following Admin Panel setting: System >
- Configuration > CATALOG > Catalog.
-
- Moving a
- category no longer results in HTTP 404 (Not Found) errors viewing a category's product in the web store.
-
-
-
- Categories
- display in the web store with the correct URL key, even if the category was previously deleted and added back
- with the same URL key.
-
- A customer can
- view a product from the Recently Viewed Products list if the product is associated with a different category
- than the one the customer is currently viewing.
-
- Any product
- page displays properly when the user accesses it from the site map on your web store.
- This includes the case when an administrator sets the following option to Yes:
- System > Configuration >CATALOG > Catalog
- > Search Engine Optimizations, option named Use Categories Path for Product
- URLs.
-
- The category is
- not included in the URL to a product in your web store when an administrator sets following option to
- No: System > Configuration >CATALOG >
- Catalog > Search Engine Optimizations, option named Use Categories
- Path for Product URLs.
-
- The URLs for
- the same category and product, when assigned to multiple store views, are as expected.
- Category URL example: /parent-category/category-2/
- Product URL example: /parent-category/category-2/product-1
-
- With the option
- to Add Store Code to URLs option enabled, store codes properly display in URLs and the store view displays
- properly.
-
- After
- duplicating a product, the product's URL key updates successfully.
-
- A product URL
- key is correct in your web store even if there is a category with the same URL key as the product.
-
- Adding products
- without specifying a value for the URL Key field no longer results in the exception log entry
- SQLSTATE[23000]: Integrity constraint violation.
-
- You can create
- two or more categories with the same URL key without encountering the exception log entry
- SQLSTATE[23000]: Integrity constraint violation.
-
- The value of a
- product's URL Key field is properly validated.
- A URL key can contain only alphanumeric characters (a-z, A-Z, 0-9) and the dash or hyphen character.
-
- A caching error
- that affected changing URL redirects was fixed.
-
- URL redirects
- work properly when products are assigned to categories in different store views but using the same request
- path.
-
- You can
- successfully import data and reindex with the import behavior set to Append Complex Data.
-
- After moving a
- category to another location in the category hierarchy, the category's URL and breadcrumbs update
- successfully.
-
- The options to
- create a custom redirect for a category and product work properly.
- (In the Admin Panel, click System > Configuration > CATALOG >
- Catalog > Search Engine Optimizations. In the right pane, from the
- Create Permanent Redirect for URLs if URL Key Changed, click Yes.
-
- Switching store
- views enables you to navigate to products and categories on that store view as expected. HTTP 404 (Not Found)
- errors no longer display and the specified category and product URL keys are correct.
- In earlier EE versions, incorrect behavior was reported when the setting System >
- Configuration > GENERAL > Web, Add Store Code to Urls was
- set to Yes.
-
- A remote code
- execution vulnerability was fixed.
-
-
-
- On
- a clean installation, display errors are hidden.
-
-
-
-
-
Magento EE 1.13.0.0 Release Notes
-
See the following sections for information about changes in this release:
Major overhaul of tax calculation formulas, correction of rounding errors, and additional assistance with
- configuration
-
- Most indexing processes now run only to update products, categories, URL redirects, and so on that
- have changed—eliminating the need for manual full reindexing
- Full page caching now invalidates only pages that are affected by product or category changes
-
Optimized cache adapters for single-server systems
-
Elimination of many types of database deadlocks
-
-
-
Security Enhancements
-
-
The Magento Admin Panel and web stores no longer allow web browsers to store usernames or passwords.
-
The Magento web store has additional Cross Site Request Forgery (CSRF) protections, meaning an imposter can
- no longer impersonate a newly registered customer and perform actions on the customer's behalf.
-
In earlier versions, Magento was vulnerable to a session fixation attack during the registration process.
- After logging in to their account, a registered user's session ID did not change. Therefore, if an attacker
- had knowledge of an unauthorized session ID and if that user successfully registers, the attacker was able to
- take over the newly registered account.
- Now, the session ID changes after successful registration, making unauthorized use of an account impossible.
-
-
The cryptographic methods used to store passwords were improved to enhance security.
-
-
-
-
Security Advisory
-
Magento has identified a potential vulnerability that might affect you if both of the following are true:
-
-
Your store uses custom code that calls Magento full page caching functions
-
You enabled the Use SID on Frontend configuration option
- (In the Admin Panel, System > Configuration > WEB > Session
- Validation Settings, Use SID on Frontend.)
-
-
Note: The potential vulnerability exists only if both
- of the preceding are true. Default Magento installations or installations that enable Use SID on
- Frontend but have no custom code with full page caching are at no risk.
-
-
If both of the preceding are true, Magento can be subjected to cross-site scripting
- (XSS) attacks—a type of injection issue, which means that malicious code is injected into otherwise
- trusted websites, generally in the form of a browser-side script.
-
Issue: Magento is subject to XSS attacks because the SID cookie value is not sanitized by default.
-
Suggested solution: Either disable Use SID on Frontend or output-encode any usage of the SID cookie value before using it or passing it as a
- parameter to any page cache helper functions.
Magento EE 1.13—unlike earlier versions—does not allow duplicate URL keys for products or
- categories. An issue has been identified that causes problems during upgrades if you already have duplicate URL
- keys. The issue is being addressed; until a solution is announced, Magento recommends you test your upgrade but
- do not try to deploy it to a production environment.
Limited the way Magento performs large database lookups.
-
-
-
Checkout performance improvements achieved by:
-
-
Eliminating unnecessary calls to gift wrapping when loading the Shipping Method checkout step
-
Eliminating unnecessary RSS cache cleanups when RSS functionality is disabled
-
The locale used to send a new order confirmation e-mail now first checks to see if the customer's locale
- is the same as the store's locale before attempting to localize the e-mail.
-
-
-
Improving the overall checkout process performance by loading the progress information for the current
- checkout step only
-
-
-
You can load a large number of tax codes (35,000 or so) without impacting performance.
-
-
The following general fixes were made to Magento tax configuration and calculations:
-
-
Based on Magento testing and merchant experience, certain tax configuration settings have been determined to be
- susceptible to rounding issues and can be confusing to buyers. To help you avoid issues with those settings,
- warning messages display in the Admin Panel if you attempt to save such a configuration.
- Administrative users can choose to dismiss the messages and can still save the configuration; however, Magento
- strongly recommends you change the configuration in a way recommended by the details displayed in the
- message.
- For details, see the Magento
- User Guide.
-
-
-
Bundle pricing is more consistent as follows:
-
-
The calculation formula is:
- Sub item price = Sub item base price * Applicable tiered price adjustment or discount, then rounded
- Bundle price = Sum (round(sub item price * qty))
-
When non-integer quantities are multiplied by a product price, Magento rounds the resulting subtotal is as
- follows:
- round(unit price * non-integer quantity)
-
-
-
All product price information on which taxation is based are rounded to two digits of precision regardless of
- how many digits of precision have been loaded into the database (for example, $10.24 instead of $10.2385). This
- situation can occur when certain integrations enable third-party applications to send four-digit precision prices
- to Magento.
- Starting with this release those additional digits will have no impact on customer facing prices. Forcing two
- digits of precision enables more exact calculations involving Fixed Product Tax (FPT), discounts, and
- taxes—among other concerns.
-
-
-
For certain Canadian provinces and localities, calculations and methods were updated to support changing legal
- requirements in Canada:
-
The following issues relate to one-cent rounding errors in the web store or shopping cart:
-
-
Calculating taxes for bundled products with tiered pricing.
-
Calculating the price before customization for bundled products.
-
-
-
Calculating the grand total of items added to a cart in a different order.
-
Viewing an order when taxes are calculated after a discount using either row-based or unit price.
-
-
-
Applying a discount to an order with a shipping address different than the billing address.
-
-
-
Calculating the grand total based on the order in which products are added to the shopping cart.
-
-
-
Specifying that prices display in the web store excluding tax and setting a 20% tax rate (or discount rate) now
- calculates the grand total correctly. It is now possible to have grand totals in amounts like 6.99, 9.99, or
- 99.99—regardless of the currency units used in the web store.
-
-
-
Adding multiple items to a cart does not affect the accuracy with which taxation is calculated.
-
-
-
Subtotal (Incl. Tax) is now correct when catalog and shipping prices include tax. Both tax and discounts are
- applied after tax.
-
-
-
Prices displayed in the cart and on the catalog page are consistent and correct when catalog prices include tax,
- and when items in the catalog are set to display both including and excluding tax.
- (In the Admin Panel, click System > Configuration > SALES >
- Tax. In the right pane, expand Calculation Settings.)
-
-
-
Error in calculating the Grand Total Excl. Tax was resolved. This error occurred in a specific configuration:
- tax is applied to FPT, FPT is included in the subtotal, and the customer selects non-taxable flat rate shipping.
-
-
-
-
-
-
Fixed Product Tax (FPT) Fixes
-
The following issues relate to errors in calculating taxes that include FPT in the web store or shopping cart:
-
-
Price in the cart displays the correct before-tax price and grand total.
-
-
-
Subtotals displayed in the cart—both Including Tax and Excluding Tax—are now correctly calculated
- when FPT is applied.
-
Free shipping offers are now processed correctly when FPT is applied.
-
FPT taxes are calculated correctly when a discount is applied.
-
-
-
-
-
Discount Calculation Fixes
-
The following issues relate to price calculations when coupon codes or other discounts are applied in the web store
- or shopping cart:
-
-
The Row Subtotal displayed in the cart is calculated correctly (that is, both Excl. Tax and Incl. Tax are
- correct).
-
The price for bundled items now displays with tax included if the bundle is configured to do so.
-
Taxation is now correctly calculated on a product with a discounted price.
-
Taxation on discounts is now calculated correctly when the ship-to country is different from the web store's
- default country.
-
-
-
Display Fixes
-
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
- store:
-
-
Row Subtotal displays correctly in the shopping cart when:
-
-
FPT is applied.
-
-
-
A discount is applied to a situation where the tax the customer pays is different from the tax specified for
- the web store's locale (for example, when the shipping origin is different than the shipping address).
-
-
-
-
-
Subtotal including tax on a credit memo is correct when one or more items in the memo includes FPT.
-
-
-
Item subtotal displays correctly when a discount is applied to a purchase that includes FPT.
-
-
-
If the administrator sets catalog prices to exclude tax and to display product prices in catalog as including
- tax, the price of the product in your web store includes applicable taxes.
-
- (In the Admin Panel, click System > Configuration > SALES >
- Tax. In the right pane, expand Calculation Settings.)
-
When Minimum Advertised Price (MAP) is enabled and the customer examines the price of a product in a gift
- registry, the price includes all of the following: price, actual price, price including tax, and price excluding
- tax.
-
-
-
The amount of tax displayed in the Order Totals section of the shopping cart is now correct when free shipping
- and a shopping cart rule discount are applied.
-
-
-
-
-
API Fixes
-
The following are fixed in the Magento SOAP v2.0 APIs (with exceptions noted):
-
-
Requesting a product using a call like the following returns the product with the specified numeric SKU value
- (8888 in the following example):
- $result = $client->call($sessionId, 'catalog_product.info', '8888', null, null, 'sku');
-
-
You can now use from-to complex filters to perform "window" filtration on a single
- field. For example, you can use from and to on the created_at return a list
- of sales orders using the salesOrderList.
-
-
-
When you use the SOAP API v.2.0 with WS-I Compliance enabled to retrieve sales orders information, the server responds with the
- correct Content-Length header.
-
-
-
The productGetSpecialPrice method returns special price information for a product, whether or not
- WS-I Compliance is
- enabled.
-
-
-
The shoppingCartPaymentList method returns the list of the available payment
- methods for the shopping cart appropriately. The following error is no longer returned:
- SOAP-ERROR: Encoding: object has no 'code' property in name
-
-
You can now add a C# web reference in Microsoft Visual Studio 2010 using the Magento WSDL.
- For example, this command no longer fails:
- C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin> wsdl /out:Magento.cs /v
- http://magentohost/api/v2_soap/?wsdl
-
-
When a product price is set with website scope and an administrative user has access to only one website, the
- default price is taken from that website scope. Also, when saving the product on the website scope, the price is
- updated only in that scope and not in the default scope.
-
-
-
An error no longer displays on your web store after a customer places an order. (The error message was
- There has been an error processing your request. Please contact us or try again later).
-
-
-
Restricted coupon codes work properly, even if the customer has selected the Remember me
- checkbox.
-
-
-
Using the Table Rates shipping option, free shipping options work properly. (In the Admin Panel, click
- System > Configuration > SALES > Shipping
- Methods. In the right pane, expand Table Rates.)
-
-
-
Issues with shipping table rates have been resolved.
-
-
-
Reward Points are now granted one time per order, even when comments are added to the order later.
-
-
-
Entering a value such as 10,50 (using a comma character and not a period) for Adjustment
- Fee now results in the correct amount of credit being applied to the transaction.
-
-
-
Unit price for bundled products is now calculated correctly.
-
-
-
The tiered price of bundled items now displays properly on the web store.
-
-
-
Composite products can be successfully reordered.
-
-
-
You can now use special characters in a product URL key.
-
-
-
After a customer visits the sitemap, web stores URLs are no longer prepended by
- /sitemap/catalog/string.
-
-
-
Welcome messages now display properly in the web store after a customer's profile information is changed.
-
-
-
Recently viewed products now display updates properly.
-
-
-
Armed Forces Middle East is now available for State when checking out.
-
-
-
Gift wrapping charges now display properly in a PDF invoice.
-
-
-
Searching for a customer's orders and returns works properly.
-
-
-
Shipping is calculated correctly if you select Using origin weight (few requests) for
- Packages Request Type. (In the Admin Panel, click System >
- Configuration > SALES > Shipping Methods > DHL (Deprecated)).
-
-
-
Free shipping is no longer available to a customer during checkout if the option was disabled by an
- administrator. (In the Admin Panel, click System > Configuration >
- Sales > Shipping Method > DHL(Deprecated), click one or more
- options from the Allowed Methods list, and, from the Free Shipping with Minimum Order
- Amount list, click No.)
-
-
-
A user can navigate your web store while downloading a downloadable product.
-
-
-
You can now specify weight units in kilograms (kg) using the FedEx shipping method.
-
-
-
FedEx shipping rates are now consistent with Magento discounted rates.
-
-
-
Fixed issues with United Parcel Service (UPS) shipping rates.
-
-
-
An issue that caused a fatal error in the web store for an item in a gift registry has been resolved. The issue
- occurred when the item was removed from a website after a user had added the item to their gift registry.
-
-
-
UPS shipping labels have the word SAMPLE printed on them only when you request a sample label.
-
-
-
Changes made to United States Post Office (USPS) APIs and rates have been incorporated in Magento.
-
-
-
You can now process a return materials authorization (RMA) for an order that was shipped to multiple addresses.
-
-
-
The products in a customer's wish list no longer disappear after one or more products are edited by an
- administrator.
-
-
-
Administrators can view the contents of a customer's shopping cart.
-
-
-
The price of a simple product now displays properly when category permissions are enabled. (To set category
- permissions in the Admin Panel, click Catalog > Categories > Manage
- Categories, select a category, and click the Category Permissions tab.)
-
-
-
Issues with purchasing a product using a gift card created with a custom option have been resolved.
-
-
-
- When a customer selects a product on your web store, the assigned category is selected in the
- navigation menu.
-
-
-
- With both flat index options enabled and set to update on save, mass attribute updates now display
- properly in your web store.
- For more information about flat catalog options, see the Magento User Guide.
-
-
-
- With both flat index options disabled, after adding a product to many websites and assigning it to
- one or more categories, the product displays in the appropriate websites and categories in the web store.
-
-
-
- You can now use multiple selection attributes in a customer segment.
-
-
-
-
-
Promotional Price Rule Fixes
-
The following fixes relate to administering and using shopping cart price rules and catalog price rules:
-
-
Shopping cart price rules applied to specific customer groups work properly.
-
-
-
Catalog price rules are applied properly to customer groups.
-
-
-
The scope of a product attribute is now honored by a catalog price rule.
-
-
-
Discounts specified by a shopping cart price rule are applied properly when a particular order is shipped to
- multiple addresses.
-
-
-
You can add a gift card to an order that qualifies for a 100% purchase price discount specified by a shopping
- cart price rule.
-
-
-
A discount specified by a shopping cart price rule that allows for more than one use per customer is applied the
- correct number of times if the customer has their orders shipped to more than one address.
-
-
-
-
When an administrative user whose role is restricted to only viewing catalog price rules, the user cannot add or
- edit catalog price rules.
-
-
-
Shopping cart price rules now work properly with bundled products.
-
-
-
-
-
Administrative Ordering and Credit Memo Fixes
-
-
When you create an order using the Admin Panel and you have multiple stores, the State/Province
- field updates appropriately for the country in which the order is placed.
-
-
-
When you create an order using the Admin Panel and you have specified a default billing address and a default
- shipping address, the addresses are used correctly.
-
-
-
Orders placed by an administrator display in a customer's last order list.
-
-
-
Product comparisons now display properly when an administrator makes a change using the Admin Panel (for
- example, deleting a product from a customer's comparison list).
-
-
-
You can now cancel an order using the Admin Panel.
-
-
-
Orders and invoices that include taxable shipping—when created in the Admin Panel—now calculate the
- shipping taxes properly.
-
-
-
Products added to a customer's wish list by an administrator display properly.
-
-
-
Issues with the incorrect number of reward points being credited when issuing credit memos have been resolved.
-
-
-
-
-
Import Fixes
-
-
The quantity (QTY) of all products imports correctly.
-
-
-
The value of Maximum Qty Allowed in Shopping Cart (use_cfg_max_sale_qty) is correct.
-
-
-
The product displays correctly in layered navigation.
-
-
-
Importing customer lists with capitalization variations in the e-mail address now imports the customer only once
- (for example, user@example.com and User@example.com).
-
-
-
- Issues with importing products with Append Complex Data selecting from a
- comma-separated value (.csv) file have been resolved.
-
-
-
-
Payment Fixes
-
-
Resolved issue sending customer e-mail when using Payflow Link.
-
-
-
Security issues with Google Checkout payments have been resolved.
-
-
-
Security issues with Authorize.net payments have been resolved.
-
-
-
Magento conforms to the latest version of the PayPal Instant Payment Notification (IPN) guidelines.
-
-
-
The contents of a shopping cart are unaffected by canceling a PayPal payment.
-
-
-
Issues with not being able to continue checkout after switching payment methods have been resolved.
-
-
-
You can now process partial refunds and invoices for orders that were placed using Payflow Pro.
-
-
-
Payflow Link and Payments Advance now capture IPN transactions properly.
-
-
-
Special characters (such as e-mail addresses) are now handled properly by the Magento Payflow API integration.
-
-
-
Resolved errors with orders placed using the Website Payments Pro payment method.
-
-
-
PayPal Express Checkout payments are handled properly when a shopping cart price rule is specified.
-
-
-
Any PayPal Name-Value Pair (NVP) payment method no longer automatically refunds an order when a chargeback is
- initiated. Magento now allows the dispute to be resolved before taking the appropriate action.
- PayPal NVP payment methods include: PayPal Payments Pro (including PayPal Payments Pro Hosted), Payments Standard,
- and all Payflow methods.
-
-
-
PayPal Pro now correctly processes the shipping address for an order.
-
-
-
PayPal Express Checkout and PayPal Pro now handle partial refunds properly.
-
-
-
Fixed rounding errors that were preventing PayPal Express Checkout transactions from completing. The error
- occurred with the following configuration:
-
-
tax calculation method based on the total
-
tax calculated based on the shipping address
-
catalog prices exclude tax
-
shipping prices exclude tax
-
customer discount applied after a discount
-
discount applied to prices excluding tax
-
tax applied to a custom price if available
- (In the Admin Panel, click System > Configuration > SALES >
- Tax. In the right pane, expand Calculation Settings.)
-
-
-
-
The order status Suspected Fraud is now supported by PayPal Payments Pro (hosted) when PayPal fraud protection
- is enabled. Using the Magento Admin Panel, the merchant can also accept or deny any Suspected Fraud orders and
- have that decision applied to the PayPal transaction.
-
-
-
- When sending payments in the United Kingdom, PayPal Payments Pro (hosted) now sends the value for
- state correctly. (Before the fix, city was sent as the value for state.)
-
-
Using the Ogone payment method, transactions display in the Magento Admin Panel after you capture them.
-
-
-
When an administrator places an order and uses PSi Gate, then cancels the order, the PSi Gate gateway displays
- both the order and the void transactions.
-
-
-
The following fields related to PayPal's Payflow Pro Gateway payment method are now implemented properly:
-
Fixed spurious Gateway error: Void error: V18A4B18E0F9 has been captured errors when canceling
- partially invoiced orders when the Payflow Pro processor was used to process the payment.
-
-
-
3-D secure fixes that affect UK merchants only:
-
-
3-D Secure for UK merchants implementing Direct Payment works properly.
-
-
-
SagePay Direct with 3-D secure payments are processed correctly.
-
-
-
-
-
The Braintree payment method can now be configured properly.
-
-
-
Partial captures are now supported for the following PayPal payment methods: Express Checkout, Payments Pro
- Payflow Edition, and PayPal Standard.
-
-
-
Using the PayPal Express Checkout method, a recently added customer can check out without the error This
- customer email already exists.
-
-
A fatal error in GiftRegistry/Model/Item/Option.php has been resolved.
-
-
-
When an administrative user whose role is restricted to managing products attempts to edit Inventory settings
- (Catalog > Manage Products, Inventory), only the available
- options display.
-
-
-
Related product information updates appropriately in the Admin Panel.
-
-
-
Issues with editing product inventory settings and category attributes using the Google Chrome web browser have
- been resolved.
-
-
-
Rolling back after a backup now works properly. (The Magento backup and rollback options are available in the
- Admin Panel in System > Tools > Backup.)
-
-
-
You can now fetch data for a PayPal Settlement Report using a custom Secure FTP (SFTP) server.
-
-
-
- Using the Solr search engine with price navigation calculation step set to manual now displays
- search results properly on your web store. (A fatal error was fixed.)
- (To set price navigation step options in the Admin Panel, click System >
- Configuration > CATALOG > Catalog > Layered
- Navigation. From the Price Navigation Step Calculation list, click
- Manual.)
- For more information about using the Solr search engine with Magento EE, see the Magento User Guide.
-
-
-
You can now save a category with the option Available Product Listing Sort By: Best value or
- Price enabled.
-
-
-
- The following fixes relate to full page caching:
-
-
- Breadcrumbs to a product work for all categories with which the product is associated.
-
-
-
- The correct customer name displays on a gift card.
-
-
-
- Product tags display properly.
-
-
-
- Related products display properly.
-
-
-
- magento-install-dir/app/code/core/Enterprise/PageCache/Model/Config.php was
- modified to enable you to set specific lifetimes for certain blocks.
-
-
-
- Automated e-mail marketing reminder rules work properly.
-
-
-
- Issues with session cookies have been resolved.
-
-
-
-
-
-
-
-
Changes
-
This release includes the following changes to support the changes in indexing:
-
-
- As a result of the optimizations made to reindexing, you can no longer have a duplicate:
-
-
URL key for any two products
-
URL key for any two categories
-
Request Path for any URL Redirect (formerly referred to as URL Rewrite
-
-
-
- There is a new management page in the Admin Panel: System >
- Configuration > ADVANCED > Index Management.
-
- The options on the System > Index Management are significantly
- different. In particular, because manual reindexing is no longer required for most indexers, there are fewer
- checkboxes and the page mostly displays status information.
-
In the Admin Panel, Catalog > Manage Products > edit-product >
- General tab page option Create Permanent Redirect for old URL if URL key changed
- changes to Create Custom Redirect for old URL.
- The feature behaves the same way; namely, selecting Yes creates a redirect for the old URL that
- points to the new URL if a page is moved.
-
Note: The wording of this option is expected to change back to
- the previous wording in a subsequent release.
-
-
-
The options Product URL Suffix and Category URL Suffix return an error if
- anything except alphanumerical characters or the underscore character are entered. (In the Admin Panel,
- click System > Configuration > CATALOG > Catalog >
- Search Engine Optimizations.)
-
- The catalog_product_entity_url_key and catalog_category_entity_url_key
- database tables for the corresponding url_key attributes have been added.
-
-
-
-
- For more information about indexing changes, see the Magento User Guide.
-
-
-
-
-
-
diff --git a/guides/m1x/ce18-ee113/ht_magento-ce-sample.data.html b/guides/m1x/ce18-ee113/ht_magento-ce-sample.data.html
deleted file mode 100644
index c6e67a7bb5..0000000000
--- a/guides/m1x/ce18-ee113/ht_magento-ce-sample.data.html
+++ /dev/null
@@ -1,45 +0,0 @@
----
-layout: m1x
-title: Installing Sample Data for Magento Community Edition (CE)
----
-
-
Overview
-
This page discusses how to get the sample data for:
-
-
Magento Community Edition (CE) 1.6, 1.7, or 1.8
-
Magento Community Edition (CE) 1.9.0.0
-
Magento Community Edition (CE) 1.9.1.0–1.9.2.0
-
-
-
Important: Magento CE 1.9 and later use different sample data from the other versions in
- the preceding list. Make sure you use the correct version of sample data
- with your version of Magento CE.
-
-
Install Sample Data Before You Install Magento
-
Magento CE sample data must be installed before you install Magento CE.
-
-
Getting the Sample Data
-
- The sample data is provided in different formats for your convenience.
- Archives for each version have exactly the same content (they differ only by compression method).
-
Redis is an open source, Berkeley Software Distribution (BSD) licensed, advanced key-value store that can optionally be used in Magento for backend and session storage. In fact, you can replace memcached with Redis.
-
Following are some of the benefits Redis provides for Magento implementations:
-
Redis supports on-disk save and master/slave replication. This is a powerful feature not supported by memcached. Replication enables high availability by eliminating a single point of failure.
-
Redis can be used for PHP session storage.
-
Redis provides much better eviction control and its backend is written with eviction support in mind.
-
Redis supports multiple databases that use the same server instance so you can use different databases for the Magento cache, full page cache (EE only), and sessions without starting many processes listening on different ports.
-
Redis supports compression libraries gzip, lzf, and snappy. lzf and snappy are much faster than gzip.
The following Magento editions support Redis session and backend caching:
-
Enterprise Edition (EE) 1.13 and later
-
Community Edition (CE) 1.8
-
The preceding Magento editions support Redis server version 2.6.9 and later available from redis.io.
-
In addition, you can optionally use the Redis extension for PHP version 2.2.3 or later if you're using Redis for backend caching; however, Magento works without this extension.
-
-
Configuring Redis
-
To use Redis with Magento, you must configure Magento to use Redis and you must install and configure the Redis server. These tasks are discussed in the following sections:
To use Redis with Magento, you only need to install and configure the Redis server. The integration between Redis and Magento is already included with Magento CE 1.8 and EE 1.13 and later versions. All you need to do is configure it.
-
Important: The Cm_RedisSession module in CE 1.8 is disabled by default. Magento disables the module to avoid unnecessary connection tries to Redis when you choose to use file, database, or a different session storage method.
-
To enable Magento to use Redis, perform the following tasks:
-
Enable the Cm_RedisSession module.
-
Open magento-install-dir/app/etc/modules/Cm_RedisSession.xml in a text editor.
-
Change the value of <active> to true.
-
Save your changes to Cm_RedisSession.xml and exit the text editor.
-
-
Modify magento-install-dir/app/etc/local.xml.
- For configuration information, see the sample provided with Magento in magento-install-dir/app/etc/local.xml.additional and also see the Readme (session) and Readme (backend).
-
Flush the Magento cache in any of the following ways:
-
If you have access to the file system as the owner of the files in the Magento installation directory, change to that directory and enter rm -rf var/cache.
-
Log in to the Admin Panel as an administrator. Click System > Cache Management, then click Flush Magento Cache at the top of the page.
You can optionally install the Redis extension for PHP version 2.2.3 or later as well, but Magento functions without it.
-
-
Getting Support for Redis
-
Important: Colin Mollenhour, the original author of Redis, does not provide support for Magento implementations. You can get support for Magento implementations in the following ways:
Welcome to the home page for Magento 1.x documentation for installation, configuration, developers, patches, and more. Here you'll find articles that were formerly located on http://magentocommerce.com/knowledge-base.
-
For information you don't find here—including Release Notes—see the User Guide page.
In a continuing effort to improve security and ease of use, Magento is updating its recommendations for file system permissions and ownership for the following Magento editions:
-
Magento Enterprise Edition (EE) versions 1.9 and later
-
Magento Community Edition (CE) versions 1.4 and later
-
This article discusses recommended permission and ownership schemes to apply after you install Magento.
-
The guidelines discussed in this article apply to:
-
New installations of or upgrades to the previously listed Magento versions only.
- The instructions might not work with older versions. If you have already installed Magento, you can optionally change your file system permissions and ownership as discussed in this article.
This article discusses the following permission and ownership schemes:
-
-
Post-installation for both a hosted Magento server and for a dedicated Magento server (in other words, you have root access on the server).
-
Securing extensions, recommended ownership and privilege settings to apply after you install Magento extensions.
- Typically, Magento extensions install with 777 (world-writable) privileges, which is undesirable from a security point of view.
-
-
Important: This topic contains suggestions based on our experience. They are not requirements because we don't know the details of your deployment. Consult your hosting provider, a qualified security specialist, or an experienced system administrator for advice about specific security settings.
-
-
Terminology
-
This article uses the following terminology:
-
-
Hosted system
-
A Magento server located on a hosting provider. A hosted system typically does not enable you to elevate to root. The web server typically runs as an ordinary user. Magento assumes you log in as this user to start and stop the web server and that you already own all the files and directories in the Magento installation directory. You can use chmod to change permissions on files and directories.
-
Dedicated system
-
A Magento server you control and operate. Unlike a hosted system, you can elevate to root and, as root, you can use the chown and chmod commands to set ownership and privileges in the Magento installation directory.
-
-
-
Setting Privileges and Ownership After You Install Magento
-
If you have installed Magento, you can set file system privileges and ownership as follows:
-
For a dedicated Magento server, you set ownership of files and directory as the web server user. You set privileges as 500 (directories) and 400 (files).
-
For a hosted Magento server on which the web server runs as the logged-in username, you set privileges as 500 (directories) and 400 (files).
-
Note: In both hosted and dedicated systems, you set the privileges for the media/ and var/ directories at 700/600 because they must be writable.
-
-
Following is an explanation of the privileges:
-
500 permissions for directories (dr-x------) gives the web server user read and execute privileges to prevent the accidental deletion or modification of files in the directory. Other users have no access to Magento directories.
-
400 permissions for files (-r--------) prevent any user (even the web server user) from overwriting files.
- This prevents attacks that depend on overwriting existing files with malicious content.
-
700 permissions (drwx------) for the media/ and var/ directories give full control (that is, read/write/execute) to the owner and no permissions to anyone else.
-
600 permissions (-rw-------) for files in the media/ and var/ directories enable the web server user to write to them and to overwrite them.
-
Note: On a dedicated system, all commands discussed in this article must be entered as a user with root privileges. On a hosted system, commands must be entered as the web server user.
-
-
To set up ownership and permissions on a dedicated Magento server:
-
Dedicated Magento server only. As a user with root privileges, find the web server user:
-
Apache:
-
Ubuntu: grep User /etc/apache2/apache2.conf
-
CentOS: grep User /etc/httpd/conf/httpd.conf
-
Note: The preceding paths are samples only. The paths to these .conf files on your system might be different. You can use the command whereis nginx to find the location of the configuration files.
-
- Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
-
nginx: Open the nginx configuration file, typically /etc/nginx/nginx.conf. The user directive specifies the username. It might run as the Apache user if Apache is installed on the same system.
-
-
-
Change to the Magento installation directory.
- On CentOS, this is typically /var/www/html/magento. On Ubuntu, it is typically /var/www/magento.
-
Dedicated Magento server only. As a user with root privileges, enter the following command to set ownership of the Magento installation directory and all its subdirectories:
-
chown -R web-server-user-name .
- For example, on Ubuntu where Apache usually runs as www-data, enter
-
chown -R www-data .
-
Enter the following commands to set permissions:
-
find . -type f -exec chmod 400 {} +
-find . -type d -exec chmod 500 {} +
-find var/ -type f -exec chmod 600 {} +
-find media/ -type f -exec chmod 600 {} +
-find var/ -type d -exec chmod 700 {} +
-find media/ -type d -exec chmod 700 {} +
-chmod 700 includes
-chmod 600 includes/config.php
-
-
Securing Magento Extensions
-
If you set permissions and ownership as discussed in this article, you must change permissions temporarily to be able to use the Magento Connect Manager in the Admin Panel. (System > Magento Connect > Magento Connect Manager). You can still install extensions manually, however; that is beyond the scope of this article.
-
You can confirm the issue when you access Magento Connect Manager in the Admin Panel. The following error displays on the Extensions tab page:
-
Warning: Your Magento folder does not have sufficient write permissions.
-
To use Magento Connect Manager, you must:
-
Temporarily set 700/600 permissions on your Magento installation directory and subdirectories.
-
Install the extension.
- Magento Connect Manager typically installs extensions with 777 (world-writable) permissions.
-
Set permissions back to their recommended values.
-
In addition, if you have a dedicated Magento server, you should check ownership of files and directories and reset them if necessary. Often, Magento Connect Manager installs extensions with user and group ownership both set to the web server user.
-
-
Temporarily Resetting Permissions on Your Magento Installation Directory
-
To temporarily set file and directory permissions so you can use Magento Connect Manager:
-
Change to the Magento installation directory.
- On CentOS, this is typically /var/www/html/magento. On Ubuntu, it is typically /var/www/magento.
-
Enter the following commands:
-
find . -type d -exec chmod 700 {} +
-find . -type f -exec chmod 600 {} +
-
Install your extension using the Magento Connect Manager.
-
-
Restoring the Recommended Permissions
-
Enter the commands discussed in this section to return permissions and ownership to their recommended values after you have installed extensions.
-
To restore Magento installation directory permissions:
-
Change to the Magento installation directory.
- On CentOS, this is typically /var/www/html/magento. On Ubuntu, it is typically /var/www/magento.
-
Dedicated Magento server only. As a user with root privileges, enter the following command to set ownership of the Magento installation directory and all its subdirectories:
-
chown -R web-server-user-name .
- For example, on Ubuntu where Apache usually runs as www-data, enter
-
chown -R www-data .
-
Enter the following commands to set permissions:
-
find . -type f -exec chmod 400 {} +
-find . -type d -exec chmod 500 {} +
-find var/ -type f -exec chmod 600 {} +
-find media/ -type f -exec chmod 600 {} +
-find var/ -type d -exec chmod 700 {} +
-find media/ -type d -exec chmod 700 {} +
-
-
Applying Magento Support Patches
-
Magento Support typically provides a shell script to patch various Magento issues. When you run the shell script, file and directory permissions are typically not changed; however, the files provided with the patch are owned by the user who applied the patch. If you have a dedicated Magento server, this is typically root; therefore, after applying the patch, you must change file ownership.
-
If you are required to apply a patch provided by Magento Support, use the following process:
-
Get the patch from Magento Support.
-
Follow the instructions provided with the patch.
- Typically, you run a shell script as either a user with root privileges or as the owner of the Magento installation directory.
-
If you ran the patch as the owner of the Magento installation directory, you're done. File permissions aren't usually changed; however, you should check and reapply file and directory privileges if necessary.
-
If you ran the patch as a user with root privileges, use the following steps to reset file ownership:
-
Dedicated Magento server only. Find the web server user:
-
Apache:
-
Ubuntu: grep User /etc/apache2/apache2.conf
-
CentOS: grep User /etc/httpd/conf/httpd.conf
-
- Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
-
nginx: Open the nginx configuration file, typically /etc/nginx/nginx.conf. The user directive specifies the username. It might run as the Apache user if Apache is installed on the same system.
-
-
As a user with root privileges, enter the following command from the Magento installation directory:
- chown -R web-server-user-name .
- For example, on Ubuntu where Apache usually runs as www-data, enter
- chown -R www-data .
-
-
For More Information
-
For more information about UNIX permissions, see the following resources:
In a continuing effort to improve security and ease of use, Magento is updating its recommendations for file
- system permissions and ownership for the following Magento editions:
-
-
Magento Enterprise Edition (EE) versions 1.9 and later
-
Magento Community Edition (CE) versions 1.4 and later
-
-
The guidelines discussed in this article apply to:
Important: This topic contains suggestions based on our experience. They are not requirements because we don't know the details of your deployment. Consult your hosting provider, a qualified security specialist, or an experienced system administrator for advice about specific security settings.
-
-
-
Terminology
-
This article uses the following terminology:
-
-
Hosted system
-
A Magento server located on a hosting provider. A hosted system typically does not enable you to
- elevate to root. The web server typically runs as an ordinary user. Magento assumes you log in as
- this user to start and stop the web server and that you already own all the files and directories in the
- Magento installation directory. You can use chmod to change permissions on files and directories.
-
-
Dedicated system
-
A Magento server you control and operate. Unlike a hosted system, you can elevate to root and, as
- root, you can use the chown and chmod commands to set ownership and privileges in
- the Magento installation directory.
-
-
-
-
-
Recommended Privileges and Ownership Before You Install Magento
-
This section discusses Magento's pre-installation recommended privilege and ownership settings, which are as
- follows:
-
-
The Magento installation directory and all subdirectories are owned by the web server user.
- This enables the web server to change files in these subdirectories but other users cannot access them
- (except a higher-level user such as root).
-
-
All directories have 700 permissions (drwx------).
- 700 permissions give full control (that is, read/write/execute) to the owner and no permissions to anyone
- else.
-
-
All files have 600 permissions (-rw-------).
- 600 permissions mean the owner can read and write but other users have no permissions.
-
-
If you use PHP-FPM (FastCGI Process Manager), make sure it is configured to run the same user as the Apache
- web server (Nginx web server).
- This allows web server to access content generated by Magento (Uploaded files, images, etc.).
-
-
-
Note: On a dedicated system, all commands discussed in this article must be
- entered as a user with root privileges.
-
After you extract the Magento installation package, set ownership and permissions as follows:
-
-
Dedicated Magento server only. Find the web server user:
-
-
Apache:
-
-
Ubuntu: grep User /etc/apache2/apache2.conf
-
CentOS: grep User /etc/httpd/conf/httpd.conf
-
Note: The preceding paths are samples only. The paths
- to these .conf files on your system might be different. You can use the command
- whereis nginx to find the location of the configuration files.
-
-
-
- Typically, the Apache web server user on CentOS is apache and the Apache web server user on
- Ubuntu is www-data.
-
-
nginx: Open the nginx configuration file, typically /etc/nginx/nginx.conf. The
- user directive specifies the username. It might run as the Apache user if Apache is
- installed on the same system.
-
-
-
-
Change to the Magento installation directory.
-
Dedicated Magento server only. Enter the following command to set ownership of the Magento
- installation directory and all its subdirectories:
-
chown -R web-server-user-name .
- For example, on Ubuntu where Apache usually runs as www-data, enter
-
chown -R www-data .
-
-
Enter the following commands to set directory permissions to 700 and file permissions to 600:
-
find . -type d -exec chmod 700 {} +
-find . -type f -exec chmod 600 {} +
-
-
-
-
For More Information
-
For more information about UNIX permissions, see the following resources:
Install prerequisite software (web server, PHP, and required PHP extensions).
-
Set up a MySQL Magento database instance.
-
Run the Magento installer to complete the installation.
-
Verify that Magento installed correctly.
-
Important: Perform all installations to Magento the latest version of CE 1.9 or Magento EE 1.14 to get the latest fixes, features, and security updates.
If you are setting up more than one web node with load balancing, set up and test that part of your system before you install Magento.
-
If your database server and web server are located on different hosts, get help before proceeding.
-
Make sure you can back up your entire system at various points during the installation so you can roll back in the event of issues.
-
Magento strongly recommends you observe the following guidelines when you set up your Magento database:
-
-
Magento for the first time uses MySQL database triggers to improve database access during reindexing. Magento does not support any custom triggers in the Magento database because custom triggers can introduce incompatibilities with future Magento versions.
If you use MySQL database replication, be aware that Magento does not support MySQL statement-based replication. Make sure you use only row-based replication.
-
More information, including software prerequisites, can be found in the next section.
-
-
Preparing Your Server for Magento CE or EE
-
The following sections discuss how to download and install prerequisite software and install Magento CE or EE on a system running:
-
-
Ubuntu 10 or later, or CentOS 6
-
Apache 2.x
-
nginx 1.7.x
-
PHP 5.4 and required extensions
-
MySQL database
-Notes:
-
Discussing how to configure Secure Sockets Layer (SSL) is beyond the scope of this guide. You can consult some general resources such as Apache, zytrax.com, or the OpenSSL documentation page.
Note: Unless otherwise noted, all tasks discussed in this article must be performed by a user with root privileges.
-
-
-
SELinux Prerequisite
-
Security Enhanced Linux (SELinux) enables CentOS and Ubuntu administrators greater access control over their servers. If you're using SELinux and Apache must initiate a connection to another host, you must run the commands discussed in this section.
-
If Apache and the database server are on the same host, you can skip this section and continue with Opening Ports In Your Firewall.
-
To enable Apache to initiate a connection to another host with SELinux enabled:
-
To determine if SELinux is enabled, use the following command:
-
getenforce
-Enforcing displays to confirm that SELinux is running.
-
Enter one of the following commands:
-
CentOS
-
setsebool -P httpd_can_network_connect=1
-
Ubuntu
-
setsebool -P apache2_can_network_connect=1
-
-
-
-
Opening Ports In Your Firewall
-
Depending on your security requirements, you might find it necessary to open port 80 and other ports in your firewall. Because of the sensitive nature of networking security, Magento strongly recommends you consult with your IT department before proceeding. Following are some suggested references:
This section discusses how to create or install the following:
-
Install and configure Network Time Protocol (NTP) which enables you to synchronize the system clock with pool servers located around the world. NTP is particularly useful for synchronizing the clocks of multiple hosts.
Installing and Configuring Network Time Protocol (NTP)
-
NTP enables servers to synchronize their system clocks using globally available pool servers. Magento recommends you use NTP servers you trust, whether they are dedicated hardware solutions your internal network or external, public servers.
-
If you are deploying Magento on multiple hosts, NTP is a simple way to guarantee their clocks are all synchronized, no matter what time zone the servers are in.
-
To install and configure NTP:
-
CentOS only.
-
Enter the following command to find the appropriate NTP software:
-yum search ntp
-
Select a package to install. For example, ntp.x86_64.
-
Install the package.
-yum -y install ntp.x86_64
-
-
Ubuntu only. Enter the following command to install NTP:
-apt-get install ntp
-
Select the NTP pool servers you wish to use.
-Selecting pool servers is up to you. If you use NTP pool servers, ntp.org recommends you use pool servers that are close to your servers' time zone as discussed on the NTP pool project help page. If you have a private NTP server that is available to all hosts in your Magento deployment, you can use that server instead.
-
Open /etc/ntp.conf in a text editor.
-
Look for lines similar to the following:
-
server 0.centos.pool.ntp.org
-server 1.centos.pool.ntp.org
-server 2.centos.pool.ntp.org
-
Replace those lines or add additional lines that specify your NTP pool server or other NTP servers. It's a good idea to specify more than one.
-An example of using three United States-based NTP servers follows:
-
server 0.us.pool.ntp.org
-server 1.us.pool.ntp.org
-server 2.us.pool.ntp.org
-
Save your changes to /etc/ntp.conf and exit the text editor.
-
CentOS only. Enter the following command so that NTP starts when the server starts.
-
chkconfig ntpd on
-
Restart the service.
-
CentOS
-
service ntpd restart
-
Ubuntu
-
service ntp restart
-
-
-
Enter the date command to check the server's date.
-If the date is incorrect, make sure the NTP client port (typically, UDP 123) is open in your firewall. Try the ntpdate pool-server-host-name command. If it fails, search for the error it returns.
-If all else fails, try restarting the server.
-
-
Creating phpinfo.php
-
phpinfo.php displays a large amount of information about PHP and its extensions. Add the following code anywhere in your web server's docroot:
-
<?php
-// Show all information, defaults to INFO_ALL
-phpinfo();
phpmyadmin is an easy-to-use, free database administration utility. You can use it to check and manipulate the contents of your database. You must log in to phpmyadmin as the MySQL database administrative user.
Download the epel RPM for the version of CentOS you're using. A sample follows.
-
cd /tmp
-wget http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm
-rpm -ivh epel-release-6-8.noarch.rpm
-
Install phpmyadmin as follows:
-
yum -y install phpmyadmin
-
Authorize access to phpmyadmin from your machine's IP address.
-
Open the following file for editing:
-
vim /etc/httpd/conf.d/phpMyAdmin.conf
-
Replace the following IP address with your IP address
-
#Require ip 127.0.0.1
-For example,
-
Require ip 192.51.100.101
-
Replace the following IP with your IP address
-
#Allow from 127.0.0.1
-For example,
-
Allow from 192.51.100.101
-
-
Save your changes to /etc/httpd/conf.d/phpMyAdmin.conf and exit the text editor.
-
Restart Apache.
-
service httpd restart
-
To use phpmyadmin, enter the following command in your browser's address or location field:
-
http://host-or-ip-address/phpmyadmin
-
When prompted, log in using your MySQL database root or administrative user's username and password.
-
To install phpmyadmin on Ubuntu:
-
Use the following command:
-apt-get install phpmyadmin
-
Follow the prompts on your screen to complete the installation.
-
To use phpmyadmin, enter the following URL in your browser's address or location field:
-http://host-or-ip-address/phpmyadmin
-
When prompted, log in using your MySQL database root or administrative user's username and password.
-
-
Creating a Magento Database Instance
-
This section discusses how to create a new database instance for Magento. Although a new database instance is recommended, you can optionally install Magento into an existing database instance. If you choose to do that, skip this section and continue with Installing Optional Sample Data.
-
Note: Before you continue, review the information about MySQL discussed in Prerequisites.
-
-
To create a new database instance:
-
Log in to your database server as any user.
-
Enter the following commands in the order shown to create a database instance named magento:
-
mysql -u root -p
-#Enter the remaining commands at the mysql> prompt.
-
-create database magento;
-GRANT ALL ON magento.* TO magento@localhost IDENTIFIED BY 'magento';
-
For MySQL versions between 5.0.2 and 5.1.6, you must enter this command:
-
GRANT SUPER ON *.* TO 'magento'@'localhost';
-
After you're done, enter exit
-
Test the database instance.
-
mysql -u magento -p
-Messages similar to the following display to confirm you successfully created the database instance. If errors display, repeat the preceding commands.
-
Welcome to the MySQL monitor. Commands end with ; or \g.
-Your MySQL connection id is 20
-Server version: 5.1.67 Source distribution
-
-Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
-
-Oracle is a registered trademark of Oracle Corporation and/or its
-affiliates. Other names may be trademarks of their respective
-owners.
-
-Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-
Extracting the Magento Installation Archive
-
Extract the Magento installation archive on your web server's docroot.
-
The path on Ubuntu is typically /var/www
-
The path on CentOS is typically /var/www/html
-
Examples follow:
-
Ubuntu
-
cd /var/www
-cp /path/magento-install-archive .
-tar -zxf magento-install-archive-name
-
CentOS
-
cd /var/www/html
-cp /path/magento-install-archive-name .
-tar -zxf magento-install-archive
-
To optionally install Magento sample data, continue with the next section.
Magento provides sample data you can optionally install to give you an idea of what products look like in the Admin Panel and in your web store. You can use this sample data to learn how Magento works and to experiment with custom themes.
-
You must install sample data on the file system and in the database before you install Magento.
-
Note: Only if your database is shared between more than one Magento installation. Database table names used by the sample data are not configurable. To use sample data with a new Magento installation, you must manually add a prefix to all sample data tables and use the same prefix when you install Magento.
If necessary, transfer the sample data to your Magento server.
-
On your Magento server, extract the sample data archive to a directory other than your Magento installation directory.
-
Make note of the path to the sample data's media subdirectory.
-
Change to the [your Magento install dir]/media directory.
-
#Ubuntu example
-cd /var/www/magento/media
-
-#CentOS example
-cd /var/www/html/magento/media
-
As a user with privileges to write to the Magento installation directories (typically the web server user), copy the sample data's media directory and subdirectories to your Magento installation directory.
-For example, to copy Magento sample data from /home/username to /var/www/magento, enter
-
cp -R /home/username/media/* .
-
Magento CE 1.9 and Magento EE 1.14 only. You must also copy the sample data's skin directory to [your Magento install dir]/skin as follows:
-For example, to copy Magento skin files from /home/username/skin to /var/www/magento/skin, enter
-
cd [your Magento install dir]/skin
-cp -R /home/username/skin/* .
-
Import the CE or EE sample data into your MySQL database as follows:
-
mysql -u root -p magento-db-instance-name < path-to-sample-data-extract-dir/sample-data-filename.sql
-EE 1.14 example
-
mysql -u root -p magento < /home/username/magento_sample_data_for_1.14.0.0.sql
-
-
Setting File and Directory Ownership and Privileges
-
Magento recommends the following ownership and privilege settings for files and directories in the Magento installation directory:
-
The Magento installation directory and all subdirectories are owned by the web server user.
-This enables the web server to change files in these subdirectories but other users cannot access them (except a higher-level user such as root).
-
All directories have 700 permissions (drwx------).
-700 permissions give full control (that is, read/write/execute) to the owner and no permissions to anyone else.
-
All files have 600 permissions (-rw-------).
-600 permissions mean the owner can read and write but other users have no permissions.
-
Note: The way you set permissions and ownership depends on whether Magento is running on a dedicated or hosted system:
-
Hosted: A Magento server located on a hosting provider. A hosted system typically does not enable you to elevate to root. The web server typically runs as an ordinary user. Magento assumes you log in as this user to start and stop the web server and that you already own all the files and directories in the Magento installation directory. You can use chmod to change permissions on files and directories.
-
Dedicated: A Magento server you control and operate. Unlike a hosted system, you can elevate to root and, as root, you can use the chown and chmod commands to set ownership and privileges in the Magento installation directory.
-
To set privileges and ownership:
-
Log in to your Magento server.
-
Change to your Magento installation directory:
-
#Ubuntu example
-cd /var/www/magento
-
-#CentOS example
-cd /var/www/html/magento
-
Dedicated Magento server only. Enter the following command to set ownership of the Magento installation directory and all its subdirectories:
-
chown -R web-server-user-name .
-For example, on Ubuntu where Apache usually runs as www-data, enter
-
chown -R www-data .
-
Enter the following commands to set directory permissions to 700 and file permissions to 600:
-
find . -type d -exec chmod 700 {} +
-find . -type f -exec chmod 600 {} +
-
-
-
Installing Magento CE or EE
-
This section discusses how to run the Magento installer, using Magento EE as an example. The Magento CE installer has exactly the same options; only the appearance is different.
-
Important: The procedure that follows assumes that your web server and database server are on the same host. If they are installed on different hosts, additional tasks are required. Get help before you continue your installation.
-
-
To install Magento CE or EE:
-
Complete all of the tasks discussed earlier in this article.
-
Enter the following URL in your web browser's address or location field:
-
web-server-ip-or-host:port/magento-path/magento
-For example, if your web server is http://www.example.com, listens on port 80, and Magento is installed in the web server docroot's magento subdirectory, enter
-
http://www.example.com/magento
-The following page displays.
-
-
Select the checkbox that indicates you agree to the terms and conditions, and click Continue.
-
On the Localization page, enter the following information.
-
-
-
-
Option
-
Meaning
-
-
-
Locale
-
From the list, click the option that best matches the locale in which your Magento server resides.
-
-
-
Time Zone
-
From the list, click the option that best matches the time zone in which your Magento server resides.
-
-
-
Default currency
-
From the list, click the default currency to use on your Magento web store.
-
-
-
-The following figure shows an example of configuring Magento for US English in the US Central time zone and using the US Dollar as the default currency.
-
-
Click Continue.
-The Configuration page displays. Each of its three sections is discussed in the following step.
-
In the Configuration page, enter the following information:
-
In the Database Configuration section, enter the following information.
-
-
-
-
Option
-
Meaning
-
-
-
Database Type
-
From the list, click MySQL.
-
-
-
Host
-
Enter the database server's fully qualified hostname or IP address. Use the default setting of localhost if your database server is on the same host as your web server.
-
-
-
Database Name
-
Enter the name of the Magento database instance in which you want to install the Magento database tables.
-
-
-
User Name
-
Enter the username of the Magento database instance owner.
-
-
-
User Password
-
Enter the Magento database owner's password.
-
-
-
Tables Prefix
-
(Optional.) Use only if you're installing the Magento database tables in a database instance that has Magento tables in it already. In that case, enter a prefix to identify the Magento tables for this installation.
-
Some customers have more than one Magento instance running on a server with all tables in the same database. This option enables those customers to share the database server with more than one Magento installation.
-
-
-
-
-A sample follows.
-
-
In the Web Access Options section, enter the following information.
-
-
-
-
Option
-
Meaning
-
-
-
Base URL
-
Enter the base URL to use to access the Magento Admin Panel and your Magento web store.
-
-
-
Admin Path
-
Enter the path to access the Admin Panel. This path is appended to Base URL.
- For example, if Base URL is http://www.example.com and Admin Path is admin, the Admin Panel's URL is http://www.example.com/admin—provided you configured your web server for server rewrites.
-
-
-
Enable Charts
-
Select the checkbox to display charts on the Admin Panel.
-
-
-
Skip Base URL Validation Before the Next Step
-
Clearing this checkbox validates your server's base URL by performing an HTTP GET. Clear this checkbox unless your web server's base URL is not verifiable; for example, in a development or test environment.
-
-
-
Use Web Server (Apache) Rewrites
-
Select this checkbox to enable the use of the Apache mod_rewrite module. You can select this checkbox only if you configured Apache to use server rewrites.
-
-
-
Use Secure URLs (SSL)
-
Select this checkbox only if your web server supports SSL.
-
-
-
-A sample follows.
-
-
In the Session Storage Options section, click one of the following options:
-
File to store user session data on the file system in the [your Magento install dir]/var/session directory.
-File-based session storage is appropriate unless the Magento file system access is slow or you have a clustered database.
-
Database to store user session data in the database.
-Choose database storage if you have a clustered database; otherwise, there might not be much benefit over file-based storage.
-
-
-
-
Click Continue.
-
Important: If errors display, you must resolve them before continuing.
-
In the Create Admin Account page, enter the following information.
-
-
-
-
Option
-
Meaning
-
-
-
First Name
-
Enter the first name of the user you want to identify as the Magento web store owner.
-
-
-
Last Name
-
Enter the user's last name.
-
-
-
Email
-
Enter the user's email address.
-
-
-
Username
-
Enter the Magento Admin Panel administrator's username. (You can create additional Magento administrators later.)
-
-
-
Password
-
Enter the user's password.
-
-
-
Confirm Password
-
Enter the user's password again for verification.
-
-
-
Encryption Key
-
If you have one, enter a key to encrypt sensitive data in the Magento database. If you don't have one, Magento generates one for you.
- The encryption key is stored in [your Magento install dir]/app/etc/local.xml.
-
-
-
-A sample follows.
-
-
Click Continue.
-The following page displays to indicate a successful installation.
-
-
-
-
Verifying that Magento CE or Magento EE Installed Successfully
-
To make sure Magento installed properly, you should log in to the Admin Panel to verify the Magento version.
-
You can also import products into Magento or perform other tasks that verify you can write to the database.
-
In a web browser's location or address field, enter the URL to the Admin Panel. An example follows:
-
http://www.example.com/magento/admin
-(The Admin Panel URL is a combination of the Base URL and Admin Path fields you entered when you installed Magento.
-
Log in to the Admin Panel as an administrator.
-
Scroll to the bottom of the page; the version should display as 1.14 (Magento EE) or 1.9.0.0 (Magento CE).
-The following figure shows an example.
-
-
-
Congratulations! You successfully installed Magento!
-
-
Setting Up Cronjobs
-
Several Magento features require at least one cronjob, which schedules activities to occur in the future. A partial list of these activities follows:
-
Catalog price rules
-
Newsletters
-
Generating Google sitemaps
-
Customer Alerts/Notifications (product price change, product back in stock)
-
Reindexing (Magento EE 1.13 only)
-
Private sales (Magento EE only)
-
Automatic updating of currency rates
-
Magento EE 1.14.1 and later, Magento CE 1.9.1 and later All Magento e-mails (including order confirmation and transactional)
-
-
Note: Magento depends on proper cronjob configuration for many important system functions, including indexing. Failure to set it up properly means Magento won't function as expected.
-
-
Crontab files define tasks (cronjobs) that are performed at scheduled dates and times. Each user on a system has its own crontab file, and the cron daemon runs each cronjob as the user who owns the crontab. For Magento, this user is the web server.
-
-
Recommendations for cronjobs
-
Magento recommends splitting your cronjob on two tasks in your crontab for best performance and completing your cronjobs without issues:
-
Indexer Cronjob (malways mode) can take longer to execute and complete, skipping other cronjobs (mdefault mode) scheduled during the time that the indexer runs.
-
Cronjobs in mdefault scope may take longer to execute and complete, blocking others scheduled during the time it is still running.
-
-
-
To split your malways and mdefault cronjob modes, use the following:
Determine which of your cronjobs may be long-running and move them into separate crontabs. For example, imports, exports, and indexes can run long, blocking other cronjobs scheduled in that crontab.
-
-
Magento recommends running cron every minute for EE and every five minutes for CE.
-
-
Create cronjobs
-
First, determine your web server's user. SSH into the server and enter the following command:
-
ps -o "user group command" -C httpd,apache2
-
In CentOS, the Apache user is typically apache. In Ubuntu, it's typically www-data. Enter this user in the commands for creating the crontabs and cronjobs.
-
-
We recommend splitting the cronjob between two tasks to prevent the indexer blocking other mdefault jobs or an mdefault job blocking the indexer. These instructions include these commands.
-
-
To create a cronjob as the user that runs Apache:
-
-
Create or edit a crontab for the Apache user. This command opens a vim text editor with the username of the Apache user. You might need to choose a text editor first.
-
crontab -u apache-user-name -e
-
To split cronjobs for better performance, enter the following:
-
This article discusses how to install required prerequisite software for CentOS. You must complete these tasks before you install Magento CE 1.8 or later or Magento EE 1.13 or later.
-
Before you continue, make sure you familiarize yourself with the installation process discussed in Prerequisites.
-
Note: You must install system software on CentOS as a user with root privileges.
-
-
-
Updating System Software
-
It's a good practice to update your repositories and optionally update system software.
-
Update repositories:
-
yum -y update
-
Optionally upgrade software. This might cause a system reboot.
-
yum -y upgrade
-
-
Apache
-
Magento requires Apache use server rewrites. You must also specify the type of directives that can be used in .htaccess, which Magento uses to specify rewrite rules.
-
Installing and configuring Apache is basically a three-step process: install the software, enable rewrites, and specify .htaccess directives.
-
-
Installing Apache
-
Install Apache 2 if you haven't already done so.
-
yum -y install httpd
-
-
Enabling Apache Rewrites
-
Open httpd.conf for editing.
-
vim /etc/httpd/conf/httpd.conf
-
Locate the block that starts with:
-
<Directory /var/www/html>
-
In that block, change the value of AllowOverride to All.
-
Save your changes to httpd.conf and exit the text editor.
-
Restart Apache.
-
service httpd restart
-
-
PHP
-
Magento CE and EE support the following PHP versions:
-
Magento CE 1.6.0.0–1.8.1.0 and Magento EE 1.11.0.0–1.13.1.0 support PHP 5.3 natively. They can be used with PHP 5.4 if you apply the PHP 5.4 patch.
-
Magento CE 1.9.0.x and EE 1.14.0.x support PHP 5.4 natively. They are backward-compatible with PHP 5.3
-
Magento CE 1.9.1 and EE 1.14.1 support PHP 5.5 natively. They are backward-compatible with PHP 5.4
-
We recommend you use the most recent PHP version supported by your version of Magento. For example, you should use PHP 5.5 with CE 1.9.1 or EE 1.14.1.
Check with a system administrator or reference for your version of CentOS to see what PHP versions are available.
-
If you're installing Magento CE 1.9.1 or Magento EE 1.14.1, you can use PHP 5.5; otherwise, we recommend PHP 5.4. For certain versions of CE and EE, a patch is required to use PHP 5.4.
-
Enter the following command to see what version of PHP is currently running:
-
php -v
-
See one of the following sections for more information:
CentOS 6.x repositories have PHP 5.3. This section assumes you use either PHP 5.4 or 5.5. Make sure you understand which version of Magento CE or EE supports the PHP version to which you upgrade.
-
Before you start, verify you have PHP 5.3 installed:
-
php -v
-
If you already have the desired PHP version installed, you don't have to do anything.
-
If PHP is not installed, install PHP 5.3 using the following command:
-
yum -y install php php-xml
-
Continue with one of the following sections.
-
Important: The following sections discuss suggested PHP upgrade paths. Because you're choosing a non-CentOS repository to upgrade PHP, make your choice carefully. Not all repositories work equally well. We don't recommend any particular repository. Consult a system administrator or CentOS reference for more information.
-
-
-
Upgrading to PHP 5.5
-
There is more than one way to upgrade CentOS 6.5 to PHP 5.5; the following is a suggestion only. Consult a reference for additional options.
Increase memory_limit in php.ini to at least 512MB.
-
Open /etc/php.ini in a text editor.
-
Change memory_limit to:
-
memory_limit = 512M
-
Save your changes and exit the text editor.
-
-
MySQL
-
This section discusses how to install and configure MySQL 5.6. CentOS 6.x repositories have MySQL 5.1; to install a different version of MySQL, see the MySQL documentation.
-
Note: Use the tasks that follow only on a new MySQL database. Some of the tasks require you to delete users and should not be performed on a database that has already been set up.
Set a password for the root user and set other security-related options. Enter the following command and follow the prompts on your screen to complete the configuration.
-
This article discusses how to install required prerequisite software for Ubuntu. You must complete these tasks before you install Magento CE 1.8 or later or Magento EE 1.13 or later.
-
Before you continue, make sure you familiarize yourself with the installation process discussed in Prerequisites.
-
Note: You must install system software on Ubuntu as a user with root privileges.
-
-
-
Updating System Software
-
It's a good practice to update your repositories and system software, if necessary.
-
Log in to your Magento server as a user with root privileges and enter the commands shown in this section.
-
Update repositories:
-
apt-get update
-
Optionally upgrade software. This might require a system reboot.
-
apt-get upgrade
-
-
Apache
-
This section discusses how to install Apache. For more details, you can consult a reference like the Ubuntu site.
-
Magento requires Apache use server rewrites. You must also specify the type of directives that can be used in .htaccess, which Magento uses to specify rewrite rules.
-
Installing and configuring Apache is basically a three-step process: install the software, enable rewrites, and specify .htaccess directives.
-
-
Installing Apache
-
Install Apache 2 if you haven't already done so:
-
apt-get -y install apache2
-
-
Enabling Apache Rewrites
-
Ubuntu 12 (which natively supports Apache 2.2) is different from Ubuntu 14 (which natively supports Apache 2.4).
-
It's very important you choose a value for AllowOverride that is suited to your deployment. You can use AllowOverride All in development but it might not be desirable in production.
-
For more information, see one of the following references:
Use this section to enable Apache rewrites and specify .htaccess if you use Apache 2.2, which is supported by the default Ubuntu 12 repository.
-
Open the following file for editing.
-
vim /etc/apache2/sites-available/default
-
Locate the following block.
-
<Directory /var/www/>
- Options Indexes FollowSymLinks MultiViews
- AllowOverride None
- Order allow,deny
- allow from all
-</Directory>
-
Change the value of AllowOverride to [value from Apache site].
-
<Directory /var/www/>
- Options Indexes FollowSymLinks MultiViews
- AllowOverride All
- Order allow,deny
- allow from all
-</Directory>
-
Save the file and exit the text editor.
-
Configure Apache to use the mod_rewrite module.
-
cd /etc/apache2/mods-enabled
-ln -s ../mods-available/rewrite.load
-
Restart Apache.
-
service apache2 restart
-
-
Enabling Apache Rewrites for Apache 2.4
-
Use this section to enable Apache rewrites and specify .htaccess if you use Apache 2.4, which is supported by the default Ubuntu 14 repository.
-
Enter the following command:
-
a2enmod rewrite
-
Specify the type of directives that can be used in .htaccess.
-For guidelines, see the Apache 2.4 documentation.
-Note that in Apache 2.4, the server's default site configuration file is /etc/apache2/sites-available/000-default.conf
-For example, you can add the following to the bottom of 000-default.conf:
-
<Directory "/var/www">
-AllowOverride [value from Apache site]
-</Directory>
-Note: You must change the value of AllowOverride in the directive for the directory to which you expect to install the Magento software. For example, to install in the web server docroot, edit the directive in <Directory /var/www>.
-
-
Restart Apache:
-service apache2 restart
-
-
PHP
-
Magento CE and EE support the following PHP versions:
-
Magento CE 1.6.0.0–1.8.1.0 and Magento EE 1.11.0.0–1.13.1.0 support PHP 5.3 natively. They can be used with PHP 5.4 if you apply the PHP 5.4 patch.
-
Magento CE 1.9.0.x and EE 1.14.0.x support PHP 5.4 natively. They are backward-compatible with PHP 5.3
-
Magento CE 1.9.1 and EE 1.14.1 support PHP 5.5 natively. They are backward-compatible with PHP 5.4
-
We recommend you use the most recent PHP version supported by your version of Magento. For example, you should use PHP 5.5 with CE 1.9.1 or EE 1.14.1.
Check with a system administrator or reference for your version of Ubuntu to see what PHP versions are available.
-
If you're installing Magento CE 1.9.1 or Magento EE 1.14.1, you can use PHP 5.5; otherwise, we recommend PHP 5.4. For certain versions of CE and EE, a patch is required to use PHP 5.4.
-
Enter the following command to see what version of PHP is currently running:
-
php -v
-
See one of the following sections for more information:
Important: The following sections discuss suggested PHP upgrade paths. Because you're choosing a non-Ubuntu repository to upgrade PHP, make your choice carefully. Not all repositories work equally well. We don't recommend any particular repository. Consult a system administrator or Ubuntu reference for more information.
-
-
To upgrade your version of PHP, see one of the following:
Increase memory_limit in php.ini to at least 512MB:
-
Open /etc/php5/apache2/php.ini in a text editor.
-
Change memory_limit to:
-
memory_limit = 512M
-
Save your changes and exit the text editor.
-
-
MySQL
-
Magento CE and EE support the following MySQL versions:
-
Magento CE 1.9.1 and Magento EE 1.14.1 support MySQL versions 5.0.2 through 5.6.x.
-To install MySQL 5.6, see Installing MySQL 5.6.
-
Magento CE versions 1.8.0.0–1.9.0.x support MySQL versions 4.1.20–5.5.x.
-To install MySQL version 5.5, see the next section.
-
-
Installing MySQL 5.5
-
Install the MySQL database:
-
apt-get -y install mysql-client mysql-server
-
-
Installing MySQL 5.6
-
Only Magento CE 1.9.1 and EE 1.14.1 support MySQL 5.6. To install MySQL 5.6 on Ubuntu 14, see Installing MySQL 5.6 on Ubuntu 14. To install MySQL 5.6 on Ubuntu 12, see the next section.
-
-
Installing MySQL 5.6 on Ubuntu 12
-
To install MySQL 5.6 on Ubuntu 12, enter the following commands in the order shown:
Test the installation by entering the following command:
-
mysql -u root -p
-
Messages similar to the following display:
-
Welcome to the MySQL monitor. Commands end with ; or \g.
-Your MySQL connection id is 43
-Server version: 5.6.21-1+deb.sury.org~precise+1 (Ubuntu)
-
-Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
-
-Oracle is a registered trademark of Oracle Corporation and/or its
-affiliates. Other names may be trademarks of their respective
-owners.
-
-Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-mysql>
-
-
Installing MySQL 5.6 on Ubuntu 14
-
To install MySQL 5.6 on Ubuntu 14, enter the following command:
Test the installation by entering the following command:
-
Welcome to the MySQL monitor. Commands end with ; or \g.
-Your MySQL connection id is 45
-Server version: 5.6.19-0ubuntu0.14.04.1 (Ubuntu)
-
-Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
-
-Oracle is a registered trademark of Oracle Corporation and/or its
-affiliates. Other names may be trademarks of their respective
-owners.
-
-Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-mysql>
-
-
\ No newline at end of file
diff --git a/guides/m1x/install/installing_upgrade_ce18_upgrade-roadmap.html b/guides/m1x/install/installing_upgrade_ce18_upgrade-roadmap.html
deleted file mode 100644
index 638d152999..0000000000
--- a/guides/m1x/install/installing_upgrade_ce18_upgrade-roadmap.html
+++ /dev/null
@@ -1,57 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
-
-
-
- Ubuntu: Installing Required Prerequisite Software for Magento CE 1.8 Magento EE 1.13 (or Later)
-
-
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
Upgrade Roadmap for Magento Community Edition (CE) 1.8 or 1.9
-
-
-
-
-
Magento recommends you upgrade your installation using the following guidelines in a development or test environment, separate from your existing production environment:
-
Install Magento in a different directory:
-
Recommended. Set up a new system (that is, another host) on which to install Magento.
-The system should be identical to, if not better than, your current system. The new system must meet the Magento system requirements.
-
Install Magento in a new, empty root installation directory on the same server.
-
-
In your current production environment:
-
Back up your Magento database.
-
Archive the file system.
-This includes the media directory and subdirectories; all extensions and customizations; and all custom themes.
-
-
In the development or test environment:
-
Create a new, empty database instance.
-
Import the production database tables into the development database instance.
-
Copy your production media directory, extensions, themes, and other customizations to the development system.
-
Copy local.xml to [your Magento install dir]/app/etc and edit it if necessary to reference the production database instance.
-
In a web browser, go to your development system base URL.
-
Wait for upgrade scripts to run.
-
Verify the development system is now identical to the production system.
-If not, fix issues, retest, and upgrade again.
-
-
Test the development system thoroughly, including:
-
Verify all extensions, themes, and customizations work.
-
Place orders using all webstores and all payment methods.
Magento Enterprise Edition (EE) 1.13.0.2, 1.13.1, or 1.14.x
-
Important: Magento recommends CE 1.9.1.0 or later or EE 1.14.1.0 or later for all CE and EE installations and upgrades to get the latest fixes, features, and security updates.
-
-
Because of changes to URL rewrites, the following upgrades are more complex than other upgrades.
-
Upgrading from EE 1.12 or earlier to EE 1.14.x
-
Upgrading from EE 1.13.0.0 or EE 1.13.0.1 to EE 1.14.x
-
Note: If you're upgrading from EE 1.13.0.2 to EE 1.13.1.0 or later, your upgrade doesn't involve changes to URL rewrites and you can skip many of the steps discussed in the other upgrades. Continue with Getting Ready For Your Upgrade.
This section discusses how to get ready for your upgrade by backing up the database and customizations on the file system. The steps that follow do not affect your current production system. You can continue serving customers with no downtime.
Recommended. Set up a new system (that is, another host) on which to install Magento.
-The system should be identical to, if not better than, your current system. The new system must meet the Magento system requirements.
-
Install Magento in a new, empty root installation directory on the same server.
-
Important: Do not upgrade Magento in the same directory on the same server because post-upgrade errors are likely to occur.
-
-
Magento strongly recommends you observe the following guidelines when you set up the Magento database in your development environment:
-
-
Magento for the first time uses MySQL database triggers to improve database access during reindexing. Magento does not support any custom triggers in the Magento database because custom triggers can introduce incompatibilities with future Magento versions.
Before you start your upgrade, you should enable exception logging so it will be enabled on the development system. Without exception logging, it will be more difficult to diagnose errors during your upgrade. You can disable exception logging after you've exported the Magento database.
-
To enable exception logging:
-
Log in to the Admin Panel as an administrator.
-
Click System > Configuration.
-
In the ADVANCED group, click Developer.
-This enables you to enable exception logging so you'll see exceptions in the development environment after the upgrade.
-
In the right pane, click Log Settings to expand it.
-The following figure shows an example.
-
-
From the Enabled list, click Yes.
-
Optionally change the names of the log files.
-
Click Save Config.
-
-
Disabling cron Jobs
-
Before upgrading to EE 1.13.0.2 or later, disable all running cron jobs. A simple way to stop cron jobs follows; consult an appropriate reference for other options.
-
As a user with root privileges, enter one of the following commands:
-
Ubuntu: service crond stop
-
CentOS: service cron stop
-
-
-
-
Setting All Indexers for Update on Save
-
This section applies to upgrading Magento EE only. Skip this section if you're using Magento CE.
-
Because of the changes to indexing in Magento EE 1.13, you must set all indexers to update on save before you upgrade; otherwise, unpredictable performance will result. You can revert indexer settings after you've exported the Magento database.
-
To set indexers to update on save:
-
Click System > Index Management.
-
On the top left corner of the row, click Select All to select all indexers.
-
From the Options list, click Change indexing mode.
-The Index Mode list displays.
-
From the Index Mode list, click Update on Save.
-The following figure shows an example.
-
-
At the top right corner, click Submit.
-
Make sure all indexers are now set for Update on Save as the following figure shows.
-
-
-
Flushing the Cache
-
Clear the Magento cache as follows:
-
Log in to the Admin Panel as an administrator.
-
Click System > Cache Management.
-
Click Flush Magento Cache.
-
-
Backing Up the Database
-
Back up your database using mysqldump or another tool. mysqldump syntax follows:
Pre-Upgrade Tasks For Your Development Environment
-
In your development environment:
-
If necessary, create a Magento installation master directory; Magento installs in a magento subdirectory of that directory.
-The Magento installation archive creates a magento subdirectory so if you want your Magento installation directory to be /var/www/magento, you don't need to do anything.
-
Tip: The name and path to the Magento installation directory in your development system does not have to be the same as on your production system, although it might make some tasks simpler.
-
-
Create a new database instance. For example, you can create a new MySQL database instance named magento using the following commands:
-
mysql -u root -p
-Enter the remaining commands at the mysql> prompt
-
create database magento;
-GRANT USAGE ON *.* TO magento@localhost IDENTIFIED BY 'magento';
-GRANT ALL ON magento.* TO magento@localhost;
-For MySQL versions later than 5.0.2 but earlier than 5.1.6, the following command is required:
-
GRANT SUPER ON *.* TO 'magento'@'localhost';
-Exit the MySQL command shell:
-
exit
-Verify the database exists using the following command:
-
mysql -u magento -p magento
-If an error displays, repeat the commands. If the command succeeded, enter exit to return to the command prompt.
-
If you're using Security Enhanced Linux (SELinux)and Apache must initiate a connection to another host, you must run the commands discussed in this step.
-
To determine if SELinux is enabled, use the following command:
-getenforce
-Enforcing displays to confirm that SELinux is running.
-
Enter one of the following commands:
-CentOS:
-
setsebool -P httpd_can_network_connect=1
-Ubuntu
-
setsebool -P apache2_can_network_connect=1
-
-
-
Optional: Upgrading to PHP 5.4
-
PHP 5.3 is currently the latest PHP version available in the default repositories for Ubuntu and CentOS. PHP 5.3 works with CE 1.8, CE 1.9, EE 1.13, and EE 1.14.
-
We recommend PHP 5.4 for all of the preceding CE and EE versions because of the new features and changes in that release.
-
CE 1.8 and EE 1.13 both require a PHP 5.4 patch. The patch is listed as PHP 5.4 Compatibility in the EE support portal.
This section discusses how to extract the Magento archive in your development system and manually copy over your customizations, themes, and extensions.
-
Important: To avoid errors after upgrading, you must set up a parallel system. Do not upgrade your existing system or post-upgrade errors are likely to occur.
-
-
Make sure the CE or EE installation archive is located in the directory above where you want Magento to be installed.
-For example, to install Magento to /var/www/magento, copy the archive to /var/www.
-
Extract the archive. For example,
-tar -zxf archive-name
-This installs Magento CE or EE on the file system on your development system. Next, you'll overwrite some of these assets with customizations from your production system.
-
Extract the production system's media archive, overwriting the installation archive. You created the media archive as discussed in Getting Ready For Your Upgrade.
-
Tip: Copy the media archive to the same level in the directory structure to simplify the process. For example, if you created the media archive on your production system in your Magento install directory, the archive when extracted creates the media directory and all subdirectories. If you copy the media archive to the Magento installation directory on your development system, extracting it automatically replaces existing media subdirectory contents.
-
If necessary, move the media directory and subdirectories to media directory in your new Magento installation, overwriting the existing contents.
If necessary, move the theme packages to the [your Magento install dir]/app/design/frontend and [your Magento install dir]/skin/frontend directories, as appropriate, overwriting the existing contents.
If necessary, move the extensions and customizations to the [your Magento install dir]/app/code/local and [your Magento install dir]/app/code/community directories, as appropriate, overwriting the existing contents.
-
-
Updating the Magento Database
-
This section discusses how to:
-
Import the production database data into the development database instance.
-
In the development database instance, change the values of the paths web/unsecure/base_url and web/secure/base_url in the core_config_data table to the development server's IP address or hostname.
-
Import the production database data using your database manager tool.
-
Important:The database instance into which you import must be empty.
-
-
mysql syntax follows:
-
mysql -u root -p database-name < database-export-filename.sql
-For example, if the database name is magento and the database export file name is mangento-db-export.sql, enter
-
mysql -u root -p magento < mangento-db-export.sql
-
The following sections discuss how to change the base URL paths from http://prod.example.com to http://dev.example.com using SQL commands and phpmyadmin:
Updating the Base URL the Database Using SQL Commands
-
This section discusses how to update the secure and unsecure URLs of your webstores and store views in the Magento database. The following example assumes you have two URLs, which every Magento installation has by default. Depending on your setup, you could have more (for additional store views, Content Delivery Networks (CDNs) and so on.
-
Use the following procedure to update all matching URLs in the database.
-
To update the database with the development system's base URLs using SQL commands:
-
Log in to the database server as any user.
-
Enter the following commands in the order shown:
-
mysql -u root -p
-Enter the remaining commands at the mysql> prompt.
-
use magento-db-name;
-SELECT * FROM core_config_data WHERE path LIKE '%base_url%';
-
In the resulting output, make note of the rows that include web/unsecure/base_url and web/secure/base_url.
-In particular, you must know the value of the config_id for these rows.
-
Carefully examine the entire URL to avoid mistakes.
-
Enter the following command to update the values of web/unsecure/base_url and web/secure/base_url:
-
UPDATE core_config_data SET value='base-url' WHERE config_id=id1 or config_id=id2;
-Example 1—config_ids are the same: if your base URL is http://dev.example.com/, the config_id of the row containing web/unsecure/base_url is 354 and the config_id of the row containing web/secure/base_url is 355, enter:
-
UPDATE core_config_data SET value='http://dev.example.com/' WHERE config_id=354 or config_id=355;
-Example 2—config_ids are different: Same as preceding example except that web/secure/base_url uses https://
-
UPDATE core_config_data SET value='http://dev.example.com/' WHERE config_id=354;
-UPDATE core_config_data SET value='https://dev.example.com/' WHERE config_id=355;
-
Verify the values are set correctly.
-
SELECT * FROM core_config_data WHERE path LIKE '%base_url%';
-
For other URLs, be careful to perform the replacement correctly.
-For example, store view base link URLs resemble the following:
-
http://prod.example.com/view1/
-Make sure to update the URL like the following:
-
UPDATE core_config_data SET value='http://dev.example.com/view1/' WHERE config_id=377;
-
When you're done, run the following command again:
-
SELECT * FROM core_config_data WHERE path LIKE '%base_url%';
-
If the values are set correctly, enter exit at the mysql> prompt and continue with Finishing the File System.
-If not, repeat the tasks discussed in this section. Do not continue until the database is updated.
-
-
-
Updating the Base URL the Database Using phpmyadmin
-
This section discusses how to use phpmyadmin to change the values of the paths web/unsecure/base_url and web/secure/base_url in the core_config_data table to the development server's IP address or hostname.
-
In a web browser's location or address field, enter dev-web-server-host-or-ip/phpmyadmin
-For example, if your web server address is http://dev.example.com, enter
-http://dev.example.com/phpmyadmin
-
Log in as the MySQL root user.
-
In the left navigation bar, click the name of your Magento database.
-
In the left navigation bar, click the core_config_data table.
-
At the top of the page, click the Search tab.
-
In the Search tab page, from the Operator list, click LIKE.
-
Enter %base_url% in the Value field.
-The following figure shows an example.
-
-
Click Go.
-The following figure shows sample results.
-
-
Click (Edit) in the row that includes the path web/unsecure/base_url.
-
Change the value to the hostname or IP address of your development server.
-The following figure shows an example.
-
-
Click Go.
-
Repeat these tasks for the path that includes web/secure/base_url.
-
Exit phpmyadmin.
-
-
Upgrading Solr (EE 1.14.0.0 only)
-
This section applies to upgrading to EE 1.14.0.0 using the Solr search engine only. If you're upgrading to a different version—or if you're not using Solr—skip this section and continue with Finishing the File System.
-
Because of changes to the Solr schema, you must copy two files from Magento to your Solr installation. Failure to do so might prevent products from displaying on your web store. After copying the files, you must also reindex the catalog search index.
-
To update Solr:
-
If the Solr search engine is running, stop it.
-
Copy the following files from the Magento 1.14.0.0 installation to the equivalent directory on your Solr installation:
-
For example, if Magento is installed in /var/www/html/magento and the example Solr configuration is installed in the /etc/solr/apache-solr-3.6.2/example/solr/conf directory on the same host, enter:
After you copy the files, you must update the catalog search index. To update the catalog search index, open a command prompt window.
-
Change to the shell subdirectory of your Magento installation directory.
-For example, on CentOS:
-
cd /var/www/html/magento/shell
-
Enter the following command:
-
php indexer.php --reindex catalogsearch_fulltext
-
Note: The preceding example showed paths used by the Solr example configuration. Solr ships with a sample configuration that Magento suggests you use for development only. Do not use the Solr example configuration in production.
-
-
Finishing the File System
-
This section discusses how to edit copy local.xml and set file system permissions and ownership on the production system.
-
-
Copying local.xml
-
Copy your production system's local.xml to [your Magento install dir]/app/etc.
-
Open local.xml in a text editor.
-
If necessary, change the database connection information in the default_setup element, as follows:
-
Save your changes to local.xml and exit the text editor.
-
-
Setting File and Directory Ownership and Privileges
-
Magento recommends the following ownership and privilege settings for files and directories in the Magento installation directory:
-
The Magento installation directory and all subdirectories are owned by the web server user.
-This enables the web server to change files in these subdirectories but other users cannot access them (except a higher-level user such as root).
-
All directories have 700 permissions (drwx------).
-700 permissions give full control (that is, read/write/execute) to the owner and no permissions to anyone else.
-
All files have 600 permissions (-rw-------).
-600 permissions mean the owner can read and write but other users have no permissions.
-
Note: The way you set permissions and ownership depends on whether Magento is running on a dedicated or hosted system:
-
Hosted: A Magento server located on a hosting provider. A hosted system typically does not enable you to elevate to root. The web server typically runs as an ordinary user. Magento assumes you log in as this user to start and stop the web server and that you already own all the files and directories in the Magento installation directory. You can use chmod to change permissions on files and directories.
-
Dedicated: A Magento server you control and operate. Unlike a hosted system, you can elevate to root and, as root, you can use the chown and chmod commands to set ownership and privileges in the Magento installation directory.
-
To set privileges and ownership:
-
Log in to your Magento server.
-
Change to your Magento installation directory:
-
#Ubuntu example
-cd /var/www/magento
-
-#CentOS example
-cd /var/www/html/magento
-
Dedicated Magento server only. Enter the following command to set ownership of the Magento installation directory and all its subdirectories:
-
chown -R web-server-user-name .
-For example, on Ubuntu where Apache usually runs as www-data, enter
-
chown -R www-data .
-
Enter the following commands to set directory permissions to 700 and file permissions to 600:
-
find . -type d -exec chmod 700 {} +
-find . -type f -exec chmod 600 {} +
-
-
-
-
Running the URL Redirect Script (EE 1.13.0.0 and 1.13.0.1 only)
To complete the upgrade, go to your Magento base URL in a web browser. The first time you go to your Magento base URL, server-side scripts run to update the database. Depending on the amount of data in your database, this process can take a long time.
-
Important: Completing the upgrade requires downtime on your production system. If you continue to take orders on your production system, there is no way to reconcile all of the new orders in the replacement development system. You can reduce the amount of downtime to a minimum by thoroughly testing your development system before shutting down production.
-
-
-
If you're upgrading from a version earlier than CE 1.4 or EE 1.7, Magento strongly recommends the two-step upgrade approach discussed in Upgrade Path. In addition, you should expect the upgrade and testing process to take a long time and to expect more downtime for your production system.
The first step in your upgrade is to run server-side upgrade scripts. Depending on the nature of your customizations and extensions, and how many customers and products are in your database, these scripts can take a long time to run and can result in exceptions. You must resolve all exceptions before continuing to the next step in the process.
-
This step in the upgrade process is iterative; that is, you'll probably run through it more than once.
-
Note: Your production system remains up during this step in the upgrade process. You can continue taking and shipping orders and also making changes in the Admin Panel.
-
To run the upgrade scripts:
-
In a web browser address or location field, enter your Magento installation's base URL.
-
Note: If you upgraded Magento on the same server, you might need to update your Apache web server's virtual host configuration to reference the new Magento installation directory. For more information about configuring virtual hosts, see the Apache Virtual Host documentation.
-
-(You updated the Magento database with the development system base URL as discussed in Updating the Magento Database.)
-
Wait while upgrade scripts run on the server.
-
If fatal errors or exceptions display in the browser, they are most likely related to customizations. To resolve fatal errors, you must:
-
Analyze the errors to determine the root cause.
-You can find errors in the web server's error log or in [your Magento install dir]/var/log.
-
Fix the cause in your extension code.
-
In your development environment, drop the Magento database.
-
Re-create the development database and import production data into it as discussed in Updating the Magento Database.
-
Use the following command to delete the contents of the Magento var/ subdirectories:
-
Repeat the tasks discussed in this section until no more fatal errors display in the browser.
-
-
-
Post-Upgrade Tasks (EE 1.13.0.1 Only)
-
This section applies to upgrading from 1.13.0.1 only. If you're upgrading CE or if you're upgrading from a different EE version, continue with Setting Up the Magento Cron Job.
-
After successfully running the Magento upgrade and fixing errors, enter the following command from the Magento root directory:
-
php -f shell/indexer.php -- --reindexall
-
This command runs a full reindex and it might take a long time, depending on the size of your database.
-
After the reindex completes, enter the following command from your Magento installation directory:
Note: Some of these directories might be empty; this is normal.
-
-
Verifying the Status of Indexers
-
After the cron job runs, all indexers should be in a Ready status. Before testing your upgrade, verify all indexers are Ready; otherwise, your testing will be inconclusive.
-
To verify the status of indexers:
-
Log in to the Admin Panel as an administrator.
-
Click System > Index Management.
-Verify that all indexers have a status of Ready, as the following figure shows.
-
-
If indexers are not Ready, use the following guidelines:
-
-
-
-
Indexer status
-
Suggested action
-
-
-
Scheduled
-
Wait for cron to finish or run http://magento-host-name/cron.php from a web browser.
-
-
-
Processing
-
Wait for cron to finish or run cron.php from a web browser. (For example, http://www.example.com/magento/cron.php)
-
If indexers are Processing for an extended period of time, run the command discussed in Clearing Magento var/ Subdirectories and refresh the Index Management page.
-
-
-
-
Testing the Magento Upgrade
-
After you have upgraded with no fatal errors or exceptions, Magento strongly recommends you thoroughly test the upgrade in your development environment as follows:
-
Test all extensions and customizations thoroughly.
-Make sure the UIs perform as expected, make sure the extensions behave properly, and so on.
-
Run some orders, making sure prices are calculated correctly and that orders go through the configured payment mechanisms.
Before making the development system live, back up everything in your production and development environments again.
-The way you make your development system live is up to you; a simple way is to update your DNS server to point to the development IP address.
-
-
Taking Your Old Production System Offline
-
The last step in upgrading is to take your production system offline and switching to your development system—which then becomes the production system from that point on.
-
Important: Before continuing, make sure all errors have been resolved and that you have thoroughly tested the upgrade as discussed in the preceding section.
-
To switch from your production to development system:
-
Put your production system in maintenance mode so it cannot accept orders or other changes.
-To do so, create an empty file named [your Magento install dir]/maintenance.flag.
-
Test it by going to your Magento web store's front page.
-The following message displays if you set up maintenance mode correctly:
-The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.
-
If necessary, update the development database again to get any final transactions processed by your current production system.
-For details, see Updating the Magento Database.
-
Put your production system in maintenance mode so it cannot process orders.
-
Make your development system live.
-The way you do this is up to you; typically, you can configure your DNS server to send requests for your web store domain to the development system's IP address. Be aware that propagating the change to other DNS servers can take some time.
-
Verify your former development system is functioning as your new Magento web store in production.
-
Shut down the old production system.
-
Congratulations! You successfully upgraded! Review our welcome page to see the improvements you're getting.
-
-
Setting Magento File System Permissions and Ownership After Upgrade
There is a known issue after upgrading to EE 1.13.1 that affects you only if you do not follow the recommended procedure to upgrade to a new environment as discussed in Getting Ready For Your Upgrade.
-
Symptom: After completing the upgrade, when you log in to the Admin Panel and click System > Configuration, a fatal error similar to the following displays in your browser:
-
Class 'Mage_Googlecheckout_Helper_Data' not found in /var/www/html/magento/app/Mage.php on line 547
-
-
Solution:
-
Close the Admin Panel browser window.
-
As a user with root privileges, delete all files exceptconfig.xml from the following directory:
-
-
-
-
\ No newline at end of file
diff --git a/guides/m1x/install/installing_upgrade_from-ee112.html b/guides/m1x/install/installing_upgrade_from-ee112.html
deleted file mode 100644
index a61036a278..0000000000
--- a/guides/m1x/install/installing_upgrade_from-ee112.html
+++ /dev/null
@@ -1,173 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
-
-
-
- EE 1.14 Upgrade: Running the EE 1.12 and Earlier URL Redirect Script
-
-
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
-
-
EE 1.14 Upgrade: Running the EE 1.12 and Earlier URL Redirect Script
-
-
This article is part of the Magento Enterprise Edition (EE) upgrade documentation. If you're looking for something else, click here to go back to the Magento Knowledge Base.
-
This article applies to the following Magento EE upgrades:
This article discusses how to run the URL redirect script that creates HTTP 301 (Moved Permanently) redirects for any duplicate product URL keys. This enables Previous links in your web store to work, for example.
-
-
To create redirects for your URLs, perform the following tasks in the order shown:
It's very important to stop cron jobs from running until after the upgrade script completes. To do so, enter one of the following commands as a user with root privileges:
-
Ubuntu: service crond stop
-
CentOS: service cron stop
-
-
Changing Indexer Settings to Update When Scheduled
-
To change indexer settings:
-
Click System > Configuration.
-
In the left navigation bar, in the ADVANCED group, click Index Management.
-
In the right pane, expand Index Options.
-
Click Update when scheduled from the list for every indexer.
-The following figure shows an example.
-
-
In the upper right corner, click Save Config.
-
Note: Ignore any messages requesting you to reindex or flush the cache; you'll do that later.
This section discusses how to run the URL redirect script to create permanent redirects for any URLs that changed in EE 1.13.1.0.
-
Note: The time the script takes to run and the amount of memory it uses is directly proportional to the size of your database. If your database has 100,000 SKUs or more, Magento strongly recommends you monitor thread execution as discussed in this section. For large databases, the script can require several hours to complete.
-
-
To run the script:
-
Change to your Magento installation directory.
-
As the user who owns the files (typically, either root or the web server user), enter the following command:
-
-where
-thread_count is the number of threads to use. Magento recommends setting this to the number of CPU cores in your system minus 1 to a maximum of 15. For example, if your system has 8 CPU cores, enter
-
php -f shell/url_migration_to_1_13.php 7
-
Note: Each thread can use up to 512MB of RAM.
-
Wait while the script runs.
-Messages like the following display to indicate progress:
-
If you have a large database, open another command window and run the following command:
-
watch -n1 "ps ax | grep umt | grep -v grep"
-This command helps you to determine if each thread behaves correctly. After each process finishes, a new process should start immediately. There should be no delays or "hangs" between processes.
If errors display, check [your Magento install dir]/shell/migration.log for exceptions and see the following table.
-
Troubleshooting
-
-
-
-
-
-
Symptom
-
Suggested action
-
-
-
ERROR: Scope of attribute "url_key" is set to Global. This may cause DB inconsistency. Aborting.
-
This error can be caused by either a product or category url_key attribute being set for Global scope. To determine which type of url_key attribute is causing the error:
-
Log in as an administrator to the Admin Panel of the production system (in other words, the system you're upgrading from).
-
Click Catalog > Attributes > Manage Attributes.
-
Click the url_key row.
-
Examine the value of the Scope list. A sample follows.
-
-
If the value in the Scope list is Global:
-
Select another value from the list. You can select any value other thanGlobal.
If the value of the Scope list is notGlobal, the issue is likely that the category url_key attribute is set to global. To confirm this:
-
Log out of the Admin Panel.
-
In the development database instance, use either the MySQL command line or phpmyadmin to get the value of is_global from the catalog_eav_attribute table. If the value is 1, your catalog url_key attribute is set to Global.
- Following is an example of finding the value using the MySQL command line:
-
select attribute_id, is_global from catalog_eav_attribute /
- where attribute_id in (select attribute_id from eav_attribute /
- where attribute_code = 'url_key');
- Note: The command must be entered on a single line. It is shown here on multiple lines because of space limitations. When you enter the command, omit the / characters.
-
If any returned value is 1, you must contact Magento Support.
-
-
-
-
Other errors
-
Try running the script again. If errors persist, contact Magento Support.
-
-
-
-
Running a Full Reindex from the Command Line
-
After successfully running the URL redirect script, enter the following command from the Magento root directory:
-
php -f shell/indexer.php --reindexall
-
This command runs a full reindex and it might take a long time, depending on the size of your database.
-
After the reindex completes, enter the following command from your Magento installation directory:
-
rm -rf var/cache var/full_page_cache var/locks
-
-
Viewing the List of Redirects
-
As a result of running the URL redirect script, a list of redirects created for duplicate URL keys displays in the Admin Panel. To view these redirects:
-
Log in to the Admin Panel as an administrator.
-
Click Catalog > URL Redirects.
-
To optionally sort results by description, click the Description column.
-All redirects created by the URL redirect script display the following description:
-
1.12.0.2-1.13.x migration redirect
-The following figure shows an example.
-
-
-
Verifying That URLs Work Properly
-
Assuming all your post-upgrade issues are fixed, go to your web store and navigate the category tree. Click some products and make sure they display properly. Verify that all Previous and Back links work properly.
This article is part of the Magento Enterprise Edition (EE) upgrade documentation. If you're looking for something else, click here to go back to the Magento Knowledge Base.
-
This article applies to the following Magento EE upgrades:
This article discusses how to run the URL redirect script that creates HTTP 301 (Moved Permanently) redirects for any duplicate product URL keys. This enables Previous links in your web store to work, for example.
-
For more information about URL changes, see the EE 1.13.0.2 Release Notes. (Release Notes for the latest release are here.)
-
To create redirects for your URLs, perform the following tasks in the order shown:
It's very important to stop cron jobs from running until after the upgrade script completes. To do so, enter one of the following commands as a user with root privileges:
-
Ubuntu: service crond stop
-
CentOS: service cron stop
-
-
Running the Script
-
This section discusses how to run the URL redirect script to create permanent redirects for any URLs that changed in EE 1.13.1.0.
-
Note: The time the script takes to run and the amount of memory it uses is directly proportional to the size of your database.
-
To run the script:
-
Change to your Magento installation directory.
-
As the user who owns the files (typically, either root or the web server user), enter the following command:
- php -f shell/url_migration_from_1_13_0_0_to_1_13_0_2.php
-
Wait while the script runs.
- Messages like the following display to indicate progress:
-
[INFO]: Initialization...
-[INFO]: Start url rewrites processing from 1.13.0.0 to 1.13.0.2 ...
-[INFO]: Start root category "Default Category" processing ...
-[INFO]: Start root category "test" processing ...
-[INFO]: Executed in time
If errors display, check [your Magento install dir]/shell/migration.log for exceptions. Following are errors that might display when you run the migration script:
-
Application is not installed yet, please complete install wizard first
-
PHP Fatal error: Uncaught exception 'PDOException' with message 'SQLSTATE[28000] [1045] Access denied for user 'name'@'hostname' (using password: YES)' in /var/www/magento/lib/Zend/Db/Adapter/Pdo/Abstract.php
-
If one of these displays, make sure you copied [your Magento install dir]/app/etc/local.xml from your development system to the production system. Edit it if necessary to reference the production database instance. After you copy and edit local.xml, run the URL redirect script again.
Important: Magento recommends CE 1.9.1.0 or later or EE 1.14.1.0 or later for all CE and EE installations and upgrades to get the latest fixes, features, and security updates.
-
-
The following table provides basic information about how you perform your upgrade. More detailed information is discussed later in this article.
-
-
-
-
Edition and version
-
Upgrade path
-
-
-
CE 1.4 or earlier
-
Your current CE version > CE 1.7 > CE 1.9.0.0
-
-
-
CE 1.5 or later
-
Your current CE version > CE 1.9.0.0
-
-
-
EE 1.7 or earlier
-
Your current EE version > EE 1.12 > EE 1.14.0.0
-
-
-
EE 1.8 or later
-
Your current EE version > EE 1.14.0.0
-
-
-
-
-
Magento EE Upgrade Path
-
Because of changes to URL rewrites, the upgrade to Magento EE 1.13.0.2 or later is more complex than other upgrades. (This includes upgrading to Magento EE 1.14.)
-
Follow are the specific versions affected:
-
Upgrading from EE 1.12 or earlier to EE 1.13.0.2 or later (including to EE 1.14)
-
Upgrading from EE 1.13.0.1 to EE 1.13.0.2 or later (including to EE 1.14)
Provided you complete all tasks discussed in this article exactly as discussed, you can upgrade to Magento CE 1.9 or EE 1.14 from CE 1.5 or later or EE 1.8 or later.
-
Important: Do not upgrade directly to this release if you're currently running CE 1.4 or earlier or EE 1.7 or earlier. A safer approach would be:
-
Upgrade to CE 1.7 or EE 1.12
-
Thoroughly test CE 1.7 or EE 1.12 and fix any issues
-
Back up the system
-
Upgrade to CE 1.9 or EE 1.14
-
-
Note:
-
Use caution when upgrading from versions older than CE 1.7 or EE 1.12 because core code on which your extensions are based and database schema have likely changed.
This section discusses why the upgrade to EE 1.13.0.2 or later requires you to perform different tasks than previous upgrades.
-
One of the results of the change to the way URL keys are handled is that URLs for the same products or categories might need to change from the URLs in the version you're upgrading from. Following are scenarios that might cause URL keys to change:
-
All product keys must be unique. Any duplicate product URL keys are changed. For example, if two products had the URL key nike-shoes, one of them is changed to a URL key like nike-shoes-1 by the URL redirect scripts. This also resolves any conflicts (for example, if you already had another product with key nike-shoes-1).
-
Categories at the same level in the hierarchy in the same store view must have unique URL keys.
-For example, if you have a shoes category with URL key shoes in English store view, schuhe in the German store view and schuhe in the Swiss store view, the upgrade scripts change one of the category's URL keys to something like schuhe-1.
-
To ensure customers and search engines will be directed to the correct page, Magento provides a script that creates HTTP 301 (Moved Permanently) redirects for URLs that are changed.
-
In other words, after the upgrade, all pre-upgrade URLs work but they might be different than they were before you upgraded.
-
The way you upgrade depends on what EE version you're starting from. The following roadmaps provide a high-level overview of the upgrade process:
Following is a high-level roadmap to upgrade to EE 1.13.0.2 or later from EE 1.12 or earlier. This upgrade involves tasks not required for other Magento upgrades; these new tasks are indicated in the roadmap.
-
Install Magento in a different directory:
-
Recommended. Set up a new system (that is, another host) on which to install Magento.
-The system should be identical to, if not better than, your current system. The new system must meet the Magento system requirements.
-
Install Magento in a new, empty root installation directory on the same server.
-
Important: Do not upgrade Magento in the same directory on the same server because post-upgrade errors are likely to occur.
-
-
In your current production environment:
-
Back up your Magento database.
-
Archive the file system.
-This includes the media directory and subdirectories; all extensions and customizations; and all custom themes.
-
-
In the development or test environment:
-
Create a new, empty database instance.
-
Import the production database tables into the development database instance.
-
Copy your production media directory, extensions, themes, and other customizations to the development system.
-
Copy local.xml to [your Magento install dir]/app/etc and edit it if necessary to reference the production database instance.
-
Stop all cron jobs.
-
In a web browser, go to your new base URL.
-
Wait for upgrade scripts to run.
-
Set all indexers to update when scheduled (System > Configuration > ADVANCED > Index Management, Update when scheduled.
-
Run the URL redirect script to create 301 redirects:
-
cd [your Magento install dir]
-php -f shell/url_migration_to_1_13.php - thread-count
-thread-count is the number of CPU cores in your Magento server, minus 1, to a maximum of 15.
Enable cron and make sure the Magento cron job is set up.
-
Verify the upgraded system is now identical to the production system.
-If not, fix issues, retest, and upgrade again.
-
-
Test the upgrade thoroughly, including:
-
Verify all extensions, themes, and customizations work.
-
Place orders using all webstores and all payment methods.
-
Step-by-step instructions for your upgrade start here.
-
-
Upgrading From EE 1.13.0.1
-
Following is a high-level roadmap to upgrade to EE 1.13.0.2 or later from EE 1.13.0.1. This upgrade involves tasks not required for other Magento upgrades; these new tasks are indicated in the roadmap.
-
Install Magento in a different directory:
-
Recommended. Set up a new system (that is, another host) on which to install Magento.
-The system should be identical to, if not better than, your current system. The new system must meet the Magento system requirements.
-
Install Magento in a new, empty root installation directory on the same server.
-
Important: Do not upgrade Magento in the same directory on the same server because post-upgrade errors are likely to occur.
-
-
In your current production environment:
-
Back up your Magento database.
-
Archive the file system.
-This includes the media directory and subdirectories; all extensions and customizations; and all custom themes.
-
-
In the development or test environment:
-
Create a new, empty database instance.
-
Import the production database tables into the development database instance.
-
Copy your production media directory, extensions, themes, and other customizations to the development system.
-
Copy local.xml to [your Magento install dir]/app/etc and edit it if necessary to reference the production database instance.
-
Stop all cron jobs.
-
Run the URL redirect script to create 301 redirects:
-
Enable cron and make sure the Magento cron job is set up.
-
Verify the upgraded system is now identical to the production system.
-If not, fix issues, retest, and upgrade again.
-
-
Test the upgrade thoroughly, including:
-
Verify all extensions, themes, and customizations work.
-
Place orders using all webstores and all payment methods.
-
Important:
-
Only after upgrade is tested and all errors fixed should you consider using it as your production system.
-
Back up your system frequently during the upgrade process so you can roll back to a previous state in the event of errors or issues.
-
To avoid unnecessary downtime and potential issues, never upgrade Magento in a live environment!
-
Step-by-step instructions for your upgrade start here.
-
-
-
\ No newline at end of file
diff --git a/guides/m1x/install/nginx.md b/guides/m1x/install/nginx.md
deleted file mode 100644
index e7c7e4fb29..0000000000
--- a/guides/m1x/install/nginx.md
+++ /dev/null
@@ -1,22 +0,0 @@
----
-layout: m1x
-title: nginx configuration
----
-
-## Install nginx {#instgde-pre-nginx-install}
-
-We support nginx version 1.7.x. Installing the nginx software is beyond the scope of this guide. You can refer to a resource like the following:
-
-* [nginx wiki](https://www.nginx.com/resources/wiki/start/topics/tutorials/install/){: target="_blank"}
-* [How To Install Nginx on Ubuntu 14.04 LTS (digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-14-04-lts){: target="_blank"}
-* [How To Install Nginx on CentOS 6 (digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-centos-6-with-yum){: target="_blank"}
-
-## nginx security setting {#inst-pre-nginx-secy}
-
-[Byte.nl](https://www.byte.nl/){: target="_blank"} recently reported that some misconfigured Magento sites using the nginx web server software are vulnerable to attacks. The misconfiguration allows outside access to Magento cache files. The cache files have predictable names and can contain sensitive information, including Magento database passwords. This information can be used to obtain access to an installation and customer information.
-
-To avoid this issue, you can use [this nginx configuration](https://gist.github.com/gwillem/cd5ae6845fa33aa0d481){: target="_blank"} provided by Willem de Groot.
-
-We also recommend you review the [Magento Security Best Practices](http://merch.docs.magento.com/ee/user_guide/Magento_Enterprise_Edition_User_Guide.html){: target="_blank"}.
-
-Additionally, you can also check your site for other security vulnerabilities at [http://magereport.com](http://magereport.com){: target="_blank"}. This is a Magento community project that is not affiliated with Magento.
\ No newline at end of file
diff --git a/guides/m1x/magefordev/mage-for-dev-1.html b/guides/m1x/magefordev/mage-for-dev-1.html
deleted file mode 100644
index 395772e5a8..0000000000
--- a/guides/m1x/magefordev/mage-for-dev-1.html
+++ /dev/null
@@ -1,507 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
- Magento for Developers: Part 1—Introduction to Magento
-
-
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
-
-
-
Magento for Developers: Part 1—Introduction to Magento
What is Magento? It's the most powerful online eCommerce platform in the universe and is changing the face of eCommerce forever. :-)
-
-
Of course, you already know that. What you may not realize is Magento's also an object-oriented PHP Framework that can be used to develop modern, dynamic web applications that tap into Magento's powerful eCommerce features.
-
-
This is the first in a series of articles in which we're going to go on a whirlwind tour of Magento's programming framework features. Don't worry if you don't follow everything immediately. As you study the system more everything in this article will start to make sense, and you'll soon be the envy of your colleagues stuck working with more primitive PHP systems.
Magento organizes its code into individual Modules. In a typical PHP Model-View-Controller (MVC) application, all the Controllers will be in one folder, all the Models in another, etc. In Magento, files are grouped together based on functionality, which are called modules in Magento.
-
-
Magento's Code
-
For example, you'll find Controllers, Models, Helpers, Blocks, etc. related to Magento's checkout functionality in
-
app/code/core/Mage/Checkout
-
-
You'll find Controllers, Models, Helpers, Blocks, etc. related to Magento's Google Checkout functionality in
-
app/code/core/Mage/GoogleCheckout
-
-
Your Code
-
When you want to customize or extend Magento, rather than editing core files directly, or even placing your new Controllers, Models, Helpers, Blocks, etc. next to Magento code, you'll create your own Modules in
-
app/code/local/Package/Modulename
-
-
Package (also often referred to as a Namespace) is a unique name that identifies your company or organization. The intent is that each member of the world-wide Magento community will use their own Package name when creating modules in order to avoid colliding with another user's code.
-
-
When you create a new Module, you need to tell Magento about it. This is done by adding an XML file to the folder:
-
app/etc/modules
-
-
There are two kinds of files in this folder, the first enables an individual Module, and is named in the form:
-Packagename_Modulename.xml
-
-
The second is a file that will enable multiple Modules from a Package/Namespace, and is named in the form:
-Packagename_All.xml. Note it is only used by the core team with the file Mage_All.xml. It is not recommended to activate several modules in a single file, as this breaks the modularity of your modules.
-
-
-
Configuration-Based MVC
-
-
Magento is a configuration-based MVC system. The alternative to this would a convention-based MVC system.
-
-
In a convention-based MVC system, if you wanted to add, say, a new Controller or maybe a new Model, you'd just create the file/class, and the system would pick it up automatically.
-
-
In a configuration-based system, like Magento, in addition to adding the new file/class to the codebase, you often need to explicitly tell the system about the new class, or new group of classes. In Magento, each Module has a file named config.xml. This file contains all the relevant configuration for a Magento Module. At runtime, all these files are loaded into one large configuration tree.
-
-
For example, want to use Models in your custom Module? You'll need to add some code to config.xml that tells Magento you want to use Models, as well as what the base class name for all your Models should be.
The same goes for Helpers, Blocks, Routes for your Controllers, Event Handlers, and more. Almost anytime you want to tap into the power of the Magento system, you'll need to make some change or addition to your config file.
-
-
-
Controllers
-
-
In any PHP system, the main PHP entry point remains a PHP file. Magento is no different, and that file is index.php.
-
-
However, you never CODE in index.php. In an MVC system, index.php will contain code/calls to code that does the following:
-
-
Examines the URL
-
Based on some set of rules, turns this URL into a Controller class and an Action method (called Routing)
-
Instantiates the Controller class and calls the Action method (called dispatching)
-
-
-
This means the practical entry point in Magento (or any MVC-based system) is a method in a Controller file. Consider the following URL:
-
-
http://example.com/catalog/category/view/id/25
-
-
Each portion of the path after the server name is parsed as follows.
-
-
Front Name - catalog
-
The first portion of the URL is called the front name. This, more or less, tells magento which Module it can find a Controller in. In the above example, the front name is catalog, which corresponds to the Module located at:
-
app/code/core/Mage/Catalog
-
-
Controller Name - category
-
The second portion of the URL tells Magento which Controller it should use. Each Module with Controllers has a special folder named 'controllers' which contains all the Controllers for a module. In the above example, the URL portion category is translated into the Controller file
All Controllers in the Magento cart application extend from Mage_Core_Controller_Front_Action.
-
-
Action Name - view
-
-
Third in our URL is the action name. In our example, this is "view". The word "view" is used to create the Action Method. So, in our example, "view" would be turned into "viewAction"
-
-
-class Mage_Catalog_CategoryController extends Mage_Core_Controller_Front_Action
-{
- public function viewAction()
- {
- //main entry point
- }
-}
-
-
-
People familiar with the Zend Framework will recognize the naming convention here.
-
-
Parameter/Value - id/25
-
-
Any path portions after the action name will be considered key/value GET request variables. So, in our example, the "id/25" means there will get a GET variable named "id", with a value of "25".
-
-
As previously mentioned, if you want your Module to use Controllers, you'll need to configure them. Below is the configuration chunk that enables Controllers for the Catalog Module
Don't worry too much about the specifics right now, but notice the
-
-<frontName>catalog</frontName>
-
-
-
This is what links a Module with a URL frontname. Most Magento core Modules choose a frontname that is the same as their Module name, but this is not required.
-
-
-
Multiple Routers
-
-
The routing described above is for the Magento cart application (often called the frontend). If Magento doesn't find a valid Controller/Action for a URL, it tries again, this time using a second set of Routing rules for the Admin application. If Magento doesn't find a valid Admin Controller/Action, it uses a special Controller named Mage_Cms_IndexController.
-
-
The CMS Controller checks Magento's content Management system to see if there's any content that should be loaded. If it finds some, it loads it, otherwise the user will be presented with a 404 page.
-
-
For example, the main magento "index" page is one that uses the CMS Controller, which can often throw newcomers for a loop.
-
-
-
Context-Based URI Model Loading
-
-
Now that we're in our Action method entry point, we'll want to start instantiating classes that do things. Magento offers a special way to instantiate Models, Helpers and Blocks using static factory methods on the global Mage class. For example:
The string 'catalog/product' is called a Grouped Class Name. It's also often called a URI. The first portion of any Grouped Class Name (in this case, catalog), is used to lookup which Module the class resides in. The second portion ('product' above) is used to determine which class should be loaded.
-
-
So, in both of the examples above, 'catalog' resolves to the Module app/code/core/Mage/Catalog.
-
-
Meaning our class name will start with Mage_Catalog.
-
-
Then, product is added to get the final class name
These rules are bound by what's been setup in each Module's config file. When you create your own custom Module, you'll have your own grouped classnames (also calles classgroups) to work with Mage::getModel('myspecialprefix/modelname');.
-
-
You don't have to use Grouped Class Names to instantiate your classes. However, as we'll learn later, there are certain advantages to doing so.
-
-
-
-
Magento Models
-
-
Magento, like most frameworks these days, offers an Object Relational Mapping (ORM) system. ORMs get you out of the business of writing SQL and allow you to manipulate a datastore purely through PHP code. For example:
In the above example we're calling the methods "getPrice" and "setPrice" on our Product. However, the Mage_Catalog_Model_Product class has no methods with these names. That's because Magento's ORM uses PHP's magic __call method to implement getters and setters.
-
-
Calling the method $product->getPrice(); will "get" the Model attribute "price".
-
-
Calling $product->setPrice(); will "set" the Model attribute "price". All of this assumes the Model class doesn't already have methods named getPrice or setPrice. If it does, the magic methods will be bypassed. If you're interested in the implementation of this, checkout the Varien_Object class, which all Models inherit from.
-
-
If you wanted to get all the available data on a Model, call $product->getData(); to get an array of all the attributes.
-
-
You'll also notice it's possible to chain together several calls to the set method:
That's because each set method returns an instance of the Model. This is a pattern you'll see used in much of the Magento codebase.
-
-
Magento's ORM also contains a way to query for multiple Objects via a Collections interface. The following would get us a collection of all products that cost $5.00
Again, you'll notice Magento's implemented a chaining interface here. Collections use the PHP Standard Library to implement Objects that have array like properties.
-
-
-foreach($products_collection as $product)
-{
- echo $product->getName();
-}
-
-
-
You may be wondering what the "addAttributeToSelect" method is for. Magento has two broad types of Model objects. One is a traditional "One Object, One Table" Active Record style Model. When you instantiate these Models, all attributes are automatically selected.
-
-
The second type of Model is an Entity Attribute Value (EAV) Model. EAV Models spread data across several different tables in the database. This gives the Magento system the flexibility to offer its flexible product attribute system without having to do a schema change each time you add an attribute. When creating a collection of EAV objects, Magento is conservative in the number of columns it will query for, so you can use addAttributeToSelect to get the columns you want, or addAttributeToSelect('*') to get all columns.
-
-
-
Helpers
-
-
Magento's Helper classes contain utility methods that will allow you to perform common tasks on objects and variables. For example:
>
-$helper = Mage::helper('catalog');
-
-
You'll notice we've left off the second part of the grouped class name. Each Module has a default Data Helper class. The following is equivalent to the above:
-$helper = Mage::helper('catalog/data');
-
-
Most Helpers inherit form Mage_Core_Helper_Abstract, which gives you several useful methods by default.
-
-$translated_output = $helper->__('Magento is Great'); //gettext style translations
-if($helper->isModuleOutputEnabled()): //is output for this module on or off?
-
-
-
-
-
Layouts
-
-
So, we've seen Controllers, Models, and Helpers. In a typical PHP MVC system, after we've manipulated our Models we would
-
-
-
Set some variables for our view
-
The system would load a default "outer" HTML layout>
-
The system would then load our view inside that outer layout
-
-
-
However, if you look at a typical Magento Controller action, you don't see any of this:
Instead, the Controller action ends with two calls
-
-
-$this->loadLayout();
-$this->renderLayout();
-
-
-
So, the "V" in Magento's MVC already differs from what you're probably used to, in that you need to explicitly kick off rendering the layout.
-
-
The layout itself also differs. A Magento Layout is an object that contains a nested/tree collection of "Block" objects. Each Block object will render a specific bit of HTML. Block objects do this through a combination of PHP code, and including PHP .phtml template files.
-
-
Blocks objects are meant to interact with the Magento system to retrieve data from Models, while the phtml template files will produce the HTML needed for a page.
-
-
For example, the page header Block app/code/core/Mage/Page/Block/Html/Head.php uses the head.phtml file page/html/head.phtml.
-
-
Another way of thinking about it is the Block classes are almost like little mini-controllers, and the .phtml files are the view.
-
-
By default, when you call
-
-
-$this->loadLayout();
-$this->renderLayout();
-
-
-
Magento will load up a Layout with a skeleton site structure. There will be Structure Blocks to give you your html, head, and body, as well as HTML to setup single or multiple columns of Layout. Additionally, there will be a few Content Blocks for the navigation, default welcome message, etc.
-
-
"Structure" and "Content" are arbitrary designations in the Layout system. A Block doesn't programmatically know if it's Structure or Content, but it's useful to think of a Block as one or the other.
-
-
To add Content to this Layout you need to tell the Magento system something like
-
-
"Hey, Magento, add these additional Blocks under the "content" Block of the skeleton"
-
-or
-
-
"Hey, Magento, add these additional Blocks under the "left column" Block of the skeleton"
-
-
This can be done programmatically in a Controller action
but more commonly (at least in the frontend cart application), is use of the XML Layout system.
-
-
The Layout XML files in a theme allow you, on a per Controller basis, to remove Blocks that would normally be rendered, or add Blocks to that default skeleton areas. For example, consider this Layout XML file:
It's saying in the catalog Module, in the category Controller, and the default Action, insert the catalog/navigation Block into the "left" structure Block, using the catalog/navigation/left.phtml template.
-
-
One last important thing about Blocks. You'll often see code in templates that looks like this:
-$this->getChildHtml('order_items')
-
-
This is how a Block renders a nested Block. However, a Block can only render a child Block if the child Block is included as a nested Block in the Layout XML file. In the example above our catalog/navigation Block has no nested Blocks. This means any call to $this->getChildHtml() in left.phtml will render as blank.
From the catalog/navigation Block, we'd be able to call
-$this->getChildHtml('foobar');
-
-
-
-
Observers
-
-
Like any good object-oriented system, Magento implements an Event/Observer pattern for end users to hook into. As certain actions happen during a Page request (a Model is saved, a user logs in, etc.), Magento will issue an event signal.
-
-
When creating your own Modules, you can "listen" for these events. Say you wanted to get an email every time a certain customer logged into the store. You could listen for the "customer_login" event (setup in config.xml)
and then write some code that would run whenever a user logged in:
-
-
-class Packagename_Mymodule_Model_Observer
-{
- public function iSpyWithMyLittleEye($observer)
- {
- $data = $observer->getData();
- //code to check observer data for our user,
- //and take some action goes here
- }
-}
-
-
-
-
Class Overrides
-
-
Finally, the Magento System offers you the ability to replace Model, Helper and Block classes from the core modules with your own. This is a feature that's similar to "Duck Typing" or "Monkey Patching" in a language like Ruby or Python.
-
-
Here's an example to help you understand. The Model class for a product is Mage_Catalog_Model_Product.
-
-
Whenever the following code is called, a Mage_Catalog_Model_Product object is created
-
-
$product = Mage::getModel('catalog/product');
-
-
This is a factory pattern.
-
-
What Magento's class override system does is allow you to tell the system
-
-
"Hey, whenever anyone asks for a catalog/product, instead of giving them a Mage_Catalog_Model_Product,
-give them a Packagename_Modulename_Model_Foobazproduct instead".
-
-
Then, if you want, your Packagename_Modulename_Model_Foobazproduct class can extend the original product class
Which will allow you to change the behavior of any method on the class, but keep the functionality of the existing methods.
-
-
class Packagename_Modulename_Model_Foobazproduct extends Mage_Catalog_Model_Product
-{
- public function validate()
- {
- //add custom validation functionality here
- return $this;
- }
-
-}
-
-
-
As you might expect, this overriding (or rewriting) is done in the config.xml file.
-
-
-<models>
- <!-- does the override for catalog/product-->
- <catalog>
- <rewrite>
- <product>Packagename_Modulename_Model_Foobazproduct</product>
- </rewrite>
- </catalog>
-</models>
-
-
-
One thing that's important to note here. Individual classes in your Module are overriding individual classes in other Modules. You are not, however, overriding the entire Module. This allows you to change specific method behavior without having to worry what the rest of the Module is doing.
-
-
-
-
Wrap Up
-
-
We hope you've enjoyed this whirlwind tour of some of the features the Magento eCommerce system offers to developers. It can be a little overwhelming at first, especially if this is your first experience with a modern, object-oriented PHP system. If you start to get frustrated, take a deep breath, remind yourself that this is new, and new things are hard, but at the end of the day it's just a different way of coding. Once you get over the learning curve you'll find yourself loath to return to other, less powerful systems.
-
-
-
\ No newline at end of file
diff --git a/guides/m1x/magefordev/mage-for-dev-2.html b/guides/m1x/magefordev/mage-for-dev-2.html
deleted file mode 100644
index 3c94eee744..0000000000
--- a/guides/m1x/magefordev/mage-for-dev-2.html
+++ /dev/null
@@ -1,237 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
- Magento for Developers: Part 2—The Magento Config
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
The config is the beating heart of the Magento System. It describes, in whole, almost any module, model, class, template, etc. than you'll need to access. It's a level of abstraction that most PHP developers aren't used to working with, and while it adds development time in the form of confusion and head scratching, it also allows you an unprecedented amount of flexibility as far as overriding default system behaviors go.
-
-
To start with, we're going to create a Magento module that will let us view the system config in our web browser. Follow along by copying and pasting the code below, it's worth going through on your own as a way to start getting comfortable with things you'll be doing while working with Magento, as well as learning key terminology.
We're going to be creating a Magento module. A module is a group of php and xml files meant to extend the system with new functionality, or override core system behavior. This may meaning adding additional data models to track sales information, changing the behavior of existing classes, or adding entirely new features.
-
-
It's worth noting that most of the base Magento system is built using the same module system you'll be using. If you look in
-
-
app/code/core/Mage
-
-
each folder is a separate module built by the Magento team. Together, these modules form the community shopping cart system you're using. Your modules should be placed in the following folder
-
-
app/code/local/Packagename
-
-
"Packagename" should be a unique string to Namespace/Package your code. It's an unofficial convention that this should be the name of your company. The idea is to pick a string that no one else in the world could possibly be using.
-
-
app/code/local/Microsoft
-
-
We'll use "Magentotutorial".
-
-
So, to add a module to your Magento system, create the following directory structure
That's it. You now have a bare bones module that won't do anything, but that Magento will be aware of. To make sure you've done everything right, do the following:
-
-
Clear your Magento cache
-
In the Magento Admin, go to System->Configuration->Advanced
-
In the "Disable modules output" panel verify that Magentotutorial_Configviewer shows up
-
-
-
Congratulations, you've built your first Magento module!
-
-
-
Creating a Module Config
-
-
Of course, this module doesn't do anything yet. When we're done, our module will
-
-
Check for the existence of a "showConfig" query string variable
-
If showConfig is present, display our Magento config and halt normal execution
-
Check for the existence of an additional query string variable, showConfigFormat that will let us specify text or xml output.
-
-
-
First, we're going to add the following <global> section to our config.xml file.
That's it. Clear your Magento cache again and then load any Magento URL with a showConfig=true query string
-
-
http://magento.example.com/?showConfig=true
-
-
-
What am I looking at?
-
-
You should be looking at a giant XML file. This describes the state of your Magento system. It lists all modules, models, classes, event listeners or almost anything else you could think of.
-
-
For example, consider the config.xml file you created above. If you search the XML file in your browser for the text Configviewer_Model_Observer you'll find your class listed. Every module's config.xml file is parsed by Magento and included in the global config.
-
-
-
Why Do I Care?
-
-
Right now this may seem esoteric, but this config is key to understanding Magento. Every module you'll be creating will add to this config, and anytime you need to access a piece of core system functionality, Magento will be referring back to the config to look something up.
-
-
A quick example: As an MVC developer, you've likely worked with some kind of helper class, instantiated something like
-
-
-$helper_sales = new HelperSales();
-
-
-
One of the things Magento has done is abstract away PHP's class declaration. In Magento, the above code looks something like
-
-
-$helper_sales = Mage::helper('sales');
-
-
-
In plain english, the static helper method will:
-
-
Look in the <helpers /> section of the Config.
-
Within <helpers />, look for a <sales /> section
-
Within the <sales /> section look for a <class /> section
-
Append the part after the slash to the value found in #3 (defaulting to data in this case)
-
Instantiate the class found in #4 (Mage_Sales_Helper_Data)
-
-
-
While this seems like a lot of work (and it is), the key advantage is by always looking to the config file for class names, we can override core Magento functionality without changing or adding to the core code. This level of meta programming, not usually found in PHP, allows you to cleanly extend only the parts of the system you need to.
The Model-View-Controller (MVC) architecture traces its origins back to the Smalltalk Programming language and Xerox Parc. Since then, there have been many systems that describe their architecture as MVC. Each system is slightly different, but all have the goal of separating data access, business logic, and user-interface code from one another.
-
-
The architecture of most PHP MVC frameworks will looks something like this.
-
-
-
A URL is intercepted by a single PHP file (usually called a Front Controller).
-
This PHP file will examine the URL, and derive a Controller name and an Action name (a process that's often called routing).
-
The derived Controller is instantiated.
-
The method name matching the derived Action name is called on the Controller.
-
This Action method will instantiate and call methods on models, depending on the request variables.
-
The Action method will also prepare a data structure of information. This data structure is passed on to the view.
-
The view then renders HTML, using the information in the data structure it has received from the Controller.
-
-
-
While this pattern was a great leap forward from the "each php file is a page" pattern established early on, for some software engineers, it's still an ugly hack. Common complaints are:
-
-
-
The Front Controller PHP file still operates in the global namespace.
-
Convention over configuration leads to less modularity.
-
-
URLs routing is often inflexible.
-
Controllers are often bound to specific views.
-
Even when a system offers a way to override these defaults, the convention leads to applications where it's difficult/impossible to drop in a new model, view, or Controller implementation without massive re-factoring.
-
-
-
-
As you've probably guessed, the Magento team shares this world view and has created a more abstract MVC pattern that looks something like this:.
-
-
-
A URL is intercepted by a single PHP file.
-
This PHP file instantiates a Magento application.
-
The Magento application instantiates a Front Controller object.
-
Front Controller instantiates any number of Router objects (specified in global config).
-
Routers check the request URL for a "match".
-
If a match is found, an Action Controller and Action are derived.
-
The Action Controller is instantiated and the method name matching the Action Name is called.
-
This Action method will instantiate and call methods on models, depending on the request.
-
This Action Controller will then instantiate a Layout Object.
-
This Layout Object will, based some request variables and system properties (also known as "handles"), create a list of Block objects that are valid for this request.
-
Layout will also call an output method on certain Block objects, which start a nested rendering (Blocks will include other Blocks).
-
Each Block has a corresponding Template file. Blocks contain PHP logic, templates contain HTML and PHP output code.
-
Blocks refer directly back to the models for their data. In other words, the Action Controller does not pass them a data structure.
-
-
-
We'll eventually touch on each part of this request, but for now we're concerned with the Front Controller -> Routers -> Action Controller section.
-
-
-
Hello World
-
Enough theory, it's time for Hello World. We're going to
-
-
Create a Hello World module in the Magento system
-
Configure this module with routes
-
Create Action Controller(s) for our routes
-
-
-
Create Hello World Module
-
-
First, we'll create a directory structure for this module. Our directory structure should look as follows:
-
-
In the Magento Admin, go to System->Configuration->Advanced.
-
Expand "Disable Modules Output" (if it isn't already).
-
Ensure that Magentotutorial_Helloworld shows up.
-
-
-
Configuring Routes
-
-
Next, we're going to configure a route. A route will turn a URL into an Action Controller and a method. Unlike other convention based PHP MVC systems, with Magento you need to explicitly define a route in the global Magento config.
-
-
In your config.xml file(at path app/code/local/Magentotutorial/Helloworld/etc/config.xml), add the following section:
-
-
We have a lot of new terminology here, let's break it down.
-
-
What is a <frontend>?
-
-
The <frontend> tag refers to a Magento Area. For now, think of Areas as individual Magento applications. The "frontend" Area is the public facing Magento shopping cart application. The "admin" Area is the private administrative console application. The "install" Area is the application you use to run though installing Magento the first time.
-
-
Why a <routers> tags if we're configuring individual routes?
-
-
There's a famous quote about computer science, often attributed to Phil Karlton:
-
-
"There are only two hard things in Computer Science: cache invalidation and naming things"
-
-
-
Magento, like all large systems, suffers from the naming problem in spades. You'll find there are many places in the global config, and the system in general, where the naming conventions seem unintuitive or even ambiguous. This is one of those places. Sometimes the <routers> tag will enclose configuration information about routers, other times it will enclose configuration information about the actual router objects that do the routing. This is going to seem counter intuitive at first, but as you start to work with Magento more and more, you'll start to understand its world view a little better. (Or, in the words of Han Solo, "Hey, trust me!").
-
-
What is a <frontName>?
-
-
When a router parses a URL, it gets separated as follows
So, by defining a value of "helloworld" in the <frontName> tags, we're telling Magento that we want the system to respond to URLs in the form of
-
-
http://example.com/helloworld/*
-
-
Many developers new to Magento confuse this frontName with the Front Controller object. They are not the same thing. The frontName belongs solely to routing.
-
-
What's the <helloworld> tag for?
-
-
This tag should be the lowercase version of you module name. Our module name is Helloworld, this tag is helloworld. Technically this tag defines our route name
-
-
You'll also notice our frontName matches our module name. It's a loose convention to have frontNames match the module names, but it's not a requirement. In your own modules, it's probably better to use a route name that's a combination of your module name and package name to avoid possible namespace collisions.
This module tag should be the full name of your module, including its package/namespace name. This will be used by the system to locate your Controller files.
-
-
Create Action Controller(s) for our Routes
-
-
One last step to go, and we'll have our Action Controller. Create a file at
-
-
the URI portion "helloworld" is the frontName, which is followed by index (The Action Controller name), which is followed by another index, which is the name of the Action Method that will be called. (an Action of index will call the method public function indexAction(){...}.
-
-
If a URL is incomplete, Magento uses "index" as the default, which is why the following URLs are equivalent.
-
Consult the global config to find the module to use for the frontName checkout (Mage_Checkout)
-
Look for the cart Action Controller (Mage_Checkout_CartController)
-
Call the addAction method on the cart Action Controller
-
-
-
Other Action Controller Tricks
-
-
Let's try adding a non-default method to our Action Controller. Add the following code to IndexController.php
-
-
-public function goodbyeAction() {
- echo 'Goodbye World!';
-}
-
-
-
And then visit the URL to test it out:
-
http://example.com/helloworld/index/goodbye
-
-
Because we're extending the Mage_Core_Controller_Front_Action class, we get some methods for free. For example, additional URL elements are automatically parsed into key/value pairs for us. Add the following method to your Action Controller.
-
-
with an Action Controller named Magentotutorial_Helloworld_MessagesController and an Action Method that looked something like
-
-public function goodbyeAction()
-{
- echo 'Another Goodbye';
-}
-
-
-
And that, in a nutshell, is how Magento implements the Controller portion of MVC. While it's a little more complicated than other PHP MVC framework's, it's a highly flexible system that will allow you build almost any URL structure you want.
Developers new to Magento are often confused by the Layout and View system. This article will take a look at Magento's Layout/Block approach, and show you how it fits into Magento MVC worldview.
-
-
Unlike many popular MVC systems, Magento's Action Controller does not pass a data object to the view or set properties on the view object (with a few exceptions). Instead, the View component directly references system models to get the information it needs for display.
-
-
One consequence of this design decision is that the View has been separated into Blocks and Templates. Blocks are PHP objects, Templates are "raw" PHP files (with a .phtml extension) that contain a mix of HTML and PHP (where PHP is used as a templating language). Each Block is tied to a single Template file. Inside a phtml file, PHP's $this keyword will contain a reference to the Template's Block object.
-
-
-
A quick example
-
-
Take a look at the default product Template at the file at
The block's _getProductCollection then instantiates models and reads their data, returning a result to the template.
-
-
Nesting Blocks
-
-
The real power of Blocks/Templates come with the getChildHtml method. This allows you to include the contents of a secondary Block/Template inside of a primary Block/Template.
-
-
Blocks calling Blocks calling Blocks is how the entire HTML layout for your page is created. Take a look at the one column layout Template.
The template itself is only 28 lines long. However, each call to $this->getChildHtml(...) will include and render another Block. These Blocks will, in turn, use getChildHtml to render other Blocks. It's Blocks all the way down.
-
-
The Layout
-
-
So, Blocks and Templates are all well and good, but you're probably wondering
-
-
-
How do I tell Magento which Blocks I want to use on a page?
-
How do I tell Magento which Block I should start rendering with?
-
How do I specify a particular Block in getChildHtml(...)? Those argument strings don't look like Block names to me.
-
-
-
This is where the Layout Object enters the picture. The Layout Object is an XML object that will define which Blocks are included on a page, and which Block(s) should kick off the rendering process.
-
-
Last time we were echoing content directly from our Action Methods. This time let's create a simple HTML template for our Hello World module.
Clear your Magento cache and reload your Hello World controller page. You should now see a website with a bright red background and an HTML source that matches what's in simple_page.phtml.
-
-
What's Going On
-
-
So, that's a lot of voodoo and cryptic incantations. Let's take a look at what's going on.
-
-
First, you'll want to install the Layoutviewer module. This is a module similar to the Configviewer module you built in the Hello World article that will let us peek at some of Magento's internals.
-
-
Once you've installed the module (similar to how you setup the Configviewer module), go to the following URL
This is the layout xml for your page/request. It's made up of <block />, <reference /> and <remove /> tags. When you call the loadLayout method of your Action Controller, Magento will
-
-
-
Generate this Layout XML
-
Instantiate a Block class for each <block /> tag, looking up the class using the tag's type attribute as a global config path and store it in the internal _blocks array of the layout object, using the tag's name attribute as the array key.
-
If the <block /> tag contains an output attribute, its value is added to the internal _output array of the layout object.
-
-
-
Then, when you call the renderLayout method in your Action Controller, Magento will iterate over all the Blocks in the _output array, using the value of the output attribute as a callback method. This is always toHtml, and means the starting point for output will be that Block's Template.
-
-
The following sections will cover how Blocks are instantiated, how this layout file is generated, and finishes up with kicking off the output process.
-
-
Block Instantiation
-
-
So, within a Layout XML file, a <block /> has a "type" that's actually a Grouped Class Name URI
The URI references a location in the (say it with me) global config. The first portion of the URI (in the above examples page) will be used to query the global config to find the page class name. The second portion of the URI (in the two examples above, html and template_links) will be appended to the base class name to create the class name Magento should instantiate.
-
-
We'll go through page/html as an example. First, Magento looks for the global config node at file
This gives us our base class prefix Mage_Page_Block. Then, the second part of the URI (html) is appended to the class name to give us our final Block class name Mage_Page_Block_Html. This is the class that will be instantiated.
-
-
If we create a block with the same name as an already existing block, the new block instance will replace the original instance. This is what we've done in our local.xml file from above.
The Block named root has been replaced with our Block, which points at a different phtml Template file.
-
-
Using references
-
-
<reference name="" /> will hook all contained XML declarations into an existing block with the specified name. Contained <block /> nodes will be assigned as child blocks to the referenced parent block.
Even though the root block is declared in a separate layout XML file, the new block is added as a child block. Magento initially creates a page/html Block named root. Then, when it later encounters the reference with the same name (root), it will assign the new block some.other.block.name as a child of the root block.
-
-
-
How Layout Files are Generated
-
-
So, we have a slightly better understanding of what's going on with the Layout XML, but where is this XML file coming from? To answer that question, we need to introduce two new concepts; Handles and the Package Layout.
-
-
Handles
-
-
Each page request in Magento will generate several unique Handles. The Layoutview module can show you these Handles by using a URL something like
You should see a list similar to the following (depending on your configuration)
-
-
-
default
-
STORE_bare_us
-
THEME_frontend_default_default
-
helloworld_index_index
-
customer_logged_out
-
-
-
Each of these is a Handle. Handles are set in a variety of places within the Magento system. The two we want to pay attention to are default and helloworld_index_index. The default Handle is present in every request into the Magento system. The helloworld_index_index Handle is created by combining the route name (helloworld), Action Controller name (index), and Action Controller Action Method (index) into a single string. This means each possible method on an Action Controller has a Handle associated with it.
-
-
Remember that "index" is the Magento default for both Action Controllers and Action Methods, so the following request
-
-
http://example.com/helloworld/?showLayout=handles
-
-
Will also produce a Handle named helloworld_index_index
-
-
Package Layout
-
-
You can think of the Package Layout similar to the global config. It's a large XML file that contains every possible layout configuration for a particular Magento install. Let's take a look at it using the Layoutview module
You should see a very large XML file. This is the Package Layout. This XML file is created by combining the contents of all the XML layout files for the current theme (or package). For the default install, this is at
-
-
app/design/frontend/base/default/layout/
-
-
Behind the scenes there are <frontend><layout><updates /> and <adminhtml><layout><updates /> sections of the global config that contains nodes with all the file names to load for the respective area. Once the files listed in the config have been combined, Magento will merge in one last xml file, local.xml. This is the file where you're able to add your customizations to your Magento install.
-
-
Combining Handles and The Package Layout
-
-
So, if you look at the Package Layout, you'll see some familiar tags such as <block /> and <reference />, but they're all surrounded by tags that look like
These are all Handle tags. The Layout for an individual request is generated by grabbing all the sections of the Package Layout that match any Handles for the request. So, in our example above, our layout is being generated by grabbing tags from the following sections
There's one additional tag you'll need to be aware of in the Package Layout. The <update /> tag allows you to include another Handle's tags. For example
to local.xml means we've overridden the "root" tag. with a different Block. By placing this in the <default /> Handle we've ensured that this override will happen for every page request in the system. That's probably not what we want.
-
-
-
If you go to any other page in your Magento site, you'll notice they're either blank white, or have the same red background that your hello world page does. Let's change your local.xml file so it only applies to the hello world page. We'll do this by changing default to use the full action name handle (helloworld_index_index).
Clear your Magento cache, and the rest of your pages should be restored.
-
-
Right now this only applies to our index Action Method. Let's add it to the goodbye Action Method as well. In your Action Controller, modify the goodbye action so it looks like
-
-public function goodbyeAction() {
- $this->loadLayout();
- $this->renderLayout();
-}
-
-
-
If you load up the following URL, you'll notice you're still getting the default Magento layout.
-
-
http://example.com/helloworld/index/goodbye
-
-
We need to add a Handle for the full action name (helloworld_index_goodbye) to our local.xml file. Rather than specify a new <block />, lets use the update tag to include the helloworld_index_index Handle.
A simple red page is pretty boring. Let's add some content to this page. Change your <helloworld_index_index /> Handle in local.xml so it looks like the following
We're adding a new Block nested within our root. This is a Block that's distributed with Magento, and will display a customer registration form. By nesting this Block within our root Block, we've made it available to be pulled into our simple_page.html Template. Next, we'll use the Block's getChildHtml method in our simple_page.phtml file. Edit simple_page.html so it looks like this
Clear your Magento cache and reload the page and you should see the customer registration form on your red background. Magento also has a Block named top.links. Let's try including that. Change your simple_page.html file so it reads
When you reload the page, you'll notice that your <h1>Links</h1> title is rendering, but nothing is rendering for top.links. That's because we didn't add it to local.xml. The getChildHtml method can only include Blocks that are specified as sub-Blocks in the Layout. This allows Magento to only instantiate the Blocks it needs, and also allows you to set difference Templates for Blocks based on context.
Clear your cache and reload the page. You should now see the top.links module.
-
-
Time for action
-
-
There is one more important concept to cover before we wrap up this lesson, and that is the <action /> tag. Using the <action /> tag enables us to call public PHP methods of the block classes. So instead of changing the template of the root block by replacing the block instance with our own, we can use a call to setTemplate instead.
This layout XML will first set the template property of the root block, and then will add the two blocks we use as child blocks. Once we clear the cache, the result should look just as before. The benefit of using the <action /> is the same block instance is used that was created earlier, and all other parent/child associations still exist. For that reason this is a more upgrade proof way of implementing our changes.
-
-
All arguments to the action's method need to be wrapped in an individual child node of the <action /> tag. The name of that node doesn't matter, only the order of the nodes. We could have written the action node from the previous example as follows with the same effect.
-
This is just to illustrate that the action's argument node names are arbitrary.
-
-
Wrapup
-
-
That covers Layout fundamentals. We have covered the tags <block />, <reference />, <update /> and <action />, and also layout update handles like <default /> and <cms_index_index />. These make up most of the layout configuration used in Magento. If you found it somewhat daunting, don't worry, you'll rarely need to work with layouts on such a fundamental level. Magento provides a number of pre-built layouts which can be modified and skinned to meet the needs of your store. Understanding how the entire Layout system works can be a great help when you're trouble shooting Layout issues, or adding new functionality to an existing Magento system.
diff --git a/guides/m1x/magefordev/mage-for-dev-5.html b/guides/m1x/magefordev/mage-for-dev-5.html
deleted file mode 100644
index d47c4189ec..0000000000
--- a/guides/m1x/magefordev/mage-for-dev-5.html
+++ /dev/null
@@ -1,458 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
- Magento for Developers: Part 5—Magento Models and ORM Basics
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
-
Magento for Developers: Part 5—Magento Models and ORM Basics
The implementation of a "Models Tier" is a huge part of any MVC framework. It represents the data of your application, and most applications are useless without data. Magento Models play an even bigger role, as they typically contain the "Business Logic" that's often relegated to the Controller or Helper methods in other PHP MVC frameworks.
-
-
Traditional PHP MVC Models
-
-
If the definition of MVC is somewhat fuzzy, the definition of a Model is even fuzzier. Prior to the wide adoption of the MVC pattern by PHP developers, data access was usually raw SQL statements and/or an SQL abstraction layer. Developers would write queries and not think too much about what objects they were modeling.
-
-
In this day and age, raw SQL is mostly frowned upon, but many PHP frameworks are still SQL centric. Models will be objects that provide some layer of abstraction, but behind the scenes developers are still writing SQL and/or calling SQL like abstraction methods to read and write-down their data.
-
-
Other frameworks eschew SQL and take the Object Relational Mapping (ORM) approach. Here, a developer is dealing strictly with Objects. Properties are set, and when a save method is called on the Object, the data is automatically written to the database. Some ORMs will attempt to divine object properties from the database, others require the user to specify them in some way, (usually in an abstract data language such as YAML). One of the most famous and popular implementations of this approach is ActiveRecord.
-
-
This definition of ORM should suffice for now, but like everything Computer Science these days, the strict definition of ORM has blurred over the years. It's beyond the scope of this article to settle that dispute, but suffice it say we're generalizing a bit.
-
-
Magento Models
-
-
It should be no surprise that Magento takes the ORM approach. While the Zend Framework SQL abstractions are available, most of your data access will be via the built in Magento Models, and Models you build yourself. It should also come as no surprise that Magento has a highly flexible, highly abstract, concept of what a Model is.
-
-
Anatomy of a Magento Model
-
-
Most Magento Models can be categorized in one of two ways. There's a basic, ActiveRecord-like/one-object-one-table Model, and there's also an Entity Attribute Value (EAV) Model. Each Model also gets a Model Collection. Collections are PHP objects used to hold a number of individual Magento Model instances. The Magento team has implemented the PHP Standard Library interfaces of IteratorAggregate and Countable to allow each Model type to have it's own collection type. If you're not familiar with the PHP Standard Library, think of Model Collections as arrays that also have methods attached.
-
-
Magento Models don't contain any code for connecting to the database. Instead, each Model uses a modelResource class, that is used to communicate with the database server (via one read and one write adapter object). By decoupling the logical Model and the code that talks to the database, it's theoretically possible to write new resource classes for a different database schemas and platforms while keeping your Models themselves untouched.
-
-
Enable developer mode
-
Something you should do in development—but never in production—is to enable Magento's developer mode which, among other things, displays exceptions in your browser. It's useful for debugging your code.
-
Enable developer mode in any of the following ways:
Edit the .htaccess in the Magento root directory file to add SetEnv MAGE_IS_DEVELOPER_MODE "true"
-
-
Creating a Basic Model
-
-
To begin, we're going to create a basic Magento Model. PHP MVC tradition insists we model a weblog post. The steps we'll need to take are
-
-
-
Create a new "Weblog" module
-
Create a database table for our Model
-
Add Model information to the config for a Model named Blogpost
-
Add Model Resource information to the config for the Blogpost Model
-
Add a Read Adapter to the config for the Blogpost Model
-
Add a Write Adapter to the config for the Blogpost Model
-
Add a PHP class file for the Blogpost Model
-
Add a PHP class file for the Blogpost Resource Model
-
Instantiate the Model
-
-
-
Create a Weblog Module
-
-
You should be an old hat at creating empty modules at this point, so we'll skip the details and assume you can create an empty module named Weblog. After you've done that, we'll setup a route for an index Action Controller with an action named "testModel". As always, the following examples assume a Package Name of "Magentotutorial".
-
-
In `Magentotutorial/Weblog/etc/config.xml`, setup the following route
-class Magentotutorial_Weblog_IndexController extends Mage_Core_Controller_Front_Action {
- public function testModelAction() {
- echo 'Setup!';
- }
-}
-
-
-
at Magentotutorial/Weblog/controllers/IndexController.php. Clear your Magento cache and load the following URL to ensure everything's been setup correctly.
-
-
http://example.com/weblog/index/testModel
-
-
You should see the word "Setup" on a white background.
-
-
Creating the Database Table
-
-
Magento has a system for automatically creating and changing your database schemas, but for the time being we'll just manually create a table for our Model.
-
-
Using the command-line or your favorite MySQL GUI application, create a table with the following schema
INSERT INTO `blog_posts` VALUES (1,'My New Title','This is a blog post','2010-07-01 00:00:00','2010-07-02 23:12:30');
-
-
The Global Config and Creating The Model
-
-
There are three individual things we need to setup for a Model in our config.
-
-
-
Enabling Models in our Module
-
Enabling Model Resources in our Module
-
Add an "entity" table configuration to our Model Resource.
-
-
-
When you instantiate a Model in Magento, you make a call like this
-
-
$model = Mage::getModel('weblog/blogpost');
-
-
The first part of the URI you pass into get Model is the Model Group Name. Because it is a good idea to follow conventions, this should be the (lowercase) name of your module, or to be safeguarded against conflicts use the packagename and modulename (also in lowercase). The second part of the URI is the lowercase version of your Model name.
-
-
So, let's add the following XML to our module's `config.xml`.
-
-<global>
- <!-- ... -->
- <models>
- <weblog>
- <class>Magentotutorial_Weblog_Model</class>
- <!--
- need to create our own resource, can't just
- use core_resource
- -->
- <resourceModel>weblog_resource</resourceModel>
- </weblog>
- </models>
- <!-- ... -->
-</global>
-
-
-
The outer <weblog /> tag is your Group Name, which should match your module name. <class /> is the BASE name all Models in the weblog group will have, also called Class Prefix. The <resourceModel /> tag indicates which Resource Model that weblog group Models should use. We talk more about this later on in this page. For now, remember your Group Name and the literal string "resource".
-
-
So, we're not done yet, but let's see what happens if we clear our Magento cache and attempt to instantiate a blogpost Model. In your `testModelAction` method, use the following code
-
- public function testModelAction() {
- $blogpost = Mage::getModel('weblog/blogpost');
- echo get_class($blogpost);
- }
-
-
-
and reload your page. You should see an error like the following:
-
-
-include(Magentotutorial/Weblog/Model/Blogpost.php) [function.include]: failed to open stream: No such file or directory
-
-
-
By attempting to retrieve a weblog/blogpost Model, you told Magento to instantiate a class with the name
-
-
-Magentotutorial_Weblog_Model_Blogpost
-
-
-
Magento is trying to __autoload include this Model, but can't find the file. Let's create it! Create the following class at the following location
Reload your page, and the exception should be replaced with the name of your class.
-
-
All basic Models that interact with the database should extend the Mage_Core_Model_Abstract class. This abstract class forces you to implement a single method named _construct (NOTE: this is not PHP's constructor __construct). This method should call the class's _init method with the same identifying URI you'll be using in the Mage::getModel method call.
-
-
The Global Config and Resources
-
-
So, we've setup our Model. Next, we need to setup our Model Resource. Model Resources contain the code that actually talks to our database. In the last section, we included the following in our config.
-
-
-<resourceModel>weblog_resource</resourceModel>
-
-
-
The value in <resourceModel /> will be used to instantiate a Model Resource class. Although you'll never need to call it yourself, when any Model in the weblog group needs to talk to the database, Magento will make the following method call to get the Model resource
-
-
-Mage::getResourceModel('weblog/blogpost');
-
-
-
Again, weblog is the Group Name, and blogpost is the Model. The Mage::getResourceModel method will use the weblog/blogpost URI to inspect the global config and pull out the value in <resourceModel> (in this case, weblog_resource). Then, a model class will be instantiated with the following URI
-
-
-weblog_resource/blogpost
-
-
-
So, if you followed that all the way, what this means is, resource models are configured in the same section of the XML config as normal Models. This can be confusing to newcomers and old-hands alike.
-
-
So, with that in mind, let's configure our resource. In our <models> section add
You're adding the <weblog_resource /> tag, which is the value of the <resourceModel /> tag you just setup. The value of <class /> is the base name that all your resource models will have, and should be named with the following format
-
-
-Packagename_Modulename_Model_Resource
-
-
-
So, we have a configured resource, let's try loading up some Model data. Change your action to look like the following
-
-
-public function testModelAction() {
- $params = $this->getRequest()->getParams();
- $blogpost = Mage::getModel('weblog/blogpost');
- echo("Loading the blogpost with an ID of ".$params['id']);
- $blogpost->load($params['id']);
- $data = $blogpost->getData();
- var_dump($data);
-}
-
-
-
And then load the following URL in your browser (after clearing your Magento cache)
-
-
http://example.com/weblog/index/testModel/id/1
-
-
You should see an exception something like the following
-
-
Warning: include(Magentotutorial/Weblog/Model/Resource/Blogpost.php) [function.include]: failed to open stream: No such file ....
-
-
As you've likely intuited, we need to add a resource class for our Model. Every Model has its own resource class. Add the following class at the following location
Again, the first parameter of the init method is the URL used to identify the Model. The second parameter is the database field that uniquely identifies any particular column. In most cases, this should be the primary key. Clear your cache, reload, and you should see
-
-
Can't retrieve entity config: weblog/blogpost
-
-
Another exception! When we use the Model URI weblog/blogpost, we're telling Magento we want the Model Group weblog, and the blogpostEntity. In the context of simple Models that extend Mage_Core_Model_Resource_Db_Abstract, an entity corresponds to a table. In this case, the table named blog_post that we created above. Let's add that entity to our XML config.
We've added a new <entities /> section to the resource Model section of our config. This, in turn, has a section named after our entity (<blogpost />) that specifies the name of the database table we want to use for this Model.
-
-
Clear your Magento cache, cross your fingers, reload the page and ...
-
-
Loading the blogpost with an ID of 1
-
-array
- 'blogpost_id' => string '1' (length=1)
- 'title' => string 'My New Title' (length=12)
- 'post' => string 'This is a blog post' (length=19)
- 'date' => string '2009-07-01 00:00:00' (length=19)
- 'timestamp' => string '2009-07-02 16:12:30' (length=19)
-
-
-
Eureka! We've managed to extract our data and, more importantly, completely configure a Magento Model.
-
-
Basic Model Operations
-
-
All Magento Models inherit from the Varien_Object class. This class is part of the Magento system library and not part of any Magento core module. You can find this object at
-
-
lib/Varien/Object.php
-
-
Magento Models store their data in a protected _data property. The Varien_Object class gives us several methods we can use to extract this data. You've already seen getData, which will return an array of key/value pairs. This method can also be passed a string key to get a specific field.
-
-
-$model->getData();
-$model->getData('title');
-
-
-
There's also a getOrigData method, which will return the Model data as it was when the object was initially populated, (working with the protected _origData method).
The Varien_Object also implements some special methods via PHP's magic __call method. You can get, set, unset, or check for the existence of any property using a method that begins with the word get, set, unset or has and is followed by the camel cased name of a property.
For this reason, you'll want to name all your database columns with lower case characters and use underscores to separate characters.
-
-
CRUD, the Magento Way
-
-
Magento Models support the basic Create, Read, Update, and Delete functionality of CRUD with load, save, and delete methods. You've already seen the load method in action. When passed a single parameter, the load method will return a record whose id field (set in the Model's resource) matches the passed in value.
-
-
$blogpost->load(1);
-
-
The save method will allow you to both INSERT a new Model into the database, or UPDATE an existing one. Add the following method to your Controller
-
-
-public function createNewPostAction() {
- $blogpost = Mage::getModel('weblog/blogpost');
- $blogpost->setTitle('Code Post!');
- $blogpost->setPost('This post was created from code!');
- $blogpost->save();
- echo 'post with ID ' . $blogpost->getId() . ' created';
-}
-
-
-
and then execute your Controller Action by loading the following URL
-
-
http://example.com/weblog/index/createNewPost
-
-
You should now see an additional saved post in your database table. Next, try the following to edit your post
So, having a single Model is useful, but sometimes we want to grab list of Models. Rather than returning a simple array of Models, each Magento Model type has a unique collection object associated with it. These objects implement the PHP IteratorAggregate and Countable interfaces, which means they can be passed to the count function, and used in for each constructs.
-
-
We'll cover Collections in full in a later article, but for now let's look at basic setup and usage. Add the following action method to your Controller, and load it in your browser.
Warning: include(Magentotutorial/Weblog/Model/Resource/Blogpost/Collection.php) [function.include]: failed to open stream
-
-
You're not surprised, are you? We need to add a PHP class file that defines our Blogpost collection. Every Model has a protected property named _resourceCollectionName that contains a URI that's used to identify our collection.
By default, this is the same URI that's used to identify our Resource Model, with the string "_collection" appended to the end. Magento considers Collections part of the Resource, so this URI is converted into the class name.
Just as with our other classes, we need to init our Collection with the Model URI. (weblog/blogpost). Rerun your Controller Action, and you should see your post information.
-
-
Wrapup
-
-
Congratulations, you've created and configured your first Magento Model. In a later article we'll take a look at Magento's Entity Attribute Value Models (EAV), which expand on what we've learned here.
-
-
\ No newline at end of file
diff --git a/guides/m1x/magefordev/mage-for-dev-6.html b/guides/m1x/magefordev/mage-for-dev-6.html
deleted file mode 100644
index bb1fbea0bb..0000000000
--- a/guides/m1x/magefordev/mage-for-dev-6.html
+++ /dev/null
@@ -1,408 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
- Magento for Developers: Part 6—Magento Setup Resources
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
-
Magento for Developers: Part 6—Magento Setup Resources
On any fast paced software development project, the task of keeping the development and production databases in sync become a sticky wicket. Magento offers a system to create versioned resource migration scripts that can help your team deal with this often contentious part of the development process.
-
-
In the ORM article we created a model for a weblog post. At the time, we ran our CREATE TABLE statements directly against the database. This time, we'll create a Setup Resource for our module that will create the table for us. We'll also create an upgrade script for our module that will update an already installed module. The steps we'll need to take are
-
-
-
Add the Setup Resource to our config
-
Create our resource class file
-
Create our installer script
-
Create our upgrade script
-
-
-
-
Adding the Setup Resource
-
So, let's continue with the weblog module we created last time. In our <global /> section, add the following
The <weblog_setup> tag will be used to uniquely identify this Setup Resource. It's encouraged, but not necessary, that you use the modelname_setup naming convention. The <module>Magentotutorial_Weblog</module> tag block should contain the Packagename_Modulename of your module. Finally, <class>Magentotutorial_Weblog_Model_Resource_Setup</class> should contain the name of the class we'll be creating for our Setup Resource. For basic setup scripts it's not necessary to create a custom class, but by doing it now you'll give yourself more flexibility down the line.
-
-
After adding the above section to your config, clear your Magento cache and try to load any page of your Magento site. You'll see an exception something like
-
-
Fatal error: Class 'Magentotutorial_Weblog_Model_Resource_Setup' not found in
-
-
Magento just tried to instantiate the class you specified in your config, but couldn't find it. You'll want to create the following file, with the following contents.
Now, reload any page of your Magento site. The exception should be gone, and your page should load as expected.
-
-
Creating our Installer Script
-
-
Next, we'll want to create our installer script. This is the script that will contain any CREATE TABLE or other SQL code that needs to be run to initialize our module.
This section is required in all config.xml files, and identifies the module as well as the its version number. Your installer script's name will be based on this version number. The following assumes the current version of your module is 0.1.0.
-
-
Create the following file at the following location
-echo 'Running This Upgrade: '.get_class($this)."\n <br /> \n";
-die("Exit for now");
-
-
-
The weblog_setup portion of the path should match the tag you created in your config.xml file (<weblog_setup />). The 0.1.0 portion of the filename should match the starting version of your module. Clear your Magento cache and reload any page in your Magento site and you should see something like
-
-
-Running This Upgrade: Magentotutorial_Weblog_Model_Resource_Setup
-Exit for now
- ...
-
-
-
Which means your update script ran. Eventually we'll put our SQL update scripts here, but for now we're going to concentrate on the setup mechanism itself. Remove the "die" statement from your script so it looks like the following
-
-
echo 'Running This Upgrade: '.get_class($this)."\n <br /> \n";
-
-
Reload your page. You should see your upgrade message displayed at the top of the page. Reload again, and your page should be displayed as normal.
-
-
Resource Versions
-
-
Magento's Setup Resources allow you to simply drop your install scripts (and upgrade scripts, which we'll get to in a bit) onto the server, and have the system automatically run them. This allows you to have all your database migrations scripts stored in the system in a consistent format.
-
-
Using your favorite database client, take a look at the core_setup table
This table contains a list of all the installed modules, along with the installed version number. You can see our module near the end
-
-
| weblog_setup | 0.1.0 | 0.1.0 |
-
-
This is how Magento knows not to re-run your script on the second, and on all successive, page loads. The weblog_setup is already installed, so it won't be updated. If you want to re-run your installer script (useful when you're developing), just delete the row for your module from this table. Let's do that now, and actually add the SQL to create our table. So first, run the following SQL.
-
-
DELETE from core_resource where code = 'weblog_setup';
-
-
We'll also want to drop the table we manually created in the ORM article.
-
-
DROP TABLE blog_posts;
-
-
Then, add the following code to your setup script.
-
-
$installer = $this;
-$installer->startSetup();
-$installer->run("
- CREATE TABLE `{$installer->getTable('weblog/blogpost')}` (
- `blogpost_id` int(11) NOT NULL auto_increment,
- `title` text,
- `post` text,
- `date` datetime default NULL,
- `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP,
- PRIMARY KEY (`blogpost_id`)
- ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
-
- INSERT INTO `{$installer->getTable('weblog/blogpost')}` VALUES (1,'My New Title','This is a blog post','2009-07-01 00:00:00','2009-07-02 23:12:30');
-");
-$installer->endSetup();
-
-
-
Clear your Magento cache and reload any page in the system. You should have a new blog_posts table with a single row.
-
-
Anatomy of a Setup Script
-
-
So, let's go over the script line-by-line. First, there's this (or is that $this?)
-
-
$installer = $this;
-
-
Each installer script is run from the context of a Setup Resource class, the class you created above. That means any reference to $this from within the script will be a reference to an object instantiated from this class. While not necessary, most setup scripts in the core modules will alias $this to a variable called installer, which is what we've done here. While not necessary, it is the convention and it's always best to follow the convention unless you have a good reason for breaking it.
-
-
Next, you'll see our queries are bookended by the following two method calls.
If you take a look at the Mage_Core_Model_Resource_Setup class in app/code/core/Mage/Core/Model/Resource/Setup.php (which your setup class inherits from) you can see that these methods do some basic SQL setup
-
-
- public function startSetup()
- {
- $this->getConnection()->startSetup()
- return $this;
- }
-
- public function endSetup()
- {
- $this->getConnection()->endSetup();
- return $this;
- }
-
-
-
You can look into Varien_Db_Adapter_Pdo_Mysql in lib/Varien/Db/Adapter/Pdo/Mysql.php to find the real SQL setup executed for MySQL connections in the startSetup() and endSetup() methods.
-
-
Finally, there's the call to the run method
-
-
$installer->run(...);
-
-
which accepts a string containing the SQL needed to setup your database table(s). You may specify any number of queries, separated by a semi-colon. You also probably noticed the following
-
-
$installer->getTable('weblog/blogpost')
-
-
The getTable method allows you to pass in a Magento Model URI and get its table name. While not necessary, using this method ensures that your script will continue to run, even if someone changes the name of their table in the config file. The Mage_Core_Model_Resource_Setup class contains many useful helper methods like this. The best way to become familiar with everything that's possible is to study the installer scripts used by the core Magento modules.
-
-
RDBMS Agnostic Scripts
-
-
Since version 1.6, Magento (in theory) supports more database backends then only MySQL. Since our setup script contains raw SQL statements, it may not run correctly on a different database system, say MSSQL. For that reason the setup script name is prefixt with the string mysql4-
-
-
In order to make setup scripts cross-database compatible, Magento offers a DDL (Data Definition Language) Table object. Here is an alternative version of our setup script that would run on any supported RDBMS.
As you can see, there is no raw SQL in this version of the setup script. So which version should you use? If you want your Modules to run on any RDBMS backend, use the new DDL style upgrade scripts. If you are concerned about backward compatibility, use the raw SQL flavor, that is still supported by Magento 1.6 and 1.7 (and probably will be supported by any 1.x Magento release).
-
-
Module Upgrades
-
-
So, that's how you create a script that will setup your initial database tables, but what if you want to alter the structure of an existing module? Magento's Setup Resources support a simple versioning scheme that will let you automatically run scripts to upgrade your modules.
-
-
Once Magento runs an installer script for a module, it will never run another installer for that module again (short of manually deleting the reference in the core_resource table). Instead, you'll need to create an upgrade script. Upgrade scripts are very similar to installer scripts, with a few key differences.
-
-
To get started, we'll create a script at the following location, with the following contents
-echo 'Testing our upgrade script (upgrade-0.1.0-0.2.0.php) and halting execution to avoid updating the system version number ';
-die();
-
-
-
Upgrade scripts are placed in the same folder as your installer script, but named slightly differently. First, and most obviously, the file name contains the word upgrade. Secondly, you'll notice there are two version numbers, separated by a "-". The first (0.1.0) is the module version that we're upgrading from. The second (0.2.0) is the module version we're upgrading to.
-
-
If we cleared our Magento cache and reloaded a page, our script wouldn't run. We need to update the version number in our module's config.xml file to trigger the upgrade
With the new version number in place, we'll need to clear our Magento cache and load any page in our Magento site. You should now see output from your upgrade script.
-
-
By the way, we also could have names our upgrade script mysql4-upgrade-0.1.0-0.2.0.php. This would indicate our upgrade would contain MySQL specific SQL.
-
-
Before we continue and actually implement the upgrade script, there's one important piece of behavior you'll want to be aware of. Create another upgrade file at the following location with the following contents.
-echo 'Testing our upgrade script (upgrade-0.1.0-0.1.5.php) and NOT halting execution <br />';
-
-
-
If you reload a page, you'll notice you see BOTH messages. When Magento notices the version number of a module has changed, it will run through all the setup scripts needed to bring that version up to date. Although we never really created a version 0.1.5 of the Weblog module, Magento sees the upgrade script, and will attempt to run it. Scripts will be run in order from lowest to highest. If you take a peek at the core_resource table,
-
-
mysql> select * from core_resource where code = 'weblog_setup';
-+--------------+---------+--------------+
-| code | version | data_version |
-+--------------+---------+--------------+
-| weblog_setup | 0.1.5 | 0.1.5 |
-+--------------+---------+--------------+
-1 row in set (0.00 sec)
-
-
-
you'll notice Magento considers the version number to be 1.5. That's because we completed executing the 1.0 to 1.5 upgrade, but did not complete execution of the 1.0 to 2.0 upgrade.
-
-
So, with all that out of the way, writing our actual upgrade script is identical to writing an installer script. Let's change the 0.1.0-0.2.0 script to read
-
-
-$installer = $this;
-$installer->startSetup();
-$installer->getConnection()
- ->changeColumn($installer->getTable('weblog/blogpost'), 'post', 'post', array(
- 'type' => Varien_Db_Ddl_Table::TYPE_TEXT,
- 'nullable' => false,
- 'comment' => 'Blogpost Body'
- )
-);
-$installer->endSetup();
-die("You'll see why this is here in a second");
-
-
-
Try refreshing a page in your Magento site and ... nothing. The upgrade script didn't run. The post field in our table still allows null values, and more importantly, the call to die() did not halt execution. Here's what happened
-
-
-
The weblog_setup resource was at version 0.1.0
-
We upgraded our module to version 0.2.0
-
Magento saw the upgraded module, and saw there were two upgrade scripts to run; 0.1.0 to 0.1.5 and 0.1.0 to 0.2.0
-
Magento queued up both scripts to run
-
Magento ran the 0.1.0 to 0.1.5 script
-
The weblog_setup resource is now at version 0.1.5
-
Magento ran the 0.1.0 to 0.2.0 script, execution was halted
-
On the next page load, Magento saw weblog_setup at version 0.1.5 and did not see any upgrade scripts to run since both scripts indicated they should be run from0.1.0
-
-
-
The correct way to achieve what we wanted would have been to name our scripts as follows
-
-
upgrade-0.1.0-0.1.5.php #This goes from 0.1.0 to 0.1.5
-upgrade-0.1.5-0.2.0.php #This goes 0.1.5 to 0.2.0
-
-
Magento is smart enough to run both scripts on a single page load. You can go back in time and give this a try by updating the core_resource table
-
-
UPDATE core_resource SET version = '0.1.0', data_version = '0.1.0' WHERE code = 'weblog_setup';
-...
-
-
It's one of the odd quirks of the Magento system that the updates will run as previously configured. This means you'll want to be careful with multiple developers adding update scripts to the system. You'll either want a build-meister/deployment-manager type in charge of the upgrade scripts or (heaven forbid) developers will need to talk to one another.
-
-
Wrap-up
-
-
You should now know the basics of how to use Magento Setup Resources to create versioned database migration scripts, as well as understand the scripts provided in the core modules. Beyond having a standard way for developers to write migration scripts, Setup Resources become much more important when creating and modifying Entity Attribute Value models.
In the first ORM article we told you there were two kinds of Models in Magento. Regular, or "simple" Models, and Entity Attribute Value (or EAV) Models. We also told you this was a bit of a fib. Here's where we come clean.
-
-
ALL Magento Models interacting with the database inherit from the Mage_Core_Model_Abstract / Varien_Object chain. What makes something either a simple Model or an EAV Model is its Model Resource. While all resources extend the base Mage_Core_Model_Resource_Abstract class, simple Models have a resource that inherits from Mage_Core_Model_Resource_Db_Abstract, and EAV Models have a resource that inherits from Mage_Eav_Model_Entity_Abstract
-
-
If you think about it, this makes sense. As the end-programmer-user of the system you want a set of methods you can use to talk to and manipulate your Models. You don't care what the backend storage looks like, you just want to get properties and invoke methods that trigger business rules.
Entity-Attribute-Value model (EAV), also known as object-attribute-value model and open schema is a data model that is used in circumstances where the number of attributes (properties, parameters) that can be used to describe a thing (an "entity" or "object") is potentially very vast, but the number that will actually apply to a given entity is relatively modest. In mathematics, this model is known as a sparse matrix.
-
-
Another metaphor that helps me wrap my head around it is "EAV brings some aspects of normalization to the database table schema". In a traditional database, tables have a fixed number of columns
Every product has a name, every product has a price, etc.
-
-
In an EAV Model, each "entity" (product) being modeled has a different set of attributes. EAV makes a lot of sense for a generic eCommerce solution. A store that sells laptops (which have a CPU speed, color, ram amount, etc) is going to have a different set of needs than a store that sells yarn (yarn has a color, but no CPU speed, etc.). Even within our hypothetical yarn store, some products will have length (balls of yarn), and others will have diameter (knitting needles).
-
-
There aren't many open source or commercial databases that use EAV by default. There are none that are available on a wide variety of web hosting platforms. Because of that, the Magento engineers have built an EAV system out of PHP objects that use MySQL as a data-store. In other words, they've built an EAV database system on top of a traditional relational database.
-
-
In practice this means any Model that uses an EAV resource has its attributes spread out over a number of MySQL tables.
-
-
-
The above diagram is a rough layout of the database tables Magento consults when it looks up an EAV record for the catalog_product entity. Each individual product has a row in catalog_product_entity. All the available attributes in the entire system (not just for products) are stored in eav_attribute, and the actual attribute values are stored in tables with names like catalog_product_entity_varchar, catalog_product_entity_decimal, catalog_product_entity_etc..
-
-
Beyond the mental flexibility an EAV system gives you, there's also the practical benefit of avoiding ALTER TABLE statements. When you add a new attribute for your products, a new row is inserted into eav_attribute. In a traditional relational database/single-table system, you'd need to ALTER the actual database structure, which can be a time consuming/risky proposition for tables with large data-sets.
-
-
The downside is there's no one single simple SQL query you can use to get at all your product data. Several single SQL queries or one large join need to be made.
-
-
Implementing EAV
-
-
That's EAV in a nutshell. The rest of this articles is a run-through of what's needed to create a new EAV Model in Magento. It's the hairiest thing you'll read about Magento and it's something that 95% of people working with the system will never need to do. However, understanding what it takes to build an EAV Model Resource will help you understand what's going on with the EAV Resources that Magento uses.
-
-
Because the EAV information is so dense, we're going to assume you're already very familiar with Magento's MVC and grouped class name features. We'll help you along the way, but training wheels are off.
-
-
Weblog, EAV Style
-
-
We're going to create another Model for a weblog post, but this time using an EAV Resource. To start with, setup and create a new module which responds at the following URL
-
-
http://example.com/complexworld
-
-
If you're unsure how to do this, be sure you've mastered the concepts in the previous tutorials.
-
-
Next, we'll create a new Model named Weblogeav. Remember, it's the Resource that's considered EAV. We design and configure our Model the exact same way, so let's configure a Model similar to one we created in the first ORM article.
You'll notice so far there is no difference to setting up a regular Model and flat table resource Model.
-
-
We'll still need to let Magento know about this resource. Similar to basic Models, EAV Resources are configured in the same <model/> node with everything else.
Again, so far this is setup similar to our regular Model Resource. We provide a <class/> that configures a PHP class, as well as an <entities/> section that will let Magento know the base table for an individual Model we want to create. The <eavblogpost/> tag is the name of the specific Model we want to create, and its inner <table/> tag specifies the base table this Model will use (more on this later).
-
-
Where Does That File Go?
-
-
Until wide adoption of PHP 5.3 and namespaces, one of the trickier (and tedious) parts of Magento will remain remembering how <classname/>s relate to file paths, and then ensuring you create the correctly named directory structure and class files. After configuring any <classname/>s or URIs, you may find it useful to attempt to instantiate an instance of the class in a controller without first creating the class files. This way PHP will throw an exception telling me it can't find a file, along with the file location. Give the following a try in your Index Controller.
-Warning: include(Magentotutorial/Complexworld/Model/Eavblogpost.php) [function.include]:
-failed to open stream: No such file or directory in /Users/username/Sites/magento.dev/lib/Varien/Autoload.php on line 93
-
-
-
In addition to telling us the path where we'll need to define the new resource class this also serves as a configuration check. If we'd been warned with the following
-
-
-Warning: include(Mage/Complexworld/Model/Eavblogpost.php) [function.include]:
-failed to open stream: No such file or directory in /Users/username/Sites/magento.dev/lib/Varien/Autoload.php on line 93
-
-
-
we'd know our Model was misconfigured, as Magento was looking for the Model in code/core/Mage instead of code/local/Magentotutorial.
Remember, the Model itself is resource independent. A regular Model and an EAV Model both extend from the same class. It's the resource that makes them different.
-
-
Clear your Magento cache, reload your page, and you should see a new warning.
So, already we're seeing a few differences between a simple Model Resource and an EAV Model Resource. First off, we're extending the Mage_Eav_Model_Entity_Abstract class. While Mage_Eav_Model_Entity_Abstract uses the same _construct concept as a regular Model Resource, there's no _init method. Instead, we need to handle the init ourselves. This means telling the resource what connection-resources it should use, and passing a unique identifier into the setType method of our object.
-
-
Another difference in Mage_Eav_Model_Entity_Abstract is _construct is not an abstract method, primarily for reasons of backwards compatibility with older versions of the system.
-
-
So, with that, let's clear the Magento cache and reload the page. You should see a new exception which reads
Magento is complaining that it can't find a entity_type named complexworld_eavblogpost. This is the value you set above
-
-
$this->setType('complexworld_eavblogpost');
-
-
Every entity has a type. Types will, among other things, let the EAV system know which attributes a Model uses, and allow the system to link to tables that store the values for attributes. We'll need to let Magento know that we're adding a new entity type. Take a look in the MySQL table named eav_entity_type.
This table contains a list of all the entity_types in the system. The unique identifier complexworld_eavblogpost corresponds to the entity_type_code column.
-
-
Systems and Applications
-
-
This illustrates the single most important Magento concept, one that many people struggle to learn.
-
-
Consider the computer in front of you. The OS (Mac OS X, Windows, Linux, etc.) is the software system. Your web browser (Firefox, Safari, IE, Opera) is the application. Magento is a system first, and an application second. You build eCommerce applications using the Magento system. What gets confusing is, there's a lot of places in Magento where the system code is exposed in a really raw form to the application code. The EAV system configuration living in the same database as your store's data is an example of this.
-
-
If you're going to get deep into Magento, you need to treat it like it's an old Type 650 machine. That is to say, it's the kind of thing you can't effectively program applications in unless unless you have a deep understanding of the system itself.
-
-
Creating a Setup Resource
-
-
So, it's theoretically possible to manually insert the rows you'll need into the Magento database to get your Model working, but it's not recommended. Fortunately, Magento provides a specialized Setup Resource that provides a number of helper method that will automatically create the needed records to get the system up and running.
-
-
So, for starters, configure the Setup Resource like you would any other.
Take note that we're extending from Mage_Eav_Model_Entity_Setup rather than Mage_Core_Model_Resource_Setup.
-
-
Finally, we'll set up our installer script. If you're not familiar with the naming conventions here, you'll want to review the setup resource tutorial on Setup Resources.
-<?php
-$installer = $this;
-throw new Exception("This is an exception to stop the installer from completing");
-
-
-
Clear your Magento Cache, reload you page, and the above exception should be thrown, meaning you've correctly configured your Setup Resource.
-
-
NOTE: We'll be building up our install script piece by piece. If you've read the previous tutorial, you'll know you need to remove the setup's row from the core_resource table and clear your cache to make an installer script re-run. For the remainder of this tutorial, please remember that anytime we add or remove an item from our installer and re-run it, you'll need to remove this row from the database and clear your Magento cache. Normally you would create this file and run it once, a tutorial is something of an edge case.
-
-
Adding the Entity Type
-
-
To begin, add the following to your Setup Resource installer script, and then run the script by loading any page (after removing the above exception)
-
-
-$installer = $this;
-$installer->startSetup();
-$installer->addEntityType('complexworld_eavblogpost', array(
- //entity_mode is the URI you'd pass into a Mage::getModel() call
- 'entity_model' => 'complexworld/eavblogpost',
-
- //table refers to the resource URI complexworld/eavblogpost
- //<complexworld_resource>...<eavblogpost><table>eavblog_posts</table>
- 'table' =>'complexworld/eavblogpost',
-));
-$installer->endSetup();
-
-
-
We're calling the addEntityType method on our installer object. This method allows us to pass in the entity type (complexworld_eavblogpost) along with a list of parameters to set its default values. If you've run this script, you'll notice new rows in the eav_attribute_group, eav_attribute_set, and eav_entity_type tables.
-
-
So, with that in place, if we reload our complexworld page, we'll get a new error.
-
-
SQLSTATE[42S02]: Base table or view not found: 1146 Table 'magento.eavblog_posts' doesn't exist
-
-
Creating the Data Tables
-
-
So, we've told Magento about our new entity type. Next, we need to add the MySQL tables that will be used to store all the entity values, as well as configure the system so it knows about these tables.
-
-
Our EAV Setup Resource has a method named createEntityTables which will automatically setup the tables we need, as well as add some configuration rows to the system. Let's add the following line to our setup resource.
The createEntityTables method accepts two parameters. The first is the base table name, the second is a list of options. We're using the Setup Resource's getTable method to pull the table name from our config. If you've been following along, you know this should resolve to the string eavblog_posts. We've omitted the second parameter which is an array of options you'll only need to used it for advanced situations that are beyond the scope of this tutorial.
-
-
After running the above script, you should have the following new tables in your database
You'll also have an additional row in the eav_attribute_set table
-
-
mysql> select * from eav_attribute_set order by attribute_set_id DESC LIMIT 1 \G
-*************************** 1. row ***************************
- attribute_set_id: 65
- entity_type_id: 37
-attribute_set_name: Default
- sort_order: 6
-
-
-
So, let's go back to our page and reload.
-
-
http://example.com/complexworld
-
-
Success! You should see no errors or warnings, and a dumped Magentotutorial_Complexworld_Model_Eavblogpost --- with no data.
-
-
Adding Attributes
-
-
The last step we need to take in our Setup Resource is telling Magento what attributes we want our EAV Model to have. This would be equivalent to adding new columns in a single database table setup. Again, the Setup Resource will help us. The method we're interested in is addAttribute.
-
-
The code from the previous section was simply telling Magento about a type of entity that we add to the system. These next bits of code are what will actually add possible attributes for our new type to the system.
-
-
We do that with the method addAttribute. When we call addAttribute, Magento will need to do several things to install your entities.
-
-
To start with, we'll give our Eavblogpost a single attribute named title.
All right, that's a small pile of code. Let's break it apart.
-
-
The first argument to addAttribute is the entity type code. It has to match the code specified when calling addEntityType. It tells Magento which entity we are adding the attribute to, in our example it is our complexworld_eavblogpost entity. To see other available entities that come shipped with Magento, remember you can look into the eav_entity_type table at the entity_type_code column.
-
-
The second argument to addAttribute is the attribute code. It has to be unique within the given entity.
-
-
The third argument is where it get real interesting. This is an array of key value pairs, describing the attribute properties. For the sake of simplicity we've chose to define a single attribute, but you could go on to define as many as you'd like, by adding additional addAttribute calls to the setup script.
-
-
Array of Key Value Pairs that Define the Attribute
-
-
Finally, we have a long list of attribute properties.
Most of these define how Magento would build a backend form element for this attribute, and probably you'll won't have to deal with the,. That said, the one important property you'll want to make note of is
-
-'type' => 'varchar'
-
-
-
This defines the type of the value that the attribute will contain. You'll recall that we added table for each attribute type
While these do not refer to the MySQL column types, (but instead the EAV attribute types), their names (varchar, datetime, etc.) are indicative of the values they'll hold.
-
-
All of these attribute properties are optional, if we wouldn't have specified them, Magento would have used a default value. These default values are defined in the _prepareValues method of the Mage_Eav_Model_Entity_Setup class (inherited by our setup class).
The second argument to the method calls to _getValue is the array key from our addAttribute argument array, and the third is the default value. So by default Magento would assume you are adding a varchar attribute with a text input.
-
-
Adding the other attributes
-
-
Lets add attributes for the blog post content and the post date. This is what the complete install script looks like.
So, now that we have everything in place, lets refresh things one last time to run our installer script. After calling addAttribute, we should have
-
-
-
A new row in eav_entity_type for the complexworld_eavblogpost entity type
-
A new row in eav_attribute for the title attribute
-
A new row in eav_attribute for the content attribute
-
A new row in eav_attribute for the date attribute
-
A new row in eav_entity_attribute
-
-
-
Tying it all Together
-
-
This is clearly the lamest.blogmodel.ever, but lets try adding some rows and iterating through a collection and get the heck out of here before our heads explode. Add the following two actions to your Index Controller.
as well as 10 new rows in the eavblog_posts_varchar table.
-
-
-mysql> SELECT * FROM eavblog_posts_varchar ORDER BY value_id DESC;
-+----------+----------------+--------------+----------+-----------+------------------+
-| value_id | entity_type_id | attribute_id | store_id | entity_id | value |
-+----------+----------------+--------------+----------+-----------+------------------+
-| 10 | 31 | 933 | 0 | 10 | This is a test 9 |
-| 9 | 31 | 933 | 0 | 9 | This is a test 8 |
-| 8 | 31 | 933 | 0 | 8 | This is a test 7 |
-| 7 | 31 | 933 | 0 | 7 | This is a test 6 |
-| 6 | 31 | 933 | 0 | 6 | This is a test 5 |
-| 5 | 31 | 933 | 0 | 5 | This is a test 4 |
-| 4 | 31 | 933 | 0 | 4 | This is a test 3 |
-| 3 | 31 | 933 | 0 | 3 | This is a test 2 |
-| 2 | 31 | 933 | 0 | 2 | This is a test 1 |
-| 1 | 31 | 933 | 0 | 1 | This is a test 0 |
-+----------+----------------+--------------+----------+-----------+------------------+
-
-
-
Notice that eavblog_posts_varchar is linked to eavblog_posts by the entity_id column.
-
-
Finally, let's pull our Models back out. Load the following URL in your browser
Warning: include(Magentotutorial/Complexworld/Model/Resource/Eavblogpost/Collection.php) [function.include]:
- failed to open stream: No such file or directory in /Users/username/Sites/magento.dev/lib/Varien/Autoload.php on line 93
-
-
So Close! We didn't make a class for our collection object! Fortunately, doing so is just as easy as with a regular Model Resource. Add the following file with the following contents
This is just a standard Magento _construct method to initialize the Model. With this in place, reload the page, and we'll see all the titles and the content outputted. But notice, the date value is missing!
-
-
Which Attributes?
-
-
Those of you with sharp eyes may have noticed something slightly different about the collection loading.
Because querying for EAV data can be SQL intensive, you'll need to specify which attributes it is you want your Models to fetch for you. This way the system can make only the queries it needs. If you're willing to suffer the performance consequences, you can use a wild card to grab all the attributes
So, that should give you enough information to be dangerous, or at least enough information so you're not drowning the next time you're trying to figure out why the yellow shirts aren't showing up in your store. There's still plenty to learn about EAV; here's a few topics I would have liked to cover in greater detail, and may talk about in future articles
-
-
-
EAV Attributes: Attributes aren't limited to datetime, decimal, int, text and varchar. You can create your own class files to model different attributes. This is what the attribute_model entity property is for.
-
Collection Filtering: Filtering on EAV collections can get tricky, especially when you're dealing with the above mentioned non-simple attributes. You need to use the addAttributeToFilter method on your collection before loading.
-
The Magento EAV Hierarchy: Magento has taken their basic EAV Model and built up a hierarchy that's very tied to store functionality, as well as including strategies to reduce the number of queries an EAV Model generates (the concept of a flat Model, for example)
-
-
-
EAV Models are, without a doubt, the most complicated part of the Magento system that an ecommerce web developer will need to deal with. Remember to take deep breaths and that, at the end of the day, its just programming. Everything happens for a concrete reason, you just need to figure out why.
\ No newline at end of file
diff --git a/guides/m1x/magefordev/mage-for-dev-8.html b/guides/m1x/magefordev/mage-for-dev-8.html
deleted file mode 100644
index 130f445977..0000000000
--- a/guides/m1x/magefordev/mage-for-dev-8.html
+++ /dev/null
@@ -1,524 +0,0 @@
----
----
-
-
-
-
-
-
-
-
-
-
- Magento for Developers: Part 8—Varien Data Collections
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
-
Magento for Developers: Part 8—Varien Data Collections
Originally, as a PHP programmer, if you wanted to collect together a group of related variables you had one choice, the venerable Array. While it shares a name with C's array of memory addresses, a PHP array is a general purpose dictionary like object combined with the behaviors of a numerically indexed mutable array.
-
-
In other languages the choice isn't so simple. You have multiple data structures to chose from, each offering particular advantages in storage, speed and semantics. The PHP philosophy was to remove this choice from the client programmer and give them one useful data structure that was "good enough".
-
-
All of this is galling to a certain type of software developer, and PHP 5 set out to change the status quo by offering built-in classes and interfaces that allow you to create your own data structures.
-
-
-$array = new ArrayObject();
-class MyCollection extends ArrayObject{...}
-$collection = new MyCollection();
-$collection[] = 'bar';
-
-
-
While this is still galling to a certain type of software developer, as you don't have access to low level implementation details, you do have the ability to create array-like Objects with methods that encapsulate specific functionality. You can also setup rules to offer a level of type safety by only allowing certain kinds of Objects into your Collection.
-
-
It should come as no surprise that Magento offers you a number of these Collections. In fact, every Model object that follows the Magento interfaces gets a Collection type for free. Understanding how these Collections work is a key part to being an effective Magento programmer. We're going to take a look at Magento Collections, starting from the bottom and working our way up. Set up a controller action where you can run arbitrary code, and let's get started.
-
-
A Collection of Things
-
-
First, we're going to create a few new Objects.
-
-
-$thing_1 = new Varien_Object();
-$thing_1->setName('Richard');
-$thing_1->setAge(24);
-
-$thing_2 = new Varien_Object();
-$thing_2->setName('Jane');
-$thing_2->setAge(12);
-
-$thing_3 = new Varien_Object();
-$thing_3->setName('Spot');
-$thing_3->setLastName('The Dog');
-$thing_3->setAge(7);
-
-
-
The Varien_Object class defines the object all Magento Models inherit from. This is a common pattern in object oriented systems, and ensures you'll always have a way to easily add methods/functionally to every object in your system without having to edit every class file.
-
-
Any Object that extends from Varien_Object has magic getter and setters that can be used to set data properties. Give this a try
-
-
var_dump($thing_1->getName());
-
-
If you don't know what the property name you're after is, you can pull out all the data as an array
-
-
var_dump($thing_3->getData());
-
-
The above will give you an array something like
-
-
-
-array
-'name' => string 'Spot' (length=4)
-'last_name' => string 'The Dog' (length=7)
-'age' => int 7
-
-
-
Notice the property named "last_name"? If there's an underscore separated property, you camel case it if you want to use the getter and setter magic.
-
-
$thing_1->setLastName('Smith');
-
-
The ability to do these kinds of things is part of the power of PHP5, and the development style a certain class of people mean when they say "Object Oriented Programming".
-
-
So, now that we have some Objects, let's add them to a Collection. Remember, a Collection is like an Array, but is defined by a PHP programmer.
The Varien_Data_Collection is the Collection that most Magento data Collections inherit from. Any method you can call on a Varien_Data_Collection you can call on Collections higher up the chain (We'll see more of this later)
-
-
What can we do with a Collection? For one, with can use foreach to iterate over it
-
-
-foreach($collection_of_things as $thing)
-{
- var_dump($thing->getData());
-}
-
-
-
There are also shortcuts for pulling out the first and last items
So, this is an interesting exercise, but why do we care?
-
-
We care because all of Magento's built in data Collections inherit from this object. That means if you have, say, a product Collection you can do the same sort of things. Let's take a look
Most Magento Model objects have a method named getCollection which will return a collection that, by default, is initialized to return every Object of that type in the system.
-
-
A Quick Note: Magento's Data Collections contain a lot of complicated logic that handles when to use an index or cache, as well as the logic for the EAV entity system. Successive method calls to the same Collection over its life can often result in unexpected behavior. Because of that, all the of the following examples are wrapped in a single method action. I'd recommend doing the same while you're experimenting. Also, XDebug'svar_dump is a godsend when working with Magento Objects and Collections, as it will (usually) intelligently short circuit showing hugely recursive Objects, but still display a useful representation of the Object structure to you.
-
-
The products Collection, as well as many other Magento Collections, also have the Varien_Data_Collection_Db class in their ancestor chain. This gives us a lot of useful methods. For example, if you want to see the select statement your Collection is using
-
-
-public function testAction()
-{
- $collection_of_products = Mage::getModel('catalog/product')->getCollection();
- var_dump($collection_of_products->getSelect()); //might cause a segmentation fault
-}
-
Whoops! Since Magento is using the Zend database abstraction layer, your Select is also an Object. Let's see that as a more useful string.
-
-
-public function testAction()
-{
- $collection_of_products = Mage::getModel('catalog/product')->getCollection();
- //var_dump($collection_of_products->getSelect()); //might cause a segmentation fault
- var_dump(
- (string) $collection_of_products->getSelect()
- );
-}
-
-
-
Sometimes this is going to result in a simple select
-
-
'SELECT `e`.* FROM `catalog_product_entity` AS `e`'
-
-
Other times, something a bit more complex
-
-
-string 'SELECT `e`.*, `price_index`.`price`, `price_index`.`final_price`, IF(`price_index`.`tier_price`,
-LEAST(`price_index`.`min_price`, `price_index`.`tier_price`), `price_index`.`min_price`) AS `minimal_price`,
-`price_index`.`min_price`, `price_index`.`max_price`, `price_index`.`tier_price` FROM `catalog_product_entity`
-AS `e` INNER JOIN `catalog_product_index_price` AS `price_index` ON price_index.entity_id = e.entity_id AND
-price_index.website_id = '1' AND price_index.customer_group_id = 0'
-
-
-
The discrepancy depends on which attributes you're selecting, as well as the aforementioned indexing and cache. If you've been following along with the other articles in this series, you know that many Magento models (including the Product Model) use an EAV system. By default, a EAV Collection will not include all of an Object's attributes. You can add them all by using the addAttributeToSelect method
-
-
-$collection_of_products = Mage::getModel('catalog/product')
- ->getCollection()
- ->addAttributeToSelect('*'); //the asterisk is like a SQL SELECT * FROM ...
-
-
-
Or, you can add just one
-
-
-//or just one
-$collection_of_products = Mage::getModel('catalog/product')
- ->getCollection()
- ->addAttributeToSelect('meta_title');
-
-
-
or chain together several
-
-
-//or just one
-$collection_of_products = Mage::getModel('catalog/product')
- ->getCollection()
- ->addAttributeToSelect('meta_title')
- ->addAttributeToSelect('price');
-
-
-
Lazy Loading
-
-
One thing that will trip up PHP developers new to Magento's ORM system is when Magento makes its database calls. When you're writing literal SQL, or even when you're using a basic ORM system, SQL calls are often made immediately when instantiating an Object.
-
-
-$model = new Customer();
-//SQL Calls being made to Populate the Object
-echo 'Done'; //execution continues
-
-
-
Magento doesn't work that way. Instead, the concept of Lazy Loading is used. In simplified terms, Lazy loading means that no SQL calls are made until the client-programmer needs to access the data. That means when you do something something like this
and not have to worry that Magento is making a database query each time a new attribute is added. The database query will not be made until you attempt to access an item in the Collection.
-
-
In general, try not to worry too much about the implementation details in your day to day work. It's good to know that there's s SQL backend and Magento is doing SQLy things, but when you're coding up a feature try to forget about it, and just treat the objects as block boxes that do what you need.
-
-
Filtering Database Collections
-
-
The most important method on a database Collection is addFieldToFilter. This adds your WHERE clauses to the SQL query being used behind the scenes. Consider this bit of code, run against the sample data database (substitute your own SKU is you're using a different set of product data)
-
-
-public function testAction()
-{
- $collection_of_products = Mage::getModel('catalog/product')
- ->getCollection();
- $collection_of_products->addFieldToFilter('sku','n2610');
-
- //another neat thing about collections is you can pass them into the count //function. More PHP5 powered goodness
- echo "Our collection now has " . count($collection_of_products) . ' item(s)';
- var_dump($collection_of_products->getFirstItem()->getData());
-}
-
-
-
The first parameter of addFieldToFilter is the attribute you wish to filter by. The second is the value you're looking for. Here's we're adding a sku filter for the value n2610.
-
-
The second parameter can also be used to specify the type of filtering you want to do. This is where things get a little complicated, and worth going into with a little more depth.
-SELECT `e`.*, IF(_table_meta_title.value_id>0, _table_meta_title.value, _table_meta_title_default.value) AS `meta_title`
-FROM `catalog_product_entity` AS `e`
-INNER JOIN `catalog_product_entity_varchar` AS `_table_meta_title_default`
- ON (_table_meta_title_default.entity_id = e.entity_id) AND (_table_meta_title_default.attribute_id='103')
- AND _table_meta_title_default.store_id=0
-LEFT JOIN `catalog_product_entity_varchar` AS `_table_meta_title`
- ON (_table_meta_title.entity_id = e.entity_id) AND (_table_meta_title.attribute_id='103')
- AND (_table_meta_title.store_id='1')
-WHERE (IF(_table_meta_title.value_id>0, _table_meta_title.value, _table_meta_title_default.value) = 'my title')
-
-
-
Not to belabor the point, but try not to think too much about the SQL if you're on deadline.
-
-
Other Comparison Operators
-
-
I'm sure you're wondering "what if I want something other than an equals by query"? Not equal, greater than, less than, etc. The addFieldToFilter method's second parameter has you covered there as well. It supports an alternate syntax where, instead of passing in a string, you pass in a single element Array.
-
-
The key of this array is the type of comparison you want to make. The value associated with that key is the value you want to filter by. Let's redo the above filter, but with this explicit syntax
As you can see, the second parameter is a PHP Array. Its key is eq, which stands for equals. The value for this key is n2610, which is the value we're filtering on.
-
-
Magento has a number of these english language like filters that will bring a tear of remembrance (and perhaps pain) to any old perl developers in the audience.
-
-
Listed below are all the filters, along with an example of their SQL equivalents.
-
-
-array("eq"=>'n2610')
-WHERE (e.sku = 'n2610')
-
-array("neq"=>'n2610')
-WHERE (e.sku != 'n2610')
-
-array("like"=>'n2610')
-WHERE (e.sku like 'n2610')
-
-array("nlike"=>'n2610')
-WHERE (e.sku not like 'n2610')
-
-array("is"=>'n2610')
-WHERE (e.sku is 'n2610')
-
-array("in"=>array('n2610'))
-WHERE (e.sku in ('n2610'))
-
-array("nin"=>array('n2610'))
-WHERE (e.sku not in ('n2610'))
-
-array("notnull"=>true)
-WHERE (e.sku is NOT NULL)
-
-array("null"=>true)
-WHERE (e.sku is NULL)
-
-array("gt"=>'n2610')
-WHERE (e.sku > 'n2610')
-
-array("lt"=>'n2610')
-WHERE (e.sku < 'n2610')
-
-array("gteq"=>'n2610')
-WHERE (e.sku >= 'n2610')
-
-array("moreq"=>'n2610') //a weird, second way to do greater than equal (Doesn't work on > 1.8 CE EDITION do the same as eq)
-WHERE (e.sku >= 'n2610')
-
-array("lteq"=>'n2610')
-WHERE (e.sku <= 'n2610')
-
-array("finset"=>array('n2610'))
-WHERE (find_in_set('n2610',e.sku))
-
-array('from'=>'10','to'=>'20')
-WHERE e.sku >= '10' and e.sku <= '20'
-
-
-
Most of these are self explanatory, but a few deserve a special callout
-
-
in, nin, find_in_set
-
-
The in, nin and finset conditionals allow you to pass in an Array of values. That is, the value portion of your filter array is itself allowed to be an array.
-
-
-array("in"=>array('n2610','ABC123')
-WHERE (e.sku in ('n2610','ABC123'))
-
-
-
notnull, null
-
-
The keyword NULL is special in most flavors of SQL. It typically won't play nice with the standard equality (=) operator. Specifying notnull or null as your filter type will get you the correct syntax for a NULL comparison while ignoring whatever value you pass in
-
-
-array("notnull"=>true)
-WHERE (e.sku is NOT NULL)
-
-
-
from - to filter
-
This is another special format that breaks the standard rule. Instead of a single element array, you specify a two element array. One element has the key from, the other element has the key to. As the keys indicated, this filter allows you to construct a from/to range without having to worry about greater than and less than symbols
WHERE (_table_price.value >= '10' and _table_price.value <= '20')'
-
-
AND or OR, or is that OR and AND?
-
-
Finally, we come to the boolean operators. It's the rare moment where we're only filtering by one attribute. Fortunately, Magento's Collections have us covered. You can chain together multiple calls to addFieldToFilter to get a number of "AND" queries.
By chaining together multiple calls as above, we'll produce a where clause that looks something like the following
-
-
WHERE (e.sku like 'a%') AND (e.sku like 'b%')
-
-
To those of you that just raised your hand, yes, the above example would always return 0 records. No sku can begin with BOTH an a and a b. What we probably want here is an OR query. This brings us to another confusing aspect of addFieldToFilter's second parameter.
-
-
If you want to build an OR query, you need to pass an Array of filter Arrays in as the second parameter. I find it's best to assign your individual filter Arrays to variables
In the interest of being explicit, here's the aforementioned array of filter arrays.
-
array($filter_a, $filter_b)
-
-
This will gives us a WHERE clause that looks something like the following
-
-
WHERE (((e.sku like 'a%') or (e.sku like 'b%')))
-
-
Wrap Up
-
-
You're now a Magento developer walking around with some serious firepower. Without having to write a single line of SQL you now know how to query Magento for any Model your store or application might need.
diff --git a/guides/m1x/other/appsec-900_addhandler.html b/guides/m1x/other/appsec-900_addhandler.html
deleted file mode 100644
index 0bbc88c618..0000000000
--- a/guides/m1x/other/appsec-900_addhandler.html
+++ /dev/null
@@ -1,98 +0,0 @@
----
-title: 'Discover credit card validation issue: Magento EE 1.9.1.1—.13.1.0 and CE 1.4.2.0—1.8.1.0'
-layout: m1x
----
-
-
Enable an attacker to execute arbitrary code on your Magento server.
-
Create files with a .csv extension, create writable directories, and change the permission of existing files to world-writable (777).
-
-
-
Note: The preceding exploits require the attacker to have administrative access to your Magento Admin Panel Dashboard. You can resolve these issues with the patch discussed in this article.
-
-
Creating files with a .csv extension can lead to executing files like php.csv (only under circumstances discussed in this article). The ability to run code with a .csv extension is dangerous itself and could be combined with other attacks; for example, targeting other software installed on the server.
Although Magento code is protected by a hash value, the possibility of a successful exploit cannot be eliminated because of the low entropy of the hash secret value.
-
We strongly recommend you to take precautions discussed in this article and apply a patch for your version of Magento Enterprise Edition or Community Edition.
-
-
Versions Affected
-
Magento software versions affected: The issue affects all shipping versions of Magento Community Edition (CE) and Enterprise Edition (EE).
-
Operating system versions affected:
-
CentOS 5.x and 6.x
-
RedHat Enterprise Linux 5.x and 6.x
-
-
Getting the Patch
-
The following table shows the patch you should get for your version of CE or EE.
Important: After applying your patch, Magento strongly recommends you evaluate your vulnerability and configure PHP as discussed in Resolving the Vulnerability
-
-
-
Determining Your Vulnerability to the File System Attack
-
To determine if you're vulnerable to execution of PHP code with a non-PHP extension, search your web server configuration file for the following string:
-
AddHandler application/x-httpd-php .php
-
The Apache configuration file is typically /etc/httpd/conf/httpd.conf
-
To confirm you're vulnerable:
-
Create a file named test.php.csv anywhere in your web server's doocroot with the following contents:
-
<?php
-phpinfo()
-
In a web browser, display that page. (For example, http://www.example.com/path/test.php.csv
-
If your browser saves the file or prompts you to save the file instead of displaying it, your server is not vulnerable. You can ignore the rest of this article.
-
If a page similar to the following displays, your server is vulnerable. Continue with the next section.
-
-
-
Resolving the File System Vulnerability
-
Important: Magento strongly recommends you perform all tasks discussed in this section in a development or testing environment and not in a production environment.
-
To resolve this vulnerability, you must log in to the Magento server as a user with root privileges or as a user with permissions to change the web server configuration.
-
To resolve the vulnerability:
-
Comment out the directive in httpd.conf by preceding it with a pound sign (#) as follows:
-
- The regular expression in this setting matches .php only to the final extension in the file name, applying the handler only to PHP files and preventing PHP from executing.
-
diff --git a/guides/m1x/other/discover-card-validation.html b/guides/m1x/other/discover-card-validation.html
deleted file mode 100644
index 07931b4e37..0000000000
--- a/guides/m1x/other/discover-card-validation.html
+++ /dev/null
@@ -1,31 +0,0 @@
----
-title: 'Discover credit card validation issue: Magento EE 1.9.1.1—.13.1.0 and CE 1.4.2.0—1.8.1.0'
-layout: m1x
----
-
Magento has fixed an issue that prevented some Discover credit cards from validating properly. The issue was that certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover cards should validate properly.
Magento Community Edition (CE) versions 1.4.2.0–1.8.1.0
-
-
-
Important: This is not a security threat. No data has been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid Discover card numbers.
We'd like to draw your attention to new patches that were recently posted to the Partner Portal and Support Center. These patches deliver important improvements, such as improving security of the Magento Connect Manager and making it easier to install community-created translation packages.
-
-
General Magento Connect Patches
-
Patch name:
-
PATCH_SUPEE-3941_EE_1.10.1.0_v1-2014-08-12-12-13-15.sh for EE 1.10.x
-
PATCH_SUPEE-3941_EE_1.11.2.0_v1-2014-08-12-12-11-32.sh for EE 1.11.x
-
PATCH_SUPEE-3941_EE_1.14.0.1_v1-2014-08-12-12-10-06.sh for EE 1.12.x
-
Result of applying this patch:
-
When you install a community-created translation package, the translation provided by the package overwrites any existing translations for the same items. This enables you to more easily install packages with translations.
-
To improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
-
Extension developers can now create an extensions with a dash character in the name. Merchants can install those extensions without issues.
-
Magento administrators who attempt to install an extension with insufficient file system privileges are now informed. Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the your Magento install dir/app/code/community directory structure, the Magento administrator sees an error message in the Magento Connect Manager.
-To set file system permissions appropriately, see After You Install Magento: Recommended File System Ownership and Privileges.
Patch name: PATCH_SUPEE-3630_EE_1.12.x_v1.sh for EE 1.12.x. After applying this patch, your search engine returns search results to users on the web store while reindexing is underway. We recommend you install this patch if you're using the Solr search engine. This patch can result in slower performance if you're using the default MySQL Full Text search engine.
diff --git a/guides/m1x/other/ht_extend_magento_rest_api.html b/guides/m1x/other/ht_extend_magento_rest_api.html
deleted file mode 100644
index d7d179f123..0000000000
--- a/guides/m1x/other/ht_extend_magento_rest_api.html
+++ /dev/null
@@ -1,850 +0,0 @@
----
-title: How to Extend the Magento REST API to Use Coupon Auto Generation
-layout: m1x
-
----
-
-
Customers of traditional stores and online web stores love coupons. Typically, a merchant sends coupons to customers who input them when checking out. The coupon saves the customer money and hopefully entices the customer to visit the store more frequently. In addition, the merchant can track coupon codes to individual customers to target market those customers.
-
-
Coupon Auto Generation and the Magento REST API
-
Magento CE 1.7 introduced a new method of creating coupon codes—auto generation. Auto generating coupons means Magento programmatically creates several coupon codes at one time quickly and easily. However, if Magento generates the coupon codes, you'd have to manually distribute them to customers.
-
Magento's REST API is extensible and can easily be called by an outside program to auto generate coupon codes. You can use this feature, for example, to e-mail coupon codes to your top 100 customers.
-
No programming is necessary to implement the extension module discussed in this guide; however, basic familiarity with Magento modules and PHP programming is desirable.
-
The Coupon AutoGen API enables any authorized external program to instruct Magento to:
-
Auto-generate the specified number of coupon codes
-
Return these codes to the calling program—simulated in this guide using a simple .php file
-
-
Implementation Details
-
This guide discusses how to use coupon auto generation and a web service to dynamically call the Magento REST API to generate a series of codes. The web service instantiates the underlying Magento sales rule (salesrule/rule) coupon code generator and creates a pool of new codes. These codes returned to the caller as a JSON string.
-
For more information about the Magento REST API, see Introduction to REST API. To extend the REST API to add a web service for generating and retrieving coupon codes, this guide discusses the following:
-
Setting up an auto generated coupon rule
-
Creating a module to use a REST based API extension
-This guide gives you all the files to create the module; no programming is necessary. There are four module configuration .xml files and one .php file to create the web service.
-
Creating a user for the OAuth access to the new service
-
Testing the web service from a separate page
-
-
System Requirements
-
To implement and test the Coupon AutoGen API, you must have all of the following:
-
Magento Community Edition (CE) 1.7 or later on Ubuntu.
-
Magento Enterprise Edition (EE) 1.12 or later on Ubuntu.
Optional.phpmyadmin, which makes it easier to view and manipulate the Magento database. You can use phpmyadmin for convenience to get the OAuth key and shared secret later in this guide.
-
-
Note: Although Magento supports other Linux operating systems, Ubuntu is the only one discussed in this guide. Consult an appropriate reference for equivalent commands on other Linux operating systems.
-For example, if your Magento instance hostname is www.example.com and you put phpinfo.php in the web server's docroot, enter:
-
http://www.example.com/phpinfo.php
-
Search the resulting output for OAuth.
-The following figure shows an example of OAuth being properly set up.
-
-If the preceding does not display, OAuth is not set up so continue with the next section.
-If OAuth is already installed, continue with Defining a Magento Coupon Code Generation Rule.
-
-
Installing the OAuth Packages
-
The pecl OAuth extension requires both PEAR (which enables you to install the package) and libpcre3-dev, which enables the OAuth package to be compiled.
-
To install the packages and confirm that OAuth is enabled:
-
Enter the following commands in the order shown:
-
-If the following displays, you must edit your php.ini file to find the OAuth library:
-
configuration option "php_ini" is not set to php.ini location
-You should add "extension=oauth.so" to php.ini
-
Open php.ini in a text editor.
-If you're not sure where it's located look in the phpinfo.php page output.
-Add the following anywhere in php.ini:
-
[OAuth]
-extension=oauth.so
-
Save your changes to php.ini and exit the text editor.
-
Enter the following command to restart the Apache web server.
-
service apache2 restart
-
Continue with the next section.
-
-
Confirming that OAuth Installed Successfully
-
If your phpinfo.php page is still open in a web browser, press Control+R to force a refresh; otherwise, enter the URL shown in Creating a phpinfo File to view it.
-
The following figure shows an example of a properly set up OAuth extension.
-
-
Note: Do not continue until you know that OAuth installed successfully.
-
-
Defining a Magento Coupon Code Generation Rule
-
To define a Magento coupon code generation rule:
-
Log in to the Magento Admin Panel as an administrator.
-
Click Promotions > Shopping Cart Price Rules.
-
On the Shopping Cart Price Rules page, click Add New Rule (in the upper-right corner of the page).
-The General Information page displays as follows.
-
-
Enter the following information.
-
-
-
-
-
-
Item
-
Description
-
-
-
Rule Name
-
Enter Generate Coupons.
-
-
-
Description
-
Enter an optional description of the rule, such as Rule that generates a sequence of coupon codes.
-
-
-
Status
-
From the list, click Active.
-
-
-
Websites
-
Click the websites on which you want the coupons to display. Hold down the Shift key and click the names of all items to select them.
-
-
-
Customer Groups
-
Hold down the Shift key and click the names of all items to select them.
-
-
-
Coupon
-
Click Specific Coupon
-
-
-
Coupon Code
-
Leave the field blank.
-
-
-
CE only. Auto Generation
-
Select the Use Auto Generation checkbox.
-
-
-
CE only. Uses per Coupon
-
Enter 10.
-
-
-
Uses per Customer
-
Enter 1.
-
-
-
From Date
-
Select today's date.
-
-
-
To Date
-
Select any date in the future.
-
-
-
Priority
-
Enter 0.
-
-
-
Public In RSS Feed
-
Click No.
-
-
-
-
In the upper-right corner of the page, click Save and Continue Edit.
-The message The rule has been saved displays at the top of the page to indicate that Magento successfully saved the rule you just created.
-
In the left navigation bar, click Actions.
-The Actions page displays as follows.
-
-
Enter the following information.
-
-
-
-
Item
-
Description
-
-
-
Apply
-
From the list, click Percent of product price discount.
-
-
-
Discount Amount
-
Enter 10.
-
-
-
Maximum Qty Discount is Applied To
-
Enter 1.
-
-
-
Discount Qty Step (Buy X)
-
Enter 1.
-
-
-
Apply to Shipping Amount
-
From the list, click No.
-
-
-
Free Shipping
-
From the list, click No.
-
-
-
Stop Further Rules Processing
-
From the list, click Yes.
-
-
-
EE only Add Reward Points
-
Enter 0.
-
-
-
-
Click Save (in the upper-right corner of the page).
-The message The rule has been saved displays to indicate that Magento saved the rule action options you just entered. Notice that this page now has a row for the Generate Coupons rule you just defined.
-A sample follows.
-
-
Write down the rule ID (circled in red in the preceding figure). You will use this value later in this guide.
-
-
Generating Coupon Codes
-
Now that you've created a rule, this section discusses how to use the rule to manually generate a sequence of coupon codes.
-
In the Shopping Cart Price Rules page, click the name of the rule you just created (Generate Coupons).
-
In the left navigation bar, click Manage Coupon Codes.
-
On the Coupons Information page, enter the following information:
-
-
-
-
Item
-
Description
-
-
-
Coupon Qty
-
Enter 3.
-
-
-
Code Length
-
Enter 12.
-
-
-
Code Format
-
Click Alphanumeric.
-
-
-
Coupon Prefix
-
Enter TEST-.
-
-
-
Coupon Suffix
-
Enter -TEST.
-
-
-
Dash Every X Characters
-
Enter 0.
-
-
-
-
Click Generate.
-Magento displays the three coupon codes you created in the Coupon Code section as the following figure shows.
-
-
Click Save.
-
-
Extending Magento's REST API to Include Coupon Auto-Generation
-
In the preceding section, you created a Shopping Cart Price Rule named Generate Coupons that manually generates a set of coupon codes. To use those codes, you could export them to a file, and then import them into any external program you want; however, this is a time-consuming procedure!
-
Fortunately, you can automate this process by adding a coupon code auto-generate API to Magento's existing REST API. Using this API, an external program can automatically get the coupon codes it needs.
-
The following sections discuss how to extend Magento's REST API to include the Coupon AutoGen API:
While you're implementing the Coupon AutoGen API, you must disable Magento's caching so Magento will find and use your new code immediately.
-
To disable the cache:
-
In the Magento Admin Panel, click System > Cache Management.
-The Cache Storage Management page displays as follows.
-
-
Click Select All (on the upper-left of the page).
-A check mark displays next to each Magento cache in the list.
-
From the Actions list, click Disable.
-
Click Submit.
-Magento disables the selected caches, replacing the green ENABLED status indicators with red DISABLED indicators.
-
Click Flush Magento Cache and wait for the cache to be flushed.
-
Log out of the Magento Admin Panel.
-
-
Creating Configuration Files
-
This section discusses how to create a module (also referred to as an extension). The module consists of configuration files that create a web service that extends the Magento REST API to take input from an external program. This program uses HTTP POST and OAuth calls to auto-generate coupon codes.
-
In this guide, the external program is a PHP script; however, it could be any application that uses OAuth and REST calls.
Note: It is up to you to determine ownership and permissions. This guide assumes you create files and directories as root and change the permissions appropriately later. Consult an IT administrator if you're not sure how to proceed.
-
-
Log in to your Magento server and create the following directories:
-
You must create the files and directories exactly as shown; directory names are case-sensitive.
-
Do not change any values in the configuration files discussed in this section.
-
When you create your configuration files, leave no white space at the beginning of the files. Leading white space might cause errors when Magento reads the files and might prevent the coupon demonstration module from working.
-
-
-
-
Change to the magento-install-dir/app/etc/modules directory.
-
In that directory, use a text editor to create your module declaration file. This file must be named CouponDemo_AutoGen.xml and have the following contents.
-
Save your changes to Coupon.php and exit the text editor.
-
Change to the magento-install-dir/app/code/community/CouponDemo/AutoGen/Model/Api2/Coupon/Rest/Admin directory.
-
Create a file named V1.php with the following contents.
-
-<?php
-/* Coupon AutoGen REST API
-*
-* @category CouponDemo
-* @package CouponDemo_AutoGen
-* @author Chuck Hudson (used with permission). For more recipes, see Chuck's book http://shop.oreilly.com/product/0636920023968.do
-*/
-class CouponDemo_AutoGen_Model_Api2_Coupon_Rest_Admin_V1 extends CouponDemo_AutoGen_Model_Api2_Coupon
-{
- /**
- * Generate one or more coupon codes using the Generate Coupons rule defined in Magento.
- * Expected parameters are:
- * {
- * 'qty': int, - number of coupon codes to instruct Magento to generate
- * 'length': int, - length of each generated coupon code
- * 'format': string, - alphanum (for alphanumeric codes), alpha (for alphabetical codes), and num (for numeric codes)
- * }
- *
- * @param array $couponData
- * @return string|void
- */
- protected function _create($couponData)
- {
- $ruleId = $this->getRequest()->getParam('rule_id');
- $couponData['rule_id'] = $ruleId;
- $rule = $this->_loadSalesRule($ruleId);
- // Reference the MassGenerator on this rule.
- /** @var Mage_SalesRule_Model_Coupon_Massgenerator $generator */
- $generator = $rule->getCouponMassGenerator();
- // Validate the generator
- if (!$generator->validateData($couponData)) {
- $this->_critical(Mage::helper('salesrule')->__('Coupon AutoGen API: Invalid parameters passed in.'),
- Mage_Api2_Model_Server::HTTP_BAD_REQUEST);
- } else {
- // Set the data for the generator
- $generator->setData($couponData);
- // Generate a pool of coupon codes for the Generate Coupons rule
- $generator->generatePool();
- }
- }
- /**
- * Retrieve list of coupon codes.
- *
- * @return array
- */
- protected function _retrieveCollection()
- {
- $ruleId = $this->getRequest()->getParam('rule_id');
- $rule = $this->_loadSalesRule($ruleId);
- /** @var Mage_SalesRule_Model_Resource_Coupon_Collection $collection */
- $collection = Mage::getResourceModel('salesrule/coupon_collection');
- $collection->addRuleToFilter($rule);
- $this->_applyCollectionModifiers($collection);
- $data = $collection->load()->toArray();
- return $data['items'];
- }
- /**
- * Load sales rule by ID.
- *
- * @param int $ruleId
- * @return Mage_SalesRule_Model_Rule
- */
- protected function _loadSalesRule($ruleId)
- {
- if (!$ruleId) {
- $this->_critical(Mage::helper('salesrule')
- ->__('Rule ID not specified.'), Mage_Api2_Model_Server::HTTP_BAD_REQUEST);
- }
- $rule = Mage::getModel('salesrule/rule')->load($ruleId);
- if (!$rule->getId()) {
- $this->_critical(Mage::helper('salesrule')
- ->__('Rule was not found.'), Mage_Api2_Model_Server::HTTP_NOT_FOUND);
- }
- return $rule;
- }
-}
-
-
Save your changes to V1.php and exit the text editor.
-
-
Setting Permissions on the Configuration Files
-
File permissions and ownership are important for any Linux application. Magento provides general guidelines for permission and ownership although following them are not a requirement for this guide. The configuration files and directories can be owned by root or other users and it won't prevent the procedures discussed in this guide from completing successfully.
-
Consult your network administrator if you are not sure how to set file permissions and ownership. The procedure that follows is a suggestion only.
-
The Magento guidelines discussed in the following procedure are taken from this Magento Wiki article and set the following:
-
File and directory ownership set to your-login-name:apache-user-group.
-If you're not sure which group owns Apache processes, enter the command ps -ef | grep apache2. The following procedure assumes it is www-data.
-
File permissions set to 644.
-
Directory permissions set to 755.
-
To optionally set permissions and ownership according to Magento guidelines:
-
As a user with root privileges, enter the following commands in the order shown to change ownership of the files and directories you created as discussed in this guide:
-
cd magento-install-dir/app/code/community
-chown -R your-login-name:www-data CouponDemo
-find . -type f -exec chmod 644 {} +
-find . -type d -exec chmod 755 {} +
-
As a user with root privileges, enter the following commands in the order shown to change the permissions and ownership of CouponDemo_AutoGen.xml .
-
cd magento-install-dir/app/etc/modules
-chown your-login-name:www-data CouponDemo_AutoGen.xml
-chmod 644 CouponDemo_AutoGen.xml
-
-
Securing the Coupon AutoGen API
-
For security reasons, Magento allows only authorized external programs to call the Magento REST API.
-
The following sections discuss how to enable the test script (discussed in the next section) to call the Coupon AutoGen API:
To use the Magento Admin Panel to create a role for the Coupon AutoGen API:
-
Log in to the Magento Admin Panel as an administrator.
-
Click System > Web Services > REST - Roles.
-
On the REST—Roles page, click Add Admin Role.
-
In the Role Name field, enter Coupon Auto Generate Demo.
-
Click Save Role.
-
In the left navigation bar, click Role API Resources.
-The Role Resources page contains a hierarchical list of resources to which you can grant or deny the Coupon Auto Generate Demo role access.
-
From the Resource Access list, click Custom.
-
Select the checkbox next to the node labeled CouponDemo API.
-
Magento automatically checks the child checkboxes as the following figure shows.
-
-
Click Save Role.
-Magento saves the resource API permissions you granted to the Coupon Auto Generate Demo REST role.
-The Coupon Auto Generate Demo role now has permission to use the Coupon AutoGen API.
-
-
Adding Users to the Coupon Auto Generate Demo Role
-
Now that you have a role, you must add users to give them permission to call the Coupon AutoGen API as follows:
-
In the left navigation bar, click Role Users.
-
Click Reset Filter (in the upper-right corner of the page).
-The page displays all registered users as the following figure shows.
-
-
Select the checkbox next to each user to grant the user privileges to access the resources available to the Coupon Auto Generate Demo REST role—that is, permission to call the Coupon AutoGen API.
-
Note: If a warning dialog box displays, click OK to dismiss it. This warning is not relevant when adding users to REST roles.
-
-
When you're done, click Save Role.
-The specified user(s) can now grant an external program the right to call the Coupon AutoGen API.
-
-
Setting up REST Attributes for the Coupon AutoGen API
-
This section discusses how to enable any user with a REST Admin role to use the Coupon AutoGen API.
-
To set REST attributes for the REST Admin role:
-
Click System > Web Services > REST - Attributes.
-
On the REST Attributes page, under User Type, click Admin.
-
In the User Type Resources section, from the Resource Access list, click Custom.
-
Select the CouponDemo API checkbox.
-Doing so selects all the child checkboxes, as the following figure shows.
-
-
Click Save.
-Any user with the REST Admin role can now read from and write to the Coupon AutoGen API.
-
-
Creating an OAuth Consumer for Your Test Script
-
This section discusses how to create a consumer so you can test the Coupon AutoGen API before you deploy it in a production system. After successfully testing the API, you can remove this user.
-
In the Magento Admin Panel, click System > Web Services > REST - OAuth Consumers.
-
Click Add New (in the upper-right corner of the page).
-The New Consumer page displays as the following figure shows.
-
-
In the Name field, enter Coupon AutoGen Test Driver.
-
Leave the other fields blank.
-
Write down the values displayed in the Key and Secret text boxes.
-
Note: The key and secret values are stored in the Magento database in the table oauth_consumer. It might be more convenient for you to use phpmyadmin or database tools to retrieve them from the database after you save the role.
-You must include these values in the test script you will write in the next section. The script uses these values to identify itself to Magento.
-
Click Save (in the upper-right corner of the page).
-
Log out of the Magento Admin Panel.
-
-
Testing the Coupon AutoGen API
-
This section discusses how to create a simple PHP file that acts as an external program and, with permissions you granted the OAuth consumer, enables the program to use the HTTP POST method to auto generate coupon codes.
-
You can use any type of OAuth/REST call, in fact, such as using the Firefox REST Client plug-in as discussed here.
-
The following sections discuss how to create and run the test script:
The test script you create calls the Coupon AutoGen API, thereby causing Magento to generate the specified coupon codes and return them to the caller (rest_test.php) in the form of a JSON-encoded string. Finally, the server responds to the browser's request with an HTML page containing the generated coupon codes.
-
The PHP code that follows:
-
Uses your OAuth consumerKey and consumerSecret to set up the OAuth client.
-
Defines data to pass to the array $couponGenerationData. The data should include the following:
-
The rule ID (listed next to the rule in the rule list in the Magento Admin Panel)
-
The number of codes desired (in this case, two)
-
The length of the codes
-
The format to be used (in this case, alphanumeric)
-
-
The array of parameters is then passed in the fetch command with the resourceUrl for the web service call.
-
-
-
Finally, the server responds to the browser's request with an HTML page containing the generated coupon codes.
-
To create the test script, named rest_test.php:
-
Create the file magento-install-dir/rest_test.php with the following contents.
-
-<?php
-/********************************************************************
-File name: rest_test.php
-Description:
-A PHP test script that calls the Coupon AutoGen extension
-to Magento's REST API.
-The Coupon AutoGen API takes:
--- the rule ID of the "Generate Coupons" rule to execute
--- the number of coupon codes to generate
--- the length of each coupon code
--- the format of each coupon code
-The API returns the generated coupon codes, in JSON-encoded form
- ********************************************************************/
-// Replace <<...>> below with the key and secret values generated for the Coupon AutoGen Test Driver
-$consumerKey = '<<YOUR CONSUMER KEY>>'; // from Admin Panel's "REST - OAuth Consumers page"
-$consumerSecret = '<<YOUR CONSUMER SECRET>>'; // from Admin Panel's "REST - OAuth Consumers page"
-
-// Set the OAuth callback URL to this script since it contains the logic
-// to execute *after* the user authorizes this script to use the Coupon AutoGen API
-$callbackUrl = "http://<<host-or-ip:port>>/<<path>>/rest_test.php";
-
-// Set the URLs below to match your Magento installation
-$temporaryCredentialsRequestUrl = "http://<<host-or-ip:port>>/<<path>>/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
-$adminAuthorizationUrl = 'http://<<host-or-ip:port>>/<<path>>/admin/oauth_authorize';
-$accessTokenRequestUrl = 'http://<<host-or-ip:port>>/<<path>>/oauth/token';
-$apiUrl = 'http://<<host-or-ip:port>>/<<path>>/api/rest';
-
-session_start();
-if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
- $_SESSION['state'] = 0;
-}
-try {
- $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
- $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
- $oauthClient->enableDebug();
- if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
- $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
- $_SESSION['secret'] = $requestToken['oauth_token_secret'];
- $_SESSION['state'] = 1;
- header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
- exit;
- } else if ($_SESSION['state'] == 1) {
- $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
- $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
- $_SESSION['state'] = 2;
- $_SESSION['token'] = $accessToken['oauth_token'];
- $_SESSION['secret'] = $accessToken['oauth_token_secret'];
- header('Location: ' . $callbackUrl);
- exit;
- } else {
- // We have the OAuth client and token. Now, let's make the API call.
- $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
- // Set the array of params to send with the request
- $ruleId = <<RULE_ID>>; // Set to the rule ID of the Generate Coupons rule
- $couponGenerationData = array();
- $couponGenerationData['qty'] = 2; // Number of coupons codes to create
- $couponGenerationData['length'] = 7; // Length of each coupon code
- // Options for format include:
- // alphanum (for alphanumeric codes), alpha (for alphabetical codes), and num (for numeric codes)
- $couponGenerationData['format'] = "alphanum"; // Use alphanumeric for the coupon code format
- // Generate coupon codes via POST
- $resourceUrl = "$apiUrl/coupondemo/rules/{$ruleId}/codes";
- $oauthClient->fetch($resourceUrl, json_encode($couponGenerationData), OAUTH_HTTP_METHOD_POST, array(
- 'Accept' => 'application/json',
- 'Content-Type' => 'application/json',
- ));
- // Retrieve list of created coupons via GET
- $collectionFilters = array('limit' => $couponGenerationData['qty'], 'order' => 'coupon_id', 'dir' => 'dsc');
- $oauthClient->fetch($resourceUrl, $collectionFilters, OAUTH_HTTP_METHOD_GET, array(
- 'Accept' => 'application/json',
- 'Content-Type' => 'application/json',
- ));
- $coupons = json_decode($oauthClient->getLastResponse(), true);
- // Display the newly generated codes to demonstrate that the Coupon AutoGen API works
- // In reality, you might put these codes in emails to customers, store them in a database, etc.
- echo "New coupon codes: ";
- foreach ($coupons as $coupon) {
- echo " --> " . $coupon['code'] . " ";
- }
- }
-} catch (OAuthException $e) {
- print_r($e->getMessage());
- echo " ";
- print_r($e->lastResponse);
-}
-
-
The following table discusses the values you must change.
-
-
-
-
String to change
-
How to change it
-
-
-
<<YOUR CONSUMER KEY>>
-
Coupon AutoGen Test Driver OAuth consumer's key.
-
You can view this in the Admin Panel: System > Web Services > REST - OAuth Consumers or you can get the value from the oauth_consumer table in the Magento database.
-
-
-
<<YOUR CONSUMER SECRET>>
-
Coupon AutoGen Test Driver OAuth consumer's secret.
-
You can view this in the Admin Panel: System > Web Services > REST - OAuth Consumers or you can get the value from the oauth_consumer table in the Magento database.
-
-
-
-
<<host-or-ip:port>>/<<path>>
-
Your Magento instance's fully qualified hostname or IP address and port, if you are using a port other than 80, and the path to your Magento installation. If you are running Magento on localhost, enter 127.0.0.1
-
For example, if your Magento server's hostname is www.example.com, running on port 80, and Magento is installed at /var/www/magento, enter http://www.example.com/magento
-
-
-
<<RULE_ID>>
-
Generate Coupons rule ID.
-
Get this value by clicking Promotions > Shopping Cart Price Rules
.
-
-
-
-
Save the file and close the text editor.
-
-
Running the Test Script
-
To run the test script:
-
Start a web browser.
-
In the browser's address or location field, enter:
-
When prompted, click Authorize to grant authorization for the script to access your OAuth consumer account, as the following figure shows.
-
-
When prompted, log in as that user.
-After you log in, two new coupon codes display as follows to confirm you successfully used the API. If your browser displays a page like this one, you've successfully implemented the Coupon AutoGen REST API!
-
-
To optionally see these codes in the Admin Panel:
-
Log in to the Admin Panel as an administrator.
-
Click Promotions > Shopping Cart Price Rules.
-
Click Generate Coupons.
-
In the left navigation bar, click Manage Coupon Codes.
-The codes you generated manually earlier display with the new codes (highlighted in red) as the following figure shows.
-
-
-
Re-Enabling Magento's Cache
-
Only after successfully completing the test, you should re-enable Magento's caching system, so performance returns to normal.
-
To re-enable the Magento cache:
-
In the Magento Admin Panel, click System > Cache Management.
-
On the Cache Storage Management page, click Select All (in the upper-left of the page).
-A check mark displays next to each Magento cache in the list.
-
Click Enable from the Actions list.
-
Click Submit.
-Magento enables the selected caches. You can tell because the red DISABLED status indicator is replaced by a green ENABLED indicator.
-
Click Select All again.
-
Click Refresh from the Actions list.
-
Click Submit.
-Magento reloads the selected caches. Magento now performs much faster.
-
Congratulations! You have successfully added the Coupon AutoGen API to Magento's REST API. Following the same procedure, you can expose lots of Magento functionality to external programs.
-
-
Troubleshooting Suggestions
-
The following sections discuss solutions to issues you might encounter when setting up this demonstration:
Problem: OAuth package installation fails with the error ERROR: `make' failed.
-
Description: In some cases, the pecl install oauth command does not install a C compiler. If you encounter the following error, you must install the make package; otherwise, OAuth won't compile:
-
1: make: not found
-ERROR: `make' failed
-
Solution:
-
Enter the following commands in the order shown as a user with root privileges:
-
apt-get install make
-pecl install oauth
-
Make sure the message Build process completed successfully displays to indicate OAuth compiled successfully.
-If the following displays, you must edit your php.ini file to find the OAuth library:
-
configuration option "php_ini" is not set to php.ini location
-You should add "extension=oauth.so" to php.ini
-
Open php.ini in a text editor.
-If you're not sure where it's located look in the phpinfo.php page output.
-Add the following anywhere in php.ini:
-
[OAuth]
-extension=oauth.so
-
Save your changes to php.ini and exit the text editor.
-
Enter the following command to restart the Apache web server.
-
CouponDemo API Calls Options Don't Display in the Admin Panel
-
Problem: After setting up the CouponDemo configuration files, the CouponDemo API Calls checkboxes do not display in the Admin Panel. A sample is shown in a figure earlier in this guide.
-
Description: The CouponDemo API Calls checkboxes display to indicate you set up the module correctly. If they don't display, either the Magento cache hasn't been entirely cleared or there's something wrong with the directory structure or configuration files.
-
Solution: Use the following steps to isolate and correct the issue:
Make sure you copied the exact text from the sample configuration files discussed in Creating Configuration Files. Do not change anything, and remember that case is important.
-
Clear the Magento cache in all of the following ways:
-
As a user with sufficient privileges to delete files and directories in the Magento installation, enter the following commands:
-
Log in to the Magento Admin Panel as an administrator and click System > Cache Management.
-Click Flush Magento Cache.
-Click Flush Cache Storage and follow the prompts on your screen to delete the cache storage.
-
-
Log out of the Magento Admin Panel and log back in.
-
Click System > REST - Roles.
-
Click Coupon Auto Generate Demo.
-
In the left navigation bar, click Role API Resources.
-
If the CouponDemo API Calls checkboxes do not display, double-check all of the .xml configuration files to make sure there is no leading white space (that is, there are no blank lines at the beginning of the files.
-Remove any blank lines and save the .xml files.
-
-
Errors Running rest_test.php
-
The following sections discuss issues you might encounter when you run rest_test.php in a web browser:
Invalid auth/bad request (got a 401, expected HTTP/1.1 20X or a redirect)
-{"messages":{"error":[{"code":401,"message":"oauth_problem=consumer_key_rejected"}]}}
-
Description: Your OAuth authentication attempt failed because the credentials are incorrect.
-
Solution: Open rest_test.php in a text editor and verify the values of the following:
You can find these values in the oauth_consumer database table or in the Admin Panel: System > Web Services > REST - OAuth Consumers.
-
After verifying the correct values, save your changes to rest_test.php and try again.
-
-
Invalid auth/bad request: Rule was not found
-
The following error displays in the web browser:
-
Invalid auth/bad request (got a 404, expected HTTP/1.1 20X or a redirect)
-{"messages":{"error":[{"code":404,"message":"Rule was not found."}]}}
-
Description: The shopping cart promotion rule could not be found.
-
Solution: Open rest_test.php in a text editor and verify the value of the following:
-
$ruleId = value;
-
You can find this value in the Admin Panel: Promotions > Shopping Cart Price Rules.
-
Change the value in rest_test.php, save it, and try again.
-
-
Invalid auth/bad request: /magento/oauth/initiate was not found on this server
-
The following error displays in the web browser:
-
Invalid auth/bad request (got a 404, expected HTTP/1.1 20X or a redirect)
-Not Found
-The requested URL /magento/oauth/initiate was not found on this server.
-
Description: The HTTP redirect failed, most likely because web server rewrites are not properly enabled.
-
Solution: Make sure web server rewrites are enabled. The procedure you use depends on your web server and operating system. An example for Ubuntu can be found here.
-
-
Next Steps
-
Refer to Magento APIs—REST for documentation explaining how the Magento's REST API framework works.
-
diff --git a/guides/m1x/other/ht_install-patches.html b/guides/m1x/other/ht_install-patches.html
deleted file mode 100644
index 5ac1aa3a6a..0000000000
--- a/guides/m1x/other/ht_install-patches.html
+++ /dev/null
@@ -1,150 +0,0 @@
----
-layout: m1x
-title: How to Apply and Revert Magento Patches
----
-
-
-
-
Note: This article assumes your patch file name ends in .sh. If your patch file name ends in .patch or something else, contact Magento Support before proceeding.
-
-
Need More Detail?
-
For more step-by-step details that are provided here, see one of the following:
Log in to magentocommerce.com/download.
- (Click My Account in the upper right corner of the page.)
- If you don't have an account, you can register for one; the account is free.
-
In the Magento Community Edition Patches section, locate the patch to install.
-
From the list next to the patch, choose your CE version.
Log in to magentocommerce.com.
- (Click My Account in the upper right corner of the page.)
-
Click Downloads in the left pane.
-
Click Magento Enterprise Edition in the right pane.
- The following figure shows an example.
-
-
Click Support Patches.
-
Locate the patch to download.
-
Click Download corresponding to the patch for the version of EE you're using.
-
After the download completes, continue with the next section.
-
-
How to Apply a Magento Patch
-
To apply a Magento patch:
-
Transfer the patch .sh file to your Magento installation root directory.
-
Note: This article assumes your patch file name ends in .sh. If your patch file name ends in .patch or something else, contact Magento Support before proceeding.
-
- For example, /var/www/html/magento.
-
Enter the following commands as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
- A message such as the following displays to confirm the patch installed successfully:
-
Patch was applied/reverted successfully.
-
To reapply ownership to the files changed by the patch:
-
Find the web server user: ps -o "user group command" -C httpd,apache2
- The value in the USER column is the web server username.
- Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
-
As a user with root privileges, enter the following command from the Magento installation directory:
-
chown -R web-server-user-name .
- For example, on Ubuntu where Apache usually runs as www-data, enter
-
chown -R www-data .
-
-
Perform any other tasks as instructed by Magento Support.
- (For example, some patches require you to stop external services, such as the Solr search engine.)
-
-
How to Apply the SUPEE-8788 Patch
-
We released a security patch in October, 2016 that might cause issues for some users. This section applies to you if any of the following is true:
-
You haven't yet applied the SUPEE-8788 patch and your Magento version is earlier than EE 1.14.1.0 or CE 1.9.1.0.
-
You applied version 1 of the SUPEE-8788 patch. (The patch name includes PATCH_SUPEE-8788_<magento version>_v1.)
-
You previously applied the SUPEE-1533 patch and you want to apply the SUPEE-8788 patch.
-
You're applying the SUPEE-8788 patch as part of an upgrade from an earlier Magento version.
-
-
We recommend the following:
-
If you applied SUPEE-8788 version 1, revert that patch, revert SUPEE-1533 (version restrictions apply), apply SUPEE-3941 (version restrictions apply), then apply SUPEE-8788 version 2 or later.
-
If you haven't applied SUPEE-8788, revert SUPEE-1533 (version restrictions apply), apply SUPEE-3941 (version restrictions apply), then apply SUPEE-8788.
-
-
Replace SUPEE-8788 version 1 with version 2 or later
-
To replace SUPEE-7877 version 1 with version 2 or later:
-
Log in to your Magento server.
-
Open <your Magento install dir>/app/etc/applied.patches.list in a text editor.
- This file lists all currently applied patches.
-
Determine which patches are already applied. Version 1 of SUPEE-8788 includes PATCH_SUPEE-8788_<magento version>_v1 in the name.
-
If your Magento version is EE 1.14.1.0 or CE 1.9.1.0, and patch SUPEE-1533 is applied, revert SUPEE-1533.
-
If your Magento version is earlier than EE 1.14.1.0 or CE 1.9.1.0, and SUPEE-3941 is not applied, apply SUPEE-3941.
-
- If the files are present, delete them to avoid a potential security exploit. As of Magento CE 1.9.0.0 and Magento EE 1.14.0.0, we no longer distribute .swf files with the Magento software.
-
-
Apply SUPEE-8788
-
To apply patch SUPEE-8788:
-
Open <your Magento install dir>/app/etc/applied.patches.list in a text editor.
-
- If the files are present, delete them to avoid a potential security exploit. As of Magento CE 1.9.0.0 and Magento EE 1.14.0.0, we no longer distribute .swf files with the Magento software.
-
-
Listing Patches You Have Installed
-
If you're not sure which patches are already applied, open <your Magento install dir>/app/etc/applied.patches.list.
-
-
How to Revert a Magento Patch
-
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
-
Change to your Magento installation directory.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh patch-file-name.sh -R
-
-
Troubleshooting
-
If you get an error when you run the patch, use the following suggestions:
-
Verify the patch is located in your Magento installation root directory.
- Ubuntu example: /var/www/magento
- CentOS example: /var/www/html/magento
-
Verify you're running the patch with sufficient privileges.
- Typically, this means running it as the web server user or as a user with root privileges.
This guide is intended for Magento EE administrators and systems integrators who have some familiarity with search
- engines—ideally, who also have Solr configuration experience. No programming is required to perform the tasks
- discussed in this guide.
-
This guide discusses a simple Solr configuration that uses the example Solr configuration provided with Solr, default
- Solr integration options provided with Magento EE, and also explains how to configure Magento EE to use Solr. Advanced
- configuration tasks—such as setting up dictionaries—are beyond the scope of this guide.
-
Note: The example Solr configuration is not intended to be used in a
- production site. It's for testing and development only. Because it's simple to use which, it's a great way for you
- to learn more about Solr.
-
-
Comparing the Search Options
-
The following table provides a quick comparison between Magento with the default MySQL full text search and Magento
- with Solr search.
-
-
-
-
-
-
Feature
-
Magento with MySQL full-text search
-
Magento with Solr search
-
-
-
Full text search
-
-
Yes and also supports two additional search modes:
-
-
Like
-
Combined (like and full text)
-
-
Yes†
-
-
-
Search recommendations
-
Yes
-
Yes
-
-
-
Faceted search (used in layered navigation)
-
Yes
-
Yes
-
-
-
Range (such as price range)
-
Yes
-
Yes
-
-
-
Sort-by options (for example, sort by relevance)
-
Yes
-
Yes
-
-
-
Zero results tips or results correction
-
No
-
Yes
-
-
-
Suggestions
-
No
-
Yes
-
-
-
Clustering
-
No
-
Yes
-
-
-
Attribute weight based on attribute settings
-
No
-
Yes
-
-
-
Search localized characters
-
No
-
Yes
-
-
-
Word delimiter (for example, searching for spider man or spiderman
- return spider-man)
-
No
-
Yes
-
-
-
-†—"Like" searching is supported by MySQL full text search but not by Solr. Defined by the
-Mage_CatalogSearch_Model_Resource_Fulltext::prepareResult() class, like searching joins each term in your
-search using LIKE statements combined by OR. Like searching is best used in stores that have simple products where users
-search for specific terms.
-
-
Support Matrix for Solr and Magento EE
-
The following table summarizes what versions of Magento EE work with what versions of Solr.
- Click here to browse the list of all
- available Solr versions.
-
-
-
-
-
Note: Magento EE does not support Solr 4.x.
-
-
More Information About the Solr Solution
-
Solr runs as a standalone full-text search server in a servlet container such as Jetty (which is used by the Solr
- example configuration) and Tomcat.
-
Solr uses the Lucene Java search library for full-text indexing and search. Your applications interact with Solr
- using HTTP POST (in JSON,
- XML, CSV, or binary formats) to index
- documents and using HTTP
- GET to retrieve search results back as JSON, XML, or a
- variety of other formats (Python, Ruby, PHP, CSV, binary, and so on). If you're a programmer, try the Solr tutorial. Whether
- you're a programmer or not, read the Solr FAQ.
-
No programming is required to implement Solr as discussed in this guide.
-
Solr's powerful external configuration allows it to be tailored to almost any type of application without Java
- coding, and it has an extensive plug-in architecture when more advanced customization is required. Solr is highly
- scalable, providing distributed search and index replication.
-
Important: Customize the Solr search engine at your own risk. Magento
- supports only the options displayed in the Admin Panel. Customizing the Solr engine itself, while potentially
- useful, can cause issues with Magento. If you encounter problems with your customizations, do not contact Magento
- Support; instead, consult the resources available from the Apache Solr Wiki.
-
In this guide, you'll use the example configuration provided with Solr and Magento's provided Solr configuration to
- implement a simple, quick integration with Solr.
-
Some reasons to use Solr with Magento include:
-
-
Magento ships with a sample Solr configuration that enables you to provide users with a powerful search engine
- without your needing to customize any code.
-
You get better performance of search, catalog views, and layered navigation.
-
When the system is under load, Solr avoids frequent updates of the MySQL catalogsearch_fulltext table and
- alleviates issues with database table locks.
-
-
-
-
Simple Comparison of Solr and MySQL Search Engines
-
Following is a simple comparison of the default MySQL full-text search and Solr search using Magento EE 1.14.0.0 and
- Solr 3.6.2. Magento EE catalog content is provided by sample data you can download from Magento.
-
Among the many options Solr gives you is the option to suggest names of products in the event the user
- enters an incomplete or incorrect search term in your Magento store's Search field.
-
-
Default MySQL Full-Text Search Using an Incorrect Search Term
-
Using the default MySQL full-text search, if a user enters an incorrect search term (such as shirrt instead
- of shirt, no results display as the following figure shows.
-
-
-
Solr Search Using an Incorrect Search Term
-
Using Solr, if a user enters an incorrect search term, suggestions display as the following figure shows.
-
-
In addition, if a user enters an incomplete search term, Magento provides dictionary-based suggestions as the
- following figure shows.
-
-
-
Prerequisites
-
The tasks discussed in this guide require the following:
Java version 1.6 or later.
- To determine if Java is already installed, enter the following command:
-
java -version
- If the message java: command not found displays, you must install the Java SDK as discussed in the next
- section. If Java is installed, make sure it's version 1.6 or later.
-
Tomcat or Jetty servlet container. This guide discusses using Jetty, which comes with Solr. Consult another
- resource, such as the Solr Wiki, to use Tomcat
- with Solr.
- To see if you're currently running Jetty and to check the version, see How
- to find out the version of Jetty.
-
-
-
Installing Prerequisite Software
-
The following sections discuss how to install the prerequisite software:
To install the Java 6 SDK, enter the following command as a user with root privileges:
-
apt-get install openjdk-6-jdk
-
To install Java 7, enter the following command as a user with root privileges:
-
apt-get install openjdk-7-jdk
-
Note: Java version 7 might not be available for all operating systems. For
- example, you can search the list of available packages for Ubuntu here.
-
-
Installing Solr 3.6.2 and Jetty
-
The Apache Solr package installs both Solr and Jetty. If Jetty is already installed, see the Solr with Jetty Wiki for more information.
-
Note: Tomcat is also a supported servlet container for Solr but discussing how to
- set up Tomcat with Solr is beyond the scope of this guide. For more information, see the Solr With Tomcat Wiki.
Copying the Magento Solr Configuration and Starting Solr
-
Magento comes packaged with a sample Solr configuration you can use and customize. To get started, you'll copy the
- Magento configuration to Solr, replacing any existing files. After that you can start Solr and begin configuring
- Magento to work with it.
-
Note: The example Solr configuration is not intended to be used in a
- production site. It's for testing and development only. It's simple to use which makes it a great way for you to
- learn more about Solr.
-
-
To copy the Magento Solr configuration:
-
-
As a user with root privileges, enter the following commands in the order shown to copy over the Solr
- configuration with the one packaged with Magento EE:
- For example, if Solr is installed in /etc/solr/apache-solr-3.6.2 and Magento is installed in
- /var/www/magento, enter:
-
cd /etc/solr/apache-solr-3.6.2/example/solr/conf
-cp -R /var/www/magento/lib/Apache/Solr/conf/* .
-
Note: If you're prompted to overwrite files, try the command \cp -R [your
- Magento install dir]/lib/Apache/Solr/conf/* .
-
-
CentOS with Tomcat 6 only. If you're using Tomcat 6 on CentOS, you must modify [your Solr install
- dir]/example/solr/conf/solrconfig.xml
- Locate the following line:
-
<dataDir>${solr.data.dir:./solr/data}</dataDir>
- Change it to:
-
<dataDir>${solr.data.dir:}</dataDir>
-
-
-
As a user with root privileges, enter the following command to start Solr:
Note: This method for starting Solr is for convenience and testing purposes
- only. In a production environment, you should start and stop Solr using a script as discussed in Scripting Solr Startup and Shutdown.
-
-
Configuring Magento to Work With Solr
-
This section discusses how to configure Magento EE to use the Solr search engine.
-
To configure Magento to work with Solr:
-
-
Log in to the Magento Admin Panel as an administrator.
-
Click System > Configuration > CATALOG > Catalog.
-
In the right pane, expand Catalog Search.
-
The following table shows the minimum amount of information to enter to test the connection to your Solr
- search engine. Leave all other values at their defaults.
-
-
-
-
-
-
Option
-
Description
-
-
-
Search Engine
-
Click Solr
-
-
-
Solr Server Hostname
-
Enter the fully qualified hostname or IP address of the machine running Solr. (If
- Solr is running on the same host as Magento, you can optionally use 127.0.0.1.)
-
-
-
Solr Server Port
-
Enter Solr's listen port. (The example Jetty servlet container uses 8983. The
- default for Tomcat is usually 8080.)
Specifies the path and name of the Solr web application. The path used by the example Solr
- configuration is solr.
-
If you customized Solr, the value you enter in this field must exactly match the value of
- webapp_name=value in [your Solr install
- dir]/example/solr/conf/scripts.conf.
-
-
-
-
Indexation Mode
-
-
Specifies how Solr processes indexed content.
-
From the Indexation Mode list, click one of the following:
-
-
-
Final commit (Default, recommended): After you reindex the content
- search index, Solr starts processing content. Users see results from content that was searchable
- before indexing started and the Magento store remains available for other requests.
-
Final commit has much better performance then partial commit, and does not require any additional
- Solr configuration as does engine autocommit.
-
Indexing begins after all unneeded data is removed and new data is added. At that point, users
- see results from newly indexed data immediately.
-
-
Partial commit: All content is removed from Solr after you reindex the content
- search index and users at that time see no search results. As content is gradually reindexed, users
- see only the results of content that has been indexed.
-
-
Engine autocommit: Content is put in the index queue but is not committed. You
- must configure Solr to commit at regular intervals (for example, every 5 minutes) or when a
- certain number of uncommitted items is reached.
Click Test Connection.
- The button changes as follows.
-
-
-
-
-
-
Button state
-
Meaning
-
-
-
-
The test connection succeeded. Click Save Config and continue
- with the next section.
-
-
-
-
The test connection failed. Try the following:
-
-
Examine the command window in which you started Solr for stack traces and exceptions. You must
- resolve those before you continue.
- In particular, make sure you started Solr as a user with root privileges.
Verify the value of the Solr Server Hostname field. Make sure the server is
- available. You can try the server's IP address instead.
-
Use the command netstat -an | grep listen-port command to verify that the port
- specified in the Solr Server Port field is not being used by another process.
- For example, to see if Solr is running on its default port, use the following command:
-
netstat -an | grep 8983
- If Solr is running on port 8983, it displays similar to the following:
- tcp 0 0 :::8983 :::* LISTEN
-
If Solr is installed on a remote machine, use the ping command to verify that machine is
- reachable from your Magento instance.
-
If SELinux is enabled, make sure the Solr servlet container's listen port is available; otherwise,
- Magento cannot communicate with the servlet container. For example, you can consult the SELinux Centos wiki.
-
-
-
-
-
-
-
Only after the test connection succeeds, click Save Config and continue with the next
- section.
-
-
-
Basic Solr Configuration
-
This section discusses how to configure Magento to work with Solr using options in the Admin Panel. Although
- additional Solr customization is possible, it is beyond the scope of this guide.
-
Important: Customize the Solr search engine at your own risk.
- Magento supports only the options displayed in the Admin Panel. Customizing the Solr engine itself, while
- potentially useful, can cause issues with Magento. If you encounter problems with your customizations, do not
- contact Magento Support; instead, consult the resources available from the Apache Solr Wiki.
-
To configure Magento to work with Solr:
-
-
Start the Magento Admin Panel and log in as an administrator.
-
Click System > Configuration.
-
In the left navigation bar, under the CATALOG group, click Catalog > Catalog
- Search.
-
The following table shows the minimum amount of information to enter to test the connection to your Solr
- search engine. Leave all other values at their defaults.
-
-
-
-
-
-
Option
-
Description
-
-
-
Minimal Query Length
-
Enter the minimum number of characters permitted for a catalog search.
-
-
-
Maximum Query Length
-
Enter the maximum number of characters permitted for a catalog search.
-
-
-
Search Engine
- Solr Server Hostname
- Solr Server Port
- Solr Server Username
- Solr Server Password
- Solr Server Timeout
- Solr Server Path
- Indexation Mode
-
Suggestions are the native Solr mechanism of advising users in the event they enter
- incomplete or incorrect user input. Suggestions, when enabled, are automatically provided as part of
- any search request.
-
Solr completes incomplete or incorrect input using a dictionary that is based on the main index (and
- can be customized using configuration files to use any other arbitrary dictionary). Suggestions
- display with default text "Did you mean:" in the search results page if needed.
-
Notes:
-
-
Search suggestions are not the same as AJAX hints.
-
Enabling suggestions negatively affects performance because they result in more complex queries
- to Solr.
-
-
-
-
-
Search Suggestions Count
-
Enter the maximum number of suggestions to return.
-
-
-
Show Results Count for Each Suggestion
-
-
The default option, No, displays only the suggestion and not the number of results
- for each suggestion.
-
Click Yes to display the number of results for each suggestion.
-
-
-
-
Enable Search Recommendations
-
-
Recommendations display terms related to a requested word or phrase on the search results
- page.
-
This functionality is not based on third party engine functionality, but is implemented as part of
- the Enterprise_Search module and can be shown with the Solr search suggestions block.
-
By default, Magento uses the Enterprise_Search_Model_Adapter_HttpStream module for
- recommendations. If you install the Apache
- Solr PHP extension, Magento automatically uses the
- Enterprise_Search_Model_Adapter_PhpExtension adapter instead. Both adapters function in the
- same way with no difference in performance. However, the PhpExtension adapter is not tested
- by Magento so you must thoroughly test any modifications you make to it before deploying it in a
- production environment.
-
Note: Enabling recommendations negatively affects
- performance because they result in more complex queries to Solr and more database calls.
-
-
-
-
Search Recommendations Count
-
Enter the maximum number of recommendations to return.
-
-
-
Show Results Count for Each Recommendation
-
-
The default option, No, displays only the recommendation and not the number of
- results for each recommendation.
-
Click Yes to display the number of results for each recommendation.
-
-
-
-
Enable Solr Engine for Catalog Navigation
-
-
Click Yes (the default) to use Solr to enable layered navigation in the category view.
-
Click No to use the database for layered navigation in the category view.
-
-
-
-
-
-
-
-
Reindexing Catalog Search and Refreshing the Full Page Cache
-
After you change the Solr configuration, you must reindex the catalog search index and refresh the full page
- cache as follows:
-
-
In the Admin Panel, click System > Cache Management.
-
Select the checkbox next to Page Cache.
-
From the Actions list in the upper right, click Refresh.
- The following figure shows an example.
-
-
-
To update the catalog search index, open a command prompt window.
-
Change to the shell subdirectory of your Magento installation directory.
- For example, on CentOS:
-
cd /var/www/html/magento/shell
-
-
Enter the following command:
-
php indexer.php --reindex catalogsearch_fulltext
-
-
-
Scripting Solr Startup and Shutdown
-
In a production environment, you should start and stop Solr using a script.
-
Note: You must perform all tasks discussed in this section as a user with root privileges.
-
Create a script named /etc/init.d/solr with options similar to the following:
You must know the App Code for your Magento MobileConnect application.
- To view the code, log in to the Admin Panel as an administrator and click MobileConnect > Manage Apps. You must know the value displayed in the App Code column.
-
-
-
Creating the iOS App
-
To create the iOS app:
-
Open MagentoShop/MagentoShop.xcodeproj in Xcode.
-
Locate Configuration.plist.
-
Change the value of serverURL to your store's base URL (for example, http://mystore.example.com).
-
Change the value of applicationCode to the application code displayed in the Magento Admin Panel.
- To view the code, log in to the Admin Panel as an administrator and click MobileConnect > Manage Apps. Enter the value displayed in the App Code column.
-
Build and run your app.
-
-
Customizing Your iOS App
-
The following sections discuss how you can customize your Magento MobileConnect iOS app.
-
-
Customizing the Launch Image
-
Launch images are located in MagentoShop/Resources/Images/LaunchImages.xcassets.
-
\ No newline at end of file
diff --git a/guides/m1x/other/payflow.html b/guides/m1x/other/payflow.html
deleted file mode 100644
index bcac4103f3..0000000000
--- a/guides/m1x/other/payflow.html
+++ /dev/null
@@ -1,13 +0,0 @@
----
-title: 'Error Using Payflow with Magento Enterprise Edition (EE) 1.12.0.2'
-layout: m1x
----
-
-
-
Problem
-
A customer applies a coupon code when checking out in a web store that runs EE 1.12.0.2 and is configured to use the Payflow Pro or Payflow Express payment methods. The following error displays:
-PayPal gateway rejected the request. Field format error: 10431-Item amount is invalid
-
-
Solution
-
To resolve this issue, contact Magento Support and request the patch for support issue ID SUPEE-1474.
Enable an attacker to execute arbitrary code on your Magento server.
-
Create files with a .csv extension, create writable directories, and change the permission of
- existing files to world-writable (777).
-
-
-
Note: The preceding exploits require the attacker to have administrative access to your Magento Admin Panel Dashboard. You can resolve these issues with the patch discussed in this article.
-
-
-
-
Creating files with a .csv extension can lead to executing files like php.csv (only under
- circumstances discussed in this article). The ability to run code with a .csv extension is dangerous
- itself and could be combined with other attacks; for example, targeting other software installed on the server.
-
Although Magento code is protected by a hash value, the possibility of a successful exploit cannot be eliminated
- because of the low entropy of the hash secret value.
-
We strongly recommend you to take precautions discussed in this article and apply a patch for your
- version of Magento Enterprise Edition or Community Edition.
-
-
Versions Affected
-
Magento software versions affected: The issue affects all shipping versions of Magento Community Edition
- (CE) and Enterprise Edition (EE).
-
Operating system versions affected:
-
-
CentOS 5.x and 6.x
-
RedHat Enterprise Linux 5.x and 6.x
-
-
-
Getting the Patch
-
The following table shows the patch you should get for your version of CE or EE.
Important: After applying your patch, Magento strongly recommends you evaluate your vulnerability and configure PHP as discussed in Resolving the Vulnerability.
-
-
-
Determining Your Vulnerability to the File System Attack
-
To determine if you're vulnerable to execution of PHP code with a non-PHP extension, search your web server
- configuration file for the following string:
-
AddHandler application/x-httpd-php .php
-
The Apache configuration file is typically /etc/httpd/conf/httpd.conf
-
To confirm you're vulnerable:
-
-
Create a file named test.php.csv anywhere in your web server's doocroot with the following
- contents:
-
<?php
-phpinfo()
-
-
In a web browser, display that page. (For example, http://www.example.com/path/test.php.csv
-
If your browser saves the file or prompts you to save the file instead of displaying it, your server is not
- vulnerable. You can ignore the rest of this article.
-
-
If a page similar to the following displays, your server is vulnerable. Continue with the next
- section.
-
-
-
-
Resolving the File System Vulnerability
-
Note: Magento strongly recommends you perform all tasks discussed in this section in a development or testing environment and not in a production environment.
-
-
-
-
To resolve this vulnerability, you must log in to the Magento server as a user with root privileges or
- as a user with permissions to change the web server configuration.
-
To resolve the vulnerability:
-
-
Comment out the directive in httpd.conf by preceding it with a pound sign (#) as follows:
-
- The regular expression in this setting matches .php only to the final extension in the file name,
- applying the handler only to PHP files and preventing PHP from executing.
-
This article lists patches that Magento Support has made available for Magento EE versions 1.10.1.0 and later. The patches themselves are available on the Magento EE support portal.
-
To get the patches:
-
Log in to http://magento.com with your Magento EE credentials.
-
Click Downloads in the left navigation.
-
In the right pane, expand Magento Enterprise Edition 1.x.
-
Expand Support Patches and Security Patches > Solr Search Engine patches.
Magento EE Solr Patch for EE 1.12.0.x (ID: SUPEE-111)
-
Magento EE Version(s) Affected
-
This fix affects Magento EE 1.12.0.0, 1.12.0.1, and 1.12.0.1
-
-
Issues Fixed in the Magento EE 1.12.0.x Patch
-
Using layered navigation filtering returns the wrong results. (For example, filtering by brand has no effect.)
-
Resolved an issue where search results don't display correctly after a Magento upgrade.
-
Catalog navigation works properly.
-
Products display as expected in categories if the products have a Date attribute with the option Used for Sorting in Product Listing> set to Yes. There are no exceptions in Magento logs after reindexing.
-
Corrected the sort order of products searched by SKU.
-
Search results of products with names and/or SKUs that contains numbers, letters, and a hyphen character (-) are as expected.
-
Resolved issues with search results for products in a locale other than en_US with numeric SKUs.
-
Resolved issues with Solr not returning product search results.
-
Search results no longer include products that are either Disabled or Out of Stock.
-
-
-
Installation Instructions
-
To install this fix:
-
Stop Solr if it's currently running.
-
Download the patch .sh and transfer it to your Magento installation root directory.
-For example, /var/www/html/magento.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh PATCH_SUPEE-111_EE_1.12.0.0_v6.sh
-Note: The patch version—indicated by _v6 in this example—is subject to change. The version you get might be different.
-A message such as the following displays to confirm the patch installed successfully:
-Patch was applied/reverted successfully.
-
To reapply ownership to the files changed by the patch:
-
Find the web server user: ps -o "user group command" -C httpd,apache2
-The value in the USER column is the web server username.
-Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
-
As the owner of the files in the Magento installation directory or as a user with root privileges, enter the following command from the Magento installation directory:
-chown -R web-server-user-name .
-For example, on Ubuntu where Apache usually runs as www-data, enter
-chown -R www-data .
-
-
Copy the updated configuration files from Magento to your Solr configuration directory.
-
Back up the files in your current Solr configuration directory.
-
Enter the following command:
-cp magento-install-root/lib/Apache/Solr/conf/* solr-config-dir
-For example, if Magento is installed in /var/www/magento and Solr configuration files are located in /etc/apache-solr-3.5.0/mysolrapp/solr/conf, enter
-cp /var/www/magento/lib/Apache/Solr/conf/* /etc/apache-solr-3.5.0/mysolrapp/solr/conf
-
-
Start Solr.
-
Log in to the Admin Panel as an administrator.
-
Click System > Cache Management.
-
Click Flush Magento Cache.
-
Click System > Configuration.
-
In the left navigation bar, from the CATALOG group, click Catalog.
-
In the right pane, expand Catalog Search.
-
From the Indexation Mode list, click Final Commit.
-This is the setting Magento recommends. For a description of the other options, see the Magento EE User Guide.
-
Click System > Index Management.
-
Click the Reindex Data link in the Catalog Search row.
-
Reindex other indexers if necessary.
-
-
Reverting the Patch
-
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
-
Change to your Magento installation directory.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh PATCH_SUPEE-111_EE_1.12.0.0_v6.sh -R
-
-
Troubleshooting
-
If you get an error when you run the patch, use the following suggestions:
-
Verify the patch is located in your Magento installation root directory.
-Ubuntu example: /var/www/magento
-CentOS example: /var/www/html/magento
-
Verify you're running the patch with sufficient privileges.
-Typically, this means running it as the web server user or as a user with root privileges.
Solr search displays expected results when products use an attribute set for Catalog Input Type for Store Owner configured for Price—and this attribute is used for sorting. The following error no longer displays after reindexing the catalog search index:
-SEVERE: org.apache.solr.common.SolrException: can not sort on multivalued field
-
Search results display in the order consistent with the setting for Catalog > Attributes > Manage Label > Options.
-
Search results display correctly if you use non-default attributes.
-
A product that uses an attribute name that has a trailing space displays in search results.
-
Resolved an issue that prevented products from displaying in the web store if Solr is enabled.
-
Products can be located using layered navigation if the products have attributes set for Use in Quick Search and/or Use in Advanced Search set to No.
-
Advanced search works properly when Solr is enabled.
-
Category permissions work properly when Solr is enabled.
-
Changing pricing, such as configuring a discount for an existing product, automatically re-indexes and displays the correct price in the web store.
-
Advanced search results display as expected after toggling the value of a Yes/No attribute.
-
A product displays in search results after changing the value of the product's Visibility setting to Catalog.
-
Quick search results display as expected when the value of maximum query length is null.
-
Searching for the value of a Yes/No attribute in a supported locale other than en_US works properly.
-
Resolved issues with incorrect attribute values being assigned to a configurable product.
-
Out of stock products display in the web store when Display Out of Stock Products is set to Yes.
-
Products display in advanced search if they have attributes of multiple select and drop-down.
-
Quick search works properly in store views with a locale other than English.
-
Cron job reindexing uses the specified indexation mode for the catalog search index.
-
Simple products that are configured as part of a grouped product display in search results for the simple product's SKU.
-
A product's price attribute displays in layered navigation when Solr is enabled.
-
Resolves an issue with attributes displaying in layered navigation as empty.
-
Catalog navigation works properly.
-
Resolved issues with Solr after upgrading to EE 1.11.1.0
-
Products display in categories after import.
-
-
-
Installation Instructions
-
To install this fix:
-
Stop Solr if it's currently running.
-
Download the patch .sh and transfer it to your Magento installation root directory.
-For example, /var/www/html/magento.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh PATCH_SUPEE-107_EE_1.11.1.0_v1.sh
-Note: The patch version—indicated by _v6 in this example—is subject to change. The version you get might be different.
-A message such as the following displays to confirm the patch installed successfully:
-Patch was applied/reverted successfully.
-
To reapply ownership to the files changed by the patch:
-
Find the web server user: ps -o "user group command" -C httpd,apache2
-The value in the USER column is the web server username.
-Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
-
As the owner of the files in the Magento installation directory or as a user with root privileges, enter the following command from the Magento installation directory:
-chown -R web-server-user-name .
-For example, on Ubuntu where Apache usually runs as www-data, enter
-chown -R www-data .
-
-
Copy the updated configuration files from Magento to your Solr configuration directory.
-
Back up the files in your current Solr configuration directory.
-
Enter the following command:
-cp magento-install-root/lib/Apache/Solr/conf/* solr-config-dir
-For example, if Magento is installed in /var/www/magento and Solr configuration files are located in /etc/apache-solr-3.5.0/mysolrapp/solr/conf, enter
-cp /var/www/magento/lib/Apache/Solr/conf/* /etc/apache-solr-3.5.0/mysolrapp/solr/conf
-
-
Start Solr.
-
Log in to the Admin Panel as an administrator.
-
Click System > Cache Management.
-
Click Flush Magento Cache.
-
Click System > Configuration.
-
In the left navigation bar, from the CATALOG group, click Catalog.
-
In the right pane, expand Catalog Search.
-
From the Indexation Mode list, click Final Commit.
-This is the setting Magento recommends. For a description of the other options, see the Magento EE User Guide.
-
Click System > Index Management.
-
Click the Reindex Data link in the Catalog Search row.
-
Reindex other indexers if necessary.
-
-
Reverting the Patch
-
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
-
Change to your Magento installation directory.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh PATCH_SUPEE-107_EE_1.11.1.0_v1.sh -R
-
-
Troubleshooting
-
If you get an error when you run the patch, use the following suggestions:
-
Verify the patch is located in your Magento installation root directory.
-Ubuntu example: /var/www/magento
-CentOS example: /var/www/html/magento
-
Verify you're running the patch with sufficient privileges.
-Typically, this means running it as the web server user or as a user with root privileges.
Magento EE Solr Patch for EE 1.11.0.x (ID: SUPEE-108)
-
Magento EE Version(s) Affected
-
This fix affects Magento EE 1.11.0.0, 1.11.0.1, and 1.11.0.2.
-
-
Issues Fixed in the Magento EE 1.11.0.x Patch
-
Solr does not display an anchor category if the layered navigation block is absent, such as when this block has been removed from the layout. Search results in this case are processed by the database, not by Solr.
-
Search results display correctly regardless of the order in which content blocks load.
-
Paginated search results display the total number of pages returned by a Solr search.
-
Search results display properly for all locales supported by the Magento configuration. (A supported locale is one for which you have uploaded translations.)
-
Reindexing using a cron job no longer causes PHP fatal errors.
-
You can now enable or disable search engine recommendations.
Solr search displays expected results when products use an attribute set for Catalog Input Type for Store Owner configured for Price—and this attribute is used for sorting. The following error no longer displays after reindexing the catalog search index:
-SEVERE: org.apache.solr.common.SolrException: can not sort on multivalued field
-
Reindexing performance has been improved.
-
Search results display in the order consistent with the setting for Catalog > Attributes > Manage Label > Options.
-
Search results display correctly if you use non-default attributes.
-
Products that use an attribute name that has a trailing space display in search results.
-
Resolved an issue that prevented products from displaying in the web store if Solr is enabled.
-
Advanced search works properly when Solr is enabled.
-
Category permissions work properly when Solr is enabled.
-
Changing pricing, such as configuring a discount for an existing product, automatically re-indexes and displays the correct price in the web store.
-
Advanced search results display as expected after toggling the value of a Yes/No attribute.
-
A product displays in search results after changing the value of the product's Visibility setting to Catalog.
-
Searching for the value of a Yes/No attribute in a supported locale other than en_US works properly.
-
Resolved issues with incorrect attribute values being assigned to a configurable product.
-
Out of stock products display in the web store when Display Out of Stock Products is set to Yes.
-(In the Admin Panel, click System > Configuration > CATALOG > Inventory > Stock Options.)
-
Products display in advanced search if they have attributes of multiple select and drop-down.
-
Quick search works properly in store views with a locale other than English.
-
Products can be located using layered navigation if the products have attributes set for Use in Quick Search and/or Use in Advanced Search set to No.
-
Quick search results display as expected when the value of maximum query length is null.
-(In the Admin Panel, click System > Configuration CATALOG > Catalog Search, value of Maximum Query Length.)
-
Cron job reindexing uses the specified indexation mode for the catalog search index.
-
Simple products that are configured as part of a grouped product display in search results for the simple product's SKU.
-
A product's price attribute displays in layered navigation when Solr is enabled.
-(Attribute is configured with Catalog Input Type for Store Owner set to Price and Use In Layered Navigation set to Filterable (with results).)
-
Products display as expected in categories if the products have a Date attribute with the option Used for Sorting in Product Listing set to Yes. There are no exceptions in Magento logs after reindexing.
-
Resolves an issue with attributes displaying in layered navigation as empty.
-
Resolved an issue where search results don't display correctly after a Magento upgrade.
-
Catalog navigation works properly.
-
Search results display correctly if products have attribute values set at the store view.
-
-
-
Installation Instructions
-
To install this fix:
-
Stop Solr if it's currently running.
-
Download the patch .sh and transfer it to your Magento installation root directory.
-For example, /var/www/html/magento.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh PATCH_SUPEE-108_EE_1.11.0.2_v1.sh
-Note: The patch version—indicated by _v1 in this example—is subject to change. The version you get might be different.
-A message such as the following displays to confirm the patch installed successfully:
-Patch was applied/reverted successfully.
-
To reapply ownership to the files changed by the patch:
-
Find the web server user: ps -o "user group command" -C httpd,apache2
-The value in the USER column is the web server username.
-Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
-
As the owner of the files in the Magento installation directory or as a user with root privileges, enter the following command from the Magento installation directory:
-chown -R web-server-user-name .
-For example, on Ubuntu where Apache usually runs as www-data, enter
-chown -R www-data .
-
-
Copy the updated configuration files from Magento to your Solr configuration directory.
-
Back up the files in your current Solr configuration directory.
-
Enter the following command:
-cp magento-install-root/lib/Apache/Solr/conf/* solr-config-dir
-For example, if Magento is installed in /var/www/magento and Solr configuration files are located in /etc/apache-solr-3.5.0/mysolrapp/solr/conf, enter
-cp /var/www/magento/lib/Apache/Solr/conf/* /etc/apache-solr-3.5.0/mysolrapp/solr/conf
-
-
Start Solr.
-
Log in to the Admin Panel as an administrator.
-
Click System > Cache Management.
-
Click Flush Magento Cache.
-
Click System > Configuration.
-
In the left navigation bar, from the CATALOG group, click Catalog.
-
In the right pane, expand Catalog Search.
-
From the Indexation Mode list, click Final Commit.
-This is the setting Magento recommends. For a description of the other options, see the Magento EE User Guide.
-
Click System > Index Management.
-
Click the Reindex Data link in the Catalog Search row.
-
Reindex other indexers if necessary.
-
-
Reverting the Patch
-
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
-
Change to your Magento installation directory.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh PATCH_SUPEE-108_EE_1.11.0.2_v1.sh -R
-
-
Troubleshooting
-
If you get an error when you run the patch, use the following suggestions:
-
Verify the patch is located in your Magento installation root directory.
-Ubuntu example: /var/www/magento
-CentOS example: /var/www/html/magento
-
Verify you're running the patch with sufficient privileges.
-Typically, this means running it as the web server user or as a user with root privileges.
Magento EE Solr Patch for EE 1.10.1.x (ID: SUPEE-110)
-
Magento EE Version(s) Affected
-
This fix affects Magento EE 1.10.1.0 and 1.10.1.1.
-
-
Issues Fixed in the Magento EE 1.10.1.x Patch
-
Solr does not display an anchor category if the layered navigation block is absent, such as when this block has been removed from the layout. Search results in this case are processed by the database, not by Solr.
-
Solr search results display correctly with different settings for an attribute set that uses Use In Layered Navigation set to Filterable (no results).
-In other words, if some products are assigned to a category that do not use that attribute set, they display correctly in Solr search results if there are products in other categories that do use the attribute set.
-
Catalog search reindexing has better performance.
-
Paginated search results display the total number of pages returned by a Solr search.
-
Search results display properly for all locales supported by the Magento configuration. (A supported locale is one for which you have uploaded translations.)
-
Search results properly detect the configured price navigation step calculation.
-(In the Admin Panel, click System > Configuration > CATALOG > Catalog > Layered Navigation. From the Price Navigation Step Calculation list, click Manual.
-
Search results display correctly if you use non-default attributes.
-
Relevancy and suggestions were improved.
-
Catalog navigation works properly.
-
When the user chooses to display all search results, the correct number of results display.
-
Search results include only products that are in stock.
-
-
Installation Instructions
-
To install this fix:
-
Download the patch .sh and transfer it to your Magento installation root directory.
-For example, /var/www/html/magento.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh PATCH_SUPEE-110_EE_1.10.1.1_v2.sh
-Note: The patch version—indicated by _v2 in this example—is subject to change. The version you get might be different.
-A message such as the following displays to confirm the patch installed successfully:
-Patch was applied/reverted successfully.
-
To reapply ownership to the files changed by the patch:
-
Find the web server user: ps -o "user group command" -C httpd,apache2
-The value in the USER column is the web server username.
-Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
-
As a user with root privileges, enter the following command from the Magento installation directory:
-chown -R web-server-user-name .
-For example, on Ubuntu where Apache usually runs as www-data, enter
-chown -R www-data .
-
-
If Solr is running, stop it.
-
Copy the updated configuration files from Magento to your Solr configuration directory.
-
Back up the files in your current Solr configuration directory.
-
Enter the following command:
-cp magento-install-root/lib/Apache/Solr/conf/* solr-config-dir
-For example, if Magento is installed in /var/www/magento and Solr configuration files are located in /etc/apache-solr-3.5.0/mysolrapp/solr/conf, enter
-cp /var/www/magento/lib/Apache/Solr/conf/* /etc/apache-solr-3.5.0/mysolrapp/solr/conf
-
-
Start Solr.
-
Log in to the Admin Panel as an administrator.
-
Click System > Cache Management.
-
Click Flush Magento Cache.
-
Click System > Configuration.
-
In the left navigation bar, from the CATALOG group, click Catalog.
-
In the right pane, expand Catalog Search.
-
From the Indexation Mode list, click Final Commit.
-This is the setting Magento recommends. For a description of the other options, see the Magento EE User Guide.
-
Click System > Index Management.
-
Click the Reindex Data link in the Catalog Search row.
-
Reindex other indexers if necessary.
-
-
Reverting the Patch
-
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
-
Change to your Magento installation directory.
-
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
-
sh PATCH_SUPEE-110_EE_1.10.1.1_v2.sh -R
-
-
Troubleshooting
-
If you get an error when you run the patch, use the following suggestions:
-
Verify the patch is located in your Magento installation root directory.
-Ubuntu example: /var/www/magento
-CentOS example: /var/www/html/magento
-
Verify you're running the patch with sufficient privileges.
-Typically, this means running it as the web server user or as a user with root privileges.
diff --git a/guides/m1x/system-requirements.md b/guides/m1x/system-requirements.md
deleted file mode 100644
index 7a03586066..0000000000
--- a/guides/m1x/system-requirements.md
+++ /dev/null
@@ -1,53 +0,0 @@
----
-layout: m1x
-title: System Requirements for Magento Enterprise Edition and Community Edition (Current Shipping Versions)
----
-
-Magento requires a LAMP or LNMP stack.
-
-#### Operating System
-
-Linux x86-64
-
-#### Web Server
-
-* Apache 2.x
-* Nginx 1.7.x
-
-#### Database
-
-* Magento EE 1.14.3 and later:
- * MySQL 5.7 (Oracle or Percona)
-* Earlier Magento versions:
- * MySQL 5.6 (Oracle or Percona)
-
-#### PHP
-
-* Magento EE 1.14.4.0 and later:
- * PHP 7.2.x
-* Magento CE 1.9.2 and later, Magento EE 1.14.2 - EE 1.14.3.10:
- * PHP 5.6.x
- * PHP 5.4.x
- * PHP 5.5.x
-* Earlier Magento versions:
- * PHP 5.4.x
- * PHP 5.5.x
-
-#### SSL
-
-* A valid security certificate is required for HTTPS.
-* Self-signed SSL certificates are not supported.
-
-#### Magento can utilize the following technologies:
-
-* [Redis]({{ site.baseurl }}/guides/m1x/ce18-ee113/using_redis.html)
-
- Redis can be used for session or cache storage
-
-* [Memcached]({{ site.baseurl }}/guides/v2.2/config-guide/memcache/memcache.html)
-
- memcached can be used for session or cache storage
-
-* Apache Solr
-
- [Solr search](http://merch.docs.magento.com/ee/user_guide/search_seo/search-configuration-solr.html) can be used as a search provider for Magento Enterprise Edition (EE) only
\ No newline at end of file
diff --git a/guides/m1x/.gitignore b/guides/v1.8/.gitignore
similarity index 100%
rename from guides/m1x/.gitignore
rename to guides/v1.8/.gitignore
diff --git a/guides/m1x/LICENSE.txt b/guides/v1.8/LICENSE.txt
similarity index 100%
rename from guides/m1x/LICENSE.txt
rename to guides/v1.8/LICENSE.txt
diff --git a/guides/v1.8/api/rest-api-index.html b/guides/v1.8/api/rest-api-index.html
new file mode 100644
index 0000000000..4c6dd5f933
--- /dev/null
+++ b/guides/v1.8/api/rest-api-index.html
@@ -0,0 +1,46 @@
+---
+layout: v1x
+title: Magento 1.9.x REST API
+guide_version: '1.9.x'
+---
+
+
\ No newline at end of file
diff --git a/guides/v1.8/api/rest/Resources/Orders/order_addresses.html b/guides/v1.8/api/rest/Resources/Orders/order_addresses.html
new file mode 100644
index 0000000000..3eb7895a20
--- /dev/null
+++ b/guides/v1.8/api/rest/Resources/Orders/order_addresses.html
@@ -0,0 +1,288 @@
+---
+layout: v1x_rest
+title: Order Addresses
+---
+
+
+
Description: Allows you to retrieve information on billing and shipping addresses from the required order.
+Notes: Customers can retrieve addresses only from their orders.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/32/addresses
Description: Allows you to retrieve information on the order billing address.
+Notes: Customers can retrieve information on billing addresses only from their own orders.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/32/addresses/billing
Description: Allows you to retrieve information on the order shipping address.
+Notes: Customers can retrieve information on shipping addresses only from their own orders.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/32/addresses/shipping
Description: Allows you to retrieve information about comments of the required order.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/33/comments
+
+
Response Body:
+
+
+
+
<?xml version="1.0"?>
+<magento_api>
+ <data_item>
+ <created_at>2012-03-09 11:20:49</created_at>
+ <comment></comment>
+ <is_customer_notified>1</is_customer_notified>
+ <is_visible_on_front>0</is_visible_on_front>
+ <status>pending</status>
+ </data_item>
+ <data_item>
+ <created_at>2012-03-09 11:21:32</created_at>
+ <comment>This is a new order for John Doe.</comment>
+ <is_customer_notified>1</is_customer_notified>
+ <is_visible_on_front>1</is_visible_on_front>
+ <status>pending</status>
+ </data_item>
+</magento_api>
+
+
+
+
+
+
Authentication: Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/33/comments
+
+
Response Body:
+
+
+
+
<?xml version="1.0"?>
+<magento_api>
+ <data_item>
+ <created_at>2012-03-09 11:21:32</created_at>
+ <comment>This is a new order for John Doe.</comment>
+ </data_item>
+</magento_api>
+
+
+
+
+
+
HTTP Method: POST
+
+
Description: Not allowed.
+
+
HTTP Method: PUT
+
+
Description: Not allowed.
+
+
HTTP Method: DELETE
+
+
Description: Not allowed.
+
+
+
+
Order Comments Attributes
+
+
+
+
+
Attribute Name
+
Attribute Description
+
Notes
+
+
+
Comment Date
+
Date when the comment was added
+
Admin and Customer
+
+
+
Comment Text
+
Comment text
+
Admin and Customer
+
+
+
Is Customer Notified
+
Defines whether the customer is notified about the comment. Can have the following values: 0 - Customer is not notified, 1 - Customer is notified.
+
Admin only
+
+
+
Is Comment Visible on Frontend
+
Defines whether the comment is visible on the frontend. Can have the following values: 0 - Comment is not visible, 1 - Comment is visible.
Description: Allows you to retrieve the list of existing order items with detailed items information.
+Notes: The list of attributes that will be returned for order items is configured in the Magento Admin Panel.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to retrieve the list of existing orders. Each order contains the following information: general order information, information on ordered items, order comments, and order addresses (both billing and shipping).
+The list of attributes that will be returned for the order is configured in the Magento Admin Panel.
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
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.
Description: Allows you to retrieve information about all images of a specified product.
+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.
+
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
+Parameters:
+No Parameters
Note: If the file_name parameter is not defined, the original file name is set for the image. The first created image will be called "image", the second created image will be called "image_2", etc.
+
+
Example:
+
+
POST http://magentohost/api/rest/products/1/images
Description: Allows you to retrieve information about product images for a specified store view.
+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.
+
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/products/8/images/store/2
Description: Allows you to add an image for the required product with image settings for a specific store.
+Notes: The image is added on the Global level; specified image parameters are set for a specific store.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example Value
+
+
+
file_mime_type
+
File mime type. Can have the following values: image/jpeg, image/png, etc.
Note: If the file_name parameter is not defined, the original file name is set for the image. The first created image will be called "image", the second created image will be called "image_2", etc.
+
+
Example:
+
+
POST http://magentohost/api/rest/products/8/images/store/3
Description: Allows you to retrieve information about a specified product image.
+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.
+
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/products/8/images/7
Description: Allows you to update information for the specified product image.
+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.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example
+
+
+
exclude
+
Defines whether the image will associate only to one of the three image types.
+
optional
+
int
+
0
+
+
+
file_content
+
Image file content (base_64 encoded).
+
optional
+
string
+
base_64 encoded file content
+
+
+
file_mime_type
+
File mime type. Can have the following values: image/jpeg, image/png, etc.
+
optional
+
string
+
image/png
+
+
+
file_name
+
Image file name.
+
optional
+
string
+
test name
+
+
+
label
+
A label that will be displayed on the frontend when pointing to the image
+
optional
+
string
+
test label
+
+
+
position
+
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
+
optional
+
int
+
1
+
+
+
types
+
Array of image types. Can have the following values: image, small_image, and thumbnail.
+
optional
+
array
+
thumbnail
+
+
+
+
+
+
+
Example:
+
+
PUT http://magentohost/api/rest/products/8/images/7
Description: Allows you to remove the specified image from a product.
+Notes: The image will not be deleted physically, the image parameters will be set to No Image.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to retrieve information about the specified product image from a specified store.
+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.
+
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/products/8/images/7/store/3
Description: Allows you to update the specified product image information for s specified store.
+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.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example
+
+
+
exclude
+
Defines whether the image will associate only to one of the three image types.
+
optional
+
int
+
0
+
+
+
file_content
+
Image file content (base_64 encoded).
+
optional
+
string
+
base_64 encoded file content
+
+
+
file_mime_type
+
File mime type. Can have the following values: image/jpeg, image/png, etc.
+
optional
+
string
+
image/png
+
+
+
file_name
+
Image file name.
+
optional
+
string
+
test name
+
+
+
label
+
A label that will be displayed on the frontend when pointing to the image
+
optional
+
string
+
test label
+
+
+
position
+
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
+
optional
+
int
+
1
+
+
+
types
+
Array of image types. Can have the following values: image, small_image, and thumbnail.
+
optional
+
array
+
thumbnail
+
+
+
+
+
+
+
Example:
+
+
PUT http://magentohost/api/rest/products/8/images/7/store/3
+
+
Request Body:
+
+
+
+
<?xml version="1.0"?>
+<magento_api>
+Â <position>3</position>
+Â <exclude>0</exclude>
+Â <types>
+Â Â Â <data_item>image</data_item>
+Â Â </types>
+</magento_api>
+
+
+
+
+
+
+
HTTP Method: DELETE
+
+
Description: Allows you to remove an image from the required product in the specified store.
+Notes: The image will not be deleted physically, the image parameters will be set to No Image for the current store.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
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.
Description: Allows you to assign a website and copy product data from the attached store to the one being attached. Only product data that is set on the Store View level is copied. All other data set on the Website or Global levels is not copied.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example Value
+
+
+
website_id
+
The website ID
+
required
+
int
+
2
+
+
+
store_from
+
The store ID from which data will be copied
+
required
+
int
+
1
+
+
+
store_to
+
The store ID to which data will be copied
+
required
+
int
+
2
+
+
+
+
+
Notes: The store_to parameter must belong to the website which we want to assign to a product.
+
+
Example:
+
+
POST http://magentohost/api/rest/products/8/websites
Multi-Website Assignment with Product Data Copying
+
+
Description: Allows you to assign multiple websites to a product together with copying product data from the attached store to the one being attached. Only product data that is set on the Store View level is copied. All other data set on the Website or Global levels is not copied.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example Value
+
+
+
website_id
+
The website ID
+
required
+
int
+
2
+
+
+
store_from
+
The store ID from which data will be copied
+
required
+
int
+
1
+
+
+
store_to
+
The store ID to which data will be copied
+
required
+
int
+
2
+
+
+
+
+
Example:
+
+
POST http://magentohost/api/rest/products/8/websites
Description: Allows you to retrieve the list of all products with detailed information.
+Notes: The list of attributes that will be returned in the response is configured in the Magento Admin Panel. The list of attributes differs for each type of user.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to retrieve the list of products of a specified category. These products will be returned in the product position ascending order.
+
+
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
Description: Allows you to retrieve information on a required simple product.
+Notes: The list of attributes that will be returned in the response is configured in the Magento Admin Panel. The list of attributes differs for each type of user.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to delete an existing product.
+
+
+
Authentication: Admin
+Default Format: JSON
+Parameters: no parameters
+Request Example:
+
+
DELETE http://magentohost/api/rest/products/1
+
+
+
+
+
Possible HTTP Status Codes
+
+
+
+
+
Status Code
+
Message
+
Description
+
+
+
404
+
Resource not found.
+
The required resource is not found.
+
+
+
405
+
Resource method not implemented yet.
+
The required method is not implemented yet.
+
+
+
405
+
Resource does not support method.
+
The current resource does not support the specified method.
+
+
+
+
+
+
diff --git a/guides/v1.8/api/rest/Resources/get_filters.html b/guides/v1.8/api/rest/Resources/get_filters.html
new file mode 100644
index 0000000000..0d3eb94a88
--- /dev/null
+++ b/guides/v1.8/api/rest/Resources/get_filters.html
@@ -0,0 +1,71 @@
+---
+layout: v1x_rest
+title: GET Filters
+---
+
Some requests use GET parameters in the URL. These are as follows:
+
+
+
filter - specifies the filters for returned data
+
page - specifies the page number which items will be returned
+
+
e.g., http://magentohost/api/rest/products?page=1
+
+
+
order, dir - specifies the sort order of returned items and the order direction: 'asc' - returns items in the ascending order; 'dsc' - returns items in the descending order.
+
limit - limits the number of returned items in the response. Note that by default, 10 items are returned in the response. The maximum number is 100 items.
+
+ Important: The default response for all APIs is JSON; however, this page currently uses mostly XML examples. We don't maintain this documentation much anymore so if you'd like to contribute some JSON, we'll acknowledge your help on this page. Edit this page on GitHub if you can help us out.
+
+
+
REST API: Stock Items
+
+
URI: /stockitems
+
+
Allows you to manage existing stock items. Inventory management is available only for Admin.
Description: Allows you to retrieve the list of existing stock items.
+ Notes: The list of attributes that will be returned for stock items is configured in the Magento Admin Panel.
+
Description: Allows you to update existing stock items.
+
+
+
Authentication: Admin
+ Default Format: JSON
+
+
Notes: The Content-Type: text/xml parameter must be added to the request header.
+
+
Parameters:
+
+
+
+
+
Name
+
Description
+
Type
+
Example Value
+
+
+
item_id
+
Item ID
+
int
+
1
+
+
+
product_id
+
Product ID
+
int
+
1
+
+
+
stock_id
+
Stock ID
+
int
+
1
+
+
+
qty
+
Quantity of stock items for the current product
+
string
+
20
+
+
+
min_qty
+
Quantity for stock items to become out of stock
+
string
+
0
+
+
+
use_config_min_qty
+
Choose whether the Config settings will be applied for the Qty for Item's Status to Become Out of Stock
+ option
+
+
int
+
1
+
+
+
is_qty_decimal
+
Choose whether the product can be sold using decimals (e.g., you can buy 2.5 product)
+
int
+
0
+
+
+
backorders
+
The customer can place the order for products that are out of stock at the moment (0 - No Backorders, 1 -
+ Allow Qty Below 0, and 2 - Allow Qty Below 0 and Notify Customer)
+
+
int
+
0
+
+
+
use_config_backorders
+
Choose whether the Config settings will be applied for the Backorders option
+
int
+
1
+
+
+
min_sale_qty
+
Minimum number of items in the shopping cart to be sold
+
string
+
10
+
+
+
use_config_min_sale_qty
+
Choose whether the Config settings will be applied for the Minimum Qty Allowed in Shopping Cart option
+
int
+
0
+
+
+
max_sale_qty
+
Maximum number of items in the shopping cart to be sold
+
string
+
100
+
+
+
use_config_max_sale_qty
+
Choose whether the Config settings will be applied for the Maximum Qty Allowed in Shopping Cart option
+
int
+
0
+
+
+
is_in_stock
+
Defines whether the product is available for selling (0 - Out of Stock, 1 - In Stock)
+
int
+
1
+
+
+
low_stock_date
+
Date when the number of stock items became lower than the number defined in the Notify for Quantity Below
+ option
+
+
string
+
2012-02-24 12:37:51
+
+
+
notify_stock_qty
+
The number of inventory items below which the customer will be notified via the RSS feed
+
string
+
10
+
+
+
use_config_notify_stock_qty
+
Choose whether the Config settings will be applied for the Notify for Quantity Below option
+
int
+
0
+
+
+
manage_stock
+
Choose whether to view and specify the product quantity and availability and whether the product is in
+ stock management( 0 - No, 1 - Yes)
+
+
int
+
0
+
+
+
use_config_manage_stock
+
Choose whether the Config settings will be applied for the Manage Stock option
+
int
+
1
+
+
+
stock_status_changed_auto
+
Defines whether products can be automatically returned to stock when the refund for an order is created
+
+
int
+
0
+
+
+
use_config_qty_increments
+
Choose whether the Config settings will be applied for the Enable Qty Increments option
+
int
+
1
+
+
+
qty_increments
+
The product quantity increment value
+
string
+
5
+
+
+
use_config_enable_qty_inc
+
Choose whether the Config settings will be applied for the Qty Increments option
+
int
+
1
+
+
+
enable_qty_increments
+
Defines whether the customer can add products only in increments to the shopping cart
+
int
+
0
+
+
+
is_decimal_divided
+
Defines whether the stock items can be divided into multiple boxes for shipping.
Allows you to update, delete, or retrieve information on a single stock item.
+ Notes: The list of attributes that will be returned for stock items is configured in the Magento Admin Panel.
+
Description: Allows you to update existing stock item data.
+ Notes: The Content-Type: text/xml parameter must be added to the request header.
+ Authentication: Admin
+ Default Format: JSON
+ Parameters:
+ Enter only those parameters which you want to update.
Description: Not allowed. The DELETE method is not allowed because you cannot delete a stock item. The
+ required stock item is deleted together with the product which it is associated to.
+
+
+
Possible HTTP Status Codes:
+
+
+
+
+
Error Code
+
Error Message
+
Error Description
+
+
+
200
+
Resource updated successful.
+
The required resource was successfully updated.
+
+
+
404
+
Resource not found.
+
The required resource is not found or does not exist.
+
+
+
400
+
Empty value for <name of the parameter> in request.
+
Value is not defined for the specified parameter in the request body.
+
+
+
400
+
Invalid value for "item_id" in request.
+
The specified value for "item_id" is not valid.
+
+
+
400
+
Missing <name of the parameter> in request.
+
The specified parameter is missing in the request body.
+
+
+
500
+
Resource internal error.
+
Resource internal error.
+
+
+
+
+
+
diff --git a/guides/v1.8/api/rest/Resources/resource_customer_addresses.html b/guides/v1.8/api/rest/Resources/resource_customer_addresses.html
new file mode 100644
index 0000000000..7eefc0f53e
--- /dev/null
+++ b/guides/v1.8/api/rest/Resources/resource_customer_addresses.html
@@ -0,0 +1,510 @@
+---
+layout: v1x_rest
+title: Customer Addresses
+---
+
+JSON responses on this page contributed by Tim Reynolds
+
+
+
HTTP Method: GET /customers/:customer_id/addresses
+
+
Description: Allows you to retrieve the list of existing customer addresses.
+Notes: The list of attributes that will be returned for customer addresses is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses. Also, Admin can add additional non-system customer address attributes by selecting Customers > Attributes > Manage Customer Address Attributes (available only in Magento Enterprise Edition). If these attributes are set as visible on frontend, they will be returned in the response.
+
+
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/customers/1/addresses
Notes: If the customer has more than two street addresses, they will be returned in the following form: first address in the first string and all other addresses in the second string separated with a semicolon (like in the example above).
+
+
HTTP Method: POST /customers/:customer_id/addresses
+
+
Description: Allows you to create a new address for the required customer.
+Notes: The Customer user type can create addresses only for themselves.
+
+
When adding a street address for the customer, it should look like the following:
Description: Allows you to retrieve an existing customer address.
+Notes: The list of attributes that will be returned for customer address is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses. Also, Admin can add additional non-system customer address attributes by selecting Customers > Attributes > Manage Customer Address Attributes (available only in Magento Enterprise Edition). If these attributes are set as visible on frontend, they will be returned in the response.
+
+
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/customers/addresses/2
HTTP Method: POST /customers/addresses/:address_id
+
+
Description: Not allowed.
+
+
HTTP Method: PUT /customers/addresses/:address_id
+
+
Description: Allows you to update an existing customer address.
+Notes: The list of attributes that will be updated for customer address is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses.
+
+
If you want to add more addresses, it should look like the following:
+
+
+
+
<street>
+Â Â <data_item>street address 1</data_item>
+Â Â <data_item>street address 2</data_item>
+Â Â <data_item>street address 3</data_item>
+</street>
+
+
+
+
+
+
+
Authentication: Admin, Customer
+Default Format: XML
+
+
+
Example:
+
+
PUT http://magentohost/api/rest/customers/addresses/7
Description: Allows you to retrieve the list of existing customers.
+Notes:: Only Admin user can retrieve the list of customers with all their attributes.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to create a new customer.
+Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example Value
+
+
+
firstname
+
The customer first name
+
required
+
string
+
John
+
+
+
lastname
+
The customer last name
+
required
+
string
+
Doe
+
+
+
email
+
The customer email address
+
required
+
string
+
johny@example.com
+
+
+
password
+
The customer password. The password must contain minimum 7 characters
+
required
+
string
+
123123q
+
+
+
website_id
+
Website ID
+
required
+
int
+
1
+
+
+
group_id
+
Customer group ID
+
required
+
int
+
1
+
+
+
disable_auto_group_change
+
Defines whether the automatic group change for the customer will be disabled
+
optional
+
int
+
0
+
+
+
prefix
+
Customer prefix
+
optional
+
string
+
Mr.
+
+
+
middlename
+
Customer middle name or initial
+
optional
+
string
+
R.
+
+
+
suffix
+
Customer suffix
+
optional
+
string
+
Sr.
+
+
+
taxvat
+
Customer Tax or VAT number
+
optional
+
string
+
GB999 9999 73
+
+
+
+
+
Notes: The list of parameters may change depending on the attributes settings in Customers > Attributes > Manage Customer Attributes page in Magento Admin Panel. For example, a required status of the middlename attribute (Middle Name/Initial) may be changed to 'YES". Please note that managing customer attributes is available only in Magento Enterprise Edition.
Response:
+If the customer was created successfully, we receive Response HTTP Code = 200, empty Response Body and Location header like '/api/rest/customers/555' where '555' - an entity id of the new customer.
Description: Allows you to retrieve information on an existing customer.
+Notes:: The list of attributes that will be returned for customers is configured in the Magento Admin Panel. The Customer user type has access only to his/her own information. Also, Admin can add additional non-system customer attributes by selecting Customers > Attributes > Manage Customer Attributes. If these attributes are set as visible on frontend, they will be returned in the response. Also, custom attributes will be returned in the response only after the customer information is updated in the Magento Admin Panel or the specified custom attribute is updated via API (see the PUT method below). Please note that managing customer attributes is available only in Magento Enterprise Edition.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to update an existing customer.
+Notes: The list of attributes that will be updated for customer is configured in the Magento Admin Panel. The Customer user type has access only to his/her own information.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+You must specify only those parameters which you want to update. Parameters that are not defined in the request body will preserve the previous values. The website_id and created_in attributes are not allowed for updating.
The Magento REST API allows you to manage customers, customer addresses, sales orders, inventory, and products. REST API is organized into the following categories:
+
+
+
+
Products
+
+
Retrieve the list of products, create, update, delete a product.
In most cases, the third-party application must be authenticated to use the Magento API. But users never reveal their credentials to the application to preserve their privacy. So, the question is as follows: how is your application going to authenticate users if it does not know user credentials. OAuth is the solution.
+
+
Magento authentication is based on OAuth, an open standard for secure API authentication. OAuth is a token-passing mechanism that allows users to control which applications have access to their data without revealing their passwords or other credentials.
+
+
The OAuth concept lies in three basic elements that can be easily described in the following picture:
+
+
+
+
+
To learn more about OAuth, you can visit the official OAuth site.
+
+
+
Using OAuth
+
+
The current API supports OAuth 1.0a.
+
+
The OAuth authentication works by asking the user to authorize their application. When the user authorizes the application, the application can access that user protected resources by using an access token. This token will be used in each further request. Access tokens are long-lived and will not expire unless the user revokes access to the application.
+
+
OAuth is completely invisible for the site visitors.
+
+
Why Do You Need OAuth?
+
+
Magento uses OAuth to allow access to its data. You need to use OAuth if you want to use any of the following Magento APIs:
+
+
+
Products
+
Inventory
+
Orders
+
Customers
+
Customer Addresses
+
Categories
+and a lot more
+
+
+
+
+
OAuth Definitions
+
+
There are some definitions you need to get familiar with before you start using OAuth. These are as follows:
+
+
User - A customer who has an account with Magento and can use the services via the Magento API.
+
Consumer - A third-party application that uses OAuth to access the Magento API. This application must be registered in the Magento system to receive the Consumer Key and Consumer Secret.
+
Consumer Key - A value used by the Consumer to identify itself with Magento.
+
Consumer Secret - A secret used by the Consumer to guarantee the ownership of the Consumer Key. This value is not passed in requests.
+
Request Token - A value used by the Consumer to obtain authorization from the User (when needed). The Request Token is exchanged for an Access Token when permission is granted.
+
Access Token - A value used by the Consumer to call Magento APIs on behalf of the User.
+
+
+
+
+
OAuth Process
+
+
The OAuth process consists of several steps:
+
+
Getting an Unauthorized Request Token.
+
Requesting user authorization.
+
Getting an Access Token by exchanging the Request Token for it.
+
+
+
+
+
The application that requires access to data is known as the Consumer and Magento is the Service Provider.
+
+
+
Registering an Application
+
+
Before starting to make API requests, you need to register the application. After the registration, you will receive the Consumer Key that will identify you in Magento. Also, you will receive a Consumer Secret. This secret will be used when requesting for a Request Token.
+
+
You can register your application by selecting System > Web Services > REST - OAuth Consumers and clicking Add New in the Admin Panel.
+
+
When registering the application, you also need to define the callback URL, to which the user will be redirected after he/she successfully authorizes your application.
+
+
Authentication Endpoints
+
+
The authentication endpoints include the following ones:
+
+
+
/oauth/initiate - this endpoint is used for retrieving the Request Token.
+
/oauth/authorize - this endpoint is used for user authorization (Customer).
+
/admin/oauth_authorize - this endpoint is used for user authorization (Admin).
+
/oauth/token - this endpoint is used for retrieving the Access Token.
+
+
+
+
Also, the simple form can be used for authentication. To use a simple form, add the /simple endpoint to the authentication endpoint. For example: /oauth/authorize/simple
+
+
+
Getting an Unauthorized Request Token
+
+
The first step to authenticate the user is to retrieve a Request Token from Magento. This is a temporary token that will be exchanged for the Access Token.
+
+
+
+
+
+
Endpoint:
+
/oauth/initiate
+
+
+
Description:
+
The first step of authentication. Allows you to obtain the Request Token used for the rest of the authentication process.
The following request parameters should be present in the Authorization header:
+
+
oauth_callback - an URI to which the Service Provider will redirect the resource owner (user) after the authorization is complete.
+
oauth_consumer_key - the Consumer Key value, retrieved after the registration of the application.
+
oauth_nonce - a random value, uniquely generated by the application.
+
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
+
oauth_signature - a generated value (signature).
+
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
+
oauth_version - OAuth version.
+
+
+
+
User Authorization
+
+
The second step is to request user authorization. After receiving the Request Token from Magento, the application provides an authorization page to the user. The only required parameter for this step is the Request Token (oauth_token value) received from the previous step. The endpoint is followed by an oauth_token parameter with the value set to the oauth_token value.
+
+
After this, the user is asked to enter their credentials and authorize. When the user is granted the access, he/she is redirected to the URL specified in the oauth_callback parameter. This URL is followed by two parameters:
+
+
oauth_token - the Request Token value.
+
oauth_verifier - a verification code that is tied to the Request Token.
+
+
+
+
+
+
+
+
Endpoint:
+
/oauth/authorize
+
+
+
Description:
+
The second step of authentication. Without the user authorization in this step, it is impossible for your application to obtain an Access Token.
The final third authentication step. After the application access is authorized, the application needs to exchange the Request Token for an Access Token. For this step, you will need the Request Token (the oauth_token and oauth_token_secret values) and the oauth_verifier value from the previous step.
+
+
+
+
+
+
Endpoint:
+
/oauth/token
+
+
+
Description:
+
The third step of authentication. Getting an Access Token.
+
+
+
Method:
+
POST
+
+
+
Returns:
+
An access token and the corresponding access token secret, URL-encoded.
The following components should be present in the Authorization header:
+
+
oauth_consumer_key - the Consumer Key value provided after the registration of the application.
+
oauth_nonce - a random value, uniquely generated by the application.
+
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
+
oauth_signature - a generated value (signature).
+
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
+
oauth_token - the oauth_token value (Request Token) received from the previous steps.
+
oauth_verifier - the verification code that is tied to the Request Token.
+
oauth_version - OAuth version.
+
+
+
+
+
The response will contain the following response parameters:
+
+
oauth_token - the Access Token that provides access to protected resources.
+
oauth_token_secret - the secret that is associated with the Access Token.
+
+
+
+
+
+
OAuth Error Codes
+
+
When the third-party application performs invalid requests to Magento, the following errors related to OAuth can occur:
+
+
+
+
+
HTTP Code
+
Error Code
+
Text Representation
+
Description
+
+
+
400
+
1
+
version_rejected
+
This error is used when the oauth_version parameter does not correspond to the "1.0a" value.
+
+
+
400
+
2
+
parameter_absent
+
This error is used there is no required parameter in the request. The name of the missing parameter is specified additionally in the response.
+
+
+
400
+
3
+
parameter_rejected
+
This error is used when the type of the parameter or its value does not meet the protocol requirements (e.g., array is passed instead of the string).
+
+
+
400
+
4
+
timestamp_refused
+
This error is used if there is incorrect value of the timestamp in the oauth_timestamp parameter.
+
+
+
401
+
5
+
nonce_used
+
This error is used if the nonce-timestamp combination has already been used.
+
+
+
400
+
6
+
signature_method_rejected
+
This error is used for unsupported signature method. The following methods are supported: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
+
+
+
401
+
7
+
signature_invalid
+
This error is used if the signature is invalid.
+
+
+
401
+
8
+
consumer_key_rejected
+
This error is used if the Consumer Key has incorrect length or does not exist.
+
+
+
401
+
9
+
token_used
+
This error is used if there is an attempt of authorization of an already authorized token or an attempt to exchange a not temporary token for a permanent one.
+
+
+
401
+
10
+
token_expired
+
This error is used if the temporary token has expired. At the moment, the mechanism of expiration of temporary tokens is not implemented and the current error is not used.
+
+
+
401
+
11
+
token_revoked
+
This error is used if the token is revoked by the user who authorized it.
+
+
+
401
+
12
+
token_rejected
+
This error is used if the token is not valid, or does not exist, or is not valid for using in the current type of request.
+
+
+
401
+
13
+
verifier_invalid
+
This error is used if the confirmation string does not correspond to the token.
+
+
+
+
+
+
+
PHP Examples
+
+
Retrieve the list of products for Admin user with OAuth authentication
Before starting to use OAuth, you need to perform several steps in the Magento Admin Panel. These steps allow you to enable the OAuth functionality for further actions.
+
+
Working with Consumers
+
+
Adding a New Consumer
+
+
First, you need to create a Consumer in the Admin Panel. Creating a new consumer means registering the application. To do this, perform the following steps:
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
+
On the OAuth Consumers page, click Add New in the top right corner to add a new consumer.
+
The New Consumer page opens. The Key and Secret fields are filled automatically and cannot be edited. These values are generated automatically and will be used to identify the Consumer in Magento.
+
+
Fill in the following fields:
+
+
Name: Enter the name of the application to be registered. This field is required.
+
Callback URL: Enter the URL address to which the Consumer will be redirected after the authorization is passed successfully. This URL address implies the path to the application. This field is optional.
+
Rejected Callback URL: Enter the URL address to which the user will be redirected if he/she rejects authorization. This field is optional.
+
+
+
Click Save in the top right corner to save the created Consumer.
+
+
+
+
Editing an Existing Consumer
+
+
To edit an existing consumer, perform the following steps:
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
+
The OAuth Consumers page opens. In the grid, select the consumer to be edited and click it.
+
The Edit Consumer page opens. On this page, you can edit the following fields:
+
+
Name: Enter a new name for the application.
+
Callback URL: Enter a new URL address to which the user will be redirected after successful authorization. This URL address implies the path to the application.
+
Rejected Callback URL: Enter another URL address to which the user will be redirected after he/she rejects authorization proceeding.
+
The Key and Secret fields cannot be edited.
+
+
+
Click Save in the top right corner to save changes.
+
+
+
+
Deleting an Existing Consumer
+
+
To delete the required consumer, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
+
The OAuth Consumers page opens. In the grid, select the consumer to be deleted and click it.
+
The Edit Consumer page opens. Click Delete in the top right corner to delete the selected consumer.
+
+
+
+
Searching for a Consumer
+
+
You can search for a required consumer by several parameters: ID, consumer name, and date of creation.
+To search for a consumer, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
+
The OAuth Consumers page opens. The list of consumers is displayed in a grid with the following fields: ID, Consumer Name, and Created At.
+
In the search field below the column header in a grid, enter the required value by which the search will be performed. Click Search in the top right corner.
+
+
+
+
+
Working with Tokens (Admin Panel)
+
+
Viewing Authorized Tokens
+
+
To view authorized tokens in the Admin panel, perform the following steps:
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Authorized Tokens.
+
The Authorized OAuth Tokens page opens. In the grid, the list of all authorized tokens is displayed.
+
Tokens are displayed in the grid with the following columns: ID, Application Name (name of consumer for which the token is created), User Type (type of the user, Customer or Admin), User ID, and the Revoked status.
+
+
+
+
From the Authorized OAuth Tokens page, you can enable, revoke, or delete the required token.
+
+
Viewing Applications
+
+
To view the list of applications, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - My Apps.
+
The My Applications page opens. Registered applications are displayed in a grid with the following columns: ID, Application Name, and Revoked.
+
+
+
+
+
Enabling Tokens
+
+
If a token is revoked (the Yes value in the Revoked column on the Authorized OAuth Tokens page), you can enable it. To do this, perform the following steps:
+
+
In the Authorized OAuth Tokens grid, select the token with the Revoked status set to Yes and select the checkbox next to it.
+
You can select more than one token with the Revoked status and enable all of them by using the mass action.
+
In the Actions drop-down list, select the Enable option and click Submit.
+
The required token is enabled.
+
+
+
+
Revoking Tokens
+
+
If a token is enabled (the No value in the Revoked column), you can revoke it. To do this, perform the following steps:
+
+
In the Authorized OAuth Tokens grid, select the token with the Revoked status set to No and select the checkbox next to it.
+
You can select more than one token with the Revoked status set to No and revoke all of them by using the mass action.
+
In the Actions drop-down list, select the Revoke option and click Submit.
+
The required token is revoked.
+
+
+
+
Deleting Tokens
+
+
To delete the required token, perform the following steps:
+
+
In the Authorized OAuth Tokens grid, select the token to be deleted and select the checkbox next to it.
+
You can select more than one token and delete all of them by using the mass action.
+
In the Actions drop-down list, select the Delete option and click Submit.
+
The required token is deleted.
+
+
+
+
+
Working with Tokens (Frontend)
+
+
Viewing Applications
+
+
To view the authorized applications from the frontend, perform the following steps:
+
+
+
On the frontend, click My Account and then select the My Applications tab on the left.
+
On the My Applications page, the list of registered applications will be displayed.
+
+
+
+
+
+
From this page, you can enable, revoke, or delete the required token.
+
+
Enabling Tokens
+
+
+
In the list of consumers, select the consumer to be enabled.
+
If the token is revoked, there will be the Disabled status next to it.
+
Click Enable next to the consumer name.
+
The token is enabled.
+
+
+
+
Disabling Tokens
+
+
+
In the list of consumers, select the consumer to be disabled.
+
If the token is enabled, there will be the Enabled status next to it.
+
Click Disable next to the consumer name.
+
The token is disabled.
+
+
+
+
Deleting Tokens
+
+
+
In the list of consumers, select the consumer to be deleted.
+
Click Delete next to the consumer name.
+
The token is deleted.
+
+
+
+
+
Working with Email Templates
+
+
Setting Up the Default Email Template
+
+
You can set the email template that will be used for user notification if the token status changes. Also, you can set different email templates for different store views. For example, you have two store views: English and German. Magento allows you to set one email template for the English store view and another one for the German store view.
+To set the email template, perform the following steps:
+
+
On the Admin Panel menu, select System > Configuration.
+
Select Services > OAuth on the left.
+
+
In the Email panel, from the Token Status Change Email Template drop-down list, select the required template and click Save Config in the top right corner.
+
The template is saved.
+
+
+
+
Creating a New Email Template
+
+
You can also create your own email template that will be used for user notification if the token status changes.
+To create a new template, perform the following steps:
+
+
On the Admin Panel menu, select System > Transactional Emails.
+
The Transactional Emails page opens. Click Add New Template in the top right corner.
+
The New Email template page opens. In the Load default template panel, in the Template drop-down list, select the Token Status Change option.
+
Specify the Locale option and click Load Template.
+
In the Template Information panel, the template data is loaded. You can specify your own template name, subject, and content.
+
When the email template is created, click Save Template in the top right corner.
+
Set the newly created template as it was described above.
+
+
+
+
Cleanup Configuration
+
+
You can configure the cleanup functionality for temporary tokens. These tokens can be deleted after a certain period of time or after a certain number of OAuth requests.
+To configure cleanup, perform the following steps:
+
+
On the Admin Panel menu, select System > Configuration.
+
Select Services > OAuth on the left.
+
+
In the Cleanup Statistics panel, you can set the following values:
+
+
Cleanup Probability: Define the threshold of OAuth requests after which the cleanup will be performed. Only temporary credentials will be removed. Enter 0 to disable the cleanup.
+
Expiration Period: Define the period (in minutes) on the expiry of which entries will be deleted from the database.
+
+
+
Click Save Config in the top right corner to save changes.
+
+
+
+
diff --git a/guides/v1.8/api/rest/common_http_status_codes.html b/guides/v1.8/api/rest/common_http_status_codes.html
new file mode 100644
index 0000000000..5718ca3153
--- /dev/null
+++ b/guides/v1.8/api/rest/common_http_status_codes.html
@@ -0,0 +1,101 @@
+---
+layout: v1x_rest
+title: Common HTTP Status Codes
+---
+
+
+
+
HTTP status codes are an essential part of the REST concept. You can get familiar with all of them on Wikipedia.
+
+
The Magento API attempts to return appropriate HTTP status codes for all requests. Any information is returned in the form of a standard HTTP response with an HTTP status code describing the error and the body message.
+
+
HTTP Status Codes
+
+
The following table contains possible common HTTP status codes:
+
+
+
+
Status Code
+
Message
+
+
+
200 OK
+
-
+
+
+
201 Created
+
Resource was partially created
+
+
+
+
207 Multi-Status
+
-
+
+
+
400 Bad Request
+
Resource data pre-validation error.
+Resource data invalid.
+Resource unknown error.
+The request data is invalid.
+Resource collection paging error.
+The paging limit exceeds the allowed number.
+Resource collection ordering error.
+Resource collection filtering error.
+Resource collection including additional attributes error.
+
+
+
403 Forbidden
+
Access denied.
+
+
+
404 Not Found
+
Resource not found.
+
+
+
405 Method Not Allowed
+
Resource does not support method.
+Resource method not implemented yet.
When the Magento API returns an error message, it returns it in your requested format. For example, an error in the XML format might look like the following:
An error in the JSON format might look like the following:
+
+
+
+
{"messages":{"error":[{"code":404,"message":"Resource not found."}]}}
+
+
+
+
+
diff --git a/guides/v1.8/api/rest/get_filters.html b/guides/v1.8/api/rest/get_filters.html
new file mode 100644
index 0000000000..2e576e2ddc
--- /dev/null
+++ b/guides/v1.8/api/rest/get_filters.html
@@ -0,0 +1,77 @@
+---
+layout: v1x_rest
+title: GET Filters
+---
+
+JSON responses on this page contributed by Tim Reynolds
+
+
Some requests use GET parameters in the URL. These are as follows:
+
+
+
filter - specifies the filters for returned data
+
page - specifies the page number which items will be returned
+
+
e.g., http://magentohost/api/rest/products?page=1
+
+
+
order, dir - specifies the sort order of returned items and the order direction: 'asc' - returns items in the ascending order; 'dsc' - returns items in the descending order.
+
limit - limits the number of returned items in the response. Note that by default, 10 items are returned in the response. The maximum number is 100 items.
+
Accessing API is performed via HTTP. When you enter a URL into a web browser address bar, the browser performs an HTTP GET request to the URL. This usually returns a web page in the form of an HTTP response that the browser displays. But the GET method is one of several HTTP request methods. Magento REST API uses the four main HTTP methods: GET, POST, PUT, and DELETE. The most widespread methods are GET and POST. The other methods are less known but they became widely known due to the popularity of REST web services. An important concept of the REST architecture is that different HTTP request methods perform different actions when applied to the same URL.
The HTTP GET method is defined in section 9.3 of the RFC2616 document:
+
+
+
The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the entity in the response and not the source text of the process, unless that text happens to be the output of the process.
+
You can retrieve a representation of a resource by getting its URL.
+
+
+
+
POST and PUT
+
+
Creating or Updating Resources with the HTTP POST and PUT Methods
+
+
The POST method is defined in section 9.5 of the RFC2616 document:
+
+
+
The POST method is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. POST is designed to allow a uniform method to cover the following functions:
+
+
+
Annotation of existing resources;
+
+
+
+
+
Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles;
+
+
+
+
+
Providing a block of data, such as the result of submitting a form, to a data-handling process;
+
+
+
+
+
Extending a database through an append operation.
+
+
+
+
+
+
The PUT method is defined in section 9.6 of the RFC2616 document:
+
+
The PUT method requests that the enclosed entity be stored under the supplied Request-URI. If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a modified version of the one residing on the origin server.
+
+
+
Creating or updating a resource involves performing an HTTP POST or HTTP PUT to a resource URL.
+
+
+
+
DELETE
+
+
Deleting Resources with the HTTP DELETE Method
+
+
The DELETE method is defined in section 9.7 of the RFC2616 document:
+
+
The DELETE method requests that the origin server delete the resource identified by the Request-URI. This method MAY be overridden by human intervention (or other means) on the origin server.
+
+
+
Deleting a resource is performed by means of making an HTTP DELETE request to the resource URL.
+
+
+
diff --git a/guides/v1.8/api/rest/introduction.html b/guides/v1.8/api/rest/introduction.html
new file mode 100644
index 0000000000..3b8d378e2f
--- /dev/null
+++ b/guides/v1.8/api/rest/introduction.html
@@ -0,0 +1,510 @@
+---
+layout: v1x_rest
+title: Introduction to the Magento 1.x REST API
+---
+
+
+
What is REST API? To make it simple, REST API defines a set of functions to which the developers can perform requests
+ and receive responses. The interaction is performed via the HTTP protocol. An advantage of such an approach is the
+ wide usage of HTTP. That is why REST API can be used practically for any programming language.
+
+
Common characteristics of Magento REST API resources are as follows: (magentohost is your domain)
+
+
+
You access the resource by sending an HTTP request to the Magento API server. The server replies with a response
+ that contains either the data you requested, or the status indicator, or even both.
All resources may return different HTTP status codes (e.g., HTTP Status Code 200 for success response or HTTP
+ Status Code 400 for the bad request).
+
You request a particular resource by adding a particular path to the base URL that specifies the resource.
+
+
+
+
Overall Capabilities
+
+
Magento REST API allows managing a number of features, namely:
+
+
+
Managing customers.
+
Managing customer addresses.
+
Managing products.
+
Retrieving sales orders.
+
Managing inventory.
+
+
+
+
+
Authentication
+
+
Magento REST API uses 3-legged OAuth 1.0a protocol to authenticate
+ the application to access the Magento service.
+
+
+
Output Formats
+
+
The REST API supports the response in two formats, which are XML and JSON.
+
+
HTTP Verbs
+
+
HTTP verbs are used to manage the state of resources. In Magento REST API, there are four verbs used to manage
+ resources: GET, POST, PUT, and DELETE. You can get the contents of the data using HTTP GET, delete the data using
+ HTTP DELETE, and create or update the data using POST/PUT.
+
+
Request Structure
+
+
All URLs in REST API have the following base URL.
+
+
http://magentohost/api/rest/
+
+
+
Example
+
+
Supposing, you want to retrieve the list of customers from Magento. To do this, you need to use the GET HTTP method.
+ The GET request to retrieve the list of customers will look as follows:
+
+
+
+
http://magentohost/api/rest/customers
+
+
+
+
where
+
+
+
http://magentohost/api/rest/ - endpoint
+
/customers - action URL
+
+
+
+
REST Resources
+
+
The Magento REST API allows you to manage customers, customer addresses, sales orders, inventory, and products. REST
+ API is organized into the following categories:
+
+
Products
+
+
+
Retrieve the list of products, create, update, and delete a product.
+ Resource Structure: http://magentohost/api/rest/products
+
+
+
+
Product Categories
+
+
+
Retrieve the list of categories assigned to a product, assign, and unassign the category to/from the specific
+ product.
+ Resource Structure: http://magentohost/api/rest/products/:productId/categories
+
+
+
+
Product Images
+
+
+
Retrieve the list of images assigned to a product, add, update, and remove an image to/from the specific
+ product.
+ Resource Structure: http://magentohost/api/rest/products/:productId/images
+
+
+
+
Product Websites
+
+
+
Retrieve the list of websites assigned to a product, assign, and unassign a website to/from the specific
+ product.
+ Resource Structure: http://magentohost/api/rest/products/:productId/websites
+
+
+
+
Customers
+
+
+
Retrieve the list of customers, create, delete a customer, and update the customer information.
+ Resource Structure: http://magentohost/api/rest/customers
+
+
+
+
Customer Addresses
+
+
+
Retrieve the list of customer addresses, create, update, and delete the customer address.
+ Resource Structure: http://magentohost/api/rest/customers/:customerId/addresses
+
+
+
+
Inventory
+
+
+
Retrieve the list of stock items and update required stock items.
+ Resource Structure: http://magentohost/api/rest/stockitems
+
+
+
+
Sales Orders
+
+
+
Retrieve the list of sales orders as well as the specific order information.
+ Resource Structure: http://magentohost/api/rest/orders
+
+
+
+
Order Items
+
+
+
Retrieve order items for the specific order.
+ Resource Structure: http://magentohost/api/rest/orders/:orderId/items
+
+
+
+
Order Addresses
+
+
+
Retrieve information on order billing and shipping addresses for the specific order.
+ Resource Structure: http://magentohost/api/rest/orders/:orderid/addresses
+
+
+
+
Order Comments
+
+
+
Retrieve order comments for the specific order
+ Resource Structure: http://magentohost/api/rest/orders/:orderid/comments
+
+
+
+
Preparing for REST API
+
+
These steps are required for utilizing REST API resources:
+
+
+
Set up permissions for REST resource operations from Magento Admin Panel.
+
Configure the attributes for different users types in Magento Admin Panel. There are 3 different types of users
+ in accessing the data: Admin, Customer, and Guest. Admin is the backend logged in user, Customer is the fronted
+ logged in user, and Guest is a non-logged in fronted user.
+
+
+
+
Preparing REST API for the Third-Party
+ Application
+
+
+
Register the third-party application (Consumer) in Magento Admin Panel.
+
The third-party application will utilize the provided consumer credentials to call Magento store for getting the
+ access token to access the data.
+
+
+
+
+
+
PHP Examples
+
+
+
Create a simple product
+ as an Admin user with OAuth authentication
+
+
+
+
+
<?php
+/**
+* Example of simple product POST using Admin account via Magento REST API. OAuth authorization is used.
+*
+* This file is a stand-alone OAuth client PHP file, which handles everything with the OAuth three-legged authentication.
+* It uses PHP session to persist the current authentication state (step), the OAuth request token with its secret
+* and the OAuth access token with its secret.
+*
+* Create this file oauth_admin.php in your Magento 1.x instance root folder to run this oauth authentication example.
+*
+* oauth_admin.php
+*
+*/
+
+$callbackUrl = "http://yourhost/oauth_admin.php";
+$temporaryCredentialsRequestUrl = "http://magentohost/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
+$adminAuthorizationUrl = 'http://magentohost/admin/oauth_authorize';
+$accessTokenRequestUrl = 'http://magentohost/oauth/token';
+$apiUrl = 'http://magentohost/api/rest';
+$consumerKey = 'yourconsumerkey';
+$consumerSecret = 'yourconsumersecret';
+
+session_start();
+if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
+ $_SESSION['state'] = 0;
+}
+try {
+ $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
+ $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
+ $oauthClient->enableDebug();
+
+ if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
+ // step 1 (state 1) - Get the initial temporary request token.
+ $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
+
+ // persist the request token secret in the session variable for step 3 to get the access token and secret.
+ $_SESSION['secret'] = $requestToken['oauth_token_secret'];
+ $_SESSION['state'] = 1;
+
+ // step 2 (state 2) - redirect to the Oauth admin authorization url to validate and confirm / reject the admin Oauth authorization request.
+ // variable $requestToken['oauth_token'] has the temporary request token
+ header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
+ exit;
+ } elseif ($_SESSION['state'] == 1) {
+ //step 3 (state 3) Exchange the temporary request token and secret to get the final access token and secret.
+ $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
+ $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
+
+ // persist the access token and its secret in the session variable
+ $_SESSION['state'] = 2;
+ $_SESSION['token'] = $accessToken['oauth_token'];
+ $_SESSION['secret'] = $accessToken['oauth_token_secret'];
+
+ // redirect back to the callback url which is the same file
+ header('Location: ' . $callbackUrl);
+ exit;
+ } else {
+
+ // send a POST request to create a simple product
+ $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
+ $resourceUrl = "$apiUrl/products";
+ $productData = json_encode(array(
+ 'type_id' => 'simple',
+ 'attribute_set_id' => 4,
+ 'sku' => 'simple' . uniqid(),
+ 'weight' => 1,
+ 'status' => 1,
+ 'visibility' => 4,
+ 'name' => 'Simple Product',
+ 'description' => 'Simple Description',
+ 'short_description' => 'Simple Short Description',
+ 'price' => 99.95,
+ 'tax_class_id' => 0,
+ ));
+ $headers = array('Content-Type' => 'application/json');
+ $oauthClient->fetch($resourceUrl, $productData, OAUTH_HTTP_METHOD_POST, $headers);
+ print_r($oauthClient->getLastResponseInfo());
+ }
+} catch (OAuthException $e) {
+ print_r($e);
+}
+
+
+
+
+
Retrieve the list
+ of products as a Customer user with OAuth authentication
+
+
+
+
+
<?php
+/**
+* Example of products list retrieve using Customer account via Magento REST API. OAuth authorization is used
+*
+* This file is a stand-alone Oauth client PHP file, which handles everything with the Oauth three-legged authentication.
+* It uses PHP session to persist the current authentication state (step), the oauth request token with its secret
+* and the oauth access token with its secret.
+*
+* Create this file oauth_customer in your Magento 1.x instance root folder to run this oauth authentication example.
+*
+* oauth_customer.php
+*
+*/
+$callbackUrl = "http://yourhost/oauth_customer.php";
+$temporaryCredentialsRequestUrl = "http://magentohost/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
+$adminAuthorizationUrl = 'http://magentohost/oauth/authorize';
+$accessTokenRequestUrl = 'http://magentohost/oauth/token';
+$apiUrl = 'http://magentohost/api/rest';
+$consumerKey = 'yourconsumerkey';
+$consumerSecret = 'yourconsumersecret';
+
+session_start();
+if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
+ $_SESSION['state'] = 0;
+}
+try {
+ $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
+ $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
+ $oauthClient->enableDebug();
+
+ if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
+ // step 1 (state 1) - Get the initial temporary request token.
+ $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
+
+ // persist the request token secret in the session variable for step 3 to get the access token and secret.
+ $_SESSION['secret'] = $requestToken['oauth_token_secret'];
+ $_SESSION['state'] = 1;
+
+ // step 2 (state 2) - redirect to the Oauth customer authorization url.
+ // variable $requestToken['oauth_token'] has the temporary request token
+ header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
+ exit;
+ } elseif ($_SESSION['state'] == 1) {
+ //step 3 (state 3) Exchange the temporary request token and secret to get the final access token and secret.
+ $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
+ $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
+
+ // persist the access token and its secret in the session variable to access the products resource
+ $_SESSION['state'] = 2;
+ $_SESSION['token'] = $accessToken['oauth_token'];
+ $_SESSION['secret'] = $accessToken['oauth_token_secret'];
+
+ // redirect back to the callback url which is the same file
+ header('Location: ' . $callbackUrl);
+ exit;
+ } else {
+ // send a GET request to list all the products
+ $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
+ $resourceUrl = "$apiUrl/products";
+ $oauthClient->fetch($resourceUrl, array(), 'GET', array('Content-Type' => 'application/json', 'Accept' => '*/*'));
+ $productsList = json_decode($oauthClient->getLastResponse());
+ print_r($productsList);
+ }
+} catch (OAuthException $e) {
+ print_r($e);
+}
+
+
+
+
+
REST Client Example
+
+
Retrieving the list of Products as a Guest
+
+
+
Use the REST Client that is a Firefox
+ add-on. In the REST Client, in the Method drop-down list, select the GET option.
+
In the URL field, enter the following URL: http://magentohost/api/rest/products?limit=2.
+
Click Send. Information about the products will be displayed in the response body. Example in the XML
+ format is as follows:
+
+
+
+
Example: XML
+
+
+
+
<?xml version="1.0"?>
+<magento_api>
+ <data_item>
+ <entity_id>16</entity_id>
+ <type_id>simple</type_id>
+ <sku>n2610</sku>
+ <description>The Nokia 2610 is an easy to use device that combines multiple messaging options including email, instant messaging, and more. You can even download MP3 ringtones, graphics, and games straight to the phone, or surf the Internet with Cingular's MEdia Net service. It's the perfect complement to Cingular service for those even remotely interested in mobile Web capabilities in an affordable handset.
+Design
+Compact and stylish, the 2610 features a candybar design sporting a bright 128 x 128 pixel display capable of displaying over 65,000 colors. Most of the phone's features and on-screen menus are controlled by a center toggle on the control pad. A standard hands-free headphone jack is provided, as are volume control keys, and there's even a "Go-To" button that can be assigned by the user for quick access to favorite applications. Lastly, the included speakerphone allows you to talk handsfree, and because the phone sports an internal antenna, there's nothing to snag or break off.
+</description>
+ <meta_keyword>Nokia 2610, cell, phone, </meta_keyword>
+ <short_description>The words "entry level" no longer mean "low-end," especially when it comes to the Nokia 2610. Offering advanced media and calling features without breaking the bank</short_description>
+ <name>Nokia 2610 Phone</name>
+ <meta_title>Nokia 2610</meta_title>
+ <meta_description>Offering advanced media and calling features without breaking the bank, The Nokia 2610 is an easy to use</meta_description>
+ <regular_price_with_tax>149.99</regular_price_with_tax>
+ <regular_price_without_tax>149.99</regular_price_without_tax>
+ <final_price_with_tax>149.99</final_price_with_tax>
+ <final_price_without_tax>149.99</final_price_without_tax>
+ <is_saleable>1</is_saleable>
+ <image_url>http://magentohost/imageulr/nokia.jpg</image_url>
+ </data_item>
+ <data_item>
+ <entity_id>17</entity_id>
+ <type_id>simple</type_id>
+ <sku>bb8100</sku>
+ <description> Like the BlackBerry 7105t, the BlackBerry 8100 Pearl is
+The BlackBerry 8100 Pearl sports a large 240 x 260 screen that supports over 65,000 colors-- plenty of real estate to view your e-mails, Web browser content, messaging sessions, and attachments. The venerable BlackBerry trackwheel has been replaced on this model with an innovative four-way trackball placed below the screen. On the rear of the handheld, you'll find a 1.3-megapixel camera and a self portrait mirror. The handheld's microSD memory card slot is located inside the device, behind the battery. There's also a standard 2.5mm headset jack that can be used with the included headset, as well as a mini-USB port for data connectivity.</description>
+ <meta_keyword>Blackberry, 8100, pearl, cell, phone</meta_keyword>
+ <short_description>The BlackBerry 8100 Pearl is a departure from the form factor of previous BlackBerry devices. This BlackBerry handset is far more phone-like, and RIM's engineers have managed to fit a QWERTY keyboard onto the handset's slim frame.</short_description>
+ <name>BlackBerry 8100 Pearl</name>
+ <meta_title>BlackBerry 8100 Pearl</meta_title>
+ <meta_description>BlackBerry 8100 Pearl sports a large 240 x 260 screen that supports over 65,000 colors-- plenty of real estate to view your e-mails, Web browser content, messaging sessions, and attachments.</meta_description>
+ <regular_price_with_tax>349.99</regular_price_with_tax>
+ <regular_price_without_tax>349.99</regular_price_without_tax>
+ <final_price_with_tax>349.99</final_price_with_tax>
+ <final_price_without_tax>349.99</final_price_without_tax>
+ <is_saleable>1</is_saleable>
+ <image_url>http://magentohost/imageulr/blackberry.jpg</image_url>
+ </data_item>
+</magento_api>
+
+
+
+
+
Additional Information
+
+
You can define the limit of items returned in the response by passing the limit parameter. By default, 10 items are
+ returned and the maximum number is 100 items. You can also define the page number by passing the page parameter.
+ Example:
Authorization header will be required for Admin and Customer user types. The following parameters must be provided in
+ the Authorization header for the call:
+
+
oauth_consumer_key - the Consumer Key value provided after the registration of the application.
+
oauth_nonce - a random value, uniquely generated by the application.
+
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following
+ values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
+
oauth_signature - a generated value (signature).
+
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
+
+
oauth_token - the oauth_token value (Request Token).
REST attributes allow specifying additional filters for different types of users. Attributes allow limiting user access more precisely.
+
+
+
REST Attributes Structure
+
+
+
+
The REST attributes tree includes the following elements (as subnodes):
+
+
Name of the resource
+
+
Read permissions (includes all elements available for the current resource)
+
Write permissions (includes all elements available for the current resource)
+
+
+
+
+
+
The Resources tree may be too immense. To avoid scrolling down when searching for the required resource, you can fold the nodes for better representation.
+
+
+
+
Managing Attributes for Guest
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
+
The REST Attributes page opens. From the list of user types, select the Guest type and click it.
+
The page for editing attribute rules opens.
+
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to a Guest type of user by selecting the corresponding All or Custom options.
+
If you select the Custom option, the resources tree appears.
+
Select the required options and click Save in the top right corner to apply changes.
+
+
+
+
+
Managing Attributes for Customer
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
+
The REST Attributes page opens. From the list of user types, select the Customer type and click it.
+
The page for editing attribute rules opens.
+
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to a Customer type of user by selecting the corresponding All or Custom options.
+
If you select the Custom option, the resources tree appears. Some resources have options for selecting read and write permissions.
+
Select the required options and click Save in the top right corner to apply changes.
+
+
+
+
Managing Attributes for Admin
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
+
The REST Attributes page opens. From the list of user types, select the Admin type and click it.
+
The page for editing attribute rules opens.
+
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to an Admin type of user by selecting the corresponding All or Custom options.
+
If you select the Custom option, the resources tree appears. Each resource has options for selecting read and write permissions.
+
Select the required options and click Save in the top right corner to apply changes.
+
+
+
+
+
Examples
+
+
This section provides some examples of limiting Guest and Customer access to certain resource elements.
+
+
Limiting Guest Access to Products
+
+
To allow Guests (users that are not registered in the Magento system) view only product name and final price with tax, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles and select the Guest role.
+
In the Role API Resources, specify the Retrieve option for the Product resource.
+
Click Save Role on the top right corner to save the role.
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes and select Guest in the list of User Types.
+
In the Resources tree, navigate to the Catalog Product node. In the Read subnode, select the Name and Final Price With Tax options.
+
Click Save in the top right corner to save the selected attributes.
+
+
+
+
+
Limiting Customer Access to Products
+
+
To allow Customers (users that are registered in the Magento system) view only product name and final price with tax, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles and select the Customer role.
+
In the Role API Resources, specify the Retrieve option for the Product resource.
+
Click Save Role on the top right corner to save the role.
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes and select Customer in the list of User Types.
+
In the Resources tree, navigate to the Catalog Product node. In the Read subnode, select the Name and Final Price With Tax options.
+
Click Save in the top right corner to save the selected attributes.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/rest/permission_settings/attributes_description.html b/guides/v1.8/api/rest/permission_settings/attributes_description.html
new file mode 100644
index 0000000000..15f30889b3
--- /dev/null
+++ b/guides/v1.8/api/rest/permission_settings/attributes_description.html
@@ -0,0 +1,1101 @@
+---
+layout: v1x_rest
+title: Attributes Description
+---
+
+
+
The following table describes REST attributes that can be managed in the Magento Admin Panel.
+To access these attributes, go to System > Web Services > REST Attributes and select the type of the user for which attributes will be managed.
+
+
+
Order/Orders
+
+
+
+
+
+
Attribute Name
+
Attribute Description
+
Notes
+
+
+
Order ID
+
Sales order ID
+
+
+
+
Order Date
+
Date when the sales order was placed
+
+
+
+
Order Status
+
Sales order status. Can have the following values: Pending, Processing, Complete, Closed, Holded, Pending PayPal, and Payment Review.
+
+
+
+
Shipping Method
+
Shipping method selected during the checkout process (e.g., Flat rate - Fixed)
+
+
+
+
Payment Method
+
Payment method selected during the checkout process (e.g., Check/money order)
+
+
+
+
Base Currency
+
Base currency code (e.g., USD)
+
+
+
+
Order Currency
+
Order currency code (e.g., EUR)
+
+
+
+
Store Name
+
Name of the store from which the order was placed
+
+
+
+
Placed from IP
+
IP address from which the order was placed
+
+
+
+
Store Currency to Base Currency Rate
+
Store currency to base currency rate
+
+
+
+
Subtotal
+
Subtotal amount in order currency (excluding shipping and tax)
+
+
+
+
Subtotal Including Tax
+
Subtotal amount including tax (in order currency)
+
+
+
+
Discount
+
Discount amount applied in the sales order in order currency
+
+
+
+
Grand Total to Be Charged
+
Total amount of money to be paid for the order in base currency (including tax)
+
+
+
+
Grand Total
+
Grand total amount in order currency (including tax and shipping)
+
+
+
+
Shipping
+
Shipping amount applied in the sales order in order currency
+
+
+
+
Shipping Including Tax
+
Shipping amount including tax (in order currency)
+
+
+
+
Shipping Tax
+
Tax amount for shipping in order currency
+
+
+
+
Tax Amount
+
Tax amount applied in the sales order in order currency
+
+
+
+
Tax Name
+
Name of the applied tax
+
+
+
+
Tax Rate
+
Tax rate applied in the order (in order currency)
+
+
+
+
Gift Cards Amount
+
Gift card pricing amount
+
This attribute is available only in Magento EE
+
+
+
Reward Points Balance
+
Reward points amount (that can be converted to currency)
+
This attribute is available only in Magento EE
+
+
+
Reward Currency Amount
+
Reward currency amount
+
This attribute is available only in Magento EE
+
+
+
Coupon Code
+
Coupon code that was applied in the order
+
+
+
+
Base Discount
+
Amount of applied discount in base currency
+
+
+
+
Base Subtotal
+
Subtotal amount for all products in the order in base currency (excluding tax and shipping)
+
+
+
+
Base Shipping
+
Amount of money to be paid for shipping in base currency
+
+
+
+
Base Shipping Tax
+
Tax amount for shipping in base currency
+
+
+
+
Base Tax Amount
+
Tax amount applied to the order items in base currency
+
+
+
+
Total Paid
+
Total amount paid for the order (in order currency)
+
+
+
+
Base Total Paid
+
Total amount paid for the order (in base currency)
+
+
+
+
Total Refunded
+
Total refunded amount in order currency
+
+
+
+
Base Total Refunded
+
Total amount refunded for the order (in base currency)
+
+
+
+
Base Subtotal Including Tax
+
Subtotal amount including tax but excluding the discount amount (in base currency)
+
+
+
+
Base Total Due
+
The rest of the money to be paid for the order in base currency (e.g., when partial invoice is applied)
+
+
+
+
Total Due
+
The rest of the money to be paid for the order in order currency (e.g., when partial invoice is applied)
+
+
+
+
Shipping Discount
+
Discount amount for shipping (in order currency)
+
+
+
+
Base Shipping Discount
+
Discount amount for shipping (in base currency)
+
+
+
+
Discount Description
+
Discount code (coupon code applied in the order)
+
+
+
+
Customer Balance
+
Customer balance (in order currency)
+
+
+
+
Base Customer Balance
+
Customer balance (in base currency)
+
+
+
+
Base Gift Cards Amount
+
Gift card pricing amount (in base currency)
+
This attribute is available only in Magento EE
+
+
+
Base Rewards Currency
+
Reward currency amount (in base currency)
+
This attribute is available only in Magento EE
+
+
+
+
+
+
Order Addresses
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Customer Last Name
+
Customer last name
+
+
+
Customer First Name
+
Customer first name
+
+
+
Customer Middle Name
+
Customer middle name or initial
+
+
+
Customer Prefix
+
Customer prefix
+
+
+
Customer Suffix
+
Customer suffix
+
+
+
Company
+
Company name
+
+
+
Street
+
Street address
+
+
+
City
+
City
+
+
+
State
+
State
+
+
+
ZIP/Postal Code
+
ZIP or postal code
+
+
+
Country
+
Country name
+
+
+
Phone Number
+
Customer phone number
+
+
+
Address Type
+
Address type. Can have the following values: billing or shipping
+
+
+
+
+
+
+
Order Items
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Base Discount Amount
+
Discount amount applied to the row in base currency
+
+
+
Base Item Subtotal
+
Row subtotal in base currency
+
+
+
Base Item Subtotal Including tax
+
Row subtotal including tax in base currency
+
+
+
Base Original Price
+
Original item price in base currency
+
+
+
Base Price
+
Item price in base currency
+
+
+
Base Price Including tax
+
Item price including tax in base currency
+
+
+
Base Tax Amount
+
Tax amount applied to the row in base currency
+
+
+
Canceled Qty
+
Number of canceled order items
+
+
+
Discount Amount
+
Discount amount applied to the row in order currency
+
+
+
Invoiced Qty
+
Number of invoiced order items
+
+
+
Item Subtotal
+
Row subtotal in order currency
+
+
+
Item Subtotal Including Tax
+
Row subtotal including tax in order currency
+
+
+
Order Item ID
+
Order item ID
+
+
+
Ordered Qty
+
Number of ordered items
+
+
+
Original Price
+
Original item price in order currency
+
+
+
Parent Order Item ID
+
ID of the configurable product to which the simple product is assigned
+
+
+
Price
+
Item price in order currency
+
+
+
Price Including Tax
+
Item price including tax in order currency
+
+
+
Product and Custom Options Name
+
Name of the product (custom options name)
+
+
+
Refunded Qty
+
Number of refunded order items
+
+
+
SKU
+
Product SKU
+
+
+
Shipped Qty
+
Number of shipped order items
+
+
+
Tax Amount
+
Tax amount applied to the row in order currency
+
+
+
Tax Percent
+
Tax percent applied to the row
+
+
+
+
+
+
+
Stock Item
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Automatically Return Credit Memo Item to Stock
+
Defines whether products can be automatically returned to stock when the refund for an order is created
+
+
+
Backorders
+
Defines whether the customer can place the order for products that are out of stock at the moment. Can have the following values: 0 - No Backorders, 1 - Allow Qty Below 0, and 2 - Allow Qty Below 0 and Notify Customer
+
+
+
Can Be Divided into Multiple Boxes for Shipping
+
Defines whether the stock items can be divided into multiple boxes for shipping
+
+
+
Enable Qty Increments
+
Defines whether the customer can add products only in increments to the shopping cart
+
+
+
Item ID
+
Stock item ID
+
+
+
Low Stock Date
+
Date when the number of stock items became lower than the number defined in the Notify for Quantity Below option
+
+
+
Manage Stock
+
Choose whether to view and specify the product quantity and availability and whether the product is in stock management. Can have the following values: 0 - No, 1 - Yes
+
+
+
Maximum Qty Allowed in Shopping Cart
+
Maximum number of items in the shopping cart to be sold
+
+
+
Minimum Qty Allowed in Shopping Cart
+
Minimum number of items in the shopping cart to be sold
+
+
+
Notify for Quantity Below
+
The number of inventory items below which the customer will be notified via the RSS feed
+
+
+
Product ID
+
Product ID
+
+
+
Qty
+
Quantity of stock items for the current product
+
+
+
Qty Increments
+
The product quantity increment value
+
+
+
Qty Uses Decimals
+
Choose whether the product can be sold using decimals (e.g., you can buy 2.5 product)
+
+
+
Qty for Item's Status to Become Out of Stock
+
Quantity for stock items to become out of stock
+
+
+
Stock Availability
+
Defines whether the product is available for selling. Can have the following values: 0 - Out of Stock, 1 - In Stock
+
+
+
Stock ID
+
Stock ID
+
+
+
Use Config Settings for Backorders
+
Choose whether the Config settings will be applied for the Backorders option
+
+
+
Use Config Settings for Enable Qty Increments
+
Choose whether the Config settings will be applied for the Enable Qty Increments option
+
+
+
Use Config Settings for Manage Stock
+
Choose whether the Config settings will be applied for the Manage Stock option
+
+
+
Use Config Settings for Maximum Qty Allowed in Shopping Cart
+
Choose whether the Config settings will be applied for the Maximum Qty Allowed in Shopping Cart option
+
+
+
Use Config Settings for Minimum Qty Allowed in Shopping Cart
+
Choose whether the Config settings will be applied for the Minimum Qty Allowed in Shopping Cart option
+
+
+
Use Config Settings for Notify for Quantity Below
+
Choose whether the Config settings will be applied for the Notify for Quantity Below option
+
+
+
Use Config Settings for Qty Increments
+
Choose whether the Config settings will be applied for the Qty Increments option
+
+
+
Use Config Settings for Qty for Item's Status to Become Out of Stock
+
Choose whether the Config settings will be applied for the Qty for Item's Status to Become Out of Stock option
+
+
+
+
+
+
Notes: The Admin user type has restrictions concerning the WRITE operations for definite stock item attributes. These are as follows:
+
+
+
+
Attribute Name
+
Admin
+
+
+
Item ID
+
No
+
+
+
Product ID
+
No
+
+
+
Stock ID
+
No
+
+
+
Low Stock Date
+
No
+
+
+
+
+
However, these attributes are available for READ operations.
+
+
+
+
Customer
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Customer ID
+
Customer ID
+
+
+
Last Logged In
+
Date when the customer was logged in last
+
+
+
Is Confirmed
+
Defines whether the email confirmation is sent to the customer
+
+
+
Created At
+
Date when the customer was created
+
+
+
Associate to Website
+
Website ID to which the customer is associated
+
+
+
Created From
+
Store view from which the customer was created
+
+
+
Group
+
Customer group ID
+
+
+
Disable automatic group change
+
Defines whether the automatic group change will be applied to the customer
+
+
+
Prefix
+
Customer prefix
+
+
+
First Name
+
Customer first name
+
+
+
Middle Name/Initial
+
Customer middle name or initial
+
+
+
Last Name
+
Customer last name
+
+
+
Suffix
+
Customer suffix
+
+
+
Email
+
Customer email address
+
+
+
Date Of Birth
+
Customer date of birth
+
+
+
Tax/VAT Number
+
Customer tax or VAT number
+
+
+
Gender
+
Customer gender (male or female)
+
+
+
+
+
+
Customer Address
+
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
City
+
City name
+
+
+
Company
+
Company name
+
+
+
Country
+
Country
+
+
+
Customer Address ID
+
Customer address ID
+
+
+
Fax
+
Fax number
+
+
+
First Name
+
Customer first name
+
+
+
Is Default Billing Address
+
Defines whether the address is a default one for billing
+
+
+
Is Default Shipping Address
+
Defines whether the address is a default one for shipping
+
+
+
Last Name
+
Customer last name
+
+
+
Middle Name/Initial
+
Customer middle name or initial
+
+
+
Prefix
+
Customer prefix
+
+
+
State/Province
+
Customer state/region
+
+
+
Street Address
+
Customer street address
+
+
+
Suffix
+
Customer suffix
+
+
+
Telephone
+
Customer phone number
+
+
+
VAT Number
+
Customer VAT number
+
+
+
ZIP/Postal Code
+
Customer ZIP or postal code
+
+
+
+
+
+
+
Product
+
+
Attributes for the product resource are divided into those available for the Admin type of user and those available for the Customer and Guest types of user.
+
+
+
+
+
Attribute Name
+
Attribute Description
+
Notes
+
+
+
Product ID
+
Product ID
+
Available only for Admin
+
+
+
name
+
Product Name
+
+
+
+
Product Type
+
Product type. Can have the following values: Simple, Grouped, Configurable, Virtual, Bundle, or Downloadable
+
+
+
+
Attribute Set Name
+
Name of the attribute set which the product is based on
+
Available only for Admin
+
+
+
sku
+
Product SKU
+
+
+
+
price
+
Product price
+
+
+
+
visibility
+
Product visibility in the store. Can have the following values: Catalog, Search; Search; Catalog; Not Visible Individually
+
Available only for Admin
+
+
+
description
+
Product description
+
+
+
+
short_description
+
Product short description
+
+
+
+
weight
+
Product weight
+
Available only for Admin
+
+
+
news_from_date
+
Date starting from which the product is promoted as a new product
+
Available only for Admin
+
+
+
news_to_date
+
Date till which the product is promoted as a new product
+
Available only for Admin
+
+
+
status
+
Product status in the store. Can have the following values: Enabled or Disabled
+
Available only for Admin
+
+
+
url_key
+
A friendly URL path for the product
+
Available only for Admin
+
+
+
Create Permanent Redirect for Old URL
+
Defines whether the redirect to an original URL will be applied (when the existing URL for a product is edited)
+
Available only for Admin; available only for product update
+
+
+
country_of_manufacture
+
Product country of manufacture
+
Available only for Admin
+
+
+
is_returnable
+
Defines whether the product can be returned
+
Available only for Admin
+
+
+
special_price
+
Product special price
+
Available only for Admin
+
+
+
special_from_date
+
Date starting from which the special price will be applied for the product
+
Available only for Admin
+
+
+
special_to_date
+
Date till which the special price will be applied for the product
+
Available only for Admin
+
+
+
group_price
+
Product group price
+
Available only for Admin
+
+
+
tier_price
+
Product tier price
+
+
+
+
msrp_enabled
+
The Apply MAP option. Defines whether the price in the catalog in the frontend is substituted with a Click for price link
+
Available only for Admin
+
+
+
msrp_display_actual_price_type
+
Defines how the price will be displayed in the frontend. Can have the following values: In Cart, Before Order Confirmation, and On Gesture
+
Available only for Admin
+
+
+
msrp
+
The Manufacturer's Suggested Retail Price option. The price that a manufacturer suggests to sell the product at
+
Available only for Admin
+
+
+
enable_googlecheckout
+
Defines whether the product can be purchased with the help of the Google Checkout payment service. Can have the following values: Yes and No
+
Available only for Admin
+
+
+
tax_class_id
+
The product tax class to which the product will be associated
+
Available only for Admin
+
+
+
meta_title
+
Product meta title
+
+
+
+
meta_keyword
+
Product meta keywords
+
+
+
+
meta_description
+
Product meta description
+
+
+
+
custom_design
+
Custom design applied for the product page
+
Available only for Admin
+
+
+
custom_design_from
+
Date starting from which the custom design will be applied for the product page
+
Available only for Admin
+
+
+
custom_design_to
+
Date till which the custom design will be applied for the product page
+
Available only for Admin
+
+
+
custom_layout_update
+
An XML block to alter the page layout
+
Available only for Admin
+
+
+
page_layout
+
Page template that can be applied to the product page
+
Available only for Admin
+
+
+
options_container
+
Defines how the custom options for the product will be displayed. Can have the following values: Block after Info Column or Product Info Column
+
Available only for Admin
+
+
+
gift_message_available
+
Defines whether the gift message is available for the product
+
Available only for Admin
+
+
+
Use Config Settings for Allow Gift Message
+
Defines whether the configuration settings will be used for the Allow Gift Message option
+
Available only for Admin
+
+
+
gift_wrapping_available
+
Defines whether the gift wrapping is available for the product
+
Available only for Admin. This attribute is available in Magento EE
+
+
+
Use Config Settings for Allow Gift Wrapping
+
Defines whether the configuration settings will be used for the Allow Gift Wrapping option
+
Available only for Admin. This attribute is available in Magento EE
+
+
+
gift_wrapping_price
+
Price for the gift wrapping (available in Magento EE)
+
Available only for Admin
+
+
+
Inventory Data
+
Product inventory data
+
Available only for Admin
+
+
+
Custom attr
+
Product custom attributes
+
The customer can see only attributes that are set as visible on frontend
+
+
+
Regular Price
+
The original product price displayed in the frontend
+
Available only for Customer and Guest
+
+
+
Final Price
+
The final product price
+
Available only for Customer and Guest
+
+
+
Final Price with Tax
+
The final product price with tax
+
Available only for Customer and Guest
+
+
+
Final Price Without Tax
+
The final product price without tax
+
Available only for Customer and Guest
+
+
+
Stock Status
+
The product stock status (availability)
+
Available only for Customer and Guest
+
+
+
Product Is Saleable
+
Defines whether the product can be sold
+
Available only for Customer and Guest
+
+
+
Total Reviews Number
+
The number of all reviews for a product
+
Available only for Customer and Guest
+
+
+
Product URL Link
+
A link to the product without the assigned category
+
Available only for Customer and Guest
+
+
+
Buy Now Link
+
A link that adds a product to the shopping cart
+
Available only for Customer and Guest
+
+
+
Product Has Custom Options
+
Defines whether the product has custom options or not
+
Available only for Customer and Guest
+
+
+
Default Product Image
+
Default product image
+
Available only for Customer and Guest
+
+
+
+
+
Product Category
+
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Category ID
+
ID of the category to which the product is assigned
+
+
+
+
+
+
Product Image
+
+
+
+
+
+
Attribute Name
+
Attribute Description
+
Notes
+
+
+
Exclude
+
Defines whether the image will associate only to one of the three image types.
+
+
+
+
ID
+
Image file ID
+
Available only for READ operations
+
+
+
Label
+
A label that will be displayed on the frontend when pointing to the image
+
+
+
+
Position
+
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
+
+
+
+
Type
+
Image type. Can have the following values: Base Image, Small Image, or Thumbnail.
+
+
+
+
URL
+
Image file URL path
+
Available only for READ operations
+
+
+
File Content
+
Image file content (base_64 encoded)
+
Available only for WRITE operations
+
+
+
File MIME Type
+
File MIME type. Can have the following values: image/jpeg, image/png, image/gif, etc.
+
Available only for WRITE operations
+
+
+
File Name
+
Image file name
+
Available only for WRITE operations
+
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/rest/permission_settings/permission_settings.html b/guides/v1.8/api/rest/permission_settings/permission_settings.html
new file mode 100644
index 0000000000..f96d64e1b7
--- /dev/null
+++ b/guides/v1.8/api/rest/permission_settings/permission_settings.html
@@ -0,0 +1,111 @@
+---
+layout: v1x_rest
+title: Permission Settings
+---
+
+
+
After the authentication is complete successfully, the Access Token is received and will be used in every API call. This key allows identifying the client that accesses the API. With the help of this key, the following information about the user can be retrieved:
+
+
+
Type of the API user
+
User ID (can be Admin ID or Customer ID)
+
+
+
Authorization
+
+
+
Access Levels
+
+
There is a three-level authorization approach in Magento REST API. These three levels are as follows:
+
+
Guest
+
Customer
+
Admin
+
+
+
+
The following graphic describes the default rights for each access level with each level obtaining more rights up to Admin who has access to everything.
+
+
+
+
+
Each user type will be described below.
+Magento grants permissions for the following three types of users:
+
+
Guest
+
+
Guest can be a type of application that does not require authentication. This application has access only to public resources.
+
+
Customer
+
+
Customer can be a registered and logged in user. This type of user can have access only to its own resources as well as to public resources.
+
+
Admin
+
+
Admin can be the store owner. This type has full set of permissions.
+
+
Understanding of access levels is the basis of the ACL work.
+
+
Access Control List (ACL)
+
+
ACL Overview
+
+
Every user has a specific role and purpose. To accomplish their goals, each user must be able to access certain resources and perform specific actions. Allowing users to access the resources without any limits can compromise Magento security.
+
+
The Access Control List (ACL) is a set of permissions (access rights) that particular users have for certain resources. When a user wants to perform a specific action with a resource (for example, update the customer information), Magento checks the permission for this combination of user, resource, and action. If the action is allowed, the user can proceed. Otherwise, the action is denied.
+
+
Understanding ACL
+
+
Access control lists include two main things: a subject and an object. Usually, the subject is the user who wants to use the resource. The object is the resource that a certain user wants to have access to. So, ACL is used to decide when the subject can have access to object.
+
+
You should remember that ACL is not the same as authentication. ACL is the next step after the authentication is passed successfully. These two concepts are closely connected but the difference lies in the following: authentication is understanding who the user is and ACL is understanding what the user can do.
+
+
+
+
ACL Structure
+
+
ACL is implemented in a tree structure. There is a tree of resources for each user type. Namely, Admin, Customer, and Guest have their own trees of resources.
+Each ACL entry specifies two instances: a subject and an action the subject can perform.
+
+
Example of the resource tree for the Admin role is as follows:
+
+
+
+
Read/Write Permissions
+
+
All REST resource attributes are divided into two categories: Read and Write. The Read category includes the operation of retrieving. So, when selecting the attributes in the Read category, you specify them for the resource retrieving. The Write category includes the operations of creating and updating. So, when selecting the attributes in the Write category, you specify them for the resource creation and updating. To illustrate the situation, let's take the following example:
+
REST roles in Magento are used to limit access to certain resources. Limiting access lies in configuration of a REST role and assigning a user to it. You can select which resources will be available for the user and which will not.
+
+
REST roles management consists in the role creation, editing, deleting, and user assignment. Note that REST role creation and deletion is available only for Admin role.
+
+
The REST Roles page initially includes two roles: Customer and Guest.
+
+
Only API Resources can be edited in the Guest and Customer roles. You cannot change the name or assigned users in these roles. Also, you cannot delete the Guest or Customer role. For example, when editing the Guest Role, the page looks as follows:
+
+
+
Viewing REST Roles
+
+
To view the list of REST roles, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens.
+
REST roles are displayed in a grid with the following columns: ID (role ID), Role Name, User Type, and Created At (date and time of the role creation).
+
+
+
+
+
Working with Admin Role
+
+
Adding a New REST Role for Admin
+
+
To add a new REST role for Admin, perform the following steps:
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens.
+
In the top right corner, click Add Admin Role. The Add New Role page opens.
+
There are two tabs in the Role Information panel on the left: Role Info and Role API Resources.
+
Select the Role Info tab and in the Role Information panel, enter the name for the role to be created in the corresponding Role Name field. This field is required.
+
In the Role API Resources tab, in the Resource Access drop-down list, select whether the user will have full or custom access by selecting the corresponding All or Custom options. If you select the Custom option, the Resources tree will appear where you will be able to check the required resources and actions.
+
Click Save Role in the top right corner to save the role.
+
After you saved the role, a new Role Users tab appears in the Role Information panel on the left. In this tab, you can manage users for the current role. Click Reset Filter to view all users to which the role can be assigned.
+
+
+
+
+
Editing an Existing Admin REST Role
+
+
To edit an existing Admin REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. In the roles grid, select the Admin role and click it.
+
The Edit Role <role name> page opens. You can edit the following information:
+
+
Role Info: Edit the name of the Admin role by selecting the Role Info tab to the left.
+
Role API Resources: Select or clear the resources available for this role.
+
Role Users: Assign or remove users for this role.
+
+
+
Click Save Role in the top right corner to apply changes.
+
+
+
+
+
Deleting an Existing Admin REST Role
+
+
To delete an existing Admin REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. In the roles grid, select the required Admin role to be deleted and click it.
+
The Edit Role <role name> page opens. In the top right corner, click Delete Role. The role is deleted.
+
+
+
+
+
Assigning a REST Role to Admin
+
+
To assign a REST role to admin, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Permissions > Users.
+
The Users page opens. In the users grid, select the user to which the REST Admin role will be assigned.
+
The Edit User <Name of the User> page opens. In the User Information panel, select the REST Role tab.
+
In the list of REST roles, select the Admin role to be assigned and select the option button next to it.
+
Click Save User in the top right corner to save changes.
+
+
+
+
Assigning Multiple Users to an Admin REST Role
+
+
To assign more than one user to an existing Admin REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. In the REST roles grid, select the Admin role to which users will be assigned.
+
The Edit Role <role name> page opens. In the Role Information panel, select the Role Users tab.
+
In the list of users, click Reset Filter to view the list of all users to which the role can be assigned. Select the checkboxes near the users to be assigned to the Admin role.
+
Click Save Role in the top right corner to save changes.
+
+
+
+
+
Viewing Users Assigned to an Admin REST Role
+
+
To view the list of users assigned to a REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. From the list of roles, select the Admin role whose assigned users you want to view and click it.
+
The Edit Role <role name> page opens. In the Role Information panel on the left, select the Role Users tab.
+
The list of REST role users is displayed in a grid with the following columns: ID, User Name, First Name, and Last Name.
+
+
+
+
+
+
Unassigning User from the Admin REST Role
+
+
To unassign the Admin REST role from a user, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. From the list of roles, select the Admin role from which you want to unassign a user and click it.
+
The Edit Role <role name> page opens. In the Role Information panel on the left, select the Role Users tab.
+
Clear the checkbox next to the user which you want to unassign from the current REST role.
+
Click Save Role in the top right corner to apply the changes.
+
+
+
+
+
Working with Guest and Customer Roles
+
+
As it has been mentioned before, the Customer and Guest roles cannot be removed and can be only partially edited. You can edit only the resources and actions allowed for the user.
+
+
Editing the Guest REST Role
+
+
To edit the Guest REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. From the list of roles, select the Guest role and click it.
+
The Edit Role "Guest" page opens. In the Role Resources panel, edit the required information.
+
Click Save Role in the top right corner to apply changes.
+
+
+
+
Editing the Customer REST Role
+
+
To edit the Customer REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. From the list of roles, select the Customer role and click it.
+
The Edit Role "Customer" page opens. In the Role Resources panel, edit the required information.
+
Click Save Role in the top right corner to apply changes.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/rest/response_formats.html b/guides/v1.8/api/rest/response_formats.html
new file mode 100644
index 0000000000..79d2e7d668
--- /dev/null
+++ b/guides/v1.8/api/rest/response_formats.html
@@ -0,0 +1,166 @@
+---
+layout: v1x_rest
+title: Response Formats
+---
+
+
+
+
If you make a Magento API call, you are guaranteed to receive some kind of a response. If you make a successful call, you will receive an HTTP response with a 200 OK status.
+
+
REST API Response Formats
+
+
You can view the response data from any Magento API call in one of the following two formats:
+
+
+
XML
+
JSON
+
+
+
+
The format of returned data is defined in the request header. The format you choose depends on what you are familiar with most or tools available to you.
+
+
+
XML Format
+
+
The XML response format is a simple XML block.
+To set the response format to XML, add the Accept request header with the text/xml value.
+
+
A successful call will return the following response (example of retrieving information about stock items):
JSON (JavaScript Object Notation) is a lightweight data-interchange format.
+To set the response format to JSON, add the Accept request header with the application/json value.
+
+
Response Structure
+
+
The JSON objects represent a direct mapping of the XML block from the XML response format.
The list of HTTP status codes that are returned in the API response is described in the Common HTTP Status Codes part of the documentation. There, you can find the list of codes themselves together with their description.
The following parameters must be provided in the Authorization header for the call:
+
+
oauth_signature_method
+
oauth_version
+
oauth_nonce
+
oauth_timestamp
+
oauth_consumer_key
+
oauth_token
+
oauth_signature
+
+
+
+
Testing
+ REST resources with the REST Client plugin
+ for the Mozilla Firefox browser.
+
+
+
Open the REST Client.
+
From the Authentication drop-down, select OAuth.
+
+
In the OAuth window, on the Signature for the request tab, fill in the following fields:
+
+
Consumer key: Enter the Key value provided when you created the consumer in Magento Admin Panel.
+
+
Consumer secret: Enter the Secret value provided when you created the consumer in Magento Admin
+ Panel.
+
Access token: Enter the oauth_token value received when you authenticated the application.
+
Access token secret: Enter the oauth_token_secret value received when you authenticated the
+ application.
+
+
+
On the OAuth setting tab, define the following options:
+
+
+
Signature Methods: From the drop-down list, select which method will be used for signatures (HMAC-SHA1
+ or PLAINTEXT).
+
oAuth Version: From the drop-down list, select the 1.0 option (REST API supports OAuth 1.0a).
+
+
Leave the Realm, oAuth Nonce, and oAuth Timestamp values set by default.
+
+
+
Click Save and wait for the confirmation dialog to close.
+
Return to the Signature for the request tab and select Insert > Insert as header.
+
+
An authorization header is created on the main page of REST Client.
+
+
+
+ NOTE: Click the header with authorization data and click Auto refresh in the opened pop-up in order to
+ generate new values for oauth_nonce, oauth_timestamp, and oauth_signature at each request.
+
+
From the Headers drop-down, select Custom Header.
+
+
In the Request Header window, enter "Content-Type" in the Name field and "text/xml" in the
+ Value field (if you want to use the XML data format). To use the JSON request data format, enter
+ application/json instead of the text/xml value.
+
Click Okay.
+
+
+
+
+
+
+
Example: Retrieving the List of Products
+
+
+
From the Method drop-down list, select the GET option.
+
In the URL field, enter the following URL: http://magentohost/api/rest/products. You can limit the number
+ of products returned in the response. To set the limit to 4, enter the following URL:
+ http://magentohost/api/rest/products?limit=4
+
Click Send. Information about all products will be displayed in the response body. Example is as
+ follows:
+
In the first field, start typing authorization. An Authorization popup appears. Click it.
+
+
When you click the fields next to the Authorization header, the Construct link appears. Click it to
+ configure OAuth authentication.
+
The Authorization window opens. Select the OAuth tab.
+
+
In the Type group of options, select the Signed Request option.
+
In the signature method group of options, select which method will be used for signatures (HMAC-SHA1 or
+ PLAINTEXT).
+
Fill in the following data:
+
+
+
Consumer key: Enter the Key value provided when you created the consumer in Magento Admin Panel.
+
+
Consumer secret: Enter the Secret value provided when you created the consumer in Magento Admin
+ Panel.
+
Access Token: Enter the oauth_token value received when you authenticated the application.
+
Access Token Secret: Enter the oauth_token_secret value received when you authenticated the
+ application.
+
+
+
Click OK.
+ NOTE: Advanced REST Client does not save the Consumer secret and Access Token Secret values.
+ You need to enter these values each time you make a request.
+
In the URL field, enter the URL to which the API call will be performed and select the required HTTP
+ method.
+
In the Headers table, click Add row and add the Accept - application/json or Accept - text/xml
+ header depending on which format you prefer for the returned data.
+
Click Send Request.
+
+
+
+
Example: Retrieving the list of customers
+
+
+
In the Method group of options, select the GET option.
+
In the URL field, enter the following URL: http://magentohost/api/rest/customers.
+
Click Send request. Information about all customers will be displayed in the response body. Note that only
+ Admin type of the user can retrieve the list of customers. Example is as follows:
+
+
+
+
+
Example: Creating a customer address
+
+
+
In the Method group of options, select the POST option.
+
In the URL field, enter the following URL: http://magentohost/api/rest/customers/:id/addresses where the ":id"
+ value is the customer ID in the system.
+
In the Body table, on the Raw input tab, enter the data required for customer address creation.
+
Click Send request. If the address is created, the 200 OK HTTP status code will be returned. Example is as
+ follows:
+
+
\ No newline at end of file
diff --git a/guides/v1.8/api/soap-api-index.html b/guides/v1.8/api/soap-api-index.html
new file mode 100644
index 0000000000..fbc04d5ea8
--- /dev/null
+++ b/guides/v1.8/api/soap-api-index.html
@@ -0,0 +1,211 @@
+---
+layout: v1x
+title: Magento 1.x SOAP API
+---
+
+
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.assignProduct (SOAP V1)
+
catalogCategoryAssignProduct (SOAP V2)
+
+
+
+
Assign a product to the required category.
+
+
Aliases:
+
+
category.assignProduct
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the category
+
+
+
string
+
product/productId
+
ID or SKU of the product to be assigned to the category
+
+
+
string
+
position
+
Position of the assigned product in the category (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' argument
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the product is assigned to the specified category
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.assignProduct', array('categoryId' => '4', 'product' => '1'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAssignProduct($sessionId, '4', '3');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.assignedProducts (SOAP V1)
+
catalogCategoryAssignedProducts (SOAP V2)
+
+
+
+
Retrieve the list of products assigned to a required category.
+
+
Aliases:
+
+
category.assignedProducts
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the required category
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogAssignedProduct
+
+
+
+
+
The catalogAssignedProduct content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
product_id
+
ID of the assigned product
+
+
+
string
+
type
+
Product type
+
+
+
int
+
set
+
Attribute set ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
int
+
position
+
Position of the assigned product
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.assignedProducts', '4');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAssignedProducts($sessionId, '4');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.create (SOAP V1)
+
catalogCategoryCreate (SOAP V2)
+
+
+
+
Create a new category and return its ID.
+
+
Aliases:
+
+
category.create
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
parentId
+
Parent category ID
+
+
+
array
+
categoryData
+
Array of catalogCategoryEntityCreate
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
attribute_id
+
ID of the created category
+
+
+
+
+
The categoryData content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
name
+
Name of the created category
+
+
+
int
+
is_active
+
Defines whether the category will be visible in the frontend
+
+
+
int
+
position
+
Position of the created category (optional)
+
+
+
ArrayOfString
+
available_sort_by
+
All available options by which products in the category can be sorted
+
+
+
string
+
custom_design
+
The custom design for the category (optional)
+
+
+
int
+
custom_apply_to_products
+
Apply the custom design to all products assigned to the category (optional)
+
+
+
string
+
custom_design_from
+
Date starting from which the custom design will be applied to the category (optional)
+
+
+
string
+
custom_design_to
+
Date till which the custom design will be applied to the category (optional)
+
+
+
string
+
custom_layout_update
+
Custom layout update (optional)
+
+
+
string
+
default_sort_by
+
The default option by which products in the category are sorted
+
+
+
string
+
description
+
Category description (optional)
+
+
+
string
+
display_mode
+
Content that will be displayed on the category view page (optional)
+
+
+
int
+
is_anchor
+
Defines whether the category will be anchored (optional)
+
+
+
int
+
landing_page
+
Landing page (optional)
+
+
+
string
+
meta_description
+
Category meta description (optional)
+
+
+
string
+
meta_keywords
+
Category meta keywords (optional)
+
+
+
string
+
meta_title
+
Category meta title (optional)
+
+
+
string
+
page_layout
+
Type of page layout that the category should use (optional)
+
+
+
string
+
url_key
+
A relative URL path which can be entered in place of the standard target path (optional)
+
+
+
int
+
include_in_menu
+
Defines whether the category is visible on the top menu bar
+
+
+
string
+
filter_price_range
+
Price range of each price level displayed in the layered navigation block (optional)
+
+
+
int
+
custom_use_parent_settings
+
Defines whether the category will inherit custom design settings of the category to which it is assigned. 1 - Yes, 0 - No (optional)
+
+
+
+
+
Notes: The position parameter is deprecated, the category will be positioned anyway in the end of the list and you can not set the position directly. You should use the catalog_category.move method instead. You cannot also assign a root category to the specified store.
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$result = $client->call($session, 'catalog_category.create', array(2, array(
+ 'name' => 'Category name',
+ 'is_active' => 1,
+ 'position' => 1,
+ //<!-- position parameter is deprecated, category anyway will be positioned in the end of list
+ //and you can not set position directly, use catalog_category.move instead -->
+ 'available_sort_by' => 'position',
+ 'custom_design' => null,
+ 'custom_apply_to_products' => null,
+ 'custom_design_from' => null,
+ 'custom_design_to' => null,
+ 'custom_layout_update' => null,
+ 'default_sort_by' => 'position',
+ 'description' => 'Category description',
+ 'display_mode' => null,
+ 'is_anchor' => 0,
+ 'landing_page' => null,
+ 'meta_description' => 'Category meta description',
+ 'meta_keywords' => 'Category meta keywords',
+ 'meta_title' => 'Category meta title',
+ 'page_layout' => 'two_columns_left',
+ 'url_key' => 'url-key',
+ 'include_in_menu' => 1,
+)));
+
+var_dump ($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$result = $client->catalogCategoryCreate($session, 2, array(
+ 'name' => 'Category name 2',
+ 'is_active' => 1,
+ 'position' => 1,
+ //<!-- position parameter is deprecated, category anyway will be positioned in the end of list
+ //and you can not set position directly, use catalog_category.move instead -->
+ 'available_sort_by' => array('position'),
+ 'custom_design' => null,
+ 'custom_apply_to_products' => null,
+ 'custom_design_from' => null,
+ 'custom_design_to' => null,
+ 'custom_layout_update' => null,
+ 'default_sort_by' => 'position',
+ 'description' => 'Category description',
+ 'display_mode' => null,
+ 'is_anchor' => 0,
+ 'landing_page' => null,
+ 'meta_description' => 'Category meta description',
+ 'meta_keywords' => 'Category meta keywords',
+ 'meta_title' => 'Category meta title',
+ 'page_layout' => 'two_columns_left',
+ 'url_key' => 'url-key',
+ 'include_in_menu' => 1,
+));
+
+var_dump ($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogCategory/catalog_category.currentStore.html b/guides/v1.8/api/soap/catalog/catalogCategory/catalog_category.currentStore.html
new file mode 100644
index 0000000000..67a19673fd
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogCategory/catalog_category.currentStore.html
@@ -0,0 +1,103 @@
+---
+layout: v1x_soap
+title: Current Store
+---
+
+
+
Module: Mage_Catalog
+
+
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
catalog_category.currentStore (SOAP V1)
+
catalogCategoryCurrentStore (SOAP V2)
+
+
+
+
Allows you to set/get the current store view.
+
+
Aliases:
+
+
category.currentStore
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
storeView
+
Store view ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'category.currentStore', '1');
+var_dump ($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryCurrentStore($sessionId, '1');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.delete (SOAP V1)
+
catalogCategoryDelete (SOAP V2)
+
+
+
+
Allows you to delete the required category.
+
+
Aliases:
+
+
category.delete
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the category to be deleted
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the category is deleted
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.delete', '7');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryDelete($sessionId, '7');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogCategory/catalog_category.info.html b/guides/v1.8/api/soap/catalog/catalogCategory/catalog_category.info.html
new file mode 100644
index 0000000000..f07d93b8c4
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogCategory/catalog_category.info.html
@@ -0,0 +1,344 @@
+---
+layout: v1x_soap
+title: Category Info
+---
+
+
+
Module: Mage_Catalog
+
+
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.info (SOAP V1)
+
catalogCategoryInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the required category.
+
+
Aliases:
+
+
category.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
Category ID
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
ArrayOfString
+
attributes
+
Array of attributes (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
info
+
Array of catalogCategoryInfo
+
+
+
+
+
The catalogCategoryInfo content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
category_id
+
Category ID
+
+
+
int
+
is_active
+
Defines whether the category is active
+
+
+
string
+
position
+
Category position
+
+
+
string
+
level
+
Category level
+
+
+
string
+
parent_id
+
Parent category ID
+
+
+
string
+
all_children
+
All child categories of the current category
+
+
+
string
+
children
+
Names of direct child categories
+
+
+
string
+
created_at
+
Date when the category was created
+
+
+
string
+
updated_at
+
Date when the category was updated
+
+
+
string
+
name
+
Category name
+
+
+
string
+
url_key
+
A relative URL path which can be entered in place of the standard target path (optional)
+
+
+
string
+
description
+
Category description
+
+
+
string
+
meta_title
+
Category meta title
+
+
+
string
+
meta_keywords
+
Category meta keywords
+
+
+
string
+
meta_description
+
Category meta description
+
+
+
string
+
path
+
Path
+
+
+
string
+
url_path
+
URL path
+
+
+
int
+
children_count
+
Number of child categories
+
+
+
string
+
display_mode
+
Content that will be displayed on the category view page (optional)
+
+
+
int
+
is_anchor
+
Defines whether the category is anchored
+
+
+
ArrayOfString
+
available_sort_by
+
All available options by which products in the category can be sorted
+
+
+
string
+
custom_design
+
The custom design for the category (optional)
+
+
+
string
+
custom_apply_to_products
+
Apply the custom design to all products assigned to the category (optional)
+
+
+
string
+
custom_design_from
+
Date starting from which the custom design will be applied to the category (optional)
+
+
+
string
+
custom_design_to
+
Date till which the custom design will be applied to the category (optional)
+
+
+
string
+
page_layout
+
Type of page layout that the category should use (optional)
+
+
+
string
+
custom_layout_update
+
Custom layout update (optional)
+
+
+
string
+
default_sort_by
+
The default option by which products in the category are sorted
+
+
+
int
+
landing_page
+
Landing page (optional)
+
+
+
int
+
include_in_menu
+
Defines whether the category is available on the Magento top menu bar
+
+
+
string
+
filter_price_range
+
Price range of each price level displayed in the layered navigation block
+
+
+
int
+
custom_use_parent_settings
+
Defines whether the category will inherit custom design settings of the category to which it is assigned. 1 - Yes, 0 - No
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.info', '5');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryInfo($sessionId, '5');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
catalog_category.level (SOAP V1)
+
catalogCategoryLevel (SOAP V2)
+
+
+
+
Allows you to retrieve one level of categories by a website, a store view, or a parent category.
+
+
Aliases:
+
+
category.level
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
website
+
Website ID or code (optional)
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
parentCategory
+
Parent category ID (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
tree
+
Array of CatalogCategoryEntitiesNoChildren
+
+
+
+
+
The CatalogCategoryEntitityNoChildren content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
category_id
+
Category ID
+
+
+
int
+
parent_id
+
Parent category ID
+
+
+
string
+
name
+
Category name
+
+
+
int
+
is_active
+
Defines whether the category is active
+
+
+
int
+
position
+
Category position
+
+
+
int
+
level
+
Category level
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.level');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryLevel($sessionId);
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.move (SOAP V1)
+
catalogCategoryMove (SOAP V2)
+
+
+
+
Allows you to move the required category in the category tree.
+
+
Aliases:
+
+
category.move
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the category to be moved
+
+
+
int
+
parentId
+
ID of the new parent category
+
+
+
string
+
afterId
+
ID of the category after which the required category will be moved (optional for V1 and V2)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
id
+
True if the category is moved
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.move', array('categoryId' => '4', 'parentId' => '3'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryMove($sessionId, '4', '3');
+var_dump($result);
Note: Please make sure that you are not moving the category to any of its own children. There are no extra checks to prevent doing it through API, and you won’t be able to fix this from the admin interface later.
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.removeProduct (SOAP V1)
+
catalogCategoryRemoveProduct (SOAP V2)
+
+
+
+
Allows you to remove the product assignment from the category.
+
+
Aliases:
+
+
category.removeProduct
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
Category ID
+
+
+
string
+
productId
+
ID or SKU of the product to be removed from the category
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the product is removed from the category
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.removeProduct', array('categoryId' => '4', 'product' => '3'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryRemoveProduct($sessionId, '4', '3');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.tree (SOAP V1)
+
catalogCategoryTree (SOAP V2)
+
+
+
+
Allows you to retrieve the hierarchical tree of categories.
+
+
Aliases:
+
+
category.tree
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
parentId
+
ID of the parent category (optional)
+
+
+
string
+
storeView
+
Store view (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
tree
+
Array of catalogCategoryTree
+
+
+
+
+
+
The catalogCategoryTree content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
category_id
+
Category ID
+
+
+
int
+
parent_id
+
Parent category ID
+
+
+
string
+
name
+
Category name
+
+
+
int
+
position
+
Category position
+
+
+
int
+
level
+
Category level
+
+
+
array
+
children
+
Array of CatalogCategoryEntities
+
+
+
+
+
The catalogCategoryEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
category_id
+
Category ID
+
+
+
int
+
parent_id
+
Parent category ID
+
+
+
string
+
name
+
Category name
+
+
+
int
+
is_active
+
defines whether the category is active
+
+
+
int
+
position
+
Category position
+
+
+
int
+
level
+
Category level
+
+
+
array
+
children
+
Array of CatalogCategoryEntities
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.tree');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryTree($sessionId);
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.updateProduct (SOAP V1)
+
catalogCategoryUpdateProduct (SOAP V2)
+
+
+
+
Allows you to update the product assigned to a category. The product position is updated.
+
+
Aliases:
+
+
category.updateProduct
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the category to which the product is assigned
+
+
+
string
+
productId
+
ID or SKU of the product to be updated
+
+
+
string
+
position
+
Position of the product in the category (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the product is updated in the category
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.updateProduct', array('categoryId' => '4', 'product' => '1', 'position' => '3'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryUpdateProduct($sessionId, '4', '1', '3');
+var_dump($result);
+
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.currentStore.html b/guides/v1.8/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.currentStore.html
new file mode 100644
index 0000000000..fd00d97c7f
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.currentStore.html
@@ -0,0 +1,102 @@
+---
+layout: v1x_soap
+title: Current Store
+---
+
+
+
Module: Mage_Catalog
+
+
Resource: catalog_category_attribute
+
+
Aliases:
+
+
category_attribute
+
+
+
+
Method:
+
+
catalog_category_attribute.currentStore (SOAP V1)
+
catalogCategoryAttributeCurrentStore (SOAP V2)
+
+
+
+
+
Allows you to set/get the current store view.
+
+
Aliases:
+
+
category_attribute.currentStore
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
storeView
+
Store view ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category_attribute.currentStore', 'english');
+var_dump ($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAttributeCurrentStore($sessionId, 'english');
+var_dump($result);
Allows you to retrieve the list of category attributes.
+
+
Aliases:
+
+
category_attribute.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogAttributeEntity
+
+
+
+
+
The catalogAttributeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
attribute_id
+
Attribute ID
+
+
+
string
+
code
+
Attribute code
+
+
+
string
+
type
+
Attribute type
+
+
+
string
+
required
+
Defines whether the attribute is required
+
+
+
string
+
scope
+
Attribute scope: global, website, or store
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category_attribute.list',);
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAttributeList($sessionId);
+var_dump($result);
The catalogAttributeOptionEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
label
+
Option label
+
+
+
string
+
value
+
Option value
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category_attribute.options', '65');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAttributeOptions($sessionId, '65');
+var_dump($result);
Example 2. Creating, viewing, updating, and deleting a product
+
+
+
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+
+$attributeSets = $proxy->call($sessionId, 'product_attribute_set.list');
+$set = current($attributeSets);
+
+
+$newProductData = array(
+ 'name' => 'name of product',
+ // websites - Array of website ids to which you want to assign a new product
+ 'websites' => array(1), // array(1,2,3,...)
+ 'short_description' => 'short description',
+ 'description' => 'description',
+ 'status' => 1,
+ 'weight' => 0,
+ 'tax_class_id' => 1,
+ 'categories' => array(3), //3 is the category id
+ 'price' => 12.05
+);
+
+// Create new product
+$proxy->call($sessionId, 'product.create', array('simple', $set['set_id'], 'sku_of_product', $newProductData));
+$proxy->call($sessionId, 'product_stock.update', array('sku_of_product', array('qty'=>50, 'is_in_stock'=>1)));
+
+// Get info of created product
+var_dump($proxy->call($sessionId, 'product.info', 'sku_of_product'));
+
+// Update product name on german store view
+$proxy->call($sessionId, 'product.update', array('sku_of_product', array('name'=>'new name of product'), 'german'));
+
+// Get info for default values
+var_dump($proxy->call($sessionId, 'product.info', 'sku_of_product'));
+// Get info for german store view
+
+var_dump($proxy->call($sessionId, 'product.info', array('sku_of_product', 'german')));
+
+// Delete product
+$proxy->call($sessionId, 'product.delete', 'sku_of_product');
+
+try {
+ // Ensure that product deleted
+ var_dump($proxy->call($sessionId, 'product.info', 'sku_of_product'));
+} catch (SoapFault $e) {
+ echo "Product already deleted";
+}
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.create.html b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.create.html
new file mode 100644
index 0000000000..31ca39b92b
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.create.html
@@ -0,0 +1,516 @@
+---
+layout: v1x_soap
+title: Product Create
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.create (SOAP V1)
+
catalogProductCreate (SOAP V2)
+
+
+
+
Allows you to create a new product and return ID of the created product.
+
+
Aliases:
+
+
product.create
+
+
+
Note:
+
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Product type
+
+
+
string
+
set
+
ID of the product attribute set
+
+
+
string
+
sku
+
Product SKU
+
+
+
array
+
productData
+
Array of catalogProductCreateEntity
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
result
+
ID of the created product
+
+
+
+
+
The catalogProductCreateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
ArrayOfString
+
categories
+
Array of categories
+
+
+
ArrayOfString
+
websites
+
Array of websites
+
+
+
string
+
name
+
Product name
+
+
+
string
+
description
+
Product description
+
+
+
string
+
short_description
+
Product short description
+
+
+
string
+
weight
+
Product weight
+
+
+
string
+
status
+
Product status
+
+
+
string
+
url_key
+
URL key
+
+
+
string
+
url_path
+
URL path
+
+
+
string
+
visibility
+
Product visibility on the frontend
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
string
+
has_options
+
Defines whether the product has options
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available for the product
+
+
+
string
+
price
+
Product price
+
+
+
string
+
special_price
+
Product special price
+
+
+
string
+
special_from_date
+
Date starting from which the special price will be applied to the product
+
+
+
string
+
special_to_date
+
Date till which the special price will be applied to the product
+
+
+
string
+
tax_class_id
+
Tax class ID
+
+
+
array
+
tier_price
+
Array of catalogProductTierPriceEntity
+
+
+
string
+
meta_title
+
Meta title
+
+
+
string
+
meta_keyword
+
Meta keyword
+
+
+
string
+
meta_description
+
Meta description
+
+
+
string
+
custom_design
+
Custom design
+
+
+
string
+
custom_layout_update
+
Custom layout update
+
+
+
string
+
options_container
+
Options container
+
+
+
array
+
additional_attributes
+
Array of catalogProductAdditionalAttributesEntity
+
+
+
array
+
stock_data
+
Array of catalogInventoryStockItemUpdateEntity
+
+
+
+
+
Notes: The "websites" and "website_ids" or "categories" and "category_ids" parameters are interchangeable. In other words, you can specify an array of website IDs (int) and then you don't need to specify the array of website codes (string) and vice versa.
+
+
The catalogProductTierPriceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
website
+
Website
+
+
+
int
+
qty
+
Quantity
+
+
+
double
+
price
+
Tier price
+
+
+
+
+
The catalogInventoryStockItemUpdateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
qty
+
Quantity of items
+
+
+
int
+
is_in_stock
+
Defines whether the item is in stock
+
+
+
int
+
manage_stock
+
Manage stock
+
+
+
int
+
use_config_manage_stock
+
Use config manage stock
+
+
+
int
+
min_qty
+
Minimum quantity for items to be in stock
+
+
+
int
+
use_config_min_qty
+
Use config settings flag (value defined in the Inventory System Configuration)
+
+
+
int
+
min_sale_qty
+
Minimum quantity allowed in the shopping cart
+
+
+
int
+
use_config_min_sale_qty
+
Use config settings flag
+
+
+
int
+
max_sale_qty
+
Maximum quantity allowed in the shopping cart
+
+
+
int
+
use_config_max_sale_qty
+
Use config settings flag
+
+
+
int
+
is_qty_decimal
+
Defines whether the quantity is decimal
+
+
+
int
+
backorders
+
Backorders status
+
+
+
int
+
use_config_backorders
+
Use config settings flag (for backorders)
+
+
+
int
+
notify_stock_qty
+
Stock quantity below which a notification will appear
+
+
+
int
+
use_config_notify_stock_qty
+
Use config settings flag (for stock quantity)
+
+
+
+
+
The catalogProductAdditionalAttributesEntity content is as follows:
+
+
+
+
+
Type
+
Name
+
+
+
associativeMultiArray
+
multi_data
+
+
+
associativeArray
+
single_data
+
+
+
+
+
Single Data: array of attributes with only single value
+Multi Data: array of attributes which could contain several values
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
100
+
Requested store view not found.
+
+
+
102
+
Invalid data given. Details in error message.
+
+
+
104
+
Product type is not in allowed types.
+
+
+
105
+
Product attribute set is not existed
+
+
+
106
+
Product attribute set is not belong catalog product entity type
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+// get attribute set
+$attributeSets = $client->call($session, 'product_attribute_set.list');
+$attributeSet = current($attributeSets);
+
+
+$result = $client->call($session, 'catalog_product.create', array('simple', $attributeSet['set_id'], 'product_sku', array(
+ 'categories' => array(2),
+ 'websites' => array(1),
+ 'name' => 'Product name',
+ 'description' => 'Product description',
+ 'short_description' => 'Product short description',
+ 'weight' => '10',
+ 'status' => '1',
+ 'url_key' => 'product-url-key',
+ 'url_path' => 'product-url-path',
+ 'visibility' => '4',
+ 'price' => '100',
+ 'tax_class_id' => 1,
+ 'meta_title' => 'Product meta title',
+ 'meta_keyword' => 'Product meta keyword',
+ 'meta_description' => 'Product meta description'
+)));
+
+var_dump ($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+// get attribute set
+$attributeSets = $client->catalogProductAttributeSetList($session);
+$attributeSet = current($attributeSets);
+
+$result = $client->catalogProductCreate($session, 'simple', $attributeSet->set_id, 'product_sku', array(
+ 'categories' => array(2),
+ 'websites' => array(1),
+ 'name' => 'Product name',
+ 'description' => 'Product description',
+ 'short_description' => 'Product short description',
+ 'weight' => '10',
+ 'status' => '1',
+ 'url_key' => 'product-url-key',
+ 'url_path' => 'product-url-path',
+ 'visibility' => '4',
+ 'price' => '100',
+ 'tax_class_id' => 1,
+ 'meta_title' => 'Product meta title',
+ 'meta_keyword' => 'Product meta keyword',
+ 'meta_description' => 'Product meta description'
+));
+
+var_dump ($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.currentStore.html b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.currentStore.html
new file mode 100644
index 0000000000..6a34fb28a7
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.currentStore.html
@@ -0,0 +1,103 @@
+---
+layout: v1x_soap
+title: Current Product Store
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
catalog_product.currentStore (SOAP V1)
+
catalogProductCurrentStore (SOAP V2)
+
+
+
+
Allows you to set/get the current store view.
+
+
Aliases:
+
+
product.currentStore
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int/string
+
storeView
+
Store view ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.currentStore', 'english');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCurrentStore($sessionId, 'english');
+var_dump($result);
+
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.delete.html b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.delete.html
new file mode 100644
index 0000000000..bd719244cb
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.delete.html
@@ -0,0 +1,124 @@
+---
+layout: v1x_soap
+title: Product Delete
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.delete (SOAP V1)
+
catalogProductDelete (SOAP V2)
+
+
+
+
Allows you to delete the required product.
+
+
Aliases:
+
+
product.delete
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean/int
+
result
+
True (1) if the product is deleted
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.delete', '6');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductDelete($sessionId, '6');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.getSpecialPrice.html b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.getSpecialPrice.html
new file mode 100644
index 0000000000..4fd41d40ef
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.getSpecialPrice.html
@@ -0,0 +1,165 @@
+---
+layout: v1x_soap
+title: Get Special Price
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.getSpecialPrice (SOAP V1)
+
catalogProductGetSpecialPrice (SOAP V2)
+
+
+
+
Allows you to get the product special price data.
+
+
Aliases:
+
+
product.getSpecialPrice
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductReturnEntity
+
+
+
+
+
The catalogProductReturnEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
special_price
+
Product special price
+
+
+
string
+
special_from_date
+
Date starting from which the special price is applied to the product
+
+
+
string
+
special_to_date
+
Date till which the special price is applied to the product
+
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.getSpecialPrice', '1');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductGetSpecialPrice($sessionId, '1');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.info.html b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.info.html
new file mode 100644
index 0000000000..5720ebe11c
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.info.html
@@ -0,0 +1,444 @@
+---
+layout: v1x_soap
+title: Product Info
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.info (SOAP V1)
+
catalogProductInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the required product.
+
+
Aliases:
+
+
product.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
productId
+
Product ID or SKU
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
array
+
attributes
+
Array of catalogProductRequestAttributes (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU value is passed in the "productId" parameter. (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
info
+
Array of catalogProductReturnEntity
+
+
+
+
+
The catalogProductRequestAttributes content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
ArrayOfString
+
attributes
+
Array of attributes
+
+
+
ArrayOfString
+
additional_attributes
+
Array of additional attributes
+
+
+
+
+
The catalogProductReturnEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
set
+
Product set
+
+
+
string
+
type
+
Product type
+
+
+
ArrayOfString
+
categories
+
Array of categories
+
+
+
ArrayOfString
+
websites
+
Array of websites
+
+
+
string
+
created_at
+
Date when the product was created
+
+
+
string
+
updated_at
+
Date when the product was last updated
+
+
+
string
+
type_id
+
Type ID
+
+
+
string
+
name
+
Product name
+
+
+
string
+
description
+
Product description
+
+
+
string
+
short_description
+
Short description for a product
+
+
+
string
+
weight
+
Product weight
+
+
+
string
+
status
+
Status of a product
+
+
+
string
+
url_key
+
Relative URL path that can be entered in place of a target path
+
+
+
string
+
url_path
+
URL path
+
+
+
string
+
visibility
+
Product visibility on the frontend
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
string
+
has_options
+
Defines whether the product has options
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available for the product
+
+
+
string
+
price
+
Product price
+
+
+
string
+
special_price
+
Product special price
+
+
+
string
+
special_from_date
+
Date starting from which the special price is applied to the product
+
+
+
string
+
special_to_date
+
Date till which the special price is applied to the product
+
+
+
string
+
tax_class_id
+
Tax class ID
+
+
+
array
+
tier_price
+
Array of catalogProductTierPriceEntity
+
+
+
string
+
meta_title
+
Mate title
+
+
+
string
+
meta_keyword
+
Meta keyword
+
+
+
string
+
meta_description
+
Meta description
+
+
+
string
+
custom_design
+
Custom design
+
+
+
string
+
custom_layout_update
+
Custom layout update
+
+
+
string
+
options_container
+
Options container
+
+
+
associativeArray
+
additional_attributes
+
Array of additional attributes
+
+
+
string
+
enable_googlecheckout
+
Defines whether Google Checkout is applied to the product
+
+
+
+
+
The catalogProductTierPriceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
customer_group_id
+
ID of the customer group
+
+
+
string
+
website
+
Website
+
+
+
int
+
qty
+
Quantity to which the price will be applied
+
+
+
double
+
price
+
Price that each item will cost
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.info', '4');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductInfo($sessionId, '4');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.list.html b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.list.html
new file mode 100644
index 0000000000..b326407061
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.list.html
@@ -0,0 +1,224 @@
+---
+layout: v1x_soap
+title: Product List
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.list (SOAP V1)
+
catalogProductList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of products.
+
+
Aliases:
+
+
product.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters by attributes (optional)
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
storeView
+
Array of catalogProductEntity
+
+
+
+
+
The catalogProductEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
name
+
Product name
+
+
+
string
+
set
+
Product attribute set
+
+
+
string
+
type
+
Type of the product
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2 (List of All Products)
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductList($sessionId);
+var_dump($result);
+
+
+
+
+
Request Example SOAP V2 (Complex Filter)
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$complexFilter = array(
+ 'complex_filter' => array(
+ array(
+ 'key' => 'type',
+ 'value' => array('key' => 'in', 'value' => 'simple,configurable')
+ )
+ )
+);
+$result = $client->catalogProductList($session, $complexFilter);
+
+var_dump ($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.setSpecialPrice.html b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.setSpecialPrice.html
new file mode 100644
index 0000000000..76171eba25
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProduct/catalog_product.setSpecialPrice.html
@@ -0,0 +1,145 @@
+---
+layout: v1x_soap
+title: Set Special Price
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.setSpecialPrice (SOAP V1)
+
catalogProductSetSpecialPrice (SOAP V2)
+
+
+
+
Allows you to set the product special price.
+
+
Aliases:
+
+
product.setSpecialPrice
+
+
+
Note:
+
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
productId
+
Product ID or SKU
+
+
+
string
+
specialPrice
+
Product special price
+
+
+
string
+
fromDate
+
Date starting from which special price will be applied
+
+
+
string
+
toDate
+
Date till which special price will be applied
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
productIdentifierType
+
Defines whether the product ID or SKU is passed in the 'productId' parameter (optional)
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean/int
+
result
+
True (1) if the special price is set for the product
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.setSpecialPrice', array('product' => 'testproduct', 'specialPrice' => '77.5', 'fromDate' => '2012-03-29 12:30:51', 'toDate' => '2012-04-29 12:30:51'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductSetSpecialPrice($sessionId, '2', '77.5', '2012-03-29 12:30:51', '2012-04-29 12:30:51');
+var_dump($result);
Allows you to update the required product. Note that you should specify only those parameters which you want to be updated.
+
+
Aliases:
+
+
product.update
+
+
+
Note:
+
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID
+
+
+
array
+
productData
+
Array of catalogProductCreateEntity
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the product is updated
+
+
+
+
+
The catalogProductCreateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
ArrayOfString
+
categories
+
Array of categories
+
+
+
ArrayOfString
+
websites
+
Array of websites
+
+
+
string
+
name
+
Product name
+
+
+
string
+
description
+
Product description
+
+
+
string
+
short_description
+
Product short description
+
+
+
string
+
weight
+
Product weight
+
+
+
string
+
status
+
Product status
+
+
+
string
+
url_key
+
A relative URL path that can be entered in place of the target path
+
+
+
string
+
url_path
+
URL path
+
+
+
string
+
visibility
+
Product visibility on the frontend
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
string
+
has_options
+
Defines whether the product has options
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available for the product
+
+
+
string
+
price
+
Product price
+
+
+
string
+
special_price
+
Product special price
+
+
+
string
+
special_from_date
+
Date starting from which the special price will be applied to the product
+
+
+
string
+
special_to_date
+
Date till which the special price will be applied to the product
+
+
+
string
+
tax_class_id
+
Tax class ID
+
+
+
array
+
tier_price
+
Array of catalogProductTierPriceEntity
+
+
+
string
+
meta_title
+
Meta title
+
+
+
string
+
meta_keyword
+
Meta keyword
+
+
+
string
+
meta_description
+
Meta description
+
+
+
string
+
custom_design
+
Custom design
+
+
+
string
+
custom_layout_update
+
Custom layout update
+
+
+
string
+
options_container
+
Options container
+
+
+
associativeArray
+
additional_attributes
+
Array of catalogProductAdditionalAttributesEntity
+
+
+
array
+
stock_data
+
Array of catalogInventoryStockItemUpdateEntity
+
+
+
+
+
Notes: The "websites" and "website_ids" or "categories" and "category_ids" parameters are interchangeable. In other words, you can specify an array of website IDs (int) and then you don't need to specify the array of website codes (string) and vice versa.
+
+
The catalogProductTierPriceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
website
+
Website
+
+
+
int
+
qty
+
Quantity of items to which the price will be applied
+
+
+
double
+
price
+
Price that each item will cost
+
+
+
+
+
The catalogInventoryStockItemUpdateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
qty
+
Quantity of items
+
+
+
int
+
is_in_stock
+
Defines whether the item is in stock
+
+
+
int
+
manage_stock
+
Manage stock
+
+
+
int
+
use_config_manage_stock
+
Use config manage stock
+
+
+
int
+
min_qty
+
Minimum quantity for items to be in stock
+
+
+
int
+
use_config_min_qty
+
Use config settings flag (value defined in the Inventory System Configuration)
+
+
+
int
+
min_sale_qty
+
Minimum quantity allowed in the shopping cart
+
+
+
int
+
use_config_min_sale_qty
+
Use config settings flag
+
+
+
int
+
max_sale_qty
+
Maximum quantity allowed in the shopping cart
+
+
+
int
+
use_config_max_sale_qty
+
Use config settings flag
+
+
+
int
+
is_qty_decimal
+
Defines whether the quantity is decimal
+
+
+
int
+
backorders
+
Backorders status
+
+
+
int
+
use_config_backorders
+
Use config settings flag (for backorders)
+
+
+
int
+
notify_stock_qty
+
Stock quantity below which a notification will appear
+
+
+
int
+
use_config_notify_stock_qty
+
Use config settings flag (for stock quantity)
+
+
+
+
+
The catalogProductAdditionalAttributesEntity content is as follows:
+
+
+
+
+
Type
+
Name
+
+
+
associativeMultiArray
+
multi_data
+
+
+
associativeArray
+
single_data
+
+
+
+
+
Single Data: array of attributes with only single value
+Multi Data: array of attributes which could contain several values
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
100
+
Requested store view not found.
+
+
+
101
+
Product not exists.
+
+
+
102
+
Invalid data given. Details in error message.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$result = $client->call($session, 'catalog_product.update', array('product_sku', array(
+ 'categories' => array(2),
+ 'websites' => array(1),
+ 'name' => 'Product name new 2',
+ 'description' => 'Product description',
+ 'short_description' => 'Product short description',
+ 'weight' => '10',
+ 'status' => '1',
+ 'url_key' => 'product-url-key',
+ 'url_path' => 'product-url-path',
+ 'visibility' => '4',
+ 'price' => '100',
+ 'tax_class_id' => 1,
+ 'meta_title' => 'Product meta title',
+ 'meta_keyword' => 'Product meta keyword',
+ 'meta_description' => 'Product meta description'
+)));
+
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$result = $client->catalogProductUpdate($session, 'product_sku', array(
+ 'categories' => array(2),
+ 'websites' => array(1),
+ 'name' => 'Product name new',
+ 'description' => 'Product description',
+ 'short_description' => 'Product short description',
+ 'weight' => '10',
+ 'status' => '1',
+ 'url_key' => 'product-url-key',
+ 'url_path' => 'product-url-path',
+ 'visibility' => '4',
+ 'price' => '100',
+ 'tax_class_id' => 1,
+ 'meta_title' => 'Product meta title',
+ 'meta_keyword' => 'Product meta keyword',
+ 'meta_description' => 'Product meta description'
+));
+
+var_dump ($result);
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.create.html b/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.create.html
new file mode 100644
index 0000000000..9a3da61481
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.create.html
@@ -0,0 +1,424 @@
+---
+layout: v1x_soap
+title: Create Attribute
+---
+
+
Module: Product Attributes API
+
+
Resource: product_attribute
+
+
+
Method:
+
+
+
product_attribute.create (SOAP V1)
+
catalogProductAttributeCreate (SOAP V2)
+
+
+
+
Allows you to create a new product attribute.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
data
+
Array of catalogProductAttributeEntityToCreate
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
result
+
ID of the created attribute
+
+
+
+
+
The catalogProductAttributeEntityToCreate content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
attribute_code
+
Attribute code
+
+
+
string
+
frontend_input
+
Attribute type
+
+
+
string
+
scope
+
Attribute scope. Possible values are as follows: 'store', 'website', or 'global'
+
+
+
string
+
default_value
+
Attribute default value
+
+
+
int
+
is_unique
+
Defines whether the attribute is unique
+
+
+
int
+
is_required
+
Defines whether the attribute is required
+
+
+
ArrayOfString
+
apply_to
+
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
+
+
+
int
+
is_configurable
+
Defines whether the attribute can be used for configurable products
+
+
+
int
+
is_searchable
+
Defines whether the attribute can be used in Quick Search
+
+
+
int
+
is_visible_in_advanced_search
+
Defines whether the attribute can be used in Advanced Search
+
+
+
int
+
is_comparable
+
Defines whether the attribute can be compared on the frontend
+
+
+
int
+
is_used_for_promo_rules
+
Defines whether the attribute can be used for promo rules
+
+
+
int
+
is_visible_on_front
+
Defines whether the attribute is visible on the frontend
+
+
+
int
+
used_in_product_listing
+
Defines whether the attribute can be used in product listing
+
+
+
associativeArray
+
additional_fields
+
Array of additional fields
+
+
+
array
+
frontend_label
+
Array of catalogProductAttributeFrontendLabel
+
+
+
+
+
The catalogProductAttributeFrontendLabelEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
label
+
Text label
+
+
+
+
Notes: The "label" value for the "store_id" value set to 0 must be specified. An attribute cannot be created without specifying the label for store_id=0.
+
+
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
frontend_class
+
Input Validation for Store Owner. Possible values are as follows: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_wysiwyg_enabled
+
Enable WYSIWYG flag
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it is used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
int
+
position
+
Position
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it is used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
int
+
position
+
Position
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
102
+
Invalid request parameters.
+
+
+
103
+
Attribute code is invalid. Please use only letters (a-z), numbers (0-9) or underscore (_) in this field, first character should be a letter.
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html b/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html
new file mode 100644
index 0000000000..4ca818475e
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html
@@ -0,0 +1,99 @@
+---
+layout: v1x_soap
+title: Current Store
+---
+
+
Module: Mage_Catalog
+
+
Resource: catalog_product_attribute
+
+
Aliases:
+
+
product_attribute
+
+
+
+
Method:
+
+
catalog_product_attribute.currentStore (SOAP V1)
+
catalogProductAttributeCurrentStore (SOAP V2)
+
+
+
+
Allows you to set/get the current store view.
+
+
Aliases:
+
+
product_attribute.currentStore
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
storeView
+
Store view ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute.currentStore', 'english');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeCurrentStore($sessionId, 'english');
+var_dump($result);
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.info.html b/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.info.html
new file mode 100644
index 0000000000..cb3221c629
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.info.html
@@ -0,0 +1,410 @@
+---
+layout: v1x_soap
+title: Attribute Info
+---
+
+
+
Module: Product Attributes API
+
+
Resource: product_attribute
+
+
+
Method:
+
+
product_attribute.info (SOAP V1)
+
catalogProductAttributeInfo (SOAP V2)
+
+
+
+
Allows you to get full information about a required attribute with the list of options.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
attribute
+
Attribute code or ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductAttributeEntity
+
+
+
+
+
The catalogProductAttributeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
attribute_id
+
Attribute ID
+
+
+
string
+
attribute_code
+
Attribute code
+
+
+
string
+
frontend_input
+
Attribute type
+
+
+
string
+
scope
+
Attribute scope
+
+
+
string
+
default_value
+
Attribute default value
+
+
+
int
+
is_unique
+
Defines whether the attribute is unique
+
+
+
int
+
is_required
+
Defines whether the attribute is required
+
+
+
ArrayOfString
+
apply_to
+
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
+
+
+
int
+
is_configurable
+
Defines whether the attribute can be used for configurable products
+
+
+
int
+
is_searchable
+
Defines whether the attribute can be used in Quick Search
+
+
+
int
+
is_visible_in_advanced_search
+
Defines whether the attribute can be used in Advanced Search
+
+
+
int
+
is_comparable
+
Defines whether the attribute can be compared on the frontend
+
+
+
int
+
is_used_for_promo_rules
+
Defines whether the attribute can be used for promo rules
+
+
+
int
+
is_visible_on_front
+
Defines whether the attribute is visible on the frontend
+
+
+
int
+
used_in_product_listing
+
Defines whether the attribute can be used in product listing
+
+
+
associativeArray
+
additional_fields
+
Array of additional fields
+
+
+
array
+
options
+
Array of catalogAttributeOptionEntity
+
+
+
array
+
frontend_label
+
Array of catalogProductAttributeFrontendLabel
+
+
+
+
+
The catalogAttributeOptionEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
label
+
Text label
+
+
+
string
+
value
+
Option ID
+
+
+
+
+
The catalogProductAttributeFrontendLabelEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
label
+
Text label
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
frontend_class
+
Input Validation for Store Owner. Possible values: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_wysiwyg_enabled
+
Enable WYSIWYG flag
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
int
+
position
+
Position
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
int
+
position
+
Position
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Requested attribute not found.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_attribute.info', '11');
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeInfo($sessionId, '11');
+var_dump($result);
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.update.html b/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.update.html
new file mode 100644
index 0000000000..b8c9ab5b90
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttribute/product_attribute.update.html
@@ -0,0 +1,402 @@
+---
+layout: v1x_soap
+title: Attribute Update
+---
+
+
Module: Product Attributes API
+
+
Resource: product_attribute
+
+
+
Method:
+
+
+
product_attribute.update (SOAP V1)
+
catalogProductAttributeUpdate (SOAP V2)
+
+
+
+
Allows you to update the required attribute.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
attribute
+
Attribute code or ID
+
+
+
array
+
data
+
Array of catalogProductAttributeEntityToUpdate
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the attribute is updated
+
+
+
+
+
The catalogProductAttributeEntityToUpdate content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
scope
+
Attribute scope. Possible values are as follows: 'store', 'website', or 'global'
+
+
+
string
+
default_value
+
Attribute default value
+
+
+
int
+
is_unique
+
Defines whether the attribute is unique
+
+
+
int
+
is_required
+
Defines whether the attribute is required
+
+
+
ArrayOfString
+
apply_to
+
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
+
+
+
int
+
is_configurable
+
Defines whether the attribute can be used for configurable products
+
+
+
int
+
is_searchable
+
Defines whether the attribute can be used in Quick Search
+
+
+
int
+
is_visible_in_advanced_search
+
Defines whether the attribute can be used in Advanced Search
+
+
+
int
+
is_comparable
+
Defines whether the attribute can be compared on the frontend
+
+
+
int
+
is_used_for_promo_rules
+
Defines whether the attribute can be used for promo rules
+
+
+
int
+
is_visible_on_front
+
Defines whether the attribute can be visible on the frontend
+
+
+
int
+
used_in_product_listing
+
Defines whether the attribute can be used in product listing
+
+
+
associativeArray
+
additional_fields
+
Array of additional fields
+
+
+
array
+
frontend_label
+
Array of catalogProductAttributeFrontendLabel
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
frontend_class
+
Input Validation for Store Owner. Possible values: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_wysiwyg_enabled
+
Enable WYSIWYG flag
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
integer
+
position
+
Position
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
integer
+
position
+
Position
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The catalogProductAttributeFrontendLabel content is as follows:
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.currentStore', 'english');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaCurrentStore($sessionId, 'english');
+var_dump($result);
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html
new file mode 100644
index 0000000000..5fff30aad8
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html
@@ -0,0 +1,197 @@
+---
+layout: v1x_soap
+title: Media Info
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.info (SOAP V1)
+
catalogProductAttributeMediaInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the specified product image.
+
+
Aliases:
+
+
product_attribute_media.info
+
product_media.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
file
+
Name of the image file (e.g., /b/l/blackberry8100_2.jpg)
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductImageEntity
+
+
+
+
+
+
The catalogProductImageEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
file
+
Image file name
+
+
+
string
+
label
+
Image file label
+
+
+
string
+
position
+
Image file position
+
+
+
string
+
exclude
+
Defines whether the image will associate only to one of three image types
+
+
+
string
+
url
+
Image URL
+
+
+
ArrayOfString
+
types
+
Array of types
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.info', array('product' => '2', 'file' => '/b/l/blackberry8100_2.jpg'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaInfo($sessionId, '2', '/b/l/blackberry8100_2.jpg');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html
new file mode 100644
index 0000000000..423a3155b5
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html
@@ -0,0 +1,194 @@
+---
+layout: v1x_soap
+title: Media List
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.list (SOAP V1)
+
catalogProductAttributeMediaList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product images.
+
+
Aliases:
+
+
product_attribute_media.list
+
product_media.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or sku is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductImageEntity
+
+
+
+
+
The catalogProductImageEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
file
+
Image file name
+
+
+
string
+
label
+
Image label
+
+
+
string
+
position
+
Image position
+
+
+
string
+
exclude
+
Defines whether the image will associate only to one of three image types
+
+
+
string
+
url
+
Image URL
+
+
+
ArrayOfString
+
types
+
Array of types
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.list', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaList($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.remove.html b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.remove.html
new file mode 100644
index 0000000000..9a45f82d99
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.remove.html
@@ -0,0 +1,130 @@
+---
+layout: v1x_soap
+title: Media Remove
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.remove (SOAP V1)
+
catalogProductAttributeMediaRemove (SOAP V2)
+
+
+
+
Allows you to remove the image from a product.
+
+
Aliases:
+
+
product_attribute_media.remove
+
product_media.remove
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
file
+
Image file name (e.g., /b/l/blackberry8100_2.jpg)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the image is removed from a product
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.remove', array('product' => '3', 'file' => '/b/l/blackberry8100_2.jpg'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaRemove($sessionId, '3', '/b/l/blackberry8100_2.jpg');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.types.html b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.types.html
new file mode 100644
index 0000000000..8add016765
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.types.html
@@ -0,0 +1,160 @@
+---
+layout: v1x_soap
+title: Media Types
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.types (SOAP V1)
+
catalogProductAttributeMediaTypes (SOAP V2)
+
+
+
+
Allows you to retrieve product image types including standard image, small_image, thumbnail, etc. Note that if the product attribute set contains attributes of the Media Image type (Catalog Input Type for Store Owner > Media Image), it will also be returned in the response.
+
+
Aliases:
+
+
product_attribute_media.types
+
product_media.types
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
setId
+
ID of the product attribute set
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductAttributeMediaTypeEntity
+
+
+
+
+
The catalogProductAttributeMediaTypeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
code
+
Image type code
+
+
+
string
+
scope
+
Image scope (store, website, or global)
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.types', '4');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaTypes($sessionId, '4');
+var_dump($result);
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.update.html b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.update.html
new file mode 100644
index 0000000000..014aaf9aaa
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.update.html
@@ -0,0 +1,234 @@
+---
+layout: v1x_soap
+title: Media Update
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.update (SOAP V1)
+
catalogProductAttributeMediaUpdate (SOAP V2)
+
+
+
+
Allows you to update the product image.
+
+
Aliases:
+
+
product_attribute_media.update
+
product_media.update
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or code
+
+
+
string
+
file
+
Image file name (e.g., /i/m/image.jpeg)
+
+
+
array
+
data
+
Array of catalogProductAttributeMediaCreateEntity
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Notes: You should specify only those parameters which you want to be updated. Parameters that were not specified in the request, will preserve the previous values.
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
result
+
Result of product image updating
+
+
+
+
+
The catalogProductAttributeMediaCreateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
file
+
Array of catalogProductImageFileEntity
+
+
+
string
+
label
+
Product image label
+
+
+
string
+
position
+
Product image position
+
+
+
ArrayOfString
+
types
+
Array of types
+
+
+
string
+
exclude
+
Defines whether the image will associate only to one of three image types
+
+
+
string
+
remove
+
Image remove flag
+
+
+
+
+
The catalogProductImageFileEntity content is as follows:
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.groupAdd.html b/guides/v1.8/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.groupAdd.html
new file mode 100644
index 0000000000..b10a353444
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.groupAdd.html
@@ -0,0 +1,128 @@
+---
+layout: v1x_soap
+title: Attribute Set Group Add
+---
+
+
Module: Product Attribute Set API
+
+
Resource: product_attribute_set
+
+
+
Method:
+
+
+
product_attribute_set.groupAdd (SOAP V1)
+
catalogProductAttributeSetGroupAdd (SOAP V2)
+
+
+
+
Allows you to add a new group for attributes to the attribute set.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
attributeSetId
+
Attribute set ID
+
+
+
string
+
groupName
+
Group name
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
result
+
ID of the created group
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
112
+
Requested group exist already in requested attribute set.
+
+
+
113
+
Error while adding group to attribute set. Details in error message.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_attribute_set.groupAdd', array('attributeSetId' => '9', 'groupName' => 'new_group'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeSetGroupAdd($sessionId, '9', 'new_group');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html b/guides/v1.8/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html
new file mode 100644
index 0000000000..696357ecfa
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html
@@ -0,0 +1,155 @@
+---
+layout: v1x_soap
+title: Attribute Set List
+---
+
+
Module:Mage_Catalog
+
+
+
Resource:catalog_product_attribute_set
+
+
Aliases:
+
+
product_attribute_set
+
+
+
+
Method:
+
+
+
catalog_product_attribute_set.list (SOAP V1)
+
catalogProductAttributeSetList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product attribute sets.
+
+
Aliases:
+
+
product_attribute_set.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductAttributeSetEntity
+
+
+
+
+
The catalogProductAttributeSetEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
set_id
+
ID of the attribute set
+
+
+
string
+
name
+
Attribute set name
+
+
+
+
+
Faults:
+
+
No faults.
+
+
Examples
+
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_set.list');
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeSetList($sessionId);
+var_dump($result);
Allows you to retrieve full information about the custom option in a product.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
optionId
+
Option ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionInfoEntity
+
+
+
+
+
The catalogProductCustomOptionInfoEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
title
+
Custom option title
+
+
+
string
+
type
+
Custom option type. Can have one of the following values: "fixed" or "percent"
+
+
+
string
+
sort_order
+
Custom option sort order
+
+
+
int
+
is_require
+
Defines whether the custom option is required
+
+
+
array
+
additional_fields
+
Array of catalogProductCustomOptionAdditionalFields
+
+
+
+
+
The catalogProductCustomOptionAdditionalFields content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
title
+
Custom option title
+
+
+
string
+
price
+
Custom option price
+
+
+
string
+
price_type
+
Price type. Possible values are as follows: "fixed" or "percent"
+
+
+
string
+
sku
+
Custom option SKU
+
+
+
string
+
max_characters
+
Maximum number of characters for the customer input on the frontend (optional)
+
+
+
string
+
sort_order
+
Custom option sort order
+
+
+
string
+
file_extension
+
List of file extensions allowed to upload by the user on the frontend (optional; for the File input type)
+
+
+
string
+
image_size_x
+
Width limit for uploaded images (optional; for the File input type)
+
+
+
string
+
image_size_y
+
Height limit for uploaded images (optional; for the File input type)
+
+
+
string
+
value_id
+
Value ID
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Product with requested id does not exist.
+
+
+
104
+
Store with requested code/id does not exist.
+
+
+
105
+
Option with requested id does not exist.
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option.info', '1');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionInfo($sessionId, '1');
+var_dump($result);
Allows you to retrieve the list of custom options for a specific product.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
productId
+
Product ID
+
+
+
string
+
store
+
Store view ID or code (optional but required for WS-I mode)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionList
+
+
+
+
+
The catalogProductCustomOptionList content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
option_id
+
Custom option ID
+
+
+
string
+
title
+
Custom option title
+
+
+
string
+
type
+
Custom option type
+
+
+
string
+
sort_order
+
Custom option sort order
+
+
+
int
+
is_require
+
Defines whether the custom option is required
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Product with requested id does not exist.
+
+
+
104
+
Store with requested code/id does not exist.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option.list', '1');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionList($sessionId, '1');
+var_dump($result);
Allows you to retrieve the list of available custom option types.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionTypes
+
+
+
+
+
The catalogProductCustomOptionTypesEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
label
+
Custom option label
+
+
+
string
+
value
+
Custom option value
+
+
+
+
Faults:
+
+
No faults
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option.types');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionTypes($sessionId);
+var_dump($result);
Error while adding an option value. Details are in the error message.
+
+
+
103
+
Option with requested id does not exist.
+
+
+
104
+
Invalid option type.
+
+
+
105
+
Store with requested code/id does not exist.
+
+
+
106
+
Can not delete option.
+
+
+
107
+
Error while updating an option value. Details are in the error message.
+
+
+
108
+
Title field is required.
+
+
+
109
+
Option should have at least one value. Can not delete last value.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html b/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html
new file mode 100644
index 0000000000..01b118a963
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html
@@ -0,0 +1,198 @@
+---
+layout: v1x_soap
+title: Product Custom Value Add
+---
+
+
Module: Complex Product API
+
+
+
Resource: product_custom_option_value
+
+
+
Method:
+
+
+
product_custom_option_value.add (SOAP V1)
+
catalogProductCustomOptionValueAdd (SOAP V2)
+
+
+
+
Allows you to add a new custom option value to a custom option. Note that the custom option value can be added only to the option with the Select Input Type.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
optionId
+
Option ID
+
+
+
array
+
data
+
Array of catalogProductCustomOptionValueAdd
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the custom option value is added
+
+
+
+
+
The catalogProductCustomOptionValueAdd content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
title
+
Custom option value title
+
+
+
string
+
price
+
Custom option value price
+
+
+
string
+
price_type
+
Type of the custom option value price. Can have one of the following values: "fixed" or "percent"
+
+
+
string
+
sku
+
Custom option value row SKU
+
+
+
string
+
sort_order
+
Custom option value sort order
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Option value with requested id does not exist.
+
+
+
102
+
Error while adding an option value. Details are in the error message.
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.info.html b/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.info.html
new file mode 100644
index 0000000000..e438d6665a
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.info.html
@@ -0,0 +1,218 @@
+---
+layout: v1x_soap
+title: Product Custom Value Info
+---
+
+
Module: Complex Product API
+
+
+
Resource: product_custom_option_value
+
+
+
Method:
+
+
+
product_custom_option_value.info (SOAP V1)
+
catalogProductCustomOptionValueInfo (SOAP V2)
+
+
+
+
Allows you to retrieve full information about the specified product custom option value.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
valueId
+
Value ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionValueInfoEntity
+
+
+
+
+
The catalogProductCustomOptionValueInfoEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
value_id
+
Option value ID
+
+
+
string
+
option_id
+
Option ID
+
+
+
string
+
sku
+
Custom option value row SKU
+
+
+
string
+
sort_order
+
Option value sort order
+
+
+
string
+
default_price
+
Option value default price
+
+
+
string
+
default_price_type
+
Default price type. Possible values are as follows: "fixed" or "percent"
+
+
+
string
+
store_price
+
Option value store price
+
+
+
string
+
store_price_type
+
Store price type. Possible values are as follows: "fixed" or "percent"
+
+
+
string
+
price
+
Option value price
+
+
+
string
+
price_type
+
Price type. Possible values are as follows: "fixed" or "percent"
+
+
+
string
+
default_title
+
Option value default title
+
+
+
string
+
store_title
+
Option value store title
+
+
+
string
+
title
+
Option value title
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Option value with requested id does not exist.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option_value.info', '5');
+var_dump($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionValueInfo($sessionId, '5');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.list.html b/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.list.html
new file mode 100644
index 0000000000..b84d9cc361
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.list.html
@@ -0,0 +1,197 @@
+---
+layout: v1x_soap
+title: Product Custom Value List
+---
+
+
Module: Complex Product API
+
+
+
Resource: product_custom_option_value
+
+
+
Method:
+
+
+
product_custom_option_value.list (SOAP V1)
+
catalogProductCustomOptionValueList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product custom option values. Note that the method is available only for the option Select Input Type.
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
optionId
+
Option ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionValueList
+
+
+
+
+
The catalogProductCustomOptionValueListEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
value_id
+
Custom option value ID
+
+
+
string
+
title
+
Custom option value title
+
+
+
string
+
price
+
Option value price
+
+
+
string
+
price_type
+
Price type. Possible values: "fixed" or "percent"
+
+
+
string
+
sku
+
Custom option value SKU
+
+
+
string
+
sort_order
+
Option value sort order (optional)
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Provided data is invalid.
+
+
+
102
+
Error while adding an option value. Details are in the error message.
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option_value.list', '3');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionValueList($sessionId, '3');
+var_dump($result);
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+
+// Get list of related products
+var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
+
+// Assign related product
+$proxy->call($sessionId, 'product_link.assign', array('related', 'Sku', 'Sku2', array('position'=>0, 'qty'=>56)));
+
+var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
+
+// Update related product
+$proxy->call($sessionId, 'product_link.update', array('related', 'Sku', 'Sku2', array('position'=>2)));
+
+var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
+
+// Remove related product
+$proxy->call($sessionId, 'product_link.remove', array('related', 'Sku', 'Sku2'));
+
+var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html
new file mode 100644
index 0000000000..4b6e585df7
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html
@@ -0,0 +1,176 @@
+---
+layout: v1x_soap
+title: Product Link Assign
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.assign (SOAP V1)
+
catalogProductLinkAssign (SOAP V2)
+
+
+
+
Allows you to assign a product link (cross_sell, grouped, related, or up_sell) to another product.
+
+
Aliases:
+
+
product_link.assign
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Type of the link (cross_sell, grouped, related, or up_sell)
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
linkedProduct\linkedProductId
+
Product ID or SKU for the link
+
+
+
array
+
data
+
Array of catalogProductLinkEntity
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the link is assigned to the product
+
+
+
+
+
The catalogProductLinkEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
type
+
Type of the link (cross_sell, grouped, related, or up_sell)
+
+
+
string
+
set
+
Product attribute set
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
position
+
Position of the product
+
+
+
string
+
qty
+
Quantity of products
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apikey');
+
+$result = $client->call($session, 'catalog_product_link.assign', array('type' => 'related', 'product' => '1', 'linkedProduct' => '4'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkAssign($sessionId, 'related', '1', '4');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.attributes.html b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.attributes.html
new file mode 100644
index 0000000000..b4c3394af1
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.attributes.html
@@ -0,0 +1,150 @@
+---
+layout: v1x_soap
+title: Product Link Attributes
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.attributes (SOAP V1)
+
catalogProductLinkAttributes (SOAP V2)
+
+
+
+
Allows you to retrieve the product link type attributes.
+
+
Aliases:
+
+
product_link.attributes
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Type of the link (cross_sell, up_sell, related, or grouped)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductLinkAttributeEntity
+
+
+
+
+
The catalogProductLinkAttributeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
code
+
Attribute code
+
+
+
string
+
type
+
Attribute type
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_link.attributes', 'related');
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkAttributes($sessionId, 'related');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.list.html b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.list.html
new file mode 100644
index 0000000000..989bd456d8
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.list.html
@@ -0,0 +1,192 @@
+---
+layout: v1x_soap
+title: Product Link List
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.list (SOAP V1)
+
catalogProductLinkList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of linked products for a specific product.
+
+
Aliases:
+
+
product_link.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Type of the link (cross_sell, up_sell, related, or grouped)
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductLinkEntity
+
+
+
+
+
The catalogProductLinkEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
type
+
Type of the link
+
+
+
string
+
set
+
Product attribute set
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
position
+
Position
+
+
+
string
+
qty
+
Quantity
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_link.list', array('type' => 'related', 'product' => '1'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkList($sessionId, 'related', '1');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.remove.html b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.remove.html
new file mode 100644
index 0000000000..20717ad565
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.remove.html
@@ -0,0 +1,130 @@
+---
+layout: v1x_soap
+title: Product Link Remove
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.remove (SOAP V1)
+
catalogProductLinkRemove (SOAP V2)
+
+
+
+
Allows you to remove the product link from a specific product.
+
+
Aliases:
+
+
product_link.remove
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Type of the link (cross_sell, up_sell, related, or grouped)
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
linkedProduct\linkedProductId
+
Product ID or SKU for the link
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the link is removed from a product
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_link.remove', array('type' => 'related', 'product' => '1', 'linkedProduct' => '4'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkRemove($sessionId, 'related', '1', '4');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.types.html b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.types.html
new file mode 100644
index 0000000000..19fd4e0453
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductLink/catalog_product_link.types.html
@@ -0,0 +1,127 @@
+---
+layout: v1x_soap
+title: Product Link Types
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.types (SOAP V1)
+
catalogProductLinkTypes (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product link types.
+
+
Aliases:
+
+
product_link.types
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
ArrayOfString
+
result
+
Array of link types
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_link.types');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkTypes($sessionId);
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductTag/product_tag.remove.html b/guides/v1.8/api/soap/catalog/catalogProductTag/product_tag.remove.html
new file mode 100644
index 0000000000..4a4be55a82
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductTag/product_tag.remove.html
@@ -0,0 +1,119 @@
+---
+layout: v1x_soap
+title: Product Tag Remove
+---
+
+
Module: Tag API
+
+
Resource: catalog_product_tag
+
+
Aliases: product_tag
+
+
+
Method:
+
+
+
catalog_product_tag.remove (SOAP V1)
+
catalogProductTagRemove (SOAP V2)
+
+
+
+
Allows you to remove an existing product tag.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
tagId
+
Tag ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the product tag is removed
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
104
+
Requested tag does not exist.
+
+
+
107
+
Error while removing tag. Details in error message.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_tag.remove', '3');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductTagRemove($sessionId, '3');
+var_dump($result);
Allows you to retrieve information about product tier prices.
+
+
Aliases:
+
+
product_attribute_tier_price.info
+
product_tier_price.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductTierPriceEntity
+
+
+
+
+
The catalogProductTierPriceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
website
+
Website
+
+
+
int
+
qty
+
Quantity of items to which the price will be applied
+
+
+
double
+
price
+
Price that each item will cost
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_tier_price.info', 'productId');
+var_dump($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$productId = 1;
+
+$result = $client->catalogProductAttributeTierPriceInfo(
+ $session,
+ $productId
+);
+
+
diff --git a/guides/v1.8/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html b/guides/v1.8/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html
new file mode 100644
index 0000000000..8f09eb0876
--- /dev/null
+++ b/guides/v1.8/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html
@@ -0,0 +1,169 @@
+---
+layout: v1x_soap
+title: Product Type List
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_type
+
+
Aliases:
+
+
product_type
+
+
+
+
Method:
+
+
+
catalog_product_type.list (SOAP V1)
+
catalogProductTypeList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product types.
+
+
Aliases:
+
+
product_type.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductTypeEntity
+
+
+
+
+
The catalogProductTypeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
type
+
Product type
+
+
+
string
+
label
+
Product label in the Admin Panel
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_type.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductTypeList($sessionId);
+var_dump($result);
The use_config_manage_stock unchecks the ‘Use Config Settings’ box which allows you to make changes to this product and not to use the global settings that are set by default.
+
+
Example 1. Working with stock update
+
+
+
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+
+// Get stock info
+var_dump($proxy->call($sessionId, 'product_stock.list', 'Sku'));
+
+// Update stock info
+$proxy->call($sessionId, 'product_stock.update', array('Sku', array('qty'=>50, 'is_in_stock'=>1)));
+
+var_dump($proxy->call($sessionId, 'product_stock.list', 'Sku'));
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/catalogInventory/cataloginventory_stock_item.list.html b/guides/v1.8/api/soap/catalogInventory/cataloginventory_stock_item.list.html
new file mode 100644
index 0000000000..b68ea73e57
--- /dev/null
+++ b/guides/v1.8/api/soap/catalogInventory/cataloginventory_stock_item.list.html
@@ -0,0 +1,166 @@
+---
+layout: v1x_soap
+title: Inventory Item List
+---
+
+
Module: Mage_CatalogInventory
+
+
+
Resource: cataloginventory_stock_item
+
+
Aliases:
+
+
product_stock
+
+
+
+
Method:
+
+
+
cataloginventory_stock_item.list (SOAP V1)
+
catalogInventoryStockItemList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of stock data by product IDs.
+
+
Aliases:
+
+
product_stock.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
ArrayOfString
+
products/productIds (for WS-I mode)
+
List of product IDs or SKUs
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogInventoryStockItemEntity
+
+
+
+
+
The catalogInventoryStockItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
qty
+
Product quantity
+
+
+
string
+
is_in_stock
+
Defines whether the product is in stock
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cataloginventory_stock_item.list', '1');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogInventoryStockItemList($sessionId, array('1', '2'));
+var_dump($result);
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.
Can not make operation because store is not exists
+
+
+
1002
+
Can not make operation because quote is not exists
+
+
+
1003
+
Can not create a quote.
+
+
+
1004
+
Can not create a quote because quote with such identifier is already exists
+
+
+
1005
+
You did not set all required agreements
+
+
+
1006
+
The checkout type is not valid. Select single checkout type.
+
+
+
1007
+
Checkout is not available for guest
+
+
+
1008
+
Can not create an order.
+
+
+
+
+
Example
+
+
The following example illustrates the work with shopping cart (creation of a shopping cart, setting customer and customer addresses, adding products to the shopping cart, updating products in the shopping cart, removing products from the shopping cart, getting the list of products/shipping methods/payment methods, setting payment/shipping methods, adding/removing coupon, getting total prices/full information about shopping cart/list of licenses, and creating an order.
diff --git a/guides/v1.8/api/soap/checkout/cart/cart.info.html b/guides/v1.8/api/soap/checkout/cart/cart.info.html
new file mode 100644
index 0000000000..66385e24d1
--- /dev/null
+++ b/guides/v1.8/api/soap/checkout/cart/cart.info.html
@@ -0,0 +1,944 @@
+---
+layout: v1x_soap
+title: Cart Info
+---
+
+
Mage_Checkout
+
+
Module: Shopping Cart API
+
+
Resource: cart
+
+
+
Method:
+
+
+
cart.info (SOAP V1)
+
shoppingCartInfo (SOAP V2)
+
+
+
+
Allows you to retrieve full information about the shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID (quote ID)
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of shoppingCartInfoEntity
+
+
+
+
+
The shoppingCartInfoEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
converted_at
+
Date of conversion
+
+
+
int
+
quote_id
+
Quote ID
+
+
+
int
+
is_active
+
Active flag
+
+
+
int
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
int
+
is_multi_shipping
+
Defines whether multi shipping is available
+
+
+
double
+
items_count
+
Items quantity
+
+
+
double
+
items_qty
+
Total items quantity
+
+
+
string
+
orig_order_id
+
Original order ID
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
store_to_quote_rate
+
Store to quote rate
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
quote_currency_code
+
Quote currency code
+
+
+
string
+
grand_total
+
Grand total
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
checkout_method
+
Checkout method
+
+
+
string
+
customer_id
+
Customer ID
+
+
+
string
+
customer_tax_class_id
+
Customer tax class ID
+
+
+
int
+
customer_group_id
+
Customer group ID
+
+
+
string
+
customer_email
+
Customer email address
+
+
+
string
+
customer_prefix
+
Customer prefix
+
+
+
string
+
customer_firstname
+
Customer first name
+
+
+
string
+
customer_middlename
+
Customer middle name
+
+
+
string
+
customer_lastname
+
Customer last name
+
+
+
string
+
customer_suffix
+
Customer suffix
+
+
+
string
+
customer_note
+
Customer note
+
+
+
string
+
customer_note_notify
+
Customer notification flag
+
+
+
string
+
customer_is_guest
+
Defines whether the customer is a guest
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
reserved_order_id
+
Reserved order ID
+
+
+
string
+
password_hash
+
Password hash
+
+
+
string
+
coupon_code
+
Coupon code
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
double
+
base_to_global_rate
+
Base to global rate
+
+
+
double
+
base_to_quote_rate
+
Base to quote rate
+
+
+
string
+
customer_taxvat
+
Customer taxvat value
+
+
+
string
+
customer_gender
+
Customer gender
+
+
+
double
+
subtotal
+
Subtotal
+
+
+
double
+
base_subtotal
+
Base subtotal
+
+
+
double
+
subtotal_with_discount
+
Subtotal with discount
+
+
+
double
+
base_subtotal_with_discount
+
Base subtotal with discount
+
+
+
string
+
ext_shipping_info
+
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
double
+
customer_balance_amount_used
+
Used customer balance amount
+
+
+
double
+
base_customer_balance_amount_used
+
Used base customer balance amount
+
+
+
string
+
use_customer_balance
+
Defines whether to use the customer balance
+
+
+
string
+
gift_cards_amount
+
Gift cards amount
+
+
+
string
+
base_gift_cards_amount
+
Base gift cards amount
+
+
+
string
+
gift_cards_amount_used
+
Used gift cards amount
+
+
+
string
+
use_reward_points
+
Defines whether to use reward points
+
+
+
string
+
reward_points_balance
+
Reward points balance
+
+
+
string
+
base_reward_currency_amount
+
Base reward currency amount
+
+
+
string
+
reward_currency_amount
+
Reward currency amount
+
+
+
array
+
shipping_address
+
Array of shoppingCartAddressEntity
+
+
+
array
+
billing_address
+
Array of shoppingCartAddressEntity
+
+
+
array
+
items
+
Array of shoppingCartItemEntity
+
+
+
array
+
payment
+
Array of shoppingCartPaymentEntity
+
+
+
+
+
The shoppingCartAddressEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
address_id
+
Shopping cart address ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
customer_id
+
Customer ID
+
+
+
int
+
save_in_address_book
+
Defines whether to save the address in the address book
+
+
+
string
+
customer_address_id
+
Customer address ID
+
+
+
string
+
address_type
+
Address type
+
+
+
string
+
email
+
Email address
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
company
+
Company name
+
+
+
string
+
street
+
Street
+
+
+
string
+
city
+
City
+
+
+
string
+
region
+
Region
+
+
+
string
+
region_id
+
Region ID
+
+
+
string
+
postcode
+
Postcode
+
+
+
string
+
country_id
+
Country ID
+
+
+
string
+
telephone
+
Telephone number
+
+
+
string
+
fax
+
Fax
+
+
+
int
+
same_as_billing
+
Defines whether the address is the same as the billing one
+
+
+
int
+
free_shipping
+
Defines whether free shipping is used
+
+
+
string
+
shipping_method
+
Shipping method
+
+
+
string
+
shipping_description
+
Shipping description
+
+
+
double
+
weight
+
Weight
+
+
+
+
+
The shoppingCartItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
item_id
+
Cart item ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
parent_item_id
+
Parent item ID
+
+
+
int
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
name
+
Product name
+
+
+
string
+
description
+
Description
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
additional_data
+
Additional data
+
+
+
string
+
free_shipping
+
Free shipping
+
+
+
string
+
is_qty_decimal
+
Defines whether the quantity is decimal
+
+
+
string
+
no_discount
+
Defines whether no discount is applied
+
+
+
double
+
weight
+
Weight
+
+
+
double
+
qty
+
Quantity
+
+
+
double
+
price
+
Price
+
+
+
double
+
base_price
+
Base price
+
+
+
double
+
custom_price
+
Custom price
+
+
+
double
+
discount_percent
+
Discount percent
+
+
+
double
+
discount_amount
+
Discount amount
+
+
+
double
+
base_discount_amount
+
Base discount amount
+
+
+
double
+
tax_percent
+
Tax percent
+
+
+
double
+
tax_amount
+
Tax amount
+
+
+
double
+
base_tax_amount
+
Base tax amount
+
+
+
double
+
row_total
+
Row total
+
+
+
double
+
base_row_total
+
Base row total
+
+
+
double
+
row_total_with_discount
+
Row total with discount
+
+
+
double
+
row_weight
+
Row weight
+
+
+
string
+
product_type
+
Product type
+
+
+
double
+
base_tax_before_discount
+
Base tax before discount
+
+
+
double
+
tax_before_discount
+
Tax before discount
+
+
+
double
+
original_custom_price
+
Original custom price
+
+
+
double
+
base_cost
+
Base cost
+
+
+
double
+
price_incl_tax
+
Price including tax
+
+
+
double
+
base_price_incl_tax
+
Base price including tax
+
+
+
double
+
row_total_incl_tax
+
Row total including tax
+
+
+
double
+
base_row_total_incl_tax
+
Base row total including tax
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available
+
+
+
double
+
weee_tax_applied
+
Applied fix product tax
+
+
+
double
+
weee_tax_applied_amount
+
Applied fix product tax amount
+
+
+
double
+
weee_tax_applied_row_amount
+
Applied fix product tax row amount
+
+
+
double
+
base_weee_tax_applied_amount
+
Applied fix product tax amount (in base currency)
+
+
+
double
+
base_weee_tax_applied_row_amount
+
Applied fix product tax row amount (in base currency)
+
+
+
double
+
weee_tax_disposition
+
Fixed product tax disposition
+
+
+
double
+
weee_tax_row_disposition
+
Fixed product tax row disposition
+
+
+
double
+
base_weee_tax_disposition
+
Fixed product tax disposition (in base currency)
+
+
+
double
+
base_weee_tax_row_disposition
+
Fixed product tax row disposition (in base currency)
+
+
+
string
+
tax_class_id
+
Tax class ID
+
+
+
+
+
The shoppingCartPaymentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
payment_id
+
Payment ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
method
+
Payment method
+
+
+
string
+
cc_type
+
Credit card type
+
+
+
string
+
cc_number_enc
+
Credit card number
+
+
+
string
+
cc_last4
+
Last four digits on the credit card
+
+
+
string
+
cc_cid_enc
+
Credit card CID
+
+
+
string
+
cc_owner
+
Credit card owner
+
+
+
string
+
cc_exp_month
+
Credit card expiration month
+
+
+
string
+
cc_exp_year
+
Credit card expiration year
+
+
+
string
+
cc_ss_owner
+
Credit card owner (Switch/Solo)
+
+
+
string
+
cc_ss_start_month
+
Credit card start month (Switch/Solo)
+
+
+
string
+
cc_ss_start_year
+
Credit card start year (Switch/Solo)
+
+
+
string
+
cc_ss_issue
+
Credit card issue number (Switch/Solo)
+
+
+
string
+
po_number
+
Purchase order number
+
+
+
string
+
additional_data
+
Additional data
+
+
+
string
+
additional_information
+
Additional information
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cart.info', '15');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->shoppingCartInfo($sessionId, '15');
+var_dump($result);
+
+
+
diff --git a/guides/v1.8/api/soap/checkout/cart/cart.order.html b/guides/v1.8/api/soap/checkout/cart/cart.order.html
new file mode 100644
index 0000000000..06948f05e4
--- /dev/null
+++ b/guides/v1.8/api/soap/checkout/cart/cart.order.html
@@ -0,0 +1,174 @@
+---
+layout: v1x_soap
+title: Cart Order
+---
+
+
Mage_Checkout
+
+
+
Module: Shopping Cart API
+
+
Resource: cart
+
+
Method:
+
+
+
cart.order (SOAP V1)
+
shoppingCartOrder (SOAP V2)
+
+
+
+
Allows you to create an order from a shopping cart (quote).
+Before placing the order, you need to add the customer, customer address, shipping and payment methods.
Allows you to retrieve total prices for a shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID (quote identifier)
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of shoppingCartTotalsEntity
+
+
+
+
+
The shoppingCartTotalsEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
title
+
Title
+
+
+
float
+
amount
+
Total amount
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cart.totals', '15');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->shoppingCartTotals($sessionId, '15');
+var_dump($result);
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.
+
+
Cart Coupon
+
+
Allows you to add and remove coupon codes for a shopping cart.
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 the frontend logic. The cart is represented by the Mage_Checkout_Model_Cart class and the quote is represented by the Mage_Sales_Model_Quote class.
+
+
Faults
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
1001
+
Can not make operation because store is not exists
+
+
+
1002
+
Can not make operation because quote is not exists
+
+
+
1081
+
Coupon could not be applied because quote is empty.
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.
+
+
Cart Customer
+
+
Allows you to add customer information and addresses into a shopping cart.
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.
+
+
Cart Payment
+
+
Allows you to retrieve and set payment methods for a shopping cart.
cart_payment.list - Get the list of available payment methods for a shopping cart
+
+
+
+
Faults
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
1001
+
Can not make operation because store is not exists
+
+
+
1002
+
Can not make operation because quote is not exists
+
+
+
1071
+
Payment method data is empty.
+
+
+
1072
+
Customer’s billing address is not set. Required for payment method data.
+
+
+
1073
+
Customer’s shipping address is not set. Required for payment method data.
+
+
+
1074
+
Payment method is not allowed
+
+
+
1075
+
Payment method is not set.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/checkout/cartPayment/cart_payment.list.html b/guides/v1.8/api/soap/checkout/cartPayment/cart_payment.list.html
new file mode 100644
index 0000000000..688e4f5b98
--- /dev/null
+++ b/guides/v1.8/api/soap/checkout/cartPayment/cart_payment.list.html
@@ -0,0 +1,132 @@
+---
+layout: v1x_soap
+title: Payment List
+---
+
+
Mage_Checkout
+
+
+
Module: Shopping Cart API
+
+
Resource: cart_payment
+
+
Method:
+
+
cart_payment.list (SOAP V1)
+
shoppingCartPaymentList (SOAP V2)
+
+
+
+
Allows you to retrieve a list of available payment methods for a shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of shoppingCartPaymentMethodResponseEntity
+
+
+
+
+
The shoppingCartPaymentMethodResponseEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
code
+
Payment method code
+
+
+
string
+
title
+
Payment method title
+
+
+
associativeArray
+
cc_types
+
Array of credit card types
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cart_payment.list', 'quoteId');
+var_dump($result);
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.
Can not make operation because store is not exists
+
+
+
1002
+
Can not make operation because quote is not exists
+
+
+
1021
+
Product’s data is not valid.
+
+
+
1022
+
Product(s) could not be added.
+
+
+
1023
+
Quote could not be saved during adding product(s) operation.
+
+
+
1024
+
Product(s) could not be updated.
+
+
+
1025
+
Quote could not be saved during updating product(s) operation.
+
+
+
1026
+
Product(s) could not be removed.
+
+
+
1027
+
Quote could not be saved during removing product(s) operation.
+
+
+
1028
+
Customer is not set for quote.
+
+
+
1029
+
Customer’s quote is not existed.
+
+
+
1030
+
Quotes are identical.
+
+
+
1031
+
Product(s) could not be moved.
+
+
+
1032
+
One of quote could not be saved during moving product(s) operation.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/checkout/cartProduct/cart_product.add.html b/guides/v1.8/api/soap/checkout/cartProduct/cart_product.add.html
new file mode 100644
index 0000000000..244186d154
--- /dev/null
+++ b/guides/v1.8/api/soap/checkout/cartProduct/cart_product.add.html
@@ -0,0 +1,203 @@
+---
+layout: v1x_soap
+title: Product Add
+---
+
+
Shopping Cart API
+
+
Allows you to create/modify shopping cart and create an order after complete filling the shopping cart. Consists of two main parts: Shopping Cart and Checkout processes.
+
+
Module: Mage_Checkout
+
+
Resource: cart_product
+
+
Method:
+
+
+
cart_product.add (SOAP V1)
+
shoppingCartProductAdd (SOAP V2)
+
+
+
+
Allows you to add one or more products to the shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID (quote ID)
+
+
+
array
+
products\productsData
+
An array with the list of shoppingCartProductEntity
+
+
+
string
+
storeId
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True on success (if the product is added to the shopping cart)
+
+
+
+
+
The shoppingCartProductEntity array attributes are as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
ID of the product to be added to the shopping cart (quote) (optional)
+
+
+
string
+
sku
+
SKU of the product to be added to the shopping cart (quote) (optional)
+
+
+
double
+
qty
+
Number of products to be added to the shopping cart (quote) (optional)
+
+
+
associativeArray
+
options
+
An array in the form of option_id => content (optional)
+
+
+
diff --git a/guides/v1.8/api/soap/checkout/cartProduct/cart_product.list.html b/guides/v1.8/api/soap/checkout/cartProduct/cart_product.list.html
new file mode 100644
index 0000000000..0cd1c3f657
--- /dev/null
+++ b/guides/v1.8/api/soap/checkout/cartProduct/cart_product.list.html
@@ -0,0 +1,180 @@
+---
+layout: v1x_soap
+title: Product List
+---
+
+
Mage_Checkout
+
+
+
Module: Shopping Cart API
+
+
Resource: cart_product
+
+
+
Method:
+
+
+
cart_product.list (SOAP V1)
+
shoppingCartProductList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of products in the shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of shoppingCartProductResponseEntity
+
+
+
+
+
The shoppingCartProductResponseEntity (catalogProductEntity) content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
name
+
Product name
+
+
+
string
+
set
+
Product attribute set
+
+
+
string
+
type
+
Product type
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
+
Faults:
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cart_product.list', '15');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->shoppingCartProductList($sessionId, '15');
+var_dump($result);
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.
+
+
Cart Shipping
+
+
Allows you to retrieve and set shipping methods for a shopping cart.
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.
+
+
Cart Coupon
+
+
Allows you to add and remove coupon codes for a shopping cart.
The Core API allows you to manage a set of common resources used in Magento. However, you may choose to have your own set of resources to manage, or you may wish to extend the Core API to handle additional resources.
+
+
This tutorial leads you through the process of creating a custom API for a customer module that handles basic customer information.
+
+
Note: This tutorial applies to v1 of the API.
+
+
To learn more about the Core API, to read Magento Core API calls.
+
+
For general information about the Magento API, go to the Introduction.
+
+
1. Creating an XML File that Will Define the API Resource
+
+
Create a file named api.xml in the /etc folder in the customer module. Start with the empty structure, as follows:
Add an element named customer in the <resources> element. Add a <methods> element, with elements for list, create, info, update and remove methods for customer resource.
The resource can return some faults, so add a <faults> element in the customer element, and list the various faults.
+
+
+
<config>
+ <api>
+....
+ <resources>
+ <customer translate="title" module="customer">
+....
+ <faults module="customer"> <!-- module="customer" specifies the module which will be used for translation. -->
+ <data_invalid> <!-- if we get invalid input data for customers -->
+ <code>100</code >
+ <!-- we cannot know all the errors that can appear, their details can be found in error message for call -->
+ <message>Invalid customer data. Details in error message.</message>
+ </data_invalid>
+ <filters_invalid>
+ <code>101</code >
+ <message>Invalid filters specified. Details in error message.</message>
+ </filters_invalid>
+ <not_exists>
+ <code>102</code >
+ <message>Customer doesn't exist.</message>
+ </not_exists>
+ <not_deleted>
+ <code>103</code >
+ <message>Customer was not deleted. Details in error message.</message>
+ </not_deleted>
+ </faults>
+ </customer>
+ </resources>
+....
+ </api>
+</config>
+
+
+
+
4. Describing the Access Control List (ACL) for the Resource
+
+
In order to prevent unauthorized access to our custom API, you must first list the resources that are restricted within the <acl> element.
Next, write some PHP code to access the resources. Start by creating a class called Mage_Customer_Model_Customer_Api that extends Mage_Api_Model_Resource_Abstract. Save it into a file called api.php.
+
+
+
class Mage_Customer_Model_Customer_Api extends Mage_Api_Model_Resource_Abstract
+{
+
+ public function create($customerData)
+ {
+ }
+
+ public function info($customerId)
+ {
+ }
+
+ public function items($filters)
+ {
+ }
+
+ public function update($customerId, $customerData)
+ {
+ }
+
+ public function delete($customerId)
+ {
+ }
+}
+
+
+
+
Note that you cannot create method "list" because it’s a PHP keyword, so instead the method is named items. In order to make this work, add a <method> element into the <list> element in api.xml, as shown below.
Now add some simple functionality to the Mage_Customer_Model_Api methods you created.
+
+
Create a customer:
+
+
+
public function create($customerData)
+ {
+ try {
+ $customer = Mage::getModel('customer/customer')
+ ->setData($customerData)
+ ->save();
+ } catch (Mage_Core_Exception $e) {
+ $this->_fault('data_invalid', $e->getMessage());
+ // We cannot know all the possible exceptions,
+ // so let's try to catch the ones that extend Mage_Core_Exception
+ } catch (Exception $e) {
+ $this->_fault('data_invalid', $e->getMessage());
+ }
+ return $customer->getId();
+ }
+
+
+
+
Retrieve customer info:
+
+
+
public function info($customerId)
+ {
+ $customer = Mage::getModel('customer/customer')->load($customerId);
+ if (!$customer->getId()) {
+ $this->_fault('not_exists');
+ // If customer not found.
+ }
+ return $customer->toArray();
+ // We can use only simple PHP data types in webservices.
+ }
+
+
+
+
Retrieve list of customers using filtering:
+
+
+
public function items($filters)
+ {
+ $collection = Mage::getModel('customer/customer')->getCollection()
+ ->addAttributeToSelect('*');
+
+ if (is_array($filters)) {
+ try {
+ foreach ($filters as $field => $value) {
+ $collection->addFieldToFilter($field, $value);
+ }
+ } catch (Mage_Core_Exception $e) {
+ $this->_fault('filters_invalid', $e->getMessage());
+ // If we are adding filter on non-existent attribute
+ }
+ }
+
+ $result = array();
+ foreach ($collection as $customer) {
+ $result[] = $customer->toArray();
+ }
+
+ return $result;
+ }
+
+
+
+
Update a customer:
+
+
+
public function update($customerId, $customerData)
+ {
+ $customer = Mage::getModel('customer/customer')->load($customerId);
+
+ if (!$customer->getId()) {
+ $this->_fault('not_exists');
+ // No customer found
+ }
+
+ $customer->addData($customerData)->save();
+ return true;
+ }
+
+
+
+
Delete a customer:
+
+
+
public function delete($customerId)
+ {
+ $customer = Mage::getModel('customer/customer')->load($customerId);
+
+ if (!$customer->getId()) {
+ $this->_fault('not_exists');
+ // No customer found
+ }
+
+ try {
+ $customer->delete();
+ } catch (Mage_Core_Exception $e) {
+ $this->_fault('not_deleted', $e->getMessage());
+ // Some errors while deleting.
+ }
+
+ return true;
+ }
+
+
+
+
Creating a Custom Adapter
+
+
In order to create custom webservice adapter, implement the Mage_Api_Model_Server_Adapter_Interface, which is shown below.
+
+
+
interface Mage_Api_Model_Server_Adapter_Interface
+{
+ /**
+ * Set handler class name for webservice
+ *
+ * @param string $handler
+ * @return Mage_Api_Model_Server_Adapter_Interface
+ */
+ function setHandler($handler);
+
+ /**
+ * Retrieve handler class name for webservice
+ *
+ * @return string [basc]
+ */
+ function getHandler();
+
+ /**
+ * Set webservice API controller
+ *
+ * @param Mage_Api_Controller_Action $controller
+ * @return Mage_Api_Model_Server_Adapter_Interface
+ */
+ function setController(Mage_Api_Controller_Action $controller);
+
+ /**
+ * Retrieve webservice API controller
+ *
+ * @return Mage_Api_Controller_Action
+ */
+ function getController();
+
+ /**
+ * Run webservice
+ *
+ * @return Mage_Api_Model_Server_Adapter_Interface
+ */
+ function run();
+
+ /**
+ * Dispatch webservice fault
+ *
+ * @param int $code
+ * @param string $message
+ */
+ function fault($code, $message);
+
+} // Class Mage_Api_Model_Server_Adapter_Interface End
+
+
+
+
Here is an example implementation for XML-RPC:
+
+
+
class Mage_Api_Model_Server_Adapter_Customxmlrpc
+ extends Varien_Object
+ implements Mage_Api_Model_Server_Adapter_Interface
+{
+ /**
+ * XmlRpc Server
+ *
+ * @var Zend_XmlRpc_Server
+ */
+ protected $_xmlRpc = null;
+
+ /**
+ * Set handler class name for webservice
+ *
+ * @param string $handler
+ * @return Mage_Api_Model_Server_Adapter_Xmlrpc
+ */
+ public function setHandler($handler)
+ {
+ $this->setData('handler', $handler);
+ return $this;
+ }
+
+ /**
+ * Retrieve handler class name for webservice
+ *
+ * @return string
+ */
+ public function getHandler()
+ {
+ return $this->getData('handler');
+ }
+
+ /**
+ * Set webservice API controller
+ *
+ * @param Mage_Api_Controller_Action $controller
+ * @return Mage_Api_Model_Server_Adapter_Xmlrpc
+ */
+ public function setController(Mage_Api_Controller_Action $controller)
+ {
+ $this->setData('controller', $controller);
+ return $this;
+ }
+
+ /**
+ * Retrieve webservice API controller
+ *
+ * @return Mage_Api_Controller_Action
+ */
+ public function getController()
+ {
+ return $this->getData('controller');
+ }
+
+ /**
+ * Run webservice
+ *
+ * @param Mage_Api_Controller_Action $controller
+ * @return Mage_Api_Model_Server_Adapter_Xmlrpc
+ */
+ public function run()
+ {
+ $this->_xmlRpc = new Zend_XmlRpc_Server();
+ $this->_xmlRpc->setClass($this->getHandler());
+ $this->getController()->getResponse()
+ ->setHeader('Content-Type', 'text/xml')
+ ->setBody($this->_xmlRpc->handle());
+ return $this;
+ }
+
+ /**
+ * Dispatch webservice fault
+ *
+ * @param int $code
+ * @param string $message
+ */
+ public function fault($code, $message)
+ {
+ throw new Zend_XmlRpc_Server_Exception($message, $code);
+ }
+} // Class Mage_Api_Model_Server_Adapter_Customxmlrpc End
+
+
+
+
Notes: The setHandler, getHandler, setController and getController methods have a simple implementation that uses the Varien_Object getData and setData methods.
+
+
The run and fault methods are a native implementation for an XML-RPC webservice. The run method defines webservice logic in this adapter for creating an XML-RPC server to handle XML-RPC requests.
+
+
+
public function run()
+Â Â {
+Â Â Â Â $this->_xmlRpc = new Zend_XmlRpc_Server();
+Â Â Â Â $this->_xmlRpc->setClass($this->getHandler());
+Â Â Â Â $this->getController()->getResponse()
+Â Â Â Â Â Â ->setHeader('Content-Type', 'text/xml')
+Â Â Â Â Â Â ->setBody($this->_xmlRpc->handle());
+Â Â Â Â return $this;
+Â Â }
+
+
+
+
The "fault" method allows you to send fault exceptions for XML-RPC service when handling requests.
+
+
+
public function fault($code, $message)
+Â Â {
+Â Â Â Â throw new Zend_XmlRpc_Server_Exception($message, $code);
+Â Â }
+
+
+
+
Common Error Messages
+
+
The following are common error messages that you might receive when creating your own custom API.
+
+
Invalid API path
+
+
This error occurs when the methods listed in the api.xml file do not correspond exactly with those used in your PHP file.
+
+
For example, in your api.xml file, you might have this:
Allows you to export/import customers from/to Magento
+
+
Resource: customer
+
+
+
Method:
+
+
+
customer.delete (SOAP V1)
+
customerCustomerDelete (SOAP V2)
+
+
+
+
Delete the required customer.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
customerId
+
Customer ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the customer is deleted
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer.delete', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerCustomerDelete($sessionId, '2');
+var_dump($result);
diff --git a/guides/v1.8/api/soap/customer/customer.info.html b/guides/v1.8/api/soap/customer/customer.info.html
new file mode 100644
index 0000000000..5aee882f61
--- /dev/null
+++ b/guides/v1.8/api/soap/customer/customer.info.html
@@ -0,0 +1,259 @@
+---
+layout: v1x_soap
+title: Customer Info
+---
+
+
Module: Mage_Customer
+
+
Allows you to export/import customers from/to Magento.
+
+
Resource: customer
+
+
+
Method:
+
+
+
customer.info (SOAP V1)
+
customerCustomerInfo (SOAP V2)
+
+
+
+
+
Retrieve information about the specified customer.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
customerId
+
ID of the required customer
+
+
+
ArrayOfString
+
attributes
+
Array of attributes
+
+
+
+
+
attributes (optional depending on the version) - only specified attributes will be returned. The customer_id value is always returned.
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
customerInfo
+
Array of customerCustomerEntity
+
+
+
+
+
The customerCustomerEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_id
+
ID of the customer
+
+
+
string
+
created_at
+
Date when the customer was created
+
+
+
string
+
updated_at
+
Date when the customer was updated
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
int
+
store_id
+
Store ID
+
+
+
int
+
website_id
+
Website ID
+
+
+
string
+
created_in
+
Store view the customer was created in
+
+
+
string
+
email
+
Customer email
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
int
+
group_id
+
Customer group ID
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
dob
+
Customer date of birth
+
+
+
string
+
taxvat
+
Tax/VAT number
+
+
+
boolean
+
confirmation
+
Confirmation flag
+
+
+
string
+
password_hash
+
Password hash
+
+
+
string
+
rp_token
+
Reset password token
+
+
+
string
+
rp_token_created_at
+
Date when the password was reset
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer.info', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerCustomerInfo($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/customer/customer.list.html b/guides/v1.8/api/soap/customer/customer.list.html
new file mode 100644
index 0000000000..d88bfce781
--- /dev/null
+++ b/guides/v1.8/api/soap/customer/customer.list.html
@@ -0,0 +1,275 @@
+---
+layout: v1x_soap
+title: Customer List
+---
+
+
Module: Mage_Customer
+
+
+
Resource: customer
+
+
+
Method:
+
+
+
customer.list (SOAP V1)
+
customerCustomerList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of customers.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters by customer attributes (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
storeView
+
Array of customerCustomerEntity
+
+
+
+
+
The customerCustomerEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_id
+
ID of the customer
+
+
+
string
+
created_at
+
Date when the customer was created
+
+
+
string
+
updated_at
+
Date of when the customer was updated
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
int
+
store_id
+
Store ID
+
+
+
int
+
website_id
+
Website ID
+
+
+
string
+
created_in
+
Created in
+
+
+
string
+
email
+
Customer email
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
int
+
group_id
+
Group ID
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
dob
+
Customer date of birth
+
+
+
string
+
taxvat
+
Taxvat value
+
+
+
boolean
+
confirmation
+
Confirmation flag
+
+
+
string
+
password_hash
+
Password hash
+
+
+
+
Note: The password_hash parameter will only match exactly with the same MD5 and salt as was used when Magento stored the value. If you try to match with an unsalted MD5 hash, or any salt other than what Magento used, it will not match. This is just a straight string comparison.
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer.list');
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2 (List of All Customers)
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerCustomerList($sessionId);
+var_dump($result);
+
+
+
+
+
Request Example SOAP V2 (Complex Filter)
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$complexFilter = array(
+ 'complex_filter' => array(
+ array(
+ 'key' => 'group_id',
+ 'value' => array('key' => 'in', 'value' => '1,3')
+ )
+ )
+);
+$result = $client->customerCustomerList($session, $complexFilter);
+
+var_dump ($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer_address.delete', '4');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerAddressDelete($sessionId, '4');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/customer/customerAddress/customer_address.info.html b/guides/v1.8/api/soap/customer/customerAddress/customer_address.info.html
new file mode 100644
index 0000000000..785d9f58cb
--- /dev/null
+++ b/guides/v1.8/api/soap/customer/customerAddress/customer_address.info.html
@@ -0,0 +1,254 @@
+---
+layout: v1x_soap
+title: Address Info
+---
+
+
Module: Mage_Customer
+
+
+
Resource: customer_address
+
+
+
Method:
+
+
+
customer_address.info (SOAP V1)
+
customerAddressInfo (SOAP V2)
+
+
+
+
Retrieve information about the required customer address.
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
addressId
+
Address ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
info
+
Array of customerAddressEntityItem
+
+
+
+
+
The customerAddressEntityItem content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_address_id
+
ID of the customer address
+
+
+
string
+
created_at
+
Date when the address was created
+
+
+
string
+
updated_at
+
Date when the address was updated
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
city
+
name of the city
+
+
+
string
+
company
+
Name of the company
+
+
+
string
+
country_id
+
ID of the country
+
+
+
string
+
fax
+
Fax
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
postcode
+
Customer postcode
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
region
+
Name of the region
+
+
+
int
+
region_id
+
Region ID
+
+
+
string
+
street
+
Name of the street
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
telephone
+
Telephone number
+
+
+
boolean
+
is_default_billing
+
True if the address is the default one for billing
+
+
+
boolean
+
is_default_shipping
+
True if the address is the default one for shipping
+
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer_address.info', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerAddressInfo($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/customer/customerAddress/customer_address.list.html b/guides/v1.8/api/soap/customer/customerAddress/customer_address.list.html
new file mode 100644
index 0000000000..25d291da67
--- /dev/null
+++ b/guides/v1.8/api/soap/customer/customerAddress/customer_address.list.html
@@ -0,0 +1,259 @@
+---
+layout: v1x_soap
+title: Address List
+---
+
+
Module: Mage_Customer
+
+
+
Resource: customer_address
+
+
+
Method:
+
+
+
customer_address.list (SOAP V1)
+
customerAddressList (SOAP V2)
+
+
+
+
Retrieve the list of customer addresses.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
customerId
+
Customer ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of customerAddressEntity
+
+
+
+
+
The customerAddressEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_address_id
+
ID of the customer address
+
+
+
string
+
created_at
+
Date when the address was created
+
+
+
string
+
updated_at
+
Date when the address was updated
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
city
+
City
+
+
+
string
+
company
+
Name of the company
+
+
+
string
+
country_id
+
ID of the country
+
+
+
string
+
fax
+
Fax
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
postcode
+
Customer postcode
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
region
+
Name of the region
+
+
+
int
+
region_id
+
Region ID
+
+
+
string
+
street
+
Name of the street
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
telephone
+
Telephone number
+
+
+
boolean
+
is_default_billing
+
True if the address is the default one for billing
+
+
+
boolean
+
is_default_shipping
+
True if the address is the default one for shipping
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer_address.list', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerAddressList($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/customer/customer_group.html b/guides/v1.8/api/soap/customer/customer_group.html
new file mode 100644
index 0000000000..7854a734e5
--- /dev/null
+++ b/guides/v1.8/api/soap/customer/customer_group.html
@@ -0,0 +1,146 @@
+---
+layout: v1x_soap
+title: Customer Group
+---
+
+
Module: Mage_Customer
+
+
Allows you to export customer groups from Magento
+
+
Resource: customer_group
+
+
Method:
+
+
+
customer_group.list (SOAP V1)
+
customerGroupList (SOAP V2)
+
+
+
+
Retrieve the list of customer groups
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
An array of customerGroupEntity
+
+
+
+
+
The customerGroupEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_group_id
+
ID of the customer group
+
+
+
string
+
customer_group_code
+
Customer group code
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer_group.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerGroupList($sessionId);
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/directory/directory_region.list.html b/guides/v1.8/api/soap/directory/directory_region.list.html
new file mode 100644
index 0000000000..cec893f714
--- /dev/null
+++ b/guides/v1.8/api/soap/directory/directory_region.list.html
@@ -0,0 +1,186 @@
+---
+layout: v1x_soap
+title: Region List
+---
+
+
Region API
+
+
Allows you to export the list of regions from Magento
+
+
Module: Mage_Directory
+
+
Resource: directory_region
+
+
Aliases:
+
+
region
+
+
+
+
Method:
+
+
+
directory_region.list (SOAP V1)
+
directoryRegionList (SOAP V2)
+
+
+
+
Retrieve the list of regions in the specified country.
+
+
Aliases:
+
+
region.list
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
country
+
Country code in ISO2 or ISO3
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
directoryRegionEntityArray
+
An array of directoryRegionEntity
+
+
+
+
+
+
The directoryRegionEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
region_id
+
ID of the region
+
+
+
string
+
code
+
Region code
+
+
+
string
+
name
+
Name of the region
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Country not exists.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+$regions = $proxy->call($sessionId, 'region.list', 'US');
+
+var_dump($regions); // Region list for USA.
The Magento SOAP v1 API provides you with the ability to manage your eCommerce stores by providing calls for working with resources such as customers, categories, products, and sales orders. It also allows you to manage shopping carts and inventory.
+
+
A SOAP v2 API version has been available since Magento 1.3, and a WS-I compliant version has been available since Magento 1.6.
+
+
Supported Types
+
+
The Magento API supports SOAP and XML-RPC, where SOAP is the default protocol.
+
+
SOAP
+
+
To connect to Magento SOAP web services, load the WSDL into your SOAP client from either of these URLs:
+
+
+
+
http://magentohost/api/?wsdl
+
+
+
+
+
http://magentohost/api/soap/?wsdl
+
+
+
+
where magentohost is the domain for your Magento host.
+
+
As of v1.3, you may also use the following URL to access the Magento API v2, which has been added to improve compatibility with Java and .NET:
+
+
+
+
http://magentohost/api/v2_soap?wsdl=1
+
+
+
+
The following PHP example shows how to make SOAP calls to the Magento API v1:
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'somestuff.method');
+$result = $client->call($session, 'somestuff.method', 'arg1');
+$result = $client->call($session, 'somestuff.method', array('arg1', 'arg2', 'arg3'));
+$result = $client->multiCall($session, array(
+ array('somestuff.method'),
+ array('somestuff.method', 'arg1'),
+ array('somestuff.method', array('arg1', 'arg2'))
+));
+
+
+// If you don't need the session anymore
+$client->endSession($session);
+
+
+
+
XML-RPC
+
+
To use XML-RPC, load the following URL into your XML-RPC client:
+
+
+
+
http://magentohost/api/xmlrpc/
+
+
+
+
where magentohost is the domain for your Magento host.
+
+
The following PHP example shows how to make XML-RPC calls:
+
+
+
+
$client = new Zend_XmlRpc_Client('http://magentohost/api/xmlrpc/');
+
+// If somestuff requires API authentication,
+// we should get session token
+$session = $client->call('login', array('apiUser', 'apiKey'));
+
+$client->call('call', array($session, 'somestuff.method', array('arg1', 'arg2', 'arg3')));
+$client->call('call', array($session, 'somestuff.method', 'arg1'));
+$client->call('call', array($session, 'somestuff.method'));
+$client->call('multiCall', array($session,
+ array(
+ array('somestuff.method', 'arg1'),
+ array('somestuff.method', array('arg1', 'arg2')),
+ array('somestuff.method')
+ )
+));
+
+// If you don't need the session anymore
+$client->call('endSession', array($session));
+
+
+
+
The XML-RPC only supports the version 1 of the Magento API.
+
+
API Methods
+
+
The following table contains the API methods that can be called from your SOAP or XML-RPC client on the Magento v1 API.
+
+
+
+
+
+
Method
+
Description
+
Return Value
+
+
+
startSession()
+
Start the API session and return session ID.
+
string
+
+
+
endSession(sessionId)
+
End the API session.
+
boolean
+
+
+
login(apiUser, apiKey)
+
Start the API session, return the session ID, and authorize the API user.
+
string
+
+
+
call(sessionId, resourcePath,array arguments)
+
Call the API resource that is allowed in the current session. See Note below.
+
mixed
+
+
+
multiCall(sessionId, array calls,array options)
+
Call the API resource’s methods that are allowed for current session. See Notes below.
+
array
+
+
+
resources(sessionId)
+
Return a list of available API resources and methods allowed for the current session.
+
array
+
+
+
globalFaults(sessionId)
+
Return a list of fault messages and their codes that do not depend on any resource.
+
array
+
+
+
resourceFaults(sessionId, resourceName)
+
Return a list of the specified resource fault messages, if this resource is allowed in the current session.
+
array
+
+
+
+
Note: For call and multiCall, if no session is specified, you can call only resources that are not protected by ACL.
+
+
Note: For multiCall, if the "break" option is specified, multiCall breaks on first error.
+
+
The Magento SOAP API v2 does not support the call() and multiCall() methods, and instead provides a separate method for each API resource.
+
+
Global API Faults
+
+
The following table contains fault codes that apply to all SOAP/XML-RPC API calls.
+
+
+
+
Fault Code
+
Fault Message
+
+
+
0
+
Unknown Error
+
+
+
1
+
Internal Error. Please see log for details.
+
+
+
2
+
Access denied.
+
+
+
3
+
Invalid API path.
+
+
+
4
+
Resource path is not callable.
+
+
+
+
+
SOAP API Version v2
+
+
Since Magento 1.3, version v2 of the SOAP API has also been available. The main difference between v1 and v2 is that instead of using methods call and multiCall, it has separate methods for each action.
+
+
For example, consider the following PHP code using SOAP v1.
Note that the WSDL for SOAP v1 and SOAP v2 are different. Note that in SOAP v1, customizing the API did not involve changing the WSDL. In SOAP v2, changes to the WSDL are required.
+
+
You can configure the SOAP v2 API to be WS-I compliant in the system configuration menu. To do this, set Services > Magento Core API > WS-I Compliance to Yes.
+
+
Note that the WSDL for the SOAP v2 API is different when in WS-I compliant mode.
+
+
Using the WS-I compliant SOAP v2 API WSDL, it is easy to automatically generate client classes for Java, .NET, and other languages using standard libraries.
+
+
+
diff --git a/guides/v1.8/api/soap/miscellaneous/magento.info.html b/guides/v1.8/api/soap/miscellaneous/magento.info.html
new file mode 100644
index 0000000000..655ef33b39
--- /dev/null
+++ b/guides/v1.8/api/soap/miscellaneous/magento.info.html
@@ -0,0 +1,118 @@
+---
+layout: v1x_soap
+title: Magento Info
+---
+
+
Magento Info API
+
+
Allows you to get information about the current Magento installation.
+
+
Module: Mage_Core
+
+
Resource: core_magento
+
+
Aliases: magento
+
+
+
Method:
+
+
+
core_magento.info (SOAP V1)
+
magentoInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about Magento version and edition.
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/miscellaneous/store.info.html b/guides/v1.8/api/soap/miscellaneous/store.info.html
new file mode 100644
index 0000000000..dfc6594d01
--- /dev/null
+++ b/guides/v1.8/api/soap/miscellaneous/store.info.html
@@ -0,0 +1,182 @@
+---
+layout: v1x_soap
+title: Store Info
+---
+
+
Module: Store View API
+
+
Resource: store
+
+
Method:
+
+
+
store.info (SOAP V1)
+
storeInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the required store view.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeId
+
Store view ID or code (optional)
+
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of storeEntity
+
+
+
+
+
The storeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
store_id
+
Store view ID
+
+
+
string
+
code
+
Store view code
+
+
+
int
+
website_id
+
Website ID
+
+
+
int
+
group_id
+
Group ID
+
+
+
string
+
name
+
Store name
+
+
+
int
+
sort_order
+
Store view sort order
+
+
+
int
+
is_active
+
Defines whether the store is active
+
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Requested store view not found.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'store.info', '2');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->storeInfo($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/miscellaneous/store.list.html b/guides/v1.8/api/soap/miscellaneous/store.list.html
new file mode 100644
index 0000000000..703afd15dc
--- /dev/null
+++ b/guides/v1.8/api/soap/miscellaneous/store.list.html
@@ -0,0 +1,174 @@
+---
+layout: v1x_soap
+title: Store List
+---
+
+
Module: Store View API
+
+
Resource: store
+
+
Method:
+
+
+
store.list (SOAP V1)
+
storeList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of store views.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of storeEntity
+
+
+
+
+
The storeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
store_id
+
Store view ID
+
+
+
string
+
code
+
Store view code
+
+
+
int
+
website_id
+
Website ID
+
+
+
int
+
group_id
+
Group ID
+
+
+
string
+
name
+
Store view name
+
+
+
int
+
sort_order
+
Store view sort order
+
+
+
int
+
is_active
+
Defines whether the store is active
+
+
+
+
+
Faults:
+No Faults
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'store.list');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->storeList($sessionId);
+var_dump($result);
Order status not changed. Details in error message.
+
+
+
+
+
Examples
+
+
Example 1. Work with orders
+
+
+
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+
+// Getting list of orders created by John Doe
+var_dump($proxy->call($sessionId, 'sales_order.list', array(array('customer_firstname'=>array('eq'=>'John'), 'customer_lastname'=>array('eq'=>'Doe')))));
+
+
+// Get order info 100000003
+var_dump($proxy->call($sessionId, 'sales_order.info', '100000003'));
+
+
+// Hold order 100000003
+$proxy->call($sessionId, 'sales_order.hold', '100000003');
+
+// Unhold order 100000003
+$proxy->call($sessionId, 'sales_order.unhold', '100000003');
+
+// Hold order and add comment 100000003
+$proxy->call($sessionId, 'sales_order.addComment', array('100000003', 'holded', 'You order is holded', true));
+
+// Unhold order and add comment 100000003
+$proxy->call($sessionId, 'sales_order.addComment', array('100000003', 'pending', 'You order is pending', true));
+
+// Get order info 100000003
+var_dump($proxy->call($sessionId, 'sales_order.info', '100000003'));
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.addComment', array('orderIncrementId' => '200000004', 'status' => 'processing'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderAddComment($sessionId, '200000004', 'processing');
+var_dump($result);
+
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrder/sales_order.cancel.html b/guides/v1.8/api/soap/sales/salesOrder/sales_order.cancel.html
new file mode 100644
index 0000000000..99ef601ea3
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrder/sales_order.cancel.html
@@ -0,0 +1,116 @@
+---
+layout: v1x_soap
+title: Order Cancel
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.cancel (SOAP V1)
+
salesOrderCancel (SOAP V2)
+
+
+
+
Allows you to cancel the required order.
+
+
Aliases:
+
+
order.cancel
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the order is canceled
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.cancel', '200000004');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderCancel($sessionId, '200000004');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrder/sales_order.hold.html b/guides/v1.8/api/soap/sales/salesOrder/sales_order.hold.html
new file mode 100644
index 0000000000..353463c413
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrder/sales_order.hold.html
@@ -0,0 +1,118 @@
+---
+layout: v1x_soap
+title: Order Hold
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.hold (SOAP V1)
+
salesOrderHold (SOAP V2)
+
+
+
+
Allows you to place the required order on hold.
+
+
Aliases:
+
+
order.hold
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the order is placed on hold
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.hold', '200000006');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderHold($sessionId, '200000006');
+var_dump($result);
+
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrder/sales_order.info.html b/guides/v1.8/api/soap/sales/salesOrder/sales_order.info.html
new file mode 100644
index 0000000000..6eb5143620
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrder/sales_order.info.html
@@ -0,0 +1,1188 @@
+---
+layout: v1x_soap
+title: Order Info
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.info (SOAP V1)
+
salesOrderInfo (SOAP V2)
+
+
+
+
Allows you to retrieve the required order information.
+
+
Aliases:
+
+
order.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderEntity
+
+
+
+
+
The salesOrderEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Defines whether the order is active
+
+
+
string
+
customer_id
+
Customer ID
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
subtotal
+
Subtotal sum
+
+
+
string
+
grand_total
+
Grand total sum
+
+
+
string
+
total_paid
+
Total paid
+
+
+
string
+
total_refunded
+
Total refunded
+
+
+
string
+
total_qty_ordered
+
Total quantity ordered
+
+
+
string
+
total_canceled
+
Total canceled
+
+
+
string
+
total_invoiced
+
Total invoiced
+
+
+
string
+
total_online_refunded
+
Total online refunded
+
+
+
string
+
total_offline_refunded
+
Total offline refunded
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
base_subtotal
+
Base subtotal
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
base_total_paid
+
Base total paid
+
+
+
string
+
base_total_refunded
+
Base total refunded
+
+
+
string
+
base_total_qty_ordered
+
Base total quantity ordered
+
+
+
string
+
base_total_canceled
+
Base total canceled
+
+
+
string
+
base_total_invoiced
+
Base total invoiced
+
+
+
string
+
base_total_online_refunded
+
Base total online refunded
+
+
+
string
+
base_total_offline_refunded
+
Base total offline refunded
+
+
+
string
+
billing_address_id
+
Billing address ID
+
+
+
string
+
billing_firstname
+
First name in the billing address
+
+
+
string
+
billing_lastname
+
Last name in the billing address
+
+
+
string
+
shipping_address_id
+
Shipping address ID
+
+
+
string
+
shipping_firstname
+
First name in the shipping address
+
+
+
string
+
shipping_lastname
+
Last name in the shipping address
+
+
+
string
+
billing_name
+
Billing name
+
+
+
string
+
shipping_name
+
Shipping name
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
store_to_order_rate
+
Store to order rate
+
+
+
string
+
base_to_global_rate
+
Base to global rate
+
+
+
string
+
base_to_order_rate
+
Base to order rate
+
+
+
string
+
weight
+
Weight
+
+
+
string
+
store_name
+
Store name
+
+
+
string
+
remote_ip
+
Remote IP
+
+
+
string
+
status
+
Order status
+
+
+
string
+
state
+
Order state
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
order_currency_code
+
Order currency code
+
+
+
string
+
shipping_method
+
Shipping method
+
+
+
string
+
shipping_description
+
Shipping description
+
+
+
string
+
customer_email
+
Email address of the customer
+
+
+
string
+
customer_firstname
+
Customer first name
+
+
+
string
+
customer_lastname
+
Customer last name
+
+
+
string
+
quote_id
+
Shopping cart ID
+
+
+
string
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
customer_note_notify
+
Customer notification
+
+
+
string
+
customer_is_guest
+
Defines whether the customer is a guest
+
+
+
string
+
email_sent
+
Defines whether the email notification is sent
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
array
+
shipping_address
+
Array of salesOrderAddressEntity
+
+
+
array
+
billing_address
+
Array of salesOrderAddressEntity
+
+
+
array
+
items
+
Array of salesOrderItemEntity
+
+
+
array
+
payment
+
Array of salesOrderPaymentEntity
+
+
+
array
+
status_history
+
Array of salesOrderStatusHistoryEntity
+
+
+
+
+
The salesOrderAddressEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Defines whether the address is active
+
+
+
string
+
address_type
+
Address type
+
+
+
string
+
firstname
+
First name
+
+
+
string
+
lastname
+
Last name
+
+
+
string
+
company
+
Company name
+
+
+
string
+
street
+
Street name
+
+
+
string
+
city
+
City
+
+
+
string
+
region
+
Region
+
+
+
string
+
postcode
+
Post code
+
+
+
string
+
country_id
+
Country ID
+
+
+
string
+
telephone
+
Telephone number
+
+
+
string
+
fax
+
Fax number
+
+
+
string
+
region_id
+
Region ID
+
+
+
string
+
address_id
+
Address ID
+
+
+
+
+
The salesOrderItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
item_id
+
Item ID
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
quote_item_id
+
Shopping cart item ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
product_type
+
Product type
+
+
+
string
+
product_options
+
Product options
+
+
+
string
+
weight
+
Weight
+
+
+
string
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
name
+
Product name
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
free_shipping
+
Defines whether free shipping is applied
+
+
+
string
+
is_qty_decimal
+
Defines whether the items quantity is decimal
+
+
+
string
+
no_discount
+
Defines whether no discount is applied
+
+
+
string
+
qty_canceled
+
Items quantity canceled
+
+
+
string
+
qty_invoiced
+
Items quantity invoiced
+
+
+
string
+
qty_ordered
+
Items quantity ordered
+
+
+
string
+
qty_refunded
+
Items quantity refunded
+
+
+
string
+
qty_shipped
+
Items quantity shipped
+
+
+
string
+
cost
+
Cost
+
+
+
string
+
price
+
Price
+
+
+
string
+
base_price
+
Base price
+
+
+
string
+
original_price
+
Original price
+
+
+
string
+
base_original_price
+
Base original price
+
+
+
string
+
tax_percent
+
Tax percent
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
tax_invoiced
+
Tax invoiced
+
+
+
string
+
base_tax_invoiced
+
Base tax invoiced
+
+
+
string
+
discount_percent
+
Discount percent
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
discount_invoiced
+
Discount invoiced
+
+
+
string
+
base_discount_invoiced
+
Base discount invoiced
+
+
+
string
+
amount_refunded
+
Amount refunded
+
+
+
string
+
base_amount_refunded
+
Base amount refunded
+
+
+
string
+
row_total
+
Row total
+
+
+
string
+
base_row_total
+
Base row total
+
+
+
string
+
row_invoiced
+
Row invoiced
+
+
+
string
+
base_row_invoiced
+
Base row invoiced
+
+
+
string
+
row_weight
+
Row weight
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available
+
+
+
string
+
base_tax_before_discount
+
Base tax before discount
+
+
+
string
+
tax_before_discount
+
Tax before discount
+
+
+
string
+
weee_tax_applied
+
Applied fixed product tax
+
+
+
string
+
weee_tax_applied_amount
+
Applied fixed product tax amount
+
+
+
string
+
weee_tax_applied_row_amount
+
Applied fixed product tax row amount
+
+
+
string
+
base_weee_tax_applied_amount
+
Applied fixed product tax amount (in base currency)
+
+
+
string
+
base_weee_tax_applied_row_amount
+
Applied fixed product tax row amount (in base currency)
+
+
+
string
+
weee_tax_disposition
+
Fixed product tax disposition
+
+
+
string
+
weee_tax_row_disposition
+
Fixed product tax row disposition
+
+
+
string
+
base_weee_tax_disposition
+
Fixed product tax disposition (in base currency)
+
+
+
string
+
base_weee_tax_row_disposition
+
Fixed product tax row disposition (in base currency)
+
+
+
+
+
The salesOrderPaymentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Active flag
+
+
+
string
+
amount_ordered
+
Amount ordered
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
base_amount_ordered
+
Base amount ordered
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
method
+
Payment method
+
+
+
string
+
po_number
+
Purchase order number
+
+
+
string
+
cc_type
+
Credit card type
+
+
+
string
+
cc_number_enc
+
Credit card number
+
+
+
string
+
cc_last4
+
Credit card last 4 digits
+
+
+
string
+
cc_owner
+
Credit card owner
+
+
+
string
+
cc_exp_month
+
Credit card expiration month
+
+
+
string
+
cc_exp_year
+
Credit card expiration year
+
+
+
string
+
cc_ss_start_month
+
Credit card start month (Switch/Solo)
+
+
+
string
+
cc_ss_start_year
+
Credit card start year (Switch/Solo)
+
+
+
string
+
payment_id
+
Payment ID
+
+
+
+
+
The salesOrderStatusHistoryEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Active flag
+
+
+
string
+
is_customer_notified
+
Defines whether the customer is notified
+
+
+
string
+
status
+
Order status
+
+
+
string
+
comment
+
Order comment
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.info', 'orderIncrementId');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderInfo($sessionId, '200000006');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrder/sales_order.list.html b/guides/v1.8/api/soap/sales/salesOrder/sales_order.list.html
new file mode 100644
index 0000000000..69a577c92c
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrder/sales_order.list.html
@@ -0,0 +1,550 @@
+---
+layout: v1x_soap
+title: Order List
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.list (SOAP V1)
+
salesOrderList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of orders. Additional filters can be applied.
+
+
Aliases:
+
+
order.list
+
salesOrderList (SOAP V2 method name)
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters for the list of sales orders (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
name
+
Description
+
+
+
array
+
result
+
Array of salesOrderEntity
+
+
+
+
+
The salesOrderEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Defines whether the order is active
+
+
+
string
+
customer_id
+
Customer ID
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
subtotal
+
Subtotal sum
+
+
+
string
+
grand_total
+
Grand total sum
+
+
+
string
+
total_paid
+
Total paid
+
+
+
string
+
total_refunded
+
Total refunded
+
+
+
string
+
total_qty_ordered
+
Total quantity ordered
+
+
+
string
+
total_canceled
+
Total canceled
+
+
+
string
+
total_invoiced
+
Total invoiced
+
+
+
string
+
total_online_refunded
+
Total online refunded
+
+
+
string
+
total_offline_refunded
+
Total offline refunded
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
base_subtotal
+
Base subtotal
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
base_total_paid
+
Base total paid
+
+
+
string
+
base_total_refunded
+
Base total refunded
+
+
+
string
+
base_total_qty_ordered
+
Base total quantity ordered
+
+
+
string
+
base_total_canceled
+
Base total canceled
+
+
+
string
+
base_total_invoiced
+
Base total invoiced
+
+
+
string
+
base_total_online_refunded
+
Base total online refunded
+
+
+
string
+
base_total_offline_refunded
+
Base total offline refunded
+
+
+
string
+
billing_address_id
+
Billing address ID
+
+
+
string
+
billing_firstname
+
First name in the billing address
+
+
+
string
+
billing_lastname
+
Last name in the billing address
+
+
+
string
+
shipping_address_id
+
Shipping address ID
+
+
+
string
+
shipping_firstname
+
First name in the shipping address
+
+
+
string
+
shipping_lastname
+
Last name in the shipping address
+
+
+
string
+
billing_name
+
Billing name
+
+
+
string
+
shipping_name
+
Shipping name
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
store_to_order_rate
+
Store to order rate
+
+
+
string
+
base_to_global_rate
+
Base to global rate
+
+
+
string
+
base_to_order_rate
+
Base to order rate
+
+
+
string
+
weight
+
Weight
+
+
+
string
+
store_name
+
Store name
+
+
+
string
+
remote_ip
+
Remote IP
+
+
+
string
+
status
+
Order status
+
+
+
string
+
state
+
Order state
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
order_currency_code
+
Order currency code
+
+
+
string
+
shipping_method
+
Shipping method
+
+
+
string
+
shipping_description
+
Shipping description
+
+
+
string
+
customer_email
+
Email address of the customer
+
+
+
string
+
customer_firstname
+
Customer first name
+
+
+
string
+
customer_lastname
+
Customer last name
+
+
+
string
+
quote_id
+
Shopping cart ID
+
+
+
string
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
customer_note_notify
+
Customer notification
+
+
+
string
+
customer_is_guest
+
Defines whether the customer is a guest
+
+
+
string
+
email_sent
+
Defines whether the email notification is sent
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'order.list');
+var_dump ($result);
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrder/sales_order.unhold.html b/guides/v1.8/api/soap/sales/salesOrder/sales_order.unhold.html
new file mode 100644
index 0000000000..8478c17833
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrder/sales_order.unhold.html
@@ -0,0 +1,112 @@
+---
+layout: v1x_soap
+title: Order Unhold
+---
+
+
Module: Mage_Sales
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.unhold (SOAP V1)
+
salesOrderUnhold (SOAP V2)
+
+
+
+
Allows you to unhold the required order.
+
+
Aliases:
+
+
order.unhold
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the order is unheld
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.unhold', '200000006');
+var_dump($result);
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+$creditmemoIncrementId = '100000637'; //increment id of existing credit memo
+
+$isCreditMemoCanceled = $proxy->call($sessionId, 'order_creditmemo.cancel', array($creditmemoIncrementId));
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.create.html b/guides/v1.8/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.create.html
new file mode 100644
index 0000000000..5d80c9fea8
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.create.html
@@ -0,0 +1,219 @@
+---
+layout: v1x_soap
+title: Memo Create
+---
+
+
Module: Order Credit Memo API
+
+
Resource: sales_order_creditmemo
+
+
Aliases: order_creditmemo
+
+
Method:
+
+
+
order_creditmemo.create (SOAP V1)
+
salesOrderCreditmemoCreate (SOAP V2)
+
+
+
+
Allows you to create a new credit memo for the invoiced order. Comments can be added and an email notification can be sent to the user email.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
array
+
creditmemoData
+
Array of salesOrderCreditmemoData (optional)
+
+
+
string
+
comment
+
Comment text (optional)
+
+
+
int
+
notifyCustomer
+
Notify customer by email flag (optional)
+
+
+
int
+
includeComment
+
Include comment text into an email notification (optional)
+
+
+
string
+
refundToStoreCreditAmount
+
Payment amount to be refunded to the customer store credit (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
result
+
Created credit memo increment ID
+
+
+
+
+
The salesOrderCreditmemoData content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
qtys
+
Array of orderItemIdQty
+
+
+
double
+
shipping_amount
+
Refund shipping amount (optional)
+
+
+
double
+
adjustment_positive
+
Adjustment refund amount (optional)
+
+
+
double
+
adjustment_negative
+
Adjustment fee amount (optional)
+
+
+
+
+
The orderItemIdQty content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
order_item_id
+
Order item ID to be refunded
+
+
+
double
+
qty
+
Items quantity to be refunded
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
102
+
Invalid data given. Details in error message.
+
+
+
103
+
Requested order does not exist.
+
+
+
105
+
Money can not be refunded to the store credit account as order was created by guest.
+
+
+
106
+
Credit memo for requested order can not be created.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'order_creditmemo.create', '200000010');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderCreditmemoCreate($sessionId, '200000010');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.info.html b/guides/v1.8/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.info.html
new file mode 100644
index 0000000000..bfeb02b90d
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.info.html
@@ -0,0 +1,885 @@
+---
+layout: v1x_soap
+title: Memo Info
+---
+
+
Module: Order Credit Memo API
+
+
Resource: sales_order_creditmemo
+
+
Aliases: order_creditmemo
+
+
+
Method:
+
+
+
order_creditmemo.info (SOAP V1)
+
salesOrderCreditmemoInfo (SOAP V2)
+
+
+
+
Allows you to retrieve full information about the specified credit memo.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
creditmemoIncrementId
+
Credit memo increment ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderCreditmemoEntity
+
+
+
+
+
The salesOrderCreditmemoEntity content is as follows:
+
+
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
transaction_id
+
Transaction ID
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
order_currency_code
+
Order currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
cybersource_token
+
Cybersource token
+
+
+
string
+
invoice_id
+
ID of the invoice for which the credit memo was created
+
+
+
string
+
billing_address_id
+
Billing address ID
+
+
+
string
+
shipping_address_id
+
Shipping address ID
+
+
+
string
+
state
+
State
+
+
+
string
+
creditmemo_status
+
Credit memo status
+
+
+
string
+
email_sent
+
Defines whether the email is sent
+
+
+
string
+
order_id
+
ID of the order for which the credit memo was created
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
shipping_tax_amount
+
Shipping tax amount
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
base_adjustment_positive
+
Adjustment refund amount (using base currency)
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
adjustment
+
Adjustment
+
+
+
string
+
subtotal
+
Subtotal
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
base_subtotal
+
Base subtotal
+
+
+
string
+
base_adjustment
+
Base adjustment
+
+
+
string
+
base_to_global_rate
+
Base to global rate
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
adjustment_negative
+
Adjustment fee amount
+
+
+
string
+
subtotal_incl_tax
+
Subtotal including tax
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
base_subtotal_incl_tax
+
Base subtotal including tax
+
+
+
string
+
base_adjustment_negative
+
Adjustment fee amount (using base currency)
+
+
+
string
+
grand_total
+
Grand total
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
base_to_order_rate
+
Base to order rate
+
+
+
string
+
store_to_order_rate
+
Store to order rate
+
+
+
string
+
base_shipping_tax_amount
+
Base shipping tax amount
+
+
+
string
+
adjustment_positive
+
Adjustment refund amount
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
hidden_tax_amount
+
Hidden tax amount
+
+
+
string
+
base_hidden_tax_amount
+
Base hidden tax amount
+
+
+
string
+
shipping_hidden_tax_amount
+
Shipping hidden tax amount
+
+
+
string
+
base_shipping_hidden_tax_amnt
+
Base shipping hidden tax amount
+
+
+
string
+
shipping_incl_tax
+
Shipping including tax
+
+
+
string
+
base_shipping_incl_tax
+
Base shipping including tax
+
+
+
string
+
base_customer_balance_amount
+
Base customer balance amount
+
+
+
string
+
customer_balance_amount
+
Customer balance amount
+
+
+
string
+
bs_customer_bal_total_refunded
+
Refunded base customer balance amount
+
+
+
string
+
customer_bal_total_refunded
+
Customer balance total refunded
+
+
+
string
+
base_gift_cards_amount
+
Base gift cards amount
+
+
+
string
+
gift_cards_amount
+
Gift cards amount
+
+
+
string
+
gw_base_price
+
Gift wrapping price refunded amount (using base currency)
+
+
+
string
+
gw_price
+
Gift wrapping price refunded amount
+
+
+
string
+
gw_items_base_price
+
Gift wrapping items base price
+
+
+
string
+
gw_items_price
+
Gift wrapping items price
+
+
+
string
+
gw_card_base_price
+
Gift wrapping card base price
+
+
+
string
+
gw_card_price
+
Gift wrapping card price
+
+
+
string
+
gw_base_tax_amount
+
Gift wrapping tax amount refunded (using base currency)
+
+
+
string
+
gw_tax_amount
+
Gift wrapping tax amount refunded
+
+
+
string
+
gw_items_base_tax_amount
+
Gift wrapping items base tax amount
+
+
+
string
+
gw_items_tax_amount
+
Gift wrapping items tax amount
+
+
+
string
+
gw_card_base_tax_amount
+
Gift wrapping card base tax amount
+
+
+
string
+
gw_card_tax_amount
+
Gift wrapping card tax amount
+
+
+
string
+
base_reward_currency_amount
+
Base reward currency amount
+
+
+
string
+
reward_currency_amount
+
Reward currency amount
+
+
+
string
+
reward_points_balance
+
Reward points balance
+
+
+
string
+
reward_points_balance_refund
+
Reward points balance refund
+
+
+
string
+
creditmemo_id
+
Credit memo ID
+
+
+
array
+
items
+
Array of salesOrderCreditmemoItemEntity
+
+
+
array
+
comments
+
Array of salesOrderCreditmemoCommentEntity
+
+
+
+
+
+
The salesOrderCreditmemoItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
item_id
+
Credit memo item ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
weee_tax_applied_row_amount
+
Applied fixed product tax row amount
+
+
+
string
+
base_price
+
Base price
+
+
+
string
+
base_weee_tax_row_disposition
+
Fixed product tax row disposition (in base currency)
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
base_weee_tax_applied_amount
+
Applied fixed product tax amount (in base currency)
+
+
+
string
+
weee_tax_row_disposition
+
Fixed product tax row disposition
+
+
+
string
+
base_row_total
+
Base row total
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
row_total
+
Row total
+
+
+
string
+
weee_tax_applied_amount
+
Applied fixed product tax amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
base_weee_tax_disposition
+
Fixed product tax disposition (in base currency)
+
+
+
string
+
price_incl_tax
+
Price including tax
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
weee_tax_disposition
+
Fixed product tax disposition
+
+
+
string
+
base_price_incl_tax
+
Base price including tax
+
+
+
string
+
qty
+
Quantity
+
+
+
string
+
base_cost
+
Base cost
+
+
+
string
+
base_weee_tax_applied_row_amount
+
Applied fixed product tax row amount (in base currency)
+
+
+
string
+
price
+
Price
+
+
+
string
+
base_row_total_incl_tax
+
Base row total including tax
+
+
+
string
+
row_total_incl_tax
+
Row total including tax
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
order_item_id
+
Order item ID
+
+
+
string
+
additional_data
+
Additional data
+
+
+
string
+
description
+
Description
+
+
+
string
+
weee_tax_applied
+
Applied fixed product tax
+
+
+
string
+
sku
+
Item SKU
+
+
+
string
+
name
+
Name
+
+
+
string
+
hidden_tax_amount
+
Hidden tax amount
+
+
+
string
+
base_hidden_tax_amount
+
Base hidden tax amount
+
+
+
+
+
The salesOrderCreditmemoCommentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
comment
+
Comment data
+
+
+
string
+
is_customer_notified
+
Defines whether the customer is notified
+
+
+
string
+
comment_id
+
Comment ID
+
+
+
string
+
is_visible_on_front
+
Defines whether the comment is visible on the frontend
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Description
+
+
+
100
+
Requested credit memo does not exist.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'order_creditmemo.info', '200000001');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderCreditmemoInfo($sessionId, '200000001');
+var_dump($result);
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.addComment.html b/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.addComment.html
new file mode 100644
index 0000000000..f87f898111
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.addComment.html
@@ -0,0 +1,130 @@
+---
+layout: v1x_soap
+title: Add Comment
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_invoice
+
+
Aliases:
+
+
order_invoice
+
+
+
+
Method:
+
+
+
sales_order_invoice.addComment (SOAP V1)
+
salesOrderInvoiceAddComment (SOAP V2)
+
+
+
+
Allows you to add a new comment to the order invoice.
+
+
Aliases:
+
+
order_invoice.addComment
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
invoiceIncrementId
+
Invoice increment ID
+
+
+
string
+
comment
+
Invoice comment (optional)
+
+
+
int
+
email
+
Send invoice on email flag (optional)
+
+
+
int
+
includeComment
+
Include comment in email flag (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the comment is added to the invoice
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apikey');
+
+$result = $client->call($session, 'sales_order_invoice.addComment', array('invoiceIncrementId' => '200000006', 'comment' => 'invoice comment'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderInvoiceAddComment($sessionId, '200000006');
+var_dump($result);
Allows you to cancel the required invoice. Note that not all order invoices can be canceled. Only some payment methods support canceling the order invoice (e.g., Google Checkout, PayPal Pro, PayPal Express Checkout).
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.capture.html b/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.capture.html
new file mode 100644
index 0000000000..a50888029b
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.capture.html
@@ -0,0 +1,156 @@
+---
+layout: v1x_soap
+title: Invoice Capture
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_invoice
+
+
Aliases:
+
+
order_invoice
+
+
+
+
Method:
+
+
+
sales_order_invoice.capture (SOAP V1)
+
salesOrderInvoiceCapture (SOAP V2)
+
+
+
+
Allows you to capture the required invoice. Note that not all order invoices can be captured. Only some payment methods support capturing the order invoice (e.g., PayPal Pro).
+
+
Aliases:
+
+
order_invoice.capture
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
invoiceIncrementId
+
Invoice increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the order invoice is captured.
+
+
+
+
+
+
Notes:
+
+
You should check the invoice to see if it can be captured before attempting to capture the invoice. Otherwise, the API call will generate an error.
+
+
Invoices have states as defined in the model Mage_Sales_Model_Order_Invoice:
+
+
STATE_OPEN = 1
+
STATE_PAID = 2
+
STATE_CANCELED = 3
+
+
+
+
Also note that there is a method call in the model that checks this for you - canCapture(). And it also verifies that the payment can be captured, so the invoice state might not be the only condition that is required to allow it to be captured.
Array of orderItemIdQty (quantity of items to invoice)
+
+
+
string
+
comment
+
Invoice comment (optional)
+
+
+
string
+
email
+
Send invoice on email (optional)
+
+
+
string
+
includeComment
+
Include comments in email (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
string
+
ID of the created invoice
+
+
+
+
+
The orderItemIdQty content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
order_item_id
+
Order item ID
+
+
+
double
+
qty
+
Quantity
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call(
+ $session,
+ 'sales_order_invoice.create',
+ array('orderIncrementId' => '200000008', array('15' => '1', '16' => '1'))
+ // orderItemIdQty Array is Keyed with Order Item ID, with Value of qty to invoice
+);
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+//Create invoice for order
+
+// orderItemIdQty Array is Keyed with Order Item ID, with Value of qty to invoice
+$qty = array('15' => '1', '16' => '1');
+
+$invoiceIncrementId = $proxy->salesOrderInvoiceCreate(
+ $sessionID,
+ '200000008',
+ Â $qty
+);
+var_dump($invoiceIncrementId);
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.info.html b/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.info.html
new file mode 100644
index 0000000000..22dba68cfe
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.info.html
@@ -0,0 +1,589 @@
+---
+layout: v1x_soap
+title: Invoice Info
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_invoice
+
+
Aliases:
+
+
order_invoice
+
+
+
+
Method:
+
+
+
sales_order_invoice.info (SOAP V1)
+
salesOrderInvoiceInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the required invoice.
+
+
Aliases:
+
+
order_invoice.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
invoiceIncrementId
+
Invoice increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderInvoiceEntity
+
+
+
+
+
The salesOrderInvoiceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Defines whether the invoice is active
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
order_currency_code
+
Order currency code
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
store_to_order_rate
+
Store to order rate
+
+
+
string
+
base_to_global_rate
+
Base to global rate
+
+
+
string
+
base_to_order_rate
+
Base to order rate
+
+
+
string
+
subtotal
+
Subtotal
+
+
+
string
+
base_subtotal
+
Base subtotal
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
billing_address_id
+
Billing address ID
+
+
+
string
+
billing_firstname
+
First name in the billing address
+
+
+
string
+
billing_lastname
+
Last name in the billing address
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
order_increment_id
+
Order increment ID
+
+
+
string
+
order_created_at
+
Date of order creation
+
+
+
string
+
state
+
Order state
+
+
+
string
+
grand_total
+
Grand total
+
+
+
string
+
invoice_id
+
Invoice ID
+
+
+
array
+
items
+
Array of salesOrderInvoiceItemEntity
+
+
+
array
+
comments
+
Array of salesOrderInvoiceCommentEntity
+
+
+
+
+
The salesOrderInvoiceItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Active flag
+
+
+
string
+
weee_tax_applied
+
Applied fixed product tax
+
+
+
string
+
qty
+
Quantity
+
+
+
string
+
cost
+
Cost
+
+
+
string
+
price
+
Price
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
row_total
+
Row total
+
+
+
string
+
base_price
+
Base price
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
base_row_total
+
Base row total
+
+
+
string
+
base_weee_tax_applied_amount
+
Applied fixed product tax amount (in base currency)
+
+
+
string
+
base_weee_tax_applied_row_amount
+
Applied fixed product tax row amount (in base currency)
+
+
+
string
+
weee_tax_applied_amount
+
Applied fixed product tax amount
+
+
+
string
+
weee_tax_applied_row_amount
+
Applied fixed product tax row amount
+
+
+
string
+
weee_tax_disposition
+
Fixed product tax disposition
+
+
+
string
+
weee_tax_row_disposition
+
Fixed product tax row disposition
+
+
+
string
+
base_weee_tax_disposition
+
Fixed product tax disposition (in base currency)
+
+
+
string
+
base_weee_tax_row_disposition
+
Fixed product tax row disposition (in base currency)
+
+
+
string
+
sku
+
SKU
+
+
+
string
+
name
+
Name
+
+
+
string
+
order_item_id
+
Order item ID
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
item_id
+
Item ID
+
+
+
+
+
The salesOrderInvoiceCommentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Active flag
+
+
+
string
+
comment
+
Invoice comment
+
+
+
string
+
is_customer_notified
+
Defines whether the customer is notified
+
+
+
string
+
comment_id
+
Comment ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_invoice.info', '200000006');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderInvoiceInfo($sessionId, '200000006');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.list.html b/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.list.html
new file mode 100644
index 0000000000..6ba966bcaa
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrderInvoice/sales_order_invoice.list.html
@@ -0,0 +1,214 @@
+---
+layout: v1x_soap
+title: Invoice List
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_invoice
+
+
Aliases:
+
+
order_invoice
+
+
+
+
Method:
+
+
+
sales_order_invoice.list (SOAP V1)
+
salesOrderInvoiceList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of order invoices. Additional filters can also be applied.
+
+
Aliases:
+
+
order_invoice.list
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters for the list of invoices (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderInvoiceEntity
+
+
+
+
+
The salesOrderInvoiceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
created_at
+
Date of invoice creation
+
+
+
string
+
order_currency_code
+
Order currency code (e.g., EUR)
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
state
+
Order state
+
+
+
string
+
grand_total
+
Grand total amount invoiced
+
+
+
string
+
invoice_id
+
Invoice ID
+
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_invoice.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2 (List of All Invoices)
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderInvoiceList($sessionId);
+var_dump($result);
+
+
+
+
Request Example SOAP V2 (Complex Filter)
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$complexFilter = array(
+ 'complex_filter' => array(
+ array(
+ 'key' => 'state',
+ 'value' => array('key' => 'in', 'value' => '2,3')
+ )
+ )
+);
+$result = $client->salesOrderInvoiceList($session, $complexFilter);
+
+var_dump ($result);
+
+
+Create the Magento file system owner
diff --git a/guides/v1.8/api/soap/sales/salesOrderShipment/sales_order_shipment.addComment.html b/guides/v1.8/api/soap/sales/salesOrderShipment/sales_order_shipment.addComment.html
new file mode 100644
index 0000000000..c9cab4851a
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrderShipment/sales_order_shipment.addComment.html
@@ -0,0 +1,131 @@
+---
+layout: v1x_soap
+title: Shipment Add Comment
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_shipment
+
+
Aliases:
+
+
order_shipment
+
+
+
+
Method:
+
+
+
sales_order_shipment.addComment (SOAP V1)
+
salesOrderShipmentAddComment (SOAP V2)
+
+
+
+
Allows you to add a new comment to the order shipment.
+
+
Aliases:
+
+
order_shipment.addComment
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
shipmentIncrementId
+
Shipment increment ID
+
+
+
string
+
comment
+
Shipment comment (optional)
+
+
+
string
+
email
+
Send email flag (optional)
+
+
+
string
+
includeInEmail
+
Include comment in email flag (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the comment is added to the order shipment
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.addComment', array('shipmentIncrementId' => '200000002', 'comment' => 'comment for the shipment', 'email' => null));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentAddComment($sessionId, '200000002');
+var_dump($result);
Allows you to add a new tracking number to the order shipment.
+
+
Aliases:
+
+
order_shipment.addTrack
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
shipmentIncrementId
+
Shipment increment ID
+
+
+
string
+
carrier
+
Carrier code (ups, usps, dhl, fedex, or dhlint)
+
+
+
string
+
title
+
Tracking title
+
+
+
string
+
trackNumber
+
Tracking number
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
int
+
Tracking number ID
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.addTrack', array('shipmentIncrementId' => '200000002', 'carrier' => 'ups', 'title' => 'tracking title', 'trackNumber' => '123123'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentAddTrack($sessionId, '200000002', 'ups', 'tracking title', '123123');
+var_dump($result);
Allows you to retrieve the list of allowed carriers for an order.
+
+
Aliases:
+
+
order_shipment.getCarriers
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
associativeArray
+
result
+
Array of carriers
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.getCarriers', '200000010');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentGetCarriers($sessionId, '200000010');
+var_dump($result);
+
+
diff --git a/guides/v1.8/api/soap/sales/salesOrderShipment/sales_order_shipment.list.html b/guides/v1.8/api/soap/sales/salesOrderShipment/sales_order_shipment.list.html
new file mode 100644
index 0000000000..14685a7e3d
--- /dev/null
+++ b/guides/v1.8/api/soap/sales/salesOrderShipment/sales_order_shipment.list.html
@@ -0,0 +1,193 @@
+---
+layout: v1x_soap
+title: Shipment List
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_shipment
+
+
Aliases:
+
+
order_shipment
+
+
+
+
Method:
+
+
+
sales_order_shipment.list (SOAP V1)
+
salesOrderShipmentList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of order shipments. Additional filters can be applied.
+
+
Aliases:
+
+
order_shipment.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters for the list of shipments
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderShipmentEntity
+
+
+
+
+
The salesOrderShipmentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
created_at
+
Date of shipment creation
+
+
+
string
+
total_qty
+
Total quantity of items to ship
+
+
+
string
+
shipment_id
+
Shipment ID
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2 (List of All Shipments)
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentList($sessionId);
+var_dump($result);
+
+
+
+
Request Example SOAP V2 (Complex Filter)
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$complexFilter = array(
+ 'complex_filter' => array(
+ array(
+ 'key' => 'created_at',
+ 'value' => array('key' => 'in', 'value' => '2012-03-30 12:54:46')
+ )
+ )
+);
+$result = $client->salesOrderShipmentList($session, $complexFilter);
+
+var_dump ($result);
Allows you to remove a tracking number from the order shipment.
+
+
Aliases:
+
+
order_shipment.removeTrack
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
shipmentIncrementId
+
Shipment increment ID
+
+
+
string
+
trackId
+
Track ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the tracking number is removed from the shipment
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.removeTrack', array('shipmentIncrementId' => '200000002', 'trackId' => '2'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentRemoveTrack($sessionId, '200000002', '2');
+var_dump($result);
Magento provides you with the ability to use two modes for SOAP API V2. These are with WS-I compliance mode enabled and WS-I compliance mode disabled. The first one was introduced to make the system flexible, namely, to increase compatibility with .NET and Java programming languages.
+
+
To enable/disable the WS-I compliance mode, perform the following steps:
+
+
In the Magento Admin Panel, go to System > Configuration > Magento Core API.
+
In the WS-I Compliance drop-down, select Yes to enable the WS-I compliance mode and No to disable the WS-I compliance mode, correspondingly.
+
+
+
+
+
The WS-I compliant mode uses the same WSDL endpoint as SOAP API V2 does. The key difference is that XML namespaces are used in WS-I compliance mode.
+
+
+
WSDL file with disabled WS-I compliance mode:
+
+
+
WSDL file with enabled WS-I compliance mode:
+
+
+
\ No newline at end of file
diff --git a/guides/v1.8/ce18-ee113-home.html b/guides/v1.8/ce18-ee113-home.html
new file mode 100644
index 0000000000..de3fbeb81d
--- /dev/null
+++ b/guides/v1.8/ce18-ee113-home.html
@@ -0,0 +1,83 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento Community Edition (CE) 1.8 and Enterprise Edition (EE) 1.13 Documentation Home
+
+
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
Magento Community Edition (CE) 1.8 and Enterprise Edition (EE) 1.13 Documentation Home
Welcome to the documentation home page for the Magento Enterprise Edition (EE) 1.13 and Community Edition (CE) 1.8 releases! Let's start out by telling you a little bit about them.
+
Magento recognizes that merchants and systems integrators require higher performance in key areas—such as product search, product browsing, and checkout. Merchants and integrators are now commonly coming to Magento with:
+
Large databases (that is, more than one million products)
+
Heavy traffic volume
+
Frequent merchandising updates
+
Extensive marketing and promotion campaigns
+
Many web stores to address their customers' needs
+
To address these ever-growing needs, Magento systematically examined performance and scalability characteristics. Our engineers continually measured performance on a range of environments and use cases to identify and remove bottlenecks, and then conducted extensive testing to confirm improvements.
+
We characterized performance based on variations in deployment and business configurations to ensure improvement for a range of merchant sizes and configurations.
+
In this release, we focused primarily on improvements to indexing, tax calculations, caching, and checkout performance.
+
We're excited about the changes you'll find, including:
+
Reindexing (Enterprise Edition only):
+
Most indexing processes now run only to update products, categories, URL redirects, and so on that have changed—eliminating the need for manual full reindexing
+
Your Magento web store is not locked at any point during reindexing
+
Reindexing is now a background process.
+
+
Caching (Enterprise Edition only):
+
Full page caching now invalidates only pages that are affected by product or category changes
+
Improved cache adapter for single-host systems
+
Additional option of using Redis NoSQL for cache and session storage in multi-host deployments (recommended for new deployments)
The focus of the Magento Enterprise Edition 1.13 release is performance and scalability. The benchmarking results
+ presented here demonstrate that we have addressed the following concerns:
+
+
+
The eCommerce landscape is changing, and merchants must provide customers with an online shopping experience
+ that meets their performance expectations
+
+
As merchants grow their businesses and increasingly larger enterprise merchants are adopting Magento,
+ Magento Enterprise Edition must scale to handle increased traffic volume and larger catalogs
+
+
+
+
Magento's Plan
+
+
We identified the following areas for enhancement in Magento Enterprise Edition 1.13:
+
+
+
Improve indexing for catalogs of all sizes
+
Make re-indexing operations invisible to the shopper by executing them in the background
+
Improve full page caching support
+
Reduce page load times for key shopping flows (checkout)
+
Enable merchants to serve heavier traffic volume without need to purchase additional hardware
+
+
+
What Magento
+ Accomplished
+
+
Magento Enterprise Edition 1.13 delivers the following improvements over Magento Enterprise Edition 1.12:
+
+
+
Incremental re-indexing has been introduced with Magento Enterprise Edition 1.13, and scenarios where
+ full-re-indexing was required have been limited. This means that operations that previously took hours can
+ now be completed in minutes
+
+
53% improvement in completion times for a full re-index with a 500,000 SKU catalog
+
35% improvement in "Place Order" performance
+
65% improvement in page load times across shopper flow pages that were tested.
+
+
+
+
33% improvement in orders per day that can be processed on the same hardware configuration as Magento
+ Enterprise Edition 1.12
+
+
31% improvement in page views per day supported on the same hardware configuration on Magento Enterprise
+ Edition 1.12
+
+
+
+
Multi-Node Deployment
+ Topology
+
+
Before we introduce you to the benchmarks, an overview of our multi-node benchmarking facility is in order. We
+ started with a basic multi-node cluster with load balancer and caching and separate DB node, and installed
+ Apache. This is a familiar hardware configuration for the Magento developer community. Once provisioned, we
+ installed both Magento Enterprise Edition 1.13 and Magento Enterprise Edition 1.12 on the cluster to compare
+ their performance.
+
+
This is a representation of the multi-node Magento Enterprise Edition 1.12/1.13 installation used for performance
+ testing. It consists of four physical nodes, three of which are virtualized.
+
+
+
+
+
+
We used HP ProLiant SL230s Gen8 servers with 8x16GB DDR3 and 2x Intel Xeon E5â€2660 CPUs for our benchmarking.
+
+
We used a physical disk of a usable 1.2 TB managed by a RAID10 controller. The load balancer we used is
+ nginx.
+
+
The cluster resides in our Las Vegas data center, connected to the Internet via a gigabit connection. We tested
+ the cluster using the popular Gatling suite from our engineering offices in Austin, TX.
+
+
Software Components
+
+
+
+
+
+
+
Scenarios
+
+
This section presents the merchant scenarios we simulated for our testing. These scenarios are based on
+ real-world experience and industry standards with respect to shopper flows and catalog sizes.
+
+
Shopper Flows
+
+
We used real-world, established eCommerce metrics to simulate shopper flows.
+
+
+
94% of eCommerce shoppers visited a storefront but did not purchase any products
+
65% of shoppers added items to their carts but abandoned them
+
Of the 6% who did purchase products (otherwise known as the conversion rate), half checked out as guests
+ without signing in, and half signed into the storefront.
+
+
+
+
+
+
+
+
Catalog
+
+
The catalogs we simulated also reflect real-world, established eCommerce experience.
+
+
+
We simulated small and medium-sized companies with a 50,000-item catalog with 27 product categories.
+
We simulated large companies 500,000 items in the catalog with 2,000 categories.
+
As many eCommerce sites offer different types of products, we specified physical (simple) products, virtual
+ products, and downloadable products, with 60% of the products in each catalog being physical.
+
+
We benchmarked each catalog on one website/storefront.
+
+
+
+
+
+
+
Target Merchant
+ Profile
+
+
The simulated merchant profile we benchmarked against represents the profile of our enterprise customers. We
+ established these metrics based on the day-to-day experience of large merchants operating a successful eCommerce
+ business. Again, we used what we consider to be a typical hardware and software configuration.
+
+
+
50K visitors / day
+
1M Page views / day
+
18000 orders / day
+
3000 orders during peak 4 hours
+
1000 concurrent users
+
Standard HW/SW configuration
+
+
+
Benchmarking Results
+
+
+
These benchmarks were generated during extensive testing of our multi-node configuration running Magento
+ Enterprise Edition 1.13 described above. Our configuration was modeled after what a commercial hosting partner
+ would put into production, and the results reflect accurate gains over Magento Enterprise Edition 1.12.
+
+
The duration of the test sessions is 72 seconds, which significantly stresses the multi-node configuration.
+
+
Incremental
+ Re-indexing
+
+
In Magento Enterprise Edition 1.12, any change to a product would result in a full re-index. Magento Enterprise
+ Edition 1.13 introduces a new feature--incremental re-indexing. With incremental re-indexing, only those items
+ that were changed or added will be re-indexed, reducing the processing time to a fraction of what was required
+ before.
+
+
Take the example of a merchant with a catalog containing 500,000 products. In Magento Enterprise Edition 1.12,
+ any change to a product would result in a full re-index operation. In Magento Enterprise Edition 1.13,
+ incremental re-indexing means the merchant will only re-index items that were changed. The test focused on
+ measuring the improvements provided by the incremental re-indexing feature in Magento Enterprise Edition 1.13.
+ The table below compares improvements to common admin actions, such as changing a product description, prices or
+ inventory.
+
+
+
+
+
+
Full Re-indexing
+
+
+
As part of the benchmarking effort, we also measured the improvements in the full re-indexing feature on Magento
+ Enterprise Edition 1.13, where indexing a 500,000-item catalog was 53% faster than Magento Enterprise Edition
+ 1.12. Faster re-indexing means less load on the system and that changes to the catalog propagate faster to the
+ storefront.
+
+
+
+
+
+
+
500,000 products
+
2,000 categories
+
One store
+
One catalog update during test run
+
+
+
Individual
+ Re-indexers
+
+
The Magento Enterprise Edition 1.13 indexer component contains a number of individual indexers such as Product
+ Flat Data and Product Price. When a Magento admin changes the price of a product, it is only necessary to
+ execute the Product Price indexer for pricing changes to propagate to the frontend. The completion times of
+ these individual indexers were measured in the benchmark environment for Magento Enterprise Edition 1.13 and
+ Magento Enterprise Edition 1.12.
+
+
This section presents the results for full re-index completion times for the individual indexers in Magento
+ Enterprise Edition 1.13 compared to Magento Enterprise Edition 1.12.
+
+
+
+
+
+
+
URL Rewrite failed to run in Magento Enterprise Edition 1.12 but takes only 0.15 sec in Magento Enterprise
+ Edition 1.13
+
+
Catalog description: 500,000 products, 2000 categories, one storefront
+
+
+
Page Load Times
+
+
When Magento Enterprise Edition 1.12 and Magento Enterprise Edition 1.13 were compared, with both running on our
+ multi-node benchmarking configuration, Magento Enterprise Edition 1.13 loaded pages 65% faster than Magento
+ Enterprise Edition 1.12.
+
+
Guest checkout and registered user checkout are two flows that are crucial to storefront operation. This section
+ presents the results of page load time measurements for these two flows.
+
+
Guest Checkout
+ Flow Page Load Times
+
+
In the guest checkout flow pages, Magento Enterprise Edition 1.13 provides a substantial decrease in load times
+ over its predecessor, most of the time more than twice as fast.
+
+
+
+
+
+
Registered
+ Checkout Flow Page Load Times
+
+
The bar chart below presents the improvements in page load times for registered checkout flow.
+
+
+
+
+
+
Page Views and
+ Orders
+
+
In addition to page load times, the benchmark also focused on measuring throughput improvements, particularly
+ page views per day and orders per day.
+
+
During our testing, which simulated a storefront running at peak hours, EE 1.13 executed 33% more orders and 31%
+ more page views than Magento Enterprise Edition 1.12 on the multi-node benchmarking configuration. Notably,
+ Magento Enterprise Edition 1.13 served 47K pages during the test run (10 minutes).
+
+
+
+
+
+
+
10 minute session time
+
+
+
Observations
+
+
What we noted during the benchmarking tests:
+
+
+
The MySQL instance did not show any significant signs of CPU or I/O load during the tests.
+
+
+
The CPU was under 10% and no queries exceeded a 2-second threshold.
+
+
+
Redis and Memcached instances did not exceed a CPU load of 10% during the tests.
+
Web nodes showed high levels of CPU utilization under high load.
+
We anticipate achieving stable scaling by adding additional web nodes to the cluster until the services
+ themselves begin to degrade.
+
+
+
+
Conclusion
+
+
Magento Enterprise Edition 1.13 was engineered for performance--and clearly delivers on the goal as measured by
+ important metrics.
+
+
+
Indexing is improved to enable faster operations without impacting shopping experience. Merchant
+ administrators can add and update products as needed while ensuring product URLs, promotions, navigational
+ menus, and product search tools are always up to date.
+
+
The checkout process is improved by reducing page load times for browsing and placing orders. Faster
+ checkout can significantly improve your customers’ shopping experience and customer satisfaction, and
+ potentially improve your conversion rate.
+
+
Faster page load times means Magento Enterprise Edition 1.13 can support more page views per day and more
+ orders per day, potentially increasing your conversion rate.
+
+
+
+
In addition, we have focused on providing these benefits without the need to upgrade existing hardware, improving
+ your return on assets and investment.
+
+
Appendix
+
+
Page Load Times
+
+ This benchmark report presented analysis of the results produced by the Gatling load generator tool. In this
+ appendix, you can see the actual results reported by Gatling. The results were obtained under the following test
+ setup, which was designed to push Magento to its limit.
+
+
+
+
+
Concurrent session (users)
+
1000
+
+
+
Peak load duration
+
10 minutes
+
+
+
Session duration
+
72 seconds
+
+
+
CPU utilization
+
95%
+
+
+
+
+ CPU utilization is high because session duration was set to 72 seconds for the test. Session duration was set to a
+ low value to increase the active load on Magento. A typical e-commerce site will see session durations of five
+ minutes or more. Preliminary experiments by the benchmark team have confirmed that using a five-minute session
+ duration reduces the CPU utilization to 50-60%.
+
+
+
+
+
+
+
+
Magento EE v1.13
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Requests
+
+
Total
+
OK
+
KO
+
+
Min
+
Max
+
Mean
+
Std Dev
+
95th Pct
+
99th Pct
+
Req/s
+
+
+
Global Information0
+
+
62161
+
62087
+
74
+
+
80
+
12910
+
1735
+
1869
+
5780
+
8060
+
75
+
+
+
product page0
+
+
28573
+
28573
+
0
+
+
80
+
9390
+
709
+
996
+
2670
+
4920
+
34
+
+
+
Click add to cart1
+
+
10458
+
10458
+
0
+
+
440
+
7170
+
1868
+
1139
+
4010
+
4980
+
13
+
+
+
Click add to cart Redirect 12
+
+
10458
+
10458
+
0
+
+
960
+
12910
+
3816
+
2239
+
8050
+
9960
+
13
+
+
+
click checkout3
+
+
3486
+
3486
+
0
+
+
1100
+
10800
+
3459
+
1965
+
7130
+
8970
+
4
+
+
+
Registered Checkout:Login and Pick Address4
+
+
3366
+
3366
+
0
+
+
200
+
7380
+
1155
+
1482
+
4870
+
5900
+
4
+
+
+
Registered Checkout:Login and Pick Address Redirect 15
+
+
3366
+
3366
+
0
+
+
700
+
11440
+
2605
+
1662
+
5640
+
7710
+
4
+
+
+
Guest Checkout start6
+
+
120
+
120
+
0
+
+
360
+
2490
+
908
+
487
+
1860
+
2420
+
0
+
+
+
Registered:Pick Billing Address 17
+
+
120
+
120
+
0
+
+
390
+
4240
+
1457
+
974
+
3510
+
4210
+
0
+
+
+
Registered:Pick Billing Address 2-18
+
+
120
+
120
+
0
+
+
410
+
3690
+
1218
+
685
+
2460
+
3070
+
0
+
+
+
Registered:Pick Billing Address 2-29
+
+
120
+
120
+
0
+
+
400
+
3600
+
1201
+
714
+
2700
+
3510
+
0
+
+
+
Registered:Go to pick Shipping Method10
+
+
120
+
120
+
0
+
+
340
+
2900
+
1072
+
633
+
2330
+
2700
+
0
+
+
+
Guest:Pick Billing Address 111
+
+
120
+
120
+
0
+
+
610
+
4620
+
1688
+
941
+
3580
+
4440
+
0
+
+
+
Guest:Pick Billing Address 212
+
+
120
+
120
+
0
+
+
380
+
3530
+
1049
+
589
+
2050
+
2750
+
0
+
+
+
Guest:Go to pick Shipping Method13
+
+
120
+
120
+
0
+
+
300
+
2080
+
796
+
401
+
1530
+
1960
+
0
+
+
+
Set Shipping Method (Flatrate) 114
+
+
240
+
240
+
0
+
+
510
+
4830
+
1780
+
1066
+
3930
+
4720
+
0
+
+
+
Set Shipping Method (Flatrate): Goto Payment15
+
+
240
+
240
+
0
+
+
300
+
3150
+
905
+
516
+
1940
+
2300
+
0
+
+
+
Set Payment Method (Check/MO) 116
+
+
240
+
240
+
0
+
+
670
+
5290
+
1787
+
987
+
3660
+
4920
+
0
+
+
+
Set Payment Method (Check/MO) 217
+
+
240
+
240
+
0
+
+
300
+
2760
+
904
+
518
+
2010
+
2440
+
0
+
+
+
Set Payment Method (Check/MO) 318
+
+
220
+
220
+
0
+
+
370
+
8180
+
2696
+
1725
+
5810
+
7590
+
0
+
+
+
/checkout/../success/19
+
+
240
+
240
+
0
+
+
250
+
2830
+
931
+
583
+
1970
+
2530
+
0
+
+
+
/checkout/../success/ Redirect 120
+
+
74
+
0
+
74
+
+
1030
+
8350
+
2473
+
1620
+
5590
+
7310
+
0
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Magento EE v1.12
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Requests
+
+
Total
+
OK
+
KO
+
+
Min
+
Max
+
Mean
+
Std Dev
+
95th Pct
+
99th Pct
+
Req/s
+
+
+
Global Information0
+
+
48044
+
47887
+
157
+
+
40
+
40580
+
4985
+
3290
+
10650
+
13870
+
58
+
+
+
product page0
+
+
21327
+
21286
+
41
+
+
40
+
20040
+
4557
+
2820
+
9740
+
12350
+
26
+
+
+
Click add to cart1
+
+
8340
+
8324
+
16
+
+
40
+
12130
+
4216
+
2217
+
7520
+
9000
+
10
+
+
+
Click add to cart Redirect 12
+
+
8324
+
8320
+
4
+
+
40
+
16500
+
7022
+
3449
+
11780
+
13500
+
10
+
+
+
click checkout3
+
+
2780
+
2779
+
1
+
+
920
+
12350
+
6311
+
2829
+
9760
+
10950
+
3
+
+
+
Guest Checkout start4
+
+
90
+
90
+
0
+
+
390
+
3690
+
2103
+
795
+
3210
+
3410
+
0
+
+
+
Registered Checkout:Login and Pick Address5
+
+
2690
+
2690
+
0
+
+
180
+
19120
+
3298
+
4984
+
15470
+
16940
+
3
+
+
+
Guest:Pick Billing Address 16
+
+
90
+
90
+
0
+
+
600
+
7750
+
4348
+
1605
+
6430
+
7400
+
0
+
+
+
Registered Checkout:Login and Pick Address Redirect 17
+
+
2690
+
2688
+
2
+
+
40
+
24360
+
5433
+
3350
+
11780
+
14060
+
3
+
+
+
Guest:Pick Billing Address 28
+
+
90
+
90
+
0
+
+
520
+
8240
+
3412
+
1423
+
5480
+
6810
+
0
+
+
+
Guest:Go to pick Shipping Method9
+
+
90
+
90
+
0
+
+
310
+
4780
+
2334
+
888
+
3300
+
4450
+
0
+
+
+
Registered:Pick Billing Address 110
+
+
90
+
90
+
0
+
+
370
+
10090
+
3657
+
2453
+
8660
+
9600
+
0
+
+
+
Registered:Pick Billing Address 2-111
+
+
90
+
90
+
0
+
+
540
+
17670
+
4148
+
2741
+
10220
+
12510
+
0
+
+
+
Registered:Pick Billing Address 2-212
+
+
90
+
90
+
0
+
+
530
+
12640
+
3983
+
2411
+
8290
+
11590
+
0
+
+
+
Registered:Go to pick Shipping Method13
+
+
90
+
90
+
0
+
+
360
+
6290
+
2546
+
1401
+
5050
+
5980
+
0
+
+
+
Set Shipping Method (Flatrate) 114
+
+
180
+
180
+
0
+
+
450
+
7640
+
3926
+
1884
+
6550
+
7450
+
0
+
+
+
Set Shipping Method (Flatrate): Goto Payment15
+
+
180
+
180
+
0
+
+
380
+
6290
+
2451
+
1256
+
4270
+
4830
+
0
+
+
+
Set Payment Method (Check/MO) 116
+
+
180
+
180
+
0
+
+
570
+
8290
+
3923
+
1996
+
6460
+
7300
+
0
+
+
+
Set Payment Method (Check/MO) 217
+
+
180
+
180
+
0
+
+
330
+
5230
+
2318
+
1238
+
4210
+
4810
+
0
+
+
+
Set Payment Method (Check/MO) 318
+
+
180
+
180
+
0
+
+
940
+
40580
+
12673
+
7957
+
25910
+
29540
+
0
+
+
+
/checkout/../success/19
+
+
180
+
180
+
0
+
+
230
+
3330
+
1437
+
854
+
2870
+
3150
+
0
+
+
+
/checkout/../success/ Redirect 120
+
+
93
+
0
+
93
+
+
780
+
10470
+
5031
+
2251
+
7920
+
8880
+
0
+
+
+
+
+
+
+
+
Estimating the
+ Number of Visitors
+
+ Gatling does not report the number of users that cycled through during the test. However, it is possible to estimate
+ the number using the following formula:
+
+
Magento Community Edition (CE) Release Notes (1.8 and later)
+
+
+
Note: We'd like to make you aware that a security patch for older versions of Magento Community Edition has been posted (in
+ the Magento Community Edition Patches section). This patch resolves a remote code execution vulnerability that
+ enables an attacker with Magento administrator privileges to delete files and directories on a Magento
+ installation. This vulnerability was discovered through our quarterly penetration testing process and has not been
+ reported by merchants.
+ This issue was fixed in Magento Community Edition 1.8.0.0; no patch is necessary for versions 1.8.0.0 and later.
+ Patches are available for Magento Community Edition 1.4.0.0 through 1.7.0.2. We encourage all affected merchants
+ to apply the patch in their next regularly scheduled maintenance cycle.
+ Magento takes security very seriously and will continue to focus on identifying potential issues and hardening our
+ defenses.
+
+
+
Table of Contents
+
These Release Notes contain the following information:
Note: Some of the patches discussed in this section have
+ EE_1.14.0.1 in the name. These patches were all tested against CE 1.8.x as well.
+
+
General Magento Connect Patches
+
Patch name: SUPEE-3941
+
+
+ When
+ you install a community-created translation package, the translation provided by the package overwrites any
+ existing translations for the same items. This enables you to more easily install packages with translations.
+
+
+ To
+ improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
+
+ Extension
+ developers can now create an extensions with a dash character in the name. Merchants can install those extensions
+ without issues.
+
+ Magento
+ administrators who attempt to install an extension with insufficient file system privileges are now informed.
+ Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the
+ your Magento install dir/app/code/community directory structure, the Magento administrator
+ sees an error message in the Magento Connect Manager.
+ To set file system permissions appropriately, see After You Install
+ Magento: Recommended File System Ownership and Privileges.
+
+
+
Magento Install Page Displays After SOAP v2 Index Page Refresh
+
Patch name: SUPEE-3762.
+ Refreshing the SOAP v2
+ index page (http://your-magento-host-name/index.php/api/v2_soap/index/) results in all
+ administrators and customers viewing the Magento installation page.
+
+
+
+
+
Discover Card Validation Patch Available
+
Magento has fixed an issue that prevented some Discover credit cards from validating properly. The issue was that
+ certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover
+ cards should validate properly.
+
The issue affects Magento CE versions 1.4.2.0–1.8.1.0.
Important: This is not a security threat. No data has
+ been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid
+ Discover card numbers.
+
+
+
PHP 5.4 Patch Available
+
You can use PHP 5.4 with Magento CE versions 1.6.0.0–1.8.1.0.
Magento CE 1.8.1.0 helps advance overall product quality and ease operations by providing significant tax
+ calculation improvements, a wide range of bug fixes, and several security enhancements.
+
+
Tax Calculation Improvements
+
CE 1.8.1.0 resolves Value Added Tax (VAT) and Fixed Product Tax (FPT) issues so that Magento administrators can
+ create invoices and credit memos to give merchants merchants access to accurate and consistent tax calculations
+ and displays. We've also addressed:
+
+
VAT tax calculation issues for cross-border trade
+
Tax rounding issues when multiple taxes are applied
+
VAT and FPT calculation issues for bundled products
+
Support for the Waste Electrical and Electronic Equipment (W.E.E.E.) recycling tax in the EU
+
+
+
Functional Improvements
+
CE 1.8.1.0 includes bug fixes across important feature areas, including the shopping cart, checkout, content
+ management system, and product import and export function. Many of these updates came from a hackathon held with
+ Magento community developers, which demonstrates the vitality of our development community and their powerful
+ ability to help us advance the platform.
+
+
Security Enhancements
+
CE 1.8.1.0 includes several security enhancements that were identified through our rigorous security assessment
+ process. Magento complements its own comprehensive internal testing with quarterly penetration testing by expert
+ consultants and actively works with the development community to identify security issues in order to harden the
+ platform against potential threats.
+
+
+
+
Security Enhancements
+
Magento addressed the following security issues:
+
+
+ Improved the
+ password hashing algorithm.
+ Magento thanks Bjorn Kraus for contributing to this fix.
+
+
+ Resolved
+ issues that could have resulted in Cross-Site Request Forgery (CSRF) in the web store.
+
+
+
+ Resolved potential
+ issues when issuing Return Materials Authorizations (RMAs).
+ Magento thanks Ivan Chepurnyi for contributing to this fix.
+
+ Resolved a session
+ fixation issue when registering a user with the web store.
+
+
+
+
+ Resolved issues
+ with the expiration of file-based user sessions.
+ Closed a potential
+ loophole that enables another user to possibly access personal information when viewing billing
+ agreements.
+ Magento thanks Darryl Adie and Ampersand Commerce for contributing to this fix.
+
+ Fixed the security
+ settings for the frontend cookie to protect user sessions.
+
+
+
+
+
+
Issue After Upgrading to CE 1.8.1
+
+ There is a known Issue After Upgrading to CE 1.8.1 that affects
+ you only if you do not follow the recommended procedure to upgrade to a new environment as
+ discussed in Getting Ready For
+ Your Upgrade.
+
Symptom: After completing the upgrade, when you log in to the Admin Panel and click
+ System > Configuration, a fatal error similar to the following displays in your
+ browser:
+
Class 'Mage_Googlecheckout_Helper_Data' not found in /var/www/html/magento/app/Mage.php on line 547
+
+
Solution:
+
+
Close the Admin Panel browser window.
+
As a user with root privileges, delete all files exceptconfig.xml from the
+ following directory:
+
See the following sections for a discussion of changes in this release:
+
+
+
+ A tax
+ configuration option for Fixed Product Tax (FPT) has changed. This option is in the Admin Panel at
+ System > Configuration > SALES > Tax > Fixed Product Taxes,
+ option FPT Tax Configuration. This option replaces the Apply Tax to FPT option
+ in earlier CE releases.
+ This option specifies how FPT is calculated as follows:
+
+
Not Taxed: Click this option if your taxing jurisdiction does not tax FPT. (For example,
+ the state of California does not tax FPT.)
+
Taxed: Click this option if your taxing jurisdiction does tax FPT. (For example, Canada
+ taxes FPT.)
+
Loaded and Displayed with Tax: Click this option if FPT is added to the order total
+ before applying tax (for example, in EU countries).
+
+
+
+ You can now
+ specify a 0% tax rate. (In the Admin Panel, click Sales > Tax > Manage
+ Tax Zones & Rates.).
+ For more information, see the Magento User Guide.
+
+ Magento changed
+ its recommended setting for System > Configuration > SALES >
+ Tax > Calculation Settings, option Apply Discount On Prices
+ as follows:
+
+
US and Canadian merchants: Set the value of Apply Discount On Prices to Excluding
+ Tax.
+
EU merchants: Set the value of Apply Discount On Prices to Including
+ Tax.
+
+
+
+ Magento strongly
+ recommends all merchants set Apply Customer Tax to After Discount, regardless
+ of all other tax-related settings. This avoids issues with calculating the total product price.
+
+
+ When you specify a
+ tax rate, the State list is now available whenever you choose a country that has states.
+
+ You can now specify
+ the asterisk (*) wildcard character for the value of State when you set up a new
+ tax rate. This enables you to apply the same tax rate to all states or provinces in a particular country.
+
+ Stores now display
+ in the Admin Panel in System > Manage Stores as a three-column hierarchy, with
+ the website in the left column, all stores associated with the website in the center column, and all store views
+ associated with the store in the right column.
+ This makes it easier for you to browse your stores and understand which websites, store views, and stores are
+ associated with each other. The updated Manage Stores page also displays the root category for each store and
+ the code for each website and store view.
+ Magento thanks Fabrizio Branca for contributing to this fix. For more information, see Fabrizio's
+ blog post.
+
+ For the DHL
+ (Deprecated) shipping method to work, you must change the gateway URL as follows:
+
+
Log in to the Admin Panel as an administrator.
+
Click System > Configuration > SALES > Shipping
+ Methods.
+
In the right pane, expand DHL (Deprecated).
+
Change the value of the Gateway URL field to the following:
+
http://xmlapi.dhl-usa.com/ApiLanding.asp
+
+
In the upper right corner, click Save Config.
+
+
+
+
+
+
Tax Calculation Fixes
+
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
+
+
+ Canadian customers
+ now receive an e-mail with the correct totals for invoices and credit memos that include Provincial Sales Tax
+ (PST) and Goods and Services Tax (GST).
+
+ Resolved issues
+ with incorrect prices and incorrect tax amounts when a custom price is used together with the configuration
+ setting System > Configuration > SALES > Tax >
+ Calculation Settings, option Apply Tax On set to Original price
+ only.
+
+ The tax amount is
+ calculated correctly when:
+
+
The customer is in a different taxing jurisdiction than the web store
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Catalog Prices is set
+ to Including Tax
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Tax Calculation Method Based
+ On is set to Unit Price
+
+
+
+ The row total
+ including tax displayed in the shopping cart is calculated correctly when:
+
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Catalog Prices is set
+ to Excluding Tax
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Tax Calculation Method Based
+ On is set to Row Total
+
+
+
+ The row subtotal
+ displays the correct amount when reordering a product that includes a discount coupon.
+
+ Multiple tax rates
+ for a product display correctly in the Admin Panel when creating an invoice or credit memo.
+
+ Resolved calculation
+ errors when tax and currency conversion are applied. As a result, the price the customer views on a catalog or
+ product page is the same as the price displayed in the shopping cart.
+
+ A customer can now
+ place an order when two tax rules are applied to a product, even if the tax rules specify the same tax rate.
+
+
+ Resolved issues with
+ calculating taxes on orders that are shipped to different countries that have different tax rates.
+
+ Product prices,
+ including taxes, display on category and product pages the same for a guest customer as for a logged-in
+ customer. (A guest customer is a customer who does not log in to your web store; this customer belongs to the
+ NOT LOGGED IN customer group.)
+
+
+
+
Rounding Issues
+
The following tax rounding issues were resolved:
+
+
+ Resolved a
+ rounding issue in the tax detail display in the shopping cart when more than one tax rule is used.
+
+ Resolved an issue
+ reported on stackoverflow where a calculation error resulted from the following configuration:
+ System > Configuration > SALES > Tax > Calculation
+ Settings, option Tax Calculation Method Based On set to Total
+ System > Configuration > SALES > Tax > Calculation
+ Settings, option Catalog Prices set to Including Tax
+
+ As a result of
+ allowing a 0% tax rate, rounding errors related to different VAT jurisdictions have been resolved. For example,
+ if a product originates in a country with VAT but is shipped to another country that has no VAT, correct prices
+ display in the shopping cart.
+
+ Row totals display
+ correctly in the shopping cart when:
+
+
A shopping cart discount is applied
+
The following configuration options are set in System > Configuration >
+ SALES > Tax > Calculation Settings:
+
+
Catalog Prices is set to Including Tax
+
Tax Calculation Method Based On is set to Excluding Tax
+
Apply Customer Tax is set to After Discount
+
Apply Discount On Prices is set to Including Taxes
+
+
+
+
+
+
+
Display Issues
+
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
+ store:
+
+
+ Shipping prices
+ including tax display properly in the shopping cart.
+
+ A special price now
+ displays correctly on the product view page.
+
+ Values displayed in
+ PDFs for invoices and credit memos no longer overlap each other.
+
+ Orders, invoices,
+ and credit memos for downloadable and virtual products display the correct row total when viewed in the Admin
+ Panel.
+
+ Orders display the
+ FPT in the Admin Panel when the full tax summary is specified.
+
+ Fixed-price
+ bundled products that include FPT now display only one price for both From and To values, regardless of how you
+ configured the products.
+
+
+
+
+
Bundled Products Issues
+
+
+ The price of a
+ dynamic bundled product is calculated correctly after being customized by the customer.
+
+ The price of a
+ dynamic bundled product with tiered pricing is calculated correctly after being customized by the customer.
+
+ Resolved issues
+ with calculating the value displayed for the price including tax for bundled products.
+
+ The price
+ excluding tax of a bundle product to which a discount is applied is the same:
+
+
When viewed on the customization page
+
after adding the bundled product to the shopping cart.
+
+
+
+ A dynamically-priced
+ bundled product's prices displayed for Unit Price in the shopping cart (that is, the price including tax and the
+ price excluding tax) are now correct. Before the fix, the prices were equal, which was incorrect.
+
+ The
+ price of a bundled product displayed on the product view page and in the shopping cart are the same.
+
+ The grand total
+ including tax and the subtotal including tax displayed in the shopping cart are now identical when you specify
+ that catalog prices include tax and the shopping cart is set to display prices with and without taxes for a
+ dynamic bundled product that consists of two simple products.
+
+
+
+
Fixed Product Tax (FPT) Issues
+
+
+ Resolved
+ issues in calculating FPT on a credit memo.
+
+ With both
+ discounts and FPT enabled (and FPT is taxable), the subtotal including tax displayed in the shopping cart is
+ correct.
+
+ FPT calculation
+ for bundled products that have FPT applied to them now are now correct for all FPT configuration settings.
+
+ The invoice total
+ is calculated correctly for an order that has both FPT and a shopping cart discount.
+
+ The FPT amount is
+ now included in the Subtotal (Incl.Tax) row for partial invoice.
+
+ Resolved an issue
+ that resulted in FPT being applied twice to the grand total in the shopping cart.
+
+
+
+
+
Fixes in Magento CE 1.8.1.0
+
Fixes in this release can be divided into the following categories:
+ Resolved a new
+ customer registration issue that enabled a user to register and see another customer's dashboard.
+
+ Resolved issues with
+ breadcrumbs disappearing or displaying incorrectly.
+
+
+ The following options are available in the Admin Panel in System >
+ Configuration > SALES > Sales > Gift Options:
+ Allow Gift Wrapping on Order Level set to No
+ Allow Gift Wrapping for Order Items set to Yes
+
+ Category and
+ subcategory names display correctly. Before the issue was resolved, subcategory names that were significantly
+ longer than the category name did not display properly.
+
+
+ If a customer adds
+ more than one product that requires products to be purchased in increments, only the products that meet the
+ increment requirements are added. Before the fix, all products were added.
+
+ Scheduled payments
+ work properly.
+ Magento thanks Sylvain Raye for contributing to this fix.
+
+ If a bundled or
+ configurable product is out of stock, it's no longer available to check out.
+ Magento thanks Francesco Marangi for contributing to this fix.
+
+ Placing an order
+ in the Admin Panel correctly sets the order status to Pending.
+ Magento thanks GitHub user elframan for contributing to this fix.
+
+
+
+
+
Import and Export Fixes
+
+
+ Scheduled export
+ works properly.
+
+ You can now export
+ a shipment to CSV after printing its shipping label.
+ Magento thanks Florinel Chis for contributing to this fix.
+
+
+
+
Shipping Fixes
+
+
+ You are not
+ required to enter a declared value to ship with FedEx.
+
+ FedEx shipping
+ labels print properly; addresses are not truncated.
+
+ Fix for the USPS
+ change to the names of their Priority and Express shipping options in their API made on Sunday, July 28, 2013.
+
+
+
+
+
+
+
+
+
Other Fixes
+
+
+ Resolved issues that
+ caused spurious errors in the Magento exception log:
+ 'Zend_Date_Exception' with message 'Invalid year, it must be between -10000 and 10000'
+
+
+
+
+ Widgets display
+ properly on the CMS.
+
+
+
+
+ The product attribute
+ option Use Default Value works properly when used in a non-default store view.
+
+ A category attribute
+ set to store view scope displays in layered navigation.
+
+ A store set for
+ British Pound Sterling currency units now displays the correct currency in payment logs.
+
+ Resolved an issue with
+ the Mage_Catalog_Block_Product_Abstract class that caused errors to display on product view pages in
+ your web store.
+
+
+
+
+ Back-in-stock e-mails
+ contain the correct content.
+
+
+
+
+
+
+
+ You can now manage
+ product ratings and reviews from the Admin Panel as well as from the web store.
+ Magento thanks Fabian Blechschmidt Schrank for contributing to this fix.
+
+
+ Resolved an issue
+ with Mage_Page_Block_Template_Links::addLinkBlock to enable you to sort an array of results by
+ position.
+ Magento thanks Benjamin Marks for contributing to this fix.
+
+
+
+
Magento Community Edition (CE) 1.8.0.0 Release Notes
+
See the following sections for information about changes in this release:
+ Errors are not
+ displayed in a new Magento installation.
+
+ Fixed a session
+ fixation vulnerability in the new user registration process. Attackers can no longer abuse this flaw to take over
+ new user accounts during registration.
+
+ Resolved a remote
+ code execution vulnerability that enabled an attacker to delete files and directories on the Magento installation.
+ (The attack required access to the Admin Panel as a Magento administrator.)
+
+ Prevent attacks that
+ use OAuth to leak sensitive information to an attacker that knows the consumer key and user token.
+
+ Resolved an issue
+ that enabled attackers to gain access to billing information.
+ We thank Darryl Adia (from Ampersand Commerce) for contributing to this fix.
+
+ Resolved
+ issues with the security of OAuth tokens and keys.
+
A remote code execution vulnerability was fixed.
+ We thank Bastian Ike for contributing to this fix.
+
+
The Magento Admin Panel and web stores no longer allow web browsers to store usernames or passwords.
+
The Magento web store has additional Cross Site Request Forgery (CSRF) protections, meaning an imposter can no
+ longer impersonate a newly registered customer and perform actions on the customer's behalf.
+
The cryptographic methods used to store passwords were improved to enhance security.
+
+
+
United States Postal Service (USPS) Update
+
The USPS changed the names of their Priority and Express shipping options in their API in July 2013. To enable you
+ to continue utilizing USPS Priority and Express mail methods, CE 1.8 includes a patch that addresses the
+ issue.
+
Important: The USPS API patch has an impact on upgrading to CE 1.8
+ from earlier versions. If you're doing a new CE 1.8 installation, however, you don't need to do anything.
+
+
+
Following are details about the upgrade impact:
+
+
Print all USPS shipping labels before upgrading; after upgrading, you will not be able to print them.
+
Any shopping cart price rules that use the USPS shipping method that created before you upgrade must be re
+ created after you upgrade. Pre-existing USPS shipping methods do not work with shopping cart price rules after the
+ upgrade.
+
+
+
Performance Improvements
+
+
Limited the way Magento performs large database lookups.
+
+
Checkout performance improvements achieved by:
+
+
Eliminating unnecessary RSS cache cleanups when RSS functionality is disabled
+
The locale used to send a new order confirmation e-mail now first checks to see if the customer's locale is
+ the same as the store's locale before attempting to localize the e-mail.
+
+
+
Improving the overall checkout process performance by loading the progress information for the current
+ checkout step only
+
+
+
You can load a large number of tax codes (35,000 or so) without impacting performance.
+
+
+
+
+
Tax Calculation Fixes
+
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
+
+
Based on Magento testing and merchant experience, certain tax configuration settings have been determined to be
+ susceptible to rounding issues and can be confusing to buyers. To help you avoid issues with those settings,
+ warning messages display in the Admin Panel if you attempt to save such a configuration.
+ Administrative users can choose to dismiss the messages and can still save the configuration; however, Magento
+ strongly recommends you change the configuration in a way recommended by the details displayed in the
+ message.
+ For details, see the Magento
+ User Guide.
+
+
+
Bundle pricing is more consistent as follows:
+
+
The calculation formula is:
+ Sub item price = Sub item base price * Applicable tiered price adjustment or discount, then rounded
+ Bundle price = Sum (round(sub item price * qty))
+
When non-integer quantities are multiplied by a product price, Magento rounds the resulting subtotal is as
+ follows:
+ round(unit price * non-integer quantity)
+
+
+
All product price information on which taxation is based are rounded to two digits of precision regardless of
+ how many digits of precision have been loaded into the database (for example, $10.24 instead of $10.2385). This
+ situation can occur when certain integrations enable third-party applications to send four-digit precision prices
+ to Magento.
+ Starting with this release those additional digits will have no impact on customer facing prices. Forcing two
+ digits of precision enables more exact calculations involving Fixed Product Tax (FPT), discounts, and
+ taxes—among other concerns.
+
+
+
For certain Canadian provinces and localities, calculations and methods were updated to support changing legal
+ requirements in Canada:
+
The following issues relate to one-cent rounding errors in the web store or shopping cart:
+
+
Calculating taxes for bundled products with tiered pricing.
+
Calculating the price before customization for bundled products.
+
+
+
Calculating the grand total of items added to a cart in a different order.
+
Viewing an order when taxes are calculated after a discount using either row-based or unit price.
+
+
+
Applying a discount to an order with a shipping address different than the billing address.
+
+
+
Calculating the grand total based on the order in which products are added to the shopping cart.
+
+
+
Specifying that prices display in the web store excluding tax and setting a 20% tax rate (or discount rate) now
+ calculates the grand total correctly. It is now possible to have grand totals in amounts like 6.99, 9.99, or
+ 99.99—regardless of the currency units used in the web store.
+
+
+
Adding multiple items to a cart does not affect the accuracy with which taxation is calculated.
+
+
+
Subtotal (Incl. Tax) is now correct when catalog and shipping prices include tax. Both tax and discounts are
+ applied after tax.
+
+
+
Prices displayed in the cart and on the catalog page are consistent and correct when catalog prices include tax,
+ and when items in the catalog are set to display both including and excluding tax.
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
+
+
Error in calculating the Grand Total Excl. Tax was resolved. This error occurred in a specific configuration:
+ tax is applied to FPT, FPT is included in the subtotal, and the customer selects non-taxable flat rate shipping.
+
+
+
+
+
+
Fixed Product Tax (FPT) Fixes
+
The following issues relate to errors in calculating taxes that include FPT in the web store or shopping cart:
+
+
Price in the cart displays the correct before-tax price and grand total.
+
+
+
Subtotals displayed in the cart—both Including Tax and Excluding Tax—are now correctly calculated
+ when FPT is applied.
+
Free shipping offers are now processed correctly when FPT is applied.
+
FPT taxes are calculated correctly when a discount is applied.
+
+
+
+
+
Discount Calculation Fixes
+
The following issues relate to price calculations when coupon codes or other discounts are applied in the web store
+ or shopping cart:
+
+
The Row Subtotal displayed in the cart is calculated correctly (that is, both Excl. Tax and Incl. Tax are
+ correct).
+
The price for bundled items now displays with tax included if the bundle is configured to do so.
+
Taxation is now correctly calculated on a product with a discounted price.
+
Taxation on discounts is now calculated correctly when the ship-to country is different from the web store's
+ default country.
+
+
+
Display Fixes
+
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
+ store:
+
+
Row Subtotal displays correctly in the shopping cart when:
+
+
FPT is applied.
+
+
+
A discount is applied to a situation where the tax the customer pays is different from the tax specified for
+ the web store's locale (for example, when the shipping origin is different than the shipping address).
+
+
+
+
+
Subtotal including tax on a credit memo is correct when one or more items in the memo includes FPT.
+
+
+
Item subtotal displays correctly when a discount is applied to a purchase that includes FPT.
+
+
+
If the administrator sets catalog prices to exclude tax and to display product prices in catalog as including
+ tax, the price of the product in your web store includes applicable taxes.
+
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
The amount of tax displayed in the Order Totals section of the shopping cart is now correct when free shipping
+ and a shopping cart rule discount are applied.
+
+
+
+
+
API Fixes
+
The following are fixed in the Magento SOAP v2.0 APIs (with exceptions noted):
+
+
Requesting a product using a call like the following returns the product with the specified numeric SKU value
+ (8888 in the following example):
+ $result = $client->call($sessionId, 'catalog_product.info', '8888', null, null, 'sku');
+
+
You can now use from-to complex filters to perform "window" filtration on a single
+ field. For example, you can use from and to on the created_at return a list
+ of sales orders using the salesOrderList.
+
+
+
When you use the SOAP API v.2.0 with WS-I Compliance enabled to retrieve sales orders information, the server responds with the
+ correct Content-Length header.
+
+
+
The productGetSpecialPrice method returns special price information for a product, whether or not
+ WS-I Compliance is
+ enabled.
+
+
+
The shoppingCartPaymentList method returns the list of the available payment
+ methods for the shopping cart appropriately. The following error is no longer returned:
+ SOAP-ERROR: Encoding: object has no 'code' property in name
+
+
You can now add a C# web reference in Microsoft Visual Studio 2010 using the Magento WSDL.
+ For example, this command no longer fails:
+ C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin> wsdl /out:Magento.cs /v
+ http://magentohost/api/v2_soap/?wsdl
+
+
When a product price is set with website scope and an administrative user has access to only one website, the
+ default price is taken from that website scope. Also, when saving the product on the website scope, the price is
+ updated only in that scope and not in the default scope.
+
+
+
An error no longer displays on your web store after a customer places an order. (The error message was
+ There has been an error processing your request. Please contact us or try again later).
+
+
+
Restricted coupon codes work properly, even if the customer has selected the Remember me
+ checkbox.
+
+
+
Using the Table Rates shipping option, free shipping options work properly. (In the Admin Panel, click
+ System > Configuration > SALES > Shipping
+ Methods. In the right pane, expand Table Rates.)
+
+
+
Issues with shipping table rates have been resolved.
+
+
+
Entering a value such as 10,50 (using a comma character and not a period) for Adjustment
+ Fee now results in the correct amount of credit being applied to the transaction.
+
+
+
Unit price for bundled products is now calculated correctly.
+
+
+
The tiered price of bundled items now displays properly on the web store.
+
+
+
Composite products can be successfully reordered.
+
+
+
You can now use special characters in a product URL key.
+
+
+
After a customer visits the sitemap, web stores URLs are no longer prepended by
+ /sitemap/catalog/string.
+
+
+
Welcome messages now display properly in the web store after a customer's profile information is changed.
+
+
+
Recently viewed products now display updates properly.
+
+
+
Armed Forces Middle East is now available for State when checking out.
+
+
+
Searching for a customer's orders and returns works properly.
+
+
+
Shipping is calculated correctly if you select Using origin weight (few requests) for
+ Packages Request Type. (In the Admin Panel, click System >
+ Configuration > SALES > Shipping Methods > DHL (Deprecated)).
+
+
+
Free shipping is no longer available to a customer during checkout if the option was disabled by an
+ administrator. (In the Admin Panel, click System > Configuration >
+ Sales > Shipping Method > DHL(Deprecated), click one or more
+ options from the Allowed Methods list, and, from the Free Shipping with Minimum Order
+ Amount list, click No.)
+
+
+
A user can navigate your web store while downloading a downloadable product.
+
+
+
You can now specify weight units in kilograms (kg) using the FedEx shipping method.
+
+
+
FedEx shipping rates are now consistent with Magento discounted rates.
+
+
+
Fixed issues with United Parcel Service (UPS) shipping rates.
+
+
+
UPS shipping labels have the word SAMPLE printed on them only when you request a sample label.
+
+
+
Changes made to United States Post Office (USPS) APIs and rates have been incorporated in Magento.
+
+
+
The products in a customer's wish list no longer disappear after one or more products are edited by an
+ administrator.
+
+
+
Administrators can view the contents of a customer's shopping cart.
+
+
+
+ When a customer selects a product on your web store, the assigned category is selected in the
+ navigation menu.
+
+
+
+
+
Promotional Price Rule Fixes
+
The following fixes relate to administering and using shopping cart price rules and catalog price rules:
+
+
Shopping cart price rules applied to specific customer groups work properly.
+
+
+
Catalog price rules are applied properly to customer groups.
+
+
+
The scope of a product attribute is now honored by a catalog price rule.
+
+
+
Discounts specified by a shopping cart price rule are applied properly when a particular order is shipped to
+ multiple addresses.
+
+
+
A discount specified by a shopping cart price rule that allows for more than one use per customer is applied the
+ correct number of times if the customer has their orders shipped to more than one address.
+
+
+
+
When an administrative user whose role is restricted to only viewing catalog price rules, the user cannot add or
+ edit catalog price rules.
+
+
+
Shopping cart price rules now work properly with bundled products.
+
+
+
+
+
Administrative Ordering and Credit Memo Fixes
+
+
When you create an order using the Admin Panel and you have multiple stores, the State/Province
+ field updates appropriately for the country in which the order is placed.
+
+
+
When you create an order using the Admin Panel and you have specified a default billing address and a default
+ shipping address, the addresses are used correctly.
+
+
+
Orders placed by an administrator display in a customer's last order list.
+
+
+
Product comparisons now display properly when an administrator makes a change using the Admin Panel (for
+ example, deleting a product from a customer's comparison list).
+
+
+
You can now cancel an order using the Admin Panel.
+
+
+
Orders and invoices that include taxable shipping—when created in the Admin Panel—now calculate the
+ shipping taxes properly.
+
+
+
Products added to a customer's wish list by an administrator display properly.
+
+
+
+
+
Import Fixes
+
+
The quantity (QTY) of all products imports correctly.
+
+
+
The value of Maximum Qty Allowed in Shopping Cart (use_cfg_max_sale_qty) is correct.
+
+
+
The product displays correctly in layered navigation.
+
+
+
Importing customer lists with capitalization variations in the e-mail address now imports the customer only once
+ (for example, user@example.com and User@example.com).
+
+
+
+ Issues with importing products with Append Complex Data selecting from a
+ comma-separated value (.csv) file have been resolved.
+
+
+
+
Payment Fixes
+
+
Resolved issue sending customer e-mail when using Payflow Link.
+
+
+
Security issues with Google Checkout payments have been resolved.
+
+
+
Security issues with Authorize.net payments have been resolved.
+
+
+
Magento conforms to the latest version of the PayPal Instant Payment Notification (IPN) guidelines.
+
+
+
The contents of a shopping cart are unaffected by canceling a PayPal payment.
+
+
+
Issues with not being able to continue checkout after switching payment methods have been resolved.
+
+
+
You can now process partial refunds and invoices for orders that were placed using Payflow Pro.
+
+
+
Payflow Link and Payments Advance now capture IPN transactions properly.
+
+
+
Special characters (such as e-mail addresses) are now handled properly by the Magento Payflow API integration.
+
+
+
Resolved errors with orders placed using the Website Payments Pro payment method.
+
+
+
PayPal Express Checkout payments are handled properly when a shopping cart price rule is specified.
+
+
+
Any PayPal Name-Value Pair (NVP) payment method no longer automatically refunds an order when a chargeback is
+ initiated. Magento now allows the dispute to be resolved before taking the appropriate action.
+ PayPal NVP payment methods include: PayPal Payments Pro (including PayPal Payments Pro Hosted), Payments Standard,
+ and all Payflow methods.
+
+
+
PayPal Pro now correctly processes the shipping address for an order.
+
+
+
PayPal Express Checkout and PayPal Pro now handle partial refunds properly.
+
+
+
Fixed rounding errors that were preventing PayPal Express Checkout transactions from completing. The error
+ occurred with the following configuration:
+
+
tax calculation method based on the total
+
tax calculated based on the shipping address
+
catalog prices exclude tax
+
shipping prices exclude tax
+
customer discount applied after a discount
+
discount applied to prices excluding tax
+
tax applied to a custom price if available
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
+
+
+
The order status Suspected Fraud is now supported by PayPal Payments Pro (hosted) when PayPal fraud protection
+ is enabled. Using the Magento Admin Panel, the merchant can also accept or deny any Suspected Fraud orders and
+ have that decision applied to the PayPal transaction.
+
+
+
+ When sending payments in the United Kingdom, PayPal Payments Pro (hosted) now sends the value for
+ state correctly. (Before the fix, city was sent as the value for state.)
+
+
Using the Ogone payment method, transactions display in the Magento Admin Panel after you capture them.
+
+
+
When an administrator places an order and uses PSi Gate, then cancels the order, the PSi Gate gateway displays
+ both the order and the void transactions.
+
+
+
The following fields related to PayPal's Payflow Pro Gateway payment method are now implemented properly:
+
Fixed spurious Gateway error: Void error: V18A4B18E0F9 has been captured errors when canceling
+ partially invoiced orders when the Payflow Pro processor was used to process the payment.
+
+
+
3-D secure fix that affects UK merchants only: 3-D Secure for UK merchants implementing Direct Payment
+ works properly.
+
+
+
Partial captures are now supported for the following PayPal payment methods: Express Checkout, Payments Pro
+ Payflow Edition, and PayPal Standard.
+
+
+
Using the PayPal Express Checkout method, a recently added customer can check out without the error This
+ customer email already exists.
+
+
+
+
+
Other Fixes
+
+
+ Issues related to
+ the DHL shipping method for picking up and pricing orders on holidays have been resolved as follows:
+
+
If the current date is a weekend, Magento chooses next Monday as the pick-up date.
+
If the current date is a holiday, Magento requests from DHL information about the next five consecutive days
+ to find a workday on which to pick up the order.
+
If there is no workday in the five consecutive days following a holiday, the DHL shipping method is
+ unavailable.
+
+
+
+ The
+ .htaccess.sample provided with Magento now includes php_value memory_limit 512M to be
+ consistent with the Magento system
+ requirements.
+
+ You can now install
+ or upgrade to CE 1.8.0.0 if your Magento database had a table prefix (for example, all tables start with
+ mage_ because you specified a tables prefix during installation).
When an administrative user whose role is restricted to managing products attempts to edit Inventory settings
+ (Catalog > Manage Products, Inventory), only the available
+ options display.
+
+
+
Related product information updates appropriately in the Admin Panel.
+
+
+
Issues with editing product inventory settings and category attributes using the Google Chrome web browser have
+ been resolved.
+
+
+
Rolling back after a backup now works properly. (The Magento backup and rollback options are available in the
+ Admin Panel in System > Tools > Backup.)
+
+
+
You can now fetch data for a PayPal Settlement Report using a custom Secure FTP (SFTP) server.
+
+
+
You can now save a category with the option Available Product Listing Sort By: Best value or
+ Price enabled.
+
+
+
+
+
Thanks
+
Magento acknowledges and thanks everyone in the Magento Community who contributed to this release, including Colin
+ Mollenhour for Redis modules.
+
+
+
+
\ No newline at end of file
diff --git a/guides/v1.8/ce18-ee113/ee1.13_release-notes.html b/guides/v1.8/ce18-ee113/ee1.13_release-notes.html
new file mode 100644
index 0000000000..430c9fbd2f
--- /dev/null
+++ b/guides/v1.8/ce18-ee113/ee1.13_release-notes.html
@@ -0,0 +1,2109 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento Enterprise Edition (EE) Release Notes (1.13 and later)
+
+
+
+
+
+
+
+
+
+
+ {% include v1x/eol_message.html %}
+
+
+
+
Magento Enterprise Edition (EE) Release Notes (1.13 and later)
+
+
+
Table of Contents
+
These Release Notes contain the following information:
+ When
+ you install a community-created translation package, the translation provided by the package overwrites any
+ existing translations for the same items. This enables you to more easily install packages with translations.
+
+
+ To
+ improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
+
+ Extension
+ developers can now create an extensions with a dash character in the name. Merchants can install those extensions
+ without issues.
+
+ Magento
+ administrators who attempt to install an extension with insufficient file system privileges are now informed.
+ Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the
+ your Magento install dir/app/code/community directory structure, the Magento administrator
+ sees an error message in the Magento Connect Manager.
+ To set file system permissions appropriately, see After You Install
+ Magento: Recommended File System Ownership and Privileges.
+
+
+
Magento Install Page Displays After SOAP v2 Index Page Refresh
+
Patch name: PATCH_SUPEE-3762_EE_1.14.0.1_v1.sh.
+ Refreshing the SOAP v2
+ index page (http://your-magento-host-name/index.php/api/v2_soap/index/) results in all
+ administrators and customers viewing the Magento installation page.
+
+
Multiple Simultaneous Magento Administrators
+
Patch name: PATCH_SUPEE-3819_EE_1.14.0.1_v1.sh.
+ Multiple Magento
+ administrators can simultaneously add new products; or edit descriptions, edit prices, or edit stock quantities of
+ existing products without causing deadlocks, key violations, or critical data errors. Together with applying the
+ patch, you must set all indexers to Update when scheduled as follows:
+
+
Log in to the Magento Admin Panel as an administrator.
+
Click System > Configuration.
+
In the left navigation bar, from the ADVANCED group, click Index Management.
+
Expand Indexing Options.
+
From each list, click Update when scheduled.
+
Click Save Config in the upper right corner of the page.
+
+
+
+
+
+
+
+
Discover Card Validation Patch Available
+
Magento has fixed an issue that prevented some Discover credit cards from validating properly. The issue was that
+ certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover
+ cards should validate properly.
+
The issue affects EE versions 1.9.1.1 through 1.13.1.0.
Important: This is not a security threat. No data has been
+ compromised or misused. It affects only the ability to validate certain credit card number ranges as valid
+ Discover card numbers.
+
+
+
PHP 5.4 Patch Available
+
You can use PHP 5.4 with Magento EE versions 11.0.0.0–1.13.1.0.
This section discusses how to get patches referenced in these Release Notes. Magento has other patches available
+ from the EE support portal and the partner portal; you
+ can use the following instructions to install any of those patches as well.
Magento EE 1.13.1.0 helps advance overall product quality and ease operations by providing significant tax
+ calculation improvements, a wide range of bug fixes, and several security enhancements.
+
+
Tax Calculation Improvements
+
EE 1.13.1.0 resolves Value Added Tax (VAT) and Fixed Product Tax (FPT) issues so that Magento administrators can
+ create invoices and credit memos to give merchants merchants access to accurate and consistent tax calculations
+ and displays. We've also addressed:
+
+
VAT tax calculation issues for cross-border trade
+
Tax rounding issues when multiple taxes are applied
+
VAT and FPT calculation issues for bundled products
+
Support for the Waste Electrical and Electronic Equipment (W.E.E.E.) recycling tax in the EU
+
+
+
Functional Improvements
+
EE 1.13.1.0 includes bug fixes across important feature areas, including the shopping cart, checkout, content
+ management system, and product import and export function. Many of these updates came from a hackathon held with
+ Magento community developers, which demonstrates the vitality of our development community and their powerful
+ ability to help us advance the platform.
+
+
Security Enhancements
+
EE 1.13.1.0 includes several security enhancements that were identified through our rigorous security assessment
+ process. Magento complements its own comprehensive internal testing with quarterly penetration testing by expert
+ consultants and actively works with the development community to identify security issues in order to harden the
+ platform against potential threats.
+
+
Security Enhancements
+
Magento addressed the following security issues:
+
+
+ Improved the
+ password hashing algorithm.
+ Magento thanks Bjorn Kraus for contributing to this fix.
+
+
+ Resolved
+ issues that could have resulted in Cross-Site Request Forgery (CSRF) in the web store.
+
+
+
+ Resolved potential
+ issues when issuing Return Materials Authorizations (RMAs).
+ Magento thanks Ivan Chepurnyi for contributing to this fix.
+
+ Resolved a session
+ fixation issue when registering a user with the web store.
+
+
+ Closed a potential
+ loophole that enables another user to possibly access personal information when viewing billing
+ agreements.
+ Magento thanks Darryl Adie and Ampersand Commerce for contributing to this fix.
+
+ Resolved a remote
+ code execution vulnerability that enabled an attacker to delete files and directories on the Magento
+ installation. (The attack required access to the Admin Panel as a Magento administrator.)
+
+ Fixed the security
+ settings for the frontend cookie to protect user sessions.
+
+
+
+
+
+
Potential Issue After Upgrading to EE 1.13.1.0
+
There is a known issue after upgrading to EE 1.13.1 that affects you only if you do not follow
+ the recommended procedure to upgrade to a new environment as discussed in Getting Ready For Your
+ Upgrade.
+
Symptom: After completing the upgrade, when you log in to the Admin Panel and click
+ System > Configuration, a fatal error similar to the following displays in your
+ browser:
+
Class 'Mage_Googlecheckout_Helper_Data' not found in /var/www/html/magento/app/Mage.php on line 547
+
+
Solution:
+
+
Close the Admin Panel browser window.
+
As a user with root privileges, delete all files exceptconfig.xml from the
+ following directory:
+
See the following sections for a discussion of changes in this release:
+
+
+ EE's Payment
+ Bridge module has been updated to the latest version.
+ For more information, see this Magento blog post.
+
+ A tax
+ configuration option for Fixed Product Tax (FPT) has changed. This option is in the Admin Panel at
+ System > Configuration > SALES > Tax > Fixed Product Taxes,
+ option FPT Tax Configuration. This option replaces the Apply Tax to FPT option
+ in earlier EE releases.
+ This option specifies how FPT is calculated as follows:
+
+
Not Taxed: Click this option if your taxing jurisdiction does not tax FPT. (For example,
+ the state of California does not tax FPT.)
+
Taxed: Click this option if your taxing jurisdiction does tax FPT. (For example, Canada
+ taxes FPT.)
+
Loaded and Displayed with Tax: Click this option if FPT is added to the order total
+ before applying tax (for example, in EU countries).
+
+
+ You can now
+ specify a 0% tax rate. (In the Admin Panel, click Sales > Tax > Manage
+ Tax Zones & Rates.).
+ For more information, see the Magento User Guide.
+
+ Magento changed
+ its recommended setting for System > Configuration > SALES >
+ Tax > Calculation Settings, option Apply Discount On Prices
+ as follows:
+
+
US and Canadian merchants: Set the value of Apply Discount On Prices to Excluding
+ Tax.
+
EU merchants: Set the value of Apply Discount On Prices to Including
+ Tax.
+
+
+
+ Magento strongly
+ recommends all merchants set Apply Customer Tax to After Discount, regardless
+ of all other tax-related settings. This avoids issues with calculating the total product price.
+
+
+ When you specify a
+ tax rate, the State list is now available whenever you choose a country that has states.
+
+ You can now specify
+ the asterisk (*) wildcard character for the value of State when you set up a new
+ tax rate. This enables you to apply the same tax rate to all states or provinces in a particular country.
+
+ Stores now display
+ in the Admin Panel in System > Manage Stores as a three-column hierarchy, with
+ the website in the left column, all stores associated with the website in the center column, and all store views
+ associated with the store in the right column.
+ This makes it easier for you to browse your stores and understand which websites, store views, and stores are
+ associated with each other. The updated Manage Stores page also displays the root category for each store and
+ the code for each website and store view.
+ Magento thanks Fabrizio Branca for contributing to this fix. For more information, see Fabrizio's
+ blog post.
+
+ For the DHL
+ (Deprecated) shipping method to work, you must change the gateway URL as follows:
+
+
Log in to the Admin Panel as an administrator.
+
Click System > Configuration > SALES > Shipping
+ Methods.
+
In the right pane, expand DHL (Deprecated).
+
Change the value of the Gateway URL field to the following:
+
http://xmlapi.dhl-usa.com/ApiLanding.asp
.
+
In the upper right corner, click Save Config.
+
+
+
+
+
+
Tax Calculation Fixes
+
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
+
+
+ Canadian customers
+ now receive an e-mail with the correct totals for invoices and credit memos that include Provincial Sales Tax
+ (PST) and Goods and Services Tax (GST).
+
+ Resolved issues
+ with incorrect prices and incorrect tax amounts when a custom price is used together with the configuration
+ setting System > Configuration > SALES > Tax >
+ Calculation Settings, option Apply Tax On set to Original price
+ only.
+
+ The tax amount is
+ calculated correctly when:
+
+
The customer is in a different taxing jurisdiction than the web store
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Catalog Prices is set
+ to Including Tax
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Tax Calculation Method Based
+ On is set to Unit Price
+
+
+
+ The row total
+ including tax displayed in the shopping cart is calculated correctly when:
+
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Catalog Prices is set
+ to Excluding Tax
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Tax Calculation Method Based
+ On is set to Row Total
+
+
+
+ The row subtotal
+ displays the correct amount when reordering a product that includes a discount coupon.
+
+ Multiple tax rates
+ for a product display correctly in the Admin Panel when creating an invoice or credit memo.
+
+ Resolved calculation
+ errors when tax and currency conversion are applied. As a result, the price the customer views on a catalog or
+ product page is the same as the price displayed in the shopping cart.
+
+ A customer can now
+ place an order when two tax rules are applied to a product, even if the tax rules specify the same tax rate.
+
+
+ Resolved issues with
+ calculating taxes on orders that are shipped to different countries that have different tax rates.
+
+ Product prices,
+ including taxes, display on category and product pages the same for a guest customer as for a logged-in
+ customer. (A guest customer is a customer who does not log in to your web store; this customer belongs to the
+ NOT LOGGED IN customer group.)
+
+
+
+
Rounding Issues
+
The following tax rounding issues were resolved:
+
+
+ Resolved a
+ rounding issue in the tax detail display in the shopping cart when more than one tax rule is used.
+
+ Resolved an issue
+ reported on stackoverflow where a calculation error resulted from the following configuration:
+ System > Configuration > SALES > Tax > Calculation
+ Settings, option Tax Calculation Method Based On set to Total
+ System > Configuration > SALES > Tax > Calculation
+ Settings, option Catalog Prices set to Including Tax
+
+ As a result of
+ allowing a 0% tax rate, rounding errors related to different VAT jurisdictions have been resolved. For example,
+ if a product originates in a country with VAT but is shipped to another country that has no VAT, correct prices
+ display in the shopping cart.
+
+ Row totals display
+ correctly in the shopping cart when:
+
+
A shopping cart discount is applied
+
The following configuration options are set in System > Configuration >
+ SALES > Tax > Calculation Settings:
+
+
Catalog Prices is set to Including Tax
+
Tax Calculation Method Based On is set to Excluding Tax
+
Apply Customer Tax is set to After Discount
+
Apply Discount On Prices is set to Including Taxes
+
+
+
+
+
+
+
+
Display Issues
+
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
+ store:
+
+
+ Shipping prices
+ including tax display properly in the shopping cart.
+
+ A special price now
+ displays correctly on the product view page.
+
+ Values displayed in
+ PDFs for invoices and credit memos no longer overlap each other.
+
+ Orders, invoices,
+ and credit memos for downloadable and virtual products display the correct row total when viewed in the Admin
+ Panel.
+
+ Orders display the
+ FPT in the Admin Panel when the full tax summary is specified.
+
+ Fixed-price
+ bundled products that include FPT now display only one price for both From and To values, regardless of how you
+ configured the products.
+
+
+
+
+
Bundled Products Issues
+
+
+ The price of a
+ dynamic bundled product is calculated correctly after being customized by the customer.
+
+ The price of a
+ dynamic bundled product with tiered pricing is calculated correctly after being customized by the customer.
+
+ Resolved issues
+ with calculating the value displayed for the price including tax for bundled products.
+
+ The price
+ excluding tax of a bundle product to which a discount is applied is the same:
+
+
When viewed on the customization page
+
after adding the bundled product to the shopping cart.
+
+
+
+ A dynamically-priced
+ bundled product's prices displayed for Unit Price in the shopping cart (that is, the price including tax and the
+ price excluding tax) are now correct. Before the fix, the prices were equal, which was incorrect.
+
+ The
+ price of a bundled product displayed on the product view page and in the shopping cart are the same.
+
+ The grand total
+ including tax and the subtotal including tax displayed in the shopping cart are now identical when you specify
+ that catalog prices include tax and the shopping cart is set to display prices with and without taxes for a
+ dynamic bundled product that consists of two simple products.
+
+
+
+
Fixed Product Tax (FPT) Issues
+
+
+ Resolved
+ issues in calculating FPT on a credit memo.
+
+ With both
+ discounts and FPT enabled (and FPT is taxable), the subtotal including tax displayed in the shopping cart is
+ correct.
+
+ FPT calculation
+ for bundled products that have FPT applied to them now are now correct for all FPT configuration settings.
+
+ The invoice total
+ is calculated correctly for an order that has both FPT and a shopping cart discount.
+
+ The FPT amount is
+ now included in the Subtotal (Incl.Tax) row for partial invoice.
+
+ Resolved an issue
+ that resulted in FPT being applied twice to the grand total in the shopping cart.
+
+
+
+
+
Fixes in Magento EE 1.13.1.0
+
Fixes in this release can be divided into the following categories:
+ Abandoned cart
+ e-mails are sent at the scheduled time.
+
+ Resolved a new
+ customer registration issue that enabled a user to register and see another customer's dashboard.
+
+ Resolved issues with
+ breadcrumbs disappearing or displaying incorrectly.
+
+ With the following
+ configuration, gift pricing is applied properly for more than one item.
+ The following options are available in the Admin Panel in System >
+ Configuration > SALES > Sales > Gift Options:
+ Allow Gift Wrapping on Order Level set to No
+ Allow Gift Wrapping for Order Items set to Yes
+
+ Category and
+ subcategory names display correctly. Before the issue was resolved, subcategory names that were significantly
+ longer than the category name did not display properly.
+
+
+ If a customer adds
+ more than one product that requires products to be purchased in increments, only the products that meet the
+ increment requirements are added. Before the fix, all products were added.
+
+ Scheduled payments
+ work properly.
+ Magento thanks Sylvain Raye for contributing to this fix.
+
+ If a bundled or
+ configurable product is out of stock, it's no longer available to check out.
+ Magento thanks Francesco Marangi for contributing to this fix.
+
+ Placing an order
+ in the Admin Panel correctly sets the order status to Pending.
+ Magento thanks GitHub user elframan for contributing to this fix.
+
+
+
+
+
Import and Export Fixes
+
+
+ Scheduled export
+ works properly.
+
+ You can now export
+ a shipment to CSV after printing its shipping label.
+ Magento thanks Florinel Chis for contributing to this fix.
+
+
+
+
Shipping Fixes
+
+
+ You are not
+ required to enter a declared value to ship with FedEx.
+
+ FedEx shipping
+ labels print properly; addresses are not truncated.
+
+ Fix for the USPS
+ change to the names of their Priority and Express shipping options in their API made on Sunday, July 28, 2013.
+
+
+
+
Payment Fixes
+
+
+ The PayFlow Pro
+ payment method now allows line items with a negative value.
+
+ You can now use the
+ GSI Payment Service with Magento Payment Bridge.
+
+
Made the following fixes to eWay Direct:
+
+
+ Updated the
+ Payment Bridge console for eWay Direct.
+
+ You can now
+ process credit memos for eWay Direct.
+
+ Capture for eWay
+ direct now works as expected (that is, after the order is placed, the transaction is not captured but
+ can be refunded.
+
+
+
(
+ Because refunds are
+ not supported by the Paybox Direct method, you cannot process refunds using the Admin Panel.
+
+ After creating a
+ refund for a First Data transaction, the transaction is closed.
+
+ You can now pay for
+ an order using Sagepay.
+
+ You can now pay for
+ an order using Worldpay.
+
+ Line item details
+ are now available for orders placed using Sage Pay.
+
+ Authorize.net sends
+ only one validation request per transaction with Customer Information Management (CIM) enabled.
+
+
+
+
+
Other Fixes
+
+
+ Resolved issues that
+ caused spurious errors in the Magento exception log:
+ 'Zend_Date_Exception' with message 'Invalid year, it must be between -10000 and 10000'
+
+ Merging CMS pages no
+ longer results in errors.
+
+ Widgets display
+ properly on the CMS.
+
+ Previewing a CMS page
+ works properly.
+
+ The product attribute
+ option Use Default Value works properly when used in a non-default store view.
+
+ A category attribute
+ set to store view scope displays in layered navigation.
+
+ A store set for
+ British Pound Sterling currency units now displays the correct currency in payment logs.
+
+ Resolved an issue with
+ the Mage_Catalog_Block_Product_Abstract class that caused errors to display on product view pages in
+ your web store.
+
+ Fixed issues with
+ customer segments.
+
+ Back-in-stock e-mails
+ contain the correct content.
+
+
+
+
+
+
+
+ You can now manage
+ product ratings and reviews from the Admin Panel as well as from the web store.
+ Magento thanks Fabian Blechschmidt Schrank for contributing to this fix.
+
+
+ Resolved an issue
+ with Mage_Page_Block_Template_Links::addLinkBlock to enable you to sort an array of results by
+ position.
+ Magento thanks Benjamin Marks for contributing to this fix.
+
+
+
+
Magento EE 1.13.0.2 Release Notes
+
In response to customer feedback about EE 1.13.0.0 and EE 1.13.0.1, Magento has modified the functionality to
+ smooth the migration path from earlier EE versions and support duplicate category URL keys.
+
See the following sections for a discussion of changes in this release:
Perform all new installations and upgrades to Magento EE 1.13.0.2—not to Magento EE
+ 1.13.0.0 or 1.13.0.1—to avoid issues with missing products on your web store due to duplicate URL
+ key issues during the upgrade.
The main difference introduced in EE 1.13.0.2 is that product URL keys must be globally unique among all
+ websites, stores, and views. You can no longer have two different products that have the same URL key.
+
Benefit:
+
A single URL leads uniquely to a product page.
+
Discussion:
+
+
In EE 1.12, it was possible to have multiple products with the same URL key; however, every time the indexer
+ ran, it silently assigned a numerical suffix to duplicates (for example, shoes became
+ shoes-1 and so on).
+
Every time this happened, another URL rewrite was created, resulted in a set of chained redirects for
+ the same product. Having multiple URLs for a product dilutes the effectiveness of URL in search engine
+ weightings, especially if you enabled canonical URLs. (As discussed in this
+ article on Google's blog, a canonical URL is a public specification of your preferred URL. The
+ canonical URL is used by any search engine when crawling and indexing your site.)
+
This behavior was not clear to merchants and had the effect of diluting search engine weightings.
+
In EE 1.13.0.2, there is a single, unique way to access a product (or multiple ways if you use the category
+ path in URLs).
+
+
+
+
No more chained redirects
+
+
Description:
+
Magento addressed the indexer issue that resulted in suffixes being silently added to products with duplicate
+ URL keys. In EE 1.13.0.2, duplicate URL keys are not allowed.
+
Benefit:
+
Search engines recognize the canonical URL, which improves the product's weighting in search results. (All of
+ the weighting goes to the canonical URL.)
+
+
+
Per-entity indexing
+
+
Description:
+
EE 1.13.0.2 uses per-entity indexing that indexes custom URL redirects, categories, and products—as
+ opposed to a global indexer.
+
Benefit:
+
+
Similar to chained redirects, in EE 1.12, if a product had the same URL key as its parent category, the indexer
+ assigned an incrementing numeric suffix to either the category or the product. This was done without the
+ merchant's knowledge and was confusing as well.
+
+
Discussion:
+
+
In EE 1.12, if you named a top-level category slippers and had product also named
+ slippers, the indexer allowed to access to the category using a URL like the following:
+ http://www.example.com/slippers-1
+
In EE 1.13.0.2, the same product can be accessed using a URL like:
+ http://www.example.com/slippers
+
There is a new Admin Panel setting to specify how indexing should be prioritized. This setting,
+ System > Configuration > CATALOG > Catalog > Search
+ Engine Optimizations > Priority for Duplicated URL Keys, is discussed in more
+ detail in Prioritizing URL Resolution.
+
+
+
+
+
+
URL Key Uniqueness Rules in Magento EE 1.13.0.2
+
The following entities can be indexed and therefore have a requirement for URL key uniqueness:
+
+
Categories
+
Products (including custom URL redirects)
+
Content Management System (CMS)
+
+
Uniqueness rules for each entity type follow:
+
+
+
+
Entity type
+
Uniqueness rule
+
+
+
Product, including custom URL redirects†
+
All product URL keys must be globally unique.
+
+
+
Category
+
+
Category URL keys must be unique only in the same level in the hierarchy; for example
+ website
+ root category
+ store view
+ category tree
+ *category name*
+
Note: Uniqueness rules apply to inactive categories as well. You cannot use the same URL
+ key for both an active and inactive category at the same level in the category hierarchy.
+
+
+
+
CMS
+
CMS URL keys, like category URL keys, must be unique only in the same level in the
+ hierarchy.
+
+
+
+
†—Custom URL redirect refers to a product's Create Custom Redirect
+ for old URL option.
+
+
URL Key Examples
+
The following table shows category URL keys that are allowed. (The URL key is shoes for all entities
+ in the table.)
You cannot have the same category URL key for two categories at the same level in the same store
+ view.
+
You can optionally add the store code to the URL path (in the Admin Panel, click System >
+ Configuration > GENERAL > Web, Add Store Code to Urls).
+
+
+
Prioritizing URL Resolution
+
Suppose you have the following set of URL keys. All of them are allowed because they're for different entity types.
+
+
+
+
+
Entity type
+
Entity name
+
URL key
+
Sample URL
+
+
+
Category
+
shoes
+
shoes
+
http://www.example.com/shoes.html
+
+
+
Product
+
shoes
+
shoes
+
http://www.example.com/shoes.html
+
+
+
Custom URL redirects
+
shoes
+
shoes
+
http://www.example.com/shoes.html
+
+
+
+
Question: What happens when a web store visitor requests
+ http://www.example.com/shoes.html?
+
Answer: You control the response in the Admin Panel. Click System >
+ Configuration > CATALOG > Search Engine Optimizations. In the right pane, click an
+ option from the Priority for Duplicated URL Keys list. Some examples follow:
+
+
+
+
Priority setting
+
Result
+
+
+
Default setting:
+
+
Redirect†
+
Category
+
Product
+
+
+
Custom URL redirect
+
+
+
+
+
Category
+
Redirect
+
Product
+
+
+
Shoes category
+
+
+
+
†—Custom URL redirect refers to a product's Create Custom Redirect
+ for old URL option.
+
The other options are:
+
+
Redirect - Product - Category
+
Category - Product - Redirect
+
Product - Redirect - Category
+
Product - Category - Redirect
+
+
In the event no URL key matches your priority setting, Magento continues through the priorities in order until a
+ match is found.
+ After changing the
+ value for product or category suffix, previous suffixes do not work.
+
For example, if a category URL suffix was set to .html and you change it to .php,
+ categories that had been using the .html suffix display an HTTP 404 (Not Found) error in your web store.
+
(In the Admin Panel, click System > Configuration > CATALOG >
+ Catalog > Search Engine Optimizations. In the right pane, the options are named
+ Product URL Suffix and Category URL Suffix.)
+
+
Patch Available for EE 1.13.0.2
+
The United States Postal Service (USPS) changed the names of their Priority and Express shipping options in their
+ API on Sunday, July 28, 2013. Magento has a patch available; however, this patch is not included in new EE 1.13.0.2
+ installations.
+
Note: If you applied the patch before you upgraded to EE 1.13.0.2, you don't
+ have to do anything.
+
+
For new EE 1.13.0.2 installations to continue utilizing USPS Priority and Express mail methods, you must
+ install the patch we've created to address the issue.
+
Get the patch from the EE support portal by logging in to magentocommerce.com.
+
+
Changes in EE 1.13.0.2
+
+
+ You
+ now have the option of specifying a store view when creating a URL redirect. There is also a Store column on the
+ Catalog > URL Redirects page.
+ This column specifies the store view for which the URL redirect is defined.
+
+ Root categories have
+ no URL Key field. The root category URL key was never used, so the field was eliminated.
+
+ Validation
+ for the URL key field was improved. URL keys can only contain alphanumeric characters (a-z, 0-9)
+ and the hyphen or dash character (-).
+
+ Categories and
+ products in categories display with the full category path if the following setting is made in the Admin Panel:
+ System > Configuration > CATALOG > Catalog. Set the option
+ named Use Categories Path for Product URLs to Yes.
+
+ When setting up a
+ product URL redirect, the name of the button on the category selection page has changed from Skip choosing
+ category to Skip Category Selection.
+
+ There is a new
+ setting in the Admin Panel to set the priority for resolving duplicate URLs for different entities (that is,
+ custom URL redirects, categories, and products). For more information, see Prioritizing URL Resolution.
+
URL key uniqueness rules apply to inactive categories as well. You cannot use the same URL key for both an
+ active and inactive category at the same level in the category hierarchy.
+
The Google sitemap for products and categories is updated with new or updated URL keys at the interval you
+ specify in the Admin Panel: System > Configuration > CATALOG > Google
+ Sitemap. In the right pane, expand Generation Settings.
+
The following apply to new products when you do not explicitly set a value for the URL key
+ field:
+
+
Duplicating a results in a URL key with an appended index number. For example, if you duplicate a product
+ with a URL key of testurlkey, the new product's URL key might is testurlkey-1.
+
If you create a new product with a name that matches an existing URL key, the new product's URL key has the
+ product ID appended to it. For example, if there is currently a product with a URL of product1
+ and you create a new product with the name Product1 and the product has an ID of 500, the new
+ product's URL key is product1-500.
+
Note: To avoid having Magento specify a URL key for you,
+ you can enter one yourself. Make sure the URL key you specify is unique among all products, including
+ products across store views.
+
+
+
+
The following apply to enabling the canonical meta tag options for categories and products:
+
+
If Use Canonical Meta Tag for Categories is enabled, the category page on your web store
+ includes a canonical URL to the full category URL. For example, http://www.example.com/mens/shoes
+
+
If Use Canonical Meta Tag for Products is enabled, the product page includes a canonical
+ URL to domain-name/product-url-key because product URL keys must be globally
+ unique.
+ If you also enable the option Use Categories Path for Product URLs, the canonical URL is
+ still domain-name/product-url-key but the product can also be accessed using
+ its full URL (including the category hierarchy). Examples:
+ If the product URL key is producturlkey and it's assigned to the Apparel > Womens >
+ Purses category, the product can be accessed using both of the following URLs:
+ http://www.example.com/producturlkey
+ http://www.example.com/apparel/womens/purses/producturlkey
+ The canonical URL for the product is http://www.example.com/producturlkey.
+
Notes:
+
The canonical URL options are available in the Admin Panel by clicking System >
+ Configuration > CATALOG > Catalog. In the right pane, expand
+ Search Engine Optimizations. The options are named Use Canonical Link Meta Tag
+ For Categories and Use Canonical Link Meta Tag For Products.
+
The option to add the category path to a product URL is available in the same location in the Admin
+ Panel. The option name is Use Categories Path for Product URLs.
+
+
+
+
+
Fixes in Magento EE 1.13.0.2
+
This section discusses fixes made in EE 1.13.0.2.
+
+
+ Resolved a
+ critical database deadlock in the URL rewrite indexer. The deadlock resulted in the following message in the
+ exception log: SQLSTATE[40001]: Serialization failure: 1213 Deadlock found when trying to get
+ lock.
+
+ The following
+ layered navigation issues were addressed:
+
+
If a subcategory contains a product that is associated with the parent category, you can view the
+ subcategory in your web store.
+
Clicking a link for a product attribute in an anchor category works.
+
+
+
+ You can now
+ install or upgrade to EE 1.13.0.2 if your Magento database had a table prefix (for example, all tables start
+ with mage_ because you specified a tables prefix during installation).
+
Resolved the following upgrade issues:
+
+
+ After
+ upgrading from an earlier version like EE 1.12.0.2, errors such as the following no longer display in the
+ Magento exception log:
+ SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry
+
+
+ Resolved an
+ issue that prevented web store users from viewing products that had duplicate URL keys before upgrading.
+
+
+
+
+
+
Resolved the following issues with URL keys in store views:
+
+
+ Changing
+ the store view no longer results in product or category 404 (Not Found) errors.
+
+ Resolved an
+ issue that categories created from a store view had the wrong URL format in the web store. Examples
+ follow:
+ Incorrect (before the fix): /catalog/category/view/s/newcategory/id/36/
+ Correct: /catalog/newcategory/
+
+
+
+ Resolved an
+ issue where a product could be viewed using a category to which it was not assigned.
+ This behavior was associated with the following Admin Panel setting: System >
+ Configuration > CATALOG > Catalog.
+
+ Moving a
+ category no longer results in HTTP 404 (Not Found) errors viewing a category's product in the web store.
+
+
+
+ Categories
+ display in the web store with the correct URL key, even if the category was previously deleted and added back
+ with the same URL key.
+
+ A customer can
+ view a product from the Recently Viewed Products list if the product is associated with a different category
+ than the one the customer is currently viewing.
+
+ Any product
+ page displays properly when the user accesses it from the site map on your web store.
+ This includes the case when an administrator sets the following option to Yes:
+ System > Configuration >CATALOG > Catalog
+ > Search Engine Optimizations, option named Use Categories Path for Product
+ URLs.
+
+ The category is
+ not included in the URL to a product in your web store when an administrator sets following option to
+ No: System > Configuration >CATALOG >
+ Catalog > Search Engine Optimizations, option named Use Categories
+ Path for Product URLs.
+
+ The URLs for
+ the same category and product, when assigned to multiple store views, are as expected.
+ Category URL example: /parent-category/category-2/
+ Product URL example: /parent-category/category-2/product-1
+
+ With the option
+ to Add Store Code to URLs option enabled, store codes properly display in URLs and the store view displays
+ properly.
+
+ After
+ duplicating a product, the product's URL key updates successfully.
+
+ A product URL
+ key is correct in your web store even if there is a category with the same URL key as the product.
+
+ Adding products
+ without specifying a value for the URL Key field no longer results in the exception log entry
+ SQLSTATE[23000]: Integrity constraint violation.
+
+ You can create
+ two or more categories with the same URL key without encountering the exception log entry
+ SQLSTATE[23000]: Integrity constraint violation.
+
+ The value of a
+ product's URL Key field is properly validated.
+ A URL key can contain only alphanumeric characters (a-z, A-Z, 0-9) and the dash or hyphen character.
+
+ A caching error
+ that affected changing URL redirects was fixed.
+
+ URL redirects
+ work properly when products are assigned to categories in different store views but using the same request
+ path.
+
+ You can
+ successfully import data and reindex with the import behavior set to Append Complex Data.
+
+ After moving a
+ category to another location in the category hierarchy, the category's URL and breadcrumbs update
+ successfully.
+
+ The options to
+ create a custom redirect for a category and product work properly.
+ (In the Admin Panel, click System > Configuration > CATALOG >
+ Catalog > Search Engine Optimizations. In the right pane, from the
+ Create Permanent Redirect for URLs if URL Key Changed, click Yes.
+
+ Switching store
+ views enables you to navigate to products and categories on that store view as expected. HTTP 404 (Not Found)
+ errors no longer display and the specified category and product URL keys are correct.
+ In earlier EE versions, incorrect behavior was reported when the setting System >
+ Configuration > GENERAL > Web, Add Store Code to Urls was
+ set to Yes.
+
+ A remote code
+ execution vulnerability was fixed.
+
+
+
+ On
+ a clean installation, display errors are hidden.
+
+
+
+
+
Magento EE 1.13.0.0 Release Notes
+
See the following sections for information about changes in this release:
Major overhaul of tax calculation formulas, correction of rounding errors, and additional assistance with
+ configuration
+
+ Most indexing processes now run only to update products, categories, URL redirects, and so on that
+ have changed—eliminating the need for manual full reindexing
+ Full page caching now invalidates only pages that are affected by product or category changes
+
Optimized cache adapters for single-server systems
+
Elimination of many types of database deadlocks
+
+
+
Security Enhancements
+
+
The Magento Admin Panel and web stores no longer allow web browsers to store usernames or passwords.
+
The Magento web store has additional Cross Site Request Forgery (CSRF) protections, meaning an imposter can
+ no longer impersonate a newly registered customer and perform actions on the customer's behalf.
+
In earlier versions, Magento was vulnerable to a session fixation attack during the registration process.
+ After logging in to their account, a registered user's session ID did not change. Therefore, if an attacker
+ had knowledge of an unauthorized session ID and if that user successfully registers, the attacker was able to
+ take over the newly registered account.
+ Now, the session ID changes after successful registration, making unauthorized use of an account impossible.
+
+
The cryptographic methods used to store passwords were improved to enhance security.
+
+
+
+
Security Advisory
+
Magento has identified a potential vulnerability that might affect you if both of the following are true:
+
+
Your store uses custom code that calls Magento full page caching functions
+
You enabled the Use SID on Frontend configuration option
+ (In the Admin Panel, System > Configuration > WEB > Session
+ Validation Settings, Use SID on Frontend.)
+
+
Note: The potential vulnerability exists only if both
+ of the preceding are true. Default Magento installations or installations that enable Use SID on
+ Frontend but have no custom code with full page caching are at no risk.
+
+
If both of the preceding are true, Magento can be subjected to cross-site scripting
+ (XSS) attacks—a type of injection issue, which means that malicious code is injected into otherwise
+ trusted websites, generally in the form of a browser-side script.
+
Issue: Magento is subject to XSS attacks because the SID cookie value is not sanitized by default.
+
Suggested solution: Either disable Use SID on Frontend or output-encode any usage of the SID cookie value before using it or passing it as a
+ parameter to any page cache helper functions.
Magento EE 1.13—unlike earlier versions—does not allow duplicate URL keys for products or
+ categories. An issue has been identified that causes problems during upgrades if you already have duplicate URL
+ keys. The issue is being addressed; until a solution is announced, Magento recommends you test your upgrade but
+ do not try to deploy it to a production environment.
Limited the way Magento performs large database lookups.
+
+
+
Checkout performance improvements achieved by:
+
+
Eliminating unnecessary calls to gift wrapping when loading the Shipping Method checkout step
+
Eliminating unnecessary RSS cache cleanups when RSS functionality is disabled
+
The locale used to send a new order confirmation e-mail now first checks to see if the customer's locale
+ is the same as the store's locale before attempting to localize the e-mail.
+
+
+
Improving the overall checkout process performance by loading the progress information for the current
+ checkout step only
+
+
+
You can load a large number of tax codes (35,000 or so) without impacting performance.
+
+
The following general fixes were made to Magento tax configuration and calculations:
+
+
Based on Magento testing and merchant experience, certain tax configuration settings have been determined to be
+ susceptible to rounding issues and can be confusing to buyers. To help you avoid issues with those settings,
+ warning messages display in the Admin Panel if you attempt to save such a configuration.
+ Administrative users can choose to dismiss the messages and can still save the configuration; however, Magento
+ strongly recommends you change the configuration in a way recommended by the details displayed in the
+ message.
+ For details, see the Magento
+ User Guide.
+
+
+
Bundle pricing is more consistent as follows:
+
+
The calculation formula is:
+ Sub item price = Sub item base price * Applicable tiered price adjustment or discount, then rounded
+ Bundle price = Sum (round(sub item price * qty))
+
When non-integer quantities are multiplied by a product price, Magento rounds the resulting subtotal is as
+ follows:
+ round(unit price * non-integer quantity)
+
+
+
All product price information on which taxation is based are rounded to two digits of precision regardless of
+ how many digits of precision have been loaded into the database (for example, $10.24 instead of $10.2385). This
+ situation can occur when certain integrations enable third-party applications to send four-digit precision prices
+ to Magento.
+ Starting with this release those additional digits will have no impact on customer facing prices. Forcing two
+ digits of precision enables more exact calculations involving Fixed Product Tax (FPT), discounts, and
+ taxes—among other concerns.
+
+
+
For certain Canadian provinces and localities, calculations and methods were updated to support changing legal
+ requirements in Canada:
+
The following issues relate to one-cent rounding errors in the web store or shopping cart:
+
+
Calculating taxes for bundled products with tiered pricing.
+
Calculating the price before customization for bundled products.
+
+
+
Calculating the grand total of items added to a cart in a different order.
+
Viewing an order when taxes are calculated after a discount using either row-based or unit price.
+
+
+
Applying a discount to an order with a shipping address different than the billing address.
+
+
+
Calculating the grand total based on the order in which products are added to the shopping cart.
+
+
+
Specifying that prices display in the web store excluding tax and setting a 20% tax rate (or discount rate) now
+ calculates the grand total correctly. It is now possible to have grand totals in amounts like 6.99, 9.99, or
+ 99.99—regardless of the currency units used in the web store.
+
+
+
Adding multiple items to a cart does not affect the accuracy with which taxation is calculated.
+
+
+
Subtotal (Incl. Tax) is now correct when catalog and shipping prices include tax. Both tax and discounts are
+ applied after tax.
+
+
+
Prices displayed in the cart and on the catalog page are consistent and correct when catalog prices include tax,
+ and when items in the catalog are set to display both including and excluding tax.
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
+
+
Error in calculating the Grand Total Excl. Tax was resolved. This error occurred in a specific configuration:
+ tax is applied to FPT, FPT is included in the subtotal, and the customer selects non-taxable flat rate shipping.
+
+
+
+
+
+
Fixed Product Tax (FPT) Fixes
+
The following issues relate to errors in calculating taxes that include FPT in the web store or shopping cart:
+
+
Price in the cart displays the correct before-tax price and grand total.
+
+
+
Subtotals displayed in the cart—both Including Tax and Excluding Tax—are now correctly calculated
+ when FPT is applied.
+
Free shipping offers are now processed correctly when FPT is applied.
+
FPT taxes are calculated correctly when a discount is applied.
+
+
+
+
+
Discount Calculation Fixes
+
The following issues relate to price calculations when coupon codes or other discounts are applied in the web store
+ or shopping cart:
+
+
The Row Subtotal displayed in the cart is calculated correctly (that is, both Excl. Tax and Incl. Tax are
+ correct).
+
The price for bundled items now displays with tax included if the bundle is configured to do so.
+
Taxation is now correctly calculated on a product with a discounted price.
+
Taxation on discounts is now calculated correctly when the ship-to country is different from the web store's
+ default country.
+
+
+
Display Fixes
+
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
+ store:
+
+
Row Subtotal displays correctly in the shopping cart when:
+
+
FPT is applied.
+
+
+
A discount is applied to a situation where the tax the customer pays is different from the tax specified for
+ the web store's locale (for example, when the shipping origin is different than the shipping address).
+
+
+
+
+
Subtotal including tax on a credit memo is correct when one or more items in the memo includes FPT.
+
+
+
Item subtotal displays correctly when a discount is applied to a purchase that includes FPT.
+
+
+
If the administrator sets catalog prices to exclude tax and to display product prices in catalog as including
+ tax, the price of the product in your web store includes applicable taxes.
+
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
When Minimum Advertised Price (MAP) is enabled and the customer examines the price of a product in a gift
+ registry, the price includes all of the following: price, actual price, price including tax, and price excluding
+ tax.
+
+
+
The amount of tax displayed in the Order Totals section of the shopping cart is now correct when free shipping
+ and a shopping cart rule discount are applied.
+
+
+
+
+
API Fixes
+
The following are fixed in the Magento SOAP v2.0 APIs (with exceptions noted):
+
+
Requesting a product using a call like the following returns the product with the specified numeric SKU value
+ (8888 in the following example):
+ $result = $client->call($sessionId, 'catalog_product.info', '8888', null, null, 'sku');
+
+
You can now use from-to complex filters to perform "window" filtration on a single
+ field. For example, you can use from and to on the created_at return a list
+ of sales orders using the salesOrderList.
+
+
+
When you use the SOAP API v.2.0 with WS-I Compliance enabled to retrieve sales orders information, the server responds with the
+ correct Content-Length header.
+
+
+
The productGetSpecialPrice method returns special price information for a product, whether or not
+ WS-I Compliance is
+ enabled.
+
+
+
The shoppingCartPaymentList method returns the list of the available payment
+ methods for the shopping cart appropriately. The following error is no longer returned:
+ SOAP-ERROR: Encoding: object has no 'code' property in name
+
+
You can now add a C# web reference in Microsoft Visual Studio 2010 using the Magento WSDL.
+ For example, this command no longer fails:
+ C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin> wsdl /out:Magento.cs /v
+ http://magentohost/api/v2_soap/?wsdl
+
+
When a product price is set with website scope and an administrative user has access to only one website, the
+ default price is taken from that website scope. Also, when saving the product on the website scope, the price is
+ updated only in that scope and not in the default scope.
+
+
+
An error no longer displays on your web store after a customer places an order. (The error message was
+ There has been an error processing your request. Please contact us or try again later).
+
+
+
Restricted coupon codes work properly, even if the customer has selected the Remember me
+ checkbox.
+
+
+
Using the Table Rates shipping option, free shipping options work properly. (In the Admin Panel, click
+ System > Configuration > SALES > Shipping
+ Methods. In the right pane, expand Table Rates.)
+
+
+
Issues with shipping table rates have been resolved.
+
+
+
Reward Points are now granted one time per order, even when comments are added to the order later.
+
+
+
Entering a value such as 10,50 (using a comma character and not a period) for Adjustment
+ Fee now results in the correct amount of credit being applied to the transaction.
+
+
+
Unit price for bundled products is now calculated correctly.
+
+
+
The tiered price of bundled items now displays properly on the web store.
+
+
+
Composite products can be successfully reordered.
+
+
+
You can now use special characters in a product URL key.
+
+
+
After a customer visits the sitemap, web stores URLs are no longer prepended by
+ /sitemap/catalog/string.
+
+
+
Welcome messages now display properly in the web store after a customer's profile information is changed.
+
+
+
Recently viewed products now display updates properly.
+
+
+
Armed Forces Middle East is now available for State when checking out.
+
+
+
Gift wrapping charges now display properly in a PDF invoice.
+
+
+
Searching for a customer's orders and returns works properly.
+
+
+
Shipping is calculated correctly if you select Using origin weight (few requests) for
+ Packages Request Type. (In the Admin Panel, click System >
+ Configuration > SALES > Shipping Methods > DHL (Deprecated)).
+
+
+
Free shipping is no longer available to a customer during checkout if the option was disabled by an
+ administrator. (In the Admin Panel, click System > Configuration >
+ Sales > Shipping Method > DHL(Deprecated), click one or more
+ options from the Allowed Methods list, and, from the Free Shipping with Minimum Order
+ Amount list, click No.)
+
+
+
A user can navigate your web store while downloading a downloadable product.
+
+
+
You can now specify weight units in kilograms (kg) using the FedEx shipping method.
+
+
+
FedEx shipping rates are now consistent with Magento discounted rates.
+
+
+
Fixed issues with United Parcel Service (UPS) shipping rates.
+
+
+
An issue that caused a fatal error in the web store for an item in a gift registry has been resolved. The issue
+ occurred when the item was removed from a website after a user had added the item to their gift registry.
+
+
+
UPS shipping labels have the word SAMPLE printed on them only when you request a sample label.
+
+
+
Changes made to United States Post Office (USPS) APIs and rates have been incorporated in Magento.
+
+
+
You can now process a return materials authorization (RMA) for an order that was shipped to multiple addresses.
+
+
+
The products in a customer's wish list no longer disappear after one or more products are edited by an
+ administrator.
+
+
+
Administrators can view the contents of a customer's shopping cart.
+
+
+
The price of a simple product now displays properly when category permissions are enabled. (To set category
+ permissions in the Admin Panel, click Catalog > Categories > Manage
+ Categories, select a category, and click the Category Permissions tab.)
+
+
+
Issues with purchasing a product using a gift card created with a custom option have been resolved.
+
+
+
+ When a customer selects a product on your web store, the assigned category is selected in the
+ navigation menu.
+
+
+
+ With both flat index options enabled and set to update on save, mass attribute updates now display
+ properly in your web store.
+ For more information about flat catalog options, see the Magento User Guide.
+
+
+
+ With both flat index options disabled, after adding a product to many websites and assigning it to
+ one or more categories, the product displays in the appropriate websites and categories in the web store.
+
+
+
+ You can now use multiple selection attributes in a customer segment.
+
+
+
+
+
Promotional Price Rule Fixes
+
The following fixes relate to administering and using shopping cart price rules and catalog price rules:
+
+
Shopping cart price rules applied to specific customer groups work properly.
+
+
+
Catalog price rules are applied properly to customer groups.
+
+
+
The scope of a product attribute is now honored by a catalog price rule.
+
+
+
Discounts specified by a shopping cart price rule are applied properly when a particular order is shipped to
+ multiple addresses.
+
+
+
You can add a gift card to an order that qualifies for a 100% purchase price discount specified by a shopping
+ cart price rule.
+
+
+
A discount specified by a shopping cart price rule that allows for more than one use per customer is applied the
+ correct number of times if the customer has their orders shipped to more than one address.
+
+
+
+
When an administrative user whose role is restricted to only viewing catalog price rules, the user cannot add or
+ edit catalog price rules.
+
+
+
Shopping cart price rules now work properly with bundled products.
+
+
+
+
+
Administrative Ordering and Credit Memo Fixes
+
+
When you create an order using the Admin Panel and you have multiple stores, the State/Province
+ field updates appropriately for the country in which the order is placed.
+
+
+
When you create an order using the Admin Panel and you have specified a default billing address and a default
+ shipping address, the addresses are used correctly.
+
+
+
Orders placed by an administrator display in a customer's last order list.
+
+
+
Product comparisons now display properly when an administrator makes a change using the Admin Panel (for
+ example, deleting a product from a customer's comparison list).
+
+
+
You can now cancel an order using the Admin Panel.
+
+
+
Orders and invoices that include taxable shipping—when created in the Admin Panel—now calculate the
+ shipping taxes properly.
+
+
+
Products added to a customer's wish list by an administrator display properly.
+
+
+
Issues with the incorrect number of reward points being credited when issuing credit memos have been resolved.
+
+
+
+
+
Import Fixes
+
+
The quantity (QTY) of all products imports correctly.
+
+
+
The value of Maximum Qty Allowed in Shopping Cart (use_cfg_max_sale_qty) is correct.
+
+
+
The product displays correctly in layered navigation.
+
+
+
Importing customer lists with capitalization variations in the e-mail address now imports the customer only once
+ (for example, user@example.com and User@example.com).
+
+
+
+ Issues with importing products with Append Complex Data selecting from a
+ comma-separated value (.csv) file have been resolved.
+
+
+
+
Payment Fixes
+
+
Resolved issue sending customer e-mail when using Payflow Link.
+
+
+
Security issues with Google Checkout payments have been resolved.
+
+
+
Security issues with Authorize.net payments have been resolved.
+
+
+
Magento conforms to the latest version of the PayPal Instant Payment Notification (IPN) guidelines.
+
+
+
The contents of a shopping cart are unaffected by canceling a PayPal payment.
+
+
+
Issues with not being able to continue checkout after switching payment methods have been resolved.
+
+
+
You can now process partial refunds and invoices for orders that were placed using Payflow Pro.
+
+
+
Payflow Link and Payments Advance now capture IPN transactions properly.
+
+
+
Special characters (such as e-mail addresses) are now handled properly by the Magento Payflow API integration.
+
+
+
Resolved errors with orders placed using the Website Payments Pro payment method.
+
+
+
PayPal Express Checkout payments are handled properly when a shopping cart price rule is specified.
+
+
+
Any PayPal Name-Value Pair (NVP) payment method no longer automatically refunds an order when a chargeback is
+ initiated. Magento now allows the dispute to be resolved before taking the appropriate action.
+ PayPal NVP payment methods include: PayPal Payments Pro (including PayPal Payments Pro Hosted), Payments Standard,
+ and all Payflow methods.
+
+
+
PayPal Pro now correctly processes the shipping address for an order.
+
+
+
PayPal Express Checkout and PayPal Pro now handle partial refunds properly.
+
+
+
Fixed rounding errors that were preventing PayPal Express Checkout transactions from completing. The error
+ occurred with the following configuration:
+
+
tax calculation method based on the total
+
tax calculated based on the shipping address
+
catalog prices exclude tax
+
shipping prices exclude tax
+
customer discount applied after a discount
+
discount applied to prices excluding tax
+
tax applied to a custom price if available
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
+
+
+
The order status Suspected Fraud is now supported by PayPal Payments Pro (hosted) when PayPal fraud protection
+ is enabled. Using the Magento Admin Panel, the merchant can also accept or deny any Suspected Fraud orders and
+ have that decision applied to the PayPal transaction.
+
+
+
+ When sending payments in the United Kingdom, PayPal Payments Pro (hosted) now sends the value for
+ state correctly. (Before the fix, city was sent as the value for state.)
+
+
Using the Ogone payment method, transactions display in the Magento Admin Panel after you capture them.
+
+
+
When an administrator places an order and uses PSi Gate, then cancels the order, the PSi Gate gateway displays
+ both the order and the void transactions.
+
+
+
The following fields related to PayPal's Payflow Pro Gateway payment method are now implemented properly:
+
Fixed spurious Gateway error: Void error: V18A4B18E0F9 has been captured errors when canceling
+ partially invoiced orders when the Payflow Pro processor was used to process the payment.
+
+
+
3-D secure fixes that affect UK merchants only:
+
+
3-D Secure for UK merchants implementing Direct Payment works properly.
+
+
+
SagePay Direct with 3-D secure payments are processed correctly.
+
+
+
+
+
The Braintree payment method can now be configured properly.
+
+
+
Partial captures are now supported for the following PayPal payment methods: Express Checkout, Payments Pro
+ Payflow Edition, and PayPal Standard.
+
+
+
Using the PayPal Express Checkout method, a recently added customer can check out without the error This
+ customer email already exists.
+
+
A fatal error in GiftRegistry/Model/Item/Option.php has been resolved.
+
+
+
When an administrative user whose role is restricted to managing products attempts to edit Inventory settings
+ (Catalog > Manage Products, Inventory), only the available
+ options display.
+
+
+
Related product information updates appropriately in the Admin Panel.
+
+
+
Issues with editing product inventory settings and category attributes using the Google Chrome web browser have
+ been resolved.
+
+
+
Rolling back after a backup now works properly. (The Magento backup and rollback options are available in the
+ Admin Panel in System > Tools > Backup.)
+
+
+
You can now fetch data for a PayPal Settlement Report using a custom Secure FTP (SFTP) server.
+
+
+
+ Using the Solr search engine with price navigation calculation step set to manual now displays
+ search results properly on your web store. (A fatal error was fixed.)
+ (To set price navigation step options in the Admin Panel, click System >
+ Configuration > CATALOG > Catalog > Layered
+ Navigation. From the Price Navigation Step Calculation list, click
+ Manual.)
+ For more information about using the Solr search engine with Magento EE, see the Magento User Guide.
+
+
+
You can now save a category with the option Available Product Listing Sort By: Best value or
+ Price enabled.
+
+
+
+ The following fixes relate to full page caching:
+
+
+ Breadcrumbs to a product work for all categories with which the product is associated.
+
+
+
+ The correct customer name displays on a gift card.
+
+
+
+ Product tags display properly.
+
+
+
+ Related products display properly.
+
+
+
+ magento-install-dir/app/code/core/Enterprise/PageCache/Model/Config.php was
+ modified to enable you to set specific lifetimes for certain blocks.
+
+
+
+ Automated e-mail marketing reminder rules work properly.
+
+
+
+ Issues with session cookies have been resolved.
+
+
+
+
+
+
+
+
Changes
+
This release includes the following changes to support the changes in indexing:
+
+
+ As a result of the optimizations made to reindexing, you can no longer have a duplicate:
+
+
URL key for any two products
+
URL key for any two categories
+
Request Path for any URL Redirect (formerly referred to as URL Rewrite
+
+
+
+ There is a new management page in the Admin Panel: System >
+ Configuration > ADVANCED > Index Management.
+
+ The options on the System > Index Management are significantly
+ different. In particular, because manual reindexing is no longer required for most indexers, there are fewer
+ checkboxes and the page mostly displays status information.
+
In the Admin Panel, Catalog > Manage Products > edit-product >
+ General tab page option Create Permanent Redirect for old URL if URL key changed
+ changes to Create Custom Redirect for old URL.
+ The feature behaves the same way; namely, selecting Yes creates a redirect for the old URL that
+ points to the new URL if a page is moved.
+
Note: The wording of this option is expected to change back to
+ the previous wording in a subsequent release.
+
+
+
The options Product URL Suffix and Category URL Suffix return an error if
+ anything except alphanumerical characters or the underscore character are entered. (In the Admin Panel,
+ click System > Configuration > CATALOG > Catalog >
+ Search Engine Optimizations.)
+
+ The catalog_product_entity_url_key and catalog_category_entity_url_key
+ database tables for the corresponding url_key attributes have been added.
+
+
+
+
+ For more information about indexing changes, see the Magento User Guide.
+
+
+
+
+
+
diff --git a/guides/v1.8/ce18-ee113/ht_magento-ce-sample.data.html b/guides/v1.8/ce18-ee113/ht_magento-ce-sample.data.html
new file mode 100644
index 0000000000..3d5e6bf356
--- /dev/null
+++ b/guides/v1.8/ce18-ee113/ht_magento-ce-sample.data.html
@@ -0,0 +1,45 @@
+---
+layout: v1x
+title: Installing Sample Data for Magento Community Edition (CE)
+---
+
+
Overview
+
This page discusses how to get the sample data for:
+
+
Magento Community Edition (CE) 1.6, 1.7, or 1.8
+
Magento Community Edition (CE) 1.9.0.0
+
Magento Community Edition (CE) 1.9.1.0–1.9.2.0
+
+
+
Important: Magento CE 1.9 and later use different sample data from the other versions in
+ the preceding list. Make sure you use the correct version of sample data
+ with your version of Magento CE.
+
+
Install Sample Data Before You Install Magento
+
Magento CE sample data must be installed before you install Magento CE.
+
+
Getting the Sample Data
+
+ The sample data is provided in different formats for your convenience.
+ Archives for each version have exactly the same content (they differ only by compression method).
+
Redis is an open source, Berkeley Software Distribution (BSD) licensed, advanced key-value store that can optionally be used in Magento for backend and session storage. In fact, you can replace memcached with Redis.
+
Following are some of the benefits Redis provides for Magento implementations:
+
Redis supports on-disk save and master/slave replication. This is a powerful feature not supported by memcached. Replication enables high availability by eliminating a single point of failure.
+
Redis can be used for PHP session storage.
+
Redis provides much better eviction control and its backend is written with eviction support in mind.
+
Redis supports multiple databases that use the same server instance so you can use different databases for the Magento cache, full page cache (EE only), and sessions without starting many processes listening on different ports.
+
Redis supports compression libraries gzip, lzf, and snappy. lzf and snappy are much faster than gzip.
The following Magento editions support Redis session and backend caching:
+
Enterprise Edition (EE) 1.13 and later
+
Community Edition (CE) 1.8
+
The preceding Magento editions support Redis server version 2.6.9 and later available from redis.io.
+
In addition, you can optionally use the Redis extension for PHP version 2.2.3 or later if you're using Redis for backend caching; however, Magento works without this extension.
+
+
Configuring Redis
+
To use Redis with Magento, you must configure Magento to use Redis and you must install and configure the Redis server. These tasks are discussed in the following sections:
To use Redis with Magento, you only need to install and configure the Redis server. The integration between Redis and Magento is already included with Magento CE 1.8 and EE 1.13 and later versions. All you need to do is configure it.
+
Important: The Cm_RedisSession module in CE 1.8 is disabled by default. Magento disables the module to avoid unnecessary connection tries to Redis when you choose to use file, database, or a different session storage method.
+
To enable Magento to use Redis, perform the following tasks:
+
Enable the Cm_RedisSession module.
+
Open magento-install-dir/app/etc/modules/Cm_RedisSession.xml in a text editor.
+
Change the value of <active> to true.
+
Save your changes to Cm_RedisSession.xml and exit the text editor.
+
+
Modify magento-install-dir/app/etc/local.xml.
+ For configuration information, see the sample provided with Magento in magento-install-dir/app/etc/local.xml.additional and also see the Readme (session) and Readme (backend).
+
Flush the Magento cache in any of the following ways:
+
If you have access to the file system as the owner of the files in the Magento installation directory, change to that directory and enter rm -rf var/cache.
+
Log in to the Admin Panel as an administrator. Click System > Cache Management, then click Flush Magento Cache at the top of the page.
You can optionally install the Redis extension for PHP version 2.2.3 or later as well, but Magento functions without it.
+
+
Getting Support for Redis
+
Important: Colin Mollenhour, the original author of Redis, does not provide support for Magento implementations. You can get support for Magento implementations in the following ways:
Magento acknowledges the contributions of Colin Mollenhour in providing the code for the Magento implementation of Redis.
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/guides/m1x/images/2167-Benchmark-Config-Doc-R1.png b/guides/v1.8/images/2167-Benchmark-Config-Doc-R1.png
similarity index 100%
rename from guides/m1x/images/2167-Benchmark-Config-Doc-R1.png
rename to guides/v1.8/images/2167-Benchmark-Config-Doc-R1.png
diff --git a/guides/m1x/images/2178-1.13_Benchmark_Report_Shopper_Flows_r1v1.png b/guides/v1.8/images/2178-1.13_Benchmark_Report_Shopper_Flows_r1v1.png
similarity index 100%
rename from guides/m1x/images/2178-1.13_Benchmark_Report_Shopper_Flows_r1v1.png
rename to guides/v1.8/images/2178-1.13_Benchmark_Report_Shopper_Flows_r1v1.png
diff --git a/guides/m1x/images/2179-1.13_Benchmark_Report_Catalog_r3v1.png b/guides/v1.8/images/2179-1.13_Benchmark_Report_Catalog_r3v1.png
similarity index 100%
rename from guides/m1x/images/2179-1.13_Benchmark_Report_Catalog_r3v1.png
rename to guides/v1.8/images/2179-1.13_Benchmark_Report_Catalog_r3v1.png
diff --git a/guides/m1x/images/2180-1.13_Benchmark_Report_Partial_Reindexingr2v1.png b/guides/v1.8/images/2180-1.13_Benchmark_Report_Partial_Reindexingr2v1.png
similarity index 100%
rename from guides/m1x/images/2180-1.13_Benchmark_Report_Partial_Reindexingr2v1.png
rename to guides/v1.8/images/2180-1.13_Benchmark_Report_Partial_Reindexingr2v1.png
diff --git a/guides/m1x/images/2182-1.13_Benchmark_Report_Full_Reindexing_r1v1.png b/guides/v1.8/images/2182-1.13_Benchmark_Report_Full_Reindexing_r1v1.png
similarity index 100%
rename from guides/m1x/images/2182-1.13_Benchmark_Report_Full_Reindexing_r1v1.png
rename to guides/v1.8/images/2182-1.13_Benchmark_Report_Full_Reindexing_r1v1.png
diff --git a/guides/m1x/images/2183-1.13_Benchmark_Report_Individual_Reindexing_r1v1.png b/guides/v1.8/images/2183-1.13_Benchmark_Report_Individual_Reindexing_r1v1.png
similarity index 100%
rename from guides/m1x/images/2183-1.13_Benchmark_Report_Individual_Reindexing_r1v1.png
rename to guides/v1.8/images/2183-1.13_Benchmark_Report_Individual_Reindexing_r1v1.png
diff --git a/guides/m1x/images/2184-1.13_Benchmark_Report_Checkout_Flow_r1v1.png b/guides/v1.8/images/2184-1.13_Benchmark_Report_Checkout_Flow_r1v1.png
similarity index 100%
rename from guides/m1x/images/2184-1.13_Benchmark_Report_Checkout_Flow_r1v1.png
rename to guides/v1.8/images/2184-1.13_Benchmark_Report_Checkout_Flow_r1v1.png
diff --git a/guides/m1x/images/2185-1.13_Benchmark_Report_Registered_Checkout_r1v1.png b/guides/v1.8/images/2185-1.13_Benchmark_Report_Registered_Checkout_r1v1.png
similarity index 100%
rename from guides/m1x/images/2185-1.13_Benchmark_Report_Registered_Checkout_r1v1.png
rename to guides/v1.8/images/2185-1.13_Benchmark_Report_Registered_Checkout_r1v1.png
diff --git a/guides/m1x/images/2186-1.13_Benchmark_Report_Page_Views_r2v1.png b/guides/v1.8/images/2186-1.13_Benchmark_Report_Page_Views_r2v1.png
similarity index 100%
rename from guides/m1x/images/2186-1.13_Benchmark_Report_Page_Views_r2v1.png
rename to guides/v1.8/images/2186-1.13_Benchmark_Report_Page_Views_r2v1.png
diff --git a/guides/m1x/images/2187-1.13_Benchmark_Report_Software_Component_r1v1.png b/guides/v1.8/images/2187-1.13_Benchmark_Report_Software_Component_r1v1.png
similarity index 100%
rename from guides/m1x/images/2187-1.13_Benchmark_Report_Software_Component_r1v1.png
rename to guides/v1.8/images/2187-1.13_Benchmark_Report_Software_Component_r1v1.png
diff --git a/guides/m1x/images/30737051.png b/guides/v1.8/images/30737051.png
similarity index 100%
rename from guides/m1x/images/30737051.png
rename to guides/v1.8/images/30737051.png
diff --git a/guides/m1x/images/30737052.png b/guides/v1.8/images/30737052.png
similarity index 100%
rename from guides/m1x/images/30737052.png
rename to guides/v1.8/images/30737052.png
diff --git a/guides/m1x/images/35619336.png b/guides/v1.8/images/35619336.png
similarity index 100%
rename from guides/m1x/images/35619336.png
rename to guides/v1.8/images/35619336.png
diff --git a/guides/m1x/images/EE-spt-portal.png b/guides/v1.8/images/EE-spt-portal.png
similarity index 100%
rename from guides/m1x/images/EE-spt-portal.png
rename to guides/v1.8/images/EE-spt-portal.png
diff --git a/guides/m1x/images/Magento_MVC.pdf b/guides/v1.8/images/Magento_MVC.pdf
similarity index 100%
rename from guides/m1x/images/Magento_MVC.pdf
rename to guides/v1.8/images/Magento_MVC.pdf
diff --git a/guides/m1x/images/NumberOfVisitors.png b/guides/v1.8/images/NumberOfVisitors.png
similarity index 100%
rename from guides/m1x/images/NumberOfVisitors.png
rename to guides/v1.8/images/NumberOfVisitors.png
diff --git a/guides/m1x/images/RWD_icon_sprite.psd b/guides/v1.8/images/RWD_icon_sprite.psd
similarity index 100%
rename from guides/m1x/images/RWD_icon_sprite.psd
rename to guides/v1.8/images/RWD_icon_sprite.psd
diff --git a/guides/m1x/images/RWD_social_icons.psd b/guides/v1.8/images/RWD_social_icons.psd
similarity index 100%
rename from guides/m1x/images/RWD_social_icons.psd
rename to guides/v1.8/images/RWD_social_icons.psd
diff --git a/guides/m1x/images/admin-panel-custom-theme.png b/guides/v1.8/images/admin-panel-custom-theme.png
similarity index 100%
rename from guides/m1x/images/admin-panel-custom-theme.png
rename to guides/v1.8/images/admin-panel-custom-theme.png
diff --git a/guides/m1x/images/appsec-900_confirm.png b/guides/v1.8/images/appsec-900_confirm.png
similarity index 100%
rename from guides/m1x/images/appsec-900_confirm.png
rename to guides/v1.8/images/appsec-900_confirm.png
diff --git a/guides/m1x/images/blend-toc.png b/guides/v1.8/images/blend-toc.png
similarity index 100%
rename from guides/m1x/images/blend-toc.png
rename to guides/v1.8/images/blend-toc.png
diff --git a/guides/m1x/images/custom-theme-dir-structure.png b/guides/v1.8/images/custom-theme-dir-structure.png
similarity index 100%
rename from guides/m1x/images/custom-theme-dir-structure.png
rename to guides/v1.8/images/custom-theme-dir-structure.png
diff --git a/guides/m1x/images/custom-theme-dir-structure_image.ai b/guides/v1.8/images/custom-theme-dir-structure_image.ai
similarity index 100%
rename from guides/m1x/images/custom-theme-dir-structure_image.ai
rename to guides/v1.8/images/custom-theme-dir-structure_image.ai
diff --git a/guides/m1x/images/custom-theme-dir-structure_image.png b/guides/v1.8/images/custom-theme-dir-structure_image.png
similarity index 100%
rename from guides/m1x/images/custom-theme-dir-structure_image.png
rename to guides/v1.8/images/custom-theme-dir-structure_image.png
diff --git a/guides/m1x/images/custom_skin-dir.png b/guides/v1.8/images/custom_skin-dir.png
similarity index 100%
rename from guides/m1x/images/custom_skin-dir.png
rename to guides/v1.8/images/custom_skin-dir.png
diff --git a/guides/m1x/images/disable-cache-confirm.png b/guides/v1.8/images/disable-cache-confirm.png
similarity index 100%
rename from guides/m1x/images/disable-cache-confirm.png
rename to guides/v1.8/images/disable-cache-confirm.png
diff --git a/guides/m1x/images/disable-cache.png b/guides/v1.8/images/disable-cache.png
similarity index 100%
rename from guides/m1x/images/disable-cache.png
rename to guides/v1.8/images/disable-cache.png
diff --git a/guides/m1x/images/ht_magento-REST-API_add_new_rest_role.png b/guides/v1.8/images/ht_magento-REST-API_add_new_rest_role.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_add_new_rest_role.png
rename to guides/v1.8/images/ht_magento-REST-API_add_new_rest_role.png
diff --git a/guides/m1x/images/ht_magento-REST-API_cache_management.png b/guides/v1.8/images/ht_magento-REST-API_cache_management.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_cache_management.png
rename to guides/v1.8/images/ht_magento-REST-API_cache_management.png
diff --git a/guides/m1x/images/ht_magento-REST-API_dir-structure.png b/guides/v1.8/images/ht_magento-REST-API_dir-structure.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_dir-structure.png
rename to guides/v1.8/images/ht_magento-REST-API_dir-structure.png
diff --git a/guides/m1x/images/ht_magento-REST-API_disable-cache-magement.png b/guides/v1.8/images/ht_magento-REST-API_disable-cache-magement.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_disable-cache-magement.png
rename to guides/v1.8/images/ht_magento-REST-API_disable-cache-magement.png
diff --git a/guides/m1x/images/ht_magento-REST-API_disable-cache-magementMock.ai b/guides/v1.8/images/ht_magento-REST-API_disable-cache-magementMock.ai
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_disable-cache-magementMock.ai
rename to guides/v1.8/images/ht_magento-REST-API_disable-cache-magementMock.ai
diff --git a/guides/m1x/images/ht_magento-REST-API_edit_rest_role_api_resources.png b/guides/v1.8/images/ht_magento-REST-API_edit_rest_role_api_resources.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_edit_rest_role_api_resources.png
rename to guides/v1.8/images/ht_magento-REST-API_edit_rest_role_api_resources.png
diff --git a/guides/m1x/images/ht_magento-REST-API_edit_rest_role_users.png b/guides/v1.8/images/ht_magento-REST-API_edit_rest_role_users.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_edit_rest_role_users.png
rename to guides/v1.8/images/ht_magento-REST-API_edit_rest_role_users.png
diff --git a/guides/m1x/images/ht_magento-REST-API_manage_coupon_codes.png b/guides/v1.8/images/ht_magento-REST-API_manage_coupon_codes.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_manage_coupon_codes.png
rename to guides/v1.8/images/ht_magento-REST-API_manage_coupon_codes.png
diff --git a/guides/m1x/images/ht_magento-REST-API_new-coupon-codes.png b/guides/v1.8/images/ht_magento-REST-API_new-coupon-codes.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_new-coupon-codes.png
rename to guides/v1.8/images/ht_magento-REST-API_new-coupon-codes.png
diff --git a/guides/m1x/images/ht_magento-REST-API_new_oauth_consumer.png b/guides/v1.8/images/ht_magento-REST-API_new_oauth_consumer.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_new_oauth_consumer.png
rename to guides/v1.8/images/ht_magento-REST-API_new_oauth_consumer.png
diff --git a/guides/m1x/images/ht_magento-REST-API_oauth-request-access.png b/guides/v1.8/images/ht_magento-REST-API_oauth-request-access.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_oauth-request-access.png
rename to guides/v1.8/images/ht_magento-REST-API_oauth-request-access.png
diff --git a/guides/m1x/images/ht_magento-REST-API_phpinfo-oauth.png b/guides/v1.8/images/ht_magento-REST-API_phpinfo-oauth.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_phpinfo-oauth.png
rename to guides/v1.8/images/ht_magento-REST-API_phpinfo-oauth.png
diff --git a/guides/m1x/images/ht_magento-REST-API_rest-api-attributes.png b/guides/v1.8/images/ht_magento-REST-API_rest-api-attributes.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_rest-api-attributes.png
rename to guides/v1.8/images/ht_magento-REST-API_rest-api-attributes.png
diff --git a/guides/m1x/images/ht_magento-REST-API_rest_rule_actions.png b/guides/v1.8/images/ht_magento-REST-API_rest_rule_actions.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_rest_rule_actions.png
rename to guides/v1.8/images/ht_magento-REST-API_rest_rule_actions.png
diff --git a/guides/m1x/images/ht_magento-REST-API_rest_rule_info.png b/guides/v1.8/images/ht_magento-REST-API_rest_rule_info.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_rest_rule_info.png
rename to guides/v1.8/images/ht_magento-REST-API_rest_rule_info.png
diff --git a/guides/m1x/images/ht_magento-REST-API_shopping_cart_price_rule.png b/guides/v1.8/images/ht_magento-REST-API_shopping_cart_price_rule.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_shopping_cart_price_rule.png
rename to guides/v1.8/images/ht_magento-REST-API_shopping_cart_price_rule.png
diff --git a/guides/m1x/images/ht_magento-REST-API_verify_view-coupon-codes.png b/guides/v1.8/images/ht_magento-REST-API_verify_view-coupon-codes.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_verify_view-coupon-codes.png
rename to guides/v1.8/images/ht_magento-REST-API_verify_view-coupon-codes.png
diff --git a/guides/m1x/images/ht_magento-REST-API_verify_view-coupon-codesMock.ai b/guides/v1.8/images/ht_magento-REST-API_verify_view-coupon-codesMock.ai
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_verify_view-coupon-codesMock.ai
rename to guides/v1.8/images/ht_magento-REST-API_verify_view-coupon-codesMock.ai
diff --git a/guides/m1x/images/ht_magento-REST-API_verify_view-coupon-codesMock.png b/guides/v1.8/images/ht_magento-REST-API_verify_view-coupon-codesMock.png
similarity index 100%
rename from guides/m1x/images/ht_magento-REST-API_verify_view-coupon-codesMock.png
rename to guides/v1.8/images/ht_magento-REST-API_verify_view-coupon-codesMock.png
diff --git a/guides/m1x/images/ht_magento-solr_catalog-search.png b/guides/v1.8/images/ht_magento-solr_catalog-search.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_catalog-search.png
rename to guides/v1.8/images/ht_magento-solr_catalog-search.png
diff --git a/guides/m1x/images/ht_magento-solr_catalog-searchMock.png b/guides/v1.8/images/ht_magento-solr_catalog-searchMock.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_catalog-searchMock.png
rename to guides/v1.8/images/ht_magento-solr_catalog-searchMock.png
diff --git a/guides/m1x/images/ht_magento-solr_catalog-searchMock.png.ai b/guides/v1.8/images/ht_magento-solr_catalog-searchMock.png.ai
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_catalog-searchMock.png.ai
rename to guides/v1.8/images/ht_magento-solr_catalog-searchMock.png.ai
diff --git a/guides/m1x/images/ht_magento-solr_default-search1.png b/guides/v1.8/images/ht_magento-solr_default-search1.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_default-search1.png
rename to guides/v1.8/images/ht_magento-solr_default-search1.png
diff --git a/guides/m1x/images/ht_magento-solr_refresh-fpc.png b/guides/v1.8/images/ht_magento-solr_refresh-fpc.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_refresh-fpc.png
rename to guides/v1.8/images/ht_magento-solr_refresh-fpc.png
diff --git a/guides/m1x/images/ht_magento-solr_reindex_catalog.png b/guides/v1.8/images/ht_magento-solr_reindex_catalog.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_reindex_catalog.png
rename to guides/v1.8/images/ht_magento-solr_reindex_catalog.png
diff --git a/guides/m1x/images/ht_magento-solr_solr-search1.png b/guides/v1.8/images/ht_magento-solr_solr-search1.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_solr-search1.png
rename to guides/v1.8/images/ht_magento-solr_solr-search1.png
diff --git a/guides/m1x/images/ht_magento-solr_solr-search2.png b/guides/v1.8/images/ht_magento-solr_solr-search2.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_solr-search2.png
rename to guides/v1.8/images/ht_magento-solr_solr-search2.png
diff --git a/guides/m1x/images/ht_magento-solr_test-connect_fail.png b/guides/v1.8/images/ht_magento-solr_test-connect_fail.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_test-connect_fail.png
rename to guides/v1.8/images/ht_magento-solr_test-connect_fail.png
diff --git a/guides/m1x/images/ht_magento-solr_test-connect_succeed.png b/guides/v1.8/images/ht_magento-solr_test-connect_succeed.png
similarity index 100%
rename from guides/m1x/images/ht_magento-solr_test-connect_succeed.png
rename to guides/v1.8/images/ht_magento-solr_test-connect_succeed.png
diff --git a/guides/m1x/images/icon-caution.png b/guides/v1.8/images/icon-caution.png
similarity index 100%
rename from guides/m1x/images/icon-caution.png
rename to guides/v1.8/images/icon-caution.png
diff --git a/guides/m1x/images/icon-important.png b/guides/v1.8/images/icon-important.png
similarity index 100%
rename from guides/m1x/images/icon-important.png
rename to guides/v1.8/images/icon-important.png
diff --git a/guides/m1x/images/icon-note.png b/guides/v1.8/images/icon-note.png
similarity index 100%
rename from guides/m1x/images/icon-note.png
rename to guides/v1.8/images/icon-note.png
diff --git a/guides/m1x/images/icon-tip.png b/guides/v1.8/images/icon-tip.png
similarity index 100%
rename from guides/m1x/images/icon-tip.png
rename to guides/v1.8/images/icon-tip.png
diff --git a/guides/m1x/images/index-management_product-url-key-attrib.png b/guides/v1.8/images/index-management_product-url-key-attrib.png
similarity index 100%
rename from guides/m1x/images/index-management_product-url-key-attrib.png
rename to guides/v1.8/images/index-management_product-url-key-attrib.png
diff --git a/guides/m1x/images/install_configuration_database.png b/guides/v1.8/images/install_configuration_database.png
similarity index 100%
rename from guides/m1x/images/install_configuration_database.png
rename to guides/v1.8/images/install_configuration_database.png
diff --git a/guides/m1x/images/install_confirm.png b/guides/v1.8/images/install_confirm.png
similarity index 100%
rename from guides/m1x/images/install_confirm.png
rename to guides/v1.8/images/install_confirm.png
diff --git a/guides/m1x/images/install_confirm_mock.ai b/guides/v1.8/images/install_confirm_mock.ai
similarity index 100%
rename from guides/m1x/images/install_confirm_mock.ai
rename to guides/v1.8/images/install_confirm_mock.ai
diff --git a/guides/m1x/images/install_confirm_mock.png b/guides/v1.8/images/install_confirm_mock.png
similarity index 100%
rename from guides/m1x/images/install_confirm_mock.png
rename to guides/v1.8/images/install_confirm_mock.png
diff --git a/guides/m1x/images/install_create-admin-account.png b/guides/v1.8/images/install_create-admin-account.png
similarity index 100%
rename from guides/m1x/images/install_create-admin-account.png
rename to guides/v1.8/images/install_create-admin-account.png
diff --git a/guides/m1x/images/install_first-page.png b/guides/v1.8/images/install_first-page.png
similarity index 100%
rename from guides/m1x/images/install_first-page.png
rename to guides/v1.8/images/install_first-page.png
diff --git a/guides/m1x/images/install_localization.png b/guides/v1.8/images/install_localization.png
similarity index 100%
rename from guides/m1x/images/install_localization.png
rename to guides/v1.8/images/install_localization.png
diff --git a/guides/m1x/images/install_myphpadmin_change.png b/guides/v1.8/images/install_myphpadmin_change.png
similarity index 100%
rename from guides/m1x/images/install_myphpadmin_change.png
rename to guides/v1.8/images/install_myphpadmin_change.png
diff --git a/guides/m1x/images/install_myphpadmin_edit-icon.png b/guides/v1.8/images/install_myphpadmin_edit-icon.png
similarity index 100%
rename from guides/m1x/images/install_myphpadmin_edit-icon.png
rename to guides/v1.8/images/install_myphpadmin_edit-icon.png
diff --git a/guides/m1x/images/install_myphpadmin_edit.png b/guides/v1.8/images/install_myphpadmin_edit.png
similarity index 100%
rename from guides/m1x/images/install_myphpadmin_edit.png
rename to guides/v1.8/images/install_myphpadmin_edit.png
diff --git a/guides/m1x/images/install_myphpadmin_results.png b/guides/v1.8/images/install_myphpadmin_results.png
similarity index 100%
rename from guides/m1x/images/install_myphpadmin_results.png
rename to guides/v1.8/images/install_myphpadmin_results.png
diff --git a/guides/m1x/images/install_myphpadmin_search.png b/guides/v1.8/images/install_myphpadmin_search.png
similarity index 100%
rename from guides/m1x/images/install_myphpadmin_search.png
rename to guides/v1.8/images/install_myphpadmin_search.png
diff --git a/guides/m1x/images/install_session-storage.png b/guides/v1.8/images/install_session-storage.png
similarity index 100%
rename from guides/m1x/images/install_session-storage.png
rename to guides/v1.8/images/install_session-storage.png
diff --git a/guides/m1x/images/install_verify-version.png b/guides/v1.8/images/install_verify-version.png
similarity index 100%
rename from guides/m1x/images/install_verify-version.png
rename to guides/v1.8/images/install_verify-version.png
diff --git a/guides/m1x/images/install_verify-version_mock.ai b/guides/v1.8/images/install_verify-version_mock.ai
similarity index 100%
rename from guides/m1x/images/install_verify-version_mock.ai
rename to guides/v1.8/images/install_verify-version_mock.ai
diff --git a/guides/m1x/images/install_verify-version_mock.png b/guides/v1.8/images/install_verify-version_mock.png
similarity index 100%
rename from guides/m1x/images/install_verify-version_mock.png
rename to guides/v1.8/images/install_verify-version_mock.png
diff --git a/guides/m1x/images/install_web-access-options.png b/guides/v1.8/images/install_web-access-options.png
similarity index 100%
rename from guides/m1x/images/install_web-access-options.png
rename to guides/v1.8/images/install_web-access-options.png
diff --git a/guides/m1x/images/new.png b/guides/v1.8/images/new.png
similarity index 100%
rename from guides/m1x/images/new.png
rename to guides/v1.8/images/new.png
diff --git a/guides/m1x/images/permissions2.png b/guides/v1.8/images/permissions2.png
similarity index 100%
rename from guides/m1x/images/permissions2.png
rename to guides/v1.8/images/permissions2.png
diff --git a/guides/m1x/images/resp_email_header-template.png b/guides/v1.8/images/resp_email_header-template.png
similarity index 100%
rename from guides/m1x/images/resp_email_header-template.png
rename to guides/v1.8/images/resp_email_header-template.png
diff --git a/guides/m1x/images/resp_email_logo.png b/guides/v1.8/images/resp_email_logo.png
similarity index 100%
rename from guides/m1x/images/resp_email_logo.png
rename to guides/v1.8/images/resp_email_logo.png
diff --git a/guides/m1x/images/resp_email_template_scope.png b/guides/v1.8/images/resp_email_template_scope.png
similarity index 100%
rename from guides/m1x/images/resp_email_template_scope.png
rename to guides/v1.8/images/resp_email_template_scope.png
diff --git a/guides/m1x/images/resp_email_using-header.png b/guides/v1.8/images/resp_email_using-header.png
similarity index 100%
rename from guides/m1x/images/resp_email_using-header.png
rename to guides/v1.8/images/resp_email_using-header.png
diff --git a/guides/m1x/images/rest-intro1.png b/guides/v1.8/images/rest-intro1.png
similarity index 100%
rename from guides/m1x/images/rest-intro1.png
rename to guides/v1.8/images/rest-intro1.png
diff --git a/guides/m1x/images/rest_attributes-conf.png b/guides/v1.8/images/rest_attributes-conf.png
similarity index 100%
rename from guides/m1x/images/rest_attributes-conf.png
rename to guides/v1.8/images/rest_attributes-conf.png
diff --git a/guides/m1x/images/rest_oauth-config2.png b/guides/v1.8/images/rest_oauth-config2.png
similarity index 100%
rename from guides/m1x/images/rest_oauth-config2.png
rename to guides/v1.8/images/rest_oauth-config2.png
diff --git a/guides/m1x/images/rest_oauth-config3.png b/guides/v1.8/images/rest_oauth-config3.png
similarity index 100%
rename from guides/m1x/images/rest_oauth-config3.png
rename to guides/v1.8/images/rest_oauth-config3.png
diff --git a/guides/m1x/images/rest_oauth-config4.png b/guides/v1.8/images/rest_oauth-config4.png
similarity index 100%
rename from guides/m1x/images/rest_oauth-config4.png
rename to guides/v1.8/images/rest_oauth-config4.png
diff --git a/guides/m1x/images/rest_oauth1.png b/guides/v1.8/images/rest_oauth1.png
similarity index 100%
rename from guides/m1x/images/rest_oauth1.png
rename to guides/v1.8/images/rest_oauth1.png
diff --git a/guides/m1x/images/rest_oauth2.png b/guides/v1.8/images/rest_oauth2.png
similarity index 100%
rename from guides/m1x/images/rest_oauth2.png
rename to guides/v1.8/images/rest_oauth2.png
diff --git a/guides/m1x/images/rest_oauth_config1.png b/guides/v1.8/images/rest_oauth_config1.png
similarity index 100%
rename from guides/m1x/images/rest_oauth_config1.png
rename to guides/v1.8/images/rest_oauth_config1.png
diff --git a/guides/m1x/images/rest_permissions1.png b/guides/v1.8/images/rest_permissions1.png
similarity index 100%
rename from guides/m1x/images/rest_permissions1.png
rename to guides/v1.8/images/rest_permissions1.png
diff --git a/guides/m1x/images/rest_permissions2.png b/guides/v1.8/images/rest_permissions2.png
similarity index 100%
rename from guides/m1x/images/rest_permissions2.png
rename to guides/v1.8/images/rest_permissions2.png
diff --git a/guides/m1x/images/rest_roles-conf.png b/guides/v1.8/images/rest_roles-conf.png
similarity index 100%
rename from guides/m1x/images/rest_roles-conf.png
rename to guides/v1.8/images/rest_roles-conf.png
diff --git a/guides/m1x/images/rest_test1.png b/guides/v1.8/images/rest_test1.png
similarity index 100%
rename from guides/m1x/images/rest_test1.png
rename to guides/v1.8/images/rest_test1.png
diff --git a/guides/m1x/images/rest_test10.png b/guides/v1.8/images/rest_test10.png
similarity index 100%
rename from guides/m1x/images/rest_test10.png
rename to guides/v1.8/images/rest_test10.png
diff --git a/guides/m1x/images/rest_test11.png b/guides/v1.8/images/rest_test11.png
similarity index 100%
rename from guides/m1x/images/rest_test11.png
rename to guides/v1.8/images/rest_test11.png
diff --git a/guides/m1x/images/rest_test12.png b/guides/v1.8/images/rest_test12.png
similarity index 100%
rename from guides/m1x/images/rest_test12.png
rename to guides/v1.8/images/rest_test12.png
diff --git a/guides/m1x/images/rest_test3.png b/guides/v1.8/images/rest_test3.png
similarity index 100%
rename from guides/m1x/images/rest_test3.png
rename to guides/v1.8/images/rest_test3.png
diff --git a/guides/m1x/images/rest_test4.png b/guides/v1.8/images/rest_test4.png
similarity index 100%
rename from guides/m1x/images/rest_test4.png
rename to guides/v1.8/images/rest_test4.png
diff --git a/guides/m1x/images/rest_test5.png b/guides/v1.8/images/rest_test5.png
similarity index 100%
rename from guides/m1x/images/rest_test5.png
rename to guides/v1.8/images/rest_test5.png
diff --git a/guides/m1x/images/rest_test6.png b/guides/v1.8/images/rest_test6.png
similarity index 100%
rename from guides/m1x/images/rest_test6.png
rename to guides/v1.8/images/rest_test6.png
diff --git a/guides/m1x/images/rest_test7.png b/guides/v1.8/images/rest_test7.png
similarity index 100%
rename from guides/m1x/images/rest_test7.png
rename to guides/v1.8/images/rest_test7.png
diff --git a/guides/m1x/images/rest_test8.png b/guides/v1.8/images/rest_test8.png
similarity index 100%
rename from guides/m1x/images/rest_test8.png
rename to guides/v1.8/images/rest_test8.png
diff --git a/guides/m1x/images/rest_test9.png b/guides/v1.8/images/rest_test9.png
similarity index 100%
rename from guides/m1x/images/rest_test9.png
rename to guides/v1.8/images/rest_test9.png
diff --git a/guides/m1x/images/rest_test_authheader.png b/guides/v1.8/images/rest_test_authheader.png
similarity index 100%
rename from guides/m1x/images/rest_test_authheader.png
rename to guides/v1.8/images/rest_test_authheader.png
diff --git a/guides/m1x/images/rest_test_insert.png b/guides/v1.8/images/rest_test_insert.png
similarity index 100%
rename from guides/m1x/images/rest_test_insert.png
rename to guides/v1.8/images/rest_test_insert.png
diff --git a/guides/m1x/images/rest_test_oauth_tab.png b/guides/v1.8/images/rest_test_oauth_tab.png
similarity index 100%
rename from guides/m1x/images/rest_test_oauth_tab.png
rename to guides/v1.8/images/rest_test_oauth_tab.png
diff --git a/guides/m1x/images/soap_wsdl-wsi.png b/guides/v1.8/images/soap_wsdl-wsi.png
similarity index 100%
rename from guides/m1x/images/soap_wsdl-wsi.png
rename to guides/v1.8/images/soap_wsdl-wsi.png
diff --git a/guides/m1x/images/soap_wsdl.png b/guides/v1.8/images/soap_wsdl.png
similarity index 100%
rename from guides/m1x/images/soap_wsdl.png
rename to guides/v1.8/images/soap_wsdl.png
diff --git a/guides/m1x/images/soap_wsi-config.png b/guides/v1.8/images/soap_wsi-config.png
similarity index 100%
rename from guides/m1x/images/soap_wsi-config.png
rename to guides/v1.8/images/soap_wsi-config.png
diff --git a/guides/m1x/images/upgrade_index-management.png b/guides/v1.8/images/upgrade_index-management.png
similarity index 100%
rename from guides/m1x/images/upgrade_index-management.png
rename to guides/v1.8/images/upgrade_index-management.png
diff --git a/guides/m1x/images/upgrade_index-management2.png b/guides/v1.8/images/upgrade_index-management2.png
similarity index 100%
rename from guides/m1x/images/upgrade_index-management2.png
rename to guides/v1.8/images/upgrade_index-management2.png
diff --git a/guides/m1x/images/upgrade_index-management_after.png b/guides/v1.8/images/upgrade_index-management_after.png
similarity index 100%
rename from guides/m1x/images/upgrade_index-management_after.png
rename to guides/v1.8/images/upgrade_index-management_after.png
diff --git a/guides/m1x/images/upgrade_index-management_when-scheduled.png b/guides/v1.8/images/upgrade_index-management_when-scheduled.png
similarity index 100%
rename from guides/m1x/images/upgrade_index-management_when-scheduled.png
rename to guides/v1.8/images/upgrade_index-management_when-scheduled.png
diff --git a/guides/m1x/images/upgrade_log.png b/guides/v1.8/images/upgrade_log.png
similarity index 100%
rename from guides/m1x/images/upgrade_log.png
rename to guides/v1.8/images/upgrade_log.png
diff --git a/guides/m1x/images/upgrade_url-redirects.png b/guides/v1.8/images/upgrade_url-redirects.png
similarity index 100%
rename from guides/m1x/images/upgrade_url-redirects.png
rename to guides/v1.8/images/upgrade_url-redirects.png
diff --git a/guides/m1x/images/m1xheader.png b/guides/v1.8/images/v1xheader.png
similarity index 100%
rename from guides/m1x/images/m1xheader.png
rename to guides/v1.8/images/v1xheader.png
diff --git a/guides/v1.8/index.html b/guides/v1.8/index.html
new file mode 100644
index 0000000000..95ffb624ff
--- /dev/null
+++ b/guides/v1.8/index.html
@@ -0,0 +1,44 @@
+---
+layout: v1x
+title: Openmage 1.9.x Reference
+---
+
+
Welcome to the home page for Magento 1.9.x documentation for installation, configuration, developers, patches, and more. Here you'll find articles that were formerly located on http://magentocommerce.com/knowledge-base.
+
For information you don't find here—including Release Notes—see the User Guide page.
In a continuing effort to improve security and ease of use, Magento is updating its recommendations for file system permissions and ownership for the following Magento editions:
+
Magento Enterprise Edition (EE) versions 1.9 and later
+
Magento Community Edition (CE) versions 1.4 and later
+
This article discusses recommended permission and ownership schemes to apply after you install Magento.
+
The guidelines discussed in this article apply to:
+
New installations of or upgrades to the previously listed Magento versions only.
+ The instructions might not work with older versions. If you have already installed Magento, you can optionally change your file system permissions and ownership as discussed in this article.
This article discusses the following permission and ownership schemes:
+
+
Post-installation for both a hosted Magento server and for a dedicated Magento server (in other words, you have root access on the server).
+
Securing extensions, recommended ownership and privilege settings to apply after you install Magento extensions.
+ Typically, Magento extensions install with 777 (world-writable) privileges, which is undesirable from a security point of view.
+
+
Important: This topic contains suggestions based on our experience. They are not requirements because we don't know the details of your deployment. Consult your hosting provider, a qualified security specialist, or an experienced system administrator for advice about specific security settings.
+
+
Terminology
+
This article uses the following terminology:
+
+
Hosted system
+
A Magento server located on a hosting provider. A hosted system typically does not enable you to elevate to root. The web server typically runs as an ordinary user. Magento assumes you log in as this user to start and stop the web server and that you already own all the files and directories in the Magento installation directory. You can use chmod to change permissions on files and directories.
+
Dedicated system
+
A Magento server you control and operate. Unlike a hosted system, you can elevate to root and, as root, you can use the chown and chmod commands to set ownership and privileges in the Magento installation directory.
+
+
+
Setting Privileges and Ownership After You Install Magento
+
If you have installed Magento, you can set file system privileges and ownership as follows:
+
For a dedicated Magento server, you set ownership of files and directory as the web server user. You set privileges as 500 (directories) and 400 (files).
+
For a hosted Magento server on which the web server runs as the logged-in username, you set privileges as 500 (directories) and 400 (files).
+
Note: In both hosted and dedicated systems, you set the privileges for the media/ and var/ directories at 700/600 because they must be writable.
+
+
Following is an explanation of the privileges:
+
500 permissions for directories (dr-x------) gives the web server user read and execute privileges to prevent the accidental deletion or modification of files in the directory. Other users have no access to Magento directories.
+
400 permissions for files (-r--------) prevent any user (even the web server user) from overwriting files.
+ This prevents attacks that depend on overwriting existing files with malicious content.
+
700 permissions (drwx------) for the media/ and var/ directories give full control (that is, read/write/execute) to the owner and no permissions to anyone else.
+
600 permissions (-rw-------) for files in the media/ and var/ directories enable the web server user to write to them and to overwrite them.
+
Note: On a dedicated system, all commands discussed in this article must be entered as a user with root privileges. On a hosted system, commands must be entered as the web server user.
+
+
To set up ownership and permissions on a dedicated Magento server:
+
Dedicated Magento server only. As a user with root privileges, find the web server user:
+
Apache:
+
Ubuntu: grep User /etc/apache2/apache2.conf
+
CentOS: grep User /etc/httpd/conf/httpd.conf
+
Note: The preceding paths are samples only. The paths to these .conf files on your system might be different. You can use the command whereis nginx to find the location of the configuration files.
+
+ Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
+
nginx: Open the nginx configuration file, typically /etc/nginx/nginx.conf. The user directive specifies the username. It might run as the Apache user if Apache is installed on the same system.
+
+
+
Change to the Magento installation directory.
+ On CentOS, this is typically /var/www/html/magento. On Ubuntu, it is typically /var/www/magento.
+
Dedicated Magento server only. As a user with root privileges, enter the following command to set ownership of the Magento installation directory and all its subdirectories:
+
chown -R web-server-user-name .
+ For example, on Ubuntu where Apache usually runs as www-data, enter
+
chown -R www-data .
+
Enter the following commands to set permissions:
+
find . -type f -exec chmod 400 {} +
+find . -type d -exec chmod 500 {} +
+find var/ -type f -exec chmod 600 {} +
+find media/ -type f -exec chmod 600 {} +
+find var/ -type d -exec chmod 700 {} +
+find media/ -type d -exec chmod 700 {} +
+chmod 700 includes
+chmod 600 includes/config.php
+
+
Securing Magento Extensions
+
If you set permissions and ownership as discussed in this article, you must change permissions temporarily to be able to use the Magento Connect Manager in the Admin Panel. (System > Magento Connect > Magento Connect Manager). You can still install extensions manually, however; that is beyond the scope of this article.
+
You can confirm the issue when you access Magento Connect Manager in the Admin Panel. The following error displays on the Extensions tab page:
+
Warning: Your Magento folder does not have sufficient write permissions.
+
To use Magento Connect Manager, you must:
+
Temporarily set 700/600 permissions on your Magento installation directory and subdirectories.
+
Install the extension.
+ Magento Connect Manager typically installs extensions with 777 (world-writable) permissions.
+
Set permissions back to their recommended values.
+
In addition, if you have a dedicated Magento server, you should check ownership of files and directories and reset them if necessary. Often, Magento Connect Manager installs extensions with user and group ownership both set to the web server user.
+
+
Temporarily Resetting Permissions on Your Magento Installation Directory
+
To temporarily set file and directory permissions so you can use Magento Connect Manager:
+
Change to the Magento installation directory.
+ On CentOS, this is typically /var/www/html/magento. On Ubuntu, it is typically /var/www/magento.
+
Enter the following commands:
+
find . -type d -exec chmod 700 {} +
+find . -type f -exec chmod 600 {} +
+
Install your extension using the Magento Connect Manager.
+
+
Restoring the Recommended Permissions
+
Enter the commands discussed in this section to return permissions and ownership to their recommended values after you have installed extensions.
+
To restore Magento installation directory permissions:
+
Change to the Magento installation directory.
+ On CentOS, this is typically /var/www/html/magento. On Ubuntu, it is typically /var/www/magento.
+
Dedicated Magento server only. As a user with root privileges, enter the following command to set ownership of the Magento installation directory and all its subdirectories:
+
chown -R web-server-user-name .
+ For example, on Ubuntu where Apache usually runs as www-data, enter
+
chown -R www-data .
+
Enter the following commands to set permissions:
+
find . -type f -exec chmod 400 {} +
+find . -type d -exec chmod 500 {} +
+find var/ -type f -exec chmod 600 {} +
+find media/ -type f -exec chmod 600 {} +
+find var/ -type d -exec chmod 700 {} +
+find media/ -type d -exec chmod 700 {} +
+
+
Applying Magento Support Patches
+
Magento Support typically provides a shell script to patch various Magento issues. When you run the shell script, file and directory permissions are typically not changed; however, the files provided with the patch are owned by the user who applied the patch. If you have a dedicated Magento server, this is typically root; therefore, after applying the patch, you must change file ownership.
+
If you are required to apply a patch provided by Magento Support, use the following process:
+
Get the patch from Magento Support.
+
Follow the instructions provided with the patch.
+ Typically, you run a shell script as either a user with root privileges or as the owner of the Magento installation directory.
+
If you ran the patch as the owner of the Magento installation directory, you're done. File permissions aren't usually changed; however, you should check and reapply file and directory privileges if necessary.
+
If you ran the patch as a user with root privileges, use the following steps to reset file ownership:
+
Dedicated Magento server only. Find the web server user:
+
Apache:
+
Ubuntu: grep User /etc/apache2/apache2.conf
+
CentOS: grep User /etc/httpd/conf/httpd.conf
+
+ Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
+
nginx: Open the nginx configuration file, typically /etc/nginx/nginx.conf. The user directive specifies the username. It might run as the Apache user if Apache is installed on the same system.
+
+
As a user with root privileges, enter the following command from the Magento installation directory:
+ chown -R web-server-user-name .
+ For example, on Ubuntu where Apache usually runs as www-data, enter
+ chown -R www-data .
+
+
For More Information
+
For more information about UNIX permissions, see the following resources:
In a continuing effort to improve security and ease of use, Magento is updating its recommendations for file
+ system permissions and ownership for the following Magento editions:
+
+
Magento Enterprise Edition (EE) versions 1.9 and later
+
Magento Community Edition (CE) versions 1.4 and later
+
+
The guidelines discussed in this article apply to:
Important: This topic contains suggestions based on our experience. They are not requirements because we don't know the details of your deployment. Consult your hosting provider, a qualified security specialist, or an experienced system administrator for advice about specific security settings.
+
+
+
Terminology
+
This article uses the following terminology:
+
+
Hosted system
+
A Magento server located on a hosting provider. A hosted system typically does not enable you to
+ elevate to root. The web server typically runs as an ordinary user. Magento assumes you log in as
+ this user to start and stop the web server and that you already own all the files and directories in the
+ Magento installation directory. You can use chmod to change permissions on files and directories.
+
+
Dedicated system
+
A Magento server you control and operate. Unlike a hosted system, you can elevate to root and, as
+ root, you can use the chown and chmod commands to set ownership and privileges in
+ the Magento installation directory.
+
+
+
+
+
Recommended Privileges and Ownership Before You Install Magento
+
This section discusses Magento's pre-installation recommended privilege and ownership settings, which are as
+ follows:
+
+
The Magento installation directory and all subdirectories are owned by the web server user.
+ This enables the web server to change files in these subdirectories but other users cannot access them
+ (except a higher-level user such as root).
+
+
All directories have 700 permissions (drwx------).
+ 700 permissions give full control (that is, read/write/execute) to the owner and no permissions to anyone
+ else.
+
+
All files have 600 permissions (-rw-------).
+ 600 permissions mean the owner can read and write but other users have no permissions.
+
+
If you use PHP-FPM (FastCGI Process Manager), make sure it is configured to run the same user as the Apache
+ web server (Nginx web server).
+ This allows web server to access content generated by Magento (Uploaded files, images, etc.).
+
+
+
Note: On a dedicated system, all commands discussed in this article must be
+ entered as a user with root privileges.
+
After you extract the Magento installation package, set ownership and permissions as follows:
+
+
Dedicated Magento server only. Find the web server user:
+
+
Apache:
+
+
Ubuntu: grep User /etc/apache2/apache2.conf
+
CentOS: grep User /etc/httpd/conf/httpd.conf
+
Note: The preceding paths are samples only. The paths
+ to these .conf files on your system might be different. You can use the command
+ whereis nginx to find the location of the configuration files.
+
+
+
+ Typically, the Apache web server user on CentOS is apache and the Apache web server user on
+ Ubuntu is www-data.
+
+
nginx: Open the nginx configuration file, typically /etc/nginx/nginx.conf. The
+ user directive specifies the username. It might run as the Apache user if Apache is
+ installed on the same system.
+
+
+
+
Change to the Magento installation directory.
+
Dedicated Magento server only. Enter the following command to set ownership of the Magento
+ installation directory and all its subdirectories:
+
chown -R web-server-user-name .
+ For example, on Ubuntu where Apache usually runs as www-data, enter
+
chown -R www-data .
+
+
Enter the following commands to set directory permissions to 700 and file permissions to 600:
+
find . -type d -exec chmod 700 {} +
+find . -type f -exec chmod 600 {} +
+
+
+
+
For More Information
+
For more information about UNIX permissions, see the following resources:
Install prerequisite software (web server, PHP, and required PHP extensions).
+
Set up a MySQL Magento database instance.
+
Run the Magento installer to complete the installation.
+
Verify that Magento installed correctly.
+
Important: Perform all installations to Magento the latest version of CE 1.9 or Magento EE 1.14 to get the latest fixes, features, and security updates.
If you are setting up more than one web node with load balancing, set up and test that part of your system before you install Magento.
+
If your database server and web server are located on different hosts, get help before proceeding.
+
Make sure you can back up your entire system at various points during the installation so you can roll back in the event of issues.
+
Magento strongly recommends you observe the following guidelines when you set up your Magento database:
+
+
Magento for the first time uses MySQL database triggers to improve database access during reindexing. Magento does not support any custom triggers in the Magento database because custom triggers can introduce incompatibilities with future Magento versions.
If you use MySQL database replication, be aware that Magento does not support MySQL statement-based replication. Make sure you use only row-based replication.
+
More information, including software prerequisites, can be found in the next section.
+
+
Preparing Your Server for Magento CE or EE
+
The following sections discuss how to download and install prerequisite software and install Magento CE or EE on a system running:
+
+
Ubuntu 10 or later, or CentOS 6
+
Apache 2.x
+
nginx 1.7.x
+
PHP 5.4 and required extensions
+
MySQL database
+Notes:
+
Discussing how to configure Secure Sockets Layer (SSL) is beyond the scope of this guide. You can consult some general resources such as Apache, zytrax.com, or the OpenSSL documentation page.
Note: Unless otherwise noted, all tasks discussed in this article must be performed by a user with root privileges.
+
+
+
SELinux Prerequisite
+
Security Enhanced Linux (SELinux) enables CentOS and Ubuntu administrators greater access control over their servers. If you're using SELinux and Apache must initiate a connection to another host, you must run the commands discussed in this section.
+
If Apache and the database server are on the same host, you can skip this section and continue with Opening Ports In Your Firewall.
+
To enable Apache to initiate a connection to another host with SELinux enabled:
+
To determine if SELinux is enabled, use the following command:
+
getenforce
+Enforcing displays to confirm that SELinux is running.
+
Enter one of the following commands:
+
CentOS
+
setsebool -P httpd_can_network_connect=1
+
Ubuntu
+
setsebool -P apache2_can_network_connect=1
+
+
+
+
Opening Ports In Your Firewall
+
Depending on your security requirements, you might find it necessary to open port 80 and other ports in your firewall. Because of the sensitive nature of networking security, Magento strongly recommends you consult with your IT department before proceeding. Following are some suggested references:
This section discusses how to create or install the following:
+
Install and configure Network Time Protocol (NTP) which enables you to synchronize the system clock with pool servers located around the world. NTP is particularly useful for synchronizing the clocks of multiple hosts.
Installing and Configuring Network Time Protocol (NTP)
+
NTP enables servers to synchronize their system clocks using globally available pool servers. Magento recommends you use NTP servers you trust, whether they are dedicated hardware solutions your internal network or external, public servers.
+
If you are deploying Magento on multiple hosts, NTP is a simple way to guarantee their clocks are all synchronized, no matter what time zone the servers are in.
+
To install and configure NTP:
+
CentOS only.
+
Enter the following command to find the appropriate NTP software:
+yum search ntp
+
Select a package to install. For example, ntp.x86_64.
+
Install the package.
+yum -y install ntp.x86_64
+
+
Ubuntu only. Enter the following command to install NTP:
+apt-get install ntp
+
Select the NTP pool servers you wish to use.
+Selecting pool servers is up to you. If you use NTP pool servers, ntp.org recommends you use pool servers that are close to your servers' time zone as discussed on the NTP pool project help page. If you have a private NTP server that is available to all hosts in your Magento deployment, you can use that server instead.
+
Open /etc/ntp.conf in a text editor.
+
Look for lines similar to the following:
+
server 0.centos.pool.ntp.org
+server 1.centos.pool.ntp.org
+server 2.centos.pool.ntp.org
+
Replace those lines or add additional lines that specify your NTP pool server or other NTP servers. It's a good idea to specify more than one.
+An example of using three United States-based NTP servers follows:
+
server 0.us.pool.ntp.org
+server 1.us.pool.ntp.org
+server 2.us.pool.ntp.org
+
Save your changes to /etc/ntp.conf and exit the text editor.
+
CentOS only. Enter the following command so that NTP starts when the server starts.
+
chkconfig ntpd on
+
Restart the service.
+
CentOS
+
service ntpd restart
+
Ubuntu
+
service ntp restart
+
+
+
Enter the date command to check the server's date.
+If the date is incorrect, make sure the NTP client port (typically, UDP 123) is open in your firewall. Try the ntpdate pool-server-host-name command. If it fails, search for the error it returns.
+If all else fails, try restarting the server.
+
+
Creating phpinfo.php
+
phpinfo.php displays a large amount of information about PHP and its extensions. Add the following code anywhere in your web server's docroot:
+
<?php
+// Show all information, defaults to INFO_ALL
+phpinfo();
phpmyadmin is an easy-to-use, free database administration utility. You can use it to check and manipulate the contents of your database. You must log in to phpmyadmin as the MySQL database administrative user.
Download the epel RPM for the version of CentOS you're using. A sample follows.
+
cd /tmp
+wget http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm
+rpm -ivh epel-release-6-8.noarch.rpm
+
Install phpmyadmin as follows:
+
yum -y install phpmyadmin
+
Authorize access to phpmyadmin from your machine's IP address.
+
Open the following file for editing:
+
vim /etc/httpd/conf.d/phpMyAdmin.conf
+
Replace the following IP address with your IP address
+
#Require ip 127.0.0.1
+For example,
+
Require ip 192.51.100.101
+
Replace the following IP with your IP address
+
#Allow from 127.0.0.1
+For example,
+
Allow from 192.51.100.101
+
+
Save your changes to /etc/httpd/conf.d/phpMyAdmin.conf and exit the text editor.
+
Restart Apache.
+
service httpd restart
+
To use phpmyadmin, enter the following command in your browser's address or location field:
+
http://host-or-ip-address/phpmyadmin
+
When prompted, log in using your MySQL database root or administrative user's username and password.
+
To install phpmyadmin on Ubuntu:
+
Use the following command:
+apt-get install phpmyadmin
+
Follow the prompts on your screen to complete the installation.
+
To use phpmyadmin, enter the following URL in your browser's address or location field:
+http://host-or-ip-address/phpmyadmin
+
When prompted, log in using your MySQL database root or administrative user's username and password.
+
+
Creating a Magento Database Instance
+
This section discusses how to create a new database instance for Magento. Although a new database instance is recommended, you can optionally install Magento into an existing database instance. If you choose to do that, skip this section and continue with Installing Optional Sample Data.
+
Note: Before you continue, review the information about MySQL discussed in Prerequisites.
+
+
To create a new database instance:
+
Log in to your database server as any user.
+
Enter the following commands in the order shown to create a database instance named magento:
+
mysql -u root -p
+#Enter the remaining commands at the mysql> prompt.
+
+create database magento;
+GRANT ALL ON magento.* TO magento@localhost IDENTIFIED BY 'magento';
+
For MySQL versions between 5.0.2 and 5.1.6, you must enter this command:
+
GRANT SUPER ON *.* TO 'magento'@'localhost';
+
After you're done, enter exit
+
Test the database instance.
+
mysql -u magento -p
+Messages similar to the following display to confirm you successfully created the database instance. If errors display, repeat the preceding commands.
+
Welcome to the MySQL monitor. Commands end with ; or \g.
+Your MySQL connection id is 20
+Server version: 5.1.67 Source distribution
+
+Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
+
+Oracle is a registered trademark of Oracle Corporation and/or its
+affiliates. Other names may be trademarks of their respective
+owners.
+
+Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+
+
Extracting the Magento Installation Archive
+
Extract the Magento installation archive on your web server's docroot.
+
The path on Ubuntu is typically /var/www
+
The path on CentOS is typically /var/www/html
+
Examples follow:
+
Ubuntu
+
cd /var/www
+cp /path/magento-install-archive .
+tar -zxf magento-install-archive-name
+
CentOS
+
cd /var/www/html
+cp /path/magento-install-archive-name .
+tar -zxf magento-install-archive
+
To optionally install Magento sample data, continue with the next section.
Magento provides sample data you can optionally install to give you an idea of what products look like in the Admin Panel and in your web store. You can use this sample data to learn how Magento works and to experiment with custom themes.
+
You must install sample data on the file system and in the database before you install Magento.
+
Note: Only if your database is shared between more than one Magento installation. Database table names used by the sample data are not configurable. To use sample data with a new Magento installation, you must manually add a prefix to all sample data tables and use the same prefix when you install Magento.
If necessary, transfer the sample data to your Magento server.
+
On your Magento server, extract the sample data archive to a directory other than your Magento installation directory.
+
Make note of the path to the sample data's media subdirectory.
+
Change to the [your Magento install dir]/media directory.
+
#Ubuntu example
+cd /var/www/magento/media
+
+#CentOS example
+cd /var/www/html/magento/media
+
As a user with privileges to write to the Magento installation directories (typically the web server user), copy the sample data's media directory and subdirectories to your Magento installation directory.
+For example, to copy Magento sample data from /home/username to /var/www/magento, enter
+
cp -R /home/username/media/* .
+
Magento CE 1.9 and Magento EE 1.14 only. You must also copy the sample data's skin directory to [your Magento install dir]/skin as follows:
+For example, to copy Magento skin files from /home/username/skin to /var/www/magento/skin, enter
+
cd [your Magento install dir]/skin
+cp -R /home/username/skin/* .
+
Import the CE or EE sample data into your MySQL database as follows:
+
mysql -u root -p magento-db-instance-name < path-to-sample-data-extract-dir/sample-data-filename.sql
+EE 1.14 example
+
mysql -u root -p magento < /home/username/magento_sample_data_for_1.14.0.0.sql
+
+
Setting File and Directory Ownership and Privileges
+
Magento recommends the following ownership and privilege settings for files and directories in the Magento installation directory:
+
The Magento installation directory and all subdirectories are owned by the web server user.
+This enables the web server to change files in these subdirectories but other users cannot access them (except a higher-level user such as root).
+
All directories have 700 permissions (drwx------).
+700 permissions give full control (that is, read/write/execute) to the owner and no permissions to anyone else.
+
All files have 600 permissions (-rw-------).
+600 permissions mean the owner can read and write but other users have no permissions.
+
Note: The way you set permissions and ownership depends on whether Magento is running on a dedicated or hosted system:
+
Hosted: A Magento server located on a hosting provider. A hosted system typically does not enable you to elevate to root. The web server typically runs as an ordinary user. Magento assumes you log in as this user to start and stop the web server and that you already own all the files and directories in the Magento installation directory. You can use chmod to change permissions on files and directories.
+
Dedicated: A Magento server you control and operate. Unlike a hosted system, you can elevate to root and, as root, you can use the chown and chmod commands to set ownership and privileges in the Magento installation directory.
+
To set privileges and ownership:
+
Log in to your Magento server.
+
Change to your Magento installation directory:
+
#Ubuntu example
+cd /var/www/magento
+
+#CentOS example
+cd /var/www/html/magento
+
Dedicated Magento server only. Enter the following command to set ownership of the Magento installation directory and all its subdirectories:
+
chown -R web-server-user-name .
+For example, on Ubuntu where Apache usually runs as www-data, enter
+
chown -R www-data .
+
Enter the following commands to set directory permissions to 700 and file permissions to 600:
+
find . -type d -exec chmod 700 {} +
+find . -type f -exec chmod 600 {} +
+
+
+
Installing Magento CE or EE
+
This section discusses how to run the Magento installer, using Magento EE as an example. The Magento CE installer has exactly the same options; only the appearance is different.
+
Important: The procedure that follows assumes that your web server and database server are on the same host. If they are installed on different hosts, additional tasks are required. Get help before you continue your installation.
+
+
To install Magento CE or EE:
+
Complete all of the tasks discussed earlier in this article.
+
Enter the following URL in your web browser's address or location field:
+
web-server-ip-or-host:port/magento-path/magento
+For example, if your web server is http://www.example.com, listens on port 80, and Magento is installed in the web server docroot's magento subdirectory, enter
+
http://www.example.com/magento
+The following page displays.
+
+
Select the checkbox that indicates you agree to the terms and conditions, and click Continue.
+
On the Localization page, enter the following information.
+
+
+
+
Option
+
Meaning
+
+
+
Locale
+
From the list, click the option that best matches the locale in which your Magento server resides.
+
+
+
Time Zone
+
From the list, click the option that best matches the time zone in which your Magento server resides.
+
+
+
Default currency
+
From the list, click the default currency to use on your Magento web store.
+
+
+
+The following figure shows an example of configuring Magento for US English in the US Central time zone and using the US Dollar as the default currency.
+
+
Click Continue.
+The Configuration page displays. Each of its three sections is discussed in the following step.
+
In the Configuration page, enter the following information:
+
In the Database Configuration section, enter the following information.
+
+
+
+
Option
+
Meaning
+
+
+
Database Type
+
From the list, click MySQL.
+
+
+
Host
+
Enter the database server's fully qualified hostname or IP address. Use the default setting of localhost if your database server is on the same host as your web server.
+
+
+
Database Name
+
Enter the name of the Magento database instance in which you want to install the Magento database tables.
+
+
+
User Name
+
Enter the username of the Magento database instance owner.
+
+
+
User Password
+
Enter the Magento database owner's password.
+
+
+
Tables Prefix
+
(Optional.) Use only if you're installing the Magento database tables in a database instance that has Magento tables in it already. In that case, enter a prefix to identify the Magento tables for this installation.
+
Some customers have more than one Magento instance running on a server with all tables in the same database. This option enables those customers to share the database server with more than one Magento installation.
+
+
+
+
+A sample follows.
+
+
In the Web Access Options section, enter the following information.
+
+
+
+
Option
+
Meaning
+
+
+
Base URL
+
Enter the base URL to use to access the Magento Admin Panel and your Magento web store.
+
+
+
Admin Path
+
Enter the path to access the Admin Panel. This path is appended to Base URL.
+ For example, if Base URL is http://www.example.com and Admin Path is admin, the Admin Panel's URL is http://www.example.com/admin—provided you configured your web server for server rewrites.
+
+
+
Enable Charts
+
Select the checkbox to display charts on the Admin Panel.
+
+
+
Skip Base URL Validation Before the Next Step
+
Clearing this checkbox validates your server's base URL by performing an HTTP GET. Clear this checkbox unless your web server's base URL is not verifiable; for example, in a development or test environment.
+
+
+
Use Web Server (Apache) Rewrites
+
Select this checkbox to enable the use of the Apache mod_rewrite module. You can select this checkbox only if you configured Apache to use server rewrites.
+
+
+
Use Secure URLs (SSL)
+
Select this checkbox only if your web server supports SSL.
+
+
+
+A sample follows.
+
+
In the Session Storage Options section, click one of the following options:
+
File to store user session data on the file system in the [your Magento install dir]/var/session directory.
+File-based session storage is appropriate unless the Magento file system access is slow or you have a clustered database.
+
Database to store user session data in the database.
+Choose database storage if you have a clustered database; otherwise, there might not be much benefit over file-based storage.
+
+
+
+
Click Continue.
+
Important: If errors display, you must resolve them before continuing.
+
In the Create Admin Account page, enter the following information.
+
+
+
+
Option
+
Meaning
+
+
+
First Name
+
Enter the first name of the user you want to identify as the Magento web store owner.
+
+
+
Last Name
+
Enter the user's last name.
+
+
+
Email
+
Enter the user's email address.
+
+
+
Username
+
Enter the Magento Admin Panel administrator's username. (You can create additional Magento administrators later.)
+
+
+
Password
+
Enter the user's password.
+
+
+
Confirm Password
+
Enter the user's password again for verification.
+
+
+
Encryption Key
+
If you have one, enter a key to encrypt sensitive data in the Magento database. If you don't have one, Magento generates one for you.
+ The encryption key is stored in [your Magento install dir]/app/etc/local.xml.
+
+
+
+A sample follows.
+
+
Click Continue.
+The following page displays to indicate a successful installation.
+
+
+
+
Verifying that Magento CE or Magento EE Installed Successfully
+
To make sure Magento installed properly, you should log in to the Admin Panel to verify the Magento version.
+
You can also import products into Magento or perform other tasks that verify you can write to the database.
+
In a web browser's location or address field, enter the URL to the Admin Panel. An example follows:
+
http://www.example.com/magento/admin
+(The Admin Panel URL is a combination of the Base URL and Admin Path fields you entered when you installed Magento.
+
Log in to the Admin Panel as an administrator.
+
Scroll to the bottom of the page; the version should display as 1.14 (Magento EE) or 1.9.0.0 (Magento CE).
+The following figure shows an example.
+
+
+
Congratulations! You successfully installed Magento!
+
+
Setting Up Cronjobs
+
Several Magento features require at least one cronjob, which schedules activities to occur in the future. A partial list of these activities follows:
+
Catalog price rules
+
Newsletters
+
Generating Google sitemaps
+
Customer Alerts/Notifications (product price change, product back in stock)
+
Reindexing (Magento EE 1.13 only)
+
Private sales (Magento EE only)
+
Automatic updating of currency rates
+
Magento EE 1.14.1 and later, Magento CE 1.9.1 and later All Magento e-mails (including order confirmation and transactional)
+
+
Note: Magento depends on proper cronjob configuration for many important system functions, including indexing. Failure to set it up properly means Magento won't function as expected.
+
+
Crontab files define tasks (cronjobs) that are performed at scheduled dates and times. Each user on a system has its own crontab file, and the cron daemon runs each cronjob as the user who owns the crontab. For Magento, this user is the web server.
+
+
Recommendations for cronjobs
+
Magento recommends splitting your cronjob on two tasks in your crontab for best performance and completing your cronjobs without issues:
+
Indexer Cronjob (malways mode) can take longer to execute and complete, skipping other cronjobs (mdefault mode) scheduled during the time that the indexer runs.
+
Cronjobs in mdefault scope may take longer to execute and complete, blocking others scheduled during the time it is still running.
+
+
+
To split your malways and mdefault cronjob modes, use the following:
Determine which of your cronjobs may be long-running and move them into separate crontabs. For example, imports, exports, and indexes can run long, blocking other cronjobs scheduled in that crontab.
+
+
Magento recommends running cron every minute for EE and every five minutes for CE.
+
+
Create cronjobs
+
First, determine your web server's user. SSH into the server and enter the following command:
+
ps -o "user group command" -C httpd,apache2
+
In CentOS, the Apache user is typically apache. In Ubuntu, it's typically www-data. Enter this user in the commands for creating the crontabs and cronjobs.
+
+
We recommend splitting the cronjob between two tasks to prevent the indexer blocking other mdefault jobs or an mdefault job blocking the indexer. These instructions include these commands.
+
+
To create a cronjob as the user that runs Apache:
+
+
Create or edit a crontab for the Apache user. This command opens a vim text editor with the username of the Apache user. You might need to choose a text editor first.
+
crontab -u apache-user-name -e
+
To split cronjobs for better performance, enter the following:
+
This article discusses how to install required prerequisite software for CentOS. You must complete these tasks before you install Magento CE 1.8 or later or Magento EE 1.13 or later.
+
Before you continue, make sure you familiarize yourself with the installation process discussed in Prerequisites.
+
Note: You must install system software on CentOS as a user with root privileges.
+
+
+
Updating System Software
+
It's a good practice to update your repositories and optionally update system software.
+
Update repositories:
+
yum -y update
+
Optionally upgrade software. This might cause a system reboot.
+
yum -y upgrade
+
+
Apache
+
Magento requires Apache use server rewrites. You must also specify the type of directives that can be used in .htaccess, which Magento uses to specify rewrite rules.
+
Installing and configuring Apache is basically a three-step process: install the software, enable rewrites, and specify .htaccess directives.
+
+
Installing Apache
+
Install Apache 2 if you haven't already done so.
+
yum -y install httpd
+
+
Enabling Apache Rewrites
+
Open httpd.conf for editing.
+
vim /etc/httpd/conf/httpd.conf
+
Locate the block that starts with:
+
<Directory /var/www/html>
+
In that block, change the value of AllowOverride to All.
+
Save your changes to httpd.conf and exit the text editor.
+
Restart Apache.
+
service httpd restart
+
+
PHP
+
Magento CE and EE support the following PHP versions:
+
Magento CE 1.6.0.0–1.8.1.0 and Magento EE 1.11.0.0–1.13.1.0 support PHP 5.3 natively. They can be used with PHP 5.4 if you apply the PHP 5.4 patch.
+
Magento CE 1.9.0.x and EE 1.14.0.x support PHP 5.4 natively. They are backward-compatible with PHP 5.3
+
Magento CE 1.9.1 and EE 1.14.1 support PHP 5.5 natively. They are backward-compatible with PHP 5.4
+
We recommend you use the most recent PHP version supported by your version of Magento. For example, you should use PHP 5.5 with CE 1.9.1 or EE 1.14.1.
Check with a system administrator or reference for your version of CentOS to see what PHP versions are available.
+
If you're installing Magento CE 1.9.1 or Magento EE 1.14.1, you can use PHP 5.5; otherwise, we recommend PHP 5.4. For certain versions of CE and EE, a patch is required to use PHP 5.4.
+
Enter the following command to see what version of PHP is currently running:
+
php -v
+
See one of the following sections for more information:
CentOS 6.x repositories have PHP 5.3. This section assumes you use either PHP 5.4 or 5.5. Make sure you understand which version of Magento CE or EE supports the PHP version to which you upgrade.
+
Before you start, verify you have PHP 5.3 installed:
+
php -v
+
If you already have the desired PHP version installed, you don't have to do anything.
+
If PHP is not installed, install PHP 5.3 using the following command:
+
yum -y install php php-xml
+
Continue with one of the following sections.
+
Important: The following sections discuss suggested PHP upgrade paths. Because you're choosing a non-CentOS repository to upgrade PHP, make your choice carefully. Not all repositories work equally well. We don't recommend any particular repository. Consult a system administrator or CentOS reference for more information.
+
+
+
Upgrading to PHP 5.5
+
There is more than one way to upgrade CentOS 6.5 to PHP 5.5; the following is a suggestion only. Consult a reference for additional options.
Increase memory_limit in php.ini to at least 512MB.
+
Open /etc/php.ini in a text editor.
+
Change memory_limit to:
+
memory_limit = 512M
+
Save your changes and exit the text editor.
+
+
MySQL
+
This section discusses how to install and configure MySQL 5.6. CentOS 6.x repositories have MySQL 5.1; to install a different version of MySQL, see the MySQL documentation.
+
Note: Use the tasks that follow only on a new MySQL database. Some of the tasks require you to delete users and should not be performed on a database that has already been set up.
Set a password for the root user and set other security-related options. Enter the following command and follow the prompts on your screen to complete the configuration.
+
This article discusses how to install required prerequisite software for Ubuntu. You must complete these tasks before you install Magento CE 1.8 or later or Magento EE 1.13 or later.
+
Before you continue, make sure you familiarize yourself with the installation process discussed in Prerequisites.
+
Note: You must install system software on Ubuntu as a user with root privileges.
+
+
+
Updating System Software
+
It's a good practice to update your repositories and system software, if necessary.
+
Log in to your Magento server as a user with root privileges and enter the commands shown in this section.
+
Update repositories:
+
apt-get update
+
Optionally upgrade software. This might require a system reboot.
+
apt-get upgrade
+
+
Apache
+
This section discusses how to install Apache. For more details, you can consult a reference like the Ubuntu site.
+
Magento requires Apache use server rewrites. You must also specify the type of directives that can be used in .htaccess, which Magento uses to specify rewrite rules.
+
Installing and configuring Apache is basically a three-step process: install the software, enable rewrites, and specify .htaccess directives.
+
+
Installing Apache
+
Install Apache 2 if you haven't already done so:
+
apt-get -y install apache2
+
+
Enabling Apache Rewrites
+
Ubuntu 12 (which natively supports Apache 2.2) is different from Ubuntu 14 (which natively supports Apache 2.4).
+
It's very important you choose a value for AllowOverride that is suited to your deployment. You can use AllowOverride All in development but it might not be desirable in production.
+
For more information, see one of the following references:
Use this section to enable Apache rewrites and specify .htaccess if you use Apache 2.2, which is supported by the default Ubuntu 12 repository.
+
Open the following file for editing.
+
vim /etc/apache2/sites-available/default
+
Locate the following block.
+
<Directory /var/www/>
+ Options Indexes FollowSymLinks MultiViews
+ AllowOverride None
+ Order allow,deny
+ allow from all
+</Directory>
+
Change the value of AllowOverride to [value from Apache site].
+
<Directory /var/www/>
+ Options Indexes FollowSymLinks MultiViews
+ AllowOverride All
+ Order allow,deny
+ allow from all
+</Directory>
+
Save the file and exit the text editor.
+
Configure Apache to use the mod_rewrite module.
+
cd /etc/apache2/mods-enabled
+ln -s ../mods-available/rewrite.load
+
Restart Apache.
+
service apache2 restart
+
+
Enabling Apache Rewrites for Apache 2.4
+
Use this section to enable Apache rewrites and specify .htaccess if you use Apache 2.4, which is supported by the default Ubuntu 14 repository.
+
Enter the following command:
+
a2enmod rewrite
+
Specify the type of directives that can be used in .htaccess.
+For guidelines, see the Apache 2.4 documentation.
+Note that in Apache 2.4, the server's default site configuration file is /etc/apache2/sites-available/000-default.conf
+For example, you can add the following to the bottom of 000-default.conf:
+
<Directory "/var/www">
+AllowOverride [value from Apache site]
+</Directory>
+Note: You must change the value of AllowOverride in the directive for the directory to which you expect to install the Magento software. For example, to install in the web server docroot, edit the directive in <Directory /var/www>.
+
+
Restart Apache:
+service apache2 restart
+
+
PHP
+
Magento CE and EE support the following PHP versions:
+
Magento CE 1.6.0.0–1.8.1.0 and Magento EE 1.11.0.0–1.13.1.0 support PHP 5.3 natively. They can be used with PHP 5.4 if you apply the PHP 5.4 patch.
+
Magento CE 1.9.0.x and EE 1.14.0.x support PHP 5.4 natively. They are backward-compatible with PHP 5.3
+
Magento CE 1.9.1 and EE 1.14.1 support PHP 5.5 natively. They are backward-compatible with PHP 5.4
+
We recommend you use the most recent PHP version supported by your version of Magento. For example, you should use PHP 5.5 with CE 1.9.1 or EE 1.14.1.
Check with a system administrator or reference for your version of Ubuntu to see what PHP versions are available.
+
If you're installing Magento CE 1.9.1 or Magento EE 1.14.1, you can use PHP 5.5; otherwise, we recommend PHP 5.4. For certain versions of CE and EE, a patch is required to use PHP 5.4.
+
Enter the following command to see what version of PHP is currently running:
+
php -v
+
See one of the following sections for more information:
Important: The following sections discuss suggested PHP upgrade paths. Because you're choosing a non-Ubuntu repository to upgrade PHP, make your choice carefully. Not all repositories work equally well. We don't recommend any particular repository. Consult a system administrator or Ubuntu reference for more information.
+
+
To upgrade your version of PHP, see one of the following:
Increase memory_limit in php.ini to at least 512MB:
+
Open /etc/php5/apache2/php.ini in a text editor.
+
Change memory_limit to:
+
memory_limit = 512M
+
Save your changes and exit the text editor.
+
+
MySQL
+
Magento CE and EE support the following MySQL versions:
+
Magento CE 1.9.1 and Magento EE 1.14.1 support MySQL versions 5.0.2 through 5.6.x.
+To install MySQL 5.6, see Installing MySQL 5.6.
+
Magento CE versions 1.8.0.0–1.9.0.x support MySQL versions 4.1.20–5.5.x.
+To install MySQL version 5.5, see the next section.
+
+
Installing MySQL 5.5
+
Install the MySQL database:
+
apt-get -y install mysql-client mysql-server
+
+
Installing MySQL 5.6
+
Only Magento CE 1.9.1 and EE 1.14.1 support MySQL 5.6. To install MySQL 5.6 on Ubuntu 14, see Installing MySQL 5.6 on Ubuntu 14. To install MySQL 5.6 on Ubuntu 12, see the next section.
+
+
Installing MySQL 5.6 on Ubuntu 12
+
To install MySQL 5.6 on Ubuntu 12, enter the following commands in the order shown:
Test the installation by entering the following command:
+
mysql -u root -p
+
Messages similar to the following display:
+
Welcome to the MySQL monitor. Commands end with ; or \g.
+Your MySQL connection id is 43
+Server version: 5.6.21-1+deb.sury.org~precise+1 (Ubuntu)
+
+Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
+
+Oracle is a registered trademark of Oracle Corporation and/or its
+affiliates. Other names may be trademarks of their respective
+owners.
+
+Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+
+mysql>
+
+
Installing MySQL 5.6 on Ubuntu 14
+
To install MySQL 5.6 on Ubuntu 14, enter the following command:
Test the installation by entering the following command:
+
Welcome to the MySQL monitor. Commands end with ; or \g.
+Your MySQL connection id is 45
+Server version: 5.6.19-0ubuntu0.14.04.1 (Ubuntu)
+
+Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
+
+Oracle is a registered trademark of Oracle Corporation and/or its
+affiliates. Other names may be trademarks of their respective
+owners.
+
+Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+
+mysql>
+
+
\ No newline at end of file
diff --git a/guides/v1.8/install/installing_upgrade_ce18_upgrade-roadmap.html b/guides/v1.8/install/installing_upgrade_ce18_upgrade-roadmap.html
new file mode 100644
index 0000000000..9a24099792
--- /dev/null
+++ b/guides/v1.8/install/installing_upgrade_ce18_upgrade-roadmap.html
@@ -0,0 +1,57 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ubuntu: Installing Required Prerequisite Software for Magento CE 1.8 Magento EE 1.13 (or Later)
+
+
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
Upgrade Roadmap for Magento Community Edition (CE) 1.8 or 1.9
+
+
+
+
+
Magento recommends you upgrade your installation using the following guidelines in a development or test environment, separate from your existing production environment:
+
Install Magento in a different directory:
+
Recommended. Set up a new system (that is, another host) on which to install Magento.
+The system should be identical to, if not better than, your current system. The new system must meet the Magento system requirements.
+
Install Magento in a new, empty root installation directory on the same server.
+
+
In your current production environment:
+
Back up your Magento database.
+
Archive the file system.
+This includes the media directory and subdirectories; all extensions and customizations; and all custom themes.
+
+
In the development or test environment:
+
Create a new, empty database instance.
+
Import the production database tables into the development database instance.
+
Copy your production media directory, extensions, themes, and other customizations to the development system.
+
Copy local.xml to [your Magento install dir]/app/etc and edit it if necessary to reference the production database instance.
+
In a web browser, go to your development system base URL.
+
Wait for upgrade scripts to run.
+
Verify the development system is now identical to the production system.
+If not, fix issues, retest, and upgrade again.
+
+
Test the development system thoroughly, including:
+
Verify all extensions, themes, and customizations work.
+
Place orders using all webstores and all payment methods.
Magento Enterprise Edition (EE) 1.13.0.2, 1.13.1, or 1.14.x
+
Important: Magento recommends CE 1.9.1.0 or later or EE 1.14.1.0 or later for all CE and EE installations and upgrades to get the latest fixes, features, and security updates.
+
+
Because of changes to URL rewrites, the following upgrades are more complex than other upgrades.
+
Upgrading from EE 1.12 or earlier to EE 1.14.x
+
Upgrading from EE 1.13.0.0 or EE 1.13.0.1 to EE 1.14.x
+
Note: If you're upgrading from EE 1.13.0.2 to EE 1.13.1.0 or later, your upgrade doesn't involve changes to URL rewrites and you can skip many of the steps discussed in the other upgrades. Continue with Getting Ready For Your Upgrade.
This section discusses how to get ready for your upgrade by backing up the database and customizations on the file system. The steps that follow do not affect your current production system. You can continue serving customers with no downtime.
Recommended. Set up a new system (that is, another host) on which to install Magento.
+The system should be identical to, if not better than, your current system. The new system must meet the Magento system requirements.
+
Install Magento in a new, empty root installation directory on the same server.
+
Important: Do not upgrade Magento in the same directory on the same server because post-upgrade errors are likely to occur.
+
+
Magento strongly recommends you observe the following guidelines when you set up the Magento database in your development environment:
+
+
Magento for the first time uses MySQL database triggers to improve database access during reindexing. Magento does not support any custom triggers in the Magento database because custom triggers can introduce incompatibilities with future Magento versions.
Before you start your upgrade, you should enable exception logging so it will be enabled on the development system. Without exception logging, it will be more difficult to diagnose errors during your upgrade. You can disable exception logging after you've exported the Magento database.
+
To enable exception logging:
+
Log in to the Admin Panel as an administrator.
+
Click System > Configuration.
+
In the ADVANCED group, click Developer.
+This enables you to enable exception logging so you'll see exceptions in the development environment after the upgrade.
+
In the right pane, click Log Settings to expand it.
+The following figure shows an example.
+
+
From the Enabled list, click Yes.
+
Optionally change the names of the log files.
+
Click Save Config.
+
+
Disabling cron Jobs
+
Before upgrading to EE 1.13.0.2 or later, disable all running cron jobs. A simple way to stop cron jobs follows; consult an appropriate reference for other options.
+
As a user with root privileges, enter one of the following commands:
+
Ubuntu: service crond stop
+
CentOS: service cron stop
+
+
+
+
Setting All Indexers for Update on Save
+
This section applies to upgrading Magento EE only. Skip this section if you're using Magento CE.
+
Because of the changes to indexing in Magento EE 1.13, you must set all indexers to update on save before you upgrade; otherwise, unpredictable performance will result. You can revert indexer settings after you've exported the Magento database.
+
To set indexers to update on save:
+
Click System > Index Management.
+
On the top left corner of the row, click Select All to select all indexers.
+
From the Options list, click Change indexing mode.
+The Index Mode list displays.
+
From the Index Mode list, click Update on Save.
+The following figure shows an example.
+
+
At the top right corner, click Submit.
+
Make sure all indexers are now set for Update on Save as the following figure shows.
+
+
+
Flushing the Cache
+
Clear the Magento cache as follows:
+
Log in to the Admin Panel as an administrator.
+
Click System > Cache Management.
+
Click Flush Magento Cache.
+
+
Backing Up the Database
+
Back up your database using mysqldump or another tool. mysqldump syntax follows:
Pre-Upgrade Tasks For Your Development Environment
+
In your development environment:
+
If necessary, create a Magento installation master directory; Magento installs in a magento subdirectory of that directory.
+The Magento installation archive creates a magento subdirectory so if you want your Magento installation directory to be /var/www/magento, you don't need to do anything.
+
Tip: The name and path to the Magento installation directory in your development system does not have to be the same as on your production system, although it might make some tasks simpler.
+
+
Create a new database instance. For example, you can create a new MySQL database instance named magento using the following commands:
+
mysql -u root -p
+Enter the remaining commands at the mysql> prompt
+
create database magento;
+GRANT USAGE ON *.* TO magento@localhost IDENTIFIED BY 'magento';
+GRANT ALL ON magento.* TO magento@localhost;
+For MySQL versions later than 5.0.2 but earlier than 5.1.6, the following command is required:
+
GRANT SUPER ON *.* TO 'magento'@'localhost';
+Exit the MySQL command shell:
+
exit
+Verify the database exists using the following command:
+
mysql -u magento -p magento
+If an error displays, repeat the commands. If the command succeeded, enter exit to return to the command prompt.
+
If you're using Security Enhanced Linux (SELinux)and Apache must initiate a connection to another host, you must run the commands discussed in this step.
+
To determine if SELinux is enabled, use the following command:
+getenforce
+Enforcing displays to confirm that SELinux is running.
+
Enter one of the following commands:
+CentOS:
+
setsebool -P httpd_can_network_connect=1
+Ubuntu
+
setsebool -P apache2_can_network_connect=1
+
+
+
Optional: Upgrading to PHP 5.4
+
PHP 5.3 is currently the latest PHP version available in the default repositories for Ubuntu and CentOS. PHP 5.3 works with CE 1.8, CE 1.9, EE 1.13, and EE 1.14.
+
We recommend PHP 5.4 for all of the preceding CE and EE versions because of the new features and changes in that release.
+
CE 1.8 and EE 1.13 both require a PHP 5.4 patch. The patch is listed as PHP 5.4 Compatibility in the EE support portal.
This section discusses how to extract the Magento archive in your development system and manually copy over your customizations, themes, and extensions.
+
Important: To avoid errors after upgrading, you must set up a parallel system. Do not upgrade your existing system or post-upgrade errors are likely to occur.
+
+
Make sure the CE or EE installation archive is located in the directory above where you want Magento to be installed.
+For example, to install Magento to /var/www/magento, copy the archive to /var/www.
+
Extract the archive. For example,
+tar -zxf archive-name
+This installs Magento CE or EE on the file system on your development system. Next, you'll overwrite some of these assets with customizations from your production system.
+
Extract the production system's media archive, overwriting the installation archive. You created the media archive as discussed in Getting Ready For Your Upgrade.
+
Tip: Copy the media archive to the same level in the directory structure to simplify the process. For example, if you created the media archive on your production system in your Magento install directory, the archive when extracted creates the media directory and all subdirectories. If you copy the media archive to the Magento installation directory on your development system, extracting it automatically replaces existing media subdirectory contents.
+
If necessary, move the media directory and subdirectories to media directory in your new Magento installation, overwriting the existing contents.
If necessary, move the theme packages to the [your Magento install dir]/app/design/frontend and [your Magento install dir]/skin/frontend directories, as appropriate, overwriting the existing contents.
If necessary, move the extensions and customizations to the [your Magento install dir]/app/code/local and [your Magento install dir]/app/code/community directories, as appropriate, overwriting the existing contents.
+
+
Updating the Magento Database
+
This section discusses how to:
+
Import the production database data into the development database instance.
+
In the development database instance, change the values of the paths web/unsecure/base_url and web/secure/base_url in the core_config_data table to the development server's IP address or hostname.
+
Import the production database data using your database manager tool.
+
Important:The database instance into which you import must be empty.
+
+
mysql syntax follows:
+
mysql -u root -p database-name < database-export-filename.sql
+For example, if the database name is magento and the database export file name is mangento-db-export.sql, enter
+
mysql -u root -p magento < mangento-db-export.sql
+
The following sections discuss how to change the base URL paths from http://prod.example.com to http://dev.example.com using SQL commands and phpmyadmin:
Updating the Base URL the Database Using SQL Commands
+
This section discusses how to update the secure and unsecure URLs of your webstores and store views in the Magento database. The following example assumes you have two URLs, which every Magento installation has by default. Depending on your setup, you could have more (for additional store views, Content Delivery Networks (CDNs) and so on.
+
Use the following procedure to update all matching URLs in the database.
+
To update the database with the development system's base URLs using SQL commands:
+
Log in to the database server as any user.
+
Enter the following commands in the order shown:
+
mysql -u root -p
+Enter the remaining commands at the mysql> prompt.
+
use magento-db-name;
+SELECT * FROM core_config_data WHERE path LIKE '%base_url%';
+
In the resulting output, make note of the rows that include web/unsecure/base_url and web/secure/base_url.
+In particular, you must know the value of the config_id for these rows.
+
Carefully examine the entire URL to avoid mistakes.
+
Enter the following command to update the values of web/unsecure/base_url and web/secure/base_url:
+
UPDATE core_config_data SET value='base-url' WHERE config_id=id1 or config_id=id2;
+Example 1—config_ids are the same: if your base URL is http://dev.example.com/, the config_id of the row containing web/unsecure/base_url is 354 and the config_id of the row containing web/secure/base_url is 355, enter:
+
UPDATE core_config_data SET value='http://dev.example.com/' WHERE config_id=354 or config_id=355;
+Example 2—config_ids are different: Same as preceding example except that web/secure/base_url uses https://
+
UPDATE core_config_data SET value='http://dev.example.com/' WHERE config_id=354;
+UPDATE core_config_data SET value='https://dev.example.com/' WHERE config_id=355;
+
Verify the values are set correctly.
+
SELECT * FROM core_config_data WHERE path LIKE '%base_url%';
+
For other URLs, be careful to perform the replacement correctly.
+For example, store view base link URLs resemble the following:
+
http://prod.example.com/view1/
+Make sure to update the URL like the following:
+
UPDATE core_config_data SET value='http://dev.example.com/view1/' WHERE config_id=377;
+
When you're done, run the following command again:
+
SELECT * FROM core_config_data WHERE path LIKE '%base_url%';
+
If the values are set correctly, enter exit at the mysql> prompt and continue with Finishing the File System.
+If not, repeat the tasks discussed in this section. Do not continue until the database is updated.
+
+
+
Updating the Base URL the Database Using phpmyadmin
+
This section discusses how to use phpmyadmin to change the values of the paths web/unsecure/base_url and web/secure/base_url in the core_config_data table to the development server's IP address or hostname.
+
In a web browser's location or address field, enter dev-web-server-host-or-ip/phpmyadmin
+For example, if your web server address is http://dev.example.com, enter
+http://dev.example.com/phpmyadmin
+
Log in as the MySQL root user.
+
In the left navigation bar, click the name of your Magento database.
+
In the left navigation bar, click the core_config_data table.
+
At the top of the page, click the Search tab.
+
In the Search tab page, from the Operator list, click LIKE.
+
Enter %base_url% in the Value field.
+The following figure shows an example.
+
+
Click Go.
+The following figure shows sample results.
+
+
Click (Edit) in the row that includes the path web/unsecure/base_url.
+
Change the value to the hostname or IP address of your development server.
+The following figure shows an example.
+
+
Click Go.
+
Repeat these tasks for the path that includes web/secure/base_url.
+
Exit phpmyadmin.
+
+
Upgrading Solr (EE 1.14.0.0 only)
+
This section applies to upgrading to EE 1.14.0.0 using the Solr search engine only. If you're upgrading to a different version—or if you're not using Solr—skip this section and continue with Finishing the File System.
+
Because of changes to the Solr schema, you must copy two files from Magento to your Solr installation. Failure to do so might prevent products from displaying on your web store. After copying the files, you must also reindex the catalog search index.
+
To update Solr:
+
If the Solr search engine is running, stop it.
+
Copy the following files from the Magento 1.14.0.0 installation to the equivalent directory on your Solr installation:
+
For example, if Magento is installed in /var/www/html/magento and the example Solr configuration is installed in the /etc/solr/apache-solr-3.6.2/example/solr/conf directory on the same host, enter:
After you copy the files, you must update the catalog search index. To update the catalog search index, open a command prompt window.
+
Change to the shell subdirectory of your Magento installation directory.
+For example, on CentOS:
+
cd /var/www/html/magento/shell
+
Enter the following command:
+
php indexer.php --reindex catalogsearch_fulltext
+
Note: The preceding example showed paths used by the Solr example configuration. Solr ships with a sample configuration that Magento suggests you use for development only. Do not use the Solr example configuration in production.
+
+
Finishing the File System
+
This section discusses how to edit copy local.xml and set file system permissions and ownership on the production system.
+
+
Copying local.xml
+
Copy your production system's local.xml to [your Magento install dir]/app/etc.
+
Open local.xml in a text editor.
+
If necessary, change the database connection information in the default_setup element, as follows:
+
Save your changes to local.xml and exit the text editor.
+
+
Setting File and Directory Ownership and Privileges
+
Magento recommends the following ownership and privilege settings for files and directories in the Magento installation directory:
+
The Magento installation directory and all subdirectories are owned by the web server user.
+This enables the web server to change files in these subdirectories but other users cannot access them (except a higher-level user such as root).
+
All directories have 700 permissions (drwx------).
+700 permissions give full control (that is, read/write/execute) to the owner and no permissions to anyone else.
+
All files have 600 permissions (-rw-------).
+600 permissions mean the owner can read and write but other users have no permissions.
+
Note: The way you set permissions and ownership depends on whether Magento is running on a dedicated or hosted system:
+
Hosted: A Magento server located on a hosting provider. A hosted system typically does not enable you to elevate to root. The web server typically runs as an ordinary user. Magento assumes you log in as this user to start and stop the web server and that you already own all the files and directories in the Magento installation directory. You can use chmod to change permissions on files and directories.
+
Dedicated: A Magento server you control and operate. Unlike a hosted system, you can elevate to root and, as root, you can use the chown and chmod commands to set ownership and privileges in the Magento installation directory.
+
To set privileges and ownership:
+
Log in to your Magento server.
+
Change to your Magento installation directory:
+
#Ubuntu example
+cd /var/www/magento
+
+#CentOS example
+cd /var/www/html/magento
+
Dedicated Magento server only. Enter the following command to set ownership of the Magento installation directory and all its subdirectories:
+
chown -R web-server-user-name .
+For example, on Ubuntu where Apache usually runs as www-data, enter
+
chown -R www-data .
+
Enter the following commands to set directory permissions to 700 and file permissions to 600:
+
find . -type d -exec chmod 700 {} +
+find . -type f -exec chmod 600 {} +
+
+
+
+
Running the URL Redirect Script (EE 1.13.0.0 and 1.13.0.1 only)
To complete the upgrade, go to your Magento base URL in a web browser. The first time you go to your Magento base URL, server-side scripts run to update the database. Depending on the amount of data in your database, this process can take a long time.
+
Important: Completing the upgrade requires downtime on your production system. If you continue to take orders on your production system, there is no way to reconcile all of the new orders in the replacement development system. You can reduce the amount of downtime to a minimum by thoroughly testing your development system before shutting down production.
+
+
+
If you're upgrading from a version earlier than CE 1.4 or EE 1.7, Magento strongly recommends the two-step upgrade approach discussed in Upgrade Path. In addition, you should expect the upgrade and testing process to take a long time and to expect more downtime for your production system.
The first step in your upgrade is to run server-side upgrade scripts. Depending on the nature of your customizations and extensions, and how many customers and products are in your database, these scripts can take a long time to run and can result in exceptions. You must resolve all exceptions before continuing to the next step in the process.
+
This step in the upgrade process is iterative; that is, you'll probably run through it more than once.
+
Note: Your production system remains up during this step in the upgrade process. You can continue taking and shipping orders and also making changes in the Admin Panel.
+
To run the upgrade scripts:
+
In a web browser address or location field, enter your Magento installation's base URL.
+
Note: If you upgraded Magento on the same server, you might need to update your Apache web server's virtual host configuration to reference the new Magento installation directory. For more information about configuring virtual hosts, see the Apache Virtual Host documentation.
+
+(You updated the Magento database with the development system base URL as discussed in Updating the Magento Database.)
+
Wait while upgrade scripts run on the server.
+
If fatal errors or exceptions display in the browser, they are most likely related to customizations. To resolve fatal errors, you must:
+
Analyze the errors to determine the root cause.
+You can find errors in the web server's error log or in [your Magento install dir]/var/log.
+
Fix the cause in your extension code.
+
In your development environment, drop the Magento database.
+
Re-create the development database and import production data into it as discussed in Updating the Magento Database.
+
Use the following command to delete the contents of the Magento var/ subdirectories:
+
Repeat the tasks discussed in this section until no more fatal errors display in the browser.
+
+
+
Post-Upgrade Tasks (EE 1.13.0.1 Only)
+
This section applies to upgrading from 1.13.0.1 only. If you're upgrading CE or if you're upgrading from a different EE version, continue with Setting Up the Magento Cron Job.
+
After successfully running the Magento upgrade and fixing errors, enter the following command from the Magento root directory:
+
php -f shell/indexer.php -- --reindexall
+
This command runs a full reindex and it might take a long time, depending on the size of your database.
+
After the reindex completes, enter the following command from your Magento installation directory:
Note: Some of these directories might be empty; this is normal.
+
+
Verifying the Status of Indexers
+
After the cron job runs, all indexers should be in a Ready status. Before testing your upgrade, verify all indexers are Ready; otherwise, your testing will be inconclusive.
+
To verify the status of indexers:
+
Log in to the Admin Panel as an administrator.
+
Click System > Index Management.
+Verify that all indexers have a status of Ready, as the following figure shows.
+
+
If indexers are not Ready, use the following guidelines:
+
+
+
+
Indexer status
+
Suggested action
+
+
+
Scheduled
+
Wait for cron to finish or run http://magento-host-name/cron.php from a web browser.
+
+
+
Processing
+
Wait for cron to finish or run cron.php from a web browser. (For example, http://www.example.com/magento/cron.php)
+
If indexers are Processing for an extended period of time, run the command discussed in Clearing Magento var/ Subdirectories and refresh the Index Management page.
+
+
+
+
Testing the Magento Upgrade
+
After you have upgraded with no fatal errors or exceptions, Magento strongly recommends you thoroughly test the upgrade in your development environment as follows:
+
Test all extensions and customizations thoroughly.
+Make sure the UIs perform as expected, make sure the extensions behave properly, and so on.
+
Run some orders, making sure prices are calculated correctly and that orders go through the configured payment mechanisms.
Before making the development system live, back up everything in your production and development environments again.
+The way you make your development system live is up to you; a simple way is to update your DNS server to point to the development IP address.
+
+
Taking Your Old Production System Offline
+
The last step in upgrading is to take your production system offline and switching to your development system—which then becomes the production system from that point on.
+
Important: Before continuing, make sure all errors have been resolved and that you have thoroughly tested the upgrade as discussed in the preceding section.
+
To switch from your production to development system:
+
Put your production system in maintenance mode so it cannot accept orders or other changes.
+To do so, create an empty file named [your Magento install dir]/maintenance.flag.
+
Test it by going to your Magento web store's front page.
+The following message displays if you set up maintenance mode correctly:
+The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.
+
If necessary, update the development database again to get any final transactions processed by your current production system.
+For details, see Updating the Magento Database.
+
Put your production system in maintenance mode so it cannot process orders.
+
Make your development system live.
+The way you do this is up to you; typically, you can configure your DNS server to send requests for your web store domain to the development system's IP address. Be aware that propagating the change to other DNS servers can take some time.
+
Verify your former development system is functioning as your new Magento web store in production.
+
Shut down the old production system.
+
Congratulations! You successfully upgraded! Review our welcome page to see the improvements you're getting.
+
+
Setting Magento File System Permissions and Ownership After Upgrade
There is a known issue after upgrading to EE 1.13.1 that affects you only if you do not follow the recommended procedure to upgrade to a new environment as discussed in Getting Ready For Your Upgrade.
+
Symptom: After completing the upgrade, when you log in to the Admin Panel and click System > Configuration, a fatal error similar to the following displays in your browser:
+
Class 'Mage_Googlecheckout_Helper_Data' not found in /var/www/html/magento/app/Mage.php on line 547
+
+
Solution:
+
Close the Admin Panel browser window.
+
As a user with root privileges, delete all files exceptconfig.xml from the following directory:
+
+
+
+
\ No newline at end of file
diff --git a/guides/v1.8/install/installing_upgrade_from-ee112.html b/guides/v1.8/install/installing_upgrade_from-ee112.html
new file mode 100644
index 0000000000..772e5a139d
--- /dev/null
+++ b/guides/v1.8/install/installing_upgrade_from-ee112.html
@@ -0,0 +1,173 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+
+
+
+ EE 1.14 Upgrade: Running the EE 1.12 and Earlier URL Redirect Script
+
+
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
+
EE 1.14 Upgrade: Running the EE 1.12 and Earlier URL Redirect Script
+
+
This article is part of the Magento Enterprise Edition (EE) upgrade documentation. If you're looking for something else, click here to go back to the Magento Knowledge Base.
+
This article applies to the following Magento EE upgrades:
This article discusses how to run the URL redirect script that creates HTTP 301 (Moved Permanently) redirects for any duplicate product URL keys. This enables Previous links in your web store to work, for example.
+
+
To create redirects for your URLs, perform the following tasks in the order shown:
It's very important to stop cron jobs from running until after the upgrade script completes. To do so, enter one of the following commands as a user with root privileges:
+
Ubuntu: service crond stop
+
CentOS: service cron stop
+
+
Changing Indexer Settings to Update When Scheduled
+
To change indexer settings:
+
Click System > Configuration.
+
In the left navigation bar, in the ADVANCED group, click Index Management.
+
In the right pane, expand Index Options.
+
Click Update when scheduled from the list for every indexer.
+The following figure shows an example.
+
+
In the upper right corner, click Save Config.
+
Note: Ignore any messages requesting you to reindex or flush the cache; you'll do that later.
This section discusses how to run the URL redirect script to create permanent redirects for any URLs that changed in EE 1.13.1.0.
+
Note: The time the script takes to run and the amount of memory it uses is directly proportional to the size of your database. If your database has 100,000 SKUs or more, Magento strongly recommends you monitor thread execution as discussed in this section. For large databases, the script can require several hours to complete.
+
+
To run the script:
+
Change to your Magento installation directory.
+
As the user who owns the files (typically, either root or the web server user), enter the following command:
+
+where
+thread_count is the number of threads to use. Magento recommends setting this to the number of CPU cores in your system minus 1 to a maximum of 15. For example, if your system has 8 CPU cores, enter
+
php -f shell/url_migration_to_1_13.php 7
+
Note: Each thread can use up to 512MB of RAM.
+
Wait while the script runs.
+Messages like the following display to indicate progress:
+
If you have a large database, open another command window and run the following command:
+
watch -n1 "ps ax | grep umt | grep -v grep"
+This command helps you to determine if each thread behaves correctly. After each process finishes, a new process should start immediately. There should be no delays or "hangs" between processes.
If errors display, check [your Magento install dir]/shell/migration.log for exceptions and see the following table.
+
Troubleshooting
+
+
+
+
+
+
Symptom
+
Suggested action
+
+
+
ERROR: Scope of attribute "url_key" is set to Global. This may cause DB inconsistency. Aborting.
+
This error can be caused by either a product or category url_key attribute being set for Global scope. To determine which type of url_key attribute is causing the error:
+
Log in as an administrator to the Admin Panel of the production system (in other words, the system you're upgrading from).
+
Click Catalog > Attributes > Manage Attributes.
+
Click the url_key row.
+
Examine the value of the Scope list. A sample follows.
+
+
If the value in the Scope list is Global:
+
Select another value from the list. You can select any value other thanGlobal.
If the value of the Scope list is notGlobal, the issue is likely that the category url_key attribute is set to global. To confirm this:
+
Log out of the Admin Panel.
+
In the development database instance, use either the MySQL command line or phpmyadmin to get the value of is_global from the catalog_eav_attribute table. If the value is 1, your catalog url_key attribute is set to Global.
+ Following is an example of finding the value using the MySQL command line:
+
select attribute_id, is_global from catalog_eav_attribute /
+ where attribute_id in (select attribute_id from eav_attribute /
+ where attribute_code = 'url_key');
+ Note: The command must be entered on a single line. It is shown here on multiple lines because of space limitations. When you enter the command, omit the / characters.
+
If any returned value is 1, you must contact Magento Support.
+
+
+
+
Other errors
+
Try running the script again. If errors persist, contact Magento Support.
+
+
+
+
Running a Full Reindex from the Command Line
+
After successfully running the URL redirect script, enter the following command from the Magento root directory:
+
php -f shell/indexer.php --reindexall
+
This command runs a full reindex and it might take a long time, depending on the size of your database.
+
After the reindex completes, enter the following command from your Magento installation directory:
+
rm -rf var/cache var/full_page_cache var/locks
+
+
Viewing the List of Redirects
+
As a result of running the URL redirect script, a list of redirects created for duplicate URL keys displays in the Admin Panel. To view these redirects:
+
Log in to the Admin Panel as an administrator.
+
Click Catalog > URL Redirects.
+
To optionally sort results by description, click the Description column.
+All redirects created by the URL redirect script display the following description:
+
1.12.0.2-1.13.x migration redirect
+The following figure shows an example.
+
+
+
Verifying That URLs Work Properly
+
Assuming all your post-upgrade issues are fixed, go to your web store and navigate the category tree. Click some products and make sure they display properly. Verify that all Previous and Back links work properly.
This article is part of the Magento Enterprise Edition (EE) upgrade documentation. If you're looking for something else, click here to go back to the Magento Knowledge Base.
+
This article applies to the following Magento EE upgrades:
This article discusses how to run the URL redirect script that creates HTTP 301 (Moved Permanently) redirects for any duplicate product URL keys. This enables Previous links in your web store to work, for example.
+
For more information about URL changes, see the EE 1.13.0.2 Release Notes. (Release Notes for the latest release are here.)
+
To create redirects for your URLs, perform the following tasks in the order shown:
It's very important to stop cron jobs from running until after the upgrade script completes. To do so, enter one of the following commands as a user with root privileges:
+
Ubuntu: service crond stop
+
CentOS: service cron stop
+
+
Running the Script
+
This section discusses how to run the URL redirect script to create permanent redirects for any URLs that changed in EE 1.13.1.0.
+
Note: The time the script takes to run and the amount of memory it uses is directly proportional to the size of your database.
+
To run the script:
+
Change to your Magento installation directory.
+
As the user who owns the files (typically, either root or the web server user), enter the following command:
+ php -f shell/url_migration_from_1_13_0_0_to_1_13_0_2.php
+
Wait while the script runs.
+ Messages like the following display to indicate progress:
+
[INFO]: Initialization...
+[INFO]: Start url rewrites processing from 1.13.0.0 to 1.13.0.2 ...
+[INFO]: Start root category "Default Category" processing ...
+[INFO]: Start root category "test" processing ...
+[INFO]: Executed in time
If errors display, check [your Magento install dir]/shell/migration.log for exceptions. Following are errors that might display when you run the migration script:
+
Application is not installed yet, please complete install wizard first
+
PHP Fatal error: Uncaught exception 'PDOException' with message 'SQLSTATE[28000] [1045] Access denied for user 'name'@'hostname' (using password: YES)' in /var/www/magento/lib/Zend/Db/Adapter/Pdo/Abstract.php
+
If one of these displays, make sure you copied [your Magento install dir]/app/etc/local.xml from your development system to the production system. Edit it if necessary to reference the production database instance. After you copy and edit local.xml, run the URL redirect script again.
Important: Magento recommends CE 1.9.1.0 or later or EE 1.14.1.0 or later for all CE and EE installations and upgrades to get the latest fixes, features, and security updates.
+
+
The following table provides basic information about how you perform your upgrade. More detailed information is discussed later in this article.
+
+
+
+
Edition and version
+
Upgrade path
+
+
+
CE 1.4 or earlier
+
Your current CE version > CE 1.7 > CE 1.9.0.0
+
+
+
CE 1.5 or later
+
Your current CE version > CE 1.9.0.0
+
+
+
EE 1.7 or earlier
+
Your current EE version > EE 1.12 > EE 1.14.0.0
+
+
+
EE 1.8 or later
+
Your current EE version > EE 1.14.0.0
+
+
+
+
+
Magento EE Upgrade Path
+
Because of changes to URL rewrites, the upgrade to Magento EE 1.13.0.2 or later is more complex than other upgrades. (This includes upgrading to Magento EE 1.14.)
+
Follow are the specific versions affected:
+
Upgrading from EE 1.12 or earlier to EE 1.13.0.2 or later (including to EE 1.14)
+
Upgrading from EE 1.13.0.1 to EE 1.13.0.2 or later (including to EE 1.14)
Provided you complete all tasks discussed in this article exactly as discussed, you can upgrade to Magento CE 1.9 or EE 1.14 from CE 1.5 or later or EE 1.8 or later.
+
Important: Do not upgrade directly to this release if you're currently running CE 1.4 or earlier or EE 1.7 or earlier. A safer approach would be:
+
Upgrade to CE 1.7 or EE 1.12
+
Thoroughly test CE 1.7 or EE 1.12 and fix any issues
+
Back up the system
+
Upgrade to CE 1.9 or EE 1.14
+
+
Note:
+
Use caution when upgrading from versions older than CE 1.7 or EE 1.12 because core code on which your extensions are based and database schema have likely changed.
This section discusses why the upgrade to EE 1.13.0.2 or later requires you to perform different tasks than previous upgrades.
+
One of the results of the change to the way URL keys are handled is that URLs for the same products or categories might need to change from the URLs in the version you're upgrading from. Following are scenarios that might cause URL keys to change:
+
All product keys must be unique. Any duplicate product URL keys are changed. For example, if two products had the URL key nike-shoes, one of them is changed to a URL key like nike-shoes-1 by the URL redirect scripts. This also resolves any conflicts (for example, if you already had another product with key nike-shoes-1).
+
Categories at the same level in the hierarchy in the same store view must have unique URL keys.
+For example, if you have a shoes category with URL key shoes in English store view, schuhe in the German store view and schuhe in the Swiss store view, the upgrade scripts change one of the category's URL keys to something like schuhe-1.
+
To ensure customers and search engines will be directed to the correct page, Magento provides a script that creates HTTP 301 (Moved Permanently) redirects for URLs that are changed.
+
In other words, after the upgrade, all pre-upgrade URLs work but they might be different than they were before you upgraded.
+
The way you upgrade depends on what EE version you're starting from. The following roadmaps provide a high-level overview of the upgrade process:
Following is a high-level roadmap to upgrade to EE 1.13.0.2 or later from EE 1.12 or earlier. This upgrade involves tasks not required for other Magento upgrades; these new tasks are indicated in the roadmap.
+
Install Magento in a different directory:
+
Recommended. Set up a new system (that is, another host) on which to install Magento.
+The system should be identical to, if not better than, your current system. The new system must meet the Magento system requirements.
+
Install Magento in a new, empty root installation directory on the same server.
+
Important: Do not upgrade Magento in the same directory on the same server because post-upgrade errors are likely to occur.
+
+
In your current production environment:
+
Back up your Magento database.
+
Archive the file system.
+This includes the media directory and subdirectories; all extensions and customizations; and all custom themes.
+
+
In the development or test environment:
+
Create a new, empty database instance.
+
Import the production database tables into the development database instance.
+
Copy your production media directory, extensions, themes, and other customizations to the development system.
+
Copy local.xml to [your Magento install dir]/app/etc and edit it if necessary to reference the production database instance.
+
Stop all cron jobs.
+
In a web browser, go to your new base URL.
+
Wait for upgrade scripts to run.
+
Set all indexers to update when scheduled (System > Configuration > ADVANCED > Index Management, Update when scheduled.
+
Run the URL redirect script to create 301 redirects:
+
cd [your Magento install dir]
+php -f shell/url_migration_to_1_13.php - thread-count
+thread-count is the number of CPU cores in your Magento server, minus 1, to a maximum of 15.
Enable cron and make sure the Magento cron job is set up.
+
Verify the upgraded system is now identical to the production system.
+If not, fix issues, retest, and upgrade again.
+
+
Test the upgrade thoroughly, including:
+
Verify all extensions, themes, and customizations work.
+
Place orders using all webstores and all payment methods.
+
Step-by-step instructions for your upgrade start here.
+
+
Upgrading From EE 1.13.0.1
+
Following is a high-level roadmap to upgrade to EE 1.13.0.2 or later from EE 1.13.0.1. This upgrade involves tasks not required for other Magento upgrades; these new tasks are indicated in the roadmap.
+
Install Magento in a different directory:
+
Recommended. Set up a new system (that is, another host) on which to install Magento.
+The system should be identical to, if not better than, your current system. The new system must meet the Magento system requirements.
+
Install Magento in a new, empty root installation directory on the same server.
+
Important: Do not upgrade Magento in the same directory on the same server because post-upgrade errors are likely to occur.
+
+
In your current production environment:
+
Back up your Magento database.
+
Archive the file system.
+This includes the media directory and subdirectories; all extensions and customizations; and all custom themes.
+
+
In the development or test environment:
+
Create a new, empty database instance.
+
Import the production database tables into the development database instance.
+
Copy your production media directory, extensions, themes, and other customizations to the development system.
+
Copy local.xml to [your Magento install dir]/app/etc and edit it if necessary to reference the production database instance.
+
Stop all cron jobs.
+
Run the URL redirect script to create 301 redirects:
+
Enable cron and make sure the Magento cron job is set up.
+
Verify the upgraded system is now identical to the production system.
+If not, fix issues, retest, and upgrade again.
+
+
Test the upgrade thoroughly, including:
+
Verify all extensions, themes, and customizations work.
+
Place orders using all webstores and all payment methods.
+
Important:
+
Only after upgrade is tested and all errors fixed should you consider using it as your production system.
+
Back up your system frequently during the upgrade process so you can roll back to a previous state in the event of errors or issues.
+
To avoid unnecessary downtime and potential issues, never upgrade Magento in a live environment!
+
Step-by-step instructions for your upgrade start here.
+
+
+
\ No newline at end of file
diff --git a/guides/v1.8/install/nginx.md b/guides/v1.8/install/nginx.md
new file mode 100644
index 0000000000..26b2297c4d
--- /dev/null
+++ b/guides/v1.8/install/nginx.md
@@ -0,0 +1,22 @@
+---
+layout: v1x
+title: nginx configuration
+---
+
+## Install nginx {#instgde-pre-nginx-install}
+
+We support nginx version 1.7.x. Installing the nginx software is beyond the scope of this guide. You can refer to a resource like the following:
+
+* [nginx wiki](https://www.nginx.com/resources/wiki/start/topics/tutorials/install/){: target="_blank"}
+* [How To Install Nginx on Ubuntu 14.04 LTS (digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-14-04-lts){: target="_blank"}
+* [How To Install Nginx on CentOS 6 (digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-centos-6-with-yum){: target="_blank"}
+
+## nginx security setting {#inst-pre-nginx-secy}
+
+[Byte.nl](https://www.byte.nl/){: target="_blank"} recently reported that some misconfigured Magento sites using the nginx web server software are vulnerable to attacks. The misconfiguration allows outside access to Magento cache files. The cache files have predictable names and can contain sensitive information, including Magento database passwords. This information can be used to obtain access to an installation and customer information.
+
+To avoid this issue, you can use [this nginx configuration](https://gist.github.com/gwillem/cd5ae6845fa33aa0d481){: target="_blank"} provided by Willem de Groot.
+
+We also recommend you review the [Magento Security Best Practices](http://merch.docs.magento.com/ee/user_guide/Magento_Enterprise_Edition_User_Guide.html){: target="_blank"}.
+
+Additionally, you can also check your site for other security vulnerabilities at [http://magereport.com](http://magereport.com){: target="_blank"}. This is a Magento community project that is not affiliated with Magento.
\ No newline at end of file
diff --git a/guides/v1.8/magefordev/mage-for-dev-1.html b/guides/v1.8/magefordev/mage-for-dev-1.html
new file mode 100644
index 0000000000..c81dc1bbf3
--- /dev/null
+++ b/guides/v1.8/magefordev/mage-for-dev-1.html
@@ -0,0 +1,507 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento for Developers: Part 1—Introduction to Magento
+
+
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
+
+
Magento for Developers: Part 1—Introduction to Magento
What is Magento? It's the most powerful online eCommerce platform in the universe and is changing the face of eCommerce forever. :-)
+
+
Of course, you already know that. What you may not realize is Magento's also an object-oriented PHP Framework that can be used to develop modern, dynamic web applications that tap into Magento's powerful eCommerce features.
+
+
This is the first in a series of articles in which we're going to go on a whirlwind tour of Magento's programming framework features. Don't worry if you don't follow everything immediately. As you study the system more everything in this article will start to make sense, and you'll soon be the envy of your colleagues stuck working with more primitive PHP systems.
Magento organizes its code into individual Modules. In a typical PHP Model-View-Controller (MVC) application, all the Controllers will be in one folder, all the Models in another, etc. In Magento, files are grouped together based on functionality, which are called modules in Magento.
+
+
Magento's Code
+
For example, you'll find Controllers, Models, Helpers, Blocks, etc. related to Magento's checkout functionality in
+
app/code/core/Mage/Checkout
+
+
You'll find Controllers, Models, Helpers, Blocks, etc. related to Magento's Google Checkout functionality in
+
app/code/core/Mage/GoogleCheckout
+
+
Your Code
+
When you want to customize or extend Magento, rather than editing core files directly, or even placing your new Controllers, Models, Helpers, Blocks, etc. next to Magento code, you'll create your own Modules in
+
app/code/local/Package/Modulename
+
+
Package (also often referred to as a Namespace) is a unique name that identifies your company or organization. The intent is that each member of the world-wide Magento community will use their own Package name when creating modules in order to avoid colliding with another user's code.
+
+
When you create a new Module, you need to tell Magento about it. This is done by adding an XML file to the folder:
+
app/etc/modules
+
+
There are two kinds of files in this folder, the first enables an individual Module, and is named in the form:
+Packagename_Modulename.xml
+
+
The second is a file that will enable multiple Modules from a Package/Namespace, and is named in the form:
+Packagename_All.xml. Note it is only used by the core team with the file Mage_All.xml. It is not recommended to activate several modules in a single file, as this breaks the modularity of your modules.
+
+
+
Configuration-Based MVC
+
+
Magento is a configuration-based MVC system. The alternative to this would a convention-based MVC system.
+
+
In a convention-based MVC system, if you wanted to add, say, a new Controller or maybe a new Model, you'd just create the file/class, and the system would pick it up automatically.
+
+
In a configuration-based system, like Magento, in addition to adding the new file/class to the codebase, you often need to explicitly tell the system about the new class, or new group of classes. In Magento, each Module has a file named config.xml. This file contains all the relevant configuration for a Magento Module. At runtime, all these files are loaded into one large configuration tree.
+
+
For example, want to use Models in your custom Module? You'll need to add some code to config.xml that tells Magento you want to use Models, as well as what the base class name for all your Models should be.
The same goes for Helpers, Blocks, Routes for your Controllers, Event Handlers, and more. Almost anytime you want to tap into the power of the Magento system, you'll need to make some change or addition to your config file.
+
+
+
Controllers
+
+
In any PHP system, the main PHP entry point remains a PHP file. Magento is no different, and that file is index.php.
+
+
However, you never CODE in index.php. In an MVC system, index.php will contain code/calls to code that does the following:
+
+
Examines the URL
+
Based on some set of rules, turns this URL into a Controller class and an Action method (called Routing)
+
Instantiates the Controller class and calls the Action method (called dispatching)
+
+
+
This means the practical entry point in Magento (or any MVC-based system) is a method in a Controller file. Consider the following URL:
+
+
http://example.com/catalog/category/view/id/25
+
+
Each portion of the path after the server name is parsed as follows.
+
+
Front Name - catalog
+
The first portion of the URL is called the front name. This, more or less, tells magento which Module it can find a Controller in. In the above example, the front name is catalog, which corresponds to the Module located at:
+
app/code/core/Mage/Catalog
+
+
Controller Name - category
+
The second portion of the URL tells Magento which Controller it should use. Each Module with Controllers has a special folder named 'controllers' which contains all the Controllers for a module. In the above example, the URL portion category is translated into the Controller file
All Controllers in the Magento cart application extend from Mage_Core_Controller_Front_Action.
+
+
Action Name - view
+
+
Third in our URL is the action name. In our example, this is "view". The word "view" is used to create the Action Method. So, in our example, "view" would be turned into "viewAction"
+
+
+class Mage_Catalog_CategoryController extends Mage_Core_Controller_Front_Action
+{
+ public function viewAction()
+ {
+ //main entry point
+ }
+}
+
+
+
People familiar with the Zend Framework will recognize the naming convention here.
+
+
Parameter/Value - id/25
+
+
Any path portions after the action name will be considered key/value GET request variables. So, in our example, the "id/25" means there will get a GET variable named "id", with a value of "25".
+
+
As previously mentioned, if you want your Module to use Controllers, you'll need to configure them. Below is the configuration chunk that enables Controllers for the Catalog Module
Don't worry too much about the specifics right now, but notice the
+
+<frontName>catalog</frontName>
+
+
+
This is what links a Module with a URL frontname. Most Magento core Modules choose a frontname that is the same as their Module name, but this is not required.
+
+
+
Multiple Routers
+
+
The routing described above is for the Magento cart application (often called the frontend). If Magento doesn't find a valid Controller/Action for a URL, it tries again, this time using a second set of Routing rules for the Admin application. If Magento doesn't find a valid Admin Controller/Action, it uses a special Controller named Mage_Cms_IndexController.
+
+
The CMS Controller checks Magento's content Management system to see if there's any content that should be loaded. If it finds some, it loads it, otherwise the user will be presented with a 404 page.
+
+
For example, the main magento "index" page is one that uses the CMS Controller, which can often throw newcomers for a loop.
+
+
+
Context-Based URI Model Loading
+
+
Now that we're in our Action method entry point, we'll want to start instantiating classes that do things. Magento offers a special way to instantiate Models, Helpers and Blocks using static factory methods on the global Mage class. For example:
The string 'catalog/product' is called a Grouped Class Name. It's also often called a URI. The first portion of any Grouped Class Name (in this case, catalog), is used to lookup which Module the class resides in. The second portion ('product' above) is used to determine which class should be loaded.
+
+
So, in both of the examples above, 'catalog' resolves to the Module app/code/core/Mage/Catalog.
+
+
Meaning our class name will start with Mage_Catalog.
+
+
Then, product is added to get the final class name
These rules are bound by what's been setup in each Module's config file. When you create your own custom Module, you'll have your own grouped classnames (also calles classgroups) to work with Mage::getModel('myspecialprefix/modelname');.
+
+
You don't have to use Grouped Class Names to instantiate your classes. However, as we'll learn later, there are certain advantages to doing so.
+
+
+
+
Magento Models
+
+
Magento, like most frameworks these days, offers an Object Relational Mapping (ORM) system. ORMs get you out of the business of writing SQL and allow you to manipulate a datastore purely through PHP code. For example:
In the above example we're calling the methods "getPrice" and "setPrice" on our Product. However, the Mage_Catalog_Model_Product class has no methods with these names. That's because Magento's ORM uses PHP's magic __call method to implement getters and setters.
+
+
Calling the method $product->getPrice(); will "get" the Model attribute "price".
+
+
Calling $product->setPrice(); will "set" the Model attribute "price". All of this assumes the Model class doesn't already have methods named getPrice or setPrice. If it does, the magic methods will be bypassed. If you're interested in the implementation of this, checkout the Varien_Object class, which all Models inherit from.
+
+
If you wanted to get all the available data on a Model, call $product->getData(); to get an array of all the attributes.
+
+
You'll also notice it's possible to chain together several calls to the set method:
That's because each set method returns an instance of the Model. This is a pattern you'll see used in much of the Magento codebase.
+
+
Magento's ORM also contains a way to query for multiple Objects via a Collections interface. The following would get us a collection of all products that cost $5.00
Again, you'll notice Magento's implemented a chaining interface here. Collections use the PHP Standard Library to implement Objects that have array like properties.
+
+
+foreach($products_collection as $product)
+{
+ echo $product->getName();
+}
+
+
+
You may be wondering what the "addAttributeToSelect" method is for. Magento has two broad types of Model objects. One is a traditional "One Object, One Table" Active Record style Model. When you instantiate these Models, all attributes are automatically selected.
+
+
The second type of Model is an Entity Attribute Value (EAV) Model. EAV Models spread data across several different tables in the database. This gives the Magento system the flexibility to offer its flexible product attribute system without having to do a schema change each time you add an attribute. When creating a collection of EAV objects, Magento is conservative in the number of columns it will query for, so you can use addAttributeToSelect to get the columns you want, or addAttributeToSelect('*') to get all columns.
+
+
+
Helpers
+
+
Magento's Helper classes contain utility methods that will allow you to perform common tasks on objects and variables. For example:
>
+$helper = Mage::helper('catalog');
+
+
You'll notice we've left off the second part of the grouped class name. Each Module has a default Data Helper class. The following is equivalent to the above:
+$helper = Mage::helper('catalog/data');
+
+
Most Helpers inherit form Mage_Core_Helper_Abstract, which gives you several useful methods by default.
+
+$translated_output = $helper->__('Magento is Great'); //gettext style translations
+if($helper->isModuleOutputEnabled()): //is output for this module on or off?
+
+
+
+
+
Layouts
+
+
So, we've seen Controllers, Models, and Helpers. In a typical PHP MVC system, after we've manipulated our Models we would
+
+
+
Set some variables for our view
+
The system would load a default "outer" HTML layout>
+
The system would then load our view inside that outer layout
+
+
+
However, if you look at a typical Magento Controller action, you don't see any of this:
Instead, the Controller action ends with two calls
+
+
+$this->loadLayout();
+$this->renderLayout();
+
+
+
So, the "V" in Magento's MVC already differs from what you're probably used to, in that you need to explicitly kick off rendering the layout.
+
+
The layout itself also differs. A Magento Layout is an object that contains a nested/tree collection of "Block" objects. Each Block object will render a specific bit of HTML. Block objects do this through a combination of PHP code, and including PHP .phtml template files.
+
+
Blocks objects are meant to interact with the Magento system to retrieve data from Models, while the phtml template files will produce the HTML needed for a page.
+
+
For example, the page header Block app/code/core/Mage/Page/Block/Html/Head.php uses the head.phtml file page/html/head.phtml.
+
+
Another way of thinking about it is the Block classes are almost like little mini-controllers, and the .phtml files are the view.
+
+
By default, when you call
+
+
+$this->loadLayout();
+$this->renderLayout();
+
+
+
Magento will load up a Layout with a skeleton site structure. There will be Structure Blocks to give you your html, head, and body, as well as HTML to setup single or multiple columns of Layout. Additionally, there will be a few Content Blocks for the navigation, default welcome message, etc.
+
+
"Structure" and "Content" are arbitrary designations in the Layout system. A Block doesn't programmatically know if it's Structure or Content, but it's useful to think of a Block as one or the other.
+
+
To add Content to this Layout you need to tell the Magento system something like
+
+
"Hey, Magento, add these additional Blocks under the "content" Block of the skeleton"
+
+or
+
+
"Hey, Magento, add these additional Blocks under the "left column" Block of the skeleton"
+
+
This can be done programmatically in a Controller action
but more commonly (at least in the frontend cart application), is use of the XML Layout system.
+
+
The Layout XML files in a theme allow you, on a per Controller basis, to remove Blocks that would normally be rendered, or add Blocks to that default skeleton areas. For example, consider this Layout XML file:
It's saying in the catalog Module, in the category Controller, and the default Action, insert the catalog/navigation Block into the "left" structure Block, using the catalog/navigation/left.phtml template.
+
+
One last important thing about Blocks. You'll often see code in templates that looks like this:
+$this->getChildHtml('order_items')
+
+
This is how a Block renders a nested Block. However, a Block can only render a child Block if the child Block is included as a nested Block in the Layout XML file. In the example above our catalog/navigation Block has no nested Blocks. This means any call to $this->getChildHtml() in left.phtml will render as blank.
From the catalog/navigation Block, we'd be able to call
+$this->getChildHtml('foobar');
+
+
+
+
Observers
+
+
Like any good object-oriented system, Magento implements an Event/Observer pattern for end users to hook into. As certain actions happen during a Page request (a Model is saved, a user logs in, etc.), Magento will issue an event signal.
+
+
When creating your own Modules, you can "listen" for these events. Say you wanted to get an email every time a certain customer logged into the store. You could listen for the "customer_login" event (setup in config.xml)
and then write some code that would run whenever a user logged in:
+
+
+class Packagename_Mymodule_Model_Observer
+{
+ public function iSpyWithMyLittleEye($observer)
+ {
+ $data = $observer->getData();
+ //code to check observer data for our user,
+ //and take some action goes here
+ }
+}
+
+
+
+
Class Overrides
+
+
Finally, the Magento System offers you the ability to replace Model, Helper and Block classes from the core modules with your own. This is a feature that's similar to "Duck Typing" or "Monkey Patching" in a language like Ruby or Python.
+
+
Here's an example to help you understand. The Model class for a product is Mage_Catalog_Model_Product.
+
+
Whenever the following code is called, a Mage_Catalog_Model_Product object is created
+
+
$product = Mage::getModel('catalog/product');
+
+
This is a factory pattern.
+
+
What Magento's class override system does is allow you to tell the system
+
+
"Hey, whenever anyone asks for a catalog/product, instead of giving them a Mage_Catalog_Model_Product,
+give them a Packagename_Modulename_Model_Foobazproduct instead".
+
+
Then, if you want, your Packagename_Modulename_Model_Foobazproduct class can extend the original product class
Which will allow you to change the behavior of any method on the class, but keep the functionality of the existing methods.
+
+
class Packagename_Modulename_Model_Foobazproduct extends Mage_Catalog_Model_Product
+{
+ public function validate()
+ {
+ //add custom validation functionality here
+ return $this;
+ }
+
+}
+
+
+
As you might expect, this overriding (or rewriting) is done in the config.xml file.
+
+
+<models>
+ <!-- does the override for catalog/product-->
+ <catalog>
+ <rewrite>
+ <product>Packagename_Modulename_Model_Foobazproduct</product>
+ </rewrite>
+ </catalog>
+</models>
+
+
+
One thing that's important to note here. Individual classes in your Module are overriding individual classes in other Modules. You are not, however, overriding the entire Module. This allows you to change specific method behavior without having to worry what the rest of the Module is doing.
+
+
+
+
Wrap Up
+
+
We hope you've enjoyed this whirlwind tour of some of the features the Magento eCommerce system offers to developers. It can be a little overwhelming at first, especially if this is your first experience with a modern, object-oriented PHP system. If you start to get frustrated, take a deep breath, remind yourself that this is new, and new things are hard, but at the end of the day it's just a different way of coding. Once you get over the learning curve you'll find yourself loath to return to other, less powerful systems.
+
+
+
\ No newline at end of file
diff --git a/guides/v1.8/magefordev/mage-for-dev-2.html b/guides/v1.8/magefordev/mage-for-dev-2.html
new file mode 100644
index 0000000000..a564773c23
--- /dev/null
+++ b/guides/v1.8/magefordev/mage-for-dev-2.html
@@ -0,0 +1,237 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento for Developers: Part 2—The Magento Config
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
The config is the beating heart of the Magento System. It describes, in whole, almost any module, model, class, template, etc. than you'll need to access. It's a level of abstraction that most PHP developers aren't used to working with, and while it adds development time in the form of confusion and head scratching, it also allows you an unprecedented amount of flexibility as far as overriding default system behaviors go.
+
+
To start with, we're going to create a Magento module that will let us view the system config in our web browser. Follow along by copying and pasting the code below, it's worth going through on your own as a way to start getting comfortable with things you'll be doing while working with Magento, as well as learning key terminology.
We're going to be creating a Magento module. A module is a group of php and xml files meant to extend the system with new functionality, or override core system behavior. This may meaning adding additional data models to track sales information, changing the behavior of existing classes, or adding entirely new features.
+
+
It's worth noting that most of the base Magento system is built using the same module system you'll be using. If you look in
+
+
app/code/core/Mage
+
+
each folder is a separate module built by the Magento team. Together, these modules form the community shopping cart system you're using. Your modules should be placed in the following folder
+
+
app/code/local/Packagename
+
+
"Packagename" should be a unique string to Namespace/Package your code. It's an unofficial convention that this should be the name of your company. The idea is to pick a string that no one else in the world could possibly be using.
+
+
app/code/local/Microsoft
+
+
We'll use "Magentotutorial".
+
+
So, to add a module to your Magento system, create the following directory structure
That's it. You now have a bare bones module that won't do anything, but that Magento will be aware of. To make sure you've done everything right, do the following:
+
+
Clear your Magento cache
+
In the Magento Admin, go to System->Configuration->Advanced
+
In the "Disable modules output" panel verify that Magentotutorial_Configviewer shows up
+
+
+
Congratulations, you've built your first Magento module!
+
+
+
Creating a Module Config
+
+
Of course, this module doesn't do anything yet. When we're done, our module will
+
+
Check for the existence of a "showConfig" query string variable
+
If showConfig is present, display our Magento config and halt normal execution
+
Check for the existence of an additional query string variable, showConfigFormat that will let us specify text or xml output.
+
+
+
First, we're going to add the following <global> section to our config.xml file.
That's it. Clear your Magento cache again and then load any Magento URL with a showConfig=true query string
+
+
http://magento.example.com/?showConfig=true
+
+
+
What am I looking at?
+
+
You should be looking at a giant XML file. This describes the state of your Magento system. It lists all modules, models, classes, event listeners or almost anything else you could think of.
+
+
For example, consider the config.xml file you created above. If you search the XML file in your browser for the text Configviewer_Model_Observer you'll find your class listed. Every module's config.xml file is parsed by Magento and included in the global config.
+
+
+
Why Do I Care?
+
+
Right now this may seem esoteric, but this config is key to understanding Magento. Every module you'll be creating will add to this config, and anytime you need to access a piece of core system functionality, Magento will be referring back to the config to look something up.
+
+
A quick example: As an MVC developer, you've likely worked with some kind of helper class, instantiated something like
+
+
+$helper_sales = new HelperSales();
+
+
+
One of the things Magento has done is abstract away PHP's class declaration. In Magento, the above code looks something like
+
+
+$helper_sales = Mage::helper('sales');
+
+
+
In plain english, the static helper method will:
+
+
Look in the <helpers /> section of the Config.
+
Within <helpers />, look for a <sales /> section
+
Within the <sales /> section look for a <class /> section
+
Append the part after the slash to the value found in #3 (defaulting to data in this case)
+
Instantiate the class found in #4 (Mage_Sales_Helper_Data)
+
+
+
While this seems like a lot of work (and it is), the key advantage is by always looking to the config file for class names, we can override core Magento functionality without changing or adding to the core code. This level of meta programming, not usually found in PHP, allows you to cleanly extend only the parts of the system you need to.
diff --git a/guides/v1.8/magefordev/mage-for-dev-3.html b/guides/v1.8/magefordev/mage-for-dev-3.html
new file mode 100644
index 0000000000..3376414223
--- /dev/null
+++ b/guides/v1.8/magefordev/mage-for-dev-3.html
@@ -0,0 +1,318 @@
+---
+---
+
+
+
+
+
+
+
+
+
+ Magento for Developers: Part 3—Magento Controller Dispatch
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
+
+
Magento for Developers: Part 3—Magento Controller Dispatch
The Model-View-Controller (MVC) architecture traces its origins back to the Smalltalk Programming language and Xerox Parc. Since then, there have been many systems that describe their architecture as MVC. Each system is slightly different, but all have the goal of separating data access, business logic, and user-interface code from one another.
+
+
The architecture of most PHP MVC frameworks will looks something like this.
+
+
+
A URL is intercepted by a single PHP file (usually called a Front Controller).
+
This PHP file will examine the URL, and derive a Controller name and an Action name (a process that's often called routing).
+
The derived Controller is instantiated.
+
The method name matching the derived Action name is called on the Controller.
+
This Action method will instantiate and call methods on models, depending on the request variables.
+
The Action method will also prepare a data structure of information. This data structure is passed on to the view.
+
The view then renders HTML, using the information in the data structure it has received from the Controller.
+
+
+
While this pattern was a great leap forward from the "each php file is a page" pattern established early on, for some software engineers, it's still an ugly hack. Common complaints are:
+
+
+
The Front Controller PHP file still operates in the global namespace.
+
Convention over configuration leads to less modularity.
+
+
URLs routing is often inflexible.
+
Controllers are often bound to specific views.
+
Even when a system offers a way to override these defaults, the convention leads to applications where it's difficult/impossible to drop in a new model, view, or Controller implementation without massive re-factoring.
+
+
+
+
As you've probably guessed, the Magento team shares this world view and has created a more abstract MVC pattern that looks something like this:.
+
+
+
A URL is intercepted by a single PHP file.
+
This PHP file instantiates a Magento application.
+
The Magento application instantiates a Front Controller object.
+
Front Controller instantiates any number of Router objects (specified in global config).
+
Routers check the request URL for a "match".
+
If a match is found, an Action Controller and Action are derived.
+
The Action Controller is instantiated and the method name matching the Action Name is called.
+
This Action method will instantiate and call methods on models, depending on the request.
+
This Action Controller will then instantiate a Layout Object.
+
This Layout Object will, based some request variables and system properties (also known as "handles"), create a list of Block objects that are valid for this request.
+
Layout will also call an output method on certain Block objects, which start a nested rendering (Blocks will include other Blocks).
+
Each Block has a corresponding Template file. Blocks contain PHP logic, templates contain HTML and PHP output code.
+
Blocks refer directly back to the models for their data. In other words, the Action Controller does not pass them a data structure.
+
+
+
We'll eventually touch on each part of this request, but for now we're concerned with the Front Controller -> Routers -> Action Controller section.
+
+
+
Hello World
+
Enough theory, it's time for Hello World. We're going to
+
+
Create a Hello World module in the Magento system
+
Configure this module with routes
+
Create Action Controller(s) for our routes
+
+
+
Create Hello World Module
+
+
First, we'll create a directory structure for this module. Our directory structure should look as follows:
+
+
In the Magento Admin, go to System->Configuration->Advanced.
+
Expand "Disable Modules Output" (if it isn't already).
+
Ensure that Magentotutorial_Helloworld shows up.
+
+
+
Configuring Routes
+
+
Next, we're going to configure a route. A route will turn a URL into an Action Controller and a method. Unlike other convention based PHP MVC systems, with Magento you need to explicitly define a route in the global Magento config.
+
+
In your config.xml file(at path app/code/local/Magentotutorial/Helloworld/etc/config.xml), add the following section:
+
+
We have a lot of new terminology here, let's break it down.
+
+
What is a <frontend>?
+
+
The <frontend> tag refers to a Magento Area. For now, think of Areas as individual Magento applications. The "frontend" Area is the public facing Magento shopping cart application. The "admin" Area is the private administrative console application. The "install" Area is the application you use to run though installing Magento the first time.
+
+
Why a <routers> tags if we're configuring individual routes?
+
+
There's a famous quote about computer science, often attributed to Phil Karlton:
+
+
"There are only two hard things in Computer Science: cache invalidation and naming things"
+
+
+
Magento, like all large systems, suffers from the naming problem in spades. You'll find there are many places in the global config, and the system in general, where the naming conventions seem unintuitive or even ambiguous. This is one of those places. Sometimes the <routers> tag will enclose configuration information about routers, other times it will enclose configuration information about the actual router objects that do the routing. This is going to seem counter intuitive at first, but as you start to work with Magento more and more, you'll start to understand its world view a little better. (Or, in the words of Han Solo, "Hey, trust me!").
+
+
What is a <frontName>?
+
+
When a router parses a URL, it gets separated as follows
So, by defining a value of "helloworld" in the <frontName> tags, we're telling Magento that we want the system to respond to URLs in the form of
+
+
http://example.com/helloworld/*
+
+
Many developers new to Magento confuse this frontName with the Front Controller object. They are not the same thing. The frontName belongs solely to routing.
+
+
What's the <helloworld> tag for?
+
+
This tag should be the lowercase version of you module name. Our module name is Helloworld, this tag is helloworld. Technically this tag defines our route name
+
+
You'll also notice our frontName matches our module name. It's a loose convention to have frontNames match the module names, but it's not a requirement. In your own modules, it's probably better to use a route name that's a combination of your module name and package name to avoid possible namespace collisions.
This module tag should be the full name of your module, including its package/namespace name. This will be used by the system to locate your Controller files.
+
+
Create Action Controller(s) for our Routes
+
+
One last step to go, and we'll have our Action Controller. Create a file at
+
+
the URI portion "helloworld" is the frontName, which is followed by index (The Action Controller name), which is followed by another index, which is the name of the Action Method that will be called. (an Action of index will call the method public function indexAction(){...}.
+
+
If a URL is incomplete, Magento uses "index" as the default, which is why the following URLs are equivalent.
+
Consult the global config to find the module to use for the frontName checkout (Mage_Checkout)
+
Look for the cart Action Controller (Mage_Checkout_CartController)
+
Call the addAction method on the cart Action Controller
+
+
+
Other Action Controller Tricks
+
+
Let's try adding a non-default method to our Action Controller. Add the following code to IndexController.php
+
+
+public function goodbyeAction() {
+ echo 'Goodbye World!';
+}
+
+
+
And then visit the URL to test it out:
+
http://example.com/helloworld/index/goodbye
+
+
Because we're extending the Mage_Core_Controller_Front_Action class, we get some methods for free. For example, additional URL elements are automatically parsed into key/value pairs for us. Add the following method to your Action Controller.
+
+
with an Action Controller named Magentotutorial_Helloworld_MessagesController and an Action Method that looked something like
+
+public function goodbyeAction()
+{
+ echo 'Another Goodbye';
+}
+
+
+
And that, in a nutshell, is how Magento implements the Controller portion of MVC. While it's a little more complicated than other PHP MVC framework's, it's a highly flexible system that will allow you build almost any URL structure you want.
diff --git a/guides/v1.8/magefordev/mage-for-dev-4.html b/guides/v1.8/magefordev/mage-for-dev-4.html
new file mode 100644
index 0000000000..358391e48d
--- /dev/null
+++ b/guides/v1.8/magefordev/mage-for-dev-4.html
@@ -0,0 +1,487 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento for Developers: Part 4—Magento Layouts, Blocks and Templates
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
+
+
Magento for Developers: Part 4—Magento Layouts, Blocks and Templates
Developers new to Magento are often confused by the Layout and View system. This article will take a look at Magento's Layout/Block approach, and show you how it fits into Magento MVC worldview.
+
+
Unlike many popular MVC systems, Magento's Action Controller does not pass a data object to the view or set properties on the view object (with a few exceptions). Instead, the View component directly references system models to get the information it needs for display.
+
+
One consequence of this design decision is that the View has been separated into Blocks and Templates. Blocks are PHP objects, Templates are "raw" PHP files (with a .phtml extension) that contain a mix of HTML and PHP (where PHP is used as a templating language). Each Block is tied to a single Template file. Inside a phtml file, PHP's $this keyword will contain a reference to the Template's Block object.
+
+
+
A quick example
+
+
Take a look at the default product Template at the file at
The block's _getProductCollection then instantiates models and reads their data, returning a result to the template.
+
+
Nesting Blocks
+
+
The real power of Blocks/Templates come with the getChildHtml method. This allows you to include the contents of a secondary Block/Template inside of a primary Block/Template.
+
+
Blocks calling Blocks calling Blocks is how the entire HTML layout for your page is created. Take a look at the one column layout Template.
The template itself is only 28 lines long. However, each call to $this->getChildHtml(...) will include and render another Block. These Blocks will, in turn, use getChildHtml to render other Blocks. It's Blocks all the way down.
+
+
The Layout
+
+
So, Blocks and Templates are all well and good, but you're probably wondering
+
+
+
How do I tell Magento which Blocks I want to use on a page?
+
How do I tell Magento which Block I should start rendering with?
+
How do I specify a particular Block in getChildHtml(...)? Those argument strings don't look like Block names to me.
+
+
+
This is where the Layout Object enters the picture. The Layout Object is an XML object that will define which Blocks are included on a page, and which Block(s) should kick off the rendering process.
+
+
Last time we were echoing content directly from our Action Methods. This time let's create a simple HTML template for our Hello World module.
Clear your Magento cache and reload your Hello World controller page. You should now see a website with a bright red background and an HTML source that matches what's in simple_page.phtml.
+
+
What's Going On
+
+
So, that's a lot of voodoo and cryptic incantations. Let's take a look at what's going on.
+
+
First, you'll want to install the Layoutviewer module. This is a module similar to the Configviewer module you built in the Hello World article that will let us peek at some of Magento's internals.
+
+
Once you've installed the module (similar to how you setup the Configviewer module), go to the following URL
This is the layout xml for your page/request. It's made up of <block />, <reference /> and <remove /> tags. When you call the loadLayout method of your Action Controller, Magento will
+
+
+
Generate this Layout XML
+
Instantiate a Block class for each <block /> tag, looking up the class using the tag's type attribute as a global config path and store it in the internal _blocks array of the layout object, using the tag's name attribute as the array key.
+
If the <block /> tag contains an output attribute, its value is added to the internal _output array of the layout object.
+
+
+
Then, when you call the renderLayout method in your Action Controller, Magento will iterate over all the Blocks in the _output array, using the value of the output attribute as a callback method. This is always toHtml, and means the starting point for output will be that Block's Template.
+
+
The following sections will cover how Blocks are instantiated, how this layout file is generated, and finishes up with kicking off the output process.
+
+
Block Instantiation
+
+
So, within a Layout XML file, a <block /> has a "type" that's actually a Grouped Class Name URI
The URI references a location in the (say it with me) global config. The first portion of the URI (in the above examples page) will be used to query the global config to find the page class name. The second portion of the URI (in the two examples above, html and template_links) will be appended to the base class name to create the class name Magento should instantiate.
+
+
We'll go through page/html as an example. First, Magento looks for the global config node at file
This gives us our base class prefix Mage_Page_Block. Then, the second part of the URI (html) is appended to the class name to give us our final Block class name Mage_Page_Block_Html. This is the class that will be instantiated.
+
+
If we create a block with the same name as an already existing block, the new block instance will replace the original instance. This is what we've done in our local.xml file from above.
The Block named root has been replaced with our Block, which points at a different phtml Template file.
+
+
Using references
+
+
<reference name="" /> will hook all contained XML declarations into an existing block with the specified name. Contained <block /> nodes will be assigned as child blocks to the referenced parent block.
Even though the root block is declared in a separate layout XML file, the new block is added as a child block. Magento initially creates a page/html Block named root. Then, when it later encounters the reference with the same name (root), it will assign the new block some.other.block.name as a child of the root block.
+
+
+
How Layout Files are Generated
+
+
So, we have a slightly better understanding of what's going on with the Layout XML, but where is this XML file coming from? To answer that question, we need to introduce two new concepts; Handles and the Package Layout.
+
+
Handles
+
+
Each page request in Magento will generate several unique Handles. The Layoutview module can show you these Handles by using a URL something like
You should see a list similar to the following (depending on your configuration)
+
+
+
default
+
STORE_bare_us
+
THEME_frontend_default_default
+
helloworld_index_index
+
customer_logged_out
+
+
+
Each of these is a Handle. Handles are set in a variety of places within the Magento system. The two we want to pay attention to are default and helloworld_index_index. The default Handle is present in every request into the Magento system. The helloworld_index_index Handle is created by combining the route name (helloworld), Action Controller name (index), and Action Controller Action Method (index) into a single string. This means each possible method on an Action Controller has a Handle associated with it.
+
+
Remember that "index" is the Magento default for both Action Controllers and Action Methods, so the following request
+
+
http://example.com/helloworld/?showLayout=handles
+
+
Will also produce a Handle named helloworld_index_index
+
+
Package Layout
+
+
You can think of the Package Layout similar to the global config. It's a large XML file that contains every possible layout configuration for a particular Magento install. Let's take a look at it using the Layoutview module
You should see a very large XML file. This is the Package Layout. This XML file is created by combining the contents of all the XML layout files for the current theme (or package). For the default install, this is at
+
+
app/design/frontend/base/default/layout/
+
+
Behind the scenes there are <frontend><layout><updates /> and <adminhtml><layout><updates /> sections of the global config that contains nodes with all the file names to load for the respective area. Once the files listed in the config have been combined, Magento will merge in one last xml file, local.xml. This is the file where you're able to add your customizations to your Magento install.
+
+
Combining Handles and The Package Layout
+
+
So, if you look at the Package Layout, you'll see some familiar tags such as <block /> and <reference />, but they're all surrounded by tags that look like
These are all Handle tags. The Layout for an individual request is generated by grabbing all the sections of the Package Layout that match any Handles for the request. So, in our example above, our layout is being generated by grabbing tags from the following sections
There's one additional tag you'll need to be aware of in the Package Layout. The <update /> tag allows you to include another Handle's tags. For example
to local.xml means we've overridden the "root" tag. with a different Block. By placing this in the <default /> Handle we've ensured that this override will happen for every page request in the system. That's probably not what we want.
+
+
+
If you go to any other page in your Magento site, you'll notice they're either blank white, or have the same red background that your hello world page does. Let's change your local.xml file so it only applies to the hello world page. We'll do this by changing default to use the full action name handle (helloworld_index_index).
Clear your Magento cache, and the rest of your pages should be restored.
+
+
Right now this only applies to our index Action Method. Let's add it to the goodbye Action Method as well. In your Action Controller, modify the goodbye action so it looks like
+
+public function goodbyeAction() {
+ $this->loadLayout();
+ $this->renderLayout();
+}
+
+
+
If you load up the following URL, you'll notice you're still getting the default Magento layout.
+
+
http://example.com/helloworld/index/goodbye
+
+
We need to add a Handle for the full action name (helloworld_index_goodbye) to our local.xml file. Rather than specify a new <block />, lets use the update tag to include the helloworld_index_index Handle.
A simple red page is pretty boring. Let's add some content to this page. Change your <helloworld_index_index /> Handle in local.xml so it looks like the following
We're adding a new Block nested within our root. This is a Block that's distributed with Magento, and will display a customer registration form. By nesting this Block within our root Block, we've made it available to be pulled into our simple_page.html Template. Next, we'll use the Block's getChildHtml method in our simple_page.phtml file. Edit simple_page.html so it looks like this
Clear your Magento cache and reload the page and you should see the customer registration form on your red background. Magento also has a Block named top.links. Let's try including that. Change your simple_page.html file so it reads
When you reload the page, you'll notice that your <h1>Links</h1> title is rendering, but nothing is rendering for top.links. That's because we didn't add it to local.xml. The getChildHtml method can only include Blocks that are specified as sub-Blocks in the Layout. This allows Magento to only instantiate the Blocks it needs, and also allows you to set difference Templates for Blocks based on context.
Clear your cache and reload the page. You should now see the top.links module.
+
+
Time for action
+
+
There is one more important concept to cover before we wrap up this lesson, and that is the <action /> tag. Using the <action /> tag enables us to call public PHP methods of the block classes. So instead of changing the template of the root block by replacing the block instance with our own, we can use a call to setTemplate instead.
This layout XML will first set the template property of the root block, and then will add the two blocks we use as child blocks. Once we clear the cache, the result should look just as before. The benefit of using the <action /> is the same block instance is used that was created earlier, and all other parent/child associations still exist. For that reason this is a more upgrade proof way of implementing our changes.
+
+
All arguments to the action's method need to be wrapped in an individual child node of the <action /> tag. The name of that node doesn't matter, only the order of the nodes. We could have written the action node from the previous example as follows with the same effect.
+
This is just to illustrate that the action's argument node names are arbitrary.
+
+
Wrapup
+
+
That covers Layout fundamentals. We have covered the tags <block />, <reference />, <update /> and <action />, and also layout update handles like <default /> and <cms_index_index />. These make up most of the layout configuration used in Magento. If you found it somewhat daunting, don't worry, you'll rarely need to work with layouts on such a fundamental level. Magento provides a number of pre-built layouts which can be modified and skinned to meet the needs of your store. Understanding how the entire Layout system works can be a great help when you're trouble shooting Layout issues, or adding new functionality to an existing Magento system.
diff --git a/guides/v1.8/magefordev/mage-for-dev-5.html b/guides/v1.8/magefordev/mage-for-dev-5.html
new file mode 100644
index 0000000000..8fa7cdefe1
--- /dev/null
+++ b/guides/v1.8/magefordev/mage-for-dev-5.html
@@ -0,0 +1,458 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento for Developers: Part 5—Magento Models and ORM Basics
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
Magento for Developers: Part 5—Magento Models and ORM Basics
The implementation of a "Models Tier" is a huge part of any MVC framework. It represents the data of your application, and most applications are useless without data. Magento Models play an even bigger role, as they typically contain the "Business Logic" that's often relegated to the Controller or Helper methods in other PHP MVC frameworks.
+
+
Traditional PHP MVC Models
+
+
If the definition of MVC is somewhat fuzzy, the definition of a Model is even fuzzier. Prior to the wide adoption of the MVC pattern by PHP developers, data access was usually raw SQL statements and/or an SQL abstraction layer. Developers would write queries and not think too much about what objects they were modeling.
+
+
In this day and age, raw SQL is mostly frowned upon, but many PHP frameworks are still SQL centric. Models will be objects that provide some layer of abstraction, but behind the scenes developers are still writing SQL and/or calling SQL like abstraction methods to read and write-down their data.
+
+
Other frameworks eschew SQL and take the Object Relational Mapping (ORM) approach. Here, a developer is dealing strictly with Objects. Properties are set, and when a save method is called on the Object, the data is automatically written to the database. Some ORMs will attempt to divine object properties from the database, others require the user to specify them in some way, (usually in an abstract data language such as YAML). One of the most famous and popular implementations of this approach is ActiveRecord.
+
+
This definition of ORM should suffice for now, but like everything Computer Science these days, the strict definition of ORM has blurred over the years. It's beyond the scope of this article to settle that dispute, but suffice it say we're generalizing a bit.
+
+
Magento Models
+
+
It should be no surprise that Magento takes the ORM approach. While the Zend Framework SQL abstractions are available, most of your data access will be via the built in Magento Models, and Models you build yourself. It should also come as no surprise that Magento has a highly flexible, highly abstract, concept of what a Model is.
+
+
Anatomy of a Magento Model
+
+
Most Magento Models can be categorized in one of two ways. There's a basic, ActiveRecord-like/one-object-one-table Model, and there's also an Entity Attribute Value (EAV) Model. Each Model also gets a Model Collection. Collections are PHP objects used to hold a number of individual Magento Model instances. The Magento team has implemented the PHP Standard Library interfaces of IteratorAggregate and Countable to allow each Model type to have it's own collection type. If you're not familiar with the PHP Standard Library, think of Model Collections as arrays that also have methods attached.
+
+
Magento Models don't contain any code for connecting to the database. Instead, each Model uses a modelResource class, that is used to communicate with the database server (via one read and one write adapter object). By decoupling the logical Model and the code that talks to the database, it's theoretically possible to write new resource classes for a different database schemas and platforms while keeping your Models themselves untouched.
+
+
Enable developer mode
+
Something you should do in development—but never in production—is to enable Magento's developer mode which, among other things, displays exceptions in your browser. It's useful for debugging your code.
+
Enable developer mode in any of the following ways:
Edit the .htaccess in the Magento root directory file to add SetEnv MAGE_IS_DEVELOPER_MODE "true"
+
+
Creating a Basic Model
+
+
To begin, we're going to create a basic Magento Model. PHP MVC tradition insists we model a weblog post. The steps we'll need to take are
+
+
+
Create a new "Weblog" module
+
Create a database table for our Model
+
Add Model information to the config for a Model named Blogpost
+
Add Model Resource information to the config for the Blogpost Model
+
Add a Read Adapter to the config for the Blogpost Model
+
Add a Write Adapter to the config for the Blogpost Model
+
Add a PHP class file for the Blogpost Model
+
Add a PHP class file for the Blogpost Resource Model
+
Instantiate the Model
+
+
+
Create a Weblog Module
+
+
You should be an old hat at creating empty modules at this point, so we'll skip the details and assume you can create an empty module named Weblog. After you've done that, we'll setup a route for an index Action Controller with an action named "testModel". As always, the following examples assume a Package Name of "Magentotutorial".
+
+
In `Magentotutorial/Weblog/etc/config.xml`, setup the following route
+class Magentotutorial_Weblog_IndexController extends Mage_Core_Controller_Front_Action {
+ public function testModelAction() {
+ echo 'Setup!';
+ }
+}
+
+
+
at Magentotutorial/Weblog/controllers/IndexController.php. Clear your Magento cache and load the following URL to ensure everything's been setup correctly.
+
+
http://example.com/weblog/index/testModel
+
+
You should see the word "Setup" on a white background.
+
+
Creating the Database Table
+
+
Magento has a system for automatically creating and changing your database schemas, but for the time being we'll just manually create a table for our Model.
+
+
Using the command-line or your favorite MySQL GUI application, create a table with the following schema
INSERT INTO `blog_posts` VALUES (1,'My New Title','This is a blog post','2010-07-01 00:00:00','2010-07-02 23:12:30');
+
+
The Global Config and Creating The Model
+
+
There are three individual things we need to setup for a Model in our config.
+
+
+
Enabling Models in our Module
+
Enabling Model Resources in our Module
+
Add an "entity" table configuration to our Model Resource.
+
+
+
When you instantiate a Model in Magento, you make a call like this
+
+
$model = Mage::getModel('weblog/blogpost');
+
+
The first part of the URI you pass into get Model is the Model Group Name. Because it is a good idea to follow conventions, this should be the (lowercase) name of your module, or to be safeguarded against conflicts use the packagename and modulename (also in lowercase). The second part of the URI is the lowercase version of your Model name.
+
+
So, let's add the following XML to our module's `config.xml`.
+
+<global>
+ <!-- ... -->
+ <models>
+ <weblog>
+ <class>Magentotutorial_Weblog_Model</class>
+ <!--
+ need to create our own resource, can't just
+ use core_resource
+ -->
+ <resourceModel>weblog_resource</resourceModel>
+ </weblog>
+ </models>
+ <!-- ... -->
+</global>
+
+
+
The outer <weblog /> tag is your Group Name, which should match your module name. <class /> is the BASE name all Models in the weblog group will have, also called Class Prefix. The <resourceModel /> tag indicates which Resource Model that weblog group Models should use. We talk more about this later on in this page. For now, remember your Group Name and the literal string "resource".
+
+
So, we're not done yet, but let's see what happens if we clear our Magento cache and attempt to instantiate a blogpost Model. In your `testModelAction` method, use the following code
+
+ public function testModelAction() {
+ $blogpost = Mage::getModel('weblog/blogpost');
+ echo get_class($blogpost);
+ }
+
+
+
and reload your page. You should see an error like the following:
+
+
+include(Magentotutorial/Weblog/Model/Blogpost.php) [function.include]: failed to open stream: No such file or directory
+
+
+
By attempting to retrieve a weblog/blogpost Model, you told Magento to instantiate a class with the name
+
+
+Magentotutorial_Weblog_Model_Blogpost
+
+
+
Magento is trying to __autoload include this Model, but can't find the file. Let's create it! Create the following class at the following location
Reload your page, and the exception should be replaced with the name of your class.
+
+
All basic Models that interact with the database should extend the Mage_Core_Model_Abstract class. This abstract class forces you to implement a single method named _construct (NOTE: this is not PHP's constructor __construct). This method should call the class's _init method with the same identifying URI you'll be using in the Mage::getModel method call.
+
+
The Global Config and Resources
+
+
So, we've setup our Model. Next, we need to setup our Model Resource. Model Resources contain the code that actually talks to our database. In the last section, we included the following in our config.
+
+
+<resourceModel>weblog_resource</resourceModel>
+
+
+
The value in <resourceModel /> will be used to instantiate a Model Resource class. Although you'll never need to call it yourself, when any Model in the weblog group needs to talk to the database, Magento will make the following method call to get the Model resource
+
+
+Mage::getResourceModel('weblog/blogpost');
+
+
+
Again, weblog is the Group Name, and blogpost is the Model. The Mage::getResourceModel method will use the weblog/blogpost URI to inspect the global config and pull out the value in <resourceModel> (in this case, weblog_resource). Then, a model class will be instantiated with the following URI
+
+
+weblog_resource/blogpost
+
+
+
So, if you followed that all the way, what this means is, resource models are configured in the same section of the XML config as normal Models. This can be confusing to newcomers and old-hands alike.
+
+
So, with that in mind, let's configure our resource. In our <models> section add
You're adding the <weblog_resource /> tag, which is the value of the <resourceModel /> tag you just setup. The value of <class /> is the base name that all your resource models will have, and should be named with the following format
+
+
+Packagename_Modulename_Model_Resource
+
+
+
So, we have a configured resource, let's try loading up some Model data. Change your action to look like the following
+
+
+public function testModelAction() {
+ $params = $this->getRequest()->getParams();
+ $blogpost = Mage::getModel('weblog/blogpost');
+ echo("Loading the blogpost with an ID of ".$params['id']);
+ $blogpost->load($params['id']);
+ $data = $blogpost->getData();
+ var_dump($data);
+}
+
+
+
And then load the following URL in your browser (after clearing your Magento cache)
+
+
http://example.com/weblog/index/testModel/id/1
+
+
You should see an exception something like the following
+
+
Warning: include(Magentotutorial/Weblog/Model/Resource/Blogpost.php) [function.include]: failed to open stream: No such file ....
+
+
As you've likely intuited, we need to add a resource class for our Model. Every Model has its own resource class. Add the following class at the following location
Again, the first parameter of the init method is the URL used to identify the Model. The second parameter is the database field that uniquely identifies any particular column. In most cases, this should be the primary key. Clear your cache, reload, and you should see
+
+
Can't retrieve entity config: weblog/blogpost
+
+
Another exception! When we use the Model URI weblog/blogpost, we're telling Magento we want the Model Group weblog, and the blogpostEntity. In the context of simple Models that extend Mage_Core_Model_Resource_Db_Abstract, an entity corresponds to a table. In this case, the table named blog_post that we created above. Let's add that entity to our XML config.
We've added a new <entities /> section to the resource Model section of our config. This, in turn, has a section named after our entity (<blogpost />) that specifies the name of the database table we want to use for this Model.
+
+
Clear your Magento cache, cross your fingers, reload the page and ...
+
+
Loading the blogpost with an ID of 1
+
+array
+ 'blogpost_id' => string '1' (length=1)
+ 'title' => string 'My New Title' (length=12)
+ 'post' => string 'This is a blog post' (length=19)
+ 'date' => string '2009-07-01 00:00:00' (length=19)
+ 'timestamp' => string '2009-07-02 16:12:30' (length=19)
+
+
+
Eureka! We've managed to extract our data and, more importantly, completely configure a Magento Model.
+
+
Basic Model Operations
+
+
All Magento Models inherit from the Varien_Object class. This class is part of the Magento system library and not part of any Magento core module. You can find this object at
+
+
lib/Varien/Object.php
+
+
Magento Models store their data in a protected _data property. The Varien_Object class gives us several methods we can use to extract this data. You've already seen getData, which will return an array of key/value pairs. This method can also be passed a string key to get a specific field.
+
+
+$model->getData();
+$model->getData('title');
+
+
+
There's also a getOrigData method, which will return the Model data as it was when the object was initially populated, (working with the protected _origData method).
The Varien_Object also implements some special methods via PHP's magic __call method. You can get, set, unset, or check for the existence of any property using a method that begins with the word get, set, unset or has and is followed by the camel cased name of a property.
For this reason, you'll want to name all your database columns with lower case characters and use underscores to separate characters.
+
+
CRUD, the Magento Way
+
+
Magento Models support the basic Create, Read, Update, and Delete functionality of CRUD with load, save, and delete methods. You've already seen the load method in action. When passed a single parameter, the load method will return a record whose id field (set in the Model's resource) matches the passed in value.
+
+
$blogpost->load(1);
+
+
The save method will allow you to both INSERT a new Model into the database, or UPDATE an existing one. Add the following method to your Controller
+
+
+public function createNewPostAction() {
+ $blogpost = Mage::getModel('weblog/blogpost');
+ $blogpost->setTitle('Code Post!');
+ $blogpost->setPost('This post was created from code!');
+ $blogpost->save();
+ echo 'post with ID ' . $blogpost->getId() . ' created';
+}
+
+
+
and then execute your Controller Action by loading the following URL
+
+
http://example.com/weblog/index/createNewPost
+
+
You should now see an additional saved post in your database table. Next, try the following to edit your post
So, having a single Model is useful, but sometimes we want to grab list of Models. Rather than returning a simple array of Models, each Magento Model type has a unique collection object associated with it. These objects implement the PHP IteratorAggregate and Countable interfaces, which means they can be passed to the count function, and used in for each constructs.
+
+
We'll cover Collections in full in a later article, but for now let's look at basic setup and usage. Add the following action method to your Controller, and load it in your browser.
Warning: include(Magentotutorial/Weblog/Model/Resource/Blogpost/Collection.php) [function.include]: failed to open stream
+
+
You're not surprised, are you? We need to add a PHP class file that defines our Blogpost collection. Every Model has a protected property named _resourceCollectionName that contains a URI that's used to identify our collection.
By default, this is the same URI that's used to identify our Resource Model, with the string "_collection" appended to the end. Magento considers Collections part of the Resource, so this URI is converted into the class name.
Just as with our other classes, we need to init our Collection with the Model URI. (weblog/blogpost). Rerun your Controller Action, and you should see your post information.
+
+
Wrapup
+
+
Congratulations, you've created and configured your first Magento Model. In a later article we'll take a look at Magento's Entity Attribute Value Models (EAV), which expand on what we've learned here.
+
+
\ No newline at end of file
diff --git a/guides/v1.8/magefordev/mage-for-dev-6.html b/guides/v1.8/magefordev/mage-for-dev-6.html
new file mode 100644
index 0000000000..6ceb527cde
--- /dev/null
+++ b/guides/v1.8/magefordev/mage-for-dev-6.html
@@ -0,0 +1,408 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento for Developers: Part 6—Magento Setup Resources
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
Magento for Developers: Part 6—Magento Setup Resources
On any fast paced software development project, the task of keeping the development and production databases in sync become a sticky wicket. Magento offers a system to create versioned resource migration scripts that can help your team deal with this often contentious part of the development process.
+
+
In the ORM article we created a model for a weblog post. At the time, we ran our CREATE TABLE statements directly against the database. This time, we'll create a Setup Resource for our module that will create the table for us. We'll also create an upgrade script for our module that will update an already installed module. The steps we'll need to take are
+
+
+
Add the Setup Resource to our config
+
Create our resource class file
+
Create our installer script
+
Create our upgrade script
+
+
+
+
Adding the Setup Resource
+
So, let's continue with the weblog module we created last time. In our <global /> section, add the following
The <weblog_setup> tag will be used to uniquely identify this Setup Resource. It's encouraged, but not necessary, that you use the modelname_setup naming convention. The <module>Magentotutorial_Weblog</module> tag block should contain the Packagename_Modulename of your module. Finally, <class>Magentotutorial_Weblog_Model_Resource_Setup</class> should contain the name of the class we'll be creating for our Setup Resource. For basic setup scripts it's not necessary to create a custom class, but by doing it now you'll give yourself more flexibility down the line.
+
+
After adding the above section to your config, clear your Magento cache and try to load any page of your Magento site. You'll see an exception something like
+
+
Fatal error: Class 'Magentotutorial_Weblog_Model_Resource_Setup' not found in
+
+
Magento just tried to instantiate the class you specified in your config, but couldn't find it. You'll want to create the following file, with the following contents.
Now, reload any page of your Magento site. The exception should be gone, and your page should load as expected.
+
+
Creating our Installer Script
+
+
Next, we'll want to create our installer script. This is the script that will contain any CREATE TABLE or other SQL code that needs to be run to initialize our module.
This section is required in all config.xml files, and identifies the module as well as the its version number. Your installer script's name will be based on this version number. The following assumes the current version of your module is 0.1.0.
+
+
Create the following file at the following location
+echo 'Running This Upgrade: '.get_class($this)."\n <br /> \n";
+die("Exit for now");
+
+
+
The weblog_setup portion of the path should match the tag you created in your config.xml file (<weblog_setup />). The 0.1.0 portion of the filename should match the starting version of your module. Clear your Magento cache and reload any page in your Magento site and you should see something like
+
+
+Running This Upgrade: Magentotutorial_Weblog_Model_Resource_Setup
+Exit for now
+ ...
+
+
+
Which means your update script ran. Eventually we'll put our SQL update scripts here, but for now we're going to concentrate on the setup mechanism itself. Remove the "die" statement from your script so it looks like the following
+
+
echo 'Running This Upgrade: '.get_class($this)."\n <br /> \n";
+
+
Reload your page. You should see your upgrade message displayed at the top of the page. Reload again, and your page should be displayed as normal.
+
+
Resource Versions
+
+
Magento's Setup Resources allow you to simply drop your install scripts (and upgrade scripts, which we'll get to in a bit) onto the server, and have the system automatically run them. This allows you to have all your database migrations scripts stored in the system in a consistent format.
+
+
Using your favorite database client, take a look at the core_setup table
This table contains a list of all the installed modules, along with the installed version number. You can see our module near the end
+
+
| weblog_setup | 0.1.0 | 0.1.0 |
+
+
This is how Magento knows not to re-run your script on the second, and on all successive, page loads. The weblog_setup is already installed, so it won't be updated. If you want to re-run your installer script (useful when you're developing), just delete the row for your module from this table. Let's do that now, and actually add the SQL to create our table. So first, run the following SQL.
+
+
DELETE from core_resource where code = 'weblog_setup';
+
+
We'll also want to drop the table we manually created in the ORM article.
+
+
DROP TABLE blog_posts;
+
+
Then, add the following code to your setup script.
+
+
$installer = $this;
+$installer->startSetup();
+$installer->run("
+ CREATE TABLE `{$installer->getTable('weblog/blogpost')}` (
+ `blogpost_id` int(11) NOT NULL auto_increment,
+ `title` text,
+ `post` text,
+ `date` datetime default NULL,
+ `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP,
+ PRIMARY KEY (`blogpost_id`)
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+ INSERT INTO `{$installer->getTable('weblog/blogpost')}` VALUES (1,'My New Title','This is a blog post','2009-07-01 00:00:00','2009-07-02 23:12:30');
+");
+$installer->endSetup();
+
+
+
Clear your Magento cache and reload any page in the system. You should have a new blog_posts table with a single row.
+
+
Anatomy of a Setup Script
+
+
So, let's go over the script line-by-line. First, there's this (or is that $this?)
+
+
$installer = $this;
+
+
Each installer script is run from the context of a Setup Resource class, the class you created above. That means any reference to $this from within the script will be a reference to an object instantiated from this class. While not necessary, most setup scripts in the core modules will alias $this to a variable called installer, which is what we've done here. While not necessary, it is the convention and it's always best to follow the convention unless you have a good reason for breaking it.
+
+
Next, you'll see our queries are bookended by the following two method calls.
If you take a look at the Mage_Core_Model_Resource_Setup class in app/code/core/Mage/Core/Model/Resource/Setup.php (which your setup class inherits from) you can see that these methods do some basic SQL setup
+
+
+ public function startSetup()
+ {
+ $this->getConnection()->startSetup()
+ return $this;
+ }
+
+ public function endSetup()
+ {
+ $this->getConnection()->endSetup();
+ return $this;
+ }
+
+
+
You can look into Varien_Db_Adapter_Pdo_Mysql in lib/Varien/Db/Adapter/Pdo/Mysql.php to find the real SQL setup executed for MySQL connections in the startSetup() and endSetup() methods.
+
+
Finally, there's the call to the run method
+
+
$installer->run(...);
+
+
which accepts a string containing the SQL needed to setup your database table(s). You may specify any number of queries, separated by a semi-colon. You also probably noticed the following
+
+
$installer->getTable('weblog/blogpost')
+
+
The getTable method allows you to pass in a Magento Model URI and get its table name. While not necessary, using this method ensures that your script will continue to run, even if someone changes the name of their table in the config file. The Mage_Core_Model_Resource_Setup class contains many useful helper methods like this. The best way to become familiar with everything that's possible is to study the installer scripts used by the core Magento modules.
+
+
RDBMS Agnostic Scripts
+
+
Since version 1.6, Magento (in theory) supports more database backends then only MySQL. Since our setup script contains raw SQL statements, it may not run correctly on a different database system, say MSSQL. For that reason the setup script name is prefixt with the string mysql4-
+
+
In order to make setup scripts cross-database compatible, Magento offers a DDL (Data Definition Language) Table object. Here is an alternative version of our setup script that would run on any supported RDBMS.
As you can see, there is no raw SQL in this version of the setup script. So which version should you use? If you want your Modules to run on any RDBMS backend, use the new DDL style upgrade scripts. If you are concerned about backward compatibility, use the raw SQL flavor, that is still supported by Magento 1.6 and 1.7 (and probably will be supported by any 1.x Magento release).
+
+
Module Upgrades
+
+
So, that's how you create a script that will setup your initial database tables, but what if you want to alter the structure of an existing module? Magento's Setup Resources support a simple versioning scheme that will let you automatically run scripts to upgrade your modules.
+
+
Once Magento runs an installer script for a module, it will never run another installer for that module again (short of manually deleting the reference in the core_resource table). Instead, you'll need to create an upgrade script. Upgrade scripts are very similar to installer scripts, with a few key differences.
+
+
To get started, we'll create a script at the following location, with the following contents
+echo 'Testing our upgrade script (upgrade-0.1.0-0.2.0.php) and halting execution to avoid updating the system version number ';
+die();
+
+
+
Upgrade scripts are placed in the same folder as your installer script, but named slightly differently. First, and most obviously, the file name contains the word upgrade. Secondly, you'll notice there are two version numbers, separated by a "-". The first (0.1.0) is the module version that we're upgrading from. The second (0.2.0) is the module version we're upgrading to.
+
+
If we cleared our Magento cache and reloaded a page, our script wouldn't run. We need to update the version number in our module's config.xml file to trigger the upgrade
With the new version number in place, we'll need to clear our Magento cache and load any page in our Magento site. You should now see output from your upgrade script.
+
+
By the way, we also could have names our upgrade script mysql4-upgrade-0.1.0-0.2.0.php. This would indicate our upgrade would contain MySQL specific SQL.
+
+
Before we continue and actually implement the upgrade script, there's one important piece of behavior you'll want to be aware of. Create another upgrade file at the following location with the following contents.
+echo 'Testing our upgrade script (upgrade-0.1.0-0.1.5.php) and NOT halting execution <br />';
+
+
+
If you reload a page, you'll notice you see BOTH messages. When Magento notices the version number of a module has changed, it will run through all the setup scripts needed to bring that version up to date. Although we never really created a version 0.1.5 of the Weblog module, Magento sees the upgrade script, and will attempt to run it. Scripts will be run in order from lowest to highest. If you take a peek at the core_resource table,
+
+
mysql> select * from core_resource where code = 'weblog_setup';
++--------------+---------+--------------+
+| code | version | data_version |
++--------------+---------+--------------+
+| weblog_setup | 0.1.5 | 0.1.5 |
++--------------+---------+--------------+
+1 row in set (0.00 sec)
+
+
+
you'll notice Magento considers the version number to be 1.5. That's because we completed executing the 1.0 to 1.5 upgrade, but did not complete execution of the 1.0 to 2.0 upgrade.
+
+
So, with all that out of the way, writing our actual upgrade script is identical to writing an installer script. Let's change the 0.1.0-0.2.0 script to read
+
+
+$installer = $this;
+$installer->startSetup();
+$installer->getConnection()
+ ->changeColumn($installer->getTable('weblog/blogpost'), 'post', 'post', array(
+ 'type' => Varien_Db_Ddl_Table::TYPE_TEXT,
+ 'nullable' => false,
+ 'comment' => 'Blogpost Body'
+ )
+);
+$installer->endSetup();
+die("You'll see why this is here in a second");
+
+
+
Try refreshing a page in your Magento site and ... nothing. The upgrade script didn't run. The post field in our table still allows null values, and more importantly, the call to die() did not halt execution. Here's what happened
+
+
+
The weblog_setup resource was at version 0.1.0
+
We upgraded our module to version 0.2.0
+
Magento saw the upgraded module, and saw there were two upgrade scripts to run; 0.1.0 to 0.1.5 and 0.1.0 to 0.2.0
+
Magento queued up both scripts to run
+
Magento ran the 0.1.0 to 0.1.5 script
+
The weblog_setup resource is now at version 0.1.5
+
Magento ran the 0.1.0 to 0.2.0 script, execution was halted
+
On the next page load, Magento saw weblog_setup at version 0.1.5 and did not see any upgrade scripts to run since both scripts indicated they should be run from0.1.0
+
+
+
The correct way to achieve what we wanted would have been to name our scripts as follows
+
+
upgrade-0.1.0-0.1.5.php #This goes from 0.1.0 to 0.1.5
+upgrade-0.1.5-0.2.0.php #This goes 0.1.5 to 0.2.0
+
+
Magento is smart enough to run both scripts on a single page load. You can go back in time and give this a try by updating the core_resource table
+
+
UPDATE core_resource SET version = '0.1.0', data_version = '0.1.0' WHERE code = 'weblog_setup';
+...
+
+
It's one of the odd quirks of the Magento system that the updates will run as previously configured. This means you'll want to be careful with multiple developers adding update scripts to the system. You'll either want a build-meister/deployment-manager type in charge of the upgrade scripts or (heaven forbid) developers will need to talk to one another.
+
+
Wrap-up
+
+
You should now know the basics of how to use Magento Setup Resources to create versioned database migration scripts, as well as understand the scripts provided in the core modules. Beyond having a standard way for developers to write migration scripts, Setup Resources become much more important when creating and modifying Entity Attribute Value models.
+
+
+
diff --git a/guides/v1.8/magefordev/mage-for-dev-7.html b/guides/v1.8/magefordev/mage-for-dev-7.html
new file mode 100644
index 0000000000..20851f842c
--- /dev/null
+++ b/guides/v1.8/magefordev/mage-for-dev-7.html
@@ -0,0 +1,673 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento for Developers: Part 7—Advanced ORM: Entity Attribute Value
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
Magento for Developers: Part 7—Advanced ORM: Entity Attribute Value
In the first ORM article we told you there were two kinds of Models in Magento. Regular, or "simple" Models, and Entity Attribute Value (or EAV) Models. We also told you this was a bit of a fib. Here's where we come clean.
+
+
ALL Magento Models interacting with the database inherit from the Mage_Core_Model_Abstract / Varien_Object chain. What makes something either a simple Model or an EAV Model is its Model Resource. While all resources extend the base Mage_Core_Model_Resource_Abstract class, simple Models have a resource that inherits from Mage_Core_Model_Resource_Db_Abstract, and EAV Models have a resource that inherits from Mage_Eav_Model_Entity_Abstract
+
+
If you think about it, this makes sense. As the end-programmer-user of the system you want a set of methods you can use to talk to and manipulate your Models. You don't care what the backend storage looks like, you just want to get properties and invoke methods that trigger business rules.
Entity-Attribute-Value model (EAV), also known as object-attribute-value model and open schema is a data model that is used in circumstances where the number of attributes (properties, parameters) that can be used to describe a thing (an "entity" or "object") is potentially very vast, but the number that will actually apply to a given entity is relatively modest. In mathematics, this model is known as a sparse matrix.
+
+
Another metaphor that helps me wrap my head around it is "EAV brings some aspects of normalization to the database table schema". In a traditional database, tables have a fixed number of columns
Every product has a name, every product has a price, etc.
+
+
In an EAV Model, each "entity" (product) being modeled has a different set of attributes. EAV makes a lot of sense for a generic eCommerce solution. A store that sells laptops (which have a CPU speed, color, ram amount, etc) is going to have a different set of needs than a store that sells yarn (yarn has a color, but no CPU speed, etc.). Even within our hypothetical yarn store, some products will have length (balls of yarn), and others will have diameter (knitting needles).
+
+
There aren't many open source or commercial databases that use EAV by default. There are none that are available on a wide variety of web hosting platforms. Because of that, the Magento engineers have built an EAV system out of PHP objects that use MySQL as a data-store. In other words, they've built an EAV database system on top of a traditional relational database.
+
+
In practice this means any Model that uses an EAV resource has its attributes spread out over a number of MySQL tables.
+
+
+
The above diagram is a rough layout of the database tables Magento consults when it looks up an EAV record for the catalog_product entity. Each individual product has a row in catalog_product_entity. All the available attributes in the entire system (not just for products) are stored in eav_attribute, and the actual attribute values are stored in tables with names like catalog_product_entity_varchar, catalog_product_entity_decimal, catalog_product_entity_etc..
+
+
Beyond the mental flexibility an EAV system gives you, there's also the practical benefit of avoiding ALTER TABLE statements. When you add a new attribute for your products, a new row is inserted into eav_attribute. In a traditional relational database/single-table system, you'd need to ALTER the actual database structure, which can be a time consuming/risky proposition for tables with large data-sets.
+
+
The downside is there's no one single simple SQL query you can use to get at all your product data. Several single SQL queries or one large join need to be made.
+
+
Implementing EAV
+
+
That's EAV in a nutshell. The rest of this articles is a run-through of what's needed to create a new EAV Model in Magento. It's the hairiest thing you'll read about Magento and it's something that 95% of people working with the system will never need to do. However, understanding what it takes to build an EAV Model Resource will help you understand what's going on with the EAV Resources that Magento uses.
+
+
Because the EAV information is so dense, we're going to assume you're already very familiar with Magento's MVC and grouped class name features. We'll help you along the way, but training wheels are off.
+
+
Weblog, EAV Style
+
+
We're going to create another Model for a weblog post, but this time using an EAV Resource. To start with, setup and create a new module which responds at the following URL
+
+
http://example.com/complexworld
+
+
If you're unsure how to do this, be sure you've mastered the concepts in the previous tutorials.
+
+
Next, we'll create a new Model named Weblogeav. Remember, it's the Resource that's considered EAV. We design and configure our Model the exact same way, so let's configure a Model similar to one we created in the first ORM article.
You'll notice so far there is no difference to setting up a regular Model and flat table resource Model.
+
+
We'll still need to let Magento know about this resource. Similar to basic Models, EAV Resources are configured in the same <model/> node with everything else.
Again, so far this is setup similar to our regular Model Resource. We provide a <class/> that configures a PHP class, as well as an <entities/> section that will let Magento know the base table for an individual Model we want to create. The <eavblogpost/> tag is the name of the specific Model we want to create, and its inner <table/> tag specifies the base table this Model will use (more on this later).
+
+
Where Does That File Go?
+
+
Until wide adoption of PHP 5.3 and namespaces, one of the trickier (and tedious) parts of Magento will remain remembering how <classname/>s relate to file paths, and then ensuring you create the correctly named directory structure and class files. After configuring any <classname/>s or URIs, you may find it useful to attempt to instantiate an instance of the class in a controller without first creating the class files. This way PHP will throw an exception telling me it can't find a file, along with the file location. Give the following a try in your Index Controller.
+Warning: include(Magentotutorial/Complexworld/Model/Eavblogpost.php) [function.include]:
+failed to open stream: No such file or directory in /Users/username/Sites/magento.dev/lib/Varien/Autoload.php on line 93
+
+
+
In addition to telling us the path where we'll need to define the new resource class this also serves as a configuration check. If we'd been warned with the following
+
+
+Warning: include(Mage/Complexworld/Model/Eavblogpost.php) [function.include]:
+failed to open stream: No such file or directory in /Users/username/Sites/magento.dev/lib/Varien/Autoload.php on line 93
+
+
+
we'd know our Model was misconfigured, as Magento was looking for the Model in code/core/Mage instead of code/local/Magentotutorial.
Remember, the Model itself is resource independent. A regular Model and an EAV Model both extend from the same class. It's the resource that makes them different.
+
+
Clear your Magento cache, reload your page, and you should see a new warning.
So, already we're seeing a few differences between a simple Model Resource and an EAV Model Resource. First off, we're extending the Mage_Eav_Model_Entity_Abstract class. While Mage_Eav_Model_Entity_Abstract uses the same _construct concept as a regular Model Resource, there's no _init method. Instead, we need to handle the init ourselves. This means telling the resource what connection-resources it should use, and passing a unique identifier into the setType method of our object.
+
+
Another difference in Mage_Eav_Model_Entity_Abstract is _construct is not an abstract method, primarily for reasons of backwards compatibility with older versions of the system.
+
+
So, with that, let's clear the Magento cache and reload the page. You should see a new exception which reads
Magento is complaining that it can't find a entity_type named complexworld_eavblogpost. This is the value you set above
+
+
$this->setType('complexworld_eavblogpost');
+
+
Every entity has a type. Types will, among other things, let the EAV system know which attributes a Model uses, and allow the system to link to tables that store the values for attributes. We'll need to let Magento know that we're adding a new entity type. Take a look in the MySQL table named eav_entity_type.
This table contains a list of all the entity_types in the system. The unique identifier complexworld_eavblogpost corresponds to the entity_type_code column.
+
+
Systems and Applications
+
+
This illustrates the single most important Magento concept, one that many people struggle to learn.
+
+
Consider the computer in front of you. The OS (Mac OS X, Windows, Linux, etc.) is the software system. Your web browser (Firefox, Safari, IE, Opera) is the application. Magento is a system first, and an application second. You build eCommerce applications using the Magento system. What gets confusing is, there's a lot of places in Magento where the system code is exposed in a really raw form to the application code. The EAV system configuration living in the same database as your store's data is an example of this.
+
+
If you're going to get deep into Magento, you need to treat it like it's an old Type 650 machine. That is to say, it's the kind of thing you can't effectively program applications in unless unless you have a deep understanding of the system itself.
+
+
Creating a Setup Resource
+
+
So, it's theoretically possible to manually insert the rows you'll need into the Magento database to get your Model working, but it's not recommended. Fortunately, Magento provides a specialized Setup Resource that provides a number of helper method that will automatically create the needed records to get the system up and running.
+
+
So, for starters, configure the Setup Resource like you would any other.
Take note that we're extending from Mage_Eav_Model_Entity_Setup rather than Mage_Core_Model_Resource_Setup.
+
+
Finally, we'll set up our installer script. If you're not familiar with the naming conventions here, you'll want to review the setup resource tutorial on Setup Resources.
+<?php
+$installer = $this;
+throw new Exception("This is an exception to stop the installer from completing");
+
+
+
Clear your Magento Cache, reload you page, and the above exception should be thrown, meaning you've correctly configured your Setup Resource.
+
+
NOTE: We'll be building up our install script piece by piece. If you've read the previous tutorial, you'll know you need to remove the setup's row from the core_resource table and clear your cache to make an installer script re-run. For the remainder of this tutorial, please remember that anytime we add or remove an item from our installer and re-run it, you'll need to remove this row from the database and clear your Magento cache. Normally you would create this file and run it once, a tutorial is something of an edge case.
+
+
Adding the Entity Type
+
+
To begin, add the following to your Setup Resource installer script, and then run the script by loading any page (after removing the above exception)
+
+
+$installer = $this;
+$installer->startSetup();
+$installer->addEntityType('complexworld_eavblogpost', array(
+ //entity_mode is the URI you'd pass into a Mage::getModel() call
+ 'entity_model' => 'complexworld/eavblogpost',
+
+ //table refers to the resource URI complexworld/eavblogpost
+ //<complexworld_resource>...<eavblogpost><table>eavblog_posts</table>
+ 'table' =>'complexworld/eavblogpost',
+));
+$installer->endSetup();
+
+
+
We're calling the addEntityType method on our installer object. This method allows us to pass in the entity type (complexworld_eavblogpost) along with a list of parameters to set its default values. If you've run this script, you'll notice new rows in the eav_attribute_group, eav_attribute_set, and eav_entity_type tables.
+
+
So, with that in place, if we reload our complexworld page, we'll get a new error.
+
+
SQLSTATE[42S02]: Base table or view not found: 1146 Table 'magento.eavblog_posts' doesn't exist
+
+
Creating the Data Tables
+
+
So, we've told Magento about our new entity type. Next, we need to add the MySQL tables that will be used to store all the entity values, as well as configure the system so it knows about these tables.
+
+
Our EAV Setup Resource has a method named createEntityTables which will automatically setup the tables we need, as well as add some configuration rows to the system. Let's add the following line to our setup resource.
The createEntityTables method accepts two parameters. The first is the base table name, the second is a list of options. We're using the Setup Resource's getTable method to pull the table name from our config. If you've been following along, you know this should resolve to the string eavblog_posts. We've omitted the second parameter which is an array of options you'll only need to used it for advanced situations that are beyond the scope of this tutorial.
+
+
After running the above script, you should have the following new tables in your database
You'll also have an additional row in the eav_attribute_set table
+
+
mysql> select * from eav_attribute_set order by attribute_set_id DESC LIMIT 1 \G
+*************************** 1. row ***************************
+ attribute_set_id: 65
+ entity_type_id: 37
+attribute_set_name: Default
+ sort_order: 6
+
+
+
So, let's go back to our page and reload.
+
+
http://example.com/complexworld
+
+
Success! You should see no errors or warnings, and a dumped Magentotutorial_Complexworld_Model_Eavblogpost --- with no data.
+
+
Adding Attributes
+
+
The last step we need to take in our Setup Resource is telling Magento what attributes we want our EAV Model to have. This would be equivalent to adding new columns in a single database table setup. Again, the Setup Resource will help us. The method we're interested in is addAttribute.
+
+
The code from the previous section was simply telling Magento about a type of entity that we add to the system. These next bits of code are what will actually add possible attributes for our new type to the system.
+
+
We do that with the method addAttribute. When we call addAttribute, Magento will need to do several things to install your entities.
+
+
To start with, we'll give our Eavblogpost a single attribute named title.
All right, that's a small pile of code. Let's break it apart.
+
+
The first argument to addAttribute is the entity type code. It has to match the code specified when calling addEntityType. It tells Magento which entity we are adding the attribute to, in our example it is our complexworld_eavblogpost entity. To see other available entities that come shipped with Magento, remember you can look into the eav_entity_type table at the entity_type_code column.
+
+
The second argument to addAttribute is the attribute code. It has to be unique within the given entity.
+
+
The third argument is where it get real interesting. This is an array of key value pairs, describing the attribute properties. For the sake of simplicity we've chose to define a single attribute, but you could go on to define as many as you'd like, by adding additional addAttribute calls to the setup script.
+
+
Array of Key Value Pairs that Define the Attribute
+
+
Finally, we have a long list of attribute properties.
Most of these define how Magento would build a backend form element for this attribute, and probably you'll won't have to deal with the,. That said, the one important property you'll want to make note of is
+
+'type' => 'varchar'
+
+
+
This defines the type of the value that the attribute will contain. You'll recall that we added table for each attribute type
While these do not refer to the MySQL column types, (but instead the EAV attribute types), their names (varchar, datetime, etc.) are indicative of the values they'll hold.
+
+
All of these attribute properties are optional, if we wouldn't have specified them, Magento would have used a default value. These default values are defined in the _prepareValues method of the Mage_Eav_Model_Entity_Setup class (inherited by our setup class).
The second argument to the method calls to _getValue is the array key from our addAttribute argument array, and the third is the default value. So by default Magento would assume you are adding a varchar attribute with a text input.
+
+
Adding the other attributes
+
+
Lets add attributes for the blog post content and the post date. This is what the complete install script looks like.
So, now that we have everything in place, lets refresh things one last time to run our installer script. After calling addAttribute, we should have
+
+
+
A new row in eav_entity_type for the complexworld_eavblogpost entity type
+
A new row in eav_attribute for the title attribute
+
A new row in eav_attribute for the content attribute
+
A new row in eav_attribute for the date attribute
+
A new row in eav_entity_attribute
+
+
+
Tying it all Together
+
+
This is clearly the lamest.blogmodel.ever, but lets try adding some rows and iterating through a collection and get the heck out of here before our heads explode. Add the following two actions to your Index Controller.
as well as 10 new rows in the eavblog_posts_varchar table.
+
+
+mysql> SELECT * FROM eavblog_posts_varchar ORDER BY value_id DESC;
++----------+----------------+--------------+----------+-----------+------------------+
+| value_id | entity_type_id | attribute_id | store_id | entity_id | value |
++----------+----------------+--------------+----------+-----------+------------------+
+| 10 | 31 | 933 | 0 | 10 | This is a test 9 |
+| 9 | 31 | 933 | 0 | 9 | This is a test 8 |
+| 8 | 31 | 933 | 0 | 8 | This is a test 7 |
+| 7 | 31 | 933 | 0 | 7 | This is a test 6 |
+| 6 | 31 | 933 | 0 | 6 | This is a test 5 |
+| 5 | 31 | 933 | 0 | 5 | This is a test 4 |
+| 4 | 31 | 933 | 0 | 4 | This is a test 3 |
+| 3 | 31 | 933 | 0 | 3 | This is a test 2 |
+| 2 | 31 | 933 | 0 | 2 | This is a test 1 |
+| 1 | 31 | 933 | 0 | 1 | This is a test 0 |
++----------+----------------+--------------+----------+-----------+------------------+
+
+
+
Notice that eavblog_posts_varchar is linked to eavblog_posts by the entity_id column.
+
+
Finally, let's pull our Models back out. Load the following URL in your browser
Warning: include(Magentotutorial/Complexworld/Model/Resource/Eavblogpost/Collection.php) [function.include]:
+ failed to open stream: No such file or directory in /Users/username/Sites/magento.dev/lib/Varien/Autoload.php on line 93
+
+
So Close! We didn't make a class for our collection object! Fortunately, doing so is just as easy as with a regular Model Resource. Add the following file with the following contents
This is just a standard Magento _construct method to initialize the Model. With this in place, reload the page, and we'll see all the titles and the content outputted. But notice, the date value is missing!
+
+
Which Attributes?
+
+
Those of you with sharp eyes may have noticed something slightly different about the collection loading.
Because querying for EAV data can be SQL intensive, you'll need to specify which attributes it is you want your Models to fetch for you. This way the system can make only the queries it needs. If you're willing to suffer the performance consequences, you can use a wild card to grab all the attributes
So, that should give you enough information to be dangerous, or at least enough information so you're not drowning the next time you're trying to figure out why the yellow shirts aren't showing up in your store. There's still plenty to learn about EAV; here's a few topics I would have liked to cover in greater detail, and may talk about in future articles
+
+
+
EAV Attributes: Attributes aren't limited to datetime, decimal, int, text and varchar. You can create your own class files to model different attributes. This is what the attribute_model entity property is for.
+
Collection Filtering: Filtering on EAV collections can get tricky, especially when you're dealing with the above mentioned non-simple attributes. You need to use the addAttributeToFilter method on your collection before loading.
+
The Magento EAV Hierarchy: Magento has taken their basic EAV Model and built up a hierarchy that's very tied to store functionality, as well as including strategies to reduce the number of queries an EAV Model generates (the concept of a flat Model, for example)
+
+
+
EAV Models are, without a doubt, the most complicated part of the Magento system that an ecommerce web developer will need to deal with. Remember to take deep breaths and that, at the end of the day, its just programming. Everything happens for a concrete reason, you just need to figure out why.
\ No newline at end of file
diff --git a/guides/v1.8/magefordev/mage-for-dev-8.html b/guides/v1.8/magefordev/mage-for-dev-8.html
new file mode 100644
index 0000000000..aa284c008c
--- /dev/null
+++ b/guides/v1.8/magefordev/mage-for-dev-8.html
@@ -0,0 +1,524 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento for Developers: Part 8—Varien Data Collections
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
Magento for Developers: Part 8—Varien Data Collections
Originally, as a PHP programmer, if you wanted to collect together a group of related variables you had one choice, the venerable Array. While it shares a name with C's array of memory addresses, a PHP array is a general purpose dictionary like object combined with the behaviors of a numerically indexed mutable array.
+
+
In other languages the choice isn't so simple. You have multiple data structures to chose from, each offering particular advantages in storage, speed and semantics. The PHP philosophy was to remove this choice from the client programmer and give them one useful data structure that was "good enough".
+
+
All of this is galling to a certain type of software developer, and PHP 5 set out to change the status quo by offering built-in classes and interfaces that allow you to create your own data structures.
+
+
+$array = new ArrayObject();
+class MyCollection extends ArrayObject{...}
+$collection = new MyCollection();
+$collection[] = 'bar';
+
+
+
While this is still galling to a certain type of software developer, as you don't have access to low level implementation details, you do have the ability to create array-like Objects with methods that encapsulate specific functionality. You can also setup rules to offer a level of type safety by only allowing certain kinds of Objects into your Collection.
+
+
It should come as no surprise that Magento offers you a number of these Collections. In fact, every Model object that follows the Magento interfaces gets a Collection type for free. Understanding how these Collections work is a key part to being an effective Magento programmer. We're going to take a look at Magento Collections, starting from the bottom and working our way up. Set up a controller action where you can run arbitrary code, and let's get started.
+
+
A Collection of Things
+
+
First, we're going to create a few new Objects.
+
+
+$thing_1 = new Varien_Object();
+$thing_1->setName('Richard');
+$thing_1->setAge(24);
+
+$thing_2 = new Varien_Object();
+$thing_2->setName('Jane');
+$thing_2->setAge(12);
+
+$thing_3 = new Varien_Object();
+$thing_3->setName('Spot');
+$thing_3->setLastName('The Dog');
+$thing_3->setAge(7);
+
+
+
The Varien_Object class defines the object all Magento Models inherit from. This is a common pattern in object oriented systems, and ensures you'll always have a way to easily add methods/functionally to every object in your system without having to edit every class file.
+
+
Any Object that extends from Varien_Object has magic getter and setters that can be used to set data properties. Give this a try
+
+
var_dump($thing_1->getName());
+
+
If you don't know what the property name you're after is, you can pull out all the data as an array
+
+
var_dump($thing_3->getData());
+
+
The above will give you an array something like
+
+
+
+array
+'name' => string 'Spot' (length=4)
+'last_name' => string 'The Dog' (length=7)
+'age' => int 7
+
+
+
Notice the property named "last_name"? If there's an underscore separated property, you camel case it if you want to use the getter and setter magic.
+
+
$thing_1->setLastName('Smith');
+
+
The ability to do these kinds of things is part of the power of PHP5, and the development style a certain class of people mean when they say "Object Oriented Programming".
+
+
So, now that we have some Objects, let's add them to a Collection. Remember, a Collection is like an Array, but is defined by a PHP programmer.
The Varien_Data_Collection is the Collection that most Magento data Collections inherit from. Any method you can call on a Varien_Data_Collection you can call on Collections higher up the chain (We'll see more of this later)
+
+
What can we do with a Collection? For one, with can use foreach to iterate over it
+
+
+foreach($collection_of_things as $thing)
+{
+ var_dump($thing->getData());
+}
+
+
+
There are also shortcuts for pulling out the first and last items
So, this is an interesting exercise, but why do we care?
+
+
We care because all of Magento's built in data Collections inherit from this object. That means if you have, say, a product Collection you can do the same sort of things. Let's take a look
Most Magento Model objects have a method named getCollection which will return a collection that, by default, is initialized to return every Object of that type in the system.
+
+
A Quick Note: Magento's Data Collections contain a lot of complicated logic that handles when to use an index or cache, as well as the logic for the EAV entity system. Successive method calls to the same Collection over its life can often result in unexpected behavior. Because of that, all the of the following examples are wrapped in a single method action. I'd recommend doing the same while you're experimenting. Also, XDebug'svar_dump is a godsend when working with Magento Objects and Collections, as it will (usually) intelligently short circuit showing hugely recursive Objects, but still display a useful representation of the Object structure to you.
+
+
The products Collection, as well as many other Magento Collections, also have the Varien_Data_Collection_Db class in their ancestor chain. This gives us a lot of useful methods. For example, if you want to see the select statement your Collection is using
+
+
+public function testAction()
+{
+ $collection_of_products = Mage::getModel('catalog/product')->getCollection();
+ var_dump($collection_of_products->getSelect()); //might cause a segmentation fault
+}
+
Whoops! Since Magento is using the Zend database abstraction layer, your Select is also an Object. Let's see that as a more useful string.
+
+
+public function testAction()
+{
+ $collection_of_products = Mage::getModel('catalog/product')->getCollection();
+ //var_dump($collection_of_products->getSelect()); //might cause a segmentation fault
+ var_dump(
+ (string) $collection_of_products->getSelect()
+ );
+}
+
+
+
Sometimes this is going to result in a simple select
+
+
'SELECT `e`.* FROM `catalog_product_entity` AS `e`'
+
+
Other times, something a bit more complex
+
+
+string 'SELECT `e`.*, `price_index`.`price`, `price_index`.`final_price`, IF(`price_index`.`tier_price`,
+LEAST(`price_index`.`min_price`, `price_index`.`tier_price`), `price_index`.`min_price`) AS `minimal_price`,
+`price_index`.`min_price`, `price_index`.`max_price`, `price_index`.`tier_price` FROM `catalog_product_entity`
+AS `e` INNER JOIN `catalog_product_index_price` AS `price_index` ON price_index.entity_id = e.entity_id AND
+price_index.website_id = '1' AND price_index.customer_group_id = 0'
+
+
+
The discrepancy depends on which attributes you're selecting, as well as the aforementioned indexing and cache. If you've been following along with the other articles in this series, you know that many Magento models (including the Product Model) use an EAV system. By default, a EAV Collection will not include all of an Object's attributes. You can add them all by using the addAttributeToSelect method
+
+
+$collection_of_products = Mage::getModel('catalog/product')
+ ->getCollection()
+ ->addAttributeToSelect('*'); //the asterisk is like a SQL SELECT * FROM ...
+
+
+
Or, you can add just one
+
+
+//or just one
+$collection_of_products = Mage::getModel('catalog/product')
+ ->getCollection()
+ ->addAttributeToSelect('meta_title');
+
+
+
or chain together several
+
+
+//or just one
+$collection_of_products = Mage::getModel('catalog/product')
+ ->getCollection()
+ ->addAttributeToSelect('meta_title')
+ ->addAttributeToSelect('price');
+
+
+
Lazy Loading
+
+
One thing that will trip up PHP developers new to Magento's ORM system is when Magento makes its database calls. When you're writing literal SQL, or even when you're using a basic ORM system, SQL calls are often made immediately when instantiating an Object.
+
+
+$model = new Customer();
+//SQL Calls being made to Populate the Object
+echo 'Done'; //execution continues
+
+
+
Magento doesn't work that way. Instead, the concept of Lazy Loading is used. In simplified terms, Lazy loading means that no SQL calls are made until the client-programmer needs to access the data. That means when you do something something like this
and not have to worry that Magento is making a database query each time a new attribute is added. The database query will not be made until you attempt to access an item in the Collection.
+
+
In general, try not to worry too much about the implementation details in your day to day work. It's good to know that there's s SQL backend and Magento is doing SQLy things, but when you're coding up a feature try to forget about it, and just treat the objects as block boxes that do what you need.
+
+
Filtering Database Collections
+
+
The most important method on a database Collection is addFieldToFilter. This adds your WHERE clauses to the SQL query being used behind the scenes. Consider this bit of code, run against the sample data database (substitute your own SKU is you're using a different set of product data)
+
+
+public function testAction()
+{
+ $collection_of_products = Mage::getModel('catalog/product')
+ ->getCollection();
+ $collection_of_products->addFieldToFilter('sku','n2610');
+
+ //another neat thing about collections is you can pass them into the count //function. More PHP5 powered goodness
+ echo "Our collection now has " . count($collection_of_products) . ' item(s)';
+ var_dump($collection_of_products->getFirstItem()->getData());
+}
+
+
+
The first parameter of addFieldToFilter is the attribute you wish to filter by. The second is the value you're looking for. Here's we're adding a sku filter for the value n2610.
+
+
The second parameter can also be used to specify the type of filtering you want to do. This is where things get a little complicated, and worth going into with a little more depth.
+SELECT `e`.*, IF(_table_meta_title.value_id>0, _table_meta_title.value, _table_meta_title_default.value) AS `meta_title`
+FROM `catalog_product_entity` AS `e`
+INNER JOIN `catalog_product_entity_varchar` AS `_table_meta_title_default`
+ ON (_table_meta_title_default.entity_id = e.entity_id) AND (_table_meta_title_default.attribute_id='103')
+ AND _table_meta_title_default.store_id=0
+LEFT JOIN `catalog_product_entity_varchar` AS `_table_meta_title`
+ ON (_table_meta_title.entity_id = e.entity_id) AND (_table_meta_title.attribute_id='103')
+ AND (_table_meta_title.store_id='1')
+WHERE (IF(_table_meta_title.value_id>0, _table_meta_title.value, _table_meta_title_default.value) = 'my title')
+
+
+
Not to belabor the point, but try not to think too much about the SQL if you're on deadline.
+
+
Other Comparison Operators
+
+
I'm sure you're wondering "what if I want something other than an equals by query"? Not equal, greater than, less than, etc. The addFieldToFilter method's second parameter has you covered there as well. It supports an alternate syntax where, instead of passing in a string, you pass in a single element Array.
+
+
The key of this array is the type of comparison you want to make. The value associated with that key is the value you want to filter by. Let's redo the above filter, but with this explicit syntax
As you can see, the second parameter is a PHP Array. Its key is eq, which stands for equals. The value for this key is n2610, which is the value we're filtering on.
+
+
Magento has a number of these english language like filters that will bring a tear of remembrance (and perhaps pain) to any old perl developers in the audience.
+
+
Listed below are all the filters, along with an example of their SQL equivalents.
+
+
+array("eq"=>'n2610')
+WHERE (e.sku = 'n2610')
+
+array("neq"=>'n2610')
+WHERE (e.sku != 'n2610')
+
+array("like"=>'n2610')
+WHERE (e.sku like 'n2610')
+
+array("nlike"=>'n2610')
+WHERE (e.sku not like 'n2610')
+
+array("is"=>'n2610')
+WHERE (e.sku is 'n2610')
+
+array("in"=>array('n2610'))
+WHERE (e.sku in ('n2610'))
+
+array("nin"=>array('n2610'))
+WHERE (e.sku not in ('n2610'))
+
+array("notnull"=>true)
+WHERE (e.sku is NOT NULL)
+
+array("null"=>true)
+WHERE (e.sku is NULL)
+
+array("gt"=>'n2610')
+WHERE (e.sku > 'n2610')
+
+array("lt"=>'n2610')
+WHERE (e.sku < 'n2610')
+
+array("gteq"=>'n2610')
+WHERE (e.sku >= 'n2610')
+
+array("moreq"=>'n2610') //a weird, second way to do greater than equal (Doesn't work on > 1.8 CE EDITION do the same as eq)
+WHERE (e.sku >= 'n2610')
+
+array("lteq"=>'n2610')
+WHERE (e.sku <= 'n2610')
+
+array("finset"=>array('n2610'))
+WHERE (find_in_set('n2610',e.sku))
+
+array('from'=>'10','to'=>'20')
+WHERE e.sku >= '10' and e.sku <= '20'
+
+
+
Most of these are self explanatory, but a few deserve a special callout
+
+
in, nin, find_in_set
+
+
The in, nin and finset conditionals allow you to pass in an Array of values. That is, the value portion of your filter array is itself allowed to be an array.
+
+
+array("in"=>array('n2610','ABC123')
+WHERE (e.sku in ('n2610','ABC123'))
+
+
+
notnull, null
+
+
The keyword NULL is special in most flavors of SQL. It typically won't play nice with the standard equality (=) operator. Specifying notnull or null as your filter type will get you the correct syntax for a NULL comparison while ignoring whatever value you pass in
+
+
+array("notnull"=>true)
+WHERE (e.sku is NOT NULL)
+
+
+
from - to filter
+
This is another special format that breaks the standard rule. Instead of a single element array, you specify a two element array. One element has the key from, the other element has the key to. As the keys indicated, this filter allows you to construct a from/to range without having to worry about greater than and less than symbols
WHERE (_table_price.value >= '10' and _table_price.value <= '20')'
+
+
AND or OR, or is that OR and AND?
+
+
Finally, we come to the boolean operators. It's the rare moment where we're only filtering by one attribute. Fortunately, Magento's Collections have us covered. You can chain together multiple calls to addFieldToFilter to get a number of "AND" queries.
By chaining together multiple calls as above, we'll produce a where clause that looks something like the following
+
+
WHERE (e.sku like 'a%') AND (e.sku like 'b%')
+
+
To those of you that just raised your hand, yes, the above example would always return 0 records. No sku can begin with BOTH an a and a b. What we probably want here is an OR query. This brings us to another confusing aspect of addFieldToFilter's second parameter.
+
+
If you want to build an OR query, you need to pass an Array of filter Arrays in as the second parameter. I find it's best to assign your individual filter Arrays to variables
In the interest of being explicit, here's the aforementioned array of filter arrays.
+
array($filter_a, $filter_b)
+
+
This will gives us a WHERE clause that looks something like the following
+
+
WHERE (((e.sku like 'a%') or (e.sku like 'b%')))
+
+
Wrap Up
+
+
You're now a Magento developer walking around with some serious firepower. Without having to write a single line of SQL you now know how to query Magento for any Model your store or application might need.
diff --git a/guides/v1.8/other/appsec-900_addhandler.html b/guides/v1.8/other/appsec-900_addhandler.html
new file mode 100644
index 0000000000..b19abed7fd
--- /dev/null
+++ b/guides/v1.8/other/appsec-900_addhandler.html
@@ -0,0 +1,98 @@
+---
+title: 'Discover credit card validation issue: Magento EE 1.9.1.1—.13.1.0 and CE 1.4.2.0—1.8.1.0'
+layout: v1x
+---
+
+
Enable an attacker to execute arbitrary code on your Magento server.
+
Create files with a .csv extension, create writable directories, and change the permission of existing files to world-writable (777).
+
+
+
Note: The preceding exploits require the attacker to have administrative access to your Magento Admin Panel Dashboard. You can resolve these issues with the patch discussed in this article.
+
+
Creating files with a .csv extension can lead to executing files like php.csv (only under circumstances discussed in this article). The ability to run code with a .csv extension is dangerous itself and could be combined with other attacks; for example, targeting other software installed on the server.
Although Magento code is protected by a hash value, the possibility of a successful exploit cannot be eliminated because of the low entropy of the hash secret value.
+
We strongly recommend you to take precautions discussed in this article and apply a patch for your version of Magento Enterprise Edition or Community Edition.
+
+
Versions Affected
+
Magento software versions affected: The issue affects all shipping versions of Magento Community Edition (CE) and Enterprise Edition (EE).
+
Operating system versions affected:
+
CentOS 5.x and 6.x
+
RedHat Enterprise Linux 5.x and 6.x
+
+
Getting the Patch
+
The following table shows the patch you should get for your version of CE or EE.
Important: After applying your patch, Magento strongly recommends you evaluate your vulnerability and configure PHP as discussed in Resolving the Vulnerability
+
+
+
Determining Your Vulnerability to the File System Attack
+
To determine if you're vulnerable to execution of PHP code with a non-PHP extension, search your web server configuration file for the following string:
+
AddHandler application/x-httpd-php .php
+
The Apache configuration file is typically /etc/httpd/conf/httpd.conf
+
To confirm you're vulnerable:
+
Create a file named test.php.csv anywhere in your web server's doocroot with the following contents:
+
<?php
+phpinfo()
+
In a web browser, display that page. (For example, http://www.example.com/path/test.php.csv
+
If your browser saves the file or prompts you to save the file instead of displaying it, your server is not vulnerable. You can ignore the rest of this article.
+
If a page similar to the following displays, your server is vulnerable. Continue with the next section.
+
+
+
Resolving the File System Vulnerability
+
Important: Magento strongly recommends you perform all tasks discussed in this section in a development or testing environment and not in a production environment.
+
To resolve this vulnerability, you must log in to the Magento server as a user with root privileges or as a user with permissions to change the web server configuration.
+
To resolve the vulnerability:
+
Comment out the directive in httpd.conf by preceding it with a pound sign (#) as follows:
+
+ The regular expression in this setting matches .php only to the final extension in the file name, applying the handler only to PHP files and preventing PHP from executing.
+
diff --git a/guides/v1.8/other/discover-card-validation.html b/guides/v1.8/other/discover-card-validation.html
new file mode 100644
index 0000000000..2f1f082484
--- /dev/null
+++ b/guides/v1.8/other/discover-card-validation.html
@@ -0,0 +1,31 @@
+---
+title: 'Discover credit card validation issue: Magento EE 1.9.1.1—.13.1.0 and CE 1.4.2.0—1.8.1.0'
+layout: v1x
+---
+
Magento has fixed an issue that prevented some Discover credit cards from validating properly. The issue was that certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover cards should validate properly.
Magento Community Edition (CE) versions 1.4.2.0–1.8.1.0
+
+
+
Important: This is not a security threat. No data has been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid Discover card numbers.
We'd like to draw your attention to new patches that were recently posted to the Partner Portal and Support Center. These patches deliver important improvements, such as improving security of the Magento Connect Manager and making it easier to install community-created translation packages.
+
+
General Magento Connect Patches
+
Patch name:
+
PATCH_SUPEE-3941_EE_1.10.1.0_v1-2014-08-12-12-13-15.sh for EE 1.10.x
+
PATCH_SUPEE-3941_EE_1.11.2.0_v1-2014-08-12-12-11-32.sh for EE 1.11.x
+
PATCH_SUPEE-3941_EE_1.14.0.1_v1-2014-08-12-12-10-06.sh for EE 1.12.x
+
Result of applying this patch:
+
When you install a community-created translation package, the translation provided by the package overwrites any existing translations for the same items. This enables you to more easily install packages with translations.
+
To improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
+
Extension developers can now create an extensions with a dash character in the name. Merchants can install those extensions without issues.
+
Magento administrators who attempt to install an extension with insufficient file system privileges are now informed. Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the your Magento install dir/app/code/community directory structure, the Magento administrator sees an error message in the Magento Connect Manager.
+To set file system permissions appropriately, see After You Install Magento: Recommended File System Ownership and Privileges.
Patch name: PATCH_SUPEE-3630_EE_1.12.x_v1.sh for EE 1.12.x. After applying this patch, your search engine returns search results to users on the web store while reindexing is underway. We recommend you install this patch if you're using the Solr search engine. This patch can result in slower performance if you're using the default MySQL Full Text search engine.
diff --git a/guides/v1.8/other/ht_extend_magento_rest_api.html b/guides/v1.8/other/ht_extend_magento_rest_api.html
new file mode 100644
index 0000000000..58a2fa4624
--- /dev/null
+++ b/guides/v1.8/other/ht_extend_magento_rest_api.html
@@ -0,0 +1,850 @@
+---
+title: How to Extend the Magento REST API to Use Coupon Auto Generation
+layout: v1x
+
+---
+
+
Customers of traditional stores and online web stores love coupons. Typically, a merchant sends coupons to customers who input them when checking out. The coupon saves the customer money and hopefully entices the customer to visit the store more frequently. In addition, the merchant can track coupon codes to individual customers to target market those customers.
+
+
Coupon Auto Generation and the Magento REST API
+
Magento CE 1.7 introduced a new method of creating coupon codes—auto generation. Auto generating coupons means Magento programmatically creates several coupon codes at one time quickly and easily. However, if Magento generates the coupon codes, you'd have to manually distribute them to customers.
+
Magento's REST API is extensible and can easily be called by an outside program to auto generate coupon codes. You can use this feature, for example, to e-mail coupon codes to your top 100 customers.
+
No programming is necessary to implement the extension module discussed in this guide; however, basic familiarity with Magento modules and PHP programming is desirable.
+
The Coupon AutoGen API enables any authorized external program to instruct Magento to:
+
Auto-generate the specified number of coupon codes
+
Return these codes to the calling program—simulated in this guide using a simple .php file
+
+
Implementation Details
+
This guide discusses how to use coupon auto generation and a web service to dynamically call the Magento REST API to generate a series of codes. The web service instantiates the underlying Magento sales rule (salesrule/rule) coupon code generator and creates a pool of new codes. These codes returned to the caller as a JSON string.
+
For more information about the Magento REST API, see Introduction to REST API. To extend the REST API to add a web service for generating and retrieving coupon codes, this guide discusses the following:
+
Setting up an auto generated coupon rule
+
Creating a module to use a REST based API extension
+This guide gives you all the files to create the module; no programming is necessary. There are four module configuration .xml files and one .php file to create the web service.
+
Creating a user for the OAuth access to the new service
+
Testing the web service from a separate page
+
+
System Requirements
+
To implement and test the Coupon AutoGen API, you must have all of the following:
+
Magento Community Edition (CE) 1.7 or later on Ubuntu.
+
Magento Enterprise Edition (EE) 1.12 or later on Ubuntu.
Optional.phpmyadmin, which makes it easier to view and manipulate the Magento database. You can use phpmyadmin for convenience to get the OAuth key and shared secret later in this guide.
+
+
Note: Although Magento supports other Linux operating systems, Ubuntu is the only one discussed in this guide. Consult an appropriate reference for equivalent commands on other Linux operating systems.
+For example, if your Magento instance hostname is www.example.com and you put phpinfo.php in the web server's docroot, enter:
+
http://www.example.com/phpinfo.php
+
Search the resulting output for OAuth.
+The following figure shows an example of OAuth being properly set up.
+
+If the preceding does not display, OAuth is not set up so continue with the next section.
+If OAuth is already installed, continue with Defining a Magento Coupon Code Generation Rule.
+
+
Installing the OAuth Packages
+
The pecl OAuth extension requires both PEAR (which enables you to install the package) and libpcre3-dev, which enables the OAuth package to be compiled.
+
To install the packages and confirm that OAuth is enabled:
+
Enter the following commands in the order shown:
+
+If the following displays, you must edit your php.ini file to find the OAuth library:
+
configuration option "php_ini" is not set to php.ini location
+You should add "extension=oauth.so" to php.ini
+
Open php.ini in a text editor.
+If you're not sure where it's located look in the phpinfo.php page output.
+Add the following anywhere in php.ini:
+
[OAuth]
+extension=oauth.so
+
Save your changes to php.ini and exit the text editor.
+
Enter the following command to restart the Apache web server.
+
service apache2 restart
+
Continue with the next section.
+
+
Confirming that OAuth Installed Successfully
+
If your phpinfo.php page is still open in a web browser, press Control+R to force a refresh; otherwise, enter the URL shown in Creating a phpinfo File to view it.
+
The following figure shows an example of a properly set up OAuth extension.
+
+
Note: Do not continue until you know that OAuth installed successfully.
+
+
Defining a Magento Coupon Code Generation Rule
+
To define a Magento coupon code generation rule:
+
Log in to the Magento Admin Panel as an administrator.
+
Click Promotions > Shopping Cart Price Rules.
+
On the Shopping Cart Price Rules page, click Add New Rule (in the upper-right corner of the page).
+The General Information page displays as follows.
+
+
Enter the following information.
+
+
+
+
+
+
Item
+
Description
+
+
+
Rule Name
+
Enter Generate Coupons.
+
+
+
Description
+
Enter an optional description of the rule, such as Rule that generates a sequence of coupon codes.
+
+
+
Status
+
From the list, click Active.
+
+
+
Websites
+
Click the websites on which you want the coupons to display. Hold down the Shift key and click the names of all items to select them.
+
+
+
Customer Groups
+
Hold down the Shift key and click the names of all items to select them.
+
+
+
Coupon
+
Click Specific Coupon
+
+
+
Coupon Code
+
Leave the field blank.
+
+
+
CE only. Auto Generation
+
Select the Use Auto Generation checkbox.
+
+
+
CE only. Uses per Coupon
+
Enter 10.
+
+
+
Uses per Customer
+
Enter 1.
+
+
+
From Date
+
Select today's date.
+
+
+
To Date
+
Select any date in the future.
+
+
+
Priority
+
Enter 0.
+
+
+
Public In RSS Feed
+
Click No.
+
+
+
+
In the upper-right corner of the page, click Save and Continue Edit.
+The message The rule has been saved displays at the top of the page to indicate that Magento successfully saved the rule you just created.
+
In the left navigation bar, click Actions.
+The Actions page displays as follows.
+
+
Enter the following information.
+
+
+
+
Item
+
Description
+
+
+
Apply
+
From the list, click Percent of product price discount.
+
+
+
Discount Amount
+
Enter 10.
+
+
+
Maximum Qty Discount is Applied To
+
Enter 1.
+
+
+
Discount Qty Step (Buy X)
+
Enter 1.
+
+
+
Apply to Shipping Amount
+
From the list, click No.
+
+
+
Free Shipping
+
From the list, click No.
+
+
+
Stop Further Rules Processing
+
From the list, click Yes.
+
+
+
EE only Add Reward Points
+
Enter 0.
+
+
+
+
Click Save (in the upper-right corner of the page).
+The message The rule has been saved displays to indicate that Magento saved the rule action options you just entered. Notice that this page now has a row for the Generate Coupons rule you just defined.
+A sample follows.
+
+
Write down the rule ID (circled in red in the preceding figure). You will use this value later in this guide.
+
+
Generating Coupon Codes
+
Now that you've created a rule, this section discusses how to use the rule to manually generate a sequence of coupon codes.
+
In the Shopping Cart Price Rules page, click the name of the rule you just created (Generate Coupons).
+
In the left navigation bar, click Manage Coupon Codes.
+
On the Coupons Information page, enter the following information:
+
+
+
+
Item
+
Description
+
+
+
Coupon Qty
+
Enter 3.
+
+
+
Code Length
+
Enter 12.
+
+
+
Code Format
+
Click Alphanumeric.
+
+
+
Coupon Prefix
+
Enter TEST-.
+
+
+
Coupon Suffix
+
Enter -TEST.
+
+
+
Dash Every X Characters
+
Enter 0.
+
+
+
+
Click Generate.
+Magento displays the three coupon codes you created in the Coupon Code section as the following figure shows.
+
+
Click Save.
+
+
Extending Magento's REST API to Include Coupon Auto-Generation
+
In the preceding section, you created a Shopping Cart Price Rule named Generate Coupons that manually generates a set of coupon codes. To use those codes, you could export them to a file, and then import them into any external program you want; however, this is a time-consuming procedure!
+
Fortunately, you can automate this process by adding a coupon code auto-generate API to Magento's existing REST API. Using this API, an external program can automatically get the coupon codes it needs.
+
The following sections discuss how to extend Magento's REST API to include the Coupon AutoGen API:
While you're implementing the Coupon AutoGen API, you must disable Magento's caching so Magento will find and use your new code immediately.
+
To disable the cache:
+
In the Magento Admin Panel, click System > Cache Management.
+The Cache Storage Management page displays as follows.
+
+
Click Select All (on the upper-left of the page).
+A check mark displays next to each Magento cache in the list.
+
From the Actions list, click Disable.
+
Click Submit.
+Magento disables the selected caches, replacing the green ENABLED status indicators with red DISABLED indicators.
+
Click Flush Magento Cache and wait for the cache to be flushed.
+
Log out of the Magento Admin Panel.
+
+
Creating Configuration Files
+
This section discusses how to create a module (also referred to as an extension). The module consists of configuration files that create a web service that extends the Magento REST API to take input from an external program. This program uses HTTP POST and OAuth calls to auto-generate coupon codes.
+
In this guide, the external program is a PHP script; however, it could be any application that uses OAuth and REST calls.
Note: It is up to you to determine ownership and permissions. This guide assumes you create files and directories as root and change the permissions appropriately later. Consult an IT administrator if you're not sure how to proceed.
+
+
Log in to your Magento server and create the following directories:
+
You must create the files and directories exactly as shown; directory names are case-sensitive.
+
Do not change any values in the configuration files discussed in this section.
+
When you create your configuration files, leave no white space at the beginning of the files. Leading white space might cause errors when Magento reads the files and might prevent the coupon demonstration module from working.
+
+
+
+
Change to the magento-install-dir/app/etc/modules directory.
+
In that directory, use a text editor to create your module declaration file. This file must be named CouponDemo_AutoGen.xml and have the following contents.
+
Save your changes to Coupon.php and exit the text editor.
+
Change to the magento-install-dir/app/code/community/CouponDemo/AutoGen/Model/Api2/Coupon/Rest/Admin directory.
+
Create a file named V1.php with the following contents.
+
+<?php
+/* Coupon AutoGen REST API
+*
+* @category CouponDemo
+* @package CouponDemo_AutoGen
+* @author Chuck Hudson (used with permission). For more recipes, see Chuck's book http://shop.oreilly.com/product/0636920023968.do
+*/
+class CouponDemo_AutoGen_Model_Api2_Coupon_Rest_Admin_V1 extends CouponDemo_AutoGen_Model_Api2_Coupon
+{
+ /**
+ * Generate one or more coupon codes using the Generate Coupons rule defined in Magento.
+ * Expected parameters are:
+ * {
+ * 'qty': int, - number of coupon codes to instruct Magento to generate
+ * 'length': int, - length of each generated coupon code
+ * 'format': string, - alphanum (for alphanumeric codes), alpha (for alphabetical codes), and num (for numeric codes)
+ * }
+ *
+ * @param array $couponData
+ * @return string|void
+ */
+ protected function _create($couponData)
+ {
+ $ruleId = $this->getRequest()->getParam('rule_id');
+ $couponData['rule_id'] = $ruleId;
+ $rule = $this->_loadSalesRule($ruleId);
+ // Reference the MassGenerator on this rule.
+ /** @var Mage_SalesRule_Model_Coupon_Massgenerator $generator */
+ $generator = $rule->getCouponMassGenerator();
+ // Validate the generator
+ if (!$generator->validateData($couponData)) {
+ $this->_critical(Mage::helper('salesrule')->__('Coupon AutoGen API: Invalid parameters passed in.'),
+ Mage_Api2_Model_Server::HTTP_BAD_REQUEST);
+ } else {
+ // Set the data for the generator
+ $generator->setData($couponData);
+ // Generate a pool of coupon codes for the Generate Coupons rule
+ $generator->generatePool();
+ }
+ }
+ /**
+ * Retrieve list of coupon codes.
+ *
+ * @return array
+ */
+ protected function _retrieveCollection()
+ {
+ $ruleId = $this->getRequest()->getParam('rule_id');
+ $rule = $this->_loadSalesRule($ruleId);
+ /** @var Mage_SalesRule_Model_Resource_Coupon_Collection $collection */
+ $collection = Mage::getResourceModel('salesrule/coupon_collection');
+ $collection->addRuleToFilter($rule);
+ $this->_applyCollectionModifiers($collection);
+ $data = $collection->load()->toArray();
+ return $data['items'];
+ }
+ /**
+ * Load sales rule by ID.
+ *
+ * @param int $ruleId
+ * @return Mage_SalesRule_Model_Rule
+ */
+ protected function _loadSalesRule($ruleId)
+ {
+ if (!$ruleId) {
+ $this->_critical(Mage::helper('salesrule')
+ ->__('Rule ID not specified.'), Mage_Api2_Model_Server::HTTP_BAD_REQUEST);
+ }
+ $rule = Mage::getModel('salesrule/rule')->load($ruleId);
+ if (!$rule->getId()) {
+ $this->_critical(Mage::helper('salesrule')
+ ->__('Rule was not found.'), Mage_Api2_Model_Server::HTTP_NOT_FOUND);
+ }
+ return $rule;
+ }
+}
+
+
Save your changes to V1.php and exit the text editor.
+
+
Setting Permissions on the Configuration Files
+
File permissions and ownership are important for any Linux application. Magento provides general guidelines for permission and ownership although following them are not a requirement for this guide. The configuration files and directories can be owned by root or other users and it won't prevent the procedures discussed in this guide from completing successfully.
+
Consult your network administrator if you are not sure how to set file permissions and ownership. The procedure that follows is a suggestion only.
+
The Magento guidelines discussed in the following procedure are taken from this Magento Wiki article and set the following:
+
File and directory ownership set to your-login-name:apache-user-group.
+If you're not sure which group owns Apache processes, enter the command ps -ef | grep apache2. The following procedure assumes it is www-data.
+
File permissions set to 644.
+
Directory permissions set to 755.
+
To optionally set permissions and ownership according to Magento guidelines:
+
As a user with root privileges, enter the following commands in the order shown to change ownership of the files and directories you created as discussed in this guide:
+
cd magento-install-dir/app/code/community
+chown -R your-login-name:www-data CouponDemo
+find . -type f -exec chmod 644 {} +
+find . -type d -exec chmod 755 {} +
+
As a user with root privileges, enter the following commands in the order shown to change the permissions and ownership of CouponDemo_AutoGen.xml .
+
cd magento-install-dir/app/etc/modules
+chown your-login-name:www-data CouponDemo_AutoGen.xml
+chmod 644 CouponDemo_AutoGen.xml
+
+
Securing the Coupon AutoGen API
+
For security reasons, Magento allows only authorized external programs to call the Magento REST API.
+
The following sections discuss how to enable the test script (discussed in the next section) to call the Coupon AutoGen API:
To use the Magento Admin Panel to create a role for the Coupon AutoGen API:
+
Log in to the Magento Admin Panel as an administrator.
+
Click System > Web Services > REST - Roles.
+
On the REST—Roles page, click Add Admin Role.
+
In the Role Name field, enter Coupon Auto Generate Demo.
+
Click Save Role.
+
In the left navigation bar, click Role API Resources.
+The Role Resources page contains a hierarchical list of resources to which you can grant or deny the Coupon Auto Generate Demo role access.
+
From the Resource Access list, click Custom.
+
Select the checkbox next to the node labeled CouponDemo API.
+
Magento automatically checks the child checkboxes as the following figure shows.
+
+
Click Save Role.
+Magento saves the resource API permissions you granted to the Coupon Auto Generate Demo REST role.
+The Coupon Auto Generate Demo role now has permission to use the Coupon AutoGen API.
+
+
Adding Users to the Coupon Auto Generate Demo Role
+
Now that you have a role, you must add users to give them permission to call the Coupon AutoGen API as follows:
+
In the left navigation bar, click Role Users.
+
Click Reset Filter (in the upper-right corner of the page).
+The page displays all registered users as the following figure shows.
+
+
Select the checkbox next to each user to grant the user privileges to access the resources available to the Coupon Auto Generate Demo REST role—that is, permission to call the Coupon AutoGen API.
+
Note: If a warning dialog box displays, click OK to dismiss it. This warning is not relevant when adding users to REST roles.
+
+
When you're done, click Save Role.
+The specified user(s) can now grant an external program the right to call the Coupon AutoGen API.
+
+
Setting up REST Attributes for the Coupon AutoGen API
+
This section discusses how to enable any user with a REST Admin role to use the Coupon AutoGen API.
+
To set REST attributes for the REST Admin role:
+
Click System > Web Services > REST - Attributes.
+
On the REST Attributes page, under User Type, click Admin.
+
In the User Type Resources section, from the Resource Access list, click Custom.
+
Select the CouponDemo API checkbox.
+Doing so selects all the child checkboxes, as the following figure shows.
+
+
Click Save.
+Any user with the REST Admin role can now read from and write to the Coupon AutoGen API.
+
+
Creating an OAuth Consumer for Your Test Script
+
This section discusses how to create a consumer so you can test the Coupon AutoGen API before you deploy it in a production system. After successfully testing the API, you can remove this user.
+
In the Magento Admin Panel, click System > Web Services > REST - OAuth Consumers.
+
Click Add New (in the upper-right corner of the page).
+The New Consumer page displays as the following figure shows.
+
+
In the Name field, enter Coupon AutoGen Test Driver.
+
Leave the other fields blank.
+
Write down the values displayed in the Key and Secret text boxes.
+
Note: The key and secret values are stored in the Magento database in the table oauth_consumer. It might be more convenient for you to use phpmyadmin or database tools to retrieve them from the database after you save the role.
+You must include these values in the test script you will write in the next section. The script uses these values to identify itself to Magento.
+
Click Save (in the upper-right corner of the page).
+
Log out of the Magento Admin Panel.
+
+
Testing the Coupon AutoGen API
+
This section discusses how to create a simple PHP file that acts as an external program and, with permissions you granted the OAuth consumer, enables the program to use the HTTP POST method to auto generate coupon codes.
+
You can use any type of OAuth/REST call, in fact, such as using the Firefox REST Client plug-in as discussed here.
+
The following sections discuss how to create and run the test script:
The test script you create calls the Coupon AutoGen API, thereby causing Magento to generate the specified coupon codes and return them to the caller (rest_test.php) in the form of a JSON-encoded string. Finally, the server responds to the browser's request with an HTML page containing the generated coupon codes.
+
The PHP code that follows:
+
Uses your OAuth consumerKey and consumerSecret to set up the OAuth client.
+
Defines data to pass to the array $couponGenerationData. The data should include the following:
+
The rule ID (listed next to the rule in the rule list in the Magento Admin Panel)
+
The number of codes desired (in this case, two)
+
The length of the codes
+
The format to be used (in this case, alphanumeric)
+
+
The array of parameters is then passed in the fetch command with the resourceUrl for the web service call.
+
+
+
Finally, the server responds to the browser's request with an HTML page containing the generated coupon codes.
+
To create the test script, named rest_test.php:
+
Create the file magento-install-dir/rest_test.php with the following contents.
+
+<?php
+/********************************************************************
+File name: rest_test.php
+Description:
+A PHP test script that calls the Coupon AutoGen extension
+to Magento's REST API.
+The Coupon AutoGen API takes:
+-- the rule ID of the "Generate Coupons" rule to execute
+-- the number of coupon codes to generate
+-- the length of each coupon code
+-- the format of each coupon code
+The API returns the generated coupon codes, in JSON-encoded form
+ ********************************************************************/
+// Replace <<...>> below with the key and secret values generated for the Coupon AutoGen Test Driver
+$consumerKey = '<<YOUR CONSUMER KEY>>'; // from Admin Panel's "REST - OAuth Consumers page"
+$consumerSecret = '<<YOUR CONSUMER SECRET>>'; // from Admin Panel's "REST - OAuth Consumers page"
+
+// Set the OAuth callback URL to this script since it contains the logic
+// to execute *after* the user authorizes this script to use the Coupon AutoGen API
+$callbackUrl = "http://<<host-or-ip:port>>/<<path>>/rest_test.php";
+
+// Set the URLs below to match your Magento installation
+$temporaryCredentialsRequestUrl = "http://<<host-or-ip:port>>/<<path>>/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
+$adminAuthorizationUrl = 'http://<<host-or-ip:port>>/<<path>>/admin/oauth_authorize';
+$accessTokenRequestUrl = 'http://<<host-or-ip:port>>/<<path>>/oauth/token';
+$apiUrl = 'http://<<host-or-ip:port>>/<<path>>/api/rest';
+
+session_start();
+if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
+ $_SESSION['state'] = 0;
+}
+try {
+ $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
+ $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
+ $oauthClient->enableDebug();
+ if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
+ $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
+ $_SESSION['secret'] = $requestToken['oauth_token_secret'];
+ $_SESSION['state'] = 1;
+ header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
+ exit;
+ } else if ($_SESSION['state'] == 1) {
+ $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
+ $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
+ $_SESSION['state'] = 2;
+ $_SESSION['token'] = $accessToken['oauth_token'];
+ $_SESSION['secret'] = $accessToken['oauth_token_secret'];
+ header('Location: ' . $callbackUrl);
+ exit;
+ } else {
+ // We have the OAuth client and token. Now, let's make the API call.
+ $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
+ // Set the array of params to send with the request
+ $ruleId = <<RULE_ID>>; // Set to the rule ID of the Generate Coupons rule
+ $couponGenerationData = array();
+ $couponGenerationData['qty'] = 2; // Number of coupons codes to create
+ $couponGenerationData['length'] = 7; // Length of each coupon code
+ // Options for format include:
+ // alphanum (for alphanumeric codes), alpha (for alphabetical codes), and num (for numeric codes)
+ $couponGenerationData['format'] = "alphanum"; // Use alphanumeric for the coupon code format
+ // Generate coupon codes via POST
+ $resourceUrl = "$apiUrl/coupondemo/rules/{$ruleId}/codes";
+ $oauthClient->fetch($resourceUrl, json_encode($couponGenerationData), OAUTH_HTTP_METHOD_POST, array(
+ 'Accept' => 'application/json',
+ 'Content-Type' => 'application/json',
+ ));
+ // Retrieve list of created coupons via GET
+ $collectionFilters = array('limit' => $couponGenerationData['qty'], 'order' => 'coupon_id', 'dir' => 'dsc');
+ $oauthClient->fetch($resourceUrl, $collectionFilters, OAUTH_HTTP_METHOD_GET, array(
+ 'Accept' => 'application/json',
+ 'Content-Type' => 'application/json',
+ ));
+ $coupons = json_decode($oauthClient->getLastResponse(), true);
+ // Display the newly generated codes to demonstrate that the Coupon AutoGen API works
+ // In reality, you might put these codes in emails to customers, store them in a database, etc.
+ echo "New coupon codes: ";
+ foreach ($coupons as $coupon) {
+ echo " --> " . $coupon['code'] . " ";
+ }
+ }
+} catch (OAuthException $e) {
+ print_r($e->getMessage());
+ echo " ";
+ print_r($e->lastResponse);
+}
+
+
The following table discusses the values you must change.
+
+
+
+
String to change
+
How to change it
+
+
+
<<YOUR CONSUMER KEY>>
+
Coupon AutoGen Test Driver OAuth consumer's key.
+
You can view this in the Admin Panel: System > Web Services > REST - OAuth Consumers or you can get the value from the oauth_consumer table in the Magento database.
+
+
+
<<YOUR CONSUMER SECRET>>
+
Coupon AutoGen Test Driver OAuth consumer's secret.
+
You can view this in the Admin Panel: System > Web Services > REST - OAuth Consumers or you can get the value from the oauth_consumer table in the Magento database.
+
+
+
+
<<host-or-ip:port>>/<<path>>
+
Your Magento instance's fully qualified hostname or IP address and port, if you are using a port other than 80, and the path to your Magento installation. If you are running Magento on localhost, enter 127.0.0.1
+
For example, if your Magento server's hostname is www.example.com, running on port 80, and Magento is installed at /var/www/magento, enter http://www.example.com/magento
+
+
+
<<RULE_ID>>
+
Generate Coupons rule ID.
+
Get this value by clicking Promotions > Shopping Cart Price Rules
.
+
+
+
+
Save the file and close the text editor.
+
+
Running the Test Script
+
To run the test script:
+
Start a web browser.
+
In the browser's address or location field, enter:
+
When prompted, click Authorize to grant authorization for the script to access your OAuth consumer account, as the following figure shows.
+
+
When prompted, log in as that user.
+After you log in, two new coupon codes display as follows to confirm you successfully used the API. If your browser displays a page like this one, you've successfully implemented the Coupon AutoGen REST API!
+
+
To optionally see these codes in the Admin Panel:
+
Log in to the Admin Panel as an administrator.
+
Click Promotions > Shopping Cart Price Rules.
+
Click Generate Coupons.
+
In the left navigation bar, click Manage Coupon Codes.
+The codes you generated manually earlier display with the new codes (highlighted in red) as the following figure shows.
+
+
+
Re-Enabling Magento's Cache
+
Only after successfully completing the test, you should re-enable Magento's caching system, so performance returns to normal.
+
To re-enable the Magento cache:
+
In the Magento Admin Panel, click System > Cache Management.
+
On the Cache Storage Management page, click Select All (in the upper-left of the page).
+A check mark displays next to each Magento cache in the list.
+
Click Enable from the Actions list.
+
Click Submit.
+Magento enables the selected caches. You can tell because the red DISABLED status indicator is replaced by a green ENABLED indicator.
+
Click Select All again.
+
Click Refresh from the Actions list.
+
Click Submit.
+Magento reloads the selected caches. Magento now performs much faster.
+
Congratulations! You have successfully added the Coupon AutoGen API to Magento's REST API. Following the same procedure, you can expose lots of Magento functionality to external programs.
+
+
Troubleshooting Suggestions
+
The following sections discuss solutions to issues you might encounter when setting up this demonstration:
Problem: OAuth package installation fails with the error ERROR: `make' failed.
+
Description: In some cases, the pecl install oauth command does not install a C compiler. If you encounter the following error, you must install the make package; otherwise, OAuth won't compile:
+
1: make: not found
+ERROR: `make' failed
+
Solution:
+
Enter the following commands in the order shown as a user with root privileges:
+
apt-get install make
+pecl install oauth
+
Make sure the message Build process completed successfully displays to indicate OAuth compiled successfully.
+If the following displays, you must edit your php.ini file to find the OAuth library:
+
configuration option "php_ini" is not set to php.ini location
+You should add "extension=oauth.so" to php.ini
+
Open php.ini in a text editor.
+If you're not sure where it's located look in the phpinfo.php page output.
+Add the following anywhere in php.ini:
+
[OAuth]
+extension=oauth.so
+
Save your changes to php.ini and exit the text editor.
+
Enter the following command to restart the Apache web server.
+
CouponDemo API Calls Options Don't Display in the Admin Panel
+
Problem: After setting up the CouponDemo configuration files, the CouponDemo API Calls checkboxes do not display in the Admin Panel. A sample is shown in a figure earlier in this guide.
+
Description: The CouponDemo API Calls checkboxes display to indicate you set up the module correctly. If they don't display, either the Magento cache hasn't been entirely cleared or there's something wrong with the directory structure or configuration files.
+
Solution: Use the following steps to isolate and correct the issue:
Make sure you copied the exact text from the sample configuration files discussed in Creating Configuration Files. Do not change anything, and remember that case is important.
+
Clear the Magento cache in all of the following ways:
+
As a user with sufficient privileges to delete files and directories in the Magento installation, enter the following commands:
+
Log in to the Magento Admin Panel as an administrator and click System > Cache Management.
+Click Flush Magento Cache.
+Click Flush Cache Storage and follow the prompts on your screen to delete the cache storage.
+
+
Log out of the Magento Admin Panel and log back in.
+
Click System > REST - Roles.
+
Click Coupon Auto Generate Demo.
+
In the left navigation bar, click Role API Resources.
+
If the CouponDemo API Calls checkboxes do not display, double-check all of the .xml configuration files to make sure there is no leading white space (that is, there are no blank lines at the beginning of the files.
+Remove any blank lines and save the .xml files.
+
+
Errors Running rest_test.php
+
The following sections discuss issues you might encounter when you run rest_test.php in a web browser:
Invalid auth/bad request (got a 401, expected HTTP/1.1 20X or a redirect)
+{"messages":{"error":[{"code":401,"message":"oauth_problem=consumer_key_rejected"}]}}
+
Description: Your OAuth authentication attempt failed because the credentials are incorrect.
+
Solution: Open rest_test.php in a text editor and verify the values of the following:
You can find these values in the oauth_consumer database table or in the Admin Panel: System > Web Services > REST - OAuth Consumers.
+
After verifying the correct values, save your changes to rest_test.php and try again.
+
+
Invalid auth/bad request: Rule was not found
+
The following error displays in the web browser:
+
Invalid auth/bad request (got a 404, expected HTTP/1.1 20X or a redirect)
+{"messages":{"error":[{"code":404,"message":"Rule was not found."}]}}
+
Description: The shopping cart promotion rule could not be found.
+
Solution: Open rest_test.php in a text editor and verify the value of the following:
+
$ruleId = value;
+
You can find this value in the Admin Panel: Promotions > Shopping Cart Price Rules.
+
Change the value in rest_test.php, save it, and try again.
+
+
Invalid auth/bad request: /magento/oauth/initiate was not found on this server
+
The following error displays in the web browser:
+
Invalid auth/bad request (got a 404, expected HTTP/1.1 20X or a redirect)
+Not Found
+The requested URL /magento/oauth/initiate was not found on this server.
+
Description: The HTTP redirect failed, most likely because web server rewrites are not properly enabled.
+
Solution: Make sure web server rewrites are enabled. The procedure you use depends on your web server and operating system. An example for Ubuntu can be found here.
+
+
Next Steps
+
Refer to Magento APIs—REST for documentation explaining how the Magento's REST API framework works.
+
diff --git a/guides/v1.8/other/ht_install-patches.html b/guides/v1.8/other/ht_install-patches.html
new file mode 100644
index 0000000000..e6aee0a2a5
--- /dev/null
+++ b/guides/v1.8/other/ht_install-patches.html
@@ -0,0 +1,150 @@
+---
+layout: v1x
+title: How to Apply and Revert Magento Patches
+---
+
+
+
+
Note: This article assumes your patch file name ends in .sh. If your patch file name ends in .patch or something else, contact Magento Support before proceeding.
+
+
Need More Detail?
+
For more step-by-step details that are provided here, see one of the following:
Log in to magentocommerce.com/download.
+ (Click My Account in the upper right corner of the page.)
+ If you don't have an account, you can register for one; the account is free.
+
In the Magento Community Edition Patches section, locate the patch to install.
+
From the list next to the patch, choose your CE version.
Log in to magentocommerce.com.
+ (Click My Account in the upper right corner of the page.)
+
Click Downloads in the left pane.
+
Click Magento Enterprise Edition in the right pane.
+ The following figure shows an example.
+
+
Click Support Patches.
+
Locate the patch to download.
+
Click Download corresponding to the patch for the version of EE you're using.
+
After the download completes, continue with the next section.
+
+
How to Apply a Magento Patch
+
To apply a Magento patch:
+
Transfer the patch .sh file to your Magento installation root directory.
+
Note: This article assumes your patch file name ends in .sh. If your patch file name ends in .patch or something else, contact Magento Support before proceeding.
+
+ For example, /var/www/html/magento.
+
Enter the following commands as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
+ A message such as the following displays to confirm the patch installed successfully:
+
Patch was applied/reverted successfully.
+
To reapply ownership to the files changed by the patch:
+
Find the web server user: ps -o "user group command" -C httpd,apache2
+ The value in the USER column is the web server username.
+ Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
+
As a user with root privileges, enter the following command from the Magento installation directory:
+
chown -R web-server-user-name .
+ For example, on Ubuntu where Apache usually runs as www-data, enter
+
chown -R www-data .
+
+
Perform any other tasks as instructed by Magento Support.
+ (For example, some patches require you to stop external services, such as the Solr search engine.)
+
+
How to Apply the SUPEE-8788 Patch
+
We released a security patch in October, 2016 that might cause issues for some users. This section applies to you if any of the following is true:
+
You haven't yet applied the SUPEE-8788 patch and your Magento version is earlier than EE 1.14.1.0 or CE 1.9.1.0.
+
You applied version 1 of the SUPEE-8788 patch. (The patch name includes PATCH_SUPEE-8788_<magento version>_v1.)
+
You previously applied the SUPEE-1533 patch and you want to apply the SUPEE-8788 patch.
+
You're applying the SUPEE-8788 patch as part of an upgrade from an earlier Magento version.
+
+
We recommend the following:
+
If you applied SUPEE-8788 version 1, revert that patch, revert SUPEE-1533 (version restrictions apply), apply SUPEE-3941 (version restrictions apply), then apply SUPEE-8788 version 2 or later.
+
If you haven't applied SUPEE-8788, revert SUPEE-1533 (version restrictions apply), apply SUPEE-3941 (version restrictions apply), then apply SUPEE-8788.
+
+
Replace SUPEE-8788 version 1 with version 2 or later
+
To replace SUPEE-7877 version 1 with version 2 or later:
+
Log in to your Magento server.
+
Open <your Magento install dir>/app/etc/applied.patches.list in a text editor.
+ This file lists all currently applied patches.
+
Determine which patches are already applied. Version 1 of SUPEE-8788 includes PATCH_SUPEE-8788_<magento version>_v1 in the name.
+
If your Magento version is EE 1.14.1.0 or CE 1.9.1.0, and patch SUPEE-1533 is applied, revert SUPEE-1533.
+
If your Magento version is earlier than EE 1.14.1.0 or CE 1.9.1.0, and SUPEE-3941 is not applied, apply SUPEE-3941.
+
+ If the files are present, delete them to avoid a potential security exploit. As of Magento CE 1.9.0.0 and Magento EE 1.14.0.0, we no longer distribute .swf files with the Magento software.
+
+
Apply SUPEE-8788
+
To apply patch SUPEE-8788:
+
Open <your Magento install dir>/app/etc/applied.patches.list in a text editor.
+
+ If the files are present, delete them to avoid a potential security exploit. As of Magento CE 1.9.0.0 and Magento EE 1.14.0.0, we no longer distribute .swf files with the Magento software.
+
+
Listing Patches You Have Installed
+
If you're not sure which patches are already applied, open <your Magento install dir>/app/etc/applied.patches.list.
+
+
How to Revert a Magento Patch
+
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
+
Change to your Magento installation directory.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh patch-file-name.sh -R
+
+
Troubleshooting
+
If you get an error when you run the patch, use the following suggestions:
+
Verify the patch is located in your Magento installation root directory.
+ Ubuntu example: /var/www/magento
+ CentOS example: /var/www/html/magento
+
Verify you're running the patch with sufficient privileges.
+ Typically, this means running it as the web server user or as a user with root privileges.
This guide is intended for Magento EE administrators and systems integrators who have some familiarity with search
+ engines—ideally, who also have Solr configuration experience. No programming is required to perform the tasks
+ discussed in this guide.
+
This guide discusses a simple Solr configuration that uses the example Solr configuration provided with Solr, default
+ Solr integration options provided with Magento EE, and also explains how to configure Magento EE to use Solr. Advanced
+ configuration tasks—such as setting up dictionaries—are beyond the scope of this guide.
+
Note: The example Solr configuration is not intended to be used in a
+ production site. It's for testing and development only. Because it's simple to use which, it's a great way for you
+ to learn more about Solr.
+
+
Comparing the Search Options
+
The following table provides a quick comparison between Magento with the default MySQL full text search and Magento
+ with Solr search.
+
+
+
+
+
+
Feature
+
Magento with MySQL full-text search
+
Magento with Solr search
+
+
+
Full text search
+
+
Yes and also supports two additional search modes:
+
+
Like
+
Combined (like and full text)
+
+
Yes†
+
+
+
Search recommendations
+
Yes
+
Yes
+
+
+
Faceted search (used in layered navigation)
+
Yes
+
Yes
+
+
+
Range (such as price range)
+
Yes
+
Yes
+
+
+
Sort-by options (for example, sort by relevance)
+
Yes
+
Yes
+
+
+
Zero results tips or results correction
+
No
+
Yes
+
+
+
Suggestions
+
No
+
Yes
+
+
+
Clustering
+
No
+
Yes
+
+
+
Attribute weight based on attribute settings
+
No
+
Yes
+
+
+
Search localized characters
+
No
+
Yes
+
+
+
Word delimiter (for example, searching for spider man or spiderman
+ return spider-man)
+
No
+
Yes
+
+
+
+†—"Like" searching is supported by MySQL full text search but not by Solr. Defined by the
+Mage_CatalogSearch_Model_Resource_Fulltext::prepareResult() class, like searching joins each term in your
+search using LIKE statements combined by OR. Like searching is best used in stores that have simple products where users
+search for specific terms.
+
+
Support Matrix for Solr and Magento EE
+
The following table summarizes what versions of Magento EE work with what versions of Solr.
+ Click here to browse the list of all
+ available Solr versions.
+
+
+
+
+
Note: Magento EE does not support Solr 4.x.
+
+
More Information About the Solr Solution
+
Solr runs as a standalone full-text search server in a servlet container such as Jetty (which is used by the Solr
+ example configuration) and Tomcat.
+
Solr uses the Lucene Java search library for full-text indexing and search. Your applications interact with Solr
+ using HTTP POST (in JSON,
+ XML, CSV, or binary formats) to index
+ documents and using HTTP
+ GET to retrieve search results back as JSON, XML, or a
+ variety of other formats (Python, Ruby, PHP, CSV, binary, and so on). If you're a programmer, try the Solr tutorial. Whether
+ you're a programmer or not, read the Solr FAQ.
+
No programming is required to implement Solr as discussed in this guide.
+
Solr's powerful external configuration allows it to be tailored to almost any type of application without Java
+ coding, and it has an extensive plug-in architecture when more advanced customization is required. Solr is highly
+ scalable, providing distributed search and index replication.
+
Important: Customize the Solr search engine at your own risk. Magento
+ supports only the options displayed in the Admin Panel. Customizing the Solr engine itself, while potentially
+ useful, can cause issues with Magento. If you encounter problems with your customizations, do not contact Magento
+ Support; instead, consult the resources available from the Apache Solr Wiki.
+
In this guide, you'll use the example configuration provided with Solr and Magento's provided Solr configuration to
+ implement a simple, quick integration with Solr.
+
Some reasons to use Solr with Magento include:
+
+
Magento ships with a sample Solr configuration that enables you to provide users with a powerful search engine
+ without your needing to customize any code.
+
You get better performance of search, catalog views, and layered navigation.
+
When the system is under load, Solr avoids frequent updates of the MySQL catalogsearch_fulltext table and
+ alleviates issues with database table locks.
+
+
+
+
Simple Comparison of Solr and MySQL Search Engines
+
Following is a simple comparison of the default MySQL full-text search and Solr search using Magento EE 1.14.0.0 and
+ Solr 3.6.2. Magento EE catalog content is provided by sample data you can download from Magento.
+
Among the many options Solr gives you is the option to suggest names of products in the event the user
+ enters an incomplete or incorrect search term in your Magento store's Search field.
+
+
Default MySQL Full-Text Search Using an Incorrect Search Term
+
Using the default MySQL full-text search, if a user enters an incorrect search term (such as shirrt instead
+ of shirt, no results display as the following figure shows.
+
+
+
Solr Search Using an Incorrect Search Term
+
Using Solr, if a user enters an incorrect search term, suggestions display as the following figure shows.
+
+
In addition, if a user enters an incomplete search term, Magento provides dictionary-based suggestions as the
+ following figure shows.
+
+
+
Prerequisites
+
The tasks discussed in this guide require the following:
Java version 1.6 or later.
+ To determine if Java is already installed, enter the following command:
+
java -version
+ If the message java: command not found displays, you must install the Java SDK as discussed in the next
+ section. If Java is installed, make sure it's version 1.6 or later.
+
Tomcat or Jetty servlet container. This guide discusses using Jetty, which comes with Solr. Consult another
+ resource, such as the Solr Wiki, to use Tomcat
+ with Solr.
+ To see if you're currently running Jetty and to check the version, see How
+ to find out the version of Jetty.
+
+
+
Installing Prerequisite Software
+
The following sections discuss how to install the prerequisite software:
To install the Java 6 SDK, enter the following command as a user with root privileges:
+
apt-get install openjdk-6-jdk
+
To install Java 7, enter the following command as a user with root privileges:
+
apt-get install openjdk-7-jdk
+
Note: Java version 7 might not be available for all operating systems. For
+ example, you can search the list of available packages for Ubuntu here.
+
+
Installing Solr 3.6.2 and Jetty
+
The Apache Solr package installs both Solr and Jetty. If Jetty is already installed, see the Solr with Jetty Wiki for more information.
+
Note: Tomcat is also a supported servlet container for Solr but discussing how to
+ set up Tomcat with Solr is beyond the scope of this guide. For more information, see the Solr With Tomcat Wiki.
Copying the Magento Solr Configuration and Starting Solr
+
Magento comes packaged with a sample Solr configuration you can use and customize. To get started, you'll copy the
+ Magento configuration to Solr, replacing any existing files. After that you can start Solr and begin configuring
+ Magento to work with it.
+
Note: The example Solr configuration is not intended to be used in a
+ production site. It's for testing and development only. It's simple to use which makes it a great way for you to
+ learn more about Solr.
+
+
To copy the Magento Solr configuration:
+
+
As a user with root privileges, enter the following commands in the order shown to copy over the Solr
+ configuration with the one packaged with Magento EE:
+ For example, if Solr is installed in /etc/solr/apache-solr-3.6.2 and Magento is installed in
+ /var/www/magento, enter:
+
cd /etc/solr/apache-solr-3.6.2/example/solr/conf
+cp -R /var/www/magento/lib/Apache/Solr/conf/* .
+
Note: If you're prompted to overwrite files, try the command \cp -R [your
+ Magento install dir]/lib/Apache/Solr/conf/* .
+
+
CentOS with Tomcat 6 only. If you're using Tomcat 6 on CentOS, you must modify [your Solr install
+ dir]/example/solr/conf/solrconfig.xml
+ Locate the following line:
+
<dataDir>${solr.data.dir:./solr/data}</dataDir>
+ Change it to:
+
<dataDir>${solr.data.dir:}</dataDir>
+
+
+
As a user with root privileges, enter the following command to start Solr:
Note: This method for starting Solr is for convenience and testing purposes
+ only. In a production environment, you should start and stop Solr using a script as discussed in Scripting Solr Startup and Shutdown.
+
+
Configuring Magento to Work With Solr
+
This section discusses how to configure Magento EE to use the Solr search engine.
+
To configure Magento to work with Solr:
+
+
Log in to the Magento Admin Panel as an administrator.
+
Click System > Configuration > CATALOG > Catalog.
+
In the right pane, expand Catalog Search.
+
The following table shows the minimum amount of information to enter to test the connection to your Solr
+ search engine. Leave all other values at their defaults.
+
+
+
+
+
+
Option
+
Description
+
+
+
Search Engine
+
Click Solr
+
+
+
Solr Server Hostname
+
Enter the fully qualified hostname or IP address of the machine running Solr. (If
+ Solr is running on the same host as Magento, you can optionally use 127.0.0.1.)
+
+
+
Solr Server Port
+
Enter Solr's listen port. (The example Jetty servlet container uses 8983. The
+ default for Tomcat is usually 8080.)
Specifies the path and name of the Solr web application. The path used by the example Solr
+ configuration is solr.
+
If you customized Solr, the value you enter in this field must exactly match the value of
+ webapp_name=value in [your Solr install
+ dir]/example/solr/conf/scripts.conf.
+
+
+
+
Indexation Mode
+
+
Specifies how Solr processes indexed content.
+
From the Indexation Mode list, click one of the following:
+
+
+
Final commit (Default, recommended): After you reindex the content
+ search index, Solr starts processing content. Users see results from content that was searchable
+ before indexing started and the Magento store remains available for other requests.
+
Final commit has much better performance then partial commit, and does not require any additional
+ Solr configuration as does engine autocommit.
+
Indexing begins after all unneeded data is removed and new data is added. At that point, users
+ see results from newly indexed data immediately.
+
+
Partial commit: All content is removed from Solr after you reindex the content
+ search index and users at that time see no search results. As content is gradually reindexed, users
+ see only the results of content that has been indexed.
+
+
Engine autocommit: Content is put in the index queue but is not committed. You
+ must configure Solr to commit at regular intervals (for example, every 5 minutes) or when a
+ certain number of uncommitted items is reached.
Click Test Connection.
+ The button changes as follows.
+
+
+
+
+
+
Button state
+
Meaning
+
+
+
+
The test connection succeeded. Click Save Config and continue
+ with the next section.
+
+
+
+
The test connection failed. Try the following:
+
+
Examine the command window in which you started Solr for stack traces and exceptions. You must
+ resolve those before you continue.
+ In particular, make sure you started Solr as a user with root privileges.
Verify the value of the Solr Server Hostname field. Make sure the server is
+ available. You can try the server's IP address instead.
+
Use the command netstat -an | grep listen-port command to verify that the port
+ specified in the Solr Server Port field is not being used by another process.
+ For example, to see if Solr is running on its default port, use the following command:
+
netstat -an | grep 8983
+ If Solr is running on port 8983, it displays similar to the following:
+ tcp 0 0 :::8983 :::* LISTEN
+
If Solr is installed on a remote machine, use the ping command to verify that machine is
+ reachable from your Magento instance.
+
If SELinux is enabled, make sure the Solr servlet container's listen port is available; otherwise,
+ Magento cannot communicate with the servlet container. For example, you can consult the SELinux Centos wiki.
+
+
+
+
+
+
+
Only after the test connection succeeds, click Save Config and continue with the next
+ section.
+
+
+
Basic Solr Configuration
+
This section discusses how to configure Magento to work with Solr using options in the Admin Panel. Although
+ additional Solr customization is possible, it is beyond the scope of this guide.
+
Important: Customize the Solr search engine at your own risk.
+ Magento supports only the options displayed in the Admin Panel. Customizing the Solr engine itself, while
+ potentially useful, can cause issues with Magento. If you encounter problems with your customizations, do not
+ contact Magento Support; instead, consult the resources available from the Apache Solr Wiki.
+
To configure Magento to work with Solr:
+
+
Start the Magento Admin Panel and log in as an administrator.
+
Click System > Configuration.
+
In the left navigation bar, under the CATALOG group, click Catalog > Catalog
+ Search.
+
The following table shows the minimum amount of information to enter to test the connection to your Solr
+ search engine. Leave all other values at their defaults.
+
+
+
+
+
+
Option
+
Description
+
+
+
Minimal Query Length
+
Enter the minimum number of characters permitted for a catalog search.
+
+
+
Maximum Query Length
+
Enter the maximum number of characters permitted for a catalog search.
+
+
+
Search Engine
+ Solr Server Hostname
+ Solr Server Port
+ Solr Server Username
+ Solr Server Password
+ Solr Server Timeout
+ Solr Server Path
+ Indexation Mode
+
Suggestions are the native Solr mechanism of advising users in the event they enter
+ incomplete or incorrect user input. Suggestions, when enabled, are automatically provided as part of
+ any search request.
+
Solr completes incomplete or incorrect input using a dictionary that is based on the main index (and
+ can be customized using configuration files to use any other arbitrary dictionary). Suggestions
+ display with default text "Did you mean:" in the search results page if needed.
+
Notes:
+
+
Search suggestions are not the same as AJAX hints.
+
Enabling suggestions negatively affects performance because they result in more complex queries
+ to Solr.
+
+
+
+
+
Search Suggestions Count
+
Enter the maximum number of suggestions to return.
+
+
+
Show Results Count for Each Suggestion
+
+
The default option, No, displays only the suggestion and not the number of results
+ for each suggestion.
+
Click Yes to display the number of results for each suggestion.
+
+
+
+
Enable Search Recommendations
+
+
Recommendations display terms related to a requested word or phrase on the search results
+ page.
+
This functionality is not based on third party engine functionality, but is implemented as part of
+ the Enterprise_Search module and can be shown with the Solr search suggestions block.
+
By default, Magento uses the Enterprise_Search_Model_Adapter_HttpStream module for
+ recommendations. If you install the Apache
+ Solr PHP extension, Magento automatically uses the
+ Enterprise_Search_Model_Adapter_PhpExtension adapter instead. Both adapters function in the
+ same way with no difference in performance. However, the PhpExtension adapter is not tested
+ by Magento so you must thoroughly test any modifications you make to it before deploying it in a
+ production environment.
+
Note: Enabling recommendations negatively affects
+ performance because they result in more complex queries to Solr and more database calls.
+
+
+
+
Search Recommendations Count
+
Enter the maximum number of recommendations to return.
+
+
+
Show Results Count for Each Recommendation
+
+
The default option, No, displays only the recommendation and not the number of
+ results for each recommendation.
+
Click Yes to display the number of results for each recommendation.
+
+
+
+
Enable Solr Engine for Catalog Navigation
+
+
Click Yes (the default) to use Solr to enable layered navigation in the category view.
+
Click No to use the database for layered navigation in the category view.
+
+
+
+
+
+
+
+
Reindexing Catalog Search and Refreshing the Full Page Cache
+
After you change the Solr configuration, you must reindex the catalog search index and refresh the full page
+ cache as follows:
+
+
In the Admin Panel, click System > Cache Management.
+
Select the checkbox next to Page Cache.
+
From the Actions list in the upper right, click Refresh.
+ The following figure shows an example.
+
+
+
To update the catalog search index, open a command prompt window.
+
Change to the shell subdirectory of your Magento installation directory.
+ For example, on CentOS:
+
cd /var/www/html/magento/shell
+
+
Enter the following command:
+
php indexer.php --reindex catalogsearch_fulltext
+
+
+
Scripting Solr Startup and Shutdown
+
In a production environment, you should start and stop Solr using a script.
+
Note: You must perform all tasks discussed in this section as a user with root privileges.
+
Create a script named /etc/init.d/solr with options similar to the following:
You must know the App Code for your Magento MobileConnect application.
+ To view the code, log in to the Admin Panel as an administrator and click MobileConnect > Manage Apps. You must know the value displayed in the App Code column.
+
+
+
Creating the iOS App
+
To create the iOS app:
+
Open MagentoShop/MagentoShop.xcodeproj in Xcode.
+
Locate Configuration.plist.
+
Change the value of serverURL to your store's base URL (for example, http://mystore.example.com).
+
Change the value of applicationCode to the application code displayed in the Magento Admin Panel.
+ To view the code, log in to the Admin Panel as an administrator and click MobileConnect > Manage Apps. Enter the value displayed in the App Code column.
+
Build and run your app.
+
+
Customizing Your iOS App
+
The following sections discuss how you can customize your Magento MobileConnect iOS app.
+
+
Customizing the Launch Image
+
Launch images are located in MagentoShop/Resources/Images/LaunchImages.xcassets.
+
\ No newline at end of file
diff --git a/guides/v1.8/other/payflow.html b/guides/v1.8/other/payflow.html
new file mode 100644
index 0000000000..2057d62b21
--- /dev/null
+++ b/guides/v1.8/other/payflow.html
@@ -0,0 +1,13 @@
+---
+title: 'Error Using Payflow with Magento Enterprise Edition (EE) 1.12.0.2'
+layout: v1x
+---
+
+
+
Problem
+
A customer applies a coupon code when checking out in a web store that runs EE 1.12.0.2 and is configured to use the Payflow Pro or Payflow Express payment methods. The following error displays:
+PayPal gateway rejected the request. Field format error: 10431-Item amount is invalid
+
+
Solution
+
To resolve this issue, contact Magento Support and request the patch for support issue ID SUPEE-1474.
Enable an attacker to execute arbitrary code on your Magento server.
+
Create files with a .csv extension, create writable directories, and change the permission of
+ existing files to world-writable (777).
+
+
+
Note: The preceding exploits require the attacker to have administrative access to your Magento Admin Panel Dashboard. You can resolve these issues with the patch discussed in this article.
+
+
+
+
Creating files with a .csv extension can lead to executing files like php.csv (only under
+ circumstances discussed in this article). The ability to run code with a .csv extension is dangerous
+ itself and could be combined with other attacks; for example, targeting other software installed on the server.
+
Although Magento code is protected by a hash value, the possibility of a successful exploit cannot be eliminated
+ because of the low entropy of the hash secret value.
+
We strongly recommend you to take precautions discussed in this article and apply a patch for your
+ version of Magento Enterprise Edition or Community Edition.
+
+
Versions Affected
+
Magento software versions affected: The issue affects all shipping versions of Magento Community Edition
+ (CE) and Enterprise Edition (EE).
+
Operating system versions affected:
+
+
CentOS 5.x and 6.x
+
RedHat Enterprise Linux 5.x and 6.x
+
+
+
Getting the Patch
+
The following table shows the patch you should get for your version of CE or EE.
Important: After applying your patch, Magento strongly recommends you evaluate your vulnerability and configure PHP as discussed in Resolving the Vulnerability.
+
+
+
Determining Your Vulnerability to the File System Attack
+
To determine if you're vulnerable to execution of PHP code with a non-PHP extension, search your web server
+ configuration file for the following string:
+
AddHandler application/x-httpd-php .php
+
The Apache configuration file is typically /etc/httpd/conf/httpd.conf
+
To confirm you're vulnerable:
+
+
Create a file named test.php.csv anywhere in your web server's doocroot with the following
+ contents:
+
<?php
+phpinfo()
+
+
In a web browser, display that page. (For example, http://www.example.com/path/test.php.csv
+
If your browser saves the file or prompts you to save the file instead of displaying it, your server is not
+ vulnerable. You can ignore the rest of this article.
+
+
If a page similar to the following displays, your server is vulnerable. Continue with the next
+ section.
+
+
+
+
Resolving the File System Vulnerability
+
Note: Magento strongly recommends you perform all tasks discussed in this section in a development or testing environment and not in a production environment.
+
+
+
+
To resolve this vulnerability, you must log in to the Magento server as a user with root privileges or
+ as a user with permissions to change the web server configuration.
+
To resolve the vulnerability:
+
+
Comment out the directive in httpd.conf by preceding it with a pound sign (#) as follows:
+
+ The regular expression in this setting matches .php only to the final extension in the file name,
+ applying the handler only to PHP files and preventing PHP from executing.
+
+
+
diff --git a/guides/v1.8/other/solr-ee-patches.html b/guides/v1.8/other/solr-ee-patches.html
new file mode 100644
index 0000000000..de03526da7
--- /dev/null
+++ b/guides/v1.8/other/solr-ee-patches.html
@@ -0,0 +1,351 @@
+---
+title: 'Information About Enterprise Edition (EE) Patches for Apache Solr'
+layout: v1x
+---
+
This article lists patches that Magento Support has made available for Magento EE versions 1.10.1.0 and later. The patches themselves are available on the Magento EE support portal.
+
To get the patches:
+
Log in to http://magento.com with your Magento EE credentials.
+
Click Downloads in the left navigation.
+
In the right pane, expand Magento Enterprise Edition 1.x.
+
Expand Support Patches and Security Patches > Solr Search Engine patches.
Magento EE Solr Patch for EE 1.12.0.x (ID: SUPEE-111)
+
Magento EE Version(s) Affected
+
This fix affects Magento EE 1.12.0.0, 1.12.0.1, and 1.12.0.1
+
+
Issues Fixed in the Magento EE 1.12.0.x Patch
+
Using layered navigation filtering returns the wrong results. (For example, filtering by brand has no effect.)
+
Resolved an issue where search results don't display correctly after a Magento upgrade.
+
Catalog navigation works properly.
+
Products display as expected in categories if the products have a Date attribute with the option Used for Sorting in Product Listing> set to Yes. There are no exceptions in Magento logs after reindexing.
+
Corrected the sort order of products searched by SKU.
+
Search results of products with names and/or SKUs that contains numbers, letters, and a hyphen character (-) are as expected.
+
Resolved issues with search results for products in a locale other than en_US with numeric SKUs.
+
Resolved issues with Solr not returning product search results.
+
Search results no longer include products that are either Disabled or Out of Stock.
+
+
+
Installation Instructions
+
To install this fix:
+
Stop Solr if it's currently running.
+
Download the patch .sh and transfer it to your Magento installation root directory.
+For example, /var/www/html/magento.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh PATCH_SUPEE-111_EE_1.12.0.0_v6.sh
+Note: The patch version—indicated by _v6 in this example—is subject to change. The version you get might be different.
+A message such as the following displays to confirm the patch installed successfully:
+Patch was applied/reverted successfully.
+
To reapply ownership to the files changed by the patch:
+
Find the web server user: ps -o "user group command" -C httpd,apache2
+The value in the USER column is the web server username.
+Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
+
As the owner of the files in the Magento installation directory or as a user with root privileges, enter the following command from the Magento installation directory:
+chown -R web-server-user-name .
+For example, on Ubuntu where Apache usually runs as www-data, enter
+chown -R www-data .
+
+
Copy the updated configuration files from Magento to your Solr configuration directory.
+
Back up the files in your current Solr configuration directory.
+
Enter the following command:
+cp magento-install-root/lib/Apache/Solr/conf/* solr-config-dir
+For example, if Magento is installed in /var/www/magento and Solr configuration files are located in /etc/apache-solr-3.5.0/mysolrapp/solr/conf, enter
+cp /var/www/magento/lib/Apache/Solr/conf/* /etc/apache-solr-3.5.0/mysolrapp/solr/conf
+
+
Start Solr.
+
Log in to the Admin Panel as an administrator.
+
Click System > Cache Management.
+
Click Flush Magento Cache.
+
Click System > Configuration.
+
In the left navigation bar, from the CATALOG group, click Catalog.
+
In the right pane, expand Catalog Search.
+
From the Indexation Mode list, click Final Commit.
+This is the setting Magento recommends. For a description of the other options, see the Magento EE User Guide.
+
Click System > Index Management.
+
Click the Reindex Data link in the Catalog Search row.
+
Reindex other indexers if necessary.
+
+
Reverting the Patch
+
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
+
Change to your Magento installation directory.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh PATCH_SUPEE-111_EE_1.12.0.0_v6.sh -R
+
+
Troubleshooting
+
If you get an error when you run the patch, use the following suggestions:
+
Verify the patch is located in your Magento installation root directory.
+Ubuntu example: /var/www/magento
+CentOS example: /var/www/html/magento
+
Verify you're running the patch with sufficient privileges.
+Typically, this means running it as the web server user or as a user with root privileges.
Solr search displays expected results when products use an attribute set for Catalog Input Type for Store Owner configured for Price—and this attribute is used for sorting. The following error no longer displays after reindexing the catalog search index:
+SEVERE: org.apache.solr.common.SolrException: can not sort on multivalued field
+
Search results display in the order consistent with the setting for Catalog > Attributes > Manage Label > Options.
+
Search results display correctly if you use non-default attributes.
+
A product that uses an attribute name that has a trailing space displays in search results.
+
Resolved an issue that prevented products from displaying in the web store if Solr is enabled.
+
Products can be located using layered navigation if the products have attributes set for Use in Quick Search and/or Use in Advanced Search set to No.
+
Advanced search works properly when Solr is enabled.
+
Category permissions work properly when Solr is enabled.
+
Changing pricing, such as configuring a discount for an existing product, automatically re-indexes and displays the correct price in the web store.
+
Advanced search results display as expected after toggling the value of a Yes/No attribute.
+
A product displays in search results after changing the value of the product's Visibility setting to Catalog.
+
Quick search results display as expected when the value of maximum query length is null.
+
Searching for the value of a Yes/No attribute in a supported locale other than en_US works properly.
+
Resolved issues with incorrect attribute values being assigned to a configurable product.
+
Out of stock products display in the web store when Display Out of Stock Products is set to Yes.
+
Products display in advanced search if they have attributes of multiple select and drop-down.
+
Quick search works properly in store views with a locale other than English.
+
Cron job reindexing uses the specified indexation mode for the catalog search index.
+
Simple products that are configured as part of a grouped product display in search results for the simple product's SKU.
+
A product's price attribute displays in layered navigation when Solr is enabled.
+
Resolves an issue with attributes displaying in layered navigation as empty.
+
Catalog navigation works properly.
+
Resolved issues with Solr after upgrading to EE 1.11.1.0
+
Products display in categories after import.
+
+
+
Installation Instructions
+
To install this fix:
+
Stop Solr if it's currently running.
+
Download the patch .sh and transfer it to your Magento installation root directory.
+For example, /var/www/html/magento.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh PATCH_SUPEE-107_EE_1.11.1.0_v1.sh
+Note: The patch version—indicated by _v6 in this example—is subject to change. The version you get might be different.
+A message such as the following displays to confirm the patch installed successfully:
+Patch was applied/reverted successfully.
+
To reapply ownership to the files changed by the patch:
+
Find the web server user: ps -o "user group command" -C httpd,apache2
+The value in the USER column is the web server username.
+Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
+
As the owner of the files in the Magento installation directory or as a user with root privileges, enter the following command from the Magento installation directory:
+chown -R web-server-user-name .
+For example, on Ubuntu where Apache usually runs as www-data, enter
+chown -R www-data .
+
+
Copy the updated configuration files from Magento to your Solr configuration directory.
+
Back up the files in your current Solr configuration directory.
+
Enter the following command:
+cp magento-install-root/lib/Apache/Solr/conf/* solr-config-dir
+For example, if Magento is installed in /var/www/magento and Solr configuration files are located in /etc/apache-solr-3.5.0/mysolrapp/solr/conf, enter
+cp /var/www/magento/lib/Apache/Solr/conf/* /etc/apache-solr-3.5.0/mysolrapp/solr/conf
+
+
Start Solr.
+
Log in to the Admin Panel as an administrator.
+
Click System > Cache Management.
+
Click Flush Magento Cache.
+
Click System > Configuration.
+
In the left navigation bar, from the CATALOG group, click Catalog.
+
In the right pane, expand Catalog Search.
+
From the Indexation Mode list, click Final Commit.
+This is the setting Magento recommends. For a description of the other options, see the Magento EE User Guide.
+
Click System > Index Management.
+
Click the Reindex Data link in the Catalog Search row.
+
Reindex other indexers if necessary.
+
+
Reverting the Patch
+
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
+
Change to your Magento installation directory.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh PATCH_SUPEE-107_EE_1.11.1.0_v1.sh -R
+
+
Troubleshooting
+
If you get an error when you run the patch, use the following suggestions:
+
Verify the patch is located in your Magento installation root directory.
+Ubuntu example: /var/www/magento
+CentOS example: /var/www/html/magento
+
Verify you're running the patch with sufficient privileges.
+Typically, this means running it as the web server user or as a user with root privileges.
Magento EE Solr Patch for EE 1.11.0.x (ID: SUPEE-108)
+
Magento EE Version(s) Affected
+
This fix affects Magento EE 1.11.0.0, 1.11.0.1, and 1.11.0.2.
+
+
Issues Fixed in the Magento EE 1.11.0.x Patch
+
Solr does not display an anchor category if the layered navigation block is absent, such as when this block has been removed from the layout. Search results in this case are processed by the database, not by Solr.
+
Search results display correctly regardless of the order in which content blocks load.
+
Paginated search results display the total number of pages returned by a Solr search.
+
Search results display properly for all locales supported by the Magento configuration. (A supported locale is one for which you have uploaded translations.)
+
Reindexing using a cron job no longer causes PHP fatal errors.
+
You can now enable or disable search engine recommendations.
Solr search displays expected results when products use an attribute set for Catalog Input Type for Store Owner configured for Price—and this attribute is used for sorting. The following error no longer displays after reindexing the catalog search index:
+SEVERE: org.apache.solr.common.SolrException: can not sort on multivalued field
+
Reindexing performance has been improved.
+
Search results display in the order consistent with the setting for Catalog > Attributes > Manage Label > Options.
+
Search results display correctly if you use non-default attributes.
+
Products that use an attribute name that has a trailing space display in search results.
+
Resolved an issue that prevented products from displaying in the web store if Solr is enabled.
+
Advanced search works properly when Solr is enabled.
+
Category permissions work properly when Solr is enabled.
+
Changing pricing, such as configuring a discount for an existing product, automatically re-indexes and displays the correct price in the web store.
+
Advanced search results display as expected after toggling the value of a Yes/No attribute.
+
A product displays in search results after changing the value of the product's Visibility setting to Catalog.
+
Searching for the value of a Yes/No attribute in a supported locale other than en_US works properly.
+
Resolved issues with incorrect attribute values being assigned to a configurable product.
+
Out of stock products display in the web store when Display Out of Stock Products is set to Yes.
+(In the Admin Panel, click System > Configuration > CATALOG > Inventory > Stock Options.)
+
Products display in advanced search if they have attributes of multiple select and drop-down.
+
Quick search works properly in store views with a locale other than English.
+
Products can be located using layered navigation if the products have attributes set for Use in Quick Search and/or Use in Advanced Search set to No.
+
Quick search results display as expected when the value of maximum query length is null.
+(In the Admin Panel, click System > Configuration CATALOG > Catalog Search, value of Maximum Query Length.)
+
Cron job reindexing uses the specified indexation mode for the catalog search index.
+
Simple products that are configured as part of a grouped product display in search results for the simple product's SKU.
+
A product's price attribute displays in layered navigation when Solr is enabled.
+(Attribute is configured with Catalog Input Type for Store Owner set to Price and Use In Layered Navigation set to Filterable (with results).)
+
Products display as expected in categories if the products have a Date attribute with the option Used for Sorting in Product Listing set to Yes. There are no exceptions in Magento logs after reindexing.
+
Resolves an issue with attributes displaying in layered navigation as empty.
+
Resolved an issue where search results don't display correctly after a Magento upgrade.
+
Catalog navigation works properly.
+
Search results display correctly if products have attribute values set at the store view.
+
+
+
Installation Instructions
+
To install this fix:
+
Stop Solr if it's currently running.
+
Download the patch .sh and transfer it to your Magento installation root directory.
+For example, /var/www/html/magento.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh PATCH_SUPEE-108_EE_1.11.0.2_v1.sh
+Note: The patch version—indicated by _v1 in this example—is subject to change. The version you get might be different.
+A message such as the following displays to confirm the patch installed successfully:
+Patch was applied/reverted successfully.
+
To reapply ownership to the files changed by the patch:
+
Find the web server user: ps -o "user group command" -C httpd,apache2
+The value in the USER column is the web server username.
+Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
+
As the owner of the files in the Magento installation directory or as a user with root privileges, enter the following command from the Magento installation directory:
+chown -R web-server-user-name .
+For example, on Ubuntu where Apache usually runs as www-data, enter
+chown -R www-data .
+
+
Copy the updated configuration files from Magento to your Solr configuration directory.
+
Back up the files in your current Solr configuration directory.
+
Enter the following command:
+cp magento-install-root/lib/Apache/Solr/conf/* solr-config-dir
+For example, if Magento is installed in /var/www/magento and Solr configuration files are located in /etc/apache-solr-3.5.0/mysolrapp/solr/conf, enter
+cp /var/www/magento/lib/Apache/Solr/conf/* /etc/apache-solr-3.5.0/mysolrapp/solr/conf
+
+
Start Solr.
+
Log in to the Admin Panel as an administrator.
+
Click System > Cache Management.
+
Click Flush Magento Cache.
+
Click System > Configuration.
+
In the left navigation bar, from the CATALOG group, click Catalog.
+
In the right pane, expand Catalog Search.
+
From the Indexation Mode list, click Final Commit.
+This is the setting Magento recommends. For a description of the other options, see the Magento EE User Guide.
+
Click System > Index Management.
+
Click the Reindex Data link in the Catalog Search row.
+
Reindex other indexers if necessary.
+
+
Reverting the Patch
+
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
+
Change to your Magento installation directory.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh PATCH_SUPEE-108_EE_1.11.0.2_v1.sh -R
+
+
Troubleshooting
+
If you get an error when you run the patch, use the following suggestions:
+
Verify the patch is located in your Magento installation root directory.
+Ubuntu example: /var/www/magento
+CentOS example: /var/www/html/magento
+
Verify you're running the patch with sufficient privileges.
+Typically, this means running it as the web server user or as a user with root privileges.
Magento EE Solr Patch for EE 1.10.1.x (ID: SUPEE-110)
+
Magento EE Version(s) Affected
+
This fix affects Magento EE 1.10.1.0 and 1.10.1.1.
+
+
Issues Fixed in the Magento EE 1.10.1.x Patch
+
Solr does not display an anchor category if the layered navigation block is absent, such as when this block has been removed from the layout. Search results in this case are processed by the database, not by Solr.
+
Solr search results display correctly with different settings for an attribute set that uses Use In Layered Navigation set to Filterable (no results).
+In other words, if some products are assigned to a category that do not use that attribute set, they display correctly in Solr search results if there are products in other categories that do use the attribute set.
+
Catalog search reindexing has better performance.
+
Paginated search results display the total number of pages returned by a Solr search.
+
Search results display properly for all locales supported by the Magento configuration. (A supported locale is one for which you have uploaded translations.)
+
Search results properly detect the configured price navigation step calculation.
+(In the Admin Panel, click System > Configuration > CATALOG > Catalog > Layered Navigation. From the Price Navigation Step Calculation list, click Manual.
+
Search results display correctly if you use non-default attributes.
+
Relevancy and suggestions were improved.
+
Catalog navigation works properly.
+
When the user chooses to display all search results, the correct number of results display.
+
Search results include only products that are in stock.
+
+
Installation Instructions
+
To install this fix:
+
Download the patch .sh and transfer it to your Magento installation root directory.
+For example, /var/www/html/magento.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh PATCH_SUPEE-110_EE_1.10.1.1_v2.sh
+Note: The patch version—indicated by _v2 in this example—is subject to change. The version you get might be different.
+A message such as the following displays to confirm the patch installed successfully:
+Patch was applied/reverted successfully.
+
To reapply ownership to the files changed by the patch:
+
Find the web server user: ps -o "user group command" -C httpd,apache2
+The value in the USER column is the web server username.
+Typically, the Apache web server user on CentOS is apache and the Apache web server user on Ubuntu is www-data.
+
As a user with root privileges, enter the following command from the Magento installation directory:
+chown -R web-server-user-name .
+For example, on Ubuntu where Apache usually runs as www-data, enter
+chown -R www-data .
+
+
If Solr is running, stop it.
+
Copy the updated configuration files from Magento to your Solr configuration directory.
+
Back up the files in your current Solr configuration directory.
+
Enter the following command:
+cp magento-install-root/lib/Apache/Solr/conf/* solr-config-dir
+For example, if Magento is installed in /var/www/magento and Solr configuration files are located in /etc/apache-solr-3.5.0/mysolrapp/solr/conf, enter
+cp /var/www/magento/lib/Apache/Solr/conf/* /etc/apache-solr-3.5.0/mysolrapp/solr/conf
+
+
Start Solr.
+
Log in to the Admin Panel as an administrator.
+
Click System > Cache Management.
+
Click Flush Magento Cache.
+
Click System > Configuration.
+
In the left navigation bar, from the CATALOG group, click Catalog.
+
In the right pane, expand Catalog Search.
+
From the Indexation Mode list, click Final Commit.
+This is the setting Magento recommends. For a description of the other options, see the Magento EE User Guide.
+
Click System > Index Management.
+
Click the Reindex Data link in the Catalog Search row.
+
Reindex other indexers if necessary.
+
+
Reverting the Patch
+
If applying the patch results in errors, contact Magento Support. If you are instructed to do so, revert the patch:
+
Change to your Magento installation directory.
+
Enter the following command as a user with sufficient privileges to write to Magento files (typically, the web server user or root):
+
sh PATCH_SUPEE-110_EE_1.10.1.1_v2.sh -R
+
+
Troubleshooting
+
If you get an error when you run the patch, use the following suggestions:
+
Verify the patch is located in your Magento installation root directory.
+Ubuntu example: /var/www/magento
+CentOS example: /var/www/html/magento
+
Verify you're running the patch with sufficient privileges.
+Typically, this means running it as the web server user or as a user with root privileges.
diff --git a/guides/v1.8/system-requirements.md b/guides/v1.8/system-requirements.md
new file mode 100644
index 0000000000..f49572e83a
--- /dev/null
+++ b/guides/v1.8/system-requirements.md
@@ -0,0 +1,53 @@
+---
+layout: v1x
+title: System Requirements for Magento Enterprise Edition and Community Edition (Current Shipping Versions)
+---
+
+Magento requires a LAMP or LNMP stack.
+
+#### Operating System
+
+Linux x86-64
+
+#### Web Server
+
+* Apache 2.x
+* Nginx 1.7.x
+
+#### Database
+
+* Magento EE 1.14.3 and later:
+ * MySQL 5.7 (Oracle or Percona)
+* Earlier Magento versions:
+ * MySQL 5.6 (Oracle or Percona)
+
+#### PHP
+
+* Magento EE 1.14.4.0 and later:
+ * PHP 7.2.x
+* Magento CE 1.9.2 and later, Magento EE 1.14.2 - EE 1.14.3.10:
+ * PHP 5.6.x
+ * PHP 5.4.x
+ * PHP 5.5.x
+* Earlier Magento versions:
+ * PHP 5.4.x
+ * PHP 5.5.x
+
+#### SSL
+
+* A valid security certificate is required for HTTPS.
+* Self-signed SSL certificates are not supported.
+
+#### Magento can utilize the following technologies:
+
+* [Redis]({{ site.baseurl }}/guides/v1.8/ce18-ee113/using_redis.html)
+
+ Redis can be used for session or cache storage
+
+* [Memcached]({{ site.baseurl }})
+
+ memcached can be used for session or cache storage
+
+* Apache Solr
+
+ [Solr search](http://merch.docs.magento.com/ee/user_guide/search_seo/search-configuration-solr.html) can be used as a search provider for Magento Enterprise Edition (EE) only
\ No newline at end of file
diff --git a/guides/v19.x/.gitignore b/guides/v19.x/.gitignore
new file mode 100644
index 0000000000..7674aac7d7
--- /dev/null
+++ b/guides/v19.x/.gitignore
@@ -0,0 +1,4 @@
+# OS Files
+.DS_Store
+.vscode
+thumbs.db
diff --git a/guides/v19.x/LICENSE.txt b/guides/v19.x/LICENSE.txt
new file mode 100644
index 0000000000..49dc8ec82e
--- /dev/null
+++ b/guides/v19.x/LICENSE.txt
@@ -0,0 +1,48 @@
+
+Open Software License ("OSL") v. 3.0
+
+This Open Software License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following licensing notice adjacent to the copyright notice for the Original Work:
+
+Licensed under the Open Software License version 3.0
+
+ 1. Grant of Copyright License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, for the duration of the copyright, to do the following:
+
+ 1. to reproduce the Original Work in copies, either alone or as part of a collective work;
+
+ 2. to translate, adapt, alter, transform, modify, or arrange the Original Work, thereby creating derivative works ("Derivative Works") based upon the Original Work;
+
+ 3. to distribute or communicate copies of the Original Work and Derivative Works to the public, with the proviso that copies of Original Work or Derivative Works that You distribute or communicate shall be licensed under this Open Software License;
+
+ 4. to perform the Original Work publicly; and
+
+ 5. to display the Original Work publicly.
+
+ 2. Grant of Patent License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, for the duration of the patents, to make, use, sell, offer for sale, have made, and import the Original Work and Derivative Works.
+
+ 3. Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work.
+
+ 4. Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior permission of the Licensor. Except as expressly stated herein, nothing in this License grants any license to Licensor's trademarks, copyrights, patents, trade secrets or any other intellectual property. No patent license is granted to make, use, sell, offer for sale, have made, or import embodiments of any patent claims other than the licensed claims defined in Section 2. No license is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under terms different from this License any Original Work that Licensor otherwise would have a right to license.
+
+ 5. External Deployment. The term "External Deployment" means the use, distribution, or communication of the Original Work or Derivative Works in any way such that the Original Work or Derivative Works may be used by anyone other than You, whether those works are distributed or communicated to those persons or made available as an application intended for use over a network. As an express condition for the grants of license hereunder, You must treat any External Deployment by You of the Original Work or a Derivative Work as a distribution under section 1(c).
+
+ 6. Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent, or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work.
+
+ 7. Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately preceding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of non-infringement, merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to the Original Work is granted by this License except under this disclaimer.
+
+ 8. Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to anyone for any indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to the extent applicable law prohibits such limitation.
+
+ 9. Acceptance and Termination. If, at any time, You expressly assented to this License, that assent indicates your clear and irrevocable acceptance of this License and all of its terms and conditions. If You distribute or communicate copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. This License conditions your rights to undertake the activities listed in Section 1, including your right to create Derivative Works based upon the Original Work, and doing so without honoring these terms and conditions is prohibited by copyright law and international treaty. Nothing in this License is intended to affect copyright exceptions and limitations (including 'fair use' or 'fair dealing'). This License shall terminate immediately and You may no longer exercise any of the rights granted to You by this License upon your failure to honor the conditions in Section 1(c).
+
+ 10. Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware.
+
+ 11. Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of copyright or patent law in the appropriate jurisdiction. This section shall survive the termination of this License.
+
+ 12. Attorneys' Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License.
+
+ 13. Miscellaneous. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable.
+
+ 14. Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+ 15. Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You.
+
+ 16. Modification of This License. This License is Copyright (C) 2005 Lawrence Rosen. Permission is granted to copy, distribute, or communicate this License without modification. Nothing in this License permits You to modify this License as applied to the Original Work or to Derivative Works. However, You may modify the text of this License and copy, distribute or communicate your modified version (the "Modified License") and apply it to other original works of authorship subject to the following conditions: (i) You may not indicate in any way that your Modified License is the "Open Software License" or "OSL" and you may not use those names in the name of your Modified License; (ii) You must replace the notice specified in the first paragraph above with the notice "Licensed under " or with a notice of your own that is not confusingly similar to the notice in this License; and (iii) You may not claim that your original works are open source software unless your Modified License has been approved by Open Source Initiative (OSI) and You comply with its license review and certification process.
diff --git a/guides/v19.x/advanced-reporting/overview.html b/guides/v19.x/advanced-reporting/overview.html
new file mode 100644
index 0000000000..4ba280517a
--- /dev/null
+++ b/guides/v19.x/advanced-reporting/overview.html
@@ -0,0 +1 @@
+--
diff --git a/guides/v19.x/api/rest-api-index.html b/guides/v19.x/api/rest-api-index.html
new file mode 100644
index 0000000000..780cb5b79a
--- /dev/null
+++ b/guides/v19.x/api/rest-api-index.html
@@ -0,0 +1,45 @@
+---
+layout: v1x
+title: Magento 1.x REST API
+---
+
+
\ No newline at end of file
diff --git a/guides/v19.x/api/rest/Resources/Orders/order_addresses.html b/guides/v19.x/api/rest/Resources/Orders/order_addresses.html
new file mode 100644
index 0000000000..3eb7895a20
--- /dev/null
+++ b/guides/v19.x/api/rest/Resources/Orders/order_addresses.html
@@ -0,0 +1,288 @@
+---
+layout: v1x_rest
+title: Order Addresses
+---
+
+
+
Description: Allows you to retrieve information on billing and shipping addresses from the required order.
+Notes: Customers can retrieve addresses only from their orders.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/32/addresses
Description: Allows you to retrieve information on the order billing address.
+Notes: Customers can retrieve information on billing addresses only from their own orders.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/32/addresses/billing
Description: Allows you to retrieve information on the order shipping address.
+Notes: Customers can retrieve information on shipping addresses only from their own orders.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/32/addresses/shipping
Description: Allows you to retrieve information about comments of the required order.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/33/comments
+
+
Response Body:
+
+
+
+
<?xml version="1.0"?>
+<magento_api>
+ <data_item>
+ <created_at>2012-03-09 11:20:49</created_at>
+ <comment></comment>
+ <is_customer_notified>1</is_customer_notified>
+ <is_visible_on_front>0</is_visible_on_front>
+ <status>pending</status>
+ </data_item>
+ <data_item>
+ <created_at>2012-03-09 11:21:32</created_at>
+ <comment>This is a new order for John Doe.</comment>
+ <is_customer_notified>1</is_customer_notified>
+ <is_visible_on_front>1</is_visible_on_front>
+ <status>pending</status>
+ </data_item>
+</magento_api>
+
+
+
+
+
+
Authentication: Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/orders/33/comments
+
+
Response Body:
+
+
+
+
<?xml version="1.0"?>
+<magento_api>
+ <data_item>
+ <created_at>2012-03-09 11:21:32</created_at>
+ <comment>This is a new order for John Doe.</comment>
+ </data_item>
+</magento_api>
+
+
+
+
+
+
HTTP Method: POST
+
+
Description: Not allowed.
+
+
HTTP Method: PUT
+
+
Description: Not allowed.
+
+
HTTP Method: DELETE
+
+
Description: Not allowed.
+
+
+
+
Order Comments Attributes
+
+
+
+
+
Attribute Name
+
Attribute Description
+
Notes
+
+
+
Comment Date
+
Date when the comment was added
+
Admin and Customer
+
+
+
Comment Text
+
Comment text
+
Admin and Customer
+
+
+
Is Customer Notified
+
Defines whether the customer is notified about the comment. Can have the following values: 0 - Customer is not notified, 1 - Customer is notified.
+
Admin only
+
+
+
Is Comment Visible on Frontend
+
Defines whether the comment is visible on the frontend. Can have the following values: 0 - Comment is not visible, 1 - Comment is visible.
Description: Allows you to retrieve the list of existing order items with detailed items information.
+Notes: The list of attributes that will be returned for order items is configured in the Magento Admin Panel.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to retrieve the list of existing orders. Each order contains the following information: general order information, information on ordered items, order comments, and order addresses (both billing and shipping).
+The list of attributes that will be returned for the order is configured in the Magento Admin Panel.
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
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.
Description: Allows you to retrieve information about all images of a specified product.
+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.
+
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
+Parameters:
+No Parameters
Note: If the file_name parameter is not defined, the original file name is set for the image. The first created image will be called "image", the second created image will be called "image_2", etc.
+
+
Example:
+
+
POST http://magentohost/api/rest/products/1/images
Description: Allows you to retrieve information about product images for a specified store view.
+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.
+
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/products/8/images/store/2
Description: Allows you to add an image for the required product with image settings for a specific store.
+Notes: The image is added on the Global level; specified image parameters are set for a specific store.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example Value
+
+
+
file_mime_type
+
File mime type. Can have the following values: image/jpeg, image/png, etc.
Note: If the file_name parameter is not defined, the original file name is set for the image. The first created image will be called "image", the second created image will be called "image_2", etc.
+
+
Example:
+
+
POST http://magentohost/api/rest/products/8/images/store/3
Description: Allows you to retrieve information about a specified product image.
+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.
+
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/products/8/images/7
Description: Allows you to update information for the specified product image.
+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.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example
+
+
+
exclude
+
Defines whether the image will associate only to one of the three image types.
+
optional
+
int
+
0
+
+
+
file_content
+
Image file content (base_64 encoded).
+
optional
+
string
+
base_64 encoded file content
+
+
+
file_mime_type
+
File mime type. Can have the following values: image/jpeg, image/png, etc.
+
optional
+
string
+
image/png
+
+
+
file_name
+
Image file name.
+
optional
+
string
+
test name
+
+
+
label
+
A label that will be displayed on the frontend when pointing to the image
+
optional
+
string
+
test label
+
+
+
position
+
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
+
optional
+
int
+
1
+
+
+
types
+
Array of image types. Can have the following values: image, small_image, and thumbnail.
+
optional
+
array
+
thumbnail
+
+
+
+
+
+
+
Example:
+
+
PUT http://magentohost/api/rest/products/8/images/7
Description: Allows you to remove the specified image from a product.
+Notes: The image will not be deleted physically, the image parameters will be set to No Image.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to retrieve information about the specified product image from a specified store.
+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.
+
+
+
Authentication: Admin, Customer, Guest
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/products/8/images/7/store/3
Description: Allows you to update the specified product image information for s specified store.
+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.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example
+
+
+
exclude
+
Defines whether the image will associate only to one of the three image types.
+
optional
+
int
+
0
+
+
+
file_content
+
Image file content (base_64 encoded).
+
optional
+
string
+
base_64 encoded file content
+
+
+
file_mime_type
+
File mime type. Can have the following values: image/jpeg, image/png, etc.
+
optional
+
string
+
image/png
+
+
+
file_name
+
Image file name.
+
optional
+
string
+
test name
+
+
+
label
+
A label that will be displayed on the frontend when pointing to the image
+
optional
+
string
+
test label
+
+
+
position
+
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
+
optional
+
int
+
1
+
+
+
types
+
Array of image types. Can have the following values: image, small_image, and thumbnail.
+
optional
+
array
+
thumbnail
+
+
+
+
+
+
+
Example:
+
+
PUT http://magentohost/api/rest/products/8/images/7/store/3
+
+
Request Body:
+
+
+
+
<?xml version="1.0"?>
+<magento_api>
+Â <position>3</position>
+Â <exclude>0</exclude>
+Â <types>
+Â Â Â <data_item>image</data_item>
+Â Â </types>
+</magento_api>
+
+
+
+
+
+
+
HTTP Method: DELETE
+
+
Description: Allows you to remove an image from the required product in the specified store.
+Notes: The image will not be deleted physically, the image parameters will be set to No Image for the current store.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
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.
Description: Allows you to assign a website and copy product data from the attached store to the one being attached. Only product data that is set on the Store View level is copied. All other data set on the Website or Global levels is not copied.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example Value
+
+
+
website_id
+
The website ID
+
required
+
int
+
2
+
+
+
store_from
+
The store ID from which data will be copied
+
required
+
int
+
1
+
+
+
store_to
+
The store ID to which data will be copied
+
required
+
int
+
2
+
+
+
+
+
Notes: The store_to parameter must belong to the website which we want to assign to a product.
+
+
Example:
+
+
POST http://magentohost/api/rest/products/8/websites
Multi-Website Assignment with Product Data Copying
+
+
Description: Allows you to assign multiple websites to a product together with copying product data from the attached store to the one being attached. Only product data that is set on the Store View level is copied. All other data set on the Website or Global levels is not copied.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example Value
+
+
+
website_id
+
The website ID
+
required
+
int
+
2
+
+
+
store_from
+
The store ID from which data will be copied
+
required
+
int
+
1
+
+
+
store_to
+
The store ID to which data will be copied
+
required
+
int
+
2
+
+
+
+
+
Example:
+
+
POST http://magentohost/api/rest/products/8/websites
Description: Allows you to retrieve the list of all products with detailed information.
+Notes: The list of attributes that will be returned in the response is configured in the Magento Admin Panel. The list of attributes differs for each type of user.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to retrieve the list of products of a specified category. These products will be returned in the product position ascending order.
+
+
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
Description: Allows you to retrieve information on a required simple product.
+Notes: The list of attributes that will be returned in the response is configured in the Magento Admin Panel. The list of attributes differs for each type of user.
+
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to delete an existing product.
+
+
+
Authentication: Admin
+Default Format: JSON
+Parameters: no parameters
+Request Example:
+
+
DELETE http://magentohost/api/rest/products/1
+
+
+
+
+
Possible HTTP Status Codes
+
+
+
+
+
Status Code
+
Message
+
Description
+
+
+
404
+
Resource not found.
+
The required resource is not found.
+
+
+
405
+
Resource method not implemented yet.
+
The required method is not implemented yet.
+
+
+
405
+
Resource does not support method.
+
The current resource does not support the specified method.
+
+
+
+
+
+
diff --git a/guides/v19.x/api/rest/Resources/get_filters.html b/guides/v19.x/api/rest/Resources/get_filters.html
new file mode 100644
index 0000000000..0d3eb94a88
--- /dev/null
+++ b/guides/v19.x/api/rest/Resources/get_filters.html
@@ -0,0 +1,71 @@
+---
+layout: v1x_rest
+title: GET Filters
+---
+
Some requests use GET parameters in the URL. These are as follows:
+
+
+
filter - specifies the filters for returned data
+
page - specifies the page number which items will be returned
+
+
e.g., http://magentohost/api/rest/products?page=1
+
+
+
order, dir - specifies the sort order of returned items and the order direction: 'asc' - returns items in the ascending order; 'dsc' - returns items in the descending order.
+
limit - limits the number of returned items in the response. Note that by default, 10 items are returned in the response. The maximum number is 100 items.
+
+ Important: The default response for all APIs is JSON; however, this page currently uses mostly XML examples. We don't maintain this documentation much anymore so if you'd like to contribute some JSON, we'll acknowledge your help on this page. Edit this page on GitHub if you can help us out.
+
+
+
REST API: Stock Items
+
+
URI: /stockitems
+
+
Allows you to manage existing stock items. Inventory management is available only for Admin.
Description: Allows you to retrieve the list of existing stock items.
+ Notes: The list of attributes that will be returned for stock items is configured in the Magento Admin Panel.
+
Description: Allows you to update existing stock items.
+
+
+
Authentication: Admin
+ Default Format: JSON
+
+
Notes: The Content-Type: text/xml parameter must be added to the request header.
+
+
Parameters:
+
+
+
+
+
Name
+
Description
+
Type
+
Example Value
+
+
+
item_id
+
Item ID
+
int
+
1
+
+
+
product_id
+
Product ID
+
int
+
1
+
+
+
stock_id
+
Stock ID
+
int
+
1
+
+
+
qty
+
Quantity of stock items for the current product
+
string
+
20
+
+
+
min_qty
+
Quantity for stock items to become out of stock
+
string
+
0
+
+
+
use_config_min_qty
+
Choose whether the Config settings will be applied for the Qty for Item's Status to Become Out of Stock
+ option
+
+
int
+
1
+
+
+
is_qty_decimal
+
Choose whether the product can be sold using decimals (e.g., you can buy 2.5 product)
+
int
+
0
+
+
+
backorders
+
The customer can place the order for products that are out of stock at the moment (0 - No Backorders, 1 -
+ Allow Qty Below 0, and 2 - Allow Qty Below 0 and Notify Customer)
+
+
int
+
0
+
+
+
use_config_backorders
+
Choose whether the Config settings will be applied for the Backorders option
+
int
+
1
+
+
+
min_sale_qty
+
Minimum number of items in the shopping cart to be sold
+
string
+
10
+
+
+
use_config_min_sale_qty
+
Choose whether the Config settings will be applied for the Minimum Qty Allowed in Shopping Cart option
+
int
+
0
+
+
+
max_sale_qty
+
Maximum number of items in the shopping cart to be sold
+
string
+
100
+
+
+
use_config_max_sale_qty
+
Choose whether the Config settings will be applied for the Maximum Qty Allowed in Shopping Cart option
+
int
+
0
+
+
+
is_in_stock
+
Defines whether the product is available for selling (0 - Out of Stock, 1 - In Stock)
+
int
+
1
+
+
+
low_stock_date
+
Date when the number of stock items became lower than the number defined in the Notify for Quantity Below
+ option
+
+
string
+
2012-02-24 12:37:51
+
+
+
notify_stock_qty
+
The number of inventory items below which the customer will be notified via the RSS feed
+
string
+
10
+
+
+
use_config_notify_stock_qty
+
Choose whether the Config settings will be applied for the Notify for Quantity Below option
+
int
+
0
+
+
+
manage_stock
+
Choose whether to view and specify the product quantity and availability and whether the product is in
+ stock management( 0 - No, 1 - Yes)
+
+
int
+
0
+
+
+
use_config_manage_stock
+
Choose whether the Config settings will be applied for the Manage Stock option
+
int
+
1
+
+
+
stock_status_changed_auto
+
Defines whether products can be automatically returned to stock when the refund for an order is created
+
+
int
+
0
+
+
+
use_config_qty_increments
+
Choose whether the Config settings will be applied for the Enable Qty Increments option
+
int
+
1
+
+
+
qty_increments
+
The product quantity increment value
+
string
+
5
+
+
+
use_config_enable_qty_inc
+
Choose whether the Config settings will be applied for the Qty Increments option
+
int
+
1
+
+
+
enable_qty_increments
+
Defines whether the customer can add products only in increments to the shopping cart
+
int
+
0
+
+
+
is_decimal_divided
+
Defines whether the stock items can be divided into multiple boxes for shipping.
Allows you to update, delete, or retrieve information on a single stock item.
+ Notes: The list of attributes that will be returned for stock items is configured in the Magento Admin Panel.
+
Description: Allows you to update existing stock item data.
+ Notes: The Content-Type: text/xml parameter must be added to the request header.
+ Authentication: Admin
+ Default Format: JSON
+ Parameters:
+ Enter only those parameters which you want to update.
Description: Not allowed. The DELETE method is not allowed because you cannot delete a stock item. The
+ required stock item is deleted together with the product which it is associated to.
+
+
+
Possible HTTP Status Codes:
+
+
+
+
+
Error Code
+
Error Message
+
Error Description
+
+
+
200
+
Resource updated successful.
+
The required resource was successfully updated.
+
+
+
404
+
Resource not found.
+
The required resource is not found or does not exist.
+
+
+
400
+
Empty value for <name of the parameter> in request.
+
Value is not defined for the specified parameter in the request body.
+
+
+
400
+
Invalid value for "item_id" in request.
+
The specified value for "item_id" is not valid.
+
+
+
400
+
Missing <name of the parameter> in request.
+
The specified parameter is missing in the request body.
+
+
+
500
+
Resource internal error.
+
Resource internal error.
+
+
+
+
+
+
diff --git a/guides/v19.x/api/rest/Resources/resource_customer_addresses.html b/guides/v19.x/api/rest/Resources/resource_customer_addresses.html
new file mode 100644
index 0000000000..7eefc0f53e
--- /dev/null
+++ b/guides/v19.x/api/rest/Resources/resource_customer_addresses.html
@@ -0,0 +1,510 @@
+---
+layout: v1x_rest
+title: Customer Addresses
+---
+
+JSON responses on this page contributed by Tim Reynolds
+
+
+
HTTP Method: GET /customers/:customer_id/addresses
+
+
Description: Allows you to retrieve the list of existing customer addresses.
+Notes: The list of attributes that will be returned for customer addresses is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses. Also, Admin can add additional non-system customer address attributes by selecting Customers > Attributes > Manage Customer Address Attributes (available only in Magento Enterprise Edition). If these attributes are set as visible on frontend, they will be returned in the response.
+
+
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/customers/1/addresses
Notes: If the customer has more than two street addresses, they will be returned in the following form: first address in the first string and all other addresses in the second string separated with a semicolon (like in the example above).
+
+
HTTP Method: POST /customers/:customer_id/addresses
+
+
Description: Allows you to create a new address for the required customer.
+Notes: The Customer user type can create addresses only for themselves.
+
+
When adding a street address for the customer, it should look like the following:
Description: Allows you to retrieve an existing customer address.
+Notes: The list of attributes that will be returned for customer address is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses. Also, Admin can add additional non-system customer address attributes by selecting Customers > Attributes > Manage Customer Address Attributes (available only in Magento Enterprise Edition). If these attributes are set as visible on frontend, they will be returned in the response.
+
+
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
+
+
Example:
+
+
GET http://magentohost/api/rest/customers/addresses/2
HTTP Method: POST /customers/addresses/:address_id
+
+
Description: Not allowed.
+
+
HTTP Method: PUT /customers/addresses/:address_id
+
+
Description: Allows you to update an existing customer address.
+Notes: The list of attributes that will be updated for customer address is configured in the Magento Admin Panel. The Customer user type has access only to his/her own addresses.
+
+
If you want to add more addresses, it should look like the following:
+
+
+
+
<street>
+Â Â <data_item>street address 1</data_item>
+Â Â <data_item>street address 2</data_item>
+Â Â <data_item>street address 3</data_item>
+</street>
+
+
+
+
+
+
+
Authentication: Admin, Customer
+Default Format: XML
+
+
+
Example:
+
+
PUT http://magentohost/api/rest/customers/addresses/7
Description: Allows you to retrieve the list of existing customers.
+Notes:: Only Admin user can retrieve the list of customers with all their attributes.
+
+
Authentication: Admin
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to create a new customer.
+Authentication: Admin
+Default Format: XML
+Parameters:
+
+
+
+
+
Name
+
Description
+
Required
+
Type
+
Example Value
+
+
+
firstname
+
The customer first name
+
required
+
string
+
John
+
+
+
lastname
+
The customer last name
+
required
+
string
+
Doe
+
+
+
email
+
The customer email address
+
required
+
string
+
johny@example.com
+
+
+
password
+
The customer password. The password must contain minimum 7 characters
+
required
+
string
+
123123q
+
+
+
website_id
+
Website ID
+
required
+
int
+
1
+
+
+
group_id
+
Customer group ID
+
required
+
int
+
1
+
+
+
disable_auto_group_change
+
Defines whether the automatic group change for the customer will be disabled
+
optional
+
int
+
0
+
+
+
prefix
+
Customer prefix
+
optional
+
string
+
Mr.
+
+
+
middlename
+
Customer middle name or initial
+
optional
+
string
+
R.
+
+
+
suffix
+
Customer suffix
+
optional
+
string
+
Sr.
+
+
+
taxvat
+
Customer Tax or VAT number
+
optional
+
string
+
GB999 9999 73
+
+
+
+
+
Notes: The list of parameters may change depending on the attributes settings in Customers > Attributes > Manage Customer Attributes page in Magento Admin Panel. For example, a required status of the middlename attribute (Middle Name/Initial) may be changed to 'YES". Please note that managing customer attributes is available only in Magento Enterprise Edition.
Response:
+If the customer was created successfully, we receive Response HTTP Code = 200, empty Response Body and Location header like '/api/rest/customers/555' where '555' - an entity id of the new customer.
Description: Allows you to retrieve information on an existing customer.
+Notes:: The list of attributes that will be returned for customers is configured in the Magento Admin Panel. The Customer user type has access only to his/her own information. Also, Admin can add additional non-system customer attributes by selecting Customers > Attributes > Manage Customer Attributes. If these attributes are set as visible on frontend, they will be returned in the response. Also, custom attributes will be returned in the response only after the customer information is updated in the Magento Admin Panel or the specified custom attribute is updated via API (see the PUT method below). Please note that managing customer attributes is available only in Magento Enterprise Edition.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+No Parameters
Description: Allows you to update an existing customer.
+Notes: The list of attributes that will be updated for customer is configured in the Magento Admin Panel. The Customer user type has access only to his/her own information.
+
+
Authentication: Admin, Customer
+Default Format: XML
+Parameters:
+You must specify only those parameters which you want to update. Parameters that are not defined in the request body will preserve the previous values. The website_id and created_in attributes are not allowed for updating.
The Magento REST API allows you to manage customers, customer addresses, sales orders, inventory, and products. REST API is organized into the following categories:
+
+
+
+
Products
+
+
Retrieve the list of products, create, update, delete a product.
In most cases, the third-party application must be authenticated to use the Magento API. But users never reveal their credentials to the application to preserve their privacy. So, the question is as follows: how is your application going to authenticate users if it does not know user credentials. OAuth is the solution.
+
+
Magento authentication is based on OAuth, an open standard for secure API authentication. OAuth is a token-passing mechanism that allows users to control which applications have access to their data without revealing their passwords or other credentials.
+
+
The OAuth concept lies in three basic elements that can be easily described in the following picture:
+
+
+
+
+
To learn more about OAuth, you can visit the official OAuth site.
+
+
+
Using OAuth
+
+
The current API supports OAuth 1.0a.
+
+
The OAuth authentication works by asking the user to authorize their application. When the user authorizes the application, the application can access that user protected resources by using an access token. This token will be used in each further request. Access tokens are long-lived and will not expire unless the user revokes access to the application.
+
+
OAuth is completely invisible for the site visitors.
+
+
Why Do You Need OAuth?
+
+
Magento uses OAuth to allow access to its data. You need to use OAuth if you want to use any of the following Magento APIs:
+
+
+
Products
+
Inventory
+
Orders
+
Customers
+
Customer Addresses
+
Categories
+and a lot more
+
+
+
+
+
OAuth Definitions
+
+
There are some definitions you need to get familiar with before you start using OAuth. These are as follows:
+
+
User - A customer who has an account with Magento and can use the services via the Magento API.
+
Consumer - A third-party application that uses OAuth to access the Magento API. This application must be registered in the Magento system to receive the Consumer Key and Consumer Secret.
+
Consumer Key - A value used by the Consumer to identify itself with Magento.
+
Consumer Secret - A secret used by the Consumer to guarantee the ownership of the Consumer Key. This value is not passed in requests.
+
Request Token - A value used by the Consumer to obtain authorization from the User (when needed). The Request Token is exchanged for an Access Token when permission is granted.
+
Access Token - A value used by the Consumer to call Magento APIs on behalf of the User.
+
+
+
+
+
OAuth Process
+
+
The OAuth process consists of several steps:
+
+
Getting an Unauthorized Request Token.
+
Requesting user authorization.
+
Getting an Access Token by exchanging the Request Token for it.
+
+
+
+
+
The application that requires access to data is known as the Consumer and Magento is the Service Provider.
+
+
+
Registering an Application
+
+
Before starting to make API requests, you need to register the application. After the registration, you will receive the Consumer Key that will identify you in Magento. Also, you will receive a Consumer Secret. This secret will be used when requesting for a Request Token.
+
+
You can register your application by selecting System > Web Services > REST - OAuth Consumers and clicking Add New in the Admin Panel.
+
+
When registering the application, you also need to define the callback URL, to which the user will be redirected after he/she successfully authorizes your application.
+
+
Authentication Endpoints
+
+
The authentication endpoints include the following ones:
+
+
+
/oauth/initiate - this endpoint is used for retrieving the Request Token.
+
/oauth/authorize - this endpoint is used for user authorization (Customer).
+
/admin/oauth_authorize - this endpoint is used for user authorization (Admin).
+
/oauth/token - this endpoint is used for retrieving the Access Token.
+
+
+
+
Also, the simple form can be used for authentication. To use a simple form, add the /simple endpoint to the authentication endpoint. For example: /oauth/authorize/simple
+
+
+
Getting an Unauthorized Request Token
+
+
The first step to authenticate the user is to retrieve a Request Token from Magento. This is a temporary token that will be exchanged for the Access Token.
+
+
+
+
+
+
Endpoint:
+
/oauth/initiate
+
+
+
Description:
+
The first step of authentication. Allows you to obtain the Request Token used for the rest of the authentication process.
The following request parameters should be present in the Authorization header:
+
+
oauth_callback - an URI to which the Service Provider will redirect the resource owner (user) after the authorization is complete.
+
oauth_consumer_key - the Consumer Key value, retrieved after the registration of the application.
+
oauth_nonce - a random value, uniquely generated by the application.
+
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
+
oauth_signature - a generated value (signature).
+
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
+
oauth_version - OAuth version.
+
+
+
+
User Authorization
+
+
The second step is to request user authorization. After receiving the Request Token from Magento, the application provides an authorization page to the user. The only required parameter for this step is the Request Token (oauth_token value) received from the previous step. The endpoint is followed by an oauth_token parameter with the value set to the oauth_token value.
+
+
After this, the user is asked to enter their credentials and authorize. When the user is granted the access, he/she is redirected to the URL specified in the oauth_callback parameter. This URL is followed by two parameters:
+
+
oauth_token - the Request Token value.
+
oauth_verifier - a verification code that is tied to the Request Token.
+
+
+
+
+
+
+
+
Endpoint:
+
/oauth/authorize
+
+
+
Description:
+
The second step of authentication. Without the user authorization in this step, it is impossible for your application to obtain an Access Token.
The final third authentication step. After the application access is authorized, the application needs to exchange the Request Token for an Access Token. For this step, you will need the Request Token (the oauth_token and oauth_token_secret values) and the oauth_verifier value from the previous step.
+
+
+
+
+
+
Endpoint:
+
/oauth/token
+
+
+
Description:
+
The third step of authentication. Getting an Access Token.
+
+
+
Method:
+
POST
+
+
+
Returns:
+
An access token and the corresponding access token secret, URL-encoded.
The following components should be present in the Authorization header:
+
+
oauth_consumer_key - the Consumer Key value provided after the registration of the application.
+
oauth_nonce - a random value, uniquely generated by the application.
+
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
+
oauth_signature - a generated value (signature).
+
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
+
oauth_token - the oauth_token value (Request Token) received from the previous steps.
+
oauth_verifier - the verification code that is tied to the Request Token.
+
oauth_version - OAuth version.
+
+
+
+
+
The response will contain the following response parameters:
+
+
oauth_token - the Access Token that provides access to protected resources.
+
oauth_token_secret - the secret that is associated with the Access Token.
+
+
+
+
+
+
OAuth Error Codes
+
+
When the third-party application performs invalid requests to Magento, the following errors related to OAuth can occur:
+
+
+
+
+
HTTP Code
+
Error Code
+
Text Representation
+
Description
+
+
+
400
+
1
+
version_rejected
+
This error is used when the oauth_version parameter does not correspond to the "1.0a" value.
+
+
+
400
+
2
+
parameter_absent
+
This error is used there is no required parameter in the request. The name of the missing parameter is specified additionally in the response.
+
+
+
400
+
3
+
parameter_rejected
+
This error is used when the type of the parameter or its value does not meet the protocol requirements (e.g., array is passed instead of the string).
+
+
+
400
+
4
+
timestamp_refused
+
This error is used if there is incorrect value of the timestamp in the oauth_timestamp parameter.
+
+
+
401
+
5
+
nonce_used
+
This error is used if the nonce-timestamp combination has already been used.
+
+
+
400
+
6
+
signature_method_rejected
+
This error is used for unsupported signature method. The following methods are supported: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
+
+
+
401
+
7
+
signature_invalid
+
This error is used if the signature is invalid.
+
+
+
401
+
8
+
consumer_key_rejected
+
This error is used if the Consumer Key has incorrect length or does not exist.
+
+
+
401
+
9
+
token_used
+
This error is used if there is an attempt of authorization of an already authorized token or an attempt to exchange a not temporary token for a permanent one.
+
+
+
401
+
10
+
token_expired
+
This error is used if the temporary token has expired. At the moment, the mechanism of expiration of temporary tokens is not implemented and the current error is not used.
+
+
+
401
+
11
+
token_revoked
+
This error is used if the token is revoked by the user who authorized it.
+
+
+
401
+
12
+
token_rejected
+
This error is used if the token is not valid, or does not exist, or is not valid for using in the current type of request.
+
+
+
401
+
13
+
verifier_invalid
+
This error is used if the confirmation string does not correspond to the token.
+
+
+
+
+
+
+
PHP Examples
+
+
Retrieve the list of products for Admin user with OAuth authentication
Before starting to use OAuth, you need to perform several steps in the Magento Admin Panel. These steps allow you to enable the OAuth functionality for further actions.
+
+
Working with Consumers
+
+
Adding a New Consumer
+
+
First, you need to create a Consumer in the Admin Panel. Creating a new consumer means registering the application. To do this, perform the following steps:
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
+
On the OAuth Consumers page, click Add New in the top right corner to add a new consumer.
+
The New Consumer page opens. The Key and Secret fields are filled automatically and cannot be edited. These values are generated automatically and will be used to identify the Consumer in Magento.
+
+
Fill in the following fields:
+
+
Name: Enter the name of the application to be registered. This field is required.
+
Callback URL: Enter the URL address to which the Consumer will be redirected after the authorization is passed successfully. This URL address implies the path to the application. This field is optional.
+
Rejected Callback URL: Enter the URL address to which the user will be redirected if he/she rejects authorization. This field is optional.
+
+
+
Click Save in the top right corner to save the created Consumer.
+
+
+
+
Editing an Existing Consumer
+
+
To edit an existing consumer, perform the following steps:
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
+
The OAuth Consumers page opens. In the grid, select the consumer to be edited and click it.
+
The Edit Consumer page opens. On this page, you can edit the following fields:
+
+
Name: Enter a new name for the application.
+
Callback URL: Enter a new URL address to which the user will be redirected after successful authorization. This URL address implies the path to the application.
+
Rejected Callback URL: Enter another URL address to which the user will be redirected after he/she rejects authorization proceeding.
+
The Key and Secret fields cannot be edited.
+
+
+
Click Save in the top right corner to save changes.
+
+
+
+
Deleting an Existing Consumer
+
+
To delete the required consumer, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
+
The OAuth Consumers page opens. In the grid, select the consumer to be deleted and click it.
+
The Edit Consumer page opens. Click Delete in the top right corner to delete the selected consumer.
+
+
+
+
Searching for a Consumer
+
+
You can search for a required consumer by several parameters: ID, consumer name, and date of creation.
+To search for a consumer, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
+
The OAuth Consumers page opens. The list of consumers is displayed in a grid with the following fields: ID, Consumer Name, and Created At.
+
In the search field below the column header in a grid, enter the required value by which the search will be performed. Click Search in the top right corner.
+
+
+
+
+
Working with Tokens (Admin Panel)
+
+
Viewing Authorized Tokens
+
+
To view authorized tokens in the Admin panel, perform the following steps:
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Authorized Tokens.
+
The Authorized OAuth Tokens page opens. In the grid, the list of all authorized tokens is displayed.
+
Tokens are displayed in the grid with the following columns: ID, Application Name (name of consumer for which the token is created), User Type (type of the user, Customer or Admin), User ID, and the Revoked status.
+
+
+
+
From the Authorized OAuth Tokens page, you can enable, revoke, or delete the required token.
+
+
Viewing Applications
+
+
To view the list of applications, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - My Apps.
+
The My Applications page opens. Registered applications are displayed in a grid with the following columns: ID, Application Name, and Revoked.
+
+
+
+
+
Enabling Tokens
+
+
If a token is revoked (the Yes value in the Revoked column on the Authorized OAuth Tokens page), you can enable it. To do this, perform the following steps:
+
+
In the Authorized OAuth Tokens grid, select the token with the Revoked status set to Yes and select the checkbox next to it.
+
You can select more than one token with the Revoked status and enable all of them by using the mass action.
+
In the Actions drop-down list, select the Enable option and click Submit.
+
The required token is enabled.
+
+
+
+
Revoking Tokens
+
+
If a token is enabled (the No value in the Revoked column), you can revoke it. To do this, perform the following steps:
+
+
In the Authorized OAuth Tokens grid, select the token with the Revoked status set to No and select the checkbox next to it.
+
You can select more than one token with the Revoked status set to No and revoke all of them by using the mass action.
+
In the Actions drop-down list, select the Revoke option and click Submit.
+
The required token is revoked.
+
+
+
+
Deleting Tokens
+
+
To delete the required token, perform the following steps:
+
+
In the Authorized OAuth Tokens grid, select the token to be deleted and select the checkbox next to it.
+
You can select more than one token and delete all of them by using the mass action.
+
In the Actions drop-down list, select the Delete option and click Submit.
+
The required token is deleted.
+
+
+
+
+
Working with Tokens (Frontend)
+
+
Viewing Applications
+
+
To view the authorized applications from the frontend, perform the following steps:
+
+
+
On the frontend, click My Account and then select the My Applications tab on the left.
+
On the My Applications page, the list of registered applications will be displayed.
+
+
+
+
+
+
From this page, you can enable, revoke, or delete the required token.
+
+
Enabling Tokens
+
+
+
In the list of consumers, select the consumer to be enabled.
+
If the token is revoked, there will be the Disabled status next to it.
+
Click Enable next to the consumer name.
+
The token is enabled.
+
+
+
+
Disabling Tokens
+
+
+
In the list of consumers, select the consumer to be disabled.
+
If the token is enabled, there will be the Enabled status next to it.
+
Click Disable next to the consumer name.
+
The token is disabled.
+
+
+
+
Deleting Tokens
+
+
+
In the list of consumers, select the consumer to be deleted.
+
Click Delete next to the consumer name.
+
The token is deleted.
+
+
+
+
+
Working with Email Templates
+
+
Setting Up the Default Email Template
+
+
You can set the email template that will be used for user notification if the token status changes. Also, you can set different email templates for different store views. For example, you have two store views: English and German. Magento allows you to set one email template for the English store view and another one for the German store view.
+To set the email template, perform the following steps:
+
+
On the Admin Panel menu, select System > Configuration.
+
Select Services > OAuth on the left.
+
+
In the Email panel, from the Token Status Change Email Template drop-down list, select the required template and click Save Config in the top right corner.
+
The template is saved.
+
+
+
+
Creating a New Email Template
+
+
You can also create your own email template that will be used for user notification if the token status changes.
+To create a new template, perform the following steps:
+
+
On the Admin Panel menu, select System > Transactional Emails.
+
The Transactional Emails page opens. Click Add New Template in the top right corner.
+
The New Email template page opens. In the Load default template panel, in the Template drop-down list, select the Token Status Change option.
+
Specify the Locale option and click Load Template.
+
In the Template Information panel, the template data is loaded. You can specify your own template name, subject, and content.
+
When the email template is created, click Save Template in the top right corner.
+
Set the newly created template as it was described above.
+
+
+
+
Cleanup Configuration
+
+
You can configure the cleanup functionality for temporary tokens. These tokens can be deleted after a certain period of time or after a certain number of OAuth requests.
+To configure cleanup, perform the following steps:
+
+
On the Admin Panel menu, select System > Configuration.
+
Select Services > OAuth on the left.
+
+
In the Cleanup Statistics panel, you can set the following values:
+
+
Cleanup Probability: Define the threshold of OAuth requests after which the cleanup will be performed. Only temporary credentials will be removed. Enter 0 to disable the cleanup.
+
Expiration Period: Define the period (in minutes) on the expiry of which entries will be deleted from the database.
+
+
+
Click Save Config in the top right corner to save changes.
+
+
+
+
diff --git a/guides/v19.x/api/rest/common_http_status_codes.html b/guides/v19.x/api/rest/common_http_status_codes.html
new file mode 100644
index 0000000000..5718ca3153
--- /dev/null
+++ b/guides/v19.x/api/rest/common_http_status_codes.html
@@ -0,0 +1,101 @@
+---
+layout: v1x_rest
+title: Common HTTP Status Codes
+---
+
+
+
+
HTTP status codes are an essential part of the REST concept. You can get familiar with all of them on Wikipedia.
+
+
The Magento API attempts to return appropriate HTTP status codes for all requests. Any information is returned in the form of a standard HTTP response with an HTTP status code describing the error and the body message.
+
+
HTTP Status Codes
+
+
The following table contains possible common HTTP status codes:
+
+
+
+
Status Code
+
Message
+
+
+
200 OK
+
-
+
+
+
201 Created
+
Resource was partially created
+
+
+
+
207 Multi-Status
+
-
+
+
+
400 Bad Request
+
Resource data pre-validation error.
+Resource data invalid.
+Resource unknown error.
+The request data is invalid.
+Resource collection paging error.
+The paging limit exceeds the allowed number.
+Resource collection ordering error.
+Resource collection filtering error.
+Resource collection including additional attributes error.
+
+
+
403 Forbidden
+
Access denied.
+
+
+
404 Not Found
+
Resource not found.
+
+
+
405 Method Not Allowed
+
Resource does not support method.
+Resource method not implemented yet.
When the Magento API returns an error message, it returns it in your requested format. For example, an error in the XML format might look like the following:
An error in the JSON format might look like the following:
+
+
+
+
{"messages":{"error":[{"code":404,"message":"Resource not found."}]}}
+
+
+
+
+
diff --git a/guides/v19.x/api/rest/get_filters.html b/guides/v19.x/api/rest/get_filters.html
new file mode 100644
index 0000000000..2e576e2ddc
--- /dev/null
+++ b/guides/v19.x/api/rest/get_filters.html
@@ -0,0 +1,77 @@
+---
+layout: v1x_rest
+title: GET Filters
+---
+
+JSON responses on this page contributed by Tim Reynolds
+
+
Some requests use GET parameters in the URL. These are as follows:
+
+
+
filter - specifies the filters for returned data
+
page - specifies the page number which items will be returned
+
+
e.g., http://magentohost/api/rest/products?page=1
+
+
+
order, dir - specifies the sort order of returned items and the order direction: 'asc' - returns items in the ascending order; 'dsc' - returns items in the descending order.
+
limit - limits the number of returned items in the response. Note that by default, 10 items are returned in the response. The maximum number is 100 items.
+
Accessing API is performed via HTTP. When you enter a URL into a web browser address bar, the browser performs an HTTP GET request to the URL. This usually returns a web page in the form of an HTTP response that the browser displays. But the GET method is one of several HTTP request methods. Magento REST API uses the four main HTTP methods: GET, POST, PUT, and DELETE. The most widespread methods are GET and POST. The other methods are less known but they became widely known due to the popularity of REST web services. An important concept of the REST architecture is that different HTTP request methods perform different actions when applied to the same URL.
The HTTP GET method is defined in section 9.3 of the RFC2616 document:
+
+
+
The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the entity in the response and not the source text of the process, unless that text happens to be the output of the process.
+
You can retrieve a representation of a resource by getting its URL.
+
+
+
+
POST and PUT
+
+
Creating or Updating Resources with the HTTP POST and PUT Methods
+
+
The POST method is defined in section 9.5 of the RFC2616 document:
+
+
+
The POST method is used to request that the origin server accept the entity enclosed in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. POST is designed to allow a uniform method to cover the following functions:
+
+
+
Annotation of existing resources;
+
+
+
+
+
Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles;
+
+
+
+
+
Providing a block of data, such as the result of submitting a form, to a data-handling process;
+
+
+
+
+
Extending a database through an append operation.
+
+
+
+
+
+
The PUT method is defined in section 9.6 of the RFC2616 document:
+
+
The PUT method requests that the enclosed entity be stored under the supplied Request-URI. If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a modified version of the one residing on the origin server.
+
+
+
Creating or updating a resource involves performing an HTTP POST or HTTP PUT to a resource URL.
+
+
+
+
DELETE
+
+
Deleting Resources with the HTTP DELETE Method
+
+
The DELETE method is defined in section 9.7 of the RFC2616 document:
+
+
The DELETE method requests that the origin server delete the resource identified by the Request-URI. This method MAY be overridden by human intervention (or other means) on the origin server.
+
+
+
Deleting a resource is performed by means of making an HTTP DELETE request to the resource URL.
+
+
+
diff --git a/guides/v19.x/api/rest/introduction.html b/guides/v19.x/api/rest/introduction.html
new file mode 100644
index 0000000000..5ecca7ef8d
--- /dev/null
+++ b/guides/v19.x/api/rest/introduction.html
@@ -0,0 +1,510 @@
+---
+layout: v1x_rest
+title: Introduction to the Magento 1.x REST API
+---
+
+
+
What is REST API? To make it simple, REST API defines a set of functions to which the developers can perform requests
+ and receive responses. The interaction is performed via the HTTP protocol. An advantage of such an approach is the
+ wide usage of HTTP. That is why REST API can be used practically for any programming language.
+
+
Common characteristics of Magento REST API resources are as follows: (magentohost is your domain)
+
+
+
You access the resource by sending an HTTP request to the Magento API server. The server replies with a response
+ that contains either the data you requested, or the status indicator, or even both.
All resources may return different HTTP status codes (e.g., HTTP Status Code 200 for success response or HTTP
+ Status Code 400 for the bad request).
+
You request a particular resource by adding a particular path to the base URL that specifies the resource.
+
+
+
+
Overall Capabilities
+
+
Magento REST API allows managing a number of features, namely:
+
+
+
Managing customers.
+
Managing customer addresses.
+
Managing products.
+
Retrieving sales orders.
+
Managing inventory.
+
+
+
+
+
Authentication
+
+
Magento REST API uses 3-legged OAuth 1.0a protocol to authenticate
+ the application to access the Magento service.
+
+
+
Output Formats
+
+
The REST API supports the response in two formats, which are XML and JSON.
+
+
HTTP Verbs
+
+
HTTP verbs are used to manage the state of resources. In Magento REST API, there are four verbs used to manage
+ resources: GET, POST, PUT, and DELETE. You can get the contents of the data using HTTP GET, delete the data using
+ HTTP DELETE, and create or update the data using POST/PUT.
+
+
Request Structure
+
+
All URLs in REST API have the following base URL.
+
+
http://magentohost/api/rest/
+
+
+
Example
+
+
Supposing, you want to retrieve the list of customers from Magento. To do this, you need to use the GET HTTP method.
+ The GET request to retrieve the list of customers will look as follows:
+
+
+
+
http://magentohost/api/rest/customers
+
+
+
+
where
+
+
+
http://magentohost/api/rest/ - endpoint
+
/customers - action URL
+
+
+
+
REST Resources
+
+
The Magento REST API allows you to manage customers, customer addresses, sales orders, inventory, and products. REST
+ API is organized into the following categories:
+
+
Products
+
+
+
Retrieve the list of products, create, update, and delete a product.
+ Resource Structure: http://magentohost/api/rest/products
+
+
+
+
Product Categories
+
+
+
Retrieve the list of categories assigned to a product, assign, and unassign the category to/from the specific
+ product.
+ Resource Structure: http://magentohost/api/rest/products/:productId/categories
+
+
+
+
Product Images
+
+
+
Retrieve the list of images assigned to a product, add, update, and remove an image to/from the specific
+ product.
+ Resource Structure: http://magentohost/api/rest/products/:productId/images
+
+
+
+
Product Websites
+
+
+
Retrieve the list of websites assigned to a product, assign, and unassign a website to/from the specific
+ product.
+ Resource Structure: http://magentohost/api/rest/products/:productId/websites
+
+
+
+
Customers
+
+
+
Retrieve the list of customers, create, delete a customer, and update the customer information.
+ Resource Structure: http://magentohost/api/rest/customers
+
+
+
+
Customer Addresses
+
+
+
Retrieve the list of customer addresses, create, update, and delete the customer address.
+ Resource Structure: http://magentohost/api/rest/customers/:customerId/addresses
+
+
+
+
Inventory
+
+
+
Retrieve the list of stock items and update required stock items.
+ Resource Structure: http://magentohost/api/rest/stockitems
+
+
+
+
Sales Orders
+
+
+
Retrieve the list of sales orders as well as the specific order information.
+ Resource Structure: http://magentohost/api/rest/orders
+
+
+
+
Order Items
+
+
+
Retrieve order items for the specific order.
+ Resource Structure: http://magentohost/api/rest/orders/:orderId/items
+
+
+
+
Order Addresses
+
+
+
Retrieve information on order billing and shipping addresses for the specific order.
+ Resource Structure: http://magentohost/api/rest/orders/:orderid/addresses
+
+
+
+
Order Comments
+
+
+
Retrieve order comments for the specific order
+ Resource Structure: http://magentohost/api/rest/orders/:orderid/comments
+
+
+
+
Preparing for REST API
+
+
These steps are required for utilizing REST API resources:
+
+
+
Set up permissions for REST resource operations from Magento Admin Panel.
+
Configure the attributes for different users types in Magento Admin Panel. There are 3 different types of users
+ in accessing the data: Admin, Customer, and Guest. Admin is the backend logged in user, Customer is the fronted
+ logged in user, and Guest is a non-logged in fronted user.
+
+
+
+
Preparing REST API for the Third-Party
+ Application
+
+
+
Register the third-party application (Consumer) in Magento Admin Panel.
+
The third-party application will utilize the provided consumer credentials to call Magento store for getting the
+ access token to access the data.
+
+
+
+
+
+
PHP Examples
+
+
+
Create a simple product
+ as an Admin user with OAuth authentication
+
+
+
+
+
<?php
+/**
+* Example of simple product POST using Admin account via Magento REST API. OAuth authorization is used.
+*
+* This file is a stand-alone OAuth client PHP file, which handles everything with the OAuth three-legged authentication.
+* It uses PHP session to persist the current authentication state (step), the OAuth request token with its secret
+* and the OAuth access token with its secret.
+*
+* Create this file oauth_admin.php in your Magento 1.x instance root folder to run this oauth authentication example.
+*
+* oauth_admin.php
+*
+*/
+
+$callbackUrl = "http://yourhost/oauth_admin.php";
+$temporaryCredentialsRequestUrl = "http://magentohost/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
+$adminAuthorizationUrl = 'http://magentohost/admin/oauth_authorize';
+$accessTokenRequestUrl = 'http://magentohost/oauth/token';
+$apiUrl = 'http://magentohost/api/rest';
+$consumerKey = 'yourconsumerkey';
+$consumerSecret = 'yourconsumersecret';
+
+session_start();
+if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
+ $_SESSION['state'] = 0;
+}
+try {
+ $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
+ $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
+ $oauthClient->enableDebug();
+
+ if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
+ // step 1 (state 1) - Get the initial temporary request token.
+ $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
+
+ // persist the request token secret in the session variable for step 3 to get the access token and secret.
+ $_SESSION['secret'] = $requestToken['oauth_token_secret'];
+ $_SESSION['state'] = 1;
+
+ // step 2 (state 2) - redirect to the Oauth admin authorization url to validate and confirm / reject the admin Oauth authorization request.
+ // variable $requestToken['oauth_token'] has the temporary request token
+ header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
+ exit;
+ } elseif ($_SESSION['state'] == 1) {
+ //step 3 (state 3) Exchange the temporary request token and secret to get the final access token and secret.
+ $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
+ $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
+
+ // persist the access token and its secret in the session variable
+ $_SESSION['state'] = 2;
+ $_SESSION['token'] = $accessToken['oauth_token'];
+ $_SESSION['secret'] = $accessToken['oauth_token_secret'];
+
+ // redirect back to the callback url which is the same file
+ header('Location: ' . $callbackUrl);
+ exit;
+ } else {
+
+ // send a POST request to create a simple product
+ $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
+ $resourceUrl = "$apiUrl/products";
+ $productData = json_encode(array(
+ 'type_id' => 'simple',
+ 'attribute_set_id' => 4,
+ 'sku' => 'simple' . uniqid(),
+ 'weight' => 1,
+ 'status' => 1,
+ 'visibility' => 4,
+ 'name' => 'Simple Product',
+ 'description' => 'Simple Description',
+ 'short_description' => 'Simple Short Description',
+ 'price' => 99.95,
+ 'tax_class_id' => 0,
+ ));
+ $headers = array('Content-Type' => 'application/json');
+ $oauthClient->fetch($resourceUrl, $productData, OAUTH_HTTP_METHOD_POST, $headers);
+ print_r($oauthClient->getLastResponseInfo());
+ }
+} catch (OAuthException $e) {
+ print_r($e);
+}
+
+
+
+
+
Retrieve the list
+ of products as a Customer user with OAuth authentication
+
+
+
+
+
<?php
+/**
+* Example of products list retrieve using Customer account via Magento REST API. OAuth authorization is used
+*
+* This file is a stand-alone Oauth client PHP file, which handles everything with the Oauth three-legged authentication.
+* It uses PHP session to persist the current authentication state (step), the oauth request token with its secret
+* and the oauth access token with its secret.
+*
+* Create this file oauth_customer in your Magento 1.x instance root folder to run this oauth authentication example.
+*
+* oauth_customer.php
+*
+*/
+$callbackUrl = "http://yourhost/oauth_customer.php";
+$temporaryCredentialsRequestUrl = "http://magentohost/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
+$adminAuthorizationUrl = 'http://magentohost/oauth/authorize';
+$accessTokenRequestUrl = 'http://magentohost/oauth/token';
+$apiUrl = 'http://magentohost/api/rest';
+$consumerKey = 'yourconsumerkey';
+$consumerSecret = 'yourconsumersecret';
+
+session_start();
+if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
+ $_SESSION['state'] = 0;
+}
+try {
+ $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
+ $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
+ $oauthClient->enableDebug();
+
+ if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
+ // step 1 (state 1) - Get the initial temporary request token.
+ $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
+
+ // persist the request token secret in the session variable for step 3 to get the access token and secret.
+ $_SESSION['secret'] = $requestToken['oauth_token_secret'];
+ $_SESSION['state'] = 1;
+
+ // step 2 (state 2) - redirect to the Oauth customer authorization url.
+ // variable $requestToken['oauth_token'] has the temporary request token
+ header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
+ exit;
+ } elseif ($_SESSION['state'] == 1) {
+ //step 3 (state 3) Exchange the temporary request token and secret to get the final access token and secret.
+ $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
+ $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
+
+ // persist the access token and its secret in the session variable to access the products resource
+ $_SESSION['state'] = 2;
+ $_SESSION['token'] = $accessToken['oauth_token'];
+ $_SESSION['secret'] = $accessToken['oauth_token_secret'];
+
+ // redirect back to the callback url which is the same file
+ header('Location: ' . $callbackUrl);
+ exit;
+ } else {
+ // send a GET request to list all the products
+ $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
+ $resourceUrl = "$apiUrl/products";
+ $oauthClient->fetch($resourceUrl, array(), 'GET', array('Content-Type' => 'application/json', 'Accept' => '*/*'));
+ $productsList = json_decode($oauthClient->getLastResponse());
+ print_r($productsList);
+ }
+} catch (OAuthException $e) {
+ print_r($e);
+}
+
+
+
+
+
REST Client Example
+
+
Retrieving the list of Products as a Guest
+
+
+
Use the REST Client that is a Firefox
+ add-on. In the REST Client, in the Method drop-down list, select the GET option.
+
In the URL field, enter the following URL: http://magentohost/api/rest/products?limit=2.
+
Click Send. Information about the products will be displayed in the response body. Example in the XML
+ format is as follows:
+
+
+
+
Example: XML
+
+
+
+
<?xml version="1.0"?>
+<magento_api>
+ <data_item>
+ <entity_id>16</entity_id>
+ <type_id>simple</type_id>
+ <sku>n2610</sku>
+ <description>The Nokia 2610 is an easy to use device that combines multiple messaging options including email, instant messaging, and more. You can even download MP3 ringtones, graphics, and games straight to the phone, or surf the Internet with Cingular's MEdia Net service. It's the perfect complement to Cingular service for those even remotely interested in mobile Web capabilities in an affordable handset.
+Design
+Compact and stylish, the 2610 features a candybar design sporting a bright 128 x 128 pixel display capable of displaying over 65,000 colors. Most of the phone's features and on-screen menus are controlled by a center toggle on the control pad. A standard hands-free headphone jack is provided, as are volume control keys, and there's even a "Go-To" button that can be assigned by the user for quick access to favorite applications. Lastly, the included speakerphone allows you to talk handsfree, and because the phone sports an internal antenna, there's nothing to snag or break off.
+</description>
+ <meta_keyword>Nokia 2610, cell, phone, </meta_keyword>
+ <short_description>The words "entry level" no longer mean "low-end," especially when it comes to the Nokia 2610. Offering advanced media and calling features without breaking the bank</short_description>
+ <name>Nokia 2610 Phone</name>
+ <meta_title>Nokia 2610</meta_title>
+ <meta_description>Offering advanced media and calling features without breaking the bank, The Nokia 2610 is an easy to use</meta_description>
+ <regular_price_with_tax>149.99</regular_price_with_tax>
+ <regular_price_without_tax>149.99</regular_price_without_tax>
+ <final_price_with_tax>149.99</final_price_with_tax>
+ <final_price_without_tax>149.99</final_price_without_tax>
+ <is_saleable>1</is_saleable>
+ <image_url>http://magentohost/imageulr/nokia.jpg</image_url>
+ </data_item>
+ <data_item>
+ <entity_id>17</entity_id>
+ <type_id>simple</type_id>
+ <sku>bb8100</sku>
+ <description> Like the BlackBerry 7105t, the BlackBerry 8100 Pearl is
+The BlackBerry 8100 Pearl sports a large 240 x 260 screen that supports over 65,000 colors-- plenty of real estate to view your e-mails, Web browser content, messaging sessions, and attachments. The venerable BlackBerry trackwheel has been replaced on this model with an innovative four-way trackball placed below the screen. On the rear of the handheld, you'll find a 1.3-megapixel camera and a self portrait mirror. The handheld's microSD memory card slot is located inside the device, behind the battery. There's also a standard 2.5mm headset jack that can be used with the included headset, as well as a mini-USB port for data connectivity.</description>
+ <meta_keyword>Blackberry, 8100, pearl, cell, phone</meta_keyword>
+ <short_description>The BlackBerry 8100 Pearl is a departure from the form factor of previous BlackBerry devices. This BlackBerry handset is far more phone-like, and RIM's engineers have managed to fit a QWERTY keyboard onto the handset's slim frame.</short_description>
+ <name>BlackBerry 8100 Pearl</name>
+ <meta_title>BlackBerry 8100 Pearl</meta_title>
+ <meta_description>BlackBerry 8100 Pearl sports a large 240 x 260 screen that supports over 65,000 colors-- plenty of real estate to view your e-mails, Web browser content, messaging sessions, and attachments.</meta_description>
+ <regular_price_with_tax>349.99</regular_price_with_tax>
+ <regular_price_without_tax>349.99</regular_price_without_tax>
+ <final_price_with_tax>349.99</final_price_with_tax>
+ <final_price_without_tax>349.99</final_price_without_tax>
+ <is_saleable>1</is_saleable>
+ <image_url>http://magentohost/imageulr/blackberry.jpg</image_url>
+ </data_item>
+</magento_api>
+
+
+
+
+
Additional Information
+
+
You can define the limit of items returned in the response by passing the limit parameter. By default, 10 items are
+ returned and the maximum number is 100 items. You can also define the page number by passing the page parameter.
+ Example:
Authorization header will be required for Admin and Customer user types. The following parameters must be provided in
+ the Authorization header for the call:
+
+
oauth_consumer_key - the Consumer Key value provided after the registration of the application.
+
oauth_nonce - a random value, uniquely generated by the application.
+
oauth_signature_method - name of the signature method used to sign the request. Can have one of the following
+ values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.
+
oauth_signature - a generated value (signature).
+
oauth_timestamp - a positive integer, expressed in the number of seconds since January 1, 1970 00:00:00 GMT.
+
+
oauth_token - the oauth_token value (Request Token).
REST attributes allow specifying additional filters for different types of users. Attributes allow limiting user access more precisely.
+
+
+
REST Attributes Structure
+
+
+
+
The REST attributes tree includes the following elements (as subnodes):
+
+
Name of the resource
+
+
Read permissions (includes all elements available for the current resource)
+
Write permissions (includes all elements available for the current resource)
+
+
+
+
+
+
The Resources tree may be too immense. To avoid scrolling down when searching for the required resource, you can fold the nodes for better representation.
+
+
+
+
Managing Attributes for Guest
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
+
The REST Attributes page opens. From the list of user types, select the Guest type and click it.
+
The page for editing attribute rules opens.
+
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to a Guest type of user by selecting the corresponding All or Custom options.
+
If you select the Custom option, the resources tree appears.
+
Select the required options and click Save in the top right corner to apply changes.
+
+
+
+
+
Managing Attributes for Customer
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
+
The REST Attributes page opens. From the list of user types, select the Customer type and click it.
+
The page for editing attribute rules opens.
+
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to a Customer type of user by selecting the corresponding All or Custom options.
+
If you select the Custom option, the resources tree appears. Some resources have options for selecting read and write permissions.
+
Select the required options and click Save in the top right corner to apply changes.
+
+
+
+
Managing Attributes for Admin
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
+
The REST Attributes page opens. From the list of user types, select the Admin type and click it.
+
The page for editing attribute rules opens.
+
In the User Type Resources panel, in the Resource Access drop-down list, select whether all or some specific resources will be limited to an Admin type of user by selecting the corresponding All or Custom options.
+
If you select the Custom option, the resources tree appears. Each resource has options for selecting read and write permissions.
+
Select the required options and click Save in the top right corner to apply changes.
+
+
+
+
+
Examples
+
+
This section provides some examples of limiting Guest and Customer access to certain resource elements.
+
+
Limiting Guest Access to Products
+
+
To allow Guests (users that are not registered in the Magento system) view only product name and final price with tax, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles and select the Guest role.
+
In the Role API Resources, specify the Retrieve option for the Product resource.
+
Click Save Role on the top right corner to save the role.
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes and select Guest in the list of User Types.
+
In the Resources tree, navigate to the Catalog Product node. In the Read subnode, select the Name and Final Price With Tax options.
+
Click Save in the top right corner to save the selected attributes.
+
+
+
+
+
Limiting Customer Access to Products
+
+
To allow Customers (users that are registered in the Magento system) view only product name and final price with tax, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles and select the Customer role.
+
In the Role API Resources, specify the Retrieve option for the Product resource.
+
Click Save Role on the top right corner to save the role.
+
On the Magento Admin Panel menu, select System > Web Services > REST - Attributes and select Customer in the list of User Types.
+
In the Resources tree, navigate to the Catalog Product node. In the Read subnode, select the Name and Final Price With Tax options.
+
Click Save in the top right corner to save the selected attributes.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/rest/permission_settings/attributes_description.html b/guides/v19.x/api/rest/permission_settings/attributes_description.html
new file mode 100644
index 0000000000..15f30889b3
--- /dev/null
+++ b/guides/v19.x/api/rest/permission_settings/attributes_description.html
@@ -0,0 +1,1101 @@
+---
+layout: v1x_rest
+title: Attributes Description
+---
+
+
+
The following table describes REST attributes that can be managed in the Magento Admin Panel.
+To access these attributes, go to System > Web Services > REST Attributes and select the type of the user for which attributes will be managed.
+
+
+
Order/Orders
+
+
+
+
+
+
Attribute Name
+
Attribute Description
+
Notes
+
+
+
Order ID
+
Sales order ID
+
+
+
+
Order Date
+
Date when the sales order was placed
+
+
+
+
Order Status
+
Sales order status. Can have the following values: Pending, Processing, Complete, Closed, Holded, Pending PayPal, and Payment Review.
+
+
+
+
Shipping Method
+
Shipping method selected during the checkout process (e.g., Flat rate - Fixed)
+
+
+
+
Payment Method
+
Payment method selected during the checkout process (e.g., Check/money order)
+
+
+
+
Base Currency
+
Base currency code (e.g., USD)
+
+
+
+
Order Currency
+
Order currency code (e.g., EUR)
+
+
+
+
Store Name
+
Name of the store from which the order was placed
+
+
+
+
Placed from IP
+
IP address from which the order was placed
+
+
+
+
Store Currency to Base Currency Rate
+
Store currency to base currency rate
+
+
+
+
Subtotal
+
Subtotal amount in order currency (excluding shipping and tax)
+
+
+
+
Subtotal Including Tax
+
Subtotal amount including tax (in order currency)
+
+
+
+
Discount
+
Discount amount applied in the sales order in order currency
+
+
+
+
Grand Total to Be Charged
+
Total amount of money to be paid for the order in base currency (including tax)
+
+
+
+
Grand Total
+
Grand total amount in order currency (including tax and shipping)
+
+
+
+
Shipping
+
Shipping amount applied in the sales order in order currency
+
+
+
+
Shipping Including Tax
+
Shipping amount including tax (in order currency)
+
+
+
+
Shipping Tax
+
Tax amount for shipping in order currency
+
+
+
+
Tax Amount
+
Tax amount applied in the sales order in order currency
+
+
+
+
Tax Name
+
Name of the applied tax
+
+
+
+
Tax Rate
+
Tax rate applied in the order (in order currency)
+
+
+
+
Gift Cards Amount
+
Gift card pricing amount
+
This attribute is available only in Magento EE
+
+
+
Reward Points Balance
+
Reward points amount (that can be converted to currency)
+
This attribute is available only in Magento EE
+
+
+
Reward Currency Amount
+
Reward currency amount
+
This attribute is available only in Magento EE
+
+
+
Coupon Code
+
Coupon code that was applied in the order
+
+
+
+
Base Discount
+
Amount of applied discount in base currency
+
+
+
+
Base Subtotal
+
Subtotal amount for all products in the order in base currency (excluding tax and shipping)
+
+
+
+
Base Shipping
+
Amount of money to be paid for shipping in base currency
+
+
+
+
Base Shipping Tax
+
Tax amount for shipping in base currency
+
+
+
+
Base Tax Amount
+
Tax amount applied to the order items in base currency
+
+
+
+
Total Paid
+
Total amount paid for the order (in order currency)
+
+
+
+
Base Total Paid
+
Total amount paid for the order (in base currency)
+
+
+
+
Total Refunded
+
Total refunded amount in order currency
+
+
+
+
Base Total Refunded
+
Total amount refunded for the order (in base currency)
+
+
+
+
Base Subtotal Including Tax
+
Subtotal amount including tax but excluding the discount amount (in base currency)
+
+
+
+
Base Total Due
+
The rest of the money to be paid for the order in base currency (e.g., when partial invoice is applied)
+
+
+
+
Total Due
+
The rest of the money to be paid for the order in order currency (e.g., when partial invoice is applied)
+
+
+
+
Shipping Discount
+
Discount amount for shipping (in order currency)
+
+
+
+
Base Shipping Discount
+
Discount amount for shipping (in base currency)
+
+
+
+
Discount Description
+
Discount code (coupon code applied in the order)
+
+
+
+
Customer Balance
+
Customer balance (in order currency)
+
+
+
+
Base Customer Balance
+
Customer balance (in base currency)
+
+
+
+
Base Gift Cards Amount
+
Gift card pricing amount (in base currency)
+
This attribute is available only in Magento EE
+
+
+
Base Rewards Currency
+
Reward currency amount (in base currency)
+
This attribute is available only in Magento EE
+
+
+
+
+
+
Order Addresses
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Customer Last Name
+
Customer last name
+
+
+
Customer First Name
+
Customer first name
+
+
+
Customer Middle Name
+
Customer middle name or initial
+
+
+
Customer Prefix
+
Customer prefix
+
+
+
Customer Suffix
+
Customer suffix
+
+
+
Company
+
Company name
+
+
+
Street
+
Street address
+
+
+
City
+
City
+
+
+
State
+
State
+
+
+
ZIP/Postal Code
+
ZIP or postal code
+
+
+
Country
+
Country name
+
+
+
Phone Number
+
Customer phone number
+
+
+
Address Type
+
Address type. Can have the following values: billing or shipping
+
+
+
+
+
+
+
Order Items
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Base Discount Amount
+
Discount amount applied to the row in base currency
+
+
+
Base Item Subtotal
+
Row subtotal in base currency
+
+
+
Base Item Subtotal Including tax
+
Row subtotal including tax in base currency
+
+
+
Base Original Price
+
Original item price in base currency
+
+
+
Base Price
+
Item price in base currency
+
+
+
Base Price Including tax
+
Item price including tax in base currency
+
+
+
Base Tax Amount
+
Tax amount applied to the row in base currency
+
+
+
Canceled Qty
+
Number of canceled order items
+
+
+
Discount Amount
+
Discount amount applied to the row in order currency
+
+
+
Invoiced Qty
+
Number of invoiced order items
+
+
+
Item Subtotal
+
Row subtotal in order currency
+
+
+
Item Subtotal Including Tax
+
Row subtotal including tax in order currency
+
+
+
Order Item ID
+
Order item ID
+
+
+
Ordered Qty
+
Number of ordered items
+
+
+
Original Price
+
Original item price in order currency
+
+
+
Parent Order Item ID
+
ID of the configurable product to which the simple product is assigned
+
+
+
Price
+
Item price in order currency
+
+
+
Price Including Tax
+
Item price including tax in order currency
+
+
+
Product and Custom Options Name
+
Name of the product (custom options name)
+
+
+
Refunded Qty
+
Number of refunded order items
+
+
+
SKU
+
Product SKU
+
+
+
Shipped Qty
+
Number of shipped order items
+
+
+
Tax Amount
+
Tax amount applied to the row in order currency
+
+
+
Tax Percent
+
Tax percent applied to the row
+
+
+
+
+
+
+
Stock Item
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Automatically Return Credit Memo Item to Stock
+
Defines whether products can be automatically returned to stock when the refund for an order is created
+
+
+
Backorders
+
Defines whether the customer can place the order for products that are out of stock at the moment. Can have the following values: 0 - No Backorders, 1 - Allow Qty Below 0, and 2 - Allow Qty Below 0 and Notify Customer
+
+
+
Can Be Divided into Multiple Boxes for Shipping
+
Defines whether the stock items can be divided into multiple boxes for shipping
+
+
+
Enable Qty Increments
+
Defines whether the customer can add products only in increments to the shopping cart
+
+
+
Item ID
+
Stock item ID
+
+
+
Low Stock Date
+
Date when the number of stock items became lower than the number defined in the Notify for Quantity Below option
+
+
+
Manage Stock
+
Choose whether to view and specify the product quantity and availability and whether the product is in stock management. Can have the following values: 0 - No, 1 - Yes
+
+
+
Maximum Qty Allowed in Shopping Cart
+
Maximum number of items in the shopping cart to be sold
+
+
+
Minimum Qty Allowed in Shopping Cart
+
Minimum number of items in the shopping cart to be sold
+
+
+
Notify for Quantity Below
+
The number of inventory items below which the customer will be notified via the RSS feed
+
+
+
Product ID
+
Product ID
+
+
+
Qty
+
Quantity of stock items for the current product
+
+
+
Qty Increments
+
The product quantity increment value
+
+
+
Qty Uses Decimals
+
Choose whether the product can be sold using decimals (e.g., you can buy 2.5 product)
+
+
+
Qty for Item's Status to Become Out of Stock
+
Quantity for stock items to become out of stock
+
+
+
Stock Availability
+
Defines whether the product is available for selling. Can have the following values: 0 - Out of Stock, 1 - In Stock
+
+
+
Stock ID
+
Stock ID
+
+
+
Use Config Settings for Backorders
+
Choose whether the Config settings will be applied for the Backorders option
+
+
+
Use Config Settings for Enable Qty Increments
+
Choose whether the Config settings will be applied for the Enable Qty Increments option
+
+
+
Use Config Settings for Manage Stock
+
Choose whether the Config settings will be applied for the Manage Stock option
+
+
+
Use Config Settings for Maximum Qty Allowed in Shopping Cart
+
Choose whether the Config settings will be applied for the Maximum Qty Allowed in Shopping Cart option
+
+
+
Use Config Settings for Minimum Qty Allowed in Shopping Cart
+
Choose whether the Config settings will be applied for the Minimum Qty Allowed in Shopping Cart option
+
+
+
Use Config Settings for Notify for Quantity Below
+
Choose whether the Config settings will be applied for the Notify for Quantity Below option
+
+
+
Use Config Settings for Qty Increments
+
Choose whether the Config settings will be applied for the Qty Increments option
+
+
+
Use Config Settings for Qty for Item's Status to Become Out of Stock
+
Choose whether the Config settings will be applied for the Qty for Item's Status to Become Out of Stock option
+
+
+
+
+
+
Notes: The Admin user type has restrictions concerning the WRITE operations for definite stock item attributes. These are as follows:
+
+
+
+
Attribute Name
+
Admin
+
+
+
Item ID
+
No
+
+
+
Product ID
+
No
+
+
+
Stock ID
+
No
+
+
+
Low Stock Date
+
No
+
+
+
+
+
However, these attributes are available for READ operations.
+
+
+
+
Customer
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Customer ID
+
Customer ID
+
+
+
Last Logged In
+
Date when the customer was logged in last
+
+
+
Is Confirmed
+
Defines whether the email confirmation is sent to the customer
+
+
+
Created At
+
Date when the customer was created
+
+
+
Associate to Website
+
Website ID to which the customer is associated
+
+
+
Created From
+
Store view from which the customer was created
+
+
+
Group
+
Customer group ID
+
+
+
Disable automatic group change
+
Defines whether the automatic group change will be applied to the customer
+
+
+
Prefix
+
Customer prefix
+
+
+
First Name
+
Customer first name
+
+
+
Middle Name/Initial
+
Customer middle name or initial
+
+
+
Last Name
+
Customer last name
+
+
+
Suffix
+
Customer suffix
+
+
+
Email
+
Customer email address
+
+
+
Date Of Birth
+
Customer date of birth
+
+
+
Tax/VAT Number
+
Customer tax or VAT number
+
+
+
Gender
+
Customer gender (male or female)
+
+
+
+
+
+
Customer Address
+
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
City
+
City name
+
+
+
Company
+
Company name
+
+
+
Country
+
Country
+
+
+
Customer Address ID
+
Customer address ID
+
+
+
Fax
+
Fax number
+
+
+
First Name
+
Customer first name
+
+
+
Is Default Billing Address
+
Defines whether the address is a default one for billing
+
+
+
Is Default Shipping Address
+
Defines whether the address is a default one for shipping
+
+
+
Last Name
+
Customer last name
+
+
+
Middle Name/Initial
+
Customer middle name or initial
+
+
+
Prefix
+
Customer prefix
+
+
+
State/Province
+
Customer state/region
+
+
+
Street Address
+
Customer street address
+
+
+
Suffix
+
Customer suffix
+
+
+
Telephone
+
Customer phone number
+
+
+
VAT Number
+
Customer VAT number
+
+
+
ZIP/Postal Code
+
Customer ZIP or postal code
+
+
+
+
+
+
+
Product
+
+
Attributes for the product resource are divided into those available for the Admin type of user and those available for the Customer and Guest types of user.
+
+
+
+
+
Attribute Name
+
Attribute Description
+
Notes
+
+
+
Product ID
+
Product ID
+
Available only for Admin
+
+
+
name
+
Product Name
+
+
+
+
Product Type
+
Product type. Can have the following values: Simple, Grouped, Configurable, Virtual, Bundle, or Downloadable
+
+
+
+
Attribute Set Name
+
Name of the attribute set which the product is based on
+
Available only for Admin
+
+
+
sku
+
Product SKU
+
+
+
+
price
+
Product price
+
+
+
+
visibility
+
Product visibility in the store. Can have the following values: Catalog, Search; Search; Catalog; Not Visible Individually
+
Available only for Admin
+
+
+
description
+
Product description
+
+
+
+
short_description
+
Product short description
+
+
+
+
weight
+
Product weight
+
Available only for Admin
+
+
+
news_from_date
+
Date starting from which the product is promoted as a new product
+
Available only for Admin
+
+
+
news_to_date
+
Date till which the product is promoted as a new product
+
Available only for Admin
+
+
+
status
+
Product status in the store. Can have the following values: Enabled or Disabled
+
Available only for Admin
+
+
+
url_key
+
A friendly URL path for the product
+
Available only for Admin
+
+
+
Create Permanent Redirect for Old URL
+
Defines whether the redirect to an original URL will be applied (when the existing URL for a product is edited)
+
Available only for Admin; available only for product update
+
+
+
country_of_manufacture
+
Product country of manufacture
+
Available only for Admin
+
+
+
is_returnable
+
Defines whether the product can be returned
+
Available only for Admin
+
+
+
special_price
+
Product special price
+
Available only for Admin
+
+
+
special_from_date
+
Date starting from which the special price will be applied for the product
+
Available only for Admin
+
+
+
special_to_date
+
Date till which the special price will be applied for the product
+
Available only for Admin
+
+
+
group_price
+
Product group price
+
Available only for Admin
+
+
+
tier_price
+
Product tier price
+
+
+
+
msrp_enabled
+
The Apply MAP option. Defines whether the price in the catalog in the frontend is substituted with a Click for price link
+
Available only for Admin
+
+
+
msrp_display_actual_price_type
+
Defines how the price will be displayed in the frontend. Can have the following values: In Cart, Before Order Confirmation, and On Gesture
+
Available only for Admin
+
+
+
msrp
+
The Manufacturer's Suggested Retail Price option. The price that a manufacturer suggests to sell the product at
+
Available only for Admin
+
+
+
enable_googlecheckout
+
Defines whether the product can be purchased with the help of the Google Checkout payment service. Can have the following values: Yes and No
+
Available only for Admin
+
+
+
tax_class_id
+
The product tax class to which the product will be associated
+
Available only for Admin
+
+
+
meta_title
+
Product meta title
+
+
+
+
meta_keyword
+
Product meta keywords
+
+
+
+
meta_description
+
Product meta description
+
+
+
+
custom_design
+
Custom design applied for the product page
+
Available only for Admin
+
+
+
custom_design_from
+
Date starting from which the custom design will be applied for the product page
+
Available only for Admin
+
+
+
custom_design_to
+
Date till which the custom design will be applied for the product page
+
Available only for Admin
+
+
+
custom_layout_update
+
An XML block to alter the page layout
+
Available only for Admin
+
+
+
page_layout
+
Page template that can be applied to the product page
+
Available only for Admin
+
+
+
options_container
+
Defines how the custom options for the product will be displayed. Can have the following values: Block after Info Column or Product Info Column
+
Available only for Admin
+
+
+
gift_message_available
+
Defines whether the gift message is available for the product
+
Available only for Admin
+
+
+
Use Config Settings for Allow Gift Message
+
Defines whether the configuration settings will be used for the Allow Gift Message option
+
Available only for Admin
+
+
+
gift_wrapping_available
+
Defines whether the gift wrapping is available for the product
+
Available only for Admin. This attribute is available in Magento EE
+
+
+
Use Config Settings for Allow Gift Wrapping
+
Defines whether the configuration settings will be used for the Allow Gift Wrapping option
+
Available only for Admin. This attribute is available in Magento EE
+
+
+
gift_wrapping_price
+
Price for the gift wrapping (available in Magento EE)
+
Available only for Admin
+
+
+
Inventory Data
+
Product inventory data
+
Available only for Admin
+
+
+
Custom attr
+
Product custom attributes
+
The customer can see only attributes that are set as visible on frontend
+
+
+
Regular Price
+
The original product price displayed in the frontend
+
Available only for Customer and Guest
+
+
+
Final Price
+
The final product price
+
Available only for Customer and Guest
+
+
+
Final Price with Tax
+
The final product price with tax
+
Available only for Customer and Guest
+
+
+
Final Price Without Tax
+
The final product price without tax
+
Available only for Customer and Guest
+
+
+
Stock Status
+
The product stock status (availability)
+
Available only for Customer and Guest
+
+
+
Product Is Saleable
+
Defines whether the product can be sold
+
Available only for Customer and Guest
+
+
+
Total Reviews Number
+
The number of all reviews for a product
+
Available only for Customer and Guest
+
+
+
Product URL Link
+
A link to the product without the assigned category
+
Available only for Customer and Guest
+
+
+
Buy Now Link
+
A link that adds a product to the shopping cart
+
Available only for Customer and Guest
+
+
+
Product Has Custom Options
+
Defines whether the product has custom options or not
+
Available only for Customer and Guest
+
+
+
Default Product Image
+
Default product image
+
Available only for Customer and Guest
+
+
+
+
+
Product Category
+
+
+
+
+
+
Attribute Name
+
Attribute Description
+
+
+
Category ID
+
ID of the category to which the product is assigned
+
+
+
+
+
+
Product Image
+
+
+
+
+
+
Attribute Name
+
Attribute Description
+
Notes
+
+
+
Exclude
+
Defines whether the image will associate only to one of the three image types.
+
+
+
+
ID
+
Image file ID
+
Available only for READ operations
+
+
+
Label
+
A label that will be displayed on the frontend when pointing to the image
+
+
+
+
Position
+
The Sort Order option. The order in which the images are displayed in the MORE VIEWS section.
+
+
+
+
Type
+
Image type. Can have the following values: Base Image, Small Image, or Thumbnail.
+
+
+
+
URL
+
Image file URL path
+
Available only for READ operations
+
+
+
File Content
+
Image file content (base_64 encoded)
+
Available only for WRITE operations
+
+
+
File MIME Type
+
File MIME type. Can have the following values: image/jpeg, image/png, image/gif, etc.
+
Available only for WRITE operations
+
+
+
File Name
+
Image file name
+
Available only for WRITE operations
+
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/rest/permission_settings/permission_settings.html b/guides/v19.x/api/rest/permission_settings/permission_settings.html
new file mode 100644
index 0000000000..b4b4621722
--- /dev/null
+++ b/guides/v19.x/api/rest/permission_settings/permission_settings.html
@@ -0,0 +1,111 @@
+---
+layout: v1x_rest
+title: Permission Settings
+---
+
+
+
After the authentication is complete successfully, the Access Token is received and will be used in every API call. This key allows identifying the client that accesses the API. With the help of this key, the following information about the user can be retrieved:
+
+
+
Type of the API user
+
User ID (can be Admin ID or Customer ID)
+
+
+
Authorization
+
+
+
Access Levels
+
+
There is a three-level authorization approach in Magento REST API. These three levels are as follows:
+
+
Guest
+
Customer
+
Admin
+
+
+
+
The following graphic describes the default rights for each access level with each level obtaining more rights up to Admin who has access to everything.
+
+
+
+
+
Each user type will be described below.
+Magento grants permissions for the following three types of users:
+
+
Guest
+
+
Guest can be a type of application that does not require authentication. This application has access only to public resources.
+
+
Customer
+
+
Customer can be a registered and logged in user. This type of user can have access only to its own resources as well as to public resources.
+
+
Admin
+
+
Admin can be the store owner. This type has full set of permissions.
+
+
Understanding of access levels is the basis of the ACL work.
+
+
Access Control List (ACL)
+
+
ACL Overview
+
+
Every user has a specific role and purpose. To accomplish their goals, each user must be able to access certain resources and perform specific actions. Allowing users to access the resources without any limits can compromise Magento security.
+
+
The Access Control List (ACL) is a set of permissions (access rights) that particular users have for certain resources. When a user wants to perform a specific action with a resource (for example, update the customer information), Magento checks the permission for this combination of user, resource, and action. If the action is allowed, the user can proceed. Otherwise, the action is denied.
+
+
Understanding ACL
+
+
Access control lists include two main things: a subject and an object. Usually, the subject is the user who wants to use the resource. The object is the resource that a certain user wants to have access to. So, ACL is used to decide when the subject can have access to object.
+
+
You should remember that ACL is not the same as authentication. ACL is the next step after the authentication is passed successfully. These two concepts are closely connected but the difference lies in the following: authentication is understanding who the user is and ACL is understanding what the user can do.
+
+
+
+
ACL Structure
+
+
ACL is implemented in a tree structure. There is a tree of resources for each user type. Namely, Admin, Customer, and Guest have their own trees of resources.
+Each ACL entry specifies two instances: a subject and an action the subject can perform.
+
+
Example of the resource tree for the Admin role is as follows:
+
+
+
+
Read/Write Permissions
+
+
All REST resource attributes are divided into two categories: Read and Write. The Read category includes the operation of retrieving. So, when selecting the attributes in the Read category, you specify them for the resource retrieving. The Write category includes the operations of creating and updating. So, when selecting the attributes in the Write category, you specify them for the resource creation and updating. To illustrate the situation, let's take the following example:
+
REST roles in Magento are used to limit access to certain resources. Limiting access lies in configuration of a REST role and assigning a user to it. You can select which resources will be available for the user and which will not.
+
+
REST roles management consists in the role creation, editing, deleting, and user assignment. Note that REST role creation and deletion is available only for Admin role.
+
+
The REST Roles page initially includes two roles: Customer and Guest.
+
+
Only API Resources can be edited in the Guest and Customer roles. You cannot change the name or assigned users in these roles. Also, you cannot delete the Guest or Customer role. For example, when editing the Guest Role, the page looks as follows:
+
+
+
Viewing REST Roles
+
+
To view the list of REST roles, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens.
+
REST roles are displayed in a grid with the following columns: ID (role ID), Role Name, User Type, and Created At (date and time of the role creation).
+
+
+
+
+
Working with Admin Role
+
+
Adding a New REST Role for Admin
+
+
To add a new REST role for Admin, perform the following steps:
+
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens.
+
In the top right corner, click Add Admin Role. The Add New Role page opens.
+
There are two tabs in the Role Information panel on the left: Role Info and Role API Resources.
+
Select the Role Info tab and in the Role Information panel, enter the name for the role to be created in the corresponding Role Name field. This field is required.
+
In the Role API Resources tab, in the Resource Access drop-down list, select whether the user will have full or custom access by selecting the corresponding All or Custom options. If you select the Custom option, the Resources tree will appear where you will be able to check the required resources and actions.
+
Click Save Role in the top right corner to save the role.
+
After you saved the role, a new Role Users tab appears in the Role Information panel on the left. In this tab, you can manage users for the current role. Click Reset Filter to view all users to which the role can be assigned.
+
+
+
+
+
Editing an Existing Admin REST Role
+
+
To edit an existing Admin REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. In the roles grid, select the Admin role and click it.
+
The Edit Role <role name> page opens. You can edit the following information:
+
+
Role Info: Edit the name of the Admin role by selecting the Role Info tab to the left.
+
Role API Resources: Select or clear the resources available for this role.
+
Role Users: Assign or remove users for this role.
+
+
+
Click Save Role in the top right corner to apply changes.
+
+
+
+
+
Deleting an Existing Admin REST Role
+
+
To delete an existing Admin REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. In the roles grid, select the required Admin role to be deleted and click it.
+
The Edit Role <role name> page opens. In the top right corner, click Delete Role. The role is deleted.
+
+
+
+
+
Assigning a REST Role to Admin
+
+
To assign a REST role to admin, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Permissions > Users.
+
The Users page opens. In the users grid, select the user to which the REST Admin role will be assigned.
+
The Edit User <Name of the User> page opens. In the User Information panel, select the REST Role tab.
+
In the list of REST roles, select the Admin role to be assigned and select the option button next to it.
+
Click Save User in the top right corner to save changes.
+
+
+
+
Assigning Multiple Users to an Admin REST Role
+
+
To assign more than one user to an existing Admin REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. In the REST roles grid, select the Admin role to which users will be assigned.
+
The Edit Role <role name> page opens. In the Role Information panel, select the Role Users tab.
+
In the list of users, click Reset Filter to view the list of all users to which the role can be assigned. Select the checkboxes near the users to be assigned to the Admin role.
+
Click Save Role in the top right corner to save changes.
+
+
+
+
+
Viewing Users Assigned to an Admin REST Role
+
+
To view the list of users assigned to a REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. From the list of roles, select the Admin role whose assigned users you want to view and click it.
+
The Edit Role <role name> page opens. In the Role Information panel on the left, select the Role Users tab.
+
The list of REST role users is displayed in a grid with the following columns: ID, User Name, First Name, and Last Name.
+
+
+
+
+
+
Unassigning User from the Admin REST Role
+
+
To unassign the Admin REST role from a user, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. From the list of roles, select the Admin role from which you want to unassign a user and click it.
+
The Edit Role <role name> page opens. In the Role Information panel on the left, select the Role Users tab.
+
Clear the checkbox next to the user which you want to unassign from the current REST role.
+
Click Save Role in the top right corner to apply the changes.
+
+
+
+
+
Working with Guest and Customer Roles
+
+
As it has been mentioned before, the Customer and Guest roles cannot be removed and can be only partially edited. You can edit only the resources and actions allowed for the user.
+
+
Editing the Guest REST Role
+
+
To edit the Guest REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. From the list of roles, select the Guest role and click it.
+
The Edit Role "Guest" page opens. In the Role Resources panel, edit the required information.
+
Click Save Role in the top right corner to apply changes.
+
+
+
+
Editing the Customer REST Role
+
+
To edit the Customer REST role, perform the following steps:
+
+
On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
+
The REST Roles page opens. From the list of roles, select the Customer role and click it.
+
The Edit Role "Customer" page opens. In the Role Resources panel, edit the required information.
+
Click Save Role in the top right corner to apply changes.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/rest/response_formats.html b/guides/v19.x/api/rest/response_formats.html
new file mode 100644
index 0000000000..79d2e7d668
--- /dev/null
+++ b/guides/v19.x/api/rest/response_formats.html
@@ -0,0 +1,166 @@
+---
+layout: v1x_rest
+title: Response Formats
+---
+
+
+
+
If you make a Magento API call, you are guaranteed to receive some kind of a response. If you make a successful call, you will receive an HTTP response with a 200 OK status.
+
+
REST API Response Formats
+
+
You can view the response data from any Magento API call in one of the following two formats:
+
+
+
XML
+
JSON
+
+
+
+
The format of returned data is defined in the request header. The format you choose depends on what you are familiar with most or tools available to you.
+
+
+
XML Format
+
+
The XML response format is a simple XML block.
+To set the response format to XML, add the Accept request header with the text/xml value.
+
+
A successful call will return the following response (example of retrieving information about stock items):
JSON (JavaScript Object Notation) is a lightweight data-interchange format.
+To set the response format to JSON, add the Accept request header with the application/json value.
+
+
Response Structure
+
+
The JSON objects represent a direct mapping of the XML block from the XML response format.
The list of HTTP status codes that are returned in the API response is described in the Common HTTP Status Codes part of the documentation. There, you can find the list of codes themselves together with their description.
The following parameters must be provided in the Authorization header for the call:
+
+
oauth_signature_method
+
oauth_version
+
oauth_nonce
+
oauth_timestamp
+
oauth_consumer_key
+
oauth_token
+
oauth_signature
+
+
+
+
Testing
+ REST resources with the REST Client plugin
+ for the Mozilla Firefox browser.
+
+
+
Open the REST Client.
+
From the Authentication drop-down, select OAuth.
+
+
In the OAuth window, on the Signature for the request tab, fill in the following fields:
+
+
Consumer key: Enter the Key value provided when you created the consumer in Magento Admin Panel.
+
+
Consumer secret: Enter the Secret value provided when you created the consumer in Magento Admin
+ Panel.
+
Access token: Enter the oauth_token value received when you authenticated the application.
+
Access token secret: Enter the oauth_token_secret value received when you authenticated the
+ application.
+
+
+
On the OAuth setting tab, define the following options:
+
+
+
Signature Methods: From the drop-down list, select which method will be used for signatures (HMAC-SHA1
+ or PLAINTEXT).
+
oAuth Version: From the drop-down list, select the 1.0 option (REST API supports OAuth 1.0a).
+
+
Leave the Realm, oAuth Nonce, and oAuth Timestamp values set by default.
+
+
+
Click Save and wait for the confirmation dialog to close.
+
Return to the Signature for the request tab and select Insert > Insert as header.
+
+
An authorization header is created on the main page of REST Client.
+
+
+
+ NOTE: Click the header with authorization data and click Auto refresh in the opened pop-up in order to
+ generate new values for oauth_nonce, oauth_timestamp, and oauth_signature at each request.
+
+
From the Headers drop-down, select Custom Header.
+
+
In the Request Header window, enter "Content-Type" in the Name field and "text/xml" in the
+ Value field (if you want to use the XML data format). To use the JSON request data format, enter
+ application/json instead of the text/xml value.
+
Click Okay.
+
+
+
+
+
+
+
Example: Retrieving the List of Products
+
+
+
From the Method drop-down list, select the GET option.
+
In the URL field, enter the following URL: http://magentohost/api/rest/products. You can limit the number
+ of products returned in the response. To set the limit to 4, enter the following URL:
+ http://magentohost/api/rest/products?limit=4
+
Click Send. Information about all products will be displayed in the response body. Example is as
+ follows:
+
In the first field, start typing authorization. An Authorization popup appears. Click it.
+
+
When you click the fields next to the Authorization header, the Construct link appears. Click it to
+ configure OAuth authentication.
+
The Authorization window opens. Select the OAuth tab.
+
+
In the Type group of options, select the Signed Request option.
+
In the signature method group of options, select which method will be used for signatures (HMAC-SHA1 or
+ PLAINTEXT).
+
Fill in the following data:
+
+
+
Consumer key: Enter the Key value provided when you created the consumer in Magento Admin Panel.
+
+
Consumer secret: Enter the Secret value provided when you created the consumer in Magento Admin
+ Panel.
+
Access Token: Enter the oauth_token value received when you authenticated the application.
+
Access Token Secret: Enter the oauth_token_secret value received when you authenticated the
+ application.
+
+
+
Click OK.
+ NOTE: Advanced REST Client does not save the Consumer secret and Access Token Secret values.
+ You need to enter these values each time you make a request.
+
In the URL field, enter the URL to which the API call will be performed and select the required HTTP
+ method.
+
In the Headers table, click Add row and add the Accept - application/json or Accept - text/xml
+ header depending on which format you prefer for the returned data.
+
Click Send Request.
+
+
+
+
Example: Retrieving the list of customers
+
+
+
In the Method group of options, select the GET option.
+
In the URL field, enter the following URL: http://magentohost/api/rest/customers.
+
Click Send request. Information about all customers will be displayed in the response body. Note that only
+ Admin type of the user can retrieve the list of customers. Example is as follows:
+
+
+
+
+
Example: Creating a customer address
+
+
+
In the Method group of options, select the POST option.
+
In the URL field, enter the following URL: http://magentohost/api/rest/customers/:id/addresses where the ":id"
+ value is the customer ID in the system.
+
In the Body table, on the Raw input tab, enter the data required for customer address creation.
+
Click Send request. If the address is created, the 200 OK HTTP status code will be returned. Example is as
+ follows:
+
+
\ No newline at end of file
diff --git a/guides/v19.x/api/soap-api-index.html b/guides/v19.x/api/soap-api-index.html
new file mode 100644
index 0000000000..fbc04d5ea8
--- /dev/null
+++ b/guides/v19.x/api/soap-api-index.html
@@ -0,0 +1,211 @@
+---
+layout: v1x
+title: Magento 1.x SOAP API
+---
+
+
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.assignProduct (SOAP V1)
+
catalogCategoryAssignProduct (SOAP V2)
+
+
+
+
Assign a product to the required category.
+
+
Aliases:
+
+
category.assignProduct
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the category
+
+
+
string
+
product/productId
+
ID or SKU of the product to be assigned to the category
+
+
+
string
+
position
+
Position of the assigned product in the category (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' argument
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the product is assigned to the specified category
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.assignProduct', array('categoryId' => '4', 'product' => '1'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAssignProduct($sessionId, '4', '3');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.assignedProducts (SOAP V1)
+
catalogCategoryAssignedProducts (SOAP V2)
+
+
+
+
Retrieve the list of products assigned to a required category.
+
+
Aliases:
+
+
category.assignedProducts
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the required category
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogAssignedProduct
+
+
+
+
+
The catalogAssignedProduct content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
product_id
+
ID of the assigned product
+
+
+
string
+
type
+
Product type
+
+
+
int
+
set
+
Attribute set ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
int
+
position
+
Position of the assigned product
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.assignedProducts', '4');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAssignedProducts($sessionId, '4');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.create (SOAP V1)
+
catalogCategoryCreate (SOAP V2)
+
+
+
+
Create a new category and return its ID.
+
+
Aliases:
+
+
category.create
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
parentId
+
Parent category ID
+
+
+
array
+
categoryData
+
Array of catalogCategoryEntityCreate
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
attribute_id
+
ID of the created category
+
+
+
+
+
The categoryData content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
name
+
Name of the created category
+
+
+
int
+
is_active
+
Defines whether the category will be visible in the frontend
+
+
+
int
+
position
+
Position of the created category (optional)
+
+
+
ArrayOfString
+
available_sort_by
+
All available options by which products in the category can be sorted
+
+
+
string
+
custom_design
+
The custom design for the category (optional)
+
+
+
int
+
custom_apply_to_products
+
Apply the custom design to all products assigned to the category (optional)
+
+
+
string
+
custom_design_from
+
Date starting from which the custom design will be applied to the category (optional)
+
+
+
string
+
custom_design_to
+
Date till which the custom design will be applied to the category (optional)
+
+
+
string
+
custom_layout_update
+
Custom layout update (optional)
+
+
+
string
+
default_sort_by
+
The default option by which products in the category are sorted
+
+
+
string
+
description
+
Category description (optional)
+
+
+
string
+
display_mode
+
Content that will be displayed on the category view page (optional)
+
+
+
int
+
is_anchor
+
Defines whether the category will be anchored (optional)
+
+
+
int
+
landing_page
+
Landing page (optional)
+
+
+
string
+
meta_description
+
Category meta description (optional)
+
+
+
string
+
meta_keywords
+
Category meta keywords (optional)
+
+
+
string
+
meta_title
+
Category meta title (optional)
+
+
+
string
+
page_layout
+
Type of page layout that the category should use (optional)
+
+
+
string
+
url_key
+
A relative URL path which can be entered in place of the standard target path (optional)
+
+
+
int
+
include_in_menu
+
Defines whether the category is visible on the top menu bar
+
+
+
string
+
filter_price_range
+
Price range of each price level displayed in the layered navigation block (optional)
+
+
+
int
+
custom_use_parent_settings
+
Defines whether the category will inherit custom design settings of the category to which it is assigned. 1 - Yes, 0 - No (optional)
+
+
+
+
+
Notes: The position parameter is deprecated, the category will be positioned anyway in the end of the list and you can not set the position directly. You should use the catalog_category.move method instead. You cannot also assign a root category to the specified store.
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$result = $client->call($session, 'catalog_category.create', array(2, array(
+ 'name' => 'Category name',
+ 'is_active' => 1,
+ 'position' => 1,
+ //<!-- position parameter is deprecated, category anyway will be positioned in the end of list
+ //and you can not set position directly, use catalog_category.move instead -->
+ 'available_sort_by' => 'position',
+ 'custom_design' => null,
+ 'custom_apply_to_products' => null,
+ 'custom_design_from' => null,
+ 'custom_design_to' => null,
+ 'custom_layout_update' => null,
+ 'default_sort_by' => 'position',
+ 'description' => 'Category description',
+ 'display_mode' => null,
+ 'is_anchor' => 0,
+ 'landing_page' => null,
+ 'meta_description' => 'Category meta description',
+ 'meta_keywords' => 'Category meta keywords',
+ 'meta_title' => 'Category meta title',
+ 'page_layout' => 'two_columns_left',
+ 'url_key' => 'url-key',
+ 'include_in_menu' => 1,
+)));
+
+var_dump ($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$result = $client->catalogCategoryCreate($session, 2, array(
+ 'name' => 'Category name 2',
+ 'is_active' => 1,
+ 'position' => 1,
+ //<!-- position parameter is deprecated, category anyway will be positioned in the end of list
+ //and you can not set position directly, use catalog_category.move instead -->
+ 'available_sort_by' => array('position'),
+ 'custom_design' => null,
+ 'custom_apply_to_products' => null,
+ 'custom_design_from' => null,
+ 'custom_design_to' => null,
+ 'custom_layout_update' => null,
+ 'default_sort_by' => 'position',
+ 'description' => 'Category description',
+ 'display_mode' => null,
+ 'is_anchor' => 0,
+ 'landing_page' => null,
+ 'meta_description' => 'Category meta description',
+ 'meta_keywords' => 'Category meta keywords',
+ 'meta_title' => 'Category meta title',
+ 'page_layout' => 'two_columns_left',
+ 'url_key' => 'url-key',
+ 'include_in_menu' => 1,
+));
+
+var_dump ($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogCategory/catalog_category.currentStore.html b/guides/v19.x/api/soap/catalog/catalogCategory/catalog_category.currentStore.html
new file mode 100644
index 0000000000..67a19673fd
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogCategory/catalog_category.currentStore.html
@@ -0,0 +1,103 @@
+---
+layout: v1x_soap
+title: Current Store
+---
+
+
+
Module: Mage_Catalog
+
+
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
catalog_category.currentStore (SOAP V1)
+
catalogCategoryCurrentStore (SOAP V2)
+
+
+
+
Allows you to set/get the current store view.
+
+
Aliases:
+
+
category.currentStore
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
storeView
+
Store view ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'category.currentStore', '1');
+var_dump ($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryCurrentStore($sessionId, '1');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.delete (SOAP V1)
+
catalogCategoryDelete (SOAP V2)
+
+
+
+
Allows you to delete the required category.
+
+
Aliases:
+
+
category.delete
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the category to be deleted
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the category is deleted
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.delete', '7');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryDelete($sessionId, '7');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogCategory/catalog_category.info.html b/guides/v19.x/api/soap/catalog/catalogCategory/catalog_category.info.html
new file mode 100644
index 0000000000..f07d93b8c4
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogCategory/catalog_category.info.html
@@ -0,0 +1,344 @@
+---
+layout: v1x_soap
+title: Category Info
+---
+
+
+
Module: Mage_Catalog
+
+
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.info (SOAP V1)
+
catalogCategoryInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the required category.
+
+
Aliases:
+
+
category.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
Category ID
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
ArrayOfString
+
attributes
+
Array of attributes (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
info
+
Array of catalogCategoryInfo
+
+
+
+
+
The catalogCategoryInfo content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
category_id
+
Category ID
+
+
+
int
+
is_active
+
Defines whether the category is active
+
+
+
string
+
position
+
Category position
+
+
+
string
+
level
+
Category level
+
+
+
string
+
parent_id
+
Parent category ID
+
+
+
string
+
all_children
+
All child categories of the current category
+
+
+
string
+
children
+
Names of direct child categories
+
+
+
string
+
created_at
+
Date when the category was created
+
+
+
string
+
updated_at
+
Date when the category was updated
+
+
+
string
+
name
+
Category name
+
+
+
string
+
url_key
+
A relative URL path which can be entered in place of the standard target path (optional)
+
+
+
string
+
description
+
Category description
+
+
+
string
+
meta_title
+
Category meta title
+
+
+
string
+
meta_keywords
+
Category meta keywords
+
+
+
string
+
meta_description
+
Category meta description
+
+
+
string
+
path
+
Path
+
+
+
string
+
url_path
+
URL path
+
+
+
int
+
children_count
+
Number of child categories
+
+
+
string
+
display_mode
+
Content that will be displayed on the category view page (optional)
+
+
+
int
+
is_anchor
+
Defines whether the category is anchored
+
+
+
ArrayOfString
+
available_sort_by
+
All available options by which products in the category can be sorted
+
+
+
string
+
custom_design
+
The custom design for the category (optional)
+
+
+
string
+
custom_apply_to_products
+
Apply the custom design to all products assigned to the category (optional)
+
+
+
string
+
custom_design_from
+
Date starting from which the custom design will be applied to the category (optional)
+
+
+
string
+
custom_design_to
+
Date till which the custom design will be applied to the category (optional)
+
+
+
string
+
page_layout
+
Type of page layout that the category should use (optional)
+
+
+
string
+
custom_layout_update
+
Custom layout update (optional)
+
+
+
string
+
default_sort_by
+
The default option by which products in the category are sorted
+
+
+
int
+
landing_page
+
Landing page (optional)
+
+
+
int
+
include_in_menu
+
Defines whether the category is available on the Magento top menu bar
+
+
+
string
+
filter_price_range
+
Price range of each price level displayed in the layered navigation block
+
+
+
int
+
custom_use_parent_settings
+
Defines whether the category will inherit custom design settings of the category to which it is assigned. 1 - Yes, 0 - No
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.info', '5');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryInfo($sessionId, '5');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
catalog_category.level (SOAP V1)
+
catalogCategoryLevel (SOAP V2)
+
+
+
+
Allows you to retrieve one level of categories by a website, a store view, or a parent category.
+
+
Aliases:
+
+
category.level
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
website
+
Website ID or code (optional)
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
parentCategory
+
Parent category ID (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
tree
+
Array of CatalogCategoryEntitiesNoChildren
+
+
+
+
+
The CatalogCategoryEntitityNoChildren content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
category_id
+
Category ID
+
+
+
int
+
parent_id
+
Parent category ID
+
+
+
string
+
name
+
Category name
+
+
+
int
+
is_active
+
Defines whether the category is active
+
+
+
int
+
position
+
Category position
+
+
+
int
+
level
+
Category level
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.level');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryLevel($sessionId);
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.move (SOAP V1)
+
catalogCategoryMove (SOAP V2)
+
+
+
+
Allows you to move the required category in the category tree.
+
+
Aliases:
+
+
category.move
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the category to be moved
+
+
+
int
+
parentId
+
ID of the new parent category
+
+
+
string
+
afterId
+
ID of the category after which the required category will be moved (optional for V1 and V2)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
id
+
True if the category is moved
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.move', array('categoryId' => '4', 'parentId' => '3'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryMove($sessionId, '4', '3');
+var_dump($result);
Note: Please make sure that you are not moving the category to any of its own children. There are no extra checks to prevent doing it through API, and you won’t be able to fix this from the admin interface later.
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.removeProduct (SOAP V1)
+
catalogCategoryRemoveProduct (SOAP V2)
+
+
+
+
Allows you to remove the product assignment from the category.
+
+
Aliases:
+
+
category.removeProduct
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
Category ID
+
+
+
string
+
productId
+
ID or SKU of the product to be removed from the category
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the product is removed from the category
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.removeProduct', array('categoryId' => '4', 'product' => '3'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryRemoveProduct($sessionId, '4', '3');
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.tree (SOAP V1)
+
catalogCategoryTree (SOAP V2)
+
+
+
+
Allows you to retrieve the hierarchical tree of categories.
+
+
Aliases:
+
+
category.tree
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
parentId
+
ID of the parent category (optional)
+
+
+
string
+
storeView
+
Store view (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
tree
+
Array of catalogCategoryTree
+
+
+
+
+
+
The catalogCategoryTree content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
category_id
+
Category ID
+
+
+
int
+
parent_id
+
Parent category ID
+
+
+
string
+
name
+
Category name
+
+
+
int
+
position
+
Category position
+
+
+
int
+
level
+
Category level
+
+
+
array
+
children
+
Array of CatalogCategoryEntities
+
+
+
+
+
The catalogCategoryEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
category_id
+
Category ID
+
+
+
int
+
parent_id
+
Parent category ID
+
+
+
string
+
name
+
Category name
+
+
+
int
+
is_active
+
defines whether the category is active
+
+
+
int
+
position
+
Category position
+
+
+
int
+
level
+
Category level
+
+
+
array
+
children
+
Array of CatalogCategoryEntities
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.tree');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryTree($sessionId);
+var_dump($result);
The Mage_Catalog module allows you to manage categories and products.
+
+
Resource Name: catalog_category
+
+
Aliases:
+
+
category
+
+
+
+
Method:
+
+
+
catalog_category.updateProduct (SOAP V1)
+
catalogCategoryUpdateProduct (SOAP V2)
+
+
+
+
Allows you to update the product assigned to a category. The product position is updated.
+
+
Aliases:
+
+
category.updateProduct
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
categoryId
+
ID of the category to which the product is assigned
+
+
+
string
+
productId
+
ID or SKU of the product to be updated
+
+
+
string
+
position
+
Position of the product in the category (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the product is updated in the category
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category.updateProduct', array('categoryId' => '4', 'product' => '1', 'position' => '3'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryUpdateProduct($sessionId, '4', '1', '3');
+var_dump($result);
+
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.currentStore.html b/guides/v19.x/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.currentStore.html
new file mode 100644
index 0000000000..fd00d97c7f
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogCategoryAttributes/catalog_category_attribute.currentStore.html
@@ -0,0 +1,102 @@
+---
+layout: v1x_soap
+title: Current Store
+---
+
+
+
Module: Mage_Catalog
+
+
Resource: catalog_category_attribute
+
+
Aliases:
+
+
category_attribute
+
+
+
+
Method:
+
+
catalog_category_attribute.currentStore (SOAP V1)
+
catalogCategoryAttributeCurrentStore (SOAP V2)
+
+
+
+
+
Allows you to set/get the current store view.
+
+
Aliases:
+
+
category_attribute.currentStore
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
storeView
+
Store view ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category_attribute.currentStore', 'english');
+var_dump ($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAttributeCurrentStore($sessionId, 'english');
+var_dump($result);
Allows you to retrieve the list of category attributes.
+
+
Aliases:
+
+
category_attribute.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogAttributeEntity
+
+
+
+
+
The catalogAttributeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
attribute_id
+
Attribute ID
+
+
+
string
+
code
+
Attribute code
+
+
+
string
+
type
+
Attribute type
+
+
+
string
+
required
+
Defines whether the attribute is required
+
+
+
string
+
scope
+
Attribute scope: global, website, or store
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category_attribute.list',);
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAttributeList($sessionId);
+var_dump($result);
The catalogAttributeOptionEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
label
+
Option label
+
+
+
string
+
value
+
Option value
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_category_attribute.options', '65');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogCategoryAttributeOptions($sessionId, '65');
+var_dump($result);
Example 2. Creating, viewing, updating, and deleting a product
+
+
+
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+
+$attributeSets = $proxy->call($sessionId, 'product_attribute_set.list');
+$set = current($attributeSets);
+
+
+$newProductData = array(
+ 'name' => 'name of product',
+ // websites - Array of website ids to which you want to assign a new product
+ 'websites' => array(1), // array(1,2,3,...)
+ 'short_description' => 'short description',
+ 'description' => 'description',
+ 'status' => 1,
+ 'weight' => 0,
+ 'tax_class_id' => 1,
+ 'categories' => array(3), //3 is the category id
+ 'price' => 12.05
+);
+
+// Create new product
+$proxy->call($sessionId, 'product.create', array('simple', $set['set_id'], 'sku_of_product', $newProductData));
+$proxy->call($sessionId, 'product_stock.update', array('sku_of_product', array('qty'=>50, 'is_in_stock'=>1)));
+
+// Get info of created product
+var_dump($proxy->call($sessionId, 'product.info', 'sku_of_product'));
+
+// Update product name on german store view
+$proxy->call($sessionId, 'product.update', array('sku_of_product', array('name'=>'new name of product'), 'german'));
+
+// Get info for default values
+var_dump($proxy->call($sessionId, 'product.info', 'sku_of_product'));
+// Get info for german store view
+
+var_dump($proxy->call($sessionId, 'product.info', array('sku_of_product', 'german')));
+
+// Delete product
+$proxy->call($sessionId, 'product.delete', 'sku_of_product');
+
+try {
+ // Ensure that product deleted
+ var_dump($proxy->call($sessionId, 'product.info', 'sku_of_product'));
+} catch (SoapFault $e) {
+ echo "Product already deleted";
+}
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.create.html b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.create.html
new file mode 100644
index 0000000000..31ca39b92b
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.create.html
@@ -0,0 +1,516 @@
+---
+layout: v1x_soap
+title: Product Create
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.create (SOAP V1)
+
catalogProductCreate (SOAP V2)
+
+
+
+
Allows you to create a new product and return ID of the created product.
+
+
Aliases:
+
+
product.create
+
+
+
Note:
+
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Product type
+
+
+
string
+
set
+
ID of the product attribute set
+
+
+
string
+
sku
+
Product SKU
+
+
+
array
+
productData
+
Array of catalogProductCreateEntity
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
result
+
ID of the created product
+
+
+
+
+
The catalogProductCreateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
ArrayOfString
+
categories
+
Array of categories
+
+
+
ArrayOfString
+
websites
+
Array of websites
+
+
+
string
+
name
+
Product name
+
+
+
string
+
description
+
Product description
+
+
+
string
+
short_description
+
Product short description
+
+
+
string
+
weight
+
Product weight
+
+
+
string
+
status
+
Product status
+
+
+
string
+
url_key
+
URL key
+
+
+
string
+
url_path
+
URL path
+
+
+
string
+
visibility
+
Product visibility on the frontend
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
string
+
has_options
+
Defines whether the product has options
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available for the product
+
+
+
string
+
price
+
Product price
+
+
+
string
+
special_price
+
Product special price
+
+
+
string
+
special_from_date
+
Date starting from which the special price will be applied to the product
+
+
+
string
+
special_to_date
+
Date till which the special price will be applied to the product
+
+
+
string
+
tax_class_id
+
Tax class ID
+
+
+
array
+
tier_price
+
Array of catalogProductTierPriceEntity
+
+
+
string
+
meta_title
+
Meta title
+
+
+
string
+
meta_keyword
+
Meta keyword
+
+
+
string
+
meta_description
+
Meta description
+
+
+
string
+
custom_design
+
Custom design
+
+
+
string
+
custom_layout_update
+
Custom layout update
+
+
+
string
+
options_container
+
Options container
+
+
+
array
+
additional_attributes
+
Array of catalogProductAdditionalAttributesEntity
+
+
+
array
+
stock_data
+
Array of catalogInventoryStockItemUpdateEntity
+
+
+
+
+
Notes: The "websites" and "website_ids" or "categories" and "category_ids" parameters are interchangeable. In other words, you can specify an array of website IDs (int) and then you don't need to specify the array of website codes (string) and vice versa.
+
+
The catalogProductTierPriceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
website
+
Website
+
+
+
int
+
qty
+
Quantity
+
+
+
double
+
price
+
Tier price
+
+
+
+
+
The catalogInventoryStockItemUpdateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
qty
+
Quantity of items
+
+
+
int
+
is_in_stock
+
Defines whether the item is in stock
+
+
+
int
+
manage_stock
+
Manage stock
+
+
+
int
+
use_config_manage_stock
+
Use config manage stock
+
+
+
int
+
min_qty
+
Minimum quantity for items to be in stock
+
+
+
int
+
use_config_min_qty
+
Use config settings flag (value defined in the Inventory System Configuration)
+
+
+
int
+
min_sale_qty
+
Minimum quantity allowed in the shopping cart
+
+
+
int
+
use_config_min_sale_qty
+
Use config settings flag
+
+
+
int
+
max_sale_qty
+
Maximum quantity allowed in the shopping cart
+
+
+
int
+
use_config_max_sale_qty
+
Use config settings flag
+
+
+
int
+
is_qty_decimal
+
Defines whether the quantity is decimal
+
+
+
int
+
backorders
+
Backorders status
+
+
+
int
+
use_config_backorders
+
Use config settings flag (for backorders)
+
+
+
int
+
notify_stock_qty
+
Stock quantity below which a notification will appear
+
+
+
int
+
use_config_notify_stock_qty
+
Use config settings flag (for stock quantity)
+
+
+
+
+
The catalogProductAdditionalAttributesEntity content is as follows:
+
+
+
+
+
Type
+
Name
+
+
+
associativeMultiArray
+
multi_data
+
+
+
associativeArray
+
single_data
+
+
+
+
+
Single Data: array of attributes with only single value
+Multi Data: array of attributes which could contain several values
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
100
+
Requested store view not found.
+
+
+
102
+
Invalid data given. Details in error message.
+
+
+
104
+
Product type is not in allowed types.
+
+
+
105
+
Product attribute set is not existed
+
+
+
106
+
Product attribute set is not belong catalog product entity type
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+// get attribute set
+$attributeSets = $client->call($session, 'product_attribute_set.list');
+$attributeSet = current($attributeSets);
+
+
+$result = $client->call($session, 'catalog_product.create', array('simple', $attributeSet['set_id'], 'product_sku', array(
+ 'categories' => array(2),
+ 'websites' => array(1),
+ 'name' => 'Product name',
+ 'description' => 'Product description',
+ 'short_description' => 'Product short description',
+ 'weight' => '10',
+ 'status' => '1',
+ 'url_key' => 'product-url-key',
+ 'url_path' => 'product-url-path',
+ 'visibility' => '4',
+ 'price' => '100',
+ 'tax_class_id' => 1,
+ 'meta_title' => 'Product meta title',
+ 'meta_keyword' => 'Product meta keyword',
+ 'meta_description' => 'Product meta description'
+)));
+
+var_dump ($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+// get attribute set
+$attributeSets = $client->catalogProductAttributeSetList($session);
+$attributeSet = current($attributeSets);
+
+$result = $client->catalogProductCreate($session, 'simple', $attributeSet->set_id, 'product_sku', array(
+ 'categories' => array(2),
+ 'websites' => array(1),
+ 'name' => 'Product name',
+ 'description' => 'Product description',
+ 'short_description' => 'Product short description',
+ 'weight' => '10',
+ 'status' => '1',
+ 'url_key' => 'product-url-key',
+ 'url_path' => 'product-url-path',
+ 'visibility' => '4',
+ 'price' => '100',
+ 'tax_class_id' => 1,
+ 'meta_title' => 'Product meta title',
+ 'meta_keyword' => 'Product meta keyword',
+ 'meta_description' => 'Product meta description'
+));
+
+var_dump ($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.currentStore.html b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.currentStore.html
new file mode 100644
index 0000000000..6a34fb28a7
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.currentStore.html
@@ -0,0 +1,103 @@
+---
+layout: v1x_soap
+title: Current Product Store
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
catalog_product.currentStore (SOAP V1)
+
catalogProductCurrentStore (SOAP V2)
+
+
+
+
Allows you to set/get the current store view.
+
+
Aliases:
+
+
product.currentStore
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int/string
+
storeView
+
Store view ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.currentStore', 'english');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCurrentStore($sessionId, 'english');
+var_dump($result);
+
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.delete.html b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.delete.html
new file mode 100644
index 0000000000..bd719244cb
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.delete.html
@@ -0,0 +1,124 @@
+---
+layout: v1x_soap
+title: Product Delete
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.delete (SOAP V1)
+
catalogProductDelete (SOAP V2)
+
+
+
+
Allows you to delete the required product.
+
+
Aliases:
+
+
product.delete
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean/int
+
result
+
True (1) if the product is deleted
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.delete', '6');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductDelete($sessionId, '6');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.getSpecialPrice.html b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.getSpecialPrice.html
new file mode 100644
index 0000000000..4fd41d40ef
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.getSpecialPrice.html
@@ -0,0 +1,165 @@
+---
+layout: v1x_soap
+title: Get Special Price
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.getSpecialPrice (SOAP V1)
+
catalogProductGetSpecialPrice (SOAP V2)
+
+
+
+
Allows you to get the product special price data.
+
+
Aliases:
+
+
product.getSpecialPrice
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductReturnEntity
+
+
+
+
+
The catalogProductReturnEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
special_price
+
Product special price
+
+
+
string
+
special_from_date
+
Date starting from which the special price is applied to the product
+
+
+
string
+
special_to_date
+
Date till which the special price is applied to the product
+
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.getSpecialPrice', '1');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductGetSpecialPrice($sessionId, '1');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.info.html b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.info.html
new file mode 100644
index 0000000000..5720ebe11c
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.info.html
@@ -0,0 +1,444 @@
+---
+layout: v1x_soap
+title: Product Info
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.info (SOAP V1)
+
catalogProductInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the required product.
+
+
Aliases:
+
+
product.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
productId
+
Product ID or SKU
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
array
+
attributes
+
Array of catalogProductRequestAttributes (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU value is passed in the "productId" parameter. (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
info
+
Array of catalogProductReturnEntity
+
+
+
+
+
The catalogProductRequestAttributes content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
ArrayOfString
+
attributes
+
Array of attributes
+
+
+
ArrayOfString
+
additional_attributes
+
Array of additional attributes
+
+
+
+
+
The catalogProductReturnEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
set
+
Product set
+
+
+
string
+
type
+
Product type
+
+
+
ArrayOfString
+
categories
+
Array of categories
+
+
+
ArrayOfString
+
websites
+
Array of websites
+
+
+
string
+
created_at
+
Date when the product was created
+
+
+
string
+
updated_at
+
Date when the product was last updated
+
+
+
string
+
type_id
+
Type ID
+
+
+
string
+
name
+
Product name
+
+
+
string
+
description
+
Product description
+
+
+
string
+
short_description
+
Short description for a product
+
+
+
string
+
weight
+
Product weight
+
+
+
string
+
status
+
Status of a product
+
+
+
string
+
url_key
+
Relative URL path that can be entered in place of a target path
+
+
+
string
+
url_path
+
URL path
+
+
+
string
+
visibility
+
Product visibility on the frontend
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
string
+
has_options
+
Defines whether the product has options
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available for the product
+
+
+
string
+
price
+
Product price
+
+
+
string
+
special_price
+
Product special price
+
+
+
string
+
special_from_date
+
Date starting from which the special price is applied to the product
+
+
+
string
+
special_to_date
+
Date till which the special price is applied to the product
+
+
+
string
+
tax_class_id
+
Tax class ID
+
+
+
array
+
tier_price
+
Array of catalogProductTierPriceEntity
+
+
+
string
+
meta_title
+
Mate title
+
+
+
string
+
meta_keyword
+
Meta keyword
+
+
+
string
+
meta_description
+
Meta description
+
+
+
string
+
custom_design
+
Custom design
+
+
+
string
+
custom_layout_update
+
Custom layout update
+
+
+
string
+
options_container
+
Options container
+
+
+
associativeArray
+
additional_attributes
+
Array of additional attributes
+
+
+
string
+
enable_googlecheckout
+
Defines whether Google Checkout is applied to the product
+
+
+
+
+
The catalogProductTierPriceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
customer_group_id
+
ID of the customer group
+
+
+
string
+
website
+
Website
+
+
+
int
+
qty
+
Quantity to which the price will be applied
+
+
+
double
+
price
+
Price that each item will cost
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.info', '4');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductInfo($sessionId, '4');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.list.html b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.list.html
new file mode 100644
index 0000000000..b326407061
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.list.html
@@ -0,0 +1,224 @@
+---
+layout: v1x_soap
+title: Product List
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.list (SOAP V1)
+
catalogProductList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of products.
+
+
Aliases:
+
+
product.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters by attributes (optional)
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
storeView
+
Array of catalogProductEntity
+
+
+
+
+
The catalogProductEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
name
+
Product name
+
+
+
string
+
set
+
Product attribute set
+
+
+
string
+
type
+
Type of the product
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2 (List of All Products)
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductList($sessionId);
+var_dump($result);
+
+
+
+
+
Request Example SOAP V2 (Complex Filter)
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$complexFilter = array(
+ 'complex_filter' => array(
+ array(
+ 'key' => 'type',
+ 'value' => array('key' => 'in', 'value' => 'simple,configurable')
+ )
+ )
+);
+$result = $client->catalogProductList($session, $complexFilter);
+
+var_dump ($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.setSpecialPrice.html b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.setSpecialPrice.html
new file mode 100644
index 0000000000..76171eba25
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProduct/catalog_product.setSpecialPrice.html
@@ -0,0 +1,145 @@
+---
+layout: v1x_soap
+title: Set Special Price
+---
+
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product
+
+
Aliases:
+
+
product
+
+
+
+
Method:
+
+
+
catalog_product.setSpecialPrice (SOAP V1)
+
catalogProductSetSpecialPrice (SOAP V2)
+
+
+
+
Allows you to set the product special price.
+
+
Aliases:
+
+
product.setSpecialPrice
+
+
+
Note:
+
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
productId
+
Product ID or SKU
+
+
+
string
+
specialPrice
+
Product special price
+
+
+
string
+
fromDate
+
Date starting from which special price will be applied
+
+
+
string
+
toDate
+
Date till which special price will be applied
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
productIdentifierType
+
Defines whether the product ID or SKU is passed in the 'productId' parameter (optional)
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean/int
+
result
+
True (1) if the special price is set for the product
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product.setSpecialPrice', array('product' => 'testproduct', 'specialPrice' => '77.5', 'fromDate' => '2012-03-29 12:30:51', 'toDate' => '2012-04-29 12:30:51'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductSetSpecialPrice($sessionId, '2', '77.5', '2012-03-29 12:30:51', '2012-04-29 12:30:51');
+var_dump($result);
Allows you to update the required product. Note that you should specify only those parameters which you want to be updated.
+
+
Aliases:
+
+
product.update
+
+
+
Note:
+
Although the API accepts up to four digits of precision for all price arguments, Magento strongly recommends you pass in two digits to reduce inaccuracy in the tax calculation process. (That is, use a price like 12.35 and not 12.3487).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID
+
+
+
array
+
productData
+
Array of catalogProductCreateEntity
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the product is updated
+
+
+
+
+
The catalogProductCreateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
ArrayOfString
+
categories
+
Array of categories
+
+
+
ArrayOfString
+
websites
+
Array of websites
+
+
+
string
+
name
+
Product name
+
+
+
string
+
description
+
Product description
+
+
+
string
+
short_description
+
Product short description
+
+
+
string
+
weight
+
Product weight
+
+
+
string
+
status
+
Product status
+
+
+
string
+
url_key
+
A relative URL path that can be entered in place of the target path
+
+
+
string
+
url_path
+
URL path
+
+
+
string
+
visibility
+
Product visibility on the frontend
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
string
+
has_options
+
Defines whether the product has options
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available for the product
+
+
+
string
+
price
+
Product price
+
+
+
string
+
special_price
+
Product special price
+
+
+
string
+
special_from_date
+
Date starting from which the special price will be applied to the product
+
+
+
string
+
special_to_date
+
Date till which the special price will be applied to the product
+
+
+
string
+
tax_class_id
+
Tax class ID
+
+
+
array
+
tier_price
+
Array of catalogProductTierPriceEntity
+
+
+
string
+
meta_title
+
Meta title
+
+
+
string
+
meta_keyword
+
Meta keyword
+
+
+
string
+
meta_description
+
Meta description
+
+
+
string
+
custom_design
+
Custom design
+
+
+
string
+
custom_layout_update
+
Custom layout update
+
+
+
string
+
options_container
+
Options container
+
+
+
associativeArray
+
additional_attributes
+
Array of catalogProductAdditionalAttributesEntity
+
+
+
array
+
stock_data
+
Array of catalogInventoryStockItemUpdateEntity
+
+
+
+
+
Notes: The "websites" and "website_ids" or "categories" and "category_ids" parameters are interchangeable. In other words, you can specify an array of website IDs (int) and then you don't need to specify the array of website codes (string) and vice versa.
+
+
The catalogProductTierPriceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
website
+
Website
+
+
+
int
+
qty
+
Quantity of items to which the price will be applied
+
+
+
double
+
price
+
Price that each item will cost
+
+
+
+
+
The catalogInventoryStockItemUpdateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
qty
+
Quantity of items
+
+
+
int
+
is_in_stock
+
Defines whether the item is in stock
+
+
+
int
+
manage_stock
+
Manage stock
+
+
+
int
+
use_config_manage_stock
+
Use config manage stock
+
+
+
int
+
min_qty
+
Minimum quantity for items to be in stock
+
+
+
int
+
use_config_min_qty
+
Use config settings flag (value defined in the Inventory System Configuration)
+
+
+
int
+
min_sale_qty
+
Minimum quantity allowed in the shopping cart
+
+
+
int
+
use_config_min_sale_qty
+
Use config settings flag
+
+
+
int
+
max_sale_qty
+
Maximum quantity allowed in the shopping cart
+
+
+
int
+
use_config_max_sale_qty
+
Use config settings flag
+
+
+
int
+
is_qty_decimal
+
Defines whether the quantity is decimal
+
+
+
int
+
backorders
+
Backorders status
+
+
+
int
+
use_config_backorders
+
Use config settings flag (for backorders)
+
+
+
int
+
notify_stock_qty
+
Stock quantity below which a notification will appear
+
+
+
int
+
use_config_notify_stock_qty
+
Use config settings flag (for stock quantity)
+
+
+
+
+
The catalogProductAdditionalAttributesEntity content is as follows:
+
+
+
+
+
Type
+
Name
+
+
+
associativeMultiArray
+
multi_data
+
+
+
associativeArray
+
single_data
+
+
+
+
+
Single Data: array of attributes with only single value
+Multi Data: array of attributes which could contain several values
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
100
+
Requested store view not found.
+
+
+
101
+
Product not exists.
+
+
+
102
+
Invalid data given. Details in error message.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$result = $client->call($session, 'catalog_product.update', array('product_sku', array(
+ 'categories' => array(2),
+ 'websites' => array(1),
+ 'name' => 'Product name new 2',
+ 'description' => 'Product description',
+ 'short_description' => 'Product short description',
+ 'weight' => '10',
+ 'status' => '1',
+ 'url_key' => 'product-url-key',
+ 'url_path' => 'product-url-path',
+ 'visibility' => '4',
+ 'price' => '100',
+ 'tax_class_id' => 1,
+ 'meta_title' => 'Product meta title',
+ 'meta_keyword' => 'Product meta keyword',
+ 'meta_description' => 'Product meta description'
+)));
+
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$result = $client->catalogProductUpdate($session, 'product_sku', array(
+ 'categories' => array(2),
+ 'websites' => array(1),
+ 'name' => 'Product name new',
+ 'description' => 'Product description',
+ 'short_description' => 'Product short description',
+ 'weight' => '10',
+ 'status' => '1',
+ 'url_key' => 'product-url-key',
+ 'url_path' => 'product-url-path',
+ 'visibility' => '4',
+ 'price' => '100',
+ 'tax_class_id' => 1,
+ 'meta_title' => 'Product meta title',
+ 'meta_keyword' => 'Product meta keyword',
+ 'meta_description' => 'Product meta description'
+));
+
+var_dump ($result);
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.create.html b/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.create.html
new file mode 100644
index 0000000000..9a3da61481
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.create.html
@@ -0,0 +1,424 @@
+---
+layout: v1x_soap
+title: Create Attribute
+---
+
+
Module: Product Attributes API
+
+
Resource: product_attribute
+
+
+
Method:
+
+
+
product_attribute.create (SOAP V1)
+
catalogProductAttributeCreate (SOAP V2)
+
+
+
+
Allows you to create a new product attribute.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
data
+
Array of catalogProductAttributeEntityToCreate
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
result
+
ID of the created attribute
+
+
+
+
+
The catalogProductAttributeEntityToCreate content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
attribute_code
+
Attribute code
+
+
+
string
+
frontend_input
+
Attribute type
+
+
+
string
+
scope
+
Attribute scope. Possible values are as follows: 'store', 'website', or 'global'
+
+
+
string
+
default_value
+
Attribute default value
+
+
+
int
+
is_unique
+
Defines whether the attribute is unique
+
+
+
int
+
is_required
+
Defines whether the attribute is required
+
+
+
ArrayOfString
+
apply_to
+
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
+
+
+
int
+
is_configurable
+
Defines whether the attribute can be used for configurable products
+
+
+
int
+
is_searchable
+
Defines whether the attribute can be used in Quick Search
+
+
+
int
+
is_visible_in_advanced_search
+
Defines whether the attribute can be used in Advanced Search
+
+
+
int
+
is_comparable
+
Defines whether the attribute can be compared on the frontend
+
+
+
int
+
is_used_for_promo_rules
+
Defines whether the attribute can be used for promo rules
+
+
+
int
+
is_visible_on_front
+
Defines whether the attribute is visible on the frontend
+
+
+
int
+
used_in_product_listing
+
Defines whether the attribute can be used in product listing
+
+
+
associativeArray
+
additional_fields
+
Array of additional fields
+
+
+
array
+
frontend_label
+
Array of catalogProductAttributeFrontendLabel
+
+
+
+
+
The catalogProductAttributeFrontendLabelEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
label
+
Text label
+
+
+
+
Notes: The "label" value for the "store_id" value set to 0 must be specified. An attribute cannot be created without specifying the label for store_id=0.
+
+
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
frontend_class
+
Input Validation for Store Owner. Possible values are as follows: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_wysiwyg_enabled
+
Enable WYSIWYG flag
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it is used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
int
+
position
+
Position
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it is used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
int
+
position
+
Position
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
102
+
Invalid request parameters.
+
+
+
103
+
Attribute code is invalid. Please use only letters (a-z), numbers (0-9) or underscore (_) in this field, first character should be a letter.
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html b/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html
new file mode 100644
index 0000000000..4ca818475e
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.currentStore.html
@@ -0,0 +1,99 @@
+---
+layout: v1x_soap
+title: Current Store
+---
+
+
Module: Mage_Catalog
+
+
Resource: catalog_product_attribute
+
+
Aliases:
+
+
product_attribute
+
+
+
+
Method:
+
+
catalog_product_attribute.currentStore (SOAP V1)
+
catalogProductAttributeCurrentStore (SOAP V2)
+
+
+
+
Allows you to set/get the current store view.
+
+
Aliases:
+
+
product_attribute.currentStore
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
storeView
+
Store view ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute.currentStore', 'english');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeCurrentStore($sessionId, 'english');
+var_dump($result);
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.info.html b/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.info.html
new file mode 100644
index 0000000000..cb3221c629
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.info.html
@@ -0,0 +1,410 @@
+---
+layout: v1x_soap
+title: Attribute Info
+---
+
+
+
Module: Product Attributes API
+
+
Resource: product_attribute
+
+
+
Method:
+
+
product_attribute.info (SOAP V1)
+
catalogProductAttributeInfo (SOAP V2)
+
+
+
+
Allows you to get full information about a required attribute with the list of options.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
attribute
+
Attribute code or ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductAttributeEntity
+
+
+
+
+
The catalogProductAttributeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
attribute_id
+
Attribute ID
+
+
+
string
+
attribute_code
+
Attribute code
+
+
+
string
+
frontend_input
+
Attribute type
+
+
+
string
+
scope
+
Attribute scope
+
+
+
string
+
default_value
+
Attribute default value
+
+
+
int
+
is_unique
+
Defines whether the attribute is unique
+
+
+
int
+
is_required
+
Defines whether the attribute is required
+
+
+
ArrayOfString
+
apply_to
+
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
+
+
+
int
+
is_configurable
+
Defines whether the attribute can be used for configurable products
+
+
+
int
+
is_searchable
+
Defines whether the attribute can be used in Quick Search
+
+
+
int
+
is_visible_in_advanced_search
+
Defines whether the attribute can be used in Advanced Search
+
+
+
int
+
is_comparable
+
Defines whether the attribute can be compared on the frontend
+
+
+
int
+
is_used_for_promo_rules
+
Defines whether the attribute can be used for promo rules
+
+
+
int
+
is_visible_on_front
+
Defines whether the attribute is visible on the frontend
+
+
+
int
+
used_in_product_listing
+
Defines whether the attribute can be used in product listing
+
+
+
associativeArray
+
additional_fields
+
Array of additional fields
+
+
+
array
+
options
+
Array of catalogAttributeOptionEntity
+
+
+
array
+
frontend_label
+
Array of catalogProductAttributeFrontendLabel
+
+
+
+
+
The catalogAttributeOptionEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
label
+
Text label
+
+
+
string
+
value
+
Option ID
+
+
+
+
+
The catalogProductAttributeFrontendLabelEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
label
+
Text label
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
frontend_class
+
Input Validation for Store Owner. Possible values: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_wysiwyg_enabled
+
Enable WYSIWYG flag
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
int
+
position
+
Position
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
int
+
position
+
Position
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Requested attribute not found.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_attribute.info', '11');
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeInfo($sessionId, '11');
+var_dump($result);
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.update.html b/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.update.html
new file mode 100644
index 0000000000..b8c9ab5b90
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttribute/product_attribute.update.html
@@ -0,0 +1,402 @@
+---
+layout: v1x_soap
+title: Attribute Update
+---
+
+
Module: Product Attributes API
+
+
Resource: product_attribute
+
+
+
Method:
+
+
+
product_attribute.update (SOAP V1)
+
catalogProductAttributeUpdate (SOAP V2)
+
+
+
+
Allows you to update the required attribute.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
attribute
+
Attribute code or ID
+
+
+
array
+
data
+
Array of catalogProductAttributeEntityToUpdate
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the attribute is updated
+
+
+
+
+
The catalogProductAttributeEntityToUpdate content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
scope
+
Attribute scope. Possible values are as follows: 'store', 'website', or 'global'
+
+
+
string
+
default_value
+
Attribute default value
+
+
+
int
+
is_unique
+
Defines whether the attribute is unique
+
+
+
int
+
is_required
+
Defines whether the attribute is required
+
+
+
ArrayOfString
+
apply_to
+
Apply to. Empty for "Apply to all" or array of the following possible values: 'simple', 'grouped', 'configurable', 'virtual', 'bundle', 'downloadable', 'giftcard'
+
+
+
int
+
is_configurable
+
Defines whether the attribute can be used for configurable products
+
+
+
int
+
is_searchable
+
Defines whether the attribute can be used in Quick Search
+
+
+
int
+
is_visible_in_advanced_search
+
Defines whether the attribute can be used in Advanced Search
+
+
+
int
+
is_comparable
+
Defines whether the attribute can be compared on the frontend
+
+
+
int
+
is_used_for_promo_rules
+
Defines whether the attribute can be used for promo rules
+
+
+
int
+
is_visible_on_front
+
Defines whether the attribute can be visible on the frontend
+
+
+
int
+
used_in_product_listing
+
Defines whether the attribute can be used in product listing
+
+
+
associativeArray
+
additional_fields
+
Array of additional fields
+
+
+
array
+
frontend_label
+
Array of catalogProductAttributeFrontendLabel
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
frontend_class
+
Input Validation for Store Owner. Possible values: 'validate-number' (Decimal Number), 'validate-digits' (Integer Number), 'validate-email', 'validate-url', 'validate-alpha' (Letters), 'validate-alphanum' (Letters (a-z, A-Z), or Numbers (0-9))
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the text area type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_wysiwyg_enabled
+
Enable WYSIWYG flag
+
+
+
boolean
+
is_html_allowed_on_front
+
Defines whether the HTML tags are allowed on the frontend
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the date and boolean types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the multiselect type is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
integer
+
position
+
Position
+
+
+
+
+
The AdditionaFieldsEntity array of additional fields for the select and price types is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
is_filterable
+
Defines whether it used in layered navigation
+
+
+
boolean
+
is_filterable_in_search
+
Defines whether it is used in search results layered navigation
+
+
+
integer
+
position
+
Position
+
+
+
boolean
+
used_for_sort_by
+
Defines whether it is used for sorting in product listing
+
+
+
+
+
The catalogProductAttributeFrontendLabel content is as follows:
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.currentStore', 'english');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaCurrentStore($sessionId, 'english');
+var_dump($result);
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html
new file mode 100644
index 0000000000..5fff30aad8
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.info.html
@@ -0,0 +1,197 @@
+---
+layout: v1x_soap
+title: Media Info
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.info (SOAP V1)
+
catalogProductAttributeMediaInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the specified product image.
+
+
Aliases:
+
+
product_attribute_media.info
+
product_media.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
file
+
Name of the image file (e.g., /b/l/blackberry8100_2.jpg)
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductImageEntity
+
+
+
+
+
+
The catalogProductImageEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
file
+
Image file name
+
+
+
string
+
label
+
Image file label
+
+
+
string
+
position
+
Image file position
+
+
+
string
+
exclude
+
Defines whether the image will associate only to one of three image types
+
+
+
string
+
url
+
Image URL
+
+
+
ArrayOfString
+
types
+
Array of types
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.info', array('product' => '2', 'file' => '/b/l/blackberry8100_2.jpg'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaInfo($sessionId, '2', '/b/l/blackberry8100_2.jpg');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html
new file mode 100644
index 0000000000..423a3155b5
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.list.html
@@ -0,0 +1,194 @@
+---
+layout: v1x_soap
+title: Media List
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.list (SOAP V1)
+
catalogProductAttributeMediaList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product images.
+
+
Aliases:
+
+
product_attribute_media.list
+
product_media.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
storeView
+
Store view ID or code (optional)
+
+
+
string
+
identifierType
+
Defines whether the product ID or sku is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductImageEntity
+
+
+
+
+
The catalogProductImageEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
file
+
Image file name
+
+
+
string
+
label
+
Image label
+
+
+
string
+
position
+
Image position
+
+
+
string
+
exclude
+
Defines whether the image will associate only to one of three image types
+
+
+
string
+
url
+
Image URL
+
+
+
ArrayOfString
+
types
+
Array of types
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.list', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaList($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.remove.html b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.remove.html
new file mode 100644
index 0000000000..9a45f82d99
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.remove.html
@@ -0,0 +1,130 @@
+---
+layout: v1x_soap
+title: Media Remove
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.remove (SOAP V1)
+
catalogProductAttributeMediaRemove (SOAP V2)
+
+
+
+
Allows you to remove the image from a product.
+
+
Aliases:
+
+
product_attribute_media.remove
+
product_media.remove
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
file
+
Image file name (e.g., /b/l/blackberry8100_2.jpg)
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the image is removed from a product
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.remove', array('product' => '3', 'file' => '/b/l/blackberry8100_2.jpg'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaRemove($sessionId, '3', '/b/l/blackberry8100_2.jpg');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.types.html b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.types.html
new file mode 100644
index 0000000000..8add016765
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.types.html
@@ -0,0 +1,160 @@
+---
+layout: v1x_soap
+title: Media Types
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.types (SOAP V1)
+
catalogProductAttributeMediaTypes (SOAP V2)
+
+
+
+
Allows you to retrieve product image types including standard image, small_image, thumbnail, etc. Note that if the product attribute set contains attributes of the Media Image type (Catalog Input Type for Store Owner > Media Image), it will also be returned in the response.
+
+
Aliases:
+
+
product_attribute_media.types
+
product_media.types
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
setId
+
ID of the product attribute set
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductAttributeMediaTypeEntity
+
+
+
+
+
The catalogProductAttributeMediaTypeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
code
+
Image type code
+
+
+
string
+
scope
+
Image scope (store, website, or global)
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_media.types', '4');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeMediaTypes($sessionId, '4');
+var_dump($result);
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.update.html b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.update.html
new file mode 100644
index 0000000000..014aaf9aaa
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttributeMedia/catalog_product_attribute_media.update.html
@@ -0,0 +1,234 @@
+---
+layout: v1x_soap
+title: Media Update
+---
+
+
Module: Mage_Catalog
+
+
+
Resource:catalog_product_attribute_media
+
+
Aliases:
+
+
product_attribute_media
+
product_media
+
+
+
+
Method:
+
+
+
catalog_product_attribute_media.update (SOAP V1)
+
catalogProductAttributeMediaUpdate (SOAP V2)
+
+
+
+
Allows you to update the product image.
+
+
Aliases:
+
+
product_attribute_media.update
+
product_media.update
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or code
+
+
+
string
+
file
+
Image file name (e.g., /i/m/image.jpeg)
+
+
+
array
+
data
+
Array of catalogProductAttributeMediaCreateEntity
+
+
+
string
+
storeView
+
Store view ID or code
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Notes: You should specify only those parameters which you want to be updated. Parameters that were not specified in the request, will preserve the previous values.
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
boolean
+
result
+
Result of product image updating
+
+
+
+
+
The catalogProductAttributeMediaCreateEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
file
+
Array of catalogProductImageFileEntity
+
+
+
string
+
label
+
Product image label
+
+
+
string
+
position
+
Product image position
+
+
+
ArrayOfString
+
types
+
Array of types
+
+
+
string
+
exclude
+
Defines whether the image will associate only to one of three image types
+
+
+
string
+
remove
+
Image remove flag
+
+
+
+
+
The catalogProductImageFileEntity content is as follows:
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.groupAdd.html b/guides/v19.x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.groupAdd.html
new file mode 100644
index 0000000000..b10a353444
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.groupAdd.html
@@ -0,0 +1,128 @@
+---
+layout: v1x_soap
+title: Attribute Set Group Add
+---
+
+
Module: Product Attribute Set API
+
+
Resource: product_attribute_set
+
+
+
Method:
+
+
+
product_attribute_set.groupAdd (SOAP V1)
+
catalogProductAttributeSetGroupAdd (SOAP V2)
+
+
+
+
Allows you to add a new group for attributes to the attribute set.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
attributeSetId
+
Attribute set ID
+
+
+
string
+
groupName
+
Group name
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
result
+
ID of the created group
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
112
+
Requested group exist already in requested attribute set.
+
+
+
113
+
Error while adding group to attribute set. Details in error message.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_attribute_set.groupAdd', array('attributeSetId' => '9', 'groupName' => 'new_group'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeSetGroupAdd($sessionId, '9', 'new_group');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html b/guides/v19.x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html
new file mode 100644
index 0000000000..696357ecfa
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductAttributeSet/product_attribute_set.list.html
@@ -0,0 +1,155 @@
+---
+layout: v1x_soap
+title: Attribute Set List
+---
+
+
Module:Mage_Catalog
+
+
+
Resource:catalog_product_attribute_set
+
+
Aliases:
+
+
product_attribute_set
+
+
+
+
Method:
+
+
+
catalog_product_attribute_set.list (SOAP V1)
+
catalogProductAttributeSetList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product attribute sets.
+
+
Aliases:
+
+
product_attribute_set.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductAttributeSetEntity
+
+
+
+
+
The catalogProductAttributeSetEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
set_id
+
ID of the attribute set
+
+
+
string
+
name
+
Attribute set name
+
+
+
+
+
Faults:
+
+
No faults.
+
+
Examples
+
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_set.list');
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductAttributeSetList($sessionId);
+var_dump($result);
Allows you to retrieve full information about the custom option in a product.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
optionId
+
Option ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionInfoEntity
+
+
+
+
+
The catalogProductCustomOptionInfoEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
title
+
Custom option title
+
+
+
string
+
type
+
Custom option type. Can have one of the following values: "fixed" or "percent"
+
+
+
string
+
sort_order
+
Custom option sort order
+
+
+
int
+
is_require
+
Defines whether the custom option is required
+
+
+
array
+
additional_fields
+
Array of catalogProductCustomOptionAdditionalFields
+
+
+
+
+
The catalogProductCustomOptionAdditionalFields content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
title
+
Custom option title
+
+
+
string
+
price
+
Custom option price
+
+
+
string
+
price_type
+
Price type. Possible values are as follows: "fixed" or "percent"
+
+
+
string
+
sku
+
Custom option SKU
+
+
+
string
+
max_characters
+
Maximum number of characters for the customer input on the frontend (optional)
+
+
+
string
+
sort_order
+
Custom option sort order
+
+
+
string
+
file_extension
+
List of file extensions allowed to upload by the user on the frontend (optional; for the File input type)
+
+
+
string
+
image_size_x
+
Width limit for uploaded images (optional; for the File input type)
+
+
+
string
+
image_size_y
+
Height limit for uploaded images (optional; for the File input type)
+
+
+
string
+
value_id
+
Value ID
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Product with requested id does not exist.
+
+
+
104
+
Store with requested code/id does not exist.
+
+
+
105
+
Option with requested id does not exist.
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option.info', '1');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionInfo($sessionId, '1');
+var_dump($result);
Allows you to retrieve the list of custom options for a specific product.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
productId
+
Product ID
+
+
+
string
+
store
+
Store view ID or code (optional but required for WS-I mode)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionList
+
+
+
+
+
The catalogProductCustomOptionList content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
option_id
+
Custom option ID
+
+
+
string
+
title
+
Custom option title
+
+
+
string
+
type
+
Custom option type
+
+
+
string
+
sort_order
+
Custom option sort order
+
+
+
int
+
is_require
+
Defines whether the custom option is required
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Product with requested id does not exist.
+
+
+
104
+
Store with requested code/id does not exist.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option.list', '1');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionList($sessionId, '1');
+var_dump($result);
Allows you to retrieve the list of available custom option types.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionTypes
+
+
+
+
+
The catalogProductCustomOptionTypesEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
label
+
Custom option label
+
+
+
string
+
value
+
Custom option value
+
+
+
+
Faults:
+
+
No faults
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option.types');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionTypes($sessionId);
+var_dump($result);
Error while adding an option value. Details are in the error message.
+
+
+
103
+
Option with requested id does not exist.
+
+
+
104
+
Invalid option type.
+
+
+
105
+
Store with requested code/id does not exist.
+
+
+
106
+
Can not delete option.
+
+
+
107
+
Error while updating an option value. Details are in the error message.
+
+
+
108
+
Title field is required.
+
+
+
109
+
Option should have at least one value. Can not delete last value.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html b/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html
new file mode 100644
index 0000000000..01b118a963
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.add.html
@@ -0,0 +1,198 @@
+---
+layout: v1x_soap
+title: Product Custom Value Add
+---
+
+
Module: Complex Product API
+
+
+
Resource: product_custom_option_value
+
+
+
Method:
+
+
+
product_custom_option_value.add (SOAP V1)
+
catalogProductCustomOptionValueAdd (SOAP V2)
+
+
+
+
Allows you to add a new custom option value to a custom option. Note that the custom option value can be added only to the option with the Select Input Type.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
optionId
+
Option ID
+
+
+
array
+
data
+
Array of catalogProductCustomOptionValueAdd
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the custom option value is added
+
+
+
+
+
The catalogProductCustomOptionValueAdd content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
title
+
Custom option value title
+
+
+
string
+
price
+
Custom option value price
+
+
+
string
+
price_type
+
Type of the custom option value price. Can have one of the following values: "fixed" or "percent"
+
+
+
string
+
sku
+
Custom option value row SKU
+
+
+
string
+
sort_order
+
Custom option value sort order
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Option value with requested id does not exist.
+
+
+
102
+
Error while adding an option value. Details are in the error message.
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.info.html b/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.info.html
new file mode 100644
index 0000000000..e438d6665a
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.info.html
@@ -0,0 +1,218 @@
+---
+layout: v1x_soap
+title: Product Custom Value Info
+---
+
+
Module: Complex Product API
+
+
+
Resource: product_custom_option_value
+
+
+
Method:
+
+
+
product_custom_option_value.info (SOAP V1)
+
catalogProductCustomOptionValueInfo (SOAP V2)
+
+
+
+
Allows you to retrieve full information about the specified product custom option value.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
valueId
+
Value ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionValueInfoEntity
+
+
+
+
+
The catalogProductCustomOptionValueInfoEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
value_id
+
Option value ID
+
+
+
string
+
option_id
+
Option ID
+
+
+
string
+
sku
+
Custom option value row SKU
+
+
+
string
+
sort_order
+
Option value sort order
+
+
+
string
+
default_price
+
Option value default price
+
+
+
string
+
default_price_type
+
Default price type. Possible values are as follows: "fixed" or "percent"
+
+
+
string
+
store_price
+
Option value store price
+
+
+
string
+
store_price_type
+
Store price type. Possible values are as follows: "fixed" or "percent"
+
+
+
string
+
price
+
Option value price
+
+
+
string
+
price_type
+
Price type. Possible values are as follows: "fixed" or "percent"
+
+
+
string
+
default_title
+
Option value default title
+
+
+
string
+
store_title
+
Option value store title
+
+
+
string
+
title
+
Option value title
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Option value with requested id does not exist.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option_value.info', '5');
+var_dump($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionValueInfo($sessionId, '5');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.list.html b/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.list.html
new file mode 100644
index 0000000000..b84d9cc361
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductCustomOptionValue/product_custom_option_value.list.html
@@ -0,0 +1,197 @@
+---
+layout: v1x_soap
+title: Product Custom Value List
+---
+
+
Module: Complex Product API
+
+
+
Resource: product_custom_option_value
+
+
+
Method:
+
+
+
product_custom_option_value.list (SOAP V1)
+
catalogProductCustomOptionValueList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product custom option values. Note that the method is available only for the option Select Input Type.
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
optionId
+
Option ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductCustomOptionValueList
+
+
+
+
+
The catalogProductCustomOptionValueListEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
value_id
+
Custom option value ID
+
+
+
string
+
title
+
Custom option value title
+
+
+
string
+
price
+
Option value price
+
+
+
string
+
price_type
+
Price type. Possible values: "fixed" or "percent"
+
+
+
string
+
sku
+
Custom option value SKU
+
+
+
string
+
sort_order
+
Option value sort order (optional)
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Provided data is invalid.
+
+
+
102
+
Error while adding an option value. Details are in the error message.
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_custom_option_value.list', '3');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductCustomOptionValueList($sessionId, '3');
+var_dump($result);
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+
+// Get list of related products
+var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
+
+// Assign related product
+$proxy->call($sessionId, 'product_link.assign', array('related', 'Sku', 'Sku2', array('position'=>0, 'qty'=>56)));
+
+var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
+
+// Update related product
+$proxy->call($sessionId, 'product_link.update', array('related', 'Sku', 'Sku2', array('position'=>2)));
+
+var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
+
+// Remove related product
+$proxy->call($sessionId, 'product_link.remove', array('related', 'Sku', 'Sku2'));
+
+var_dump($proxy->call($sessionId, 'product_link.list', array('related', 'Sku')));
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html
new file mode 100644
index 0000000000..4b6e585df7
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.assign.html
@@ -0,0 +1,176 @@
+---
+layout: v1x_soap
+title: Product Link Assign
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.assign (SOAP V1)
+
catalogProductLinkAssign (SOAP V2)
+
+
+
+
Allows you to assign a product link (cross_sell, grouped, related, or up_sell) to another product.
+
+
Aliases:
+
+
product_link.assign
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Type of the link (cross_sell, grouped, related, or up_sell)
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
linkedProduct\linkedProductId
+
Product ID or SKU for the link
+
+
+
array
+
data
+
Array of catalogProductLinkEntity
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the link is assigned to the product
+
+
+
+
+
The catalogProductLinkEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
type
+
Type of the link (cross_sell, grouped, related, or up_sell)
+
+
+
string
+
set
+
Product attribute set
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
position
+
Position of the product
+
+
+
string
+
qty
+
Quantity of products
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apikey');
+
+$result = $client->call($session, 'catalog_product_link.assign', array('type' => 'related', 'product' => '1', 'linkedProduct' => '4'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkAssign($sessionId, 'related', '1', '4');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.attributes.html b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.attributes.html
new file mode 100644
index 0000000000..b4c3394af1
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.attributes.html
@@ -0,0 +1,150 @@
+---
+layout: v1x_soap
+title: Product Link Attributes
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.attributes (SOAP V1)
+
catalogProductLinkAttributes (SOAP V2)
+
+
+
+
Allows you to retrieve the product link type attributes.
+
+
Aliases:
+
+
product_link.attributes
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Type of the link (cross_sell, up_sell, related, or grouped)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductLinkAttributeEntity
+
+
+
+
+
The catalogProductLinkAttributeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
code
+
Attribute code
+
+
+
string
+
type
+
Attribute type
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_link.attributes', 'related');
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkAttributes($sessionId, 'related');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.list.html b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.list.html
new file mode 100644
index 0000000000..989bd456d8
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.list.html
@@ -0,0 +1,192 @@
+---
+layout: v1x_soap
+title: Product Link List
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.list (SOAP V1)
+
catalogProductLinkList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of linked products for a specific product.
+
+
Aliases:
+
+
product_link.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Type of the link (cross_sell, up_sell, related, or grouped)
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductLinkEntity
+
+
+
+
+
The catalogProductLinkEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
type
+
Type of the link
+
+
+
string
+
set
+
Product attribute set
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
position
+
Position
+
+
+
string
+
qty
+
Quantity
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_link.list', array('type' => 'related', 'product' => '1'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkList($sessionId, 'related', '1');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.remove.html b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.remove.html
new file mode 100644
index 0000000000..20717ad565
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.remove.html
@@ -0,0 +1,130 @@
+---
+layout: v1x_soap
+title: Product Link Remove
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.remove (SOAP V1)
+
catalogProductLinkRemove (SOAP V2)
+
+
+
+
Allows you to remove the product link from a specific product.
+
+
Aliases:
+
+
product_link.remove
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
type
+
Type of the link (cross_sell, up_sell, related, or grouped)
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
linkedProduct\linkedProductId
+
Product ID or SKU for the link
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the link is removed from a product
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_link.remove', array('type' => 'related', 'product' => '1', 'linkedProduct' => '4'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkRemove($sessionId, 'related', '1', '4');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.types.html b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.types.html
new file mode 100644
index 0000000000..19fd4e0453
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductLink/catalog_product_link.types.html
@@ -0,0 +1,127 @@
+---
+layout: v1x_soap
+title: Product Link Types
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_link
+
+
Aliases:
+
+
product_link
+
+
+
+
Method:
+
+
+
catalog_product_link.types (SOAP V1)
+
catalogProductLinkTypes (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product link types.
+
+
Aliases:
+
+
product_link.types
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
ArrayOfString
+
result
+
Array of link types
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'product_link.types');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductLinkTypes($sessionId);
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductTag/product_tag.remove.html b/guides/v19.x/api/soap/catalog/catalogProductTag/product_tag.remove.html
new file mode 100644
index 0000000000..4a4be55a82
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductTag/product_tag.remove.html
@@ -0,0 +1,119 @@
+---
+layout: v1x_soap
+title: Product Tag Remove
+---
+
+
Module: Tag API
+
+
Resource: catalog_product_tag
+
+
Aliases: product_tag
+
+
+
Method:
+
+
+
catalog_product_tag.remove (SOAP V1)
+
catalogProductTagRemove (SOAP V2)
+
+
+
+
Allows you to remove an existing product tag.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
tagId
+
Tag ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the product tag is removed
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Message
+
+
+
104
+
Requested tag does not exist.
+
+
+
107
+
Error while removing tag. Details in error message.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_tag.remove', '3');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductTagRemove($sessionId, '3');
+var_dump($result);
Allows you to retrieve information about product tier prices.
+
+
Aliases:
+
+
product_attribute_tier_price.info
+
product_tier_price.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
product\productId
+
Product ID or SKU
+
+
+
string
+
identifierType
+
Defines whether the product ID or SKU is passed in the 'product' parameter
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductTierPriceEntity
+
+
+
+
+
The catalogProductTierPriceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
website
+
Website
+
+
+
int
+
qty
+
Quantity of items to which the price will be applied
+
+
+
double
+
price
+
Price that each item will cost
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_attribute_tier_price.info', 'productId');
+var_dump($result);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$productId = 1;
+
+$result = $client->catalogProductAttributeTierPriceInfo(
+ $session,
+ $productId
+);
+
+
diff --git a/guides/v19.x/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html b/guides/v19.x/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html
new file mode 100644
index 0000000000..8f09eb0876
--- /dev/null
+++ b/guides/v19.x/api/soap/catalog/catalogProductTypes/catalog_product_type.list.html
@@ -0,0 +1,169 @@
+---
+layout: v1x_soap
+title: Product Type List
+---
+
+
Module: Mage_Catalog
+
+
+
Resource: catalog_product_type
+
+
Aliases:
+
+
product_type
+
+
+
+
Method:
+
+
+
catalog_product_type.list (SOAP V1)
+
catalogProductTypeList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of product types.
+
+
Aliases:
+
+
product_type.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogProductTypeEntity
+
+
+
+
+
The catalogProductTypeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
type
+
Product type
+
+
+
string
+
label
+
Product label in the Admin Panel
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'catalog_product_type.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogProductTypeList($sessionId);
+var_dump($result);
The use_config_manage_stock unchecks the ‘Use Config Settings’ box which allows you to make changes to this product and not to use the global settings that are set by default.
+
+
Example 1. Working with stock update
+
+
+
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+
+// Get stock info
+var_dump($proxy->call($sessionId, 'product_stock.list', 'Sku'));
+
+// Update stock info
+$proxy->call($sessionId, 'product_stock.update', array('Sku', array('qty'=>50, 'is_in_stock'=>1)));
+
+var_dump($proxy->call($sessionId, 'product_stock.list', 'Sku'));
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/catalogInventory/cataloginventory_stock_item.list.html b/guides/v19.x/api/soap/catalogInventory/cataloginventory_stock_item.list.html
new file mode 100644
index 0000000000..b68ea73e57
--- /dev/null
+++ b/guides/v19.x/api/soap/catalogInventory/cataloginventory_stock_item.list.html
@@ -0,0 +1,166 @@
+---
+layout: v1x_soap
+title: Inventory Item List
+---
+
+
Module: Mage_CatalogInventory
+
+
+
Resource: cataloginventory_stock_item
+
+
Aliases:
+
+
product_stock
+
+
+
+
Method:
+
+
+
cataloginventory_stock_item.list (SOAP V1)
+
catalogInventoryStockItemList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of stock data by product IDs.
+
+
Aliases:
+
+
product_stock.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
ArrayOfString
+
products/productIds (for WS-I mode)
+
List of product IDs or SKUs
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of catalogInventoryStockItemEntity
+
+
+
+
+
The catalogInventoryStockItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
qty
+
Product quantity
+
+
+
string
+
is_in_stock
+
Defines whether the product is in stock
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cataloginventory_stock_item.list', '1');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->catalogInventoryStockItemList($sessionId, array('1', '2'));
+var_dump($result);
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.
Can not make operation because store is not exists
+
+
+
1002
+
Can not make operation because quote is not exists
+
+
+
1003
+
Can not create a quote.
+
+
+
1004
+
Can not create a quote because quote with such identifier is already exists
+
+
+
1005
+
You did not set all required agreements
+
+
+
1006
+
The checkout type is not valid. Select single checkout type.
+
+
+
1007
+
Checkout is not available for guest
+
+
+
1008
+
Can not create an order.
+
+
+
+
+
Example
+
+
The following example illustrates the work with shopping cart (creation of a shopping cart, setting customer and customer addresses, adding products to the shopping cart, updating products in the shopping cart, removing products from the shopping cart, getting the list of products/shipping methods/payment methods, setting payment/shipping methods, adding/removing coupon, getting total prices/full information about shopping cart/list of licenses, and creating an order.
diff --git a/guides/v19.x/api/soap/checkout/cart/cart.info.html b/guides/v19.x/api/soap/checkout/cart/cart.info.html
new file mode 100644
index 0000000000..66385e24d1
--- /dev/null
+++ b/guides/v19.x/api/soap/checkout/cart/cart.info.html
@@ -0,0 +1,944 @@
+---
+layout: v1x_soap
+title: Cart Info
+---
+
+
Mage_Checkout
+
+
Module: Shopping Cart API
+
+
Resource: cart
+
+
+
Method:
+
+
+
cart.info (SOAP V1)
+
shoppingCartInfo (SOAP V2)
+
+
+
+
Allows you to retrieve full information about the shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID (quote ID)
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of shoppingCartInfoEntity
+
+
+
+
+
The shoppingCartInfoEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
converted_at
+
Date of conversion
+
+
+
int
+
quote_id
+
Quote ID
+
+
+
int
+
is_active
+
Active flag
+
+
+
int
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
int
+
is_multi_shipping
+
Defines whether multi shipping is available
+
+
+
double
+
items_count
+
Items quantity
+
+
+
double
+
items_qty
+
Total items quantity
+
+
+
string
+
orig_order_id
+
Original order ID
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
store_to_quote_rate
+
Store to quote rate
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
quote_currency_code
+
Quote currency code
+
+
+
string
+
grand_total
+
Grand total
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
checkout_method
+
Checkout method
+
+
+
string
+
customer_id
+
Customer ID
+
+
+
string
+
customer_tax_class_id
+
Customer tax class ID
+
+
+
int
+
customer_group_id
+
Customer group ID
+
+
+
string
+
customer_email
+
Customer email address
+
+
+
string
+
customer_prefix
+
Customer prefix
+
+
+
string
+
customer_firstname
+
Customer first name
+
+
+
string
+
customer_middlename
+
Customer middle name
+
+
+
string
+
customer_lastname
+
Customer last name
+
+
+
string
+
customer_suffix
+
Customer suffix
+
+
+
string
+
customer_note
+
Customer note
+
+
+
string
+
customer_note_notify
+
Customer notification flag
+
+
+
string
+
customer_is_guest
+
Defines whether the customer is a guest
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
reserved_order_id
+
Reserved order ID
+
+
+
string
+
password_hash
+
Password hash
+
+
+
string
+
coupon_code
+
Coupon code
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
double
+
base_to_global_rate
+
Base to global rate
+
+
+
double
+
base_to_quote_rate
+
Base to quote rate
+
+
+
string
+
customer_taxvat
+
Customer taxvat value
+
+
+
string
+
customer_gender
+
Customer gender
+
+
+
double
+
subtotal
+
Subtotal
+
+
+
double
+
base_subtotal
+
Base subtotal
+
+
+
double
+
subtotal_with_discount
+
Subtotal with discount
+
+
+
double
+
base_subtotal_with_discount
+
Base subtotal with discount
+
+
+
string
+
ext_shipping_info
+
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
double
+
customer_balance_amount_used
+
Used customer balance amount
+
+
+
double
+
base_customer_balance_amount_used
+
Used base customer balance amount
+
+
+
string
+
use_customer_balance
+
Defines whether to use the customer balance
+
+
+
string
+
gift_cards_amount
+
Gift cards amount
+
+
+
string
+
base_gift_cards_amount
+
Base gift cards amount
+
+
+
string
+
gift_cards_amount_used
+
Used gift cards amount
+
+
+
string
+
use_reward_points
+
Defines whether to use reward points
+
+
+
string
+
reward_points_balance
+
Reward points balance
+
+
+
string
+
base_reward_currency_amount
+
Base reward currency amount
+
+
+
string
+
reward_currency_amount
+
Reward currency amount
+
+
+
array
+
shipping_address
+
Array of shoppingCartAddressEntity
+
+
+
array
+
billing_address
+
Array of shoppingCartAddressEntity
+
+
+
array
+
items
+
Array of shoppingCartItemEntity
+
+
+
array
+
payment
+
Array of shoppingCartPaymentEntity
+
+
+
+
+
The shoppingCartAddressEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
address_id
+
Shopping cart address ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
customer_id
+
Customer ID
+
+
+
int
+
save_in_address_book
+
Defines whether to save the address in the address book
+
+
+
string
+
customer_address_id
+
Customer address ID
+
+
+
string
+
address_type
+
Address type
+
+
+
string
+
email
+
Email address
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
company
+
Company name
+
+
+
string
+
street
+
Street
+
+
+
string
+
city
+
City
+
+
+
string
+
region
+
Region
+
+
+
string
+
region_id
+
Region ID
+
+
+
string
+
postcode
+
Postcode
+
+
+
string
+
country_id
+
Country ID
+
+
+
string
+
telephone
+
Telephone number
+
+
+
string
+
fax
+
Fax
+
+
+
int
+
same_as_billing
+
Defines whether the address is the same as the billing one
+
+
+
int
+
free_shipping
+
Defines whether free shipping is used
+
+
+
string
+
shipping_method
+
Shipping method
+
+
+
string
+
shipping_description
+
Shipping description
+
+
+
double
+
weight
+
Weight
+
+
+
+
+
The shoppingCartItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
item_id
+
Cart item ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
parent_item_id
+
Parent item ID
+
+
+
int
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
name
+
Product name
+
+
+
string
+
description
+
Description
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
additional_data
+
Additional data
+
+
+
string
+
free_shipping
+
Free shipping
+
+
+
string
+
is_qty_decimal
+
Defines whether the quantity is decimal
+
+
+
string
+
no_discount
+
Defines whether no discount is applied
+
+
+
double
+
weight
+
Weight
+
+
+
double
+
qty
+
Quantity
+
+
+
double
+
price
+
Price
+
+
+
double
+
base_price
+
Base price
+
+
+
double
+
custom_price
+
Custom price
+
+
+
double
+
discount_percent
+
Discount percent
+
+
+
double
+
discount_amount
+
Discount amount
+
+
+
double
+
base_discount_amount
+
Base discount amount
+
+
+
double
+
tax_percent
+
Tax percent
+
+
+
double
+
tax_amount
+
Tax amount
+
+
+
double
+
base_tax_amount
+
Base tax amount
+
+
+
double
+
row_total
+
Row total
+
+
+
double
+
base_row_total
+
Base row total
+
+
+
double
+
row_total_with_discount
+
Row total with discount
+
+
+
double
+
row_weight
+
Row weight
+
+
+
string
+
product_type
+
Product type
+
+
+
double
+
base_tax_before_discount
+
Base tax before discount
+
+
+
double
+
tax_before_discount
+
Tax before discount
+
+
+
double
+
original_custom_price
+
Original custom price
+
+
+
double
+
base_cost
+
Base cost
+
+
+
double
+
price_incl_tax
+
Price including tax
+
+
+
double
+
base_price_incl_tax
+
Base price including tax
+
+
+
double
+
row_total_incl_tax
+
Row total including tax
+
+
+
double
+
base_row_total_incl_tax
+
Base row total including tax
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available
+
+
+
double
+
weee_tax_applied
+
Applied fix product tax
+
+
+
double
+
weee_tax_applied_amount
+
Applied fix product tax amount
+
+
+
double
+
weee_tax_applied_row_amount
+
Applied fix product tax row amount
+
+
+
double
+
base_weee_tax_applied_amount
+
Applied fix product tax amount (in base currency)
+
+
+
double
+
base_weee_tax_applied_row_amount
+
Applied fix product tax row amount (in base currency)
+
+
+
double
+
weee_tax_disposition
+
Fixed product tax disposition
+
+
+
double
+
weee_tax_row_disposition
+
Fixed product tax row disposition
+
+
+
double
+
base_weee_tax_disposition
+
Fixed product tax disposition (in base currency)
+
+
+
double
+
base_weee_tax_row_disposition
+
Fixed product tax row disposition (in base currency)
+
+
+
string
+
tax_class_id
+
Tax class ID
+
+
+
+
+
The shoppingCartPaymentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
payment_id
+
Payment ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
method
+
Payment method
+
+
+
string
+
cc_type
+
Credit card type
+
+
+
string
+
cc_number_enc
+
Credit card number
+
+
+
string
+
cc_last4
+
Last four digits on the credit card
+
+
+
string
+
cc_cid_enc
+
Credit card CID
+
+
+
string
+
cc_owner
+
Credit card owner
+
+
+
string
+
cc_exp_month
+
Credit card expiration month
+
+
+
string
+
cc_exp_year
+
Credit card expiration year
+
+
+
string
+
cc_ss_owner
+
Credit card owner (Switch/Solo)
+
+
+
string
+
cc_ss_start_month
+
Credit card start month (Switch/Solo)
+
+
+
string
+
cc_ss_start_year
+
Credit card start year (Switch/Solo)
+
+
+
string
+
cc_ss_issue
+
Credit card issue number (Switch/Solo)
+
+
+
string
+
po_number
+
Purchase order number
+
+
+
string
+
additional_data
+
Additional data
+
+
+
string
+
additional_information
+
Additional information
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cart.info', '15');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->shoppingCartInfo($sessionId, '15');
+var_dump($result);
+
+
+
diff --git a/guides/v19.x/api/soap/checkout/cart/cart.order.html b/guides/v19.x/api/soap/checkout/cart/cart.order.html
new file mode 100644
index 0000000000..06948f05e4
--- /dev/null
+++ b/guides/v19.x/api/soap/checkout/cart/cart.order.html
@@ -0,0 +1,174 @@
+---
+layout: v1x_soap
+title: Cart Order
+---
+
+
Mage_Checkout
+
+
+
Module: Shopping Cart API
+
+
Resource: cart
+
+
Method:
+
+
+
cart.order (SOAP V1)
+
shoppingCartOrder (SOAP V2)
+
+
+
+
Allows you to create an order from a shopping cart (quote).
+Before placing the order, you need to add the customer, customer address, shipping and payment methods.
Allows you to retrieve total prices for a shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID (quote identifier)
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of shoppingCartTotalsEntity
+
+
+
+
+
The shoppingCartTotalsEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
title
+
Title
+
+
+
float
+
amount
+
Total amount
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cart.totals', '15');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->shoppingCartTotals($sessionId, '15');
+var_dump($result);
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.
+
+
Cart Coupon
+
+
Allows you to add and remove coupon codes for a shopping cart.
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 the frontend logic. The cart is represented by the Mage_Checkout_Model_Cart class and the quote is represented by the Mage_Sales_Model_Quote class.
+
+
Faults
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
1001
+
Can not make operation because store is not exists
+
+
+
1002
+
Can not make operation because quote is not exists
+
+
+
1081
+
Coupon could not be applied because quote is empty.
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.
+
+
Cart Customer
+
+
Allows you to add customer information and addresses into a shopping cart.
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.
+
+
Cart Payment
+
+
Allows you to retrieve and set payment methods for a shopping cart.
cart_payment.list - Get the list of available payment methods for a shopping cart
+
+
+
+
Faults
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
1001
+
Can not make operation because store is not exists
+
+
+
1002
+
Can not make operation because quote is not exists
+
+
+
1071
+
Payment method data is empty.
+
+
+
1072
+
Customer’s billing address is not set. Required for payment method data.
+
+
+
1073
+
Customer’s shipping address is not set. Required for payment method data.
+
+
+
1074
+
Payment method is not allowed
+
+
+
1075
+
Payment method is not set.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/checkout/cartPayment/cart_payment.list.html b/guides/v19.x/api/soap/checkout/cartPayment/cart_payment.list.html
new file mode 100644
index 0000000000..688e4f5b98
--- /dev/null
+++ b/guides/v19.x/api/soap/checkout/cartPayment/cart_payment.list.html
@@ -0,0 +1,132 @@
+---
+layout: v1x_soap
+title: Payment List
+---
+
+
Mage_Checkout
+
+
+
Module: Shopping Cart API
+
+
Resource: cart_payment
+
+
Method:
+
+
cart_payment.list (SOAP V1)
+
shoppingCartPaymentList (SOAP V2)
+
+
+
+
Allows you to retrieve a list of available payment methods for a shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of shoppingCartPaymentMethodResponseEntity
+
+
+
+
+
The shoppingCartPaymentMethodResponseEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
code
+
Payment method code
+
+
+
string
+
title
+
Payment method title
+
+
+
associativeArray
+
cc_types
+
Array of credit card types
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cart_payment.list', 'quoteId');
+var_dump($result);
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.
Can not make operation because store is not exists
+
+
+
1002
+
Can not make operation because quote is not exists
+
+
+
1021
+
Product’s data is not valid.
+
+
+
1022
+
Product(s) could not be added.
+
+
+
1023
+
Quote could not be saved during adding product(s) operation.
+
+
+
1024
+
Product(s) could not be updated.
+
+
+
1025
+
Quote could not be saved during updating product(s) operation.
+
+
+
1026
+
Product(s) could not be removed.
+
+
+
1027
+
Quote could not be saved during removing product(s) operation.
+
+
+
1028
+
Customer is not set for quote.
+
+
+
1029
+
Customer’s quote is not existed.
+
+
+
1030
+
Quotes are identical.
+
+
+
1031
+
Product(s) could not be moved.
+
+
+
1032
+
One of quote could not be saved during moving product(s) operation.
+
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/checkout/cartProduct/cart_product.add.html b/guides/v19.x/api/soap/checkout/cartProduct/cart_product.add.html
new file mode 100644
index 0000000000..244186d154
--- /dev/null
+++ b/guides/v19.x/api/soap/checkout/cartProduct/cart_product.add.html
@@ -0,0 +1,203 @@
+---
+layout: v1x_soap
+title: Product Add
+---
+
+
Shopping Cart API
+
+
Allows you to create/modify shopping cart and create an order after complete filling the shopping cart. Consists of two main parts: Shopping Cart and Checkout processes.
+
+
Module: Mage_Checkout
+
+
Resource: cart_product
+
+
Method:
+
+
+
cart_product.add (SOAP V1)
+
shoppingCartProductAdd (SOAP V2)
+
+
+
+
Allows you to add one or more products to the shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID (quote ID)
+
+
+
array
+
products\productsData
+
An array with the list of shoppingCartProductEntity
+
+
+
string
+
storeId
+
Store view ID or code (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True on success (if the product is added to the shopping cart)
+
+
+
+
+
The shoppingCartProductEntity array attributes are as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
ID of the product to be added to the shopping cart (quote) (optional)
+
+
+
string
+
sku
+
SKU of the product to be added to the shopping cart (quote) (optional)
+
+
+
double
+
qty
+
Number of products to be added to the shopping cart (quote) (optional)
+
+
+
associativeArray
+
options
+
An array in the form of option_id => content (optional)
+
+
+
diff --git a/guides/v19.x/api/soap/checkout/cartProduct/cart_product.list.html b/guides/v19.x/api/soap/checkout/cartProduct/cart_product.list.html
new file mode 100644
index 0000000000..0cd1c3f657
--- /dev/null
+++ b/guides/v19.x/api/soap/checkout/cartProduct/cart_product.list.html
@@ -0,0 +1,180 @@
+---
+layout: v1x_soap
+title: Product List
+---
+
+
Mage_Checkout
+
+
+
Module: Shopping Cart API
+
+
Resource: cart_product
+
+
+
Method:
+
+
+
cart_product.list (SOAP V1)
+
shoppingCartProductList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of products in the shopping cart (quote).
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
quoteId
+
Shopping cart ID
+
+
+
string
+
store
+
Store view ID or code (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of shoppingCartProductResponseEntity
+
+
+
+
+
The shoppingCartProductResponseEntity (catalogProductEntity) content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
name
+
Product name
+
+
+
string
+
set
+
Product attribute set
+
+
+
string
+
type
+
Product type
+
+
+
ArrayOfString
+
category_ids
+
Array of category IDs
+
+
+
ArrayOfString
+
website_ids
+
Array of website IDs
+
+
+
+
Faults:
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'cart_product.list', '15');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->shoppingCartProductList($sessionId, '15');
+var_dump($result);
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.
+
+
Cart Shipping
+
+
Allows you to retrieve and set shipping methods for a shopping cart.
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.
+
+
Cart Coupon
+
+
Allows you to add and remove coupon codes for a shopping cart.
The Core API allows you to manage a set of common resources used in Magento. However, you may choose to have your own set of resources to manage, or you may wish to extend the Core API to handle additional resources.
+
+
This tutorial leads you through the process of creating a custom API for a customer module that handles basic customer information.
+
+
Note: This tutorial applies to v1 of the API.
+
+
To learn more about the Core API, to read Magento Core API calls.
+
+
For general information about the Magento API, go to the Introduction.
+
+
1. Creating an XML File that Will Define the API Resource
+
+
Create a file named api.xml in the /etc folder in the customer module. Start with the empty structure, as follows:
Add an element named customer in the <resources> element. Add a <methods> element, with elements for list, create, info, update and remove methods for customer resource.
The resource can return some faults, so add a <faults> element in the customer element, and list the various faults.
+
+
+
<config>
+ <api>
+....
+ <resources>
+ <customer translate="title" module="customer">
+....
+ <faults module="customer"> <!-- module="customer" specifies the module which will be used for translation. -->
+ <data_invalid> <!-- if we get invalid input data for customers -->
+ <code>100</code >
+ <!-- we cannot know all the errors that can appear, their details can be found in error message for call -->
+ <message>Invalid customer data. Details in error message.</message>
+ </data_invalid>
+ <filters_invalid>
+ <code>101</code >
+ <message>Invalid filters specified. Details in error message.</message>
+ </filters_invalid>
+ <not_exists>
+ <code>102</code >
+ <message>Customer doesn't exist.</message>
+ </not_exists>
+ <not_deleted>
+ <code>103</code >
+ <message>Customer was not deleted. Details in error message.</message>
+ </not_deleted>
+ </faults>
+ </customer>
+ </resources>
+....
+ </api>
+</config>
+
+
+
+
4. Describing the Access Control List (ACL) for the Resource
+
+
In order to prevent unauthorized access to our custom API, you must first list the resources that are restricted within the <acl> element.
Next, write some PHP code to access the resources. Start by creating a class called Mage_Customer_Model_Customer_Api that extends Mage_Api_Model_Resource_Abstract. Save it into a file called api.php.
+
+
+
class Mage_Customer_Model_Customer_Api extends Mage_Api_Model_Resource_Abstract
+{
+
+ public function create($customerData)
+ {
+ }
+
+ public function info($customerId)
+ {
+ }
+
+ public function items($filters)
+ {
+ }
+
+ public function update($customerId, $customerData)
+ {
+ }
+
+ public function delete($customerId)
+ {
+ }
+}
+
+
+
+
Note that you cannot create method "list" because it’s a PHP keyword, so instead the method is named items. In order to make this work, add a <method> element into the <list> element in api.xml, as shown below.
Now add some simple functionality to the Mage_Customer_Model_Api methods you created.
+
+
Create a customer:
+
+
+
public function create($customerData)
+ {
+ try {
+ $customer = Mage::getModel('customer/customer')
+ ->setData($customerData)
+ ->save();
+ } catch (Mage_Core_Exception $e) {
+ $this->_fault('data_invalid', $e->getMessage());
+ // We cannot know all the possible exceptions,
+ // so let's try to catch the ones that extend Mage_Core_Exception
+ } catch (Exception $e) {
+ $this->_fault('data_invalid', $e->getMessage());
+ }
+ return $customer->getId();
+ }
+
+
+
+
Retrieve customer info:
+
+
+
public function info($customerId)
+ {
+ $customer = Mage::getModel('customer/customer')->load($customerId);
+ if (!$customer->getId()) {
+ $this->_fault('not_exists');
+ // If customer not found.
+ }
+ return $customer->toArray();
+ // We can use only simple PHP data types in webservices.
+ }
+
+
+
+
Retrieve list of customers using filtering:
+
+
+
public function items($filters)
+ {
+ $collection = Mage::getModel('customer/customer')->getCollection()
+ ->addAttributeToSelect('*');
+
+ if (is_array($filters)) {
+ try {
+ foreach ($filters as $field => $value) {
+ $collection->addFieldToFilter($field, $value);
+ }
+ } catch (Mage_Core_Exception $e) {
+ $this->_fault('filters_invalid', $e->getMessage());
+ // If we are adding filter on non-existent attribute
+ }
+ }
+
+ $result = array();
+ foreach ($collection as $customer) {
+ $result[] = $customer->toArray();
+ }
+
+ return $result;
+ }
+
+
+
+
Update a customer:
+
+
+
public function update($customerId, $customerData)
+ {
+ $customer = Mage::getModel('customer/customer')->load($customerId);
+
+ if (!$customer->getId()) {
+ $this->_fault('not_exists');
+ // No customer found
+ }
+
+ $customer->addData($customerData)->save();
+ return true;
+ }
+
+
+
+
Delete a customer:
+
+
+
public function delete($customerId)
+ {
+ $customer = Mage::getModel('customer/customer')->load($customerId);
+
+ if (!$customer->getId()) {
+ $this->_fault('not_exists');
+ // No customer found
+ }
+
+ try {
+ $customer->delete();
+ } catch (Mage_Core_Exception $e) {
+ $this->_fault('not_deleted', $e->getMessage());
+ // Some errors while deleting.
+ }
+
+ return true;
+ }
+
+
+
+
Creating a Custom Adapter
+
+
In order to create custom webservice adapter, implement the Mage_Api_Model_Server_Adapter_Interface, which is shown below.
+
+
+
interface Mage_Api_Model_Server_Adapter_Interface
+{
+ /**
+ * Set handler class name for webservice
+ *
+ * @param string $handler
+ * @return Mage_Api_Model_Server_Adapter_Interface
+ */
+ function setHandler($handler);
+
+ /**
+ * Retrieve handler class name for webservice
+ *
+ * @return string [basc]
+ */
+ function getHandler();
+
+ /**
+ * Set webservice API controller
+ *
+ * @param Mage_Api_Controller_Action $controller
+ * @return Mage_Api_Model_Server_Adapter_Interface
+ */
+ function setController(Mage_Api_Controller_Action $controller);
+
+ /**
+ * Retrieve webservice API controller
+ *
+ * @return Mage_Api_Controller_Action
+ */
+ function getController();
+
+ /**
+ * Run webservice
+ *
+ * @return Mage_Api_Model_Server_Adapter_Interface
+ */
+ function run();
+
+ /**
+ * Dispatch webservice fault
+ *
+ * @param int $code
+ * @param string $message
+ */
+ function fault($code, $message);
+
+} // Class Mage_Api_Model_Server_Adapter_Interface End
+
+
+
+
Here is an example implementation for XML-RPC:
+
+
+
class Mage_Api_Model_Server_Adapter_Customxmlrpc
+ extends Varien_Object
+ implements Mage_Api_Model_Server_Adapter_Interface
+{
+ /**
+ * XmlRpc Server
+ *
+ * @var Zend_XmlRpc_Server
+ */
+ protected $_xmlRpc = null;
+
+ /**
+ * Set handler class name for webservice
+ *
+ * @param string $handler
+ * @return Mage_Api_Model_Server_Adapter_Xmlrpc
+ */
+ public function setHandler($handler)
+ {
+ $this->setData('handler', $handler);
+ return $this;
+ }
+
+ /**
+ * Retrieve handler class name for webservice
+ *
+ * @return string
+ */
+ public function getHandler()
+ {
+ return $this->getData('handler');
+ }
+
+ /**
+ * Set webservice API controller
+ *
+ * @param Mage_Api_Controller_Action $controller
+ * @return Mage_Api_Model_Server_Adapter_Xmlrpc
+ */
+ public function setController(Mage_Api_Controller_Action $controller)
+ {
+ $this->setData('controller', $controller);
+ return $this;
+ }
+
+ /**
+ * Retrieve webservice API controller
+ *
+ * @return Mage_Api_Controller_Action
+ */
+ public function getController()
+ {
+ return $this->getData('controller');
+ }
+
+ /**
+ * Run webservice
+ *
+ * @param Mage_Api_Controller_Action $controller
+ * @return Mage_Api_Model_Server_Adapter_Xmlrpc
+ */
+ public function run()
+ {
+ $this->_xmlRpc = new Zend_XmlRpc_Server();
+ $this->_xmlRpc->setClass($this->getHandler());
+ $this->getController()->getResponse()
+ ->setHeader('Content-Type', 'text/xml')
+ ->setBody($this->_xmlRpc->handle());
+ return $this;
+ }
+
+ /**
+ * Dispatch webservice fault
+ *
+ * @param int $code
+ * @param string $message
+ */
+ public function fault($code, $message)
+ {
+ throw new Zend_XmlRpc_Server_Exception($message, $code);
+ }
+} // Class Mage_Api_Model_Server_Adapter_Customxmlrpc End
+
+
+
+
Notes: The setHandler, getHandler, setController and getController methods have a simple implementation that uses the Varien_Object getData and setData methods.
+
+
The run and fault methods are a native implementation for an XML-RPC webservice. The run method defines webservice logic in this adapter for creating an XML-RPC server to handle XML-RPC requests.
+
+
+
public function run()
+Â Â {
+Â Â Â Â $this->_xmlRpc = new Zend_XmlRpc_Server();
+Â Â Â Â $this->_xmlRpc->setClass($this->getHandler());
+Â Â Â Â $this->getController()->getResponse()
+Â Â Â Â Â Â ->setHeader('Content-Type', 'text/xml')
+Â Â Â Â Â Â ->setBody($this->_xmlRpc->handle());
+Â Â Â Â return $this;
+Â Â }
+
+
+
+
The "fault" method allows you to send fault exceptions for XML-RPC service when handling requests.
+
+
+
public function fault($code, $message)
+Â Â {
+Â Â Â Â throw new Zend_XmlRpc_Server_Exception($message, $code);
+Â Â }
+
+
+
+
Common Error Messages
+
+
The following are common error messages that you might receive when creating your own custom API.
+
+
Invalid API path
+
+
This error occurs when the methods listed in the api.xml file do not correspond exactly with those used in your PHP file.
+
+
For example, in your api.xml file, you might have this:
Allows you to export/import customers from/to Magento
+
+
Resource: customer
+
+
+
Method:
+
+
+
customer.delete (SOAP V1)
+
customerCustomerDelete (SOAP V2)
+
+
+
+
Delete the required customer.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
customerId
+
Customer ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the customer is deleted
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer.delete', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerCustomerDelete($sessionId, '2');
+var_dump($result);
diff --git a/guides/v19.x/api/soap/customer/customer.info.html b/guides/v19.x/api/soap/customer/customer.info.html
new file mode 100644
index 0000000000..5aee882f61
--- /dev/null
+++ b/guides/v19.x/api/soap/customer/customer.info.html
@@ -0,0 +1,259 @@
+---
+layout: v1x_soap
+title: Customer Info
+---
+
+
Module: Mage_Customer
+
+
Allows you to export/import customers from/to Magento.
+
+
Resource: customer
+
+
+
Method:
+
+
+
customer.info (SOAP V1)
+
customerCustomerInfo (SOAP V2)
+
+
+
+
+
Retrieve information about the specified customer.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
customerId
+
ID of the required customer
+
+
+
ArrayOfString
+
attributes
+
Array of attributes
+
+
+
+
+
attributes (optional depending on the version) - only specified attributes will be returned. The customer_id value is always returned.
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
customerInfo
+
Array of customerCustomerEntity
+
+
+
+
+
The customerCustomerEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_id
+
ID of the customer
+
+
+
string
+
created_at
+
Date when the customer was created
+
+
+
string
+
updated_at
+
Date when the customer was updated
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
int
+
store_id
+
Store ID
+
+
+
int
+
website_id
+
Website ID
+
+
+
string
+
created_in
+
Store view the customer was created in
+
+
+
string
+
email
+
Customer email
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
int
+
group_id
+
Customer group ID
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
dob
+
Customer date of birth
+
+
+
string
+
taxvat
+
Tax/VAT number
+
+
+
boolean
+
confirmation
+
Confirmation flag
+
+
+
string
+
password_hash
+
Password hash
+
+
+
string
+
rp_token
+
Reset password token
+
+
+
string
+
rp_token_created_at
+
Date when the password was reset
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer.info', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerCustomerInfo($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/customer/customer.list.html b/guides/v19.x/api/soap/customer/customer.list.html
new file mode 100644
index 0000000000..d88bfce781
--- /dev/null
+++ b/guides/v19.x/api/soap/customer/customer.list.html
@@ -0,0 +1,275 @@
+---
+layout: v1x_soap
+title: Customer List
+---
+
+
Module: Mage_Customer
+
+
+
Resource: customer
+
+
+
Method:
+
+
+
customer.list (SOAP V1)
+
customerCustomerList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of customers.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters by customer attributes (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
storeView
+
Array of customerCustomerEntity
+
+
+
+
+
The customerCustomerEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_id
+
ID of the customer
+
+
+
string
+
created_at
+
Date when the customer was created
+
+
+
string
+
updated_at
+
Date of when the customer was updated
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
int
+
store_id
+
Store ID
+
+
+
int
+
website_id
+
Website ID
+
+
+
string
+
created_in
+
Created in
+
+
+
string
+
email
+
Customer email
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
int
+
group_id
+
Group ID
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
dob
+
Customer date of birth
+
+
+
string
+
taxvat
+
Taxvat value
+
+
+
boolean
+
confirmation
+
Confirmation flag
+
+
+
string
+
password_hash
+
Password hash
+
+
+
+
Note: The password_hash parameter will only match exactly with the same MD5 and salt as was used when Magento stored the value. If you try to match with an unsalted MD5 hash, or any salt other than what Magento used, it will not match. This is just a straight string comparison.
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer.list');
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2 (List of All Customers)
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerCustomerList($sessionId);
+var_dump($result);
+
+
+
+
+
Request Example SOAP V2 (Complex Filter)
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$complexFilter = array(
+ 'complex_filter' => array(
+ array(
+ 'key' => 'group_id',
+ 'value' => array('key' => 'in', 'value' => '1,3')
+ )
+ )
+);
+$result = $client->customerCustomerList($session, $complexFilter);
+
+var_dump ($result);
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer_address.delete', '4');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerAddressDelete($sessionId, '4');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/customer/customerAddress/customer_address.info.html b/guides/v19.x/api/soap/customer/customerAddress/customer_address.info.html
new file mode 100644
index 0000000000..785d9f58cb
--- /dev/null
+++ b/guides/v19.x/api/soap/customer/customerAddress/customer_address.info.html
@@ -0,0 +1,254 @@
+---
+layout: v1x_soap
+title: Address Info
+---
+
+
Module: Mage_Customer
+
+
+
Resource: customer_address
+
+
+
Method:
+
+
+
customer_address.info (SOAP V1)
+
customerAddressInfo (SOAP V2)
+
+
+
+
Retrieve information about the required customer address.
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
addressId
+
Address ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
info
+
Array of customerAddressEntityItem
+
+
+
+
+
The customerAddressEntityItem content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_address_id
+
ID of the customer address
+
+
+
string
+
created_at
+
Date when the address was created
+
+
+
string
+
updated_at
+
Date when the address was updated
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
city
+
name of the city
+
+
+
string
+
company
+
Name of the company
+
+
+
string
+
country_id
+
ID of the country
+
+
+
string
+
fax
+
Fax
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
postcode
+
Customer postcode
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
region
+
Name of the region
+
+
+
int
+
region_id
+
Region ID
+
+
+
string
+
street
+
Name of the street
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
telephone
+
Telephone number
+
+
+
boolean
+
is_default_billing
+
True if the address is the default one for billing
+
+
+
boolean
+
is_default_shipping
+
True if the address is the default one for shipping
+
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer_address.info', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerAddressInfo($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/customer/customerAddress/customer_address.list.html b/guides/v19.x/api/soap/customer/customerAddress/customer_address.list.html
new file mode 100644
index 0000000000..25d291da67
--- /dev/null
+++ b/guides/v19.x/api/soap/customer/customerAddress/customer_address.list.html
@@ -0,0 +1,259 @@
+---
+layout: v1x_soap
+title: Address List
+---
+
+
Module: Mage_Customer
+
+
+
Resource: customer_address
+
+
+
Method:
+
+
+
customer_address.list (SOAP V1)
+
customerAddressList (SOAP V2)
+
+
+
+
Retrieve the list of customer addresses.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
int
+
customerId
+
Customer ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of customerAddressEntity
+
+
+
+
+
The customerAddressEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_address_id
+
ID of the customer address
+
+
+
string
+
created_at
+
Date when the address was created
+
+
+
string
+
updated_at
+
Date when the address was updated
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
city
+
City
+
+
+
string
+
company
+
Name of the company
+
+
+
string
+
country_id
+
ID of the country
+
+
+
string
+
fax
+
Fax
+
+
+
string
+
firstname
+
Customer first name
+
+
+
string
+
lastname
+
Customer last name
+
+
+
string
+
middlename
+
Customer middle name
+
+
+
string
+
postcode
+
Customer postcode
+
+
+
string
+
prefix
+
Customer prefix
+
+
+
string
+
region
+
Name of the region
+
+
+
int
+
region_id
+
Region ID
+
+
+
string
+
street
+
Name of the street
+
+
+
string
+
suffix
+
Customer suffix
+
+
+
string
+
telephone
+
Telephone number
+
+
+
boolean
+
is_default_billing
+
True if the address is the default one for billing
+
+
+
boolean
+
is_default_shipping
+
True if the address is the default one for shipping
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer_address.list', '2');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerAddressList($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/customer/customer_group.html b/guides/v19.x/api/soap/customer/customer_group.html
new file mode 100644
index 0000000000..7854a734e5
--- /dev/null
+++ b/guides/v19.x/api/soap/customer/customer_group.html
@@ -0,0 +1,146 @@
+---
+layout: v1x_soap
+title: Customer Group
+---
+
+
Module: Mage_Customer
+
+
Allows you to export customer groups from Magento
+
+
Resource: customer_group
+
+
Method:
+
+
+
customer_group.list (SOAP V1)
+
customerGroupList (SOAP V2)
+
+
+
+
Retrieve the list of customer groups
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
An array of customerGroupEntity
+
+
+
+
+
The customerGroupEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
customer_group_id
+
ID of the customer group
+
+
+
string
+
customer_group_code
+
Customer group code
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'customer_group.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->customerGroupList($sessionId);
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/directory/directory_region.list.html b/guides/v19.x/api/soap/directory/directory_region.list.html
new file mode 100644
index 0000000000..cec893f714
--- /dev/null
+++ b/guides/v19.x/api/soap/directory/directory_region.list.html
@@ -0,0 +1,186 @@
+---
+layout: v1x_soap
+title: Region List
+---
+
+
Region API
+
+
Allows you to export the list of regions from Magento
+
+
Module: Mage_Directory
+
+
Resource: directory_region
+
+
Aliases:
+
+
region
+
+
+
+
Method:
+
+
+
directory_region.list (SOAP V1)
+
directoryRegionList (SOAP V2)
+
+
+
+
Retrieve the list of regions in the specified country.
+
+
Aliases:
+
+
region.list
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
country
+
Country code in ISO2 or ISO3
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
directoryRegionEntityArray
+
An array of directoryRegionEntity
+
+
+
+
+
+
The directoryRegionEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
region_id
+
ID of the region
+
+
+
string
+
code
+
Region code
+
+
+
string
+
name
+
Name of the region
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Country not exists.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+$regions = $proxy->call($sessionId, 'region.list', 'US');
+
+var_dump($regions); // Region list for USA.
The Magento SOAP v1 API provides you with the ability to manage your eCommerce stores by providing calls for working with resources such as customers, categories, products, and sales orders. It also allows you to manage shopping carts and inventory.
+
+
A SOAP v2 API version has been available since Magento 1.3, and a WS-I compliant version has been available since Magento 1.6.
+
+
Supported Types
+
+
The Magento API supports SOAP and XML-RPC, where SOAP is the default protocol.
+
+
SOAP
+
+
To connect to Magento SOAP web services, load the WSDL into your SOAP client from either of these URLs:
+
+
+
+
http://magentohost/api/?wsdl
+
+
+
+
+
http://magentohost/api/soap/?wsdl
+
+
+
+
where magentohost is the domain for your Magento host.
+
+
As of v1.3, you may also use the following URL to access the Magento API v2, which has been added to improve compatibility with Java and .NET:
+
+
+
+
http://magentohost/api/v2_soap?wsdl=1
+
+
+
+
The following PHP example shows how to make SOAP calls to the Magento API v1:
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'somestuff.method');
+$result = $client->call($session, 'somestuff.method', 'arg1');
+$result = $client->call($session, 'somestuff.method', array('arg1', 'arg2', 'arg3'));
+$result = $client->multiCall($session, array(
+ array('somestuff.method'),
+ array('somestuff.method', 'arg1'),
+ array('somestuff.method', array('arg1', 'arg2'))
+));
+
+
+// If you don't need the session anymore
+$client->endSession($session);
+
+
+
+
XML-RPC
+
+
To use XML-RPC, load the following URL into your XML-RPC client:
+
+
+
+
http://magentohost/api/xmlrpc/
+
+
+
+
where magentohost is the domain for your Magento host.
+
+
The following PHP example shows how to make XML-RPC calls:
+
+
+
+
$client = new Zend_XmlRpc_Client('http://magentohost/api/xmlrpc/');
+
+// If somestuff requires API authentication,
+// we should get session token
+$session = $client->call('login', array('apiUser', 'apiKey'));
+
+$client->call('call', array($session, 'somestuff.method', array('arg1', 'arg2', 'arg3')));
+$client->call('call', array($session, 'somestuff.method', array('arg1')));
+$client->call('call', array($session, 'somestuff.method'));
+$client->call('multiCall', array($session,
+ array(
+ array('somestuff.method', 'arg1'),
+ array('somestuff.method', array('arg1', 'arg2')),
+ array('somestuff.method')
+ )
+));
+
+// If you don't need the session anymore
+$client->call('endSession', array($session));
+
+
+
+
The XML-RPC only supports the version 1 of the Magento API.
+
+
API Methods
+
+
The following table contains the API methods that can be called from your SOAP or XML-RPC client on the Magento v1 API.
+
+
+
+
+
+
Method
+
Description
+
Return Value
+
+
+
startSession()
+
Start the API session and return session ID.
+
string
+
+
+
endSession(sessionId)
+
End the API session.
+
boolean
+
+
+
login(apiUser, apiKey)
+
Start the API session, return the session ID, and authorize the API user.
+
string
+
+
+
call(sessionId, resourcePath,array arguments)
+
Call the API resource that is allowed in the current session. See Note below.
+
mixed
+
+
+
multiCall(sessionId, array calls,array options)
+
Call the API resource’s methods that are allowed for current session. See Notes below.
+
array
+
+
+
resources(sessionId)
+
Return a list of available API resources and methods allowed for the current session.
+
array
+
+
+
globalFaults(sessionId)
+
Return a list of fault messages and their codes that do not depend on any resource.
+
array
+
+
+
resourceFaults(sessionId, resourceName)
+
Return a list of the specified resource fault messages, if this resource is allowed in the current session.
+
array
+
+
+
+
Note: For call and multiCall, if no session is specified, you can call only resources that are not protected by ACL.
+
+
Note: For multiCall, if the "break" option is specified, multiCall breaks on first error.
+
+
The Magento SOAP API v2 does not support the call() and multiCall() methods, and instead provides a separate method for each API resource.
+
+
Global API Faults
+
+
The following table contains fault codes that apply to all SOAP/XML-RPC API calls.
+
+
+
+
Fault Code
+
Fault Message
+
+
+
0
+
Unknown Error
+
+
+
1
+
Internal Error. Please see log for details.
+
+
+
2
+
Access denied.
+
+
+
3
+
Invalid API path.
+
+
+
4
+
Resource path is not callable.
+
+
+
+
+
SOAP API Version v2
+
+
Since Magento 1.3, version v2 of the SOAP API has also been available. The main difference between v1 and v2 is that instead of using methods call and multiCall, it has separate methods for each action.
+
+
For example, consider the following PHP code using SOAP v1.
Note that the WSDL for SOAP v1 and SOAP v2 are different. Note that in SOAP v1, customizing the API did not involve changing the WSDL. In SOAP v2, changes to the WSDL are required.
+
+
You can configure the SOAP v2 API to be WS-I compliant in the system configuration menu. To do this, set Services > Magento Core API > WS-I Compliance to Yes.
+
+
Note that the WSDL for the SOAP v2 API is different when in WS-I compliant mode.
+
+
Using the WS-I compliant SOAP v2 API WSDL, it is easy to automatically generate client classes for Java, .NET, and other languages using standard libraries.
+
+
+
diff --git a/guides/v19.x/api/soap/miscellaneous/magento.info.html b/guides/v19.x/api/soap/miscellaneous/magento.info.html
new file mode 100644
index 0000000000..655ef33b39
--- /dev/null
+++ b/guides/v19.x/api/soap/miscellaneous/magento.info.html
@@ -0,0 +1,118 @@
+---
+layout: v1x_soap
+title: Magento Info
+---
+
+
Magento Info API
+
+
Allows you to get information about the current Magento installation.
+
+
Module: Mage_Core
+
+
Resource: core_magento
+
+
Aliases: magento
+
+
+
Method:
+
+
+
core_magento.info (SOAP V1)
+
magentoInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about Magento version and edition.
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/miscellaneous/store.info.html b/guides/v19.x/api/soap/miscellaneous/store.info.html
new file mode 100644
index 0000000000..dfc6594d01
--- /dev/null
+++ b/guides/v19.x/api/soap/miscellaneous/store.info.html
@@ -0,0 +1,182 @@
+---
+layout: v1x_soap
+title: Store Info
+---
+
+
Module: Store View API
+
+
Resource: store
+
+
Method:
+
+
+
store.info (SOAP V1)
+
storeInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the required store view.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
storeId
+
Store view ID or code (optional)
+
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of storeEntity
+
+
+
+
+
The storeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
store_id
+
Store view ID
+
+
+
string
+
code
+
Store view code
+
+
+
int
+
website_id
+
Website ID
+
+
+
int
+
group_id
+
Group ID
+
+
+
string
+
name
+
Store name
+
+
+
int
+
sort_order
+
Store view sort order
+
+
+
int
+
is_active
+
Defines whether the store is active
+
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
101
+
Requested store view not found.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'store.info', '2');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->storeInfo($sessionId, '2');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/miscellaneous/store.list.html b/guides/v19.x/api/soap/miscellaneous/store.list.html
new file mode 100644
index 0000000000..703afd15dc
--- /dev/null
+++ b/guides/v19.x/api/soap/miscellaneous/store.list.html
@@ -0,0 +1,174 @@
+---
+layout: v1x_soap
+title: Store List
+---
+
+
Module: Store View API
+
+
Resource: store
+
+
Method:
+
+
+
store.list (SOAP V1)
+
storeList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of store views.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of storeEntity
+
+
+
+
+
The storeEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
store_id
+
Store view ID
+
+
+
string
+
code
+
Store view code
+
+
+
int
+
website_id
+
Website ID
+
+
+
int
+
group_id
+
Group ID
+
+
+
string
+
name
+
Store view name
+
+
+
int
+
sort_order
+
Store view sort order
+
+
+
int
+
is_active
+
Defines whether the store is active
+
+
+
+
+
Faults:
+No Faults
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'store.list');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->storeList($sessionId);
+var_dump($result);
Order status not changed. Details in error message.
+
+
+
+
+
Examples
+
+
Example 1. Work with orders
+
+
+
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+
+// Getting list of orders created by John Doe
+var_dump($proxy->call($sessionId, 'sales_order.list', array(array('customer_firstname'=>array('eq'=>'John'), 'customer_lastname'=>array('eq'=>'Doe')))));
+
+
+// Get order info 100000003
+var_dump($proxy->call($sessionId, 'sales_order.info', '100000003'));
+
+
+// Hold order 100000003
+$proxy->call($sessionId, 'sales_order.hold', '100000003');
+
+// Unhold order 100000003
+$proxy->call($sessionId, 'sales_order.unhold', '100000003');
+
+// Hold order and add comment 100000003
+$proxy->call($sessionId, 'sales_order.addComment', array('100000003', 'holded', 'You order is holded', true));
+
+// Unhold order and add comment 100000003
+$proxy->call($sessionId, 'sales_order.addComment', array('100000003', 'pending', 'You order is pending', true));
+
+// Get order info 100000003
+var_dump($proxy->call($sessionId, 'sales_order.info', '100000003'));
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.addComment', array('orderIncrementId' => '200000004', 'status' => 'processing'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderAddComment($sessionId, '200000004', 'processing');
+var_dump($result);
+
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrder/sales_order.cancel.html b/guides/v19.x/api/soap/sales/salesOrder/sales_order.cancel.html
new file mode 100644
index 0000000000..99ef601ea3
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrder/sales_order.cancel.html
@@ -0,0 +1,116 @@
+---
+layout: v1x_soap
+title: Order Cancel
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.cancel (SOAP V1)
+
salesOrderCancel (SOAP V2)
+
+
+
+
Allows you to cancel the required order.
+
+
Aliases:
+
+
order.cancel
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the order is canceled
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.cancel', '200000004');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderCancel($sessionId, '200000004');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrder/sales_order.hold.html b/guides/v19.x/api/soap/sales/salesOrder/sales_order.hold.html
new file mode 100644
index 0000000000..353463c413
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrder/sales_order.hold.html
@@ -0,0 +1,118 @@
+---
+layout: v1x_soap
+title: Order Hold
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.hold (SOAP V1)
+
salesOrderHold (SOAP V2)
+
+
+
+
Allows you to place the required order on hold.
+
+
Aliases:
+
+
order.hold
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the order is placed on hold
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.hold', '200000006');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderHold($sessionId, '200000006');
+var_dump($result);
+
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrder/sales_order.info.html b/guides/v19.x/api/soap/sales/salesOrder/sales_order.info.html
new file mode 100644
index 0000000000..6eb5143620
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrder/sales_order.info.html
@@ -0,0 +1,1188 @@
+---
+layout: v1x_soap
+title: Order Info
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.info (SOAP V1)
+
salesOrderInfo (SOAP V2)
+
+
+
+
Allows you to retrieve the required order information.
+
+
Aliases:
+
+
order.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderEntity
+
+
+
+
+
The salesOrderEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Defines whether the order is active
+
+
+
string
+
customer_id
+
Customer ID
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
subtotal
+
Subtotal sum
+
+
+
string
+
grand_total
+
Grand total sum
+
+
+
string
+
total_paid
+
Total paid
+
+
+
string
+
total_refunded
+
Total refunded
+
+
+
string
+
total_qty_ordered
+
Total quantity ordered
+
+
+
string
+
total_canceled
+
Total canceled
+
+
+
string
+
total_invoiced
+
Total invoiced
+
+
+
string
+
total_online_refunded
+
Total online refunded
+
+
+
string
+
total_offline_refunded
+
Total offline refunded
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
base_subtotal
+
Base subtotal
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
base_total_paid
+
Base total paid
+
+
+
string
+
base_total_refunded
+
Base total refunded
+
+
+
string
+
base_total_qty_ordered
+
Base total quantity ordered
+
+
+
string
+
base_total_canceled
+
Base total canceled
+
+
+
string
+
base_total_invoiced
+
Base total invoiced
+
+
+
string
+
base_total_online_refunded
+
Base total online refunded
+
+
+
string
+
base_total_offline_refunded
+
Base total offline refunded
+
+
+
string
+
billing_address_id
+
Billing address ID
+
+
+
string
+
billing_firstname
+
First name in the billing address
+
+
+
string
+
billing_lastname
+
Last name in the billing address
+
+
+
string
+
shipping_address_id
+
Shipping address ID
+
+
+
string
+
shipping_firstname
+
First name in the shipping address
+
+
+
string
+
shipping_lastname
+
Last name in the shipping address
+
+
+
string
+
billing_name
+
Billing name
+
+
+
string
+
shipping_name
+
Shipping name
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
store_to_order_rate
+
Store to order rate
+
+
+
string
+
base_to_global_rate
+
Base to global rate
+
+
+
string
+
base_to_order_rate
+
Base to order rate
+
+
+
string
+
weight
+
Weight
+
+
+
string
+
store_name
+
Store name
+
+
+
string
+
remote_ip
+
Remote IP
+
+
+
string
+
status
+
Order status
+
+
+
string
+
state
+
Order state
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
order_currency_code
+
Order currency code
+
+
+
string
+
shipping_method
+
Shipping method
+
+
+
string
+
shipping_description
+
Shipping description
+
+
+
string
+
customer_email
+
Email address of the customer
+
+
+
string
+
customer_firstname
+
Customer first name
+
+
+
string
+
customer_lastname
+
Customer last name
+
+
+
string
+
quote_id
+
Shopping cart ID
+
+
+
string
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
customer_note_notify
+
Customer notification
+
+
+
string
+
customer_is_guest
+
Defines whether the customer is a guest
+
+
+
string
+
email_sent
+
Defines whether the email notification is sent
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
array
+
shipping_address
+
Array of salesOrderAddressEntity
+
+
+
array
+
billing_address
+
Array of salesOrderAddressEntity
+
+
+
array
+
items
+
Array of salesOrderItemEntity
+
+
+
array
+
payment
+
Array of salesOrderPaymentEntity
+
+
+
array
+
status_history
+
Array of salesOrderStatusHistoryEntity
+
+
+
+
+
The salesOrderAddressEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Defines whether the address is active
+
+
+
string
+
address_type
+
Address type
+
+
+
string
+
firstname
+
First name
+
+
+
string
+
lastname
+
Last name
+
+
+
string
+
company
+
Company name
+
+
+
string
+
street
+
Street name
+
+
+
string
+
city
+
City
+
+
+
string
+
region
+
Region
+
+
+
string
+
postcode
+
Post code
+
+
+
string
+
country_id
+
Country ID
+
+
+
string
+
telephone
+
Telephone number
+
+
+
string
+
fax
+
Fax number
+
+
+
string
+
region_id
+
Region ID
+
+
+
string
+
address_id
+
Address ID
+
+
+
+
+
The salesOrderItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
item_id
+
Item ID
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
quote_item_id
+
Shopping cart item ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
product_type
+
Product type
+
+
+
string
+
product_options
+
Product options
+
+
+
string
+
weight
+
Weight
+
+
+
string
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
string
+
sku
+
Product SKU
+
+
+
string
+
name
+
Product name
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
free_shipping
+
Defines whether free shipping is applied
+
+
+
string
+
is_qty_decimal
+
Defines whether the items quantity is decimal
+
+
+
string
+
no_discount
+
Defines whether no discount is applied
+
+
+
string
+
qty_canceled
+
Items quantity canceled
+
+
+
string
+
qty_invoiced
+
Items quantity invoiced
+
+
+
string
+
qty_ordered
+
Items quantity ordered
+
+
+
string
+
qty_refunded
+
Items quantity refunded
+
+
+
string
+
qty_shipped
+
Items quantity shipped
+
+
+
string
+
cost
+
Cost
+
+
+
string
+
price
+
Price
+
+
+
string
+
base_price
+
Base price
+
+
+
string
+
original_price
+
Original price
+
+
+
string
+
base_original_price
+
Base original price
+
+
+
string
+
tax_percent
+
Tax percent
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
tax_invoiced
+
Tax invoiced
+
+
+
string
+
base_tax_invoiced
+
Base tax invoiced
+
+
+
string
+
discount_percent
+
Discount percent
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
discount_invoiced
+
Discount invoiced
+
+
+
string
+
base_discount_invoiced
+
Base discount invoiced
+
+
+
string
+
amount_refunded
+
Amount refunded
+
+
+
string
+
base_amount_refunded
+
Base amount refunded
+
+
+
string
+
row_total
+
Row total
+
+
+
string
+
base_row_total
+
Base row total
+
+
+
string
+
row_invoiced
+
Row invoiced
+
+
+
string
+
base_row_invoiced
+
Base row invoiced
+
+
+
string
+
row_weight
+
Row weight
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
string
+
gift_message_available
+
Defines whether the gift message is available
+
+
+
string
+
base_tax_before_discount
+
Base tax before discount
+
+
+
string
+
tax_before_discount
+
Tax before discount
+
+
+
string
+
weee_tax_applied
+
Applied fixed product tax
+
+
+
string
+
weee_tax_applied_amount
+
Applied fixed product tax amount
+
+
+
string
+
weee_tax_applied_row_amount
+
Applied fixed product tax row amount
+
+
+
string
+
base_weee_tax_applied_amount
+
Applied fixed product tax amount (in base currency)
+
+
+
string
+
base_weee_tax_applied_row_amount
+
Applied fixed product tax row amount (in base currency)
+
+
+
string
+
weee_tax_disposition
+
Fixed product tax disposition
+
+
+
string
+
weee_tax_row_disposition
+
Fixed product tax row disposition
+
+
+
string
+
base_weee_tax_disposition
+
Fixed product tax disposition (in base currency)
+
+
+
string
+
base_weee_tax_row_disposition
+
Fixed product tax row disposition (in base currency)
+
+
+
+
+
The salesOrderPaymentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Active flag
+
+
+
string
+
amount_ordered
+
Amount ordered
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
base_amount_ordered
+
Base amount ordered
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
method
+
Payment method
+
+
+
string
+
po_number
+
Purchase order number
+
+
+
string
+
cc_type
+
Credit card type
+
+
+
string
+
cc_number_enc
+
Credit card number
+
+
+
string
+
cc_last4
+
Credit card last 4 digits
+
+
+
string
+
cc_owner
+
Credit card owner
+
+
+
string
+
cc_exp_month
+
Credit card expiration month
+
+
+
string
+
cc_exp_year
+
Credit card expiration year
+
+
+
string
+
cc_ss_start_month
+
Credit card start month (Switch/Solo)
+
+
+
string
+
cc_ss_start_year
+
Credit card start year (Switch/Solo)
+
+
+
string
+
payment_id
+
Payment ID
+
+
+
+
+
The salesOrderStatusHistoryEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Active flag
+
+
+
string
+
is_customer_notified
+
Defines whether the customer is notified
+
+
+
string
+
status
+
Order status
+
+
+
string
+
comment
+
Order comment
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.info', 'orderIncrementId');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderInfo($sessionId, '200000006');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrder/sales_order.list.html b/guides/v19.x/api/soap/sales/salesOrder/sales_order.list.html
new file mode 100644
index 0000000000..69a577c92c
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrder/sales_order.list.html
@@ -0,0 +1,550 @@
+---
+layout: v1x_soap
+title: Order List
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.list (SOAP V1)
+
salesOrderList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of orders. Additional filters can be applied.
+
+
Aliases:
+
+
order.list
+
salesOrderList (SOAP V2 method name)
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters for the list of sales orders (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
name
+
Description
+
+
+
array
+
result
+
Array of salesOrderEntity
+
+
+
+
+
The salesOrderEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Defines whether the order is active
+
+
+
string
+
customer_id
+
Customer ID
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
subtotal
+
Subtotal sum
+
+
+
string
+
grand_total
+
Grand total sum
+
+
+
string
+
total_paid
+
Total paid
+
+
+
string
+
total_refunded
+
Total refunded
+
+
+
string
+
total_qty_ordered
+
Total quantity ordered
+
+
+
string
+
total_canceled
+
Total canceled
+
+
+
string
+
total_invoiced
+
Total invoiced
+
+
+
string
+
total_online_refunded
+
Total online refunded
+
+
+
string
+
total_offline_refunded
+
Total offline refunded
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
base_subtotal
+
Base subtotal
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
base_total_paid
+
Base total paid
+
+
+
string
+
base_total_refunded
+
Base total refunded
+
+
+
string
+
base_total_qty_ordered
+
Base total quantity ordered
+
+
+
string
+
base_total_canceled
+
Base total canceled
+
+
+
string
+
base_total_invoiced
+
Base total invoiced
+
+
+
string
+
base_total_online_refunded
+
Base total online refunded
+
+
+
string
+
base_total_offline_refunded
+
Base total offline refunded
+
+
+
string
+
billing_address_id
+
Billing address ID
+
+
+
string
+
billing_firstname
+
First name in the billing address
+
+
+
string
+
billing_lastname
+
Last name in the billing address
+
+
+
string
+
shipping_address_id
+
Shipping address ID
+
+
+
string
+
shipping_firstname
+
First name in the shipping address
+
+
+
string
+
shipping_lastname
+
Last name in the shipping address
+
+
+
string
+
billing_name
+
Billing name
+
+
+
string
+
shipping_name
+
Shipping name
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
store_to_order_rate
+
Store to order rate
+
+
+
string
+
base_to_global_rate
+
Base to global rate
+
+
+
string
+
base_to_order_rate
+
Base to order rate
+
+
+
string
+
weight
+
Weight
+
+
+
string
+
store_name
+
Store name
+
+
+
string
+
remote_ip
+
Remote IP
+
+
+
string
+
status
+
Order status
+
+
+
string
+
state
+
Order state
+
+
+
string
+
applied_rule_ids
+
Applied rule IDs
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
order_currency_code
+
Order currency code
+
+
+
string
+
shipping_method
+
Shipping method
+
+
+
string
+
shipping_description
+
Shipping description
+
+
+
string
+
customer_email
+
Email address of the customer
+
+
+
string
+
customer_firstname
+
Customer first name
+
+
+
string
+
customer_lastname
+
Customer last name
+
+
+
string
+
quote_id
+
Shopping cart ID
+
+
+
string
+
is_virtual
+
Defines whether the product is a virtual one
+
+
+
string
+
customer_group_id
+
Customer group ID
+
+
+
string
+
customer_note_notify
+
Customer notification
+
+
+
string
+
customer_is_guest
+
Defines whether the customer is a guest
+
+
+
string
+
email_sent
+
Defines whether the email notification is sent
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
gift_message_id
+
Gift message ID
+
+
+
string
+
gift_message
+
Gift message
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'order.list');
+var_dump ($result);
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrder/sales_order.unhold.html b/guides/v19.x/api/soap/sales/salesOrder/sales_order.unhold.html
new file mode 100644
index 0000000000..8478c17833
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrder/sales_order.unhold.html
@@ -0,0 +1,112 @@
+---
+layout: v1x_soap
+title: Order Unhold
+---
+
+
Module: Mage_Sales
+
+
Resource: sales_order
+
+
Aliases:
+
+
order
+
+
+
+
Method:
+
+
+
sales_order.unhold (SOAP V1)
+
salesOrderUnhold (SOAP V2)
+
+
+
+
Allows you to unhold the required order.
+
+
Aliases:
+
+
order.unhold
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the order is unheld
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order.unhold', '200000006');
+var_dump($result);
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
+$sessionId = $proxy->login('apiUser', 'apiKey');
+$creditmemoIncrementId = '100000637'; //increment id of existing credit memo
+
+$isCreditMemoCanceled = $proxy->call($sessionId, 'order_creditmemo.cancel', array($creditmemoIncrementId));
+
+
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.create.html b/guides/v19.x/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.create.html
new file mode 100644
index 0000000000..5d80c9fea8
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.create.html
@@ -0,0 +1,219 @@
+---
+layout: v1x_soap
+title: Memo Create
+---
+
+
Module: Order Credit Memo API
+
+
Resource: sales_order_creditmemo
+
+
Aliases: order_creditmemo
+
+
Method:
+
+
+
order_creditmemo.create (SOAP V1)
+
salesOrderCreditmemoCreate (SOAP V2)
+
+
+
+
Allows you to create a new credit memo for the invoiced order. Comments can be added and an email notification can be sent to the user email.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
array
+
creditmemoData
+
Array of salesOrderCreditmemoData (optional)
+
+
+
string
+
comment
+
Comment text (optional)
+
+
+
int
+
notifyCustomer
+
Notify customer by email flag (optional)
+
+
+
int
+
includeComment
+
Include comment text into an email notification (optional)
+
+
+
string
+
refundToStoreCreditAmount
+
Payment amount to be refunded to the customer store credit (optional)
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
result
+
Created credit memo increment ID
+
+
+
+
+
The salesOrderCreditmemoData content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
qtys
+
Array of orderItemIdQty
+
+
+
double
+
shipping_amount
+
Refund shipping amount (optional)
+
+
+
double
+
adjustment_positive
+
Adjustment refund amount (optional)
+
+
+
double
+
adjustment_negative
+
Adjustment fee amount (optional)
+
+
+
+
+
The orderItemIdQty content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
order_item_id
+
Order item ID to be refunded
+
+
+
double
+
qty
+
Items quantity to be refunded
+
+
+
+
+
Faults:
+
+
+
+
+
Fault Code
+
Fault Message
+
+
+
102
+
Invalid data given. Details in error message.
+
+
+
103
+
Requested order does not exist.
+
+
+
105
+
Money can not be refunded to the store credit account as order was created by guest.
+
+
+
106
+
Credit memo for requested order can not be created.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'order_creditmemo.create', '200000010');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderCreditmemoCreate($sessionId, '200000010');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.info.html b/guides/v19.x/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.info.html
new file mode 100644
index 0000000000..bfeb02b90d
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrderCreditMemo/sales_order_creditmemo.info.html
@@ -0,0 +1,885 @@
+---
+layout: v1x_soap
+title: Memo Info
+---
+
+
Module: Order Credit Memo API
+
+
Resource: sales_order_creditmemo
+
+
Aliases: order_creditmemo
+
+
+
Method:
+
+
+
order_creditmemo.info (SOAP V1)
+
salesOrderCreditmemoInfo (SOAP V2)
+
+
+
+
Allows you to retrieve full information about the specified credit memo.
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
creditmemoIncrementId
+
Credit memo increment ID
+
+
+
+
+
Return:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderCreditmemoEntity
+
+
+
+
+
The salesOrderCreditmemoEntity content is as follows:
+
+
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
transaction_id
+
Transaction ID
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
order_currency_code
+
Order currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
cybersource_token
+
Cybersource token
+
+
+
string
+
invoice_id
+
ID of the invoice for which the credit memo was created
+
+
+
string
+
billing_address_id
+
Billing address ID
+
+
+
string
+
shipping_address_id
+
Shipping address ID
+
+
+
string
+
state
+
State
+
+
+
string
+
creditmemo_status
+
Credit memo status
+
+
+
string
+
email_sent
+
Defines whether the email is sent
+
+
+
string
+
order_id
+
ID of the order for which the credit memo was created
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
shipping_tax_amount
+
Shipping tax amount
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
base_adjustment_positive
+
Adjustment refund amount (using base currency)
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
adjustment
+
Adjustment
+
+
+
string
+
subtotal
+
Subtotal
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
base_subtotal
+
Base subtotal
+
+
+
string
+
base_adjustment
+
Base adjustment
+
+
+
string
+
base_to_global_rate
+
Base to global rate
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
adjustment_negative
+
Adjustment fee amount
+
+
+
string
+
subtotal_incl_tax
+
Subtotal including tax
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
base_subtotal_incl_tax
+
Base subtotal including tax
+
+
+
string
+
base_adjustment_negative
+
Adjustment fee amount (using base currency)
+
+
+
string
+
grand_total
+
Grand total
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
base_to_order_rate
+
Base to order rate
+
+
+
string
+
store_to_order_rate
+
Store to order rate
+
+
+
string
+
base_shipping_tax_amount
+
Base shipping tax amount
+
+
+
string
+
adjustment_positive
+
Adjustment refund amount
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
hidden_tax_amount
+
Hidden tax amount
+
+
+
string
+
base_hidden_tax_amount
+
Base hidden tax amount
+
+
+
string
+
shipping_hidden_tax_amount
+
Shipping hidden tax amount
+
+
+
string
+
base_shipping_hidden_tax_amnt
+
Base shipping hidden tax amount
+
+
+
string
+
shipping_incl_tax
+
Shipping including tax
+
+
+
string
+
base_shipping_incl_tax
+
Base shipping including tax
+
+
+
string
+
base_customer_balance_amount
+
Base customer balance amount
+
+
+
string
+
customer_balance_amount
+
Customer balance amount
+
+
+
string
+
bs_customer_bal_total_refunded
+
Refunded base customer balance amount
+
+
+
string
+
customer_bal_total_refunded
+
Customer balance total refunded
+
+
+
string
+
base_gift_cards_amount
+
Base gift cards amount
+
+
+
string
+
gift_cards_amount
+
Gift cards amount
+
+
+
string
+
gw_base_price
+
Gift wrapping price refunded amount (using base currency)
+
+
+
string
+
gw_price
+
Gift wrapping price refunded amount
+
+
+
string
+
gw_items_base_price
+
Gift wrapping items base price
+
+
+
string
+
gw_items_price
+
Gift wrapping items price
+
+
+
string
+
gw_card_base_price
+
Gift wrapping card base price
+
+
+
string
+
gw_card_price
+
Gift wrapping card price
+
+
+
string
+
gw_base_tax_amount
+
Gift wrapping tax amount refunded (using base currency)
+
+
+
string
+
gw_tax_amount
+
Gift wrapping tax amount refunded
+
+
+
string
+
gw_items_base_tax_amount
+
Gift wrapping items base tax amount
+
+
+
string
+
gw_items_tax_amount
+
Gift wrapping items tax amount
+
+
+
string
+
gw_card_base_tax_amount
+
Gift wrapping card base tax amount
+
+
+
string
+
gw_card_tax_amount
+
Gift wrapping card tax amount
+
+
+
string
+
base_reward_currency_amount
+
Base reward currency amount
+
+
+
string
+
reward_currency_amount
+
Reward currency amount
+
+
+
string
+
reward_points_balance
+
Reward points balance
+
+
+
string
+
reward_points_balance_refund
+
Reward points balance refund
+
+
+
string
+
creditmemo_id
+
Credit memo ID
+
+
+
array
+
items
+
Array of salesOrderCreditmemoItemEntity
+
+
+
array
+
comments
+
Array of salesOrderCreditmemoCommentEntity
+
+
+
+
+
+
The salesOrderCreditmemoItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
item_id
+
Credit memo item ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
weee_tax_applied_row_amount
+
Applied fixed product tax row amount
+
+
+
string
+
base_price
+
Base price
+
+
+
string
+
base_weee_tax_row_disposition
+
Fixed product tax row disposition (in base currency)
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
base_weee_tax_applied_amount
+
Applied fixed product tax amount (in base currency)
+
+
+
string
+
weee_tax_row_disposition
+
Fixed product tax row disposition
+
+
+
string
+
base_row_total
+
Base row total
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
row_total
+
Row total
+
+
+
string
+
weee_tax_applied_amount
+
Applied fixed product tax amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
base_weee_tax_disposition
+
Fixed product tax disposition (in base currency)
+
+
+
string
+
price_incl_tax
+
Price including tax
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
weee_tax_disposition
+
Fixed product tax disposition
+
+
+
string
+
base_price_incl_tax
+
Base price including tax
+
+
+
string
+
qty
+
Quantity
+
+
+
string
+
base_cost
+
Base cost
+
+
+
string
+
base_weee_tax_applied_row_amount
+
Applied fixed product tax row amount (in base currency)
+
+
+
string
+
price
+
Price
+
+
+
string
+
base_row_total_incl_tax
+
Base row total including tax
+
+
+
string
+
row_total_incl_tax
+
Row total including tax
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
order_item_id
+
Order item ID
+
+
+
string
+
additional_data
+
Additional data
+
+
+
string
+
description
+
Description
+
+
+
string
+
weee_tax_applied
+
Applied fixed product tax
+
+
+
string
+
sku
+
Item SKU
+
+
+
string
+
name
+
Name
+
+
+
string
+
hidden_tax_amount
+
Hidden tax amount
+
+
+
string
+
base_hidden_tax_amount
+
Base hidden tax amount
+
+
+
+
+
The salesOrderCreditmemoCommentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
comment
+
Comment data
+
+
+
string
+
is_customer_notified
+
Defines whether the customer is notified
+
+
+
string
+
comment_id
+
Comment ID
+
+
+
string
+
is_visible_on_front
+
Defines whether the comment is visible on the frontend
+
+
+
+
+
Faults:
+
+
+
+
Fault Code
+
Fault Description
+
+
+
100
+
Requested credit memo does not exist.
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'order_creditmemo.info', '200000001');
+var_dump ($result);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderCreditmemoInfo($sessionId, '200000001');
+var_dump($result);
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.addComment.html b/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.addComment.html
new file mode 100644
index 0000000000..f87f898111
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.addComment.html
@@ -0,0 +1,130 @@
+---
+layout: v1x_soap
+title: Add Comment
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_invoice
+
+
Aliases:
+
+
order_invoice
+
+
+
+
Method:
+
+
+
sales_order_invoice.addComment (SOAP V1)
+
salesOrderInvoiceAddComment (SOAP V2)
+
+
+
+
Allows you to add a new comment to the order invoice.
+
+
Aliases:
+
+
order_invoice.addComment
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
invoiceIncrementId
+
Invoice increment ID
+
+
+
string
+
comment
+
Invoice comment (optional)
+
+
+
int
+
email
+
Send invoice on email flag (optional)
+
+
+
int
+
includeComment
+
Include comment in email flag (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean
+
True if the comment is added to the invoice
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apikey');
+
+$result = $client->call($session, 'sales_order_invoice.addComment', array('invoiceIncrementId' => '200000006', 'comment' => 'invoice comment'));
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderInvoiceAddComment($sessionId, '200000006');
+var_dump($result);
Allows you to cancel the required invoice. Note that not all order invoices can be canceled. Only some payment methods support canceling the order invoice (e.g., Google Checkout, PayPal Pro, PayPal Express Checkout).
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.capture.html b/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.capture.html
new file mode 100644
index 0000000000..a50888029b
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.capture.html
@@ -0,0 +1,156 @@
+---
+layout: v1x_soap
+title: Invoice Capture
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_invoice
+
+
Aliases:
+
+
order_invoice
+
+
+
+
Method:
+
+
+
sales_order_invoice.capture (SOAP V1)
+
salesOrderInvoiceCapture (SOAP V2)
+
+
+
+
Allows you to capture the required invoice. Note that not all order invoices can be captured. Only some payment methods support capturing the order invoice (e.g., PayPal Pro).
+
+
Aliases:
+
+
order_invoice.capture
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
invoiceIncrementId
+
Invoice increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the order invoice is captured.
+
+
+
+
+
+
Notes:
+
+
You should check the invoice to see if it can be captured before attempting to capture the invoice. Otherwise, the API call will generate an error.
+
+
Invoices have states as defined in the model Mage_Sales_Model_Order_Invoice:
+
+
STATE_OPEN = 1
+
STATE_PAID = 2
+
STATE_CANCELED = 3
+
+
+
+
Also note that there is a method call in the model that checks this for you - canCapture(). And it also verifies that the payment can be captured, so the invoice state might not be the only condition that is required to allow it to be captured.
Array of orderItemIdQty (quantity of items to invoice)
+
+
+
string
+
comment
+
Invoice comment (optional)
+
+
+
string
+
email
+
Send invoice on email (optional)
+
+
+
string
+
includeComment
+
Include comments in email (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
string
+
ID of the created invoice
+
+
+
+
+
The orderItemIdQty content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
int
+
order_item_id
+
Order item ID
+
+
+
double
+
qty
+
Quantity
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call(
+ $session,
+ 'sales_order_invoice.create',
+ array('orderIncrementId' => '200000008', array('15' => '1', '16' => '1'))
+ // orderItemIdQty Array is Keyed with Order Item ID, with Value of qty to invoice
+);
+var_dump ($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+//Create invoice for order
+
+// orderItemIdQty Array is Keyed with Order Item ID, with Value of qty to invoice
+$qty = array('15' => '1', '16' => '1');
+
+$invoiceIncrementId = $proxy->salesOrderInvoiceCreate(
+ $sessionID,
+ '200000008',
+ Â $qty
+);
+var_dump($invoiceIncrementId);
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.info.html b/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.info.html
new file mode 100644
index 0000000000..22dba68cfe
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.info.html
@@ -0,0 +1,589 @@
+---
+layout: v1x_soap
+title: Invoice Info
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_invoice
+
+
Aliases:
+
+
order_invoice
+
+
+
+
Method:
+
+
+
sales_order_invoice.info (SOAP V1)
+
salesOrderInvoiceInfo (SOAP V2)
+
+
+
+
Allows you to retrieve information about the required invoice.
+
+
Aliases:
+
+
order_invoice.info
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
invoiceIncrementId
+
Invoice increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderInvoiceEntity
+
+
+
+
+
The salesOrderInvoiceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
store_id
+
Store ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Defines whether the invoice is active
+
+
+
string
+
global_currency_code
+
Global currency code
+
+
+
string
+
base_currency_code
+
Base currency code
+
+
+
string
+
store_currency_code
+
Store currency code
+
+
+
string
+
order_currency_code
+
Order currency code
+
+
+
string
+
store_to_base_rate
+
Store to base rate
+
+
+
string
+
store_to_order_rate
+
Store to order rate
+
+
+
string
+
base_to_global_rate
+
Base to global rate
+
+
+
string
+
base_to_order_rate
+
Base to order rate
+
+
+
string
+
subtotal
+
Subtotal
+
+
+
string
+
base_subtotal
+
Base subtotal
+
+
+
string
+
base_grand_total
+
Base grand total
+
+
+
string
+
discount_amount
+
Discount amount
+
+
+
string
+
base_discount_amount
+
Base discount amount
+
+
+
string
+
shipping_amount
+
Shipping amount
+
+
+
string
+
base_shipping_amount
+
Base shipping amount
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
billing_address_id
+
Billing address ID
+
+
+
string
+
billing_firstname
+
First name in the billing address
+
+
+
string
+
billing_lastname
+
Last name in the billing address
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
order_increment_id
+
Order increment ID
+
+
+
string
+
order_created_at
+
Date of order creation
+
+
+
string
+
state
+
Order state
+
+
+
string
+
grand_total
+
Grand total
+
+
+
string
+
invoice_id
+
Invoice ID
+
+
+
array
+
items
+
Array of salesOrderInvoiceItemEntity
+
+
+
array
+
comments
+
Array of salesOrderInvoiceCommentEntity
+
+
+
+
+
The salesOrderInvoiceItemEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Active flag
+
+
+
string
+
weee_tax_applied
+
Applied fixed product tax
+
+
+
string
+
qty
+
Quantity
+
+
+
string
+
cost
+
Cost
+
+
+
string
+
price
+
Price
+
+
+
string
+
tax_amount
+
Tax amount
+
+
+
string
+
row_total
+
Row total
+
+
+
string
+
base_price
+
Base price
+
+
+
string
+
base_tax_amount
+
Base tax amount
+
+
+
string
+
base_row_total
+
Base row total
+
+
+
string
+
base_weee_tax_applied_amount
+
Applied fixed product tax amount (in base currency)
+
+
+
string
+
base_weee_tax_applied_row_amount
+
Applied fixed product tax row amount (in base currency)
+
+
+
string
+
weee_tax_applied_amount
+
Applied fixed product tax amount
+
+
+
string
+
weee_tax_applied_row_amount
+
Applied fixed product tax row amount
+
+
+
string
+
weee_tax_disposition
+
Fixed product tax disposition
+
+
+
string
+
weee_tax_row_disposition
+
Fixed product tax row disposition
+
+
+
string
+
base_weee_tax_disposition
+
Fixed product tax disposition (in base currency)
+
+
+
string
+
base_weee_tax_row_disposition
+
Fixed product tax row disposition (in base currency)
+
+
+
string
+
sku
+
SKU
+
+
+
string
+
name
+
Name
+
+
+
string
+
order_item_id
+
Order item ID
+
+
+
string
+
product_id
+
Product ID
+
+
+
string
+
item_id
+
Item ID
+
+
+
+
+
The salesOrderInvoiceCommentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
parent_id
+
Parent ID
+
+
+
string
+
created_at
+
Date of creation
+
+
+
string
+
updated_at
+
Date of updating
+
+
+
string
+
is_active
+
Active flag
+
+
+
string
+
comment
+
Invoice comment
+
+
+
string
+
is_customer_notified
+
Defines whether the customer is notified
+
+
+
string
+
comment_id
+
Comment ID
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_invoice.info', '200000006');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderInvoiceInfo($sessionId, '200000006');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.list.html b/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.list.html
new file mode 100644
index 0000000000..6ba966bcaa
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrderInvoice/sales_order_invoice.list.html
@@ -0,0 +1,214 @@
+---
+layout: v1x_soap
+title: Invoice List
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_invoice
+
+
Aliases:
+
+
order_invoice
+
+
+
+
Method:
+
+
+
sales_order_invoice.list (SOAP V1)
+
salesOrderInvoiceList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of order invoices. Additional filters can also be applied.
+
+
Aliases:
+
+
order_invoice.list
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters for the list of invoices (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderInvoiceEntity
+
+
+
+
+
The salesOrderInvoiceEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
created_at
+
Date of invoice creation
+
+
+
string
+
order_currency_code
+
Order currency code (e.g., EUR)
+
+
+
string
+
order_id
+
Order ID
+
+
+
string
+
state
+
Order state
+
+
+
string
+
grand_total
+
Grand total amount invoiced
+
+
+
string
+
invoice_id
+
Invoice ID
+
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_invoice.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2 (List of All Invoices)
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderInvoiceList($sessionId);
+var_dump($result);
+
+
+
+
Request Example SOAP V2 (Complex Filter)
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$complexFilter = array(
+ 'complex_filter' => array(
+ array(
+ 'key' => 'state',
+ 'value' => array('key' => 'in', 'value' => '2,3')
+ )
+ )
+);
+$result = $client->salesOrderInvoiceList($session, $complexFilter);
+
+var_dump ($result);
+
+
+Create the Magento file system owner
diff --git a/guides/v19.x/api/soap/sales/salesOrderShipment/sales_order_shipment.addComment.html b/guides/v19.x/api/soap/sales/salesOrderShipment/sales_order_shipment.addComment.html
new file mode 100644
index 0000000000..c9cab4851a
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrderShipment/sales_order_shipment.addComment.html
@@ -0,0 +1,131 @@
+---
+layout: v1x_soap
+title: Shipment Add Comment
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_shipment
+
+
Aliases:
+
+
order_shipment
+
+
+
+
Method:
+
+
+
sales_order_shipment.addComment (SOAP V1)
+
salesOrderShipmentAddComment (SOAP V2)
+
+
+
+
Allows you to add a new comment to the order shipment.
+
+
Aliases:
+
+
order_shipment.addComment
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
shipmentIncrementId
+
Shipment increment ID
+
+
+
string
+
comment
+
Shipment comment (optional)
+
+
+
string
+
email
+
Send email flag (optional)
+
+
+
string
+
includeInEmail
+
Include comment in email flag (optional)
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the comment is added to the order shipment
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.addComment', array('shipmentIncrementId' => '200000002', 'comment' => 'comment for the shipment', 'email' => null));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentAddComment($sessionId, '200000002');
+var_dump($result);
Allows you to add a new tracking number to the order shipment.
+
+
Aliases:
+
+
order_shipment.addTrack
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
shipmentIncrementId
+
Shipment increment ID
+
+
+
string
+
carrier
+
Carrier code (ups, usps, dhl, fedex, or dhlint)
+
+
+
string
+
title
+
Tracking title
+
+
+
string
+
trackNumber
+
Tracking number
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
int
+
Tracking number ID
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.addTrack', array('shipmentIncrementId' => '200000002', 'carrier' => 'ups', 'title' => 'tracking title', 'trackNumber' => '123123'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentAddTrack($sessionId, '200000002', 'ups', 'tracking title', '123123');
+var_dump($result);
Allows you to retrieve the list of allowed carriers for an order.
+
+
Aliases:
+
+
order_shipment.getCarriers
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
orderIncrementId
+
Order increment ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
associativeArray
+
result
+
Array of carriers
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.getCarriers', '200000010');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentGetCarriers($sessionId, '200000010');
+var_dump($result);
+
+
diff --git a/guides/v19.x/api/soap/sales/salesOrderShipment/sales_order_shipment.list.html b/guides/v19.x/api/soap/sales/salesOrderShipment/sales_order_shipment.list.html
new file mode 100644
index 0000000000..14685a7e3d
--- /dev/null
+++ b/guides/v19.x/api/soap/sales/salesOrderShipment/sales_order_shipment.list.html
@@ -0,0 +1,193 @@
+---
+layout: v1x_soap
+title: Shipment List
+---
+
+
Module: Mage_Sales
+
+
+
Resource: sales_order_shipment
+
+
Aliases:
+
+
order_shipment
+
+
+
+
Method:
+
+
+
sales_order_shipment.list (SOAP V1)
+
salesOrderShipmentList (SOAP V2)
+
+
+
+
Allows you to retrieve the list of order shipments. Additional filters can be applied.
+
+
Aliases:
+
+
order_shipment.list
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
array
+
filters
+
Array of filters for the list of shipments
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Name
+
Description
+
+
+
array
+
result
+
Array of salesOrderShipmentEntity
+
+
+
+
+
The salesOrderShipmentEntity content is as follows:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
increment_id
+
Increment ID
+
+
+
string
+
created_at
+
Date of shipment creation
+
+
+
string
+
total_qty
+
Total quantity of items to ship
+
+
+
string
+
shipment_id
+
Shipment ID
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.list');
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2 (List of All Shipments)
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentList($sessionId);
+var_dump($result);
+
+
+
+
Request Example SOAP V2 (Complex Filter)
+
+
+
+
$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');
+
+// If some stuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+$complexFilter = array(
+ 'complex_filter' => array(
+ array(
+ 'key' => 'created_at',
+ 'value' => array('key' => 'in', 'value' => '2012-03-30 12:54:46')
+ )
+ )
+);
+$result = $client->salesOrderShipmentList($session, $complexFilter);
+
+var_dump ($result);
Allows you to remove a tracking number from the order shipment.
+
+
Aliases:
+
+
order_shipment.removeTrack
+
+
+
+
+
Arguments:
+
+
+
+
Type
+
Name
+
Description
+
+
+
string
+
sessionId
+
Session ID
+
+
+
string
+
shipmentIncrementId
+
Shipment increment ID
+
+
+
string
+
trackId
+
Track ID
+
+
+
+
+
Returns:
+
+
+
+
Type
+
Description
+
+
+
boolean\int
+
True (1) if the tracking number is removed from the shipment
+
+
+
+
+
+
Examples
+
+
Request Example SOAP V1
+
+
+
+
+
$client = new SoapClient('http://magentohost/api/soap/?wsdl');
+
+// If somestuff requires API authentication,
+// then get a session token
+$session = $client->login('apiUser', 'apiKey');
+
+$result = $client->call($session, 'sales_order_shipment.removeTrack', array('shipmentIncrementId' => '200000002', 'trackId' => '2'));
+var_dump($result);
+
+// If you don't need the session anymore
+//$client->endSession($session);
+
+
+
+
Request Example SOAP V2
+
+
+
+
+
$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
+$sessionId = $proxy->login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary
+
+$result = $proxy->salesOrderShipmentRemoveTrack($sessionId, '200000002', '2');
+var_dump($result);
Magento provides you with the ability to use two modes for SOAP API V2. These are with WS-I compliance mode enabled and WS-I compliance mode disabled. The first one was introduced to make the system flexible, namely, to increase compatibility with .NET and Java programming languages.
+
+
To enable/disable the WS-I compliance mode, perform the following steps:
+
+
In the Magento Admin Panel, go to System > Configuration > Magento Core API.
+
In the WS-I Compliance drop-down, select Yes to enable the WS-I compliance mode and No to disable the WS-I compliance mode, correspondingly.
+
+
+
+
+
The WS-I compliant mode uses the same WSDL endpoint as SOAP API V2 does. The key difference is that XML namespaces are used in WS-I compliance mode.
+
+
+
WSDL file with disabled WS-I compliance mode:
+
+
+
WSDL file with enabled WS-I compliance mode:
+
+
+
\ No newline at end of file
diff --git a/guides/v19.x/ce18-ee113-home.html b/guides/v19.x/ce18-ee113-home.html
new file mode 100644
index 0000000000..c1a8b54bf6
--- /dev/null
+++ b/guides/v19.x/ce18-ee113-home.html
@@ -0,0 +1,83 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento Community Edition (CE) 1.8 and Enterprise Edition (EE) 1.13 Documentation Home
+
+
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
+
Magento Community Edition (CE) 1.8 and Enterprise Edition (EE) 1.13 Documentation Home
Welcome to the documentation home page for the Magento Enterprise Edition (EE) 1.13 and Community Edition (CE) 1.8 releases! Let's start out by telling you a little bit about them.
+
Magento recognizes that merchants and systems integrators require higher performance in key areas—such as product search, product browsing, and checkout. Merchants and integrators are now commonly coming to Magento with:
+
Large databases (that is, more than one million products)
+
Heavy traffic volume
+
Frequent merchandising updates
+
Extensive marketing and promotion campaigns
+
Many web stores to address their customers' needs
+
To address these ever-growing needs, Magento systematically examined performance and scalability characteristics. Our engineers continually measured performance on a range of environments and use cases to identify and remove bottlenecks, and then conducted extensive testing to confirm improvements.
+
We characterized performance based on variations in deployment and business configurations to ensure improvement for a range of merchant sizes and configurations.
+
In this release, we focused primarily on improvements to indexing, tax calculations, caching, and checkout performance.
+
We're excited about the changes you'll find, including:
+
Reindexing (Enterprise Edition only):
+
Most indexing processes now run only to update products, categories, URL redirects, and so on that have changed—eliminating the need for manual full reindexing
+
Your Magento web store is not locked at any point during reindexing
+
Reindexing is now a background process.
+
+
Caching (Enterprise Edition only):
+
Full page caching now invalidates only pages that are affected by product or category changes
+
Improved cache adapter for single-host systems
+
Additional option of using Redis NoSQL for cache and session storage in multi-host deployments (recommended for new deployments)
The focus of the Magento Enterprise Edition 1.13 release is performance and scalability. The benchmarking results
+ presented here demonstrate that we have addressed the following concerns:
+
+
+
The eCommerce landscape is changing, and merchants must provide customers with an online shopping experience
+ that meets their performance expectations
+
+
As merchants grow their businesses and increasingly larger enterprise merchants are adopting Magento,
+ Magento Enterprise Edition must scale to handle increased traffic volume and larger catalogs
+
+
+
+
Magento's Plan
+
+
We identified the following areas for enhancement in Magento Enterprise Edition 1.13:
+
+
+
Improve indexing for catalogs of all sizes
+
Make re-indexing operations invisible to the shopper by executing them in the background
+
Improve full page caching support
+
Reduce page load times for key shopping flows (checkout)
+
Enable merchants to serve heavier traffic volume without need to purchase additional hardware
+
+
+
What Magento
+ Accomplished
+
+
Magento Enterprise Edition 1.13 delivers the following improvements over Magento Enterprise Edition 1.12:
+
+
+
Incremental re-indexing has been introduced with Magento Enterprise Edition 1.13, and scenarios where
+ full-re-indexing was required have been limited. This means that operations that previously took hours can
+ now be completed in minutes
+
+
53% improvement in completion times for a full re-index with a 500,000 SKU catalog
+
35% improvement in "Place Order" performance
+
65% improvement in page load times across shopper flow pages that were tested.
+
+
+
+
33% improvement in orders per day that can be processed on the same hardware configuration as Magento
+ Enterprise Edition 1.12
+
+
31% improvement in page views per day supported on the same hardware configuration on Magento Enterprise
+ Edition 1.12
+
+
+
+
Multi-Node Deployment
+ Topology
+
+
Before we introduce you to the benchmarks, an overview of our multi-node benchmarking facility is in order. We
+ started with a basic multi-node cluster with load balancer and caching and separate DB node, and installed
+ Apache. This is a familiar hardware configuration for the Magento developer community. Once provisioned, we
+ installed both Magento Enterprise Edition 1.13 and Magento Enterprise Edition 1.12 on the cluster to compare
+ their performance.
+
+
This is a representation of the multi-node Magento Enterprise Edition 1.12/1.13 installation used for performance
+ testing. It consists of four physical nodes, three of which are virtualized.
+
+
+
+
+
+
We used HP ProLiant SL230s Gen8 servers with 8x16GB DDR3 and 2x Intel Xeon E5â€2660 CPUs for our benchmarking.
+
+
We used a physical disk of a usable 1.2 TB managed by a RAID10 controller. The load balancer we used is
+ nginx.
+
+
The cluster resides in our Las Vegas data center, connected to the Internet via a gigabit connection. We tested
+ the cluster using the popular Gatling suite from our engineering offices in Austin, TX.
+
+
Software Components
+
+
+
+
+
+
+
Scenarios
+
+
This section presents the merchant scenarios we simulated for our testing. These scenarios are based on
+ real-world experience and industry standards with respect to shopper flows and catalog sizes.
+
+
Shopper Flows
+
+
We used real-world, established eCommerce metrics to simulate shopper flows.
+
+
+
94% of eCommerce shoppers visited a storefront but did not purchase any products
+
65% of shoppers added items to their carts but abandoned them
+
Of the 6% who did purchase products (otherwise known as the conversion rate), half checked out as guests
+ without signing in, and half signed into the storefront.
+
+
+
+
+
+
+
+
Catalog
+
+
The catalogs we simulated also reflect real-world, established eCommerce experience.
+
+
+
We simulated small and medium-sized companies with a 50,000-item catalog with 27 product categories.
+
We simulated large companies 500,000 items in the catalog with 2,000 categories.
+
As many eCommerce sites offer different types of products, we specified physical (simple) products, virtual
+ products, and downloadable products, with 60% of the products in each catalog being physical.
+
+
We benchmarked each catalog on one website/storefront.
+
+
+
+
+
+
+
Target Merchant
+ Profile
+
+
The simulated merchant profile we benchmarked against represents the profile of our enterprise customers. We
+ established these metrics based on the day-to-day experience of large merchants operating a successful eCommerce
+ business. Again, we used what we consider to be a typical hardware and software configuration.
+
+
+
50K visitors / day
+
1M Page views / day
+
18000 orders / day
+
3000 orders during peak 4 hours
+
1000 concurrent users
+
Standard HW/SW configuration
+
+
+
Benchmarking Results
+
+
+
These benchmarks were generated during extensive testing of our multi-node configuration running Magento
+ Enterprise Edition 1.13 described above. Our configuration was modeled after what a commercial hosting partner
+ would put into production, and the results reflect accurate gains over Magento Enterprise Edition 1.12.
+
+
The duration of the test sessions is 72 seconds, which significantly stresses the multi-node configuration.
+
+
Incremental
+ Re-indexing
+
+
In Magento Enterprise Edition 1.12, any change to a product would result in a full re-index. Magento Enterprise
+ Edition 1.13 introduces a new feature--incremental re-indexing. With incremental re-indexing, only those items
+ that were changed or added will be re-indexed, reducing the processing time to a fraction of what was required
+ before.
+
+
Take the example of a merchant with a catalog containing 500,000 products. In Magento Enterprise Edition 1.12,
+ any change to a product would result in a full re-index operation. In Magento Enterprise Edition 1.13,
+ incremental re-indexing means the merchant will only re-index items that were changed. The test focused on
+ measuring the improvements provided by the incremental re-indexing feature in Magento Enterprise Edition 1.13.
+ The table below compares improvements to common admin actions, such as changing a product description, prices or
+ inventory.
+
+
+
+
+
+
Full Re-indexing
+
+
+
As part of the benchmarking effort, we also measured the improvements in the full re-indexing feature on Magento
+ Enterprise Edition 1.13, where indexing a 500,000-item catalog was 53% faster than Magento Enterprise Edition
+ 1.12. Faster re-indexing means less load on the system and that changes to the catalog propagate faster to the
+ storefront.
+
+
+
+
+
+
+
500,000 products
+
2,000 categories
+
One store
+
One catalog update during test run
+
+
+
Individual
+ Re-indexers
+
+
The Magento Enterprise Edition 1.13 indexer component contains a number of individual indexers such as Product
+ Flat Data and Product Price. When a Magento admin changes the price of a product, it is only necessary to
+ execute the Product Price indexer for pricing changes to propagate to the frontend. The completion times of
+ these individual indexers were measured in the benchmark environment for Magento Enterprise Edition 1.13 and
+ Magento Enterprise Edition 1.12.
+
+
This section presents the results for full re-index completion times for the individual indexers in Magento
+ Enterprise Edition 1.13 compared to Magento Enterprise Edition 1.12.
+
+
+
+
+
+
+
URL Rewrite failed to run in Magento Enterprise Edition 1.12 but takes only 0.15 sec in Magento Enterprise
+ Edition 1.13
+
+
Catalog description: 500,000 products, 2000 categories, one storefront
+
+
+
Page Load Times
+
+
When Magento Enterprise Edition 1.12 and Magento Enterprise Edition 1.13 were compared, with both running on our
+ multi-node benchmarking configuration, Magento Enterprise Edition 1.13 loaded pages 65% faster than Magento
+ Enterprise Edition 1.12.
+
+
Guest checkout and registered user checkout are two flows that are crucial to storefront operation. This section
+ presents the results of page load time measurements for these two flows.
+
+
Guest Checkout
+ Flow Page Load Times
+
+
In the guest checkout flow pages, Magento Enterprise Edition 1.13 provides a substantial decrease in load times
+ over its predecessor, most of the time more than twice as fast.
+
+
+
+
+
+
Registered
+ Checkout Flow Page Load Times
+
+
The bar chart below presents the improvements in page load times for registered checkout flow.
+
+
+
+
+
+
Page Views and
+ Orders
+
+
In addition to page load times, the benchmark also focused on measuring throughput improvements, particularly
+ page views per day and orders per day.
+
+
During our testing, which simulated a storefront running at peak hours, EE 1.13 executed 33% more orders and 31%
+ more page views than Magento Enterprise Edition 1.12 on the multi-node benchmarking configuration. Notably,
+ Magento Enterprise Edition 1.13 served 47K pages during the test run (10 minutes).
+
+
+
+
+
+
+
10 minute session time
+
+
+
Observations
+
+
What we noted during the benchmarking tests:
+
+
+
The MySQL instance did not show any significant signs of CPU or I/O load during the tests.
+
+
+
The CPU was under 10% and no queries exceeded a 2-second threshold.
+
+
+
Redis and Memcached instances did not exceed a CPU load of 10% during the tests.
+
Web nodes showed high levels of CPU utilization under high load.
+
We anticipate achieving stable scaling by adding additional web nodes to the cluster until the services
+ themselves begin to degrade.
+
+
+
+
Conclusion
+
+
Magento Enterprise Edition 1.13 was engineered for performance--and clearly delivers on the goal as measured by
+ important metrics.
+
+
+
Indexing is improved to enable faster operations without impacting shopping experience. Merchant
+ administrators can add and update products as needed while ensuring product URLs, promotions, navigational
+ menus, and product search tools are always up to date.
+
+
The checkout process is improved by reducing page load times for browsing and placing orders. Faster
+ checkout can significantly improve your customers’ shopping experience and customer satisfaction, and
+ potentially improve your conversion rate.
+
+
Faster page load times means Magento Enterprise Edition 1.13 can support more page views per day and more
+ orders per day, potentially increasing your conversion rate.
+
+
+
+
In addition, we have focused on providing these benefits without the need to upgrade existing hardware, improving
+ your return on assets and investment.
+
+
Appendix
+
+
Page Load Times
+
+ This benchmark report presented analysis of the results produced by the Gatling load generator tool. In this
+ appendix, you can see the actual results reported by Gatling. The results were obtained under the following test
+ setup, which was designed to push Magento to its limit.
+
+
+
+
+
Concurrent session (users)
+
1000
+
+
+
Peak load duration
+
10 minutes
+
+
+
Session duration
+
72 seconds
+
+
+
CPU utilization
+
95%
+
+
+
+
+ CPU utilization is high because session duration was set to 72 seconds for the test. Session duration was set to a
+ low value to increase the active load on Magento. A typical e-commerce site will see session durations of five
+ minutes or more. Preliminary experiments by the benchmark team have confirmed that using a five-minute session
+ duration reduces the CPU utilization to 50-60%.
+
+
+
+
+
+
+
+
Magento EE v1.13
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Requests
+
+
Total
+
OK
+
KO
+
+
Min
+
Max
+
Mean
+
Std Dev
+
95th Pct
+
99th Pct
+
Req/s
+
+
+
Global Information0
+
+
62161
+
62087
+
74
+
+
80
+
12910
+
1735
+
1869
+
5780
+
8060
+
75
+
+
+
product page0
+
+
28573
+
28573
+
0
+
+
80
+
9390
+
709
+
996
+
2670
+
4920
+
34
+
+
+
Click add to cart1
+
+
10458
+
10458
+
0
+
+
440
+
7170
+
1868
+
1139
+
4010
+
4980
+
13
+
+
+
Click add to cart Redirect 12
+
+
10458
+
10458
+
0
+
+
960
+
12910
+
3816
+
2239
+
8050
+
9960
+
13
+
+
+
click checkout3
+
+
3486
+
3486
+
0
+
+
1100
+
10800
+
3459
+
1965
+
7130
+
8970
+
4
+
+
+
Registered Checkout:Login and Pick Address4
+
+
3366
+
3366
+
0
+
+
200
+
7380
+
1155
+
1482
+
4870
+
5900
+
4
+
+
+
Registered Checkout:Login and Pick Address Redirect 15
+
+
3366
+
3366
+
0
+
+
700
+
11440
+
2605
+
1662
+
5640
+
7710
+
4
+
+
+
Guest Checkout start6
+
+
120
+
120
+
0
+
+
360
+
2490
+
908
+
487
+
1860
+
2420
+
0
+
+
+
Registered:Pick Billing Address 17
+
+
120
+
120
+
0
+
+
390
+
4240
+
1457
+
974
+
3510
+
4210
+
0
+
+
+
Registered:Pick Billing Address 2-18
+
+
120
+
120
+
0
+
+
410
+
3690
+
1218
+
685
+
2460
+
3070
+
0
+
+
+
Registered:Pick Billing Address 2-29
+
+
120
+
120
+
0
+
+
400
+
3600
+
1201
+
714
+
2700
+
3510
+
0
+
+
+
Registered:Go to pick Shipping Method10
+
+
120
+
120
+
0
+
+
340
+
2900
+
1072
+
633
+
2330
+
2700
+
0
+
+
+
Guest:Pick Billing Address 111
+
+
120
+
120
+
0
+
+
610
+
4620
+
1688
+
941
+
3580
+
4440
+
0
+
+
+
Guest:Pick Billing Address 212
+
+
120
+
120
+
0
+
+
380
+
3530
+
1049
+
589
+
2050
+
2750
+
0
+
+
+
Guest:Go to pick Shipping Method13
+
+
120
+
120
+
0
+
+
300
+
2080
+
796
+
401
+
1530
+
1960
+
0
+
+
+
Set Shipping Method (Flatrate) 114
+
+
240
+
240
+
0
+
+
510
+
4830
+
1780
+
1066
+
3930
+
4720
+
0
+
+
+
Set Shipping Method (Flatrate): Goto Payment15
+
+
240
+
240
+
0
+
+
300
+
3150
+
905
+
516
+
1940
+
2300
+
0
+
+
+
Set Payment Method (Check/MO) 116
+
+
240
+
240
+
0
+
+
670
+
5290
+
1787
+
987
+
3660
+
4920
+
0
+
+
+
Set Payment Method (Check/MO) 217
+
+
240
+
240
+
0
+
+
300
+
2760
+
904
+
518
+
2010
+
2440
+
0
+
+
+
Set Payment Method (Check/MO) 318
+
+
220
+
220
+
0
+
+
370
+
8180
+
2696
+
1725
+
5810
+
7590
+
0
+
+
+
/checkout/../success/19
+
+
240
+
240
+
0
+
+
250
+
2830
+
931
+
583
+
1970
+
2530
+
0
+
+
+
/checkout/../success/ Redirect 120
+
+
74
+
0
+
74
+
+
1030
+
8350
+
2473
+
1620
+
5590
+
7310
+
0
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Magento EE v1.12
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Requests
+
+
Total
+
OK
+
KO
+
+
Min
+
Max
+
Mean
+
Std Dev
+
95th Pct
+
99th Pct
+
Req/s
+
+
+
Global Information0
+
+
48044
+
47887
+
157
+
+
40
+
40580
+
4985
+
3290
+
10650
+
13870
+
58
+
+
+
product page0
+
+
21327
+
21286
+
41
+
+
40
+
20040
+
4557
+
2820
+
9740
+
12350
+
26
+
+
+
Click add to cart1
+
+
8340
+
8324
+
16
+
+
40
+
12130
+
4216
+
2217
+
7520
+
9000
+
10
+
+
+
Click add to cart Redirect 12
+
+
8324
+
8320
+
4
+
+
40
+
16500
+
7022
+
3449
+
11780
+
13500
+
10
+
+
+
click checkout3
+
+
2780
+
2779
+
1
+
+
920
+
12350
+
6311
+
2829
+
9760
+
10950
+
3
+
+
+
Guest Checkout start4
+
+
90
+
90
+
0
+
+
390
+
3690
+
2103
+
795
+
3210
+
3410
+
0
+
+
+
Registered Checkout:Login and Pick Address5
+
+
2690
+
2690
+
0
+
+
180
+
19120
+
3298
+
4984
+
15470
+
16940
+
3
+
+
+
Guest:Pick Billing Address 16
+
+
90
+
90
+
0
+
+
600
+
7750
+
4348
+
1605
+
6430
+
7400
+
0
+
+
+
Registered Checkout:Login and Pick Address Redirect 17
+
+
2690
+
2688
+
2
+
+
40
+
24360
+
5433
+
3350
+
11780
+
14060
+
3
+
+
+
Guest:Pick Billing Address 28
+
+
90
+
90
+
0
+
+
520
+
8240
+
3412
+
1423
+
5480
+
6810
+
0
+
+
+
Guest:Go to pick Shipping Method9
+
+
90
+
90
+
0
+
+
310
+
4780
+
2334
+
888
+
3300
+
4450
+
0
+
+
+
Registered:Pick Billing Address 110
+
+
90
+
90
+
0
+
+
370
+
10090
+
3657
+
2453
+
8660
+
9600
+
0
+
+
+
Registered:Pick Billing Address 2-111
+
+
90
+
90
+
0
+
+
540
+
17670
+
4148
+
2741
+
10220
+
12510
+
0
+
+
+
Registered:Pick Billing Address 2-212
+
+
90
+
90
+
0
+
+
530
+
12640
+
3983
+
2411
+
8290
+
11590
+
0
+
+
+
Registered:Go to pick Shipping Method13
+
+
90
+
90
+
0
+
+
360
+
6290
+
2546
+
1401
+
5050
+
5980
+
0
+
+
+
Set Shipping Method (Flatrate) 114
+
+
180
+
180
+
0
+
+
450
+
7640
+
3926
+
1884
+
6550
+
7450
+
0
+
+
+
Set Shipping Method (Flatrate): Goto Payment15
+
+
180
+
180
+
0
+
+
380
+
6290
+
2451
+
1256
+
4270
+
4830
+
0
+
+
+
Set Payment Method (Check/MO) 116
+
+
180
+
180
+
0
+
+
570
+
8290
+
3923
+
1996
+
6460
+
7300
+
0
+
+
+
Set Payment Method (Check/MO) 217
+
+
180
+
180
+
0
+
+
330
+
5230
+
2318
+
1238
+
4210
+
4810
+
0
+
+
+
Set Payment Method (Check/MO) 318
+
+
180
+
180
+
0
+
+
940
+
40580
+
12673
+
7957
+
25910
+
29540
+
0
+
+
+
/checkout/../success/19
+
+
180
+
180
+
0
+
+
230
+
3330
+
1437
+
854
+
2870
+
3150
+
0
+
+
+
/checkout/../success/ Redirect 120
+
+
93
+
0
+
93
+
+
780
+
10470
+
5031
+
2251
+
7920
+
8880
+
0
+
+
+
+
+
+
+
+
Estimating the
+ Number of Visitors
+
+ Gatling does not report the number of users that cycled through during the test. However, it is possible to estimate
+ the number using the following formula:
+
+
Magento Community Edition (CE) Release Notes (1.8 and later)
+
+
+
Note: We'd like to make you aware that a security patch for older versions of Magento Community Edition has been posted (in
+ the Magento Community Edition Patches section). This patch resolves a remote code execution vulnerability that
+ enables an attacker with Magento administrator privileges to delete files and directories on a Magento
+ installation. This vulnerability was discovered through our quarterly penetration testing process and has not been
+ reported by merchants.
+ This issue was fixed in Magento Community Edition 1.8.0.0; no patch is necessary for versions 1.8.0.0 and later.
+ Patches are available for Magento Community Edition 1.4.0.0 through 1.7.0.2. We encourage all affected merchants
+ to apply the patch in their next regularly scheduled maintenance cycle.
+ Magento takes security very seriously and will continue to focus on identifying potential issues and hardening our
+ defenses.
+
+
+
Table of Contents
+
These Release Notes contain the following information:
Note: Some of the patches discussed in this section have
+ EE_1.14.0.1 in the name. These patches were all tested against CE 1.8.x as well.
+
+
General Magento Connect Patches
+
Patch name: SUPEE-3941
+
+
+ When
+ you install a community-created translation package, the translation provided by the package overwrites any
+ existing translations for the same items. This enables you to more easily install packages with translations.
+
+
+ To
+ improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
+
+ Extension
+ developers can now create an extensions with a dash character in the name. Merchants can install those extensions
+ without issues.
+
+ Magento
+ administrators who attempt to install an extension with insufficient file system privileges are now informed.
+ Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the
+ your Magento install dir/app/code/community directory structure, the Magento administrator
+ sees an error message in the Magento Connect Manager.
+ To set file system permissions appropriately, see After You Install
+ Magento: Recommended File System Ownership and Privileges.
+
+
+
Magento Install Page Displays After SOAP v2 Index Page Refresh
+
Patch name: SUPEE-3762.
+ Refreshing the SOAP v2
+ index page (http://your-magento-host-name/index.php/api/v2_soap/index/) results in all
+ administrators and customers viewing the Magento installation page.
+
+
+
+
+
Discover Card Validation Patch Available
+
Magento has fixed an issue that prevented some Discover credit cards from validating properly. The issue was that
+ certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover
+ cards should validate properly.
+
The issue affects Magento CE versions 1.4.2.0–1.8.1.0.
Important: This is not a security threat. No data has
+ been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid
+ Discover card numbers.
+
+
+
PHP 5.4 Patch Available
+
You can use PHP 5.4 with Magento CE versions 1.6.0.0–1.8.1.0.
Magento CE 1.8.1.0 helps advance overall product quality and ease operations by providing significant tax
+ calculation improvements, a wide range of bug fixes, and several security enhancements.
+
+
Tax Calculation Improvements
+
CE 1.8.1.0 resolves Value Added Tax (VAT) and Fixed Product Tax (FPT) issues so that Magento administrators can
+ create invoices and credit memos to give merchants merchants access to accurate and consistent tax calculations
+ and displays. We've also addressed:
+
+
VAT tax calculation issues for cross-border trade
+
Tax rounding issues when multiple taxes are applied
+
VAT and FPT calculation issues for bundled products
+
Support for the Waste Electrical and Electronic Equipment (W.E.E.E.) recycling tax in the EU
+
+
+
Functional Improvements
+
CE 1.8.1.0 includes bug fixes across important feature areas, including the shopping cart, checkout, content
+ management system, and product import and export function. Many of these updates came from a hackathon held with
+ Magento community developers, which demonstrates the vitality of our development community and their powerful
+ ability to help us advance the platform.
+
+
Security Enhancements
+
CE 1.8.1.0 includes several security enhancements that were identified through our rigorous security assessment
+ process. Magento complements its own comprehensive internal testing with quarterly penetration testing by expert
+ consultants and actively works with the development community to identify security issues in order to harden the
+ platform against potential threats.
+
+
+
+
Security Enhancements
+
Magento addressed the following security issues:
+
+
+ Improved the
+ password hashing algorithm.
+ Magento thanks Bjorn Kraus for contributing to this fix.
+
+
+ Resolved
+ issues that could have resulted in Cross-Site Request Forgery (CSRF) in the web store.
+
+
+
+ Resolved potential
+ issues when issuing Return Materials Authorizations (RMAs).
+ Magento thanks Ivan Chepurnyi for contributing to this fix.
+
+ Resolved a session
+ fixation issue when registering a user with the web store.
+
+
+
+
+ Resolved issues
+ with the expiration of file-based user sessions.
+ Closed a potential
+ loophole that enables another user to possibly access personal information when viewing billing
+ agreements.
+ Magento thanks Darryl Adie and Ampersand Commerce for contributing to this fix.
+
+ Fixed the security
+ settings for the frontend cookie to protect user sessions.
+
+
+
+
+
+
Issue After Upgrading to CE 1.8.1
+
+ There is a known Issue After Upgrading to CE 1.8.1 that affects
+ you only if you do not follow the recommended procedure to upgrade to a new environment as
+ discussed in Getting Ready For
+ Your Upgrade.
+
Symptom: After completing the upgrade, when you log in to the Admin Panel and click
+ System > Configuration, a fatal error similar to the following displays in your
+ browser:
+
Class 'Mage_Googlecheckout_Helper_Data' not found in /var/www/html/magento/app/Mage.php on line 547
+
+
Solution:
+
+
Close the Admin Panel browser window.
+
As a user with root privileges, delete all files exceptconfig.xml from the
+ following directory:
+
See the following sections for a discussion of changes in this release:
+
+
+
+ A tax
+ configuration option for Fixed Product Tax (FPT) has changed. This option is in the Admin Panel at
+ System > Configuration > SALES > Tax > Fixed Product Taxes,
+ option FPT Tax Configuration. This option replaces the Apply Tax to FPT option
+ in earlier CE releases.
+ This option specifies how FPT is calculated as follows:
+
+
Not Taxed: Click this option if your taxing jurisdiction does not tax FPT. (For example,
+ the state of California does not tax FPT.)
+
Taxed: Click this option if your taxing jurisdiction does tax FPT. (For example, Canada
+ taxes FPT.)
+
Loaded and Displayed with Tax: Click this option if FPT is added to the order total
+ before applying tax (for example, in EU countries).
+
+
+
+ You can now
+ specify a 0% tax rate. (In the Admin Panel, click Sales > Tax > Manage
+ Tax Zones & Rates.).
+ For more information, see the Magento User Guide.
+
+ Magento changed
+ its recommended setting for System > Configuration > SALES >
+ Tax > Calculation Settings, option Apply Discount On Prices
+ as follows:
+
+
US and Canadian merchants: Set the value of Apply Discount On Prices to Excluding
+ Tax.
+
EU merchants: Set the value of Apply Discount On Prices to Including
+ Tax.
+
+
+
+ Magento strongly
+ recommends all merchants set Apply Customer Tax to After Discount, regardless
+ of all other tax-related settings. This avoids issues with calculating the total product price.
+
+
+ When you specify a
+ tax rate, the State list is now available whenever you choose a country that has states.
+
+ You can now specify
+ the asterisk (*) wildcard character for the value of State when you set up a new
+ tax rate. This enables you to apply the same tax rate to all states or provinces in a particular country.
+
+ Stores now display
+ in the Admin Panel in System > Manage Stores as a three-column hierarchy, with
+ the website in the left column, all stores associated with the website in the center column, and all store views
+ associated with the store in the right column.
+ This makes it easier for you to browse your stores and understand which websites, store views, and stores are
+ associated with each other. The updated Manage Stores page also displays the root category for each store and
+ the code for each website and store view.
+ Magento thanks Fabrizio Branca for contributing to this fix. For more information, see Fabrizio's
+ blog post.
+
+ For the DHL
+ (Deprecated) shipping method to work, you must change the gateway URL as follows:
+
+
Log in to the Admin Panel as an administrator.
+
Click System > Configuration > SALES > Shipping
+ Methods.
+
In the right pane, expand DHL (Deprecated).
+
Change the value of the Gateway URL field to the following:
+
http://xmlapi.dhl-usa.com/ApiLanding.asp
+
+
In the upper right corner, click Save Config.
+
+
+
+
+
+
Tax Calculation Fixes
+
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
+
+
+ Canadian customers
+ now receive an e-mail with the correct totals for invoices and credit memos that include Provincial Sales Tax
+ (PST) and Goods and Services Tax (GST).
+
+ Resolved issues
+ with incorrect prices and incorrect tax amounts when a custom price is used together with the configuration
+ setting System > Configuration > SALES > Tax >
+ Calculation Settings, option Apply Tax On set to Original price
+ only.
+
+ The tax amount is
+ calculated correctly when:
+
+
The customer is in a different taxing jurisdiction than the web store
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Catalog Prices is set
+ to Including Tax
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Tax Calculation Method Based
+ On is set to Unit Price
+
+
+
+ The row total
+ including tax displayed in the shopping cart is calculated correctly when:
+
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Catalog Prices is set
+ to Excluding Tax
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Tax Calculation Method Based
+ On is set to Row Total
+
+
+
+ The row subtotal
+ displays the correct amount when reordering a product that includes a discount coupon.
+
+ Multiple tax rates
+ for a product display correctly in the Admin Panel when creating an invoice or credit memo.
+
+ Resolved calculation
+ errors when tax and currency conversion are applied. As a result, the price the customer views on a catalog or
+ product page is the same as the price displayed in the shopping cart.
+
+ A customer can now
+ place an order when two tax rules are applied to a product, even if the tax rules specify the same tax rate.
+
+
+ Resolved issues with
+ calculating taxes on orders that are shipped to different countries that have different tax rates.
+
+ Product prices,
+ including taxes, display on category and product pages the same for a guest customer as for a logged-in
+ customer. (A guest customer is a customer who does not log in to your web store; this customer belongs to the
+ NOT LOGGED IN customer group.)
+
+
+
+
Rounding Issues
+
The following tax rounding issues were resolved:
+
+
+ Resolved a
+ rounding issue in the tax detail display in the shopping cart when more than one tax rule is used.
+
+ Resolved an issue
+ reported on stackoverflow where a calculation error resulted from the following configuration:
+ System > Configuration > SALES > Tax > Calculation
+ Settings, option Tax Calculation Method Based On set to Total
+ System > Configuration > SALES > Tax > Calculation
+ Settings, option Catalog Prices set to Including Tax
+
+ As a result of
+ allowing a 0% tax rate, rounding errors related to different VAT jurisdictions have been resolved. For example,
+ if a product originates in a country with VAT but is shipped to another country that has no VAT, correct prices
+ display in the shopping cart.
+
+ Row totals display
+ correctly in the shopping cart when:
+
+
A shopping cart discount is applied
+
The following configuration options are set in System > Configuration >
+ SALES > Tax > Calculation Settings:
+
+
Catalog Prices is set to Including Tax
+
Tax Calculation Method Based On is set to Excluding Tax
+
Apply Customer Tax is set to After Discount
+
Apply Discount On Prices is set to Including Taxes
+
+
+
+
+
+
+
Display Issues
+
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
+ store:
+
+
+ Shipping prices
+ including tax display properly in the shopping cart.
+
+ A special price now
+ displays correctly on the product view page.
+
+ Values displayed in
+ PDFs for invoices and credit memos no longer overlap each other.
+
+ Orders, invoices,
+ and credit memos for downloadable and virtual products display the correct row total when viewed in the Admin
+ Panel.
+
+ Orders display the
+ FPT in the Admin Panel when the full tax summary is specified.
+
+ Fixed-price
+ bundled products that include FPT now display only one price for both From and To values, regardless of how you
+ configured the products.
+
+
+
+
+
Bundled Products Issues
+
+
+ The price of a
+ dynamic bundled product is calculated correctly after being customized by the customer.
+
+ The price of a
+ dynamic bundled product with tiered pricing is calculated correctly after being customized by the customer.
+
+ Resolved issues
+ with calculating the value displayed for the price including tax for bundled products.
+
+ The price
+ excluding tax of a bundle product to which a discount is applied is the same:
+
+
When viewed on the customization page
+
after adding the bundled product to the shopping cart.
+
+
+
+ A dynamically-priced
+ bundled product's prices displayed for Unit Price in the shopping cart (that is, the price including tax and the
+ price excluding tax) are now correct. Before the fix, the prices were equal, which was incorrect.
+
+ The
+ price of a bundled product displayed on the product view page and in the shopping cart are the same.
+
+ The grand total
+ including tax and the subtotal including tax displayed in the shopping cart are now identical when you specify
+ that catalog prices include tax and the shopping cart is set to display prices with and without taxes for a
+ dynamic bundled product that consists of two simple products.
+
+
+
+
Fixed Product Tax (FPT) Issues
+
+
+ Resolved
+ issues in calculating FPT on a credit memo.
+
+ With both
+ discounts and FPT enabled (and FPT is taxable), the subtotal including tax displayed in the shopping cart is
+ correct.
+
+ FPT calculation
+ for bundled products that have FPT applied to them now are now correct for all FPT configuration settings.
+
+ The invoice total
+ is calculated correctly for an order that has both FPT and a shopping cart discount.
+
+ The FPT amount is
+ now included in the Subtotal (Incl.Tax) row for partial invoice.
+
+ Resolved an issue
+ that resulted in FPT being applied twice to the grand total in the shopping cart.
+
+
+
+
+
Fixes in Magento CE 1.8.1.0
+
Fixes in this release can be divided into the following categories:
+ Resolved a new
+ customer registration issue that enabled a user to register and see another customer's dashboard.
+
+ Resolved issues with
+ breadcrumbs disappearing or displaying incorrectly.
+
+
+ The following options are available in the Admin Panel in System >
+ Configuration > SALES > Sales > Gift Options:
+ Allow Gift Wrapping on Order Level set to No
+ Allow Gift Wrapping for Order Items set to Yes
+
+ Category and
+ subcategory names display correctly. Before the issue was resolved, subcategory names that were significantly
+ longer than the category name did not display properly.
+
+
+ If a customer adds
+ more than one product that requires products to be purchased in increments, only the products that meet the
+ increment requirements are added. Before the fix, all products were added.
+
+ Scheduled payments
+ work properly.
+ Magento thanks Sylvain Raye for contributing to this fix.
+
+ If a bundled or
+ configurable product is out of stock, it's no longer available to check out.
+ Magento thanks Francesco Marangi for contributing to this fix.
+
+ Placing an order
+ in the Admin Panel correctly sets the order status to Pending.
+ Magento thanks GitHub user elframan for contributing to this fix.
+
+
+
+
+
Import and Export Fixes
+
+
+ Scheduled export
+ works properly.
+
+ You can now export
+ a shipment to CSV after printing its shipping label.
+ Magento thanks Florinel Chis for contributing to this fix.
+
+
+
+
Shipping Fixes
+
+
+ You are not
+ required to enter a declared value to ship with FedEx.
+
+ FedEx shipping
+ labels print properly; addresses are not truncated.
+
+ Fix for the USPS
+ change to the names of their Priority and Express shipping options in their API made on Sunday, July 28, 2013.
+
+
+
+
+
+
+
+
+
Other Fixes
+
+
+ Resolved issues that
+ caused spurious errors in the Magento exception log:
+ 'Zend_Date_Exception' with message 'Invalid year, it must be between -10000 and 10000'
+
+
+
+
+ Widgets display
+ properly on the CMS.
+
+
+
+
+ The product attribute
+ option Use Default Value works properly when used in a non-default store view.
+
+ A category attribute
+ set to store view scope displays in layered navigation.
+
+ A store set for
+ British Pound Sterling currency units now displays the correct currency in payment logs.
+
+ Resolved an issue with
+ the Mage_Catalog_Block_Product_Abstract class that caused errors to display on product view pages in
+ your web store.
+
+
+
+
+ Back-in-stock e-mails
+ contain the correct content.
+
+
+
+
+
+
+
+ You can now manage
+ product ratings and reviews from the Admin Panel as well as from the web store.
+ Magento thanks Fabian Blechschmidt Schrank for contributing to this fix.
+
+
+ Resolved an issue
+ with Mage_Page_Block_Template_Links::addLinkBlock to enable you to sort an array of results by
+ position.
+ Magento thanks Benjamin Marks for contributing to this fix.
+
+
+
+
Magento Community Edition (CE) 1.8.0.0 Release Notes
+
See the following sections for information about changes in this release:
+ Errors are not
+ displayed in a new Magento installation.
+
+ Fixed a session
+ fixation vulnerability in the new user registration process. Attackers can no longer abuse this flaw to take over
+ new user accounts during registration.
+
+ Resolved a remote
+ code execution vulnerability that enabled an attacker to delete files and directories on the Magento installation.
+ (The attack required access to the Admin Panel as a Magento administrator.)
+
+ Prevent attacks that
+ use OAuth to leak sensitive information to an attacker that knows the consumer key and user token.
+
+ Resolved an issue
+ that enabled attackers to gain access to billing information.
+ We thank Darryl Adia (from Ampersand Commerce) for contributing to this fix.
+
+ Resolved
+ issues with the security of OAuth tokens and keys.
+
A remote code execution vulnerability was fixed.
+ We thank Bastian Ike for contributing to this fix.
+
+
The Magento Admin Panel and web stores no longer allow web browsers to store usernames or passwords.
+
The Magento web store has additional Cross Site Request Forgery (CSRF) protections, meaning an imposter can no
+ longer impersonate a newly registered customer and perform actions on the customer's behalf.
+
The cryptographic methods used to store passwords were improved to enhance security.
+
+
+
United States Postal Service (USPS) Update
+
The USPS changed the names of their Priority and Express shipping options in their API in July 2013. To enable you
+ to continue utilizing USPS Priority and Express mail methods, CE 1.8 includes a patch that addresses the
+ issue.
+
Important: The USPS API patch has an impact on upgrading to CE 1.8
+ from earlier versions. If you're doing a new CE 1.8 installation, however, you don't need to do anything.
+
+
+
Following are details about the upgrade impact:
+
+
Print all USPS shipping labels before upgrading; after upgrading, you will not be able to print them.
+
Any shopping cart price rules that use the USPS shipping method that created before you upgrade must be re
+ created after you upgrade. Pre-existing USPS shipping methods do not work with shopping cart price rules after the
+ upgrade.
+
+
+
Performance Improvements
+
+
Limited the way Magento performs large database lookups.
+
+
Checkout performance improvements achieved by:
+
+
Eliminating unnecessary RSS cache cleanups when RSS functionality is disabled
+
The locale used to send a new order confirmation e-mail now first checks to see if the customer's locale is
+ the same as the store's locale before attempting to localize the e-mail.
+
+
+
Improving the overall checkout process performance by loading the progress information for the current
+ checkout step only
+
+
+
You can load a large number of tax codes (35,000 or so) without impacting performance.
+
+
+
+
+
Tax Calculation Fixes
+
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
+
+
Based on Magento testing and merchant experience, certain tax configuration settings have been determined to be
+ susceptible to rounding issues and can be confusing to buyers. To help you avoid issues with those settings,
+ warning messages display in the Admin Panel if you attempt to save such a configuration.
+ Administrative users can choose to dismiss the messages and can still save the configuration; however, Magento
+ strongly recommends you change the configuration in a way recommended by the details displayed in the
+ message.
+ For details, see the Magento
+ User Guide.
+
+
+
Bundle pricing is more consistent as follows:
+
+
The calculation formula is:
+ Sub item price = Sub item base price * Applicable tiered price adjustment or discount, then rounded
+ Bundle price = Sum (round(sub item price * qty))
+
When non-integer quantities are multiplied by a product price, Magento rounds the resulting subtotal is as
+ follows:
+ round(unit price * non-integer quantity)
+
+
+
All product price information on which taxation is based are rounded to two digits of precision regardless of
+ how many digits of precision have been loaded into the database (for example, $10.24 instead of $10.2385). This
+ situation can occur when certain integrations enable third-party applications to send four-digit precision prices
+ to Magento.
+ Starting with this release those additional digits will have no impact on customer facing prices. Forcing two
+ digits of precision enables more exact calculations involving Fixed Product Tax (FPT), discounts, and
+ taxes—among other concerns.
+
+
+
For certain Canadian provinces and localities, calculations and methods were updated to support changing legal
+ requirements in Canada:
+
The following issues relate to one-cent rounding errors in the web store or shopping cart:
+
+
Calculating taxes for bundled products with tiered pricing.
+
Calculating the price before customization for bundled products.
+
+
+
Calculating the grand total of items added to a cart in a different order.
+
Viewing an order when taxes are calculated after a discount using either row-based or unit price.
+
+
+
Applying a discount to an order with a shipping address different than the billing address.
+
+
+
Calculating the grand total based on the order in which products are added to the shopping cart.
+
+
+
Specifying that prices display in the web store excluding tax and setting a 20% tax rate (or discount rate) now
+ calculates the grand total correctly. It is now possible to have grand totals in amounts like 6.99, 9.99, or
+ 99.99—regardless of the currency units used in the web store.
+
+
+
Adding multiple items to a cart does not affect the accuracy with which taxation is calculated.
+
+
+
Subtotal (Incl. Tax) is now correct when catalog and shipping prices include tax. Both tax and discounts are
+ applied after tax.
+
+
+
Prices displayed in the cart and on the catalog page are consistent and correct when catalog prices include tax,
+ and when items in the catalog are set to display both including and excluding tax.
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
+
+
Error in calculating the Grand Total Excl. Tax was resolved. This error occurred in a specific configuration:
+ tax is applied to FPT, FPT is included in the subtotal, and the customer selects non-taxable flat rate shipping.
+
+
+
+
+
+
Fixed Product Tax (FPT) Fixes
+
The following issues relate to errors in calculating taxes that include FPT in the web store or shopping cart:
+
+
Price in the cart displays the correct before-tax price and grand total.
+
+
+
Subtotals displayed in the cart—both Including Tax and Excluding Tax—are now correctly calculated
+ when FPT is applied.
+
Free shipping offers are now processed correctly when FPT is applied.
+
FPT taxes are calculated correctly when a discount is applied.
+
+
+
+
+
Discount Calculation Fixes
+
The following issues relate to price calculations when coupon codes or other discounts are applied in the web store
+ or shopping cart:
+
+
The Row Subtotal displayed in the cart is calculated correctly (that is, both Excl. Tax and Incl. Tax are
+ correct).
+
The price for bundled items now displays with tax included if the bundle is configured to do so.
+
Taxation is now correctly calculated on a product with a discounted price.
+
Taxation on discounts is now calculated correctly when the ship-to country is different from the web store's
+ default country.
+
+
+
Display Fixes
+
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
+ store:
+
+
Row Subtotal displays correctly in the shopping cart when:
+
+
FPT is applied.
+
+
+
A discount is applied to a situation where the tax the customer pays is different from the tax specified for
+ the web store's locale (for example, when the shipping origin is different than the shipping address).
+
+
+
+
+
Subtotal including tax on a credit memo is correct when one or more items in the memo includes FPT.
+
+
+
Item subtotal displays correctly when a discount is applied to a purchase that includes FPT.
+
+
+
If the administrator sets catalog prices to exclude tax and to display product prices in catalog as including
+ tax, the price of the product in your web store includes applicable taxes.
+
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
The amount of tax displayed in the Order Totals section of the shopping cart is now correct when free shipping
+ and a shopping cart rule discount are applied.
+
+
+
+
+
API Fixes
+
The following are fixed in the Magento SOAP v2.0 APIs (with exceptions noted):
+
+
Requesting a product using a call like the following returns the product with the specified numeric SKU value
+ (8888 in the following example):
+ $result = $client->call($sessionId, 'catalog_product.info', '8888', null, null, 'sku');
+
+
You can now use from-to complex filters to perform "window" filtration on a single
+ field. For example, you can use from and to on the created_at return a list
+ of sales orders using the salesOrderList.
+
+
+
When you use the SOAP API v.2.0 with WS-I Compliance enabled to retrieve sales orders information, the server responds with the
+ correct Content-Length header.
+
+
+
The productGetSpecialPrice method returns special price information for a product, whether or not
+ WS-I Compliance is
+ enabled.
+
+
+
The shoppingCartPaymentList method returns the list of the available payment
+ methods for the shopping cart appropriately. The following error is no longer returned:
+ SOAP-ERROR: Encoding: object has no 'code' property in name
+
+
You can now add a C# web reference in Microsoft Visual Studio 2010 using the Magento WSDL.
+ For example, this command no longer fails:
+ C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin> wsdl /out:Magento.cs /v
+ http://magentohost/api/v2_soap/?wsdl
+
+
When a product price is set with website scope and an administrative user has access to only one website, the
+ default price is taken from that website scope. Also, when saving the product on the website scope, the price is
+ updated only in that scope and not in the default scope.
+
+
+
An error no longer displays on your web store after a customer places an order. (The error message was
+ There has been an error processing your request. Please contact us or try again later).
+
+
+
Restricted coupon codes work properly, even if the customer has selected the Remember me
+ checkbox.
+
+
+
Using the Table Rates shipping option, free shipping options work properly. (In the Admin Panel, click
+ System > Configuration > SALES > Shipping
+ Methods. In the right pane, expand Table Rates.)
+
+
+
Issues with shipping table rates have been resolved.
+
+
+
Entering a value such as 10,50 (using a comma character and not a period) for Adjustment
+ Fee now results in the correct amount of credit being applied to the transaction.
+
+
+
Unit price for bundled products is now calculated correctly.
+
+
+
The tiered price of bundled items now displays properly on the web store.
+
+
+
Composite products can be successfully reordered.
+
+
+
You can now use special characters in a product URL key.
+
+
+
After a customer visits the sitemap, web stores URLs are no longer prepended by
+ /sitemap/catalog/string.
+
+
+
Welcome messages now display properly in the web store after a customer's profile information is changed.
+
+
+
Recently viewed products now display updates properly.
+
+
+
Armed Forces Middle East is now available for State when checking out.
+
+
+
Searching for a customer's orders and returns works properly.
+
+
+
Shipping is calculated correctly if you select Using origin weight (few requests) for
+ Packages Request Type. (In the Admin Panel, click System >
+ Configuration > SALES > Shipping Methods > DHL (Deprecated)).
+
+
+
Free shipping is no longer available to a customer during checkout if the option was disabled by an
+ administrator. (In the Admin Panel, click System > Configuration >
+ Sales > Shipping Method > DHL(Deprecated), click one or more
+ options from the Allowed Methods list, and, from the Free Shipping with Minimum Order
+ Amount list, click No.)
+
+
+
A user can navigate your web store while downloading a downloadable product.
+
+
+
You can now specify weight units in kilograms (kg) using the FedEx shipping method.
+
+
+
FedEx shipping rates are now consistent with Magento discounted rates.
+
+
+
Fixed issues with United Parcel Service (UPS) shipping rates.
+
+
+
UPS shipping labels have the word SAMPLE printed on them only when you request a sample label.
+
+
+
Changes made to United States Post Office (USPS) APIs and rates have been incorporated in Magento.
+
+
+
The products in a customer's wish list no longer disappear after one or more products are edited by an
+ administrator.
+
+
+
Administrators can view the contents of a customer's shopping cart.
+
+
+
+ When a customer selects a product on your web store, the assigned category is selected in the
+ navigation menu.
+
+
+
+
+
Promotional Price Rule Fixes
+
The following fixes relate to administering and using shopping cart price rules and catalog price rules:
+
+
Shopping cart price rules applied to specific customer groups work properly.
+
+
+
Catalog price rules are applied properly to customer groups.
+
+
+
The scope of a product attribute is now honored by a catalog price rule.
+
+
+
Discounts specified by a shopping cart price rule are applied properly when a particular order is shipped to
+ multiple addresses.
+
+
+
A discount specified by a shopping cart price rule that allows for more than one use per customer is applied the
+ correct number of times if the customer has their orders shipped to more than one address.
+
+
+
+
When an administrative user whose role is restricted to only viewing catalog price rules, the user cannot add or
+ edit catalog price rules.
+
+
+
Shopping cart price rules now work properly with bundled products.
+
+
+
+
+
Administrative Ordering and Credit Memo Fixes
+
+
When you create an order using the Admin Panel and you have multiple stores, the State/Province
+ field updates appropriately for the country in which the order is placed.
+
+
+
When you create an order using the Admin Panel and you have specified a default billing address and a default
+ shipping address, the addresses are used correctly.
+
+
+
Orders placed by an administrator display in a customer's last order list.
+
+
+
Product comparisons now display properly when an administrator makes a change using the Admin Panel (for
+ example, deleting a product from a customer's comparison list).
+
+
+
You can now cancel an order using the Admin Panel.
+
+
+
Orders and invoices that include taxable shipping—when created in the Admin Panel—now calculate the
+ shipping taxes properly.
+
+
+
Products added to a customer's wish list by an administrator display properly.
+
+
+
+
+
Import Fixes
+
+
The quantity (QTY) of all products imports correctly.
+
+
+
The value of Maximum Qty Allowed in Shopping Cart (use_cfg_max_sale_qty) is correct.
+
+
+
The product displays correctly in layered navigation.
+
+
+
Importing customer lists with capitalization variations in the e-mail address now imports the customer only once
+ (for example, user@example.com and User@example.com).
+
+
+
+ Issues with importing products with Append Complex Data selecting from a
+ comma-separated value (.csv) file have been resolved.
+
+
+
+
Payment Fixes
+
+
Resolved issue sending customer e-mail when using Payflow Link.
+
+
+
Security issues with Google Checkout payments have been resolved.
+
+
+
Security issues with Authorize.net payments have been resolved.
+
+
+
Magento conforms to the latest version of the PayPal Instant Payment Notification (IPN) guidelines.
+
+
+
The contents of a shopping cart are unaffected by canceling a PayPal payment.
+
+
+
Issues with not being able to continue checkout after switching payment methods have been resolved.
+
+
+
You can now process partial refunds and invoices for orders that were placed using Payflow Pro.
+
+
+
Payflow Link and Payments Advance now capture IPN transactions properly.
+
+
+
Special characters (such as e-mail addresses) are now handled properly by the Magento Payflow API integration.
+
+
+
Resolved errors with orders placed using the Website Payments Pro payment method.
+
+
+
PayPal Express Checkout payments are handled properly when a shopping cart price rule is specified.
+
+
+
Any PayPal Name-Value Pair (NVP) payment method no longer automatically refunds an order when a chargeback is
+ initiated. Magento now allows the dispute to be resolved before taking the appropriate action.
+ PayPal NVP payment methods include: PayPal Payments Pro (including PayPal Payments Pro Hosted), Payments Standard,
+ and all Payflow methods.
+
+
+
PayPal Pro now correctly processes the shipping address for an order.
+
+
+
PayPal Express Checkout and PayPal Pro now handle partial refunds properly.
+
+
+
Fixed rounding errors that were preventing PayPal Express Checkout transactions from completing. The error
+ occurred with the following configuration:
+
+
tax calculation method based on the total
+
tax calculated based on the shipping address
+
catalog prices exclude tax
+
shipping prices exclude tax
+
customer discount applied after a discount
+
discount applied to prices excluding tax
+
tax applied to a custom price if available
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
+
+
+
The order status Suspected Fraud is now supported by PayPal Payments Pro (hosted) when PayPal fraud protection
+ is enabled. Using the Magento Admin Panel, the merchant can also accept or deny any Suspected Fraud orders and
+ have that decision applied to the PayPal transaction.
+
+
+
+ When sending payments in the United Kingdom, PayPal Payments Pro (hosted) now sends the value for
+ state correctly. (Before the fix, city was sent as the value for state.)
+
+
Using the Ogone payment method, transactions display in the Magento Admin Panel after you capture them.
+
+
+
When an administrator places an order and uses PSi Gate, then cancels the order, the PSi Gate gateway displays
+ both the order and the void transactions.
+
+
+
The following fields related to PayPal's Payflow Pro Gateway payment method are now implemented properly:
+
Fixed spurious Gateway error: Void error: V18A4B18E0F9 has been captured errors when canceling
+ partially invoiced orders when the Payflow Pro processor was used to process the payment.
+
+
+
3-D secure fix that affects UK merchants only: 3-D Secure for UK merchants implementing Direct Payment
+ works properly.
+
+
+
Partial captures are now supported for the following PayPal payment methods: Express Checkout, Payments Pro
+ Payflow Edition, and PayPal Standard.
+
+
+
Using the PayPal Express Checkout method, a recently added customer can check out without the error This
+ customer email already exists.
+
+
+
+
+
Other Fixes
+
+
+ Issues related to
+ the DHL shipping method for picking up and pricing orders on holidays have been resolved as follows:
+
+
If the current date is a weekend, Magento chooses next Monday as the pick-up date.
+
If the current date is a holiday, Magento requests from DHL information about the next five consecutive days
+ to find a workday on which to pick up the order.
+
If there is no workday in the five consecutive days following a holiday, the DHL shipping method is
+ unavailable.
+
+
+
+ The
+ .htaccess.sample provided with Magento now includes php_value memory_limit 512M to be
+ consistent with the Magento system
+ requirements.
+
+ You can now install
+ or upgrade to CE 1.8.0.0 if your Magento database had a table prefix (for example, all tables start with
+ mage_ because you specified a tables prefix during installation).
When an administrative user whose role is restricted to managing products attempts to edit Inventory settings
+ (Catalog > Manage Products, Inventory), only the available
+ options display.
+
+
+
Related product information updates appropriately in the Admin Panel.
+
+
+
Issues with editing product inventory settings and category attributes using the Google Chrome web browser have
+ been resolved.
+
+
+
Rolling back after a backup now works properly. (The Magento backup and rollback options are available in the
+ Admin Panel in System > Tools > Backup.)
+
+
+
You can now fetch data for a PayPal Settlement Report using a custom Secure FTP (SFTP) server.
+
+
+
You can now save a category with the option Available Product Listing Sort By: Best value or
+ Price enabled.
+
+
+
+
+
Thanks
+
Magento acknowledges and thanks everyone in the Magento Community who contributed to this release, including Colin
+ Mollenhour for Redis modules.
+
+
+
+
\ No newline at end of file
diff --git a/guides/v19.x/ce18-ee113/ee1.13_release-notes.html b/guides/v19.x/ce18-ee113/ee1.13_release-notes.html
new file mode 100644
index 0000000000..36aafdba54
--- /dev/null
+++ b/guides/v19.x/ce18-ee113/ee1.13_release-notes.html
@@ -0,0 +1,2109 @@
+---
+---
+
+
+
+
+
+
+
+
+
+
+ Magento Enterprise Edition (EE) Release Notes (1.13 and later)
+
+
+
+
+
+
+
+
+
+
+ {% include v1x/eol_message.html %}
+
+
+
+
Magento Enterprise Edition (EE) Release Notes (1.13 and later)
+
+
+
Table of Contents
+
These Release Notes contain the following information:
+ When
+ you install a community-created translation package, the translation provided by the package overwrites any
+ existing translations for the same items. This enables you to more easily install packages with translations.
+
+
+ To
+ improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
+
+ Extension
+ developers can now create an extensions with a dash character in the name. Merchants can install those extensions
+ without issues.
+
+ Magento
+ administrators who attempt to install an extension with insufficient file system privileges are now informed.
+ Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the
+ your Magento install dir/app/code/community directory structure, the Magento administrator
+ sees an error message in the Magento Connect Manager.
+ To set file system permissions appropriately, see After You Install
+ Magento: Recommended File System Ownership and Privileges.
+
+
+
Magento Install Page Displays After SOAP v2 Index Page Refresh
+
Patch name: PATCH_SUPEE-3762_EE_1.14.0.1_v1.sh.
+ Refreshing the SOAP v2
+ index page (http://your-magento-host-name/index.php/api/v2_soap/index/) results in all
+ administrators and customers viewing the Magento installation page.
+
+
Multiple Simultaneous Magento Administrators
+
Patch name: PATCH_SUPEE-3819_EE_1.14.0.1_v1.sh.
+ Multiple Magento
+ administrators can simultaneously add new products; or edit descriptions, edit prices, or edit stock quantities of
+ existing products without causing deadlocks, key violations, or critical data errors. Together with applying the
+ patch, you must set all indexers to Update when scheduled as follows:
+
+
Log in to the Magento Admin Panel as an administrator.
+
Click System > Configuration.
+
In the left navigation bar, from the ADVANCED group, click Index Management.
+
Expand Indexing Options.
+
From each list, click Update when scheduled.
+
Click Save Config in the upper right corner of the page.
+
+
+
+
+
+
+
+
Discover Card Validation Patch Available
+
Magento has fixed an issue that prevented some Discover credit cards from validating properly. The issue was that
+ certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover
+ cards should validate properly.
+
The issue affects EE versions 1.9.1.1 through 1.13.1.0.
Important: This is not a security threat. No data has been
+ compromised or misused. It affects only the ability to validate certain credit card number ranges as valid
+ Discover card numbers.
+
+
+
PHP 5.4 Patch Available
+
You can use PHP 5.4 with Magento EE versions 11.0.0.0–1.13.1.0.
This section discusses how to get patches referenced in these Release Notes. Magento has other patches available
+ from the EE support portal and the partner portal; you
+ can use the following instructions to install any of those patches as well.
Magento EE 1.13.1.0 helps advance overall product quality and ease operations by providing significant tax
+ calculation improvements, a wide range of bug fixes, and several security enhancements.
+
+
Tax Calculation Improvements
+
EE 1.13.1.0 resolves Value Added Tax (VAT) and Fixed Product Tax (FPT) issues so that Magento administrators can
+ create invoices and credit memos to give merchants merchants access to accurate and consistent tax calculations
+ and displays. We've also addressed:
+
+
VAT tax calculation issues for cross-border trade
+
Tax rounding issues when multiple taxes are applied
+
VAT and FPT calculation issues for bundled products
+
Support for the Waste Electrical and Electronic Equipment (W.E.E.E.) recycling tax in the EU
+
+
+
Functional Improvements
+
EE 1.13.1.0 includes bug fixes across important feature areas, including the shopping cart, checkout, content
+ management system, and product import and export function. Many of these updates came from a hackathon held with
+ Magento community developers, which demonstrates the vitality of our development community and their powerful
+ ability to help us advance the platform.
+
+
Security Enhancements
+
EE 1.13.1.0 includes several security enhancements that were identified through our rigorous security assessment
+ process. Magento complements its own comprehensive internal testing with quarterly penetration testing by expert
+ consultants and actively works with the development community to identify security issues in order to harden the
+ platform against potential threats.
+
+
Security Enhancements
+
Magento addressed the following security issues:
+
+
+ Improved the
+ password hashing algorithm.
+ Magento thanks Bjorn Kraus for contributing to this fix.
+
+
+ Resolved
+ issues that could have resulted in Cross-Site Request Forgery (CSRF) in the web store.
+
+
+
+ Resolved potential
+ issues when issuing Return Materials Authorizations (RMAs).
+ Magento thanks Ivan Chepurnyi for contributing to this fix.
+
+ Resolved a session
+ fixation issue when registering a user with the web store.
+
+
+ Closed a potential
+ loophole that enables another user to possibly access personal information when viewing billing
+ agreements.
+ Magento thanks Darryl Adie and Ampersand Commerce for contributing to this fix.
+
+ Resolved a remote
+ code execution vulnerability that enabled an attacker to delete files and directories on the Magento
+ installation. (The attack required access to the Admin Panel as a Magento administrator.)
+
+ Fixed the security
+ settings for the frontend cookie to protect user sessions.
+
+
+
+
+
+
Potential Issue After Upgrading to EE 1.13.1.0
+
There is a known issue after upgrading to EE 1.13.1 that affects you only if you do not follow
+ the recommended procedure to upgrade to a new environment as discussed in Getting Ready For Your
+ Upgrade.
+
Symptom: After completing the upgrade, when you log in to the Admin Panel and click
+ System > Configuration, a fatal error similar to the following displays in your
+ browser:
+
Class 'Mage_Googlecheckout_Helper_Data' not found in /var/www/html/magento/app/Mage.php on line 547
+
+
Solution:
+
+
Close the Admin Panel browser window.
+
As a user with root privileges, delete all files exceptconfig.xml from the
+ following directory:
+
See the following sections for a discussion of changes in this release:
+
+
+ EE's Payment
+ Bridge module has been updated to the latest version.
+ For more information, see this Magento blog post.
+
+ A tax
+ configuration option for Fixed Product Tax (FPT) has changed. This option is in the Admin Panel at
+ System > Configuration > SALES > Tax > Fixed Product Taxes,
+ option FPT Tax Configuration. This option replaces the Apply Tax to FPT option
+ in earlier EE releases.
+ This option specifies how FPT is calculated as follows:
+
+
Not Taxed: Click this option if your taxing jurisdiction does not tax FPT. (For example,
+ the state of California does not tax FPT.)
+
Taxed: Click this option if your taxing jurisdiction does tax FPT. (For example, Canada
+ taxes FPT.)
+
Loaded and Displayed with Tax: Click this option if FPT is added to the order total
+ before applying tax (for example, in EU countries).
+
+
+ You can now
+ specify a 0% tax rate. (In the Admin Panel, click Sales > Tax > Manage
+ Tax Zones & Rates.).
+ For more information, see the Magento User Guide.
+
+ Magento changed
+ its recommended setting for System > Configuration > SALES >
+ Tax > Calculation Settings, option Apply Discount On Prices
+ as follows:
+
+
US and Canadian merchants: Set the value of Apply Discount On Prices to Excluding
+ Tax.
+
EU merchants: Set the value of Apply Discount On Prices to Including
+ Tax.
+
+
+
+ Magento strongly
+ recommends all merchants set Apply Customer Tax to After Discount, regardless
+ of all other tax-related settings. This avoids issues with calculating the total product price.
+
+
+ When you specify a
+ tax rate, the State list is now available whenever you choose a country that has states.
+
+ You can now specify
+ the asterisk (*) wildcard character for the value of State when you set up a new
+ tax rate. This enables you to apply the same tax rate to all states or provinces in a particular country.
+
+ Stores now display
+ in the Admin Panel in System > Manage Stores as a three-column hierarchy, with
+ the website in the left column, all stores associated with the website in the center column, and all store views
+ associated with the store in the right column.
+ This makes it easier for you to browse your stores and understand which websites, store views, and stores are
+ associated with each other. The updated Manage Stores page also displays the root category for each store and
+ the code for each website and store view.
+ Magento thanks Fabrizio Branca for contributing to this fix. For more information, see Fabrizio's
+ blog post.
+
+ For the DHL
+ (Deprecated) shipping method to work, you must change the gateway URL as follows:
+
+
Log in to the Admin Panel as an administrator.
+
Click System > Configuration > SALES > Shipping
+ Methods.
+
In the right pane, expand DHL (Deprecated).
+
Change the value of the Gateway URL field to the following:
+
http://xmlapi.dhl-usa.com/ApiLanding.asp
.
+
In the upper right corner, click Save Config.
+
+
+
+
+
+
Tax Calculation Fixes
+
Tax calculation issues can be divided into the following sections:
The following general fixes were made to Magento tax configuration and calculations:
+
+
+ Canadian customers
+ now receive an e-mail with the correct totals for invoices and credit memos that include Provincial Sales Tax
+ (PST) and Goods and Services Tax (GST).
+
+ Resolved issues
+ with incorrect prices and incorrect tax amounts when a custom price is used together with the configuration
+ setting System > Configuration > SALES > Tax >
+ Calculation Settings, option Apply Tax On set to Original price
+ only.
+
+ The tax amount is
+ calculated correctly when:
+
+
The customer is in a different taxing jurisdiction than the web store
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Catalog Prices is set
+ to Including Tax
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Tax Calculation Method Based
+ On is set to Unit Price
+
+
+
+ The row total
+ including tax displayed in the shopping cart is calculated correctly when:
+
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Catalog Prices is set
+ to Excluding Tax
+
The configuration option System > Configuration > SALES >
+ Tax > Calculation Settings, option Tax Calculation Method Based
+ On is set to Row Total
+
+
+
+ The row subtotal
+ displays the correct amount when reordering a product that includes a discount coupon.
+
+ Multiple tax rates
+ for a product display correctly in the Admin Panel when creating an invoice or credit memo.
+
+ Resolved calculation
+ errors when tax and currency conversion are applied. As a result, the price the customer views on a catalog or
+ product page is the same as the price displayed in the shopping cart.
+
+ A customer can now
+ place an order when two tax rules are applied to a product, even if the tax rules specify the same tax rate.
+
+
+ Resolved issues with
+ calculating taxes on orders that are shipped to different countries that have different tax rates.
+
+ Product prices,
+ including taxes, display on category and product pages the same for a guest customer as for a logged-in
+ customer. (A guest customer is a customer who does not log in to your web store; this customer belongs to the
+ NOT LOGGED IN customer group.)
+
+
+
+
Rounding Issues
+
The following tax rounding issues were resolved:
+
+
+ Resolved a
+ rounding issue in the tax detail display in the shopping cart when more than one tax rule is used.
+
+ Resolved an issue
+ reported on stackoverflow where a calculation error resulted from the following configuration:
+ System > Configuration > SALES > Tax > Calculation
+ Settings, option Tax Calculation Method Based On set to Total
+ System > Configuration > SALES > Tax > Calculation
+ Settings, option Catalog Prices set to Including Tax
+
+ As a result of
+ allowing a 0% tax rate, rounding errors related to different VAT jurisdictions have been resolved. For example,
+ if a product originates in a country with VAT but is shipped to another country that has no VAT, correct prices
+ display in the shopping cart.
+
+ Row totals display
+ correctly in the shopping cart when:
+
+
A shopping cart discount is applied
+
The following configuration options are set in System > Configuration >
+ SALES > Tax > Calculation Settings:
+
+
Catalog Prices is set to Including Tax
+
Tax Calculation Method Based On is set to Excluding Tax
+
Apply Customer Tax is set to After Discount
+
Apply Discount On Prices is set to Including Taxes
+
+
+
+
+
+
+
+
Display Issues
+
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
+ store:
+
+
+ Shipping prices
+ including tax display properly in the shopping cart.
+
+ A special price now
+ displays correctly on the product view page.
+
+ Values displayed in
+ PDFs for invoices and credit memos no longer overlap each other.
+
+ Orders, invoices,
+ and credit memos for downloadable and virtual products display the correct row total when viewed in the Admin
+ Panel.
+
+ Orders display the
+ FPT in the Admin Panel when the full tax summary is specified.
+
+ Fixed-price
+ bundled products that include FPT now display only one price for both From and To values, regardless of how you
+ configured the products.
+
+
+
+
+
Bundled Products Issues
+
+
+ The price of a
+ dynamic bundled product is calculated correctly after being customized by the customer.
+
+ The price of a
+ dynamic bundled product with tiered pricing is calculated correctly after being customized by the customer.
+
+ Resolved issues
+ with calculating the value displayed for the price including tax for bundled products.
+
+ The price
+ excluding tax of a bundle product to which a discount is applied is the same:
+
+
When viewed on the customization page
+
after adding the bundled product to the shopping cart.
+
+
+
+ A dynamically-priced
+ bundled product's prices displayed for Unit Price in the shopping cart (that is, the price including tax and the
+ price excluding tax) are now correct. Before the fix, the prices were equal, which was incorrect.
+
+ The
+ price of a bundled product displayed on the product view page and in the shopping cart are the same.
+
+ The grand total
+ including tax and the subtotal including tax displayed in the shopping cart are now identical when you specify
+ that catalog prices include tax and the shopping cart is set to display prices with and without taxes for a
+ dynamic bundled product that consists of two simple products.
+
+
+
+
Fixed Product Tax (FPT) Issues
+
+
+ Resolved
+ issues in calculating FPT on a credit memo.
+
+ With both
+ discounts and FPT enabled (and FPT is taxable), the subtotal including tax displayed in the shopping cart is
+ correct.
+
+ FPT calculation
+ for bundled products that have FPT applied to them now are now correct for all FPT configuration settings.
+
+ The invoice total
+ is calculated correctly for an order that has both FPT and a shopping cart discount.
+
+ The FPT amount is
+ now included in the Subtotal (Incl.Tax) row for partial invoice.
+
+ Resolved an issue
+ that resulted in FPT being applied twice to the grand total in the shopping cart.
+
+
+
+
+
Fixes in Magento EE 1.13.1.0
+
Fixes in this release can be divided into the following categories:
+ Abandoned cart
+ e-mails are sent at the scheduled time.
+
+ Resolved a new
+ customer registration issue that enabled a user to register and see another customer's dashboard.
+
+ Resolved issues with
+ breadcrumbs disappearing or displaying incorrectly.
+
+ With the following
+ configuration, gift pricing is applied properly for more than one item.
+ The following options are available in the Admin Panel in System >
+ Configuration > SALES > Sales > Gift Options:
+ Allow Gift Wrapping on Order Level set to No
+ Allow Gift Wrapping for Order Items set to Yes
+
+ Category and
+ subcategory names display correctly. Before the issue was resolved, subcategory names that were significantly
+ longer than the category name did not display properly.
+
+
+ If a customer adds
+ more than one product that requires products to be purchased in increments, only the products that meet the
+ increment requirements are added. Before the fix, all products were added.
+
+ Scheduled payments
+ work properly.
+ Magento thanks Sylvain Raye for contributing to this fix.
+
+ If a bundled or
+ configurable product is out of stock, it's no longer available to check out.
+ Magento thanks Francesco Marangi for contributing to this fix.
+
+ Placing an order
+ in the Admin Panel correctly sets the order status to Pending.
+ Magento thanks GitHub user elframan for contributing to this fix.
+
+
+
+
+
Import and Export Fixes
+
+
+ Scheduled export
+ works properly.
+
+ You can now export
+ a shipment to CSV after printing its shipping label.
+ Magento thanks Florinel Chis for contributing to this fix.
+
+
+
+
Shipping Fixes
+
+
+ You are not
+ required to enter a declared value to ship with FedEx.
+
+ FedEx shipping
+ labels print properly; addresses are not truncated.
+
+ Fix for the USPS
+ change to the names of their Priority and Express shipping options in their API made on Sunday, July 28, 2013.
+
+
+
+
Payment Fixes
+
+
+ The PayFlow Pro
+ payment method now allows line items with a negative value.
+
+ You can now use the
+ GSI Payment Service with Magento Payment Bridge.
+
+
Made the following fixes to eWay Direct:
+
+
+ Updated the
+ Payment Bridge console for eWay Direct.
+
+ You can now
+ process credit memos for eWay Direct.
+
+ Capture for eWay
+ direct now works as expected (that is, after the order is placed, the transaction is not captured but
+ can be refunded.
+
+
+
(
+ Because refunds are
+ not supported by the Paybox Direct method, you cannot process refunds using the Admin Panel.
+
+ After creating a
+ refund for a First Data transaction, the transaction is closed.
+
+ You can now pay for
+ an order using Sagepay.
+
+ You can now pay for
+ an order using Worldpay.
+
+ Line item details
+ are now available for orders placed using Sage Pay.
+
+ Authorize.net sends
+ only one validation request per transaction with Customer Information Management (CIM) enabled.
+
+
+
+
+
Other Fixes
+
+
+ Resolved issues that
+ caused spurious errors in the Magento exception log:
+ 'Zend_Date_Exception' with message 'Invalid year, it must be between -10000 and 10000'
+
+ Merging CMS pages no
+ longer results in errors.
+
+ Widgets display
+ properly on the CMS.
+
+ Previewing a CMS page
+ works properly.
+
+ The product attribute
+ option Use Default Value works properly when used in a non-default store view.
+
+ A category attribute
+ set to store view scope displays in layered navigation.
+
+ A store set for
+ British Pound Sterling currency units now displays the correct currency in payment logs.
+
+ Resolved an issue with
+ the Mage_Catalog_Block_Product_Abstract class that caused errors to display on product view pages in
+ your web store.
+
+ Fixed issues with
+ customer segments.
+
+ Back-in-stock e-mails
+ contain the correct content.
+
+
+
+
+
+
+
+ You can now manage
+ product ratings and reviews from the Admin Panel as well as from the web store.
+ Magento thanks Fabian Blechschmidt Schrank for contributing to this fix.
+
+
+ Resolved an issue
+ with Mage_Page_Block_Template_Links::addLinkBlock to enable you to sort an array of results by
+ position.
+ Magento thanks Benjamin Marks for contributing to this fix.
+
+
+
+
Magento EE 1.13.0.2 Release Notes
+
In response to customer feedback about EE 1.13.0.0 and EE 1.13.0.1, Magento has modified the functionality to
+ smooth the migration path from earlier EE versions and support duplicate category URL keys.
+
See the following sections for a discussion of changes in this release:
Perform all new installations and upgrades to Magento EE 1.13.0.2—not to Magento EE
+ 1.13.0.0 or 1.13.0.1—to avoid issues with missing products on your web store due to duplicate URL
+ key issues during the upgrade.
The main difference introduced in EE 1.13.0.2 is that product URL keys must be globally unique among all
+ websites, stores, and views. You can no longer have two different products that have the same URL key.
+
Benefit:
+
A single URL leads uniquely to a product page.
+
Discussion:
+
+
In EE 1.12, it was possible to have multiple products with the same URL key; however, every time the indexer
+ ran, it silently assigned a numerical suffix to duplicates (for example, shoes became
+ shoes-1 and so on).
+
Every time this happened, another URL rewrite was created, resulted in a set of chained redirects for
+ the same product. Having multiple URLs for a product dilutes the effectiveness of URL in search engine
+ weightings, especially if you enabled canonical URLs. (As discussed in this
+ article on Google's blog, a canonical URL is a public specification of your preferred URL. The
+ canonical URL is used by any search engine when crawling and indexing your site.)
+
This behavior was not clear to merchants and had the effect of diluting search engine weightings.
+
In EE 1.13.0.2, there is a single, unique way to access a product (or multiple ways if you use the category
+ path in URLs).
+
+
+
+
No more chained redirects
+
+
Description:
+
Magento addressed the indexer issue that resulted in suffixes being silently added to products with duplicate
+ URL keys. In EE 1.13.0.2, duplicate URL keys are not allowed.
+
Benefit:
+
Search engines recognize the canonical URL, which improves the product's weighting in search results. (All of
+ the weighting goes to the canonical URL.)
+
+
+
Per-entity indexing
+
+
Description:
+
EE 1.13.0.2 uses per-entity indexing that indexes custom URL redirects, categories, and products—as
+ opposed to a global indexer.
+
Benefit:
+
+
Similar to chained redirects, in EE 1.12, if a product had the same URL key as its parent category, the indexer
+ assigned an incrementing numeric suffix to either the category or the product. This was done without the
+ merchant's knowledge and was confusing as well.
+
+
Discussion:
+
+
In EE 1.12, if you named a top-level category slippers and had product also named
+ slippers, the indexer allowed to access to the category using a URL like the following:
+ http://www.example.com/slippers-1
+
In EE 1.13.0.2, the same product can be accessed using a URL like:
+ http://www.example.com/slippers
+
There is a new Admin Panel setting to specify how indexing should be prioritized. This setting,
+ System > Configuration > CATALOG > Catalog > Search
+ Engine Optimizations > Priority for Duplicated URL Keys, is discussed in more
+ detail in Prioritizing URL Resolution.
+
+
+
+
+
+
URL Key Uniqueness Rules in Magento EE 1.13.0.2
+
The following entities can be indexed and therefore have a requirement for URL key uniqueness:
+
+
Categories
+
Products (including custom URL redirects)
+
Content Management System (CMS)
+
+
Uniqueness rules for each entity type follow:
+
+
+
+
Entity type
+
Uniqueness rule
+
+
+
Product, including custom URL redirects†
+
All product URL keys must be globally unique.
+
+
+
Category
+
+
Category URL keys must be unique only in the same level in the hierarchy; for example
+ website
+ root category
+ store view
+ category tree
+ *category name*
+
Note: Uniqueness rules apply to inactive categories as well. You cannot use the same URL
+ key for both an active and inactive category at the same level in the category hierarchy.
+
+
+
+
CMS
+
CMS URL keys, like category URL keys, must be unique only in the same level in the
+ hierarchy.
+
+
+
+
†—Custom URL redirect refers to a product's Create Custom Redirect
+ for old URL option.
+
+
URL Key Examples
+
The following table shows category URL keys that are allowed. (The URL key is shoes for all entities
+ in the table.)
You cannot have the same category URL key for two categories at the same level in the same store
+ view.
+
You can optionally add the store code to the URL path (in the Admin Panel, click System >
+ Configuration > GENERAL > Web, Add Store Code to Urls).
+
+
+
Prioritizing URL Resolution
+
Suppose you have the following set of URL keys. All of them are allowed because they're for different entity types.
+
+
+
+
+
Entity type
+
Entity name
+
URL key
+
Sample URL
+
+
+
Category
+
shoes
+
shoes
+
http://www.example.com/shoes.html
+
+
+
Product
+
shoes
+
shoes
+
http://www.example.com/shoes.html
+
+
+
Custom URL redirects
+
shoes
+
shoes
+
http://www.example.com/shoes.html
+
+
+
+
Question: What happens when a web store visitor requests
+ http://www.example.com/shoes.html?
+
Answer: You control the response in the Admin Panel. Click System >
+ Configuration > CATALOG > Search Engine Optimizations. In the right pane, click an
+ option from the Priority for Duplicated URL Keys list. Some examples follow:
+
+
+
+
Priority setting
+
Result
+
+
+
Default setting:
+
+
Redirect†
+
Category
+
Product
+
+
+
Custom URL redirect
+
+
+
+
+
Category
+
Redirect
+
Product
+
+
+
Shoes category
+
+
+
+
†—Custom URL redirect refers to a product's Create Custom Redirect
+ for old URL option.
+
The other options are:
+
+
Redirect - Product - Category
+
Category - Product - Redirect
+
Product - Redirect - Category
+
Product - Category - Redirect
+
+
In the event no URL key matches your priority setting, Magento continues through the priorities in order until a
+ match is found.
+ After changing the
+ value for product or category suffix, previous suffixes do not work.
+
For example, if a category URL suffix was set to .html and you change it to .php,
+ categories that had been using the .html suffix display an HTTP 404 (Not Found) error in your web store.
+
(In the Admin Panel, click System > Configuration > CATALOG >
+ Catalog > Search Engine Optimizations. In the right pane, the options are named
+ Product URL Suffix and Category URL Suffix.)
+
+
Patch Available for EE 1.13.0.2
+
The United States Postal Service (USPS) changed the names of their Priority and Express shipping options in their
+ API on Sunday, July 28, 2013. Magento has a patch available; however, this patch is not included in new EE 1.13.0.2
+ installations.
+
Note: If you applied the patch before you upgraded to EE 1.13.0.2, you don't
+ have to do anything.
+
+
For new EE 1.13.0.2 installations to continue utilizing USPS Priority and Express mail methods, you must
+ install the patch we've created to address the issue.
+
Get the patch from the EE support portal by logging in to magentocommerce.com.
+
+
Changes in EE 1.13.0.2
+
+
+ You
+ now have the option of specifying a store view when creating a URL redirect. There is also a Store column on the
+ Catalog > URL Redirects page.
+ This column specifies the store view for which the URL redirect is defined.
+
+ Root categories have
+ no URL Key field. The root category URL key was never used, so the field was eliminated.
+
+ Validation
+ for the URL key field was improved. URL keys can only contain alphanumeric characters (a-z, 0-9)
+ and the hyphen or dash character (-).
+
+ Categories and
+ products in categories display with the full category path if the following setting is made in the Admin Panel:
+ System > Configuration > CATALOG > Catalog. Set the option
+ named Use Categories Path for Product URLs to Yes.
+
+ When setting up a
+ product URL redirect, the name of the button on the category selection page has changed from Skip choosing
+ category to Skip Category Selection.
+
+ There is a new
+ setting in the Admin Panel to set the priority for resolving duplicate URLs for different entities (that is,
+ custom URL redirects, categories, and products). For more information, see Prioritizing URL Resolution.
+
URL key uniqueness rules apply to inactive categories as well. You cannot use the same URL key for both an
+ active and inactive category at the same level in the category hierarchy.
+
The Google sitemap for products and categories is updated with new or updated URL keys at the interval you
+ specify in the Admin Panel: System > Configuration > CATALOG > Google
+ Sitemap. In the right pane, expand Generation Settings.
+
The following apply to new products when you do not explicitly set a value for the URL key
+ field:
+
+
Duplicating a results in a URL key with an appended index number. For example, if you duplicate a product
+ with a URL key of testurlkey, the new product's URL key might is testurlkey-1.
+
If you create a new product with a name that matches an existing URL key, the new product's URL key has the
+ product ID appended to it. For example, if there is currently a product with a URL of product1
+ and you create a new product with the name Product1 and the product has an ID of 500, the new
+ product's URL key is product1-500.
+
Note: To avoid having Magento specify a URL key for you,
+ you can enter one yourself. Make sure the URL key you specify is unique among all products, including
+ products across store views.
+
+
+
+
The following apply to enabling the canonical meta tag options for categories and products:
+
+
If Use Canonical Meta Tag for Categories is enabled, the category page on your web store
+ includes a canonical URL to the full category URL. For example, http://www.example.com/mens/shoes
+
+
If Use Canonical Meta Tag for Products is enabled, the product page includes a canonical
+ URL to domain-name/product-url-key because product URL keys must be globally
+ unique.
+ If you also enable the option Use Categories Path for Product URLs, the canonical URL is
+ still domain-name/product-url-key but the product can also be accessed using
+ its full URL (including the category hierarchy). Examples:
+ If the product URL key is producturlkey and it's assigned to the Apparel > Womens >
+ Purses category, the product can be accessed using both of the following URLs:
+ http://www.example.com/producturlkey
+ http://www.example.com/apparel/womens/purses/producturlkey
+ The canonical URL for the product is http://www.example.com/producturlkey.
+
Notes:
+
The canonical URL options are available in the Admin Panel by clicking System >
+ Configuration > CATALOG > Catalog. In the right pane, expand
+ Search Engine Optimizations. The options are named Use Canonical Link Meta Tag
+ For Categories and Use Canonical Link Meta Tag For Products.
+
The option to add the category path to a product URL is available in the same location in the Admin
+ Panel. The option name is Use Categories Path for Product URLs.
+
+
+
+
+
Fixes in Magento EE 1.13.0.2
+
This section discusses fixes made in EE 1.13.0.2.
+
+
+ Resolved a
+ critical database deadlock in the URL rewrite indexer. The deadlock resulted in the following message in the
+ exception log: SQLSTATE[40001]: Serialization failure: 1213 Deadlock found when trying to get
+ lock.
+
+ The following
+ layered navigation issues were addressed:
+
+
If a subcategory contains a product that is associated with the parent category, you can view the
+ subcategory in your web store.
+
Clicking a link for a product attribute in an anchor category works.
+
+
+
+ You can now
+ install or upgrade to EE 1.13.0.2 if your Magento database had a table prefix (for example, all tables start
+ with mage_ because you specified a tables prefix during installation).
+
Resolved the following upgrade issues:
+
+
+ After
+ upgrading from an earlier version like EE 1.12.0.2, errors such as the following no longer display in the
+ Magento exception log:
+ SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry
+
+
+ Resolved an
+ issue that prevented web store users from viewing products that had duplicate URL keys before upgrading.
+
+
+
+
+
+
Resolved the following issues with URL keys in store views:
+
+
+ Changing
+ the store view no longer results in product or category 404 (Not Found) errors.
+
+ Resolved an
+ issue that categories created from a store view had the wrong URL format in the web store. Examples
+ follow:
+ Incorrect (before the fix): /catalog/category/view/s/newcategory/id/36/
+ Correct: /catalog/newcategory/
+
+
+
+ Resolved an
+ issue where a product could be viewed using a category to which it was not assigned.
+ This behavior was associated with the following Admin Panel setting: System >
+ Configuration > CATALOG > Catalog.
+
+ Moving a
+ category no longer results in HTTP 404 (Not Found) errors viewing a category's product in the web store.
+
+
+
+ Categories
+ display in the web store with the correct URL key, even if the category was previously deleted and added back
+ with the same URL key.
+
+ A customer can
+ view a product from the Recently Viewed Products list if the product is associated with a different category
+ than the one the customer is currently viewing.
+
+ Any product
+ page displays properly when the user accesses it from the site map on your web store.
+ This includes the case when an administrator sets the following option to Yes:
+ System > Configuration >CATALOG > Catalog
+ > Search Engine Optimizations, option named Use Categories Path for Product
+ URLs.
+
+ The category is
+ not included in the URL to a product in your web store when an administrator sets following option to
+ No: System > Configuration >CATALOG >
+ Catalog > Search Engine Optimizations, option named Use Categories
+ Path for Product URLs.
+
+ The URLs for
+ the same category and product, when assigned to multiple store views, are as expected.
+ Category URL example: /parent-category/category-2/
+ Product URL example: /parent-category/category-2/product-1
+
+ With the option
+ to Add Store Code to URLs option enabled, store codes properly display in URLs and the store view displays
+ properly.
+
+ After
+ duplicating a product, the product's URL key updates successfully.
+
+ A product URL
+ key is correct in your web store even if there is a category with the same URL key as the product.
+
+ Adding products
+ without specifying a value for the URL Key field no longer results in the exception log entry
+ SQLSTATE[23000]: Integrity constraint violation.
+
+ You can create
+ two or more categories with the same URL key without encountering the exception log entry
+ SQLSTATE[23000]: Integrity constraint violation.
+
+ The value of a
+ product's URL Key field is properly validated.
+ A URL key can contain only alphanumeric characters (a-z, A-Z, 0-9) and the dash or hyphen character.
+
+ A caching error
+ that affected changing URL redirects was fixed.
+
+ URL redirects
+ work properly when products are assigned to categories in different store views but using the same request
+ path.
+
+ You can
+ successfully import data and reindex with the import behavior set to Append Complex Data.
+
+ After moving a
+ category to another location in the category hierarchy, the category's URL and breadcrumbs update
+ successfully.
+
+ The options to
+ create a custom redirect for a category and product work properly.
+ (In the Admin Panel, click System > Configuration > CATALOG >
+ Catalog > Search Engine Optimizations. In the right pane, from the
+ Create Permanent Redirect for URLs if URL Key Changed, click Yes.
+
+ Switching store
+ views enables you to navigate to products and categories on that store view as expected. HTTP 404 (Not Found)
+ errors no longer display and the specified category and product URL keys are correct.
+ In earlier EE versions, incorrect behavior was reported when the setting System >
+ Configuration > GENERAL > Web, Add Store Code to Urls was
+ set to Yes.
+
+ A remote code
+ execution vulnerability was fixed.
+
+
+
+ On
+ a clean installation, display errors are hidden.
+
+
+
+
+
Magento EE 1.13.0.0 Release Notes
+
See the following sections for information about changes in this release:
Major overhaul of tax calculation formulas, correction of rounding errors, and additional assistance with
+ configuration
+
+ Most indexing processes now run only to update products, categories, URL redirects, and so on that
+ have changed—eliminating the need for manual full reindexing
+ Full page caching now invalidates only pages that are affected by product or category changes
+
Optimized cache adapters for single-server systems
+
Elimination of many types of database deadlocks
+
+
+
Security Enhancements
+
+
The Magento Admin Panel and web stores no longer allow web browsers to store usernames or passwords.
+
The Magento web store has additional Cross Site Request Forgery (CSRF) protections, meaning an imposter can
+ no longer impersonate a newly registered customer and perform actions on the customer's behalf.
+
In earlier versions, Magento was vulnerable to a session fixation attack during the registration process.
+ After logging in to their account, a registered user's session ID did not change. Therefore, if an attacker
+ had knowledge of an unauthorized session ID and if that user successfully registers, the attacker was able to
+ take over the newly registered account.
+ Now, the session ID changes after successful registration, making unauthorized use of an account impossible.
+
+
The cryptographic methods used to store passwords were improved to enhance security.
+
+
+
+
Security Advisory
+
Magento has identified a potential vulnerability that might affect you if both of the following are true:
+
+
Your store uses custom code that calls Magento full page caching functions
+
You enabled the Use SID on Frontend configuration option
+ (In the Admin Panel, System > Configuration > WEB > Session
+ Validation Settings, Use SID on Frontend.)
+
+
Note: The potential vulnerability exists only if both
+ of the preceding are true. Default Magento installations or installations that enable Use SID on
+ Frontend but have no custom code with full page caching are at no risk.
+
+
If both of the preceding are true, Magento can be subjected to cross-site scripting
+ (XSS) attacks—a type of injection issue, which means that malicious code is injected into otherwise
+ trusted websites, generally in the form of a browser-side script.
+
Issue: Magento is subject to XSS attacks because the SID cookie value is not sanitized by default.
+
Suggested solution: Either disable Use SID on Frontend or output-encode any usage of the SID cookie value before using it or passing it as a
+ parameter to any page cache helper functions.
Magento EE 1.13—unlike earlier versions—does not allow duplicate URL keys for products or
+ categories. An issue has been identified that causes problems during upgrades if you already have duplicate URL
+ keys. The issue is being addressed; until a solution is announced, Magento recommends you test your upgrade but
+ do not try to deploy it to a production environment.
Limited the way Magento performs large database lookups.
+
+
+
Checkout performance improvements achieved by:
+
+
Eliminating unnecessary calls to gift wrapping when loading the Shipping Method checkout step
+
Eliminating unnecessary RSS cache cleanups when RSS functionality is disabled
+
The locale used to send a new order confirmation e-mail now first checks to see if the customer's locale
+ is the same as the store's locale before attempting to localize the e-mail.
+
+
+
Improving the overall checkout process performance by loading the progress information for the current
+ checkout step only
+
+
+
You can load a large number of tax codes (35,000 or so) without impacting performance.
+
+
The following general fixes were made to Magento tax configuration and calculations:
+
+
Based on Magento testing and merchant experience, certain tax configuration settings have been determined to be
+ susceptible to rounding issues and can be confusing to buyers. To help you avoid issues with those settings,
+ warning messages display in the Admin Panel if you attempt to save such a configuration.
+ Administrative users can choose to dismiss the messages and can still save the configuration; however, Magento
+ strongly recommends you change the configuration in a way recommended by the details displayed in the
+ message.
+ For details, see the Magento
+ User Guide.
+
+
+
Bundle pricing is more consistent as follows:
+
+
The calculation formula is:
+ Sub item price = Sub item base price * Applicable tiered price adjustment or discount, then rounded
+ Bundle price = Sum (round(sub item price * qty))
+
When non-integer quantities are multiplied by a product price, Magento rounds the resulting subtotal is as
+ follows:
+ round(unit price * non-integer quantity)
+
+
+
All product price information on which taxation is based are rounded to two digits of precision regardless of
+ how many digits of precision have been loaded into the database (for example, $10.24 instead of $10.2385). This
+ situation can occur when certain integrations enable third-party applications to send four-digit precision prices
+ to Magento.
+ Starting with this release those additional digits will have no impact on customer facing prices. Forcing two
+ digits of precision enables more exact calculations involving Fixed Product Tax (FPT), discounts, and
+ taxes—among other concerns.
+
+
+
For certain Canadian provinces and localities, calculations and methods were updated to support changing legal
+ requirements in Canada:
+
The following issues relate to one-cent rounding errors in the web store or shopping cart:
+
+
Calculating taxes for bundled products with tiered pricing.
+
Calculating the price before customization for bundled products.
+
+
+
Calculating the grand total of items added to a cart in a different order.
+
Viewing an order when taxes are calculated after a discount using either row-based or unit price.
+
+
+
Applying a discount to an order with a shipping address different than the billing address.
+
+
+
Calculating the grand total based on the order in which products are added to the shopping cart.
+
+
+
Specifying that prices display in the web store excluding tax and setting a 20% tax rate (or discount rate) now
+ calculates the grand total correctly. It is now possible to have grand totals in amounts like 6.99, 9.99, or
+ 99.99—regardless of the currency units used in the web store.
+
+
+
Adding multiple items to a cart does not affect the accuracy with which taxation is calculated.
+
+
+
Subtotal (Incl. Tax) is now correct when catalog and shipping prices include tax. Both tax and discounts are
+ applied after tax.
+
+
+
Prices displayed in the cart and on the catalog page are consistent and correct when catalog prices include tax,
+ and when items in the catalog are set to display both including and excluding tax.
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
+
+
Error in calculating the Grand Total Excl. Tax was resolved. This error occurred in a specific configuration:
+ tax is applied to FPT, FPT is included in the subtotal, and the customer selects non-taxable flat rate shipping.
+
+
+
+
+
+
Fixed Product Tax (FPT) Fixes
+
The following issues relate to errors in calculating taxes that include FPT in the web store or shopping cart:
+
+
Price in the cart displays the correct before-tax price and grand total.
+
+
+
Subtotals displayed in the cart—both Including Tax and Excluding Tax—are now correctly calculated
+ when FPT is applied.
+
Free shipping offers are now processed correctly when FPT is applied.
+
FPT taxes are calculated correctly when a discount is applied.
+
+
+
+
+
Discount Calculation Fixes
+
The following issues relate to price calculations when coupon codes or other discounts are applied in the web store
+ or shopping cart:
+
+
The Row Subtotal displayed in the cart is calculated correctly (that is, both Excl. Tax and Incl. Tax are
+ correct).
+
The price for bundled items now displays with tax included if the bundle is configured to do so.
+
Taxation is now correctly calculated on a product with a discounted price.
+
Taxation on discounts is now calculated correctly when the ship-to country is different from the web store's
+ default country.
+
+
+
Display Fixes
+
The following issues relate to the incorrect display of tax information in the Admin Panel or in your Magento web
+ store:
+
+
Row Subtotal displays correctly in the shopping cart when:
+
+
FPT is applied.
+
+
+
A discount is applied to a situation where the tax the customer pays is different from the tax specified for
+ the web store's locale (for example, when the shipping origin is different than the shipping address).
+
+
+
+
+
Subtotal including tax on a credit memo is correct when one or more items in the memo includes FPT.
+
+
+
Item subtotal displays correctly when a discount is applied to a purchase that includes FPT.
+
+
+
If the administrator sets catalog prices to exclude tax and to display product prices in catalog as including
+ tax, the price of the product in your web store includes applicable taxes.
+
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
When Minimum Advertised Price (MAP) is enabled and the customer examines the price of a product in a gift
+ registry, the price includes all of the following: price, actual price, price including tax, and price excluding
+ tax.
+
+
+
The amount of tax displayed in the Order Totals section of the shopping cart is now correct when free shipping
+ and a shopping cart rule discount are applied.
+
+
+
+
+
API Fixes
+
The following are fixed in the Magento SOAP v2.0 APIs (with exceptions noted):
+
+
Requesting a product using a call like the following returns the product with the specified numeric SKU value
+ (8888 in the following example):
+ $result = $client->call($sessionId, 'catalog_product.info', '8888', null, null, 'sku');
+
+
You can now use from-to complex filters to perform "window" filtration on a single
+ field. For example, you can use from and to on the created_at return a list
+ of sales orders using the salesOrderList.
+
+
+
When you use the SOAP API v.2.0 with WS-I Compliance enabled to retrieve sales orders information, the server responds with the
+ correct Content-Length header.
+
+
+
The productGetSpecialPrice method returns special price information for a product, whether or not
+ WS-I Compliance is
+ enabled.
+
+
+
The shoppingCartPaymentList method returns the list of the available payment
+ methods for the shopping cart appropriately. The following error is no longer returned:
+ SOAP-ERROR: Encoding: object has no 'code' property in name
+
+
You can now add a C# web reference in Microsoft Visual Studio 2010 using the Magento WSDL.
+ For example, this command no longer fails:
+ C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin> wsdl /out:Magento.cs /v
+ http://magentohost/api/v2_soap/?wsdl
+
+
When a product price is set with website scope and an administrative user has access to only one website, the
+ default price is taken from that website scope. Also, when saving the product on the website scope, the price is
+ updated only in that scope and not in the default scope.
+
+
+
An error no longer displays on your web store after a customer places an order. (The error message was
+ There has been an error processing your request. Please contact us or try again later).
+
+
+
Restricted coupon codes work properly, even if the customer has selected the Remember me
+ checkbox.
+
+
+
Using the Table Rates shipping option, free shipping options work properly. (In the Admin Panel, click
+ System > Configuration > SALES > Shipping
+ Methods. In the right pane, expand Table Rates.)
+
+
+
Issues with shipping table rates have been resolved.
+
+
+
Reward Points are now granted one time per order, even when comments are added to the order later.
+
+
+
Entering a value such as 10,50 (using a comma character and not a period) for Adjustment
+ Fee now results in the correct amount of credit being applied to the transaction.
+
+
+
Unit price for bundled products is now calculated correctly.
+
+
+
The tiered price of bundled items now displays properly on the web store.
+
+
+
Composite products can be successfully reordered.
+
+
+
You can now use special characters in a product URL key.
+
+
+
After a customer visits the sitemap, web stores URLs are no longer prepended by
+ /sitemap/catalog/string.
+
+
+
Welcome messages now display properly in the web store after a customer's profile information is changed.
+
+
+
Recently viewed products now display updates properly.
+
+
+
Armed Forces Middle East is now available for State when checking out.
+
+
+
Gift wrapping charges now display properly in a PDF invoice.
+
+
+
Searching for a customer's orders and returns works properly.
+
+
+
Shipping is calculated correctly if you select Using origin weight (few requests) for
+ Packages Request Type. (In the Admin Panel, click System >
+ Configuration > SALES > Shipping Methods > DHL (Deprecated)).
+
+
+
Free shipping is no longer available to a customer during checkout if the option was disabled by an
+ administrator. (In the Admin Panel, click System > Configuration >
+ Sales > Shipping Method > DHL(Deprecated), click one or more
+ options from the Allowed Methods list, and, from the Free Shipping with Minimum Order
+ Amount list, click No.)
+
+
+
A user can navigate your web store while downloading a downloadable product.
+
+
+
You can now specify weight units in kilograms (kg) using the FedEx shipping method.
+
+
+
FedEx shipping rates are now consistent with Magento discounted rates.
+
+
+
Fixed issues with United Parcel Service (UPS) shipping rates.
+
+
+
An issue that caused a fatal error in the web store for an item in a gift registry has been resolved. The issue
+ occurred when the item was removed from a website after a user had added the item to their gift registry.
+
+
+
UPS shipping labels have the word SAMPLE printed on them only when you request a sample label.
+
+
+
Changes made to United States Post Office (USPS) APIs and rates have been incorporated in Magento.
+
+
+
You can now process a return materials authorization (RMA) for an order that was shipped to multiple addresses.
+
+
+
The products in a customer's wish list no longer disappear after one or more products are edited by an
+ administrator.
+
+
+
Administrators can view the contents of a customer's shopping cart.
+
+
+
The price of a simple product now displays properly when category permissions are enabled. (To set category
+ permissions in the Admin Panel, click Catalog > Categories > Manage
+ Categories, select a category, and click the Category Permissions tab.)
+
+
+
Issues with purchasing a product using a gift card created with a custom option have been resolved.
+
+
+
+ When a customer selects a product on your web store, the assigned category is selected in the
+ navigation menu.
+
+
+
+ With both flat index options enabled and set to update on save, mass attribute updates now display
+ properly in your web store.
+ For more information about flat catalog options, see the Magento User Guide.
+
+
+
+ With both flat index options disabled, after adding a product to many websites and assigning it to
+ one or more categories, the product displays in the appropriate websites and categories in the web store.
+
+
+
+ You can now use multiple selection attributes in a customer segment.
+
+
+
+
+
Promotional Price Rule Fixes
+
The following fixes relate to administering and using shopping cart price rules and catalog price rules:
+
+
Shopping cart price rules applied to specific customer groups work properly.
+
+
+
Catalog price rules are applied properly to customer groups.
+
+
+
The scope of a product attribute is now honored by a catalog price rule.
+
+
+
Discounts specified by a shopping cart price rule are applied properly when a particular order is shipped to
+ multiple addresses.
+
+
+
You can add a gift card to an order that qualifies for a 100% purchase price discount specified by a shopping
+ cart price rule.
+
+
+
A discount specified by a shopping cart price rule that allows for more than one use per customer is applied the
+ correct number of times if the customer has their orders shipped to more than one address.
+
+
+
+
When an administrative user whose role is restricted to only viewing catalog price rules, the user cannot add or
+ edit catalog price rules.
+
+
+
Shopping cart price rules now work properly with bundled products.
+
+
+
+
+
Administrative Ordering and Credit Memo Fixes
+
+
When you create an order using the Admin Panel and you have multiple stores, the State/Province
+ field updates appropriately for the country in which the order is placed.
+
+
+
When you create an order using the Admin Panel and you have specified a default billing address and a default
+ shipping address, the addresses are used correctly.
+
+
+
Orders placed by an administrator display in a customer's last order list.
+
+
+
Product comparisons now display properly when an administrator makes a change using the Admin Panel (for
+ example, deleting a product from a customer's comparison list).
+
+
+
You can now cancel an order using the Admin Panel.
+
+
+
Orders and invoices that include taxable shipping—when created in the Admin Panel—now calculate the
+ shipping taxes properly.
+
+
+
Products added to a customer's wish list by an administrator display properly.
+
+
+
Issues with the incorrect number of reward points being credited when issuing credit memos have been resolved.
+
+
+
+
+
Import Fixes
+
+
The quantity (QTY) of all products imports correctly.
+
+
+
The value of Maximum Qty Allowed in Shopping Cart (use_cfg_max_sale_qty) is correct.
+
+
+
The product displays correctly in layered navigation.
+
+
+
Importing customer lists with capitalization variations in the e-mail address now imports the customer only once
+ (for example, user@example.com and User@example.com).
+
+
+
+ Issues with importing products with Append Complex Data selecting from a
+ comma-separated value (.csv) file have been resolved.
+
+
+
+
Payment Fixes
+
+
Resolved issue sending customer e-mail when using Payflow Link.
+
+
+
Security issues with Google Checkout payments have been resolved.
+
+
+
Security issues with Authorize.net payments have been resolved.
+
+
+
Magento conforms to the latest version of the PayPal Instant Payment Notification (IPN) guidelines.
+
+
+
The contents of a shopping cart are unaffected by canceling a PayPal payment.
+
+
+
Issues with not being able to continue checkout after switching payment methods have been resolved.
+
+
+
You can now process partial refunds and invoices for orders that were placed using Payflow Pro.
+
+
+
Payflow Link and Payments Advance now capture IPN transactions properly.
+
+
+
Special characters (such as e-mail addresses) are now handled properly by the Magento Payflow API integration.
+
+
+
Resolved errors with orders placed using the Website Payments Pro payment method.
+
+
+
PayPal Express Checkout payments are handled properly when a shopping cart price rule is specified.
+
+
+
Any PayPal Name-Value Pair (NVP) payment method no longer automatically refunds an order when a chargeback is
+ initiated. Magento now allows the dispute to be resolved before taking the appropriate action.
+ PayPal NVP payment methods include: PayPal Payments Pro (including PayPal Payments Pro Hosted), Payments Standard,
+ and all Payflow methods.
+
+
+
PayPal Pro now correctly processes the shipping address for an order.
+
+
+
PayPal Express Checkout and PayPal Pro now handle partial refunds properly.
+
+
+
Fixed rounding errors that were preventing PayPal Express Checkout transactions from completing. The error
+ occurred with the following configuration:
+
+
tax calculation method based on the total
+
tax calculated based on the shipping address
+
catalog prices exclude tax
+
shipping prices exclude tax
+
customer discount applied after a discount
+
discount applied to prices excluding tax
+
tax applied to a custom price if available
+ (In the Admin Panel, click System > Configuration > SALES >
+ Tax. In the right pane, expand Calculation Settings.)
+
+
+
+
The order status Suspected Fraud is now supported by PayPal Payments Pro (hosted) when PayPal fraud protection
+ is enabled. Using the Magento Admin Panel, the merchant can also accept or deny any Suspected Fraud orders and
+ have that decision applied to the PayPal transaction.
+
+
+
+ When sending payments in the United Kingdom, PayPal Payments Pro (hosted) now sends the value for
+ state correctly. (Before the fix, city was sent as the value for state.)
+
+
Using the Ogone payment method, transactions display in the Magento Admin Panel after you capture them.
+
+
+
When an administrator places an order and uses PSi Gate, then cancels the order, the PSi Gate gateway displays
+ both the order and the void transactions.
+
+
+
The following fields related to PayPal's Payflow Pro Gateway payment method are now implemented properly:
+
Fixed spurious Gateway error: Void error: V18A4B18E0F9 has been captured errors when canceling
+ partially invoiced orders when the Payflow Pro processor was used to process the payment.
+
+
+
3-D secure fixes that affect UK merchants only:
+
+
3-D Secure for UK merchants implementing Direct Payment works properly.
+
+
+
SagePay Direct with 3-D secure payments are processed correctly.
+
+
+
+
+
The Braintree payment method can now be configured properly.
+
+
+
Partial captures are now supported for the following PayPal payment methods: Express Checkout, Payments Pro
+ Payflow Edition, and PayPal Standard.
+
+
+
Using the PayPal Express Checkout method, a recently added customer can check out without the error This
+ customer email already exists.
+
+
A fatal error in GiftRegistry/Model/Item/Option.php has been resolved.
+
+
+
When an administrative user whose role is restricted to managing products attempts to edit Inventory settings
+ (Catalog > Manage Products, Inventory), only the available
+ options display.
+
+
+
Related product information updates appropriately in the Admin Panel.
+
+
+
Issues with editing product inventory settings and category attributes using the Google Chrome web browser have
+ been resolved.
+
+
+
Rolling back after a backup now works properly. (The Magento backup and rollback options are available in the
+ Admin Panel in System > Tools > Backup.)
+
+
+
You can now fetch data for a PayPal Settlement Report using a custom Secure FTP (SFTP) server.
+
+
+
+ Using the Solr search engine with price navigation calculation step set to manual now displays
+ search results properly on your web store. (A fatal error was fixed.)
+ (To set price navigation step options in the Admin Panel, click System >
+ Configuration > CATALOG > Catalog > Layered
+ Navigation. From the Price Navigation Step Calculation list, click
+ Manual.)
+ For more information about using the Solr search engine with Magento EE, see the Magento User Guide.
+
+
+
You can now save a category with the option Available Product Listing Sort By: Best value or
+ Price enabled.
+
+
+
+ The following fixes relate to full page caching:
+
+
+ Breadcrumbs to a product work for all categories with which the product is associated.
+
+
+
+ The correct customer name displays on a gift card.
+
+
+
+ Product tags display properly.
+
+
+
+ Related products display properly.
+
+
+
+ magento-install-dir/app/code/core/Enterprise/PageCache/Model/Config.php was
+ modified to enable you to set specific lifetimes for certain blocks.
+
+
+
+ Automated e-mail marketing reminder rules work properly.
+
+
+
+ Issues with session cookies have been resolved.
+
+
+
+
+
+
+
+
Changes
+
This release includes the following changes to support the changes in indexing:
+
+
+ As a result of the optimizations made to reindexing, you can no longer have a duplicate:
+
+
URL key for any two products
+
URL key for any two categories
+
Request Path for any URL Redirect (formerly referred to as URL Rewrite
+
+
+
+ There is a new management page in the Admin Panel: System >
+ Configuration > ADVANCED > Index Management.
+
+ The options on the System > Index Management are significantly
+ different. In particular, because manual reindexing is no longer required for most indexers, there are fewer
+ checkboxes and the page mostly displays status information.
+
In the Admin Panel, Catalog > Manage Products > edit-product >
+ General tab page option Create Permanent Redirect for old URL if URL key changed
+ changes to Create Custom Redirect for old URL.
+ The feature behaves the same way; namely, selecting Yes creates a redirect for the old URL that
+ points to the new URL if a page is moved.
+
Note: The wording of this option is expected to change back to
+ the previous wording in a subsequent release.
+
+
+
The options Product URL Suffix and Category URL Suffix return an error if
+ anything except alphanumerical characters or the underscore character are entered. (In the Admin Panel,
+ click System > Configuration > CATALOG > Catalog >
+ Search Engine Optimizations.)
+
+ The catalog_product_entity_url_key and catalog_category_entity_url_key
+ database tables for the corresponding url_key attributes have been added.
+
+
+
+
+ For more information about indexing changes, see the Magento User Guide.
+
+
+
+
+
+
diff --git a/guides/v19.x/ce18-ee113/ht_magento-ce-sample.data.html b/guides/v19.x/ce18-ee113/ht_magento-ce-sample.data.html
new file mode 100644
index 0000000000..3ffe1d7315
--- /dev/null
+++ b/guides/v19.x/ce18-ee113/ht_magento-ce-sample.data.html
@@ -0,0 +1,45 @@
+---
+layout: v1x
+title: Installing Sample Data for Magento Community Edition (CE)
+---
+
+
Overview
+
This page discusses how to get the sample data for:
+
+
Magento Community Edition (CE) 1.6, 1.7, or 1.8
+
Magento Community Edition (CE) 1.9.0.0
+
Magento Community Edition (CE) 1.9.1.0–1.9.2.0
+
+
+
Important: Magento CE 1.9 and later use different sample data from the other versions in
+ the preceding list. Make sure you use the correct version of sample data
+ with your version of Magento CE.
+
+
Install Sample Data Before You Install Magento
+
Magento CE sample data must be installed before you install Magento CE.
+
+
Getting the Sample Data
+
+ The sample data is provided in different formats for your convenience.
+ Archives for each version have exactly the same content (they differ only by compression method).
+
Redis is an open source, Berkeley Software Distribution (BSD) licensed, advanced key-value store that can optionally be used in Magento for backend and session storage. In fact, you can replace memcached with Redis.
+
Following are some of the benefits Redis provides for Magento implementations:
+
Redis supports on-disk save and master/slave replication. This is a powerful feature not supported by memcached. Replication enables high availability by eliminating a single point of failure.
+
Redis can be used for PHP session storage.
+
Redis provides much better eviction control and its backend is written with eviction support in mind.
+
Redis supports multiple databases that use the same server instance so you can use different databases for the Magento cache, full page cache (EE only), and sessions without starting many processes listening on different ports.
+
Redis supports compression libraries gzip, lzf, and snappy. lzf and snappy are much faster than gzip.
The following Magento editions support Redis session and backend caching:
+
Enterprise Edition (EE) 1.13 and later
+
Community Edition (CE) 1.8
+
The preceding Magento editions support Redis server version 2.6.9 and later available from redis.io.
+
In addition, you can optionally use the Redis extension for PHP version 2.2.3 or later if you're using Redis for backend caching; however, Magento works without this extension.
+
+
Configuring Redis
+
To use Redis with Magento, you must configure Magento to use Redis and you must install and configure the Redis server. These tasks are discussed in the following sections:
To use Redis with Magento, you only need to install and configure the Redis server. The integration between Redis and Magento is already included with Magento CE 1.8 and EE 1.13 and later versions. All you need to do is configure it.
+
Important: The Cm_RedisSession module in CE 1.8 is disabled by default. Magento disables the module to avoid unnecessary connection tries to Redis when you choose to use file, database, or a different session storage method.
+
To enable Magento to use Redis, perform the following tasks:
+
Enable the Cm_RedisSession module.
+
Open magento-install-dir/app/etc/modules/Cm_RedisSession.xml in a text editor.
+
Change the value of <active> to true.
+
Save your changes to Cm_RedisSession.xml and exit the text editor.
+
+
Modify magento-install-dir/app/etc/local.xml.
+ For configuration information, see the sample provided with Magento in magento-install-dir/app/etc/local.xml.additional and also see the Readme (session) and Readme (backend).
+
Flush the Magento cache in any of the following ways:
+
If you have access to the file system as the owner of the files in the Magento installation directory, change to that directory and enter rm -rf var/cache.
+
Log in to the Admin Panel as an administrator. Click System > Cache Management, then click Flush Magento Cache at the top of the page.
You can optionally install the Redis extension for PHP version 2.2.3 or later as well, but Magento functions without it.
+
+
Getting Support for Redis
+
Important: Colin Mollenhour, the original author of Redis, does not provide support for Magento implementations. You can get support for Magento implementations in the following ways:
-
\ No newline at end of file
+
diff --git a/guides/m1x/ce19-ee114/RWD_dev-guide.html b/guides/v19.x/ce19-ee114/RWD_dev-guide.html
similarity index 97%
rename from guides/m1x/ce19-ee114/RWD_dev-guide.html
rename to guides/v19.x/ce19-ee114/RWD_dev-guide.html
index bf8ecd2afb..792c986694 100644
--- a/guides/m1x/ce19-ee114/RWD_dev-guide.html
+++ b/guides/v19.x/ce19-ee114/RWD_dev-guide.html
@@ -18,8 +18,8 @@
-
-{% include m1x/eol_message.html %}
+
+{% include v1x/eol_message.html %}
@@ -30,7 +30,7 @@
Magento Community Edition (CE) 1.9 and Magento Enterprise Edition (EE) 1.14 Responsive Web Design Developer's
Guide
Note: Magento still supports other non-responsive themes as well. You don't need to use this guide to customize those themes. For more information, see the Designer's Guide to Magento.
@@ -259,10 +259,10 @@
Disabling the Magento Cache
Click Submit.
The following figure shows an example.
-
+
Click Submit.
The following figures shows all cache types disabled.
-
+
@@ -284,7 +284,7 @@
Step 1: Creating a Directory Structure for Your Respons
directories.
The rwd/default theme falls back directly to the base/default theme, so themes in the default
package will never be included as a part of the fallback chain.
-
Note: Magento EE only. The enterprise/default theme is completely replaced by rwd/enterprise and therefore, enterprise/default is not included as a part of the fallback chain.
@@ -336,7 +336,7 @@
Step 1: Creating a Directory Structure for Your Respons
-
Important: It's very important you have a theme.xml in the app/design/frontend/custompackage/customtheme/etc directory with exactly the contents shown. Failure to configure theme.xml correctly prevents Magento from loading your theme.
@@ -356,7 +356,7 @@
Step 2: Copying Files For Your Theme
Structure.
The following figure shows how your custom theme directory structure looks after copying these files and
directories.
-
+
Step 3: Configuring a Compass Watcher
You can configure Compass to watch your skin directories for changes to CSS and JavaScript and to compile them
@@ -427,7 +427,7 @@
Step 4: Configuring Magento to Load Your Theme
In the right pane, expand Themes.
In the Default field, enter customtheme
The following figure shows an example.
-
+
In the top right corner of the page, click Save Config.
If an error displays when you attempt to save the configuration, see Troubleshooting
@@ -451,7 +451,7 @@
Note: If your theme fails to load properly, see the next section.
@@ -513,7 +513,7 @@
Wrong formatting in the web store
Directory and File Reference
The following figure shows the directory structure in a properly configured system, as well as the location of
theme.xml, the custom theme configuration file.
-
+
Responsive Theme Reference
This section discusses information you need to customize the responsive theme you started in Copying
@@ -547,7 +547,7 @@
The responsive theme uses two sprites: one for general icons and the other for social icons.
Both sprite images output at 1x and 2x resolutions (for high-resolution screens). Because sprite files are very
difficult to edit without the source files, you should use these Photoshop files to change these sprites: RWD_icon_sprite.psd and RWD_social_icons.psd
+ href="{{ site.baseurl }}{{ site.v1xgdeurl }}images/RWD_icon_sprite.psd">RWD_icon_sprite.psd
Compass provides support for generating sprites from individual image files, but it was not used to generate
sprites for the responsive theme. However, you might want to take advantage of that feature for your custom
theme. Using this method requires knowledge of Compass.
@@ -990,7 +990,7 @@
High-Definition Images
href="https://speakerdeck.com/brendanfalkowski/responsive-ecommerce-part-two#114" target="_blank">slides
starting at 114 of Brendan Falkowski's Imagine 2013 talk for implementation suggestions. For a 2x solution,
PictureFill (or similar polyfill) could be used, although it would need to be integrated with ElevateZoom.
-
Note: Category banners and product detail pages use a 1.5x image solution.
diff --git a/guides/m1x/ce19-ee114/RWD_responsive_emails.html b/guides/v19.x/ce19-ee114/RWD_responsive_emails.html
similarity index 96%
rename from guides/m1x/ce19-ee114/RWD_responsive_emails.html
rename to guides/v19.x/ce19-ee114/RWD_responsive_emails.html
index 0eb4f438a8..e5bb7e3dd1 100644
--- a/guides/m1x/ce19-ee114/RWD_responsive_emails.html
+++ b/guides/v19.x/ce19-ee114/RWD_responsive_emails.html
@@ -21,14 +21,14 @@
-
- {% include m1x/eol_message.html %}
+
+ {% include v1x/eol_message.html %}
Responsive Email Developer's Guide for Magento EE 1.14.1 and Magento CE 1.9.1
We provide you with a responsive sample newsletter template
-
Note: This article focuses on responsive emails but the
same techniques can be used for newsletter templates as well. For more information about newsletter
templates, see Using Updated Newsletter Templates.
@@ -66,7 +66,7 @@
Introduction
Using cron to Send Emails
Starting in Magento EE 1.14.1 and CE 1.9.1, your Magento cron job sends all emails, including
transactional emails. You must configure cron for emails to work.
Note: To make changes to the templates at the website or
store view configuration scopes, see the next section.
@@ -324,7 +324,7 @@
Customizing the Template in the Admin Pan
The following figure shows an example:
-
Click Preview Template to look at the HTML code in a separate browser tab page or
window, or click Save Template to save it.
@@ -342,11 +342,11 @@
Using the Template in a Website or Store
all websites and store views. You can optionally associate it with a specific website or store view by
selecting it from the list.
The following example shows how to associate a template with the Madison Island English store view.
-
+
In the right pane, click Transactional Emails to expand it.
From the Email Header Template list, click the header template you created earlier.
The following figure shows an example:
-
Click Save Config in the upper right corner of the page.
@@ -367,7 +367,7 @@
Customizing CSS Styles for Emails
As you might expect, these two files compile to skin/frontend/rwd/default/css/email-inline.css
and skin/frontend/rwd/default/css/email-non-inline.css, respectively. If you're not familiar
- with how to work with Sass files, refer to the RWD theme documentation.
Refer to the Emogrifier README
to see what CSS selectors are supported.
-
Note: The {{inlinecss file=""}}
directive can be used a single time and cannot be used in templates that get included by other templates
(for example, app/locale/en_US/template/email/html/header.html and
@@ -419,7 +419,7 @@
Using Non-Inline Styles to Customize Email CSS
After the CSS is loaded, it's wrapped in a <style
type="text/css"></style> tag and is assigned to the
non_inline_styles variable.
-
Note: When you are writing "non-inline" CSS, you must
add the !important declaration after each property so the style has a high enough
specificity to get applied. This is the best way to get your custom styles to override styles
@@ -479,7 +479,7 @@
Updating a High-Resolution Logo Using the File System<
border="0"/>
-
Note: To use a file type other than GIF or if you
need to upload unique logos for different websites, stores, or store views, see the next section.
@@ -503,7 +503,7 @@
Updating a High-Resolution Logo Using the Admin Panel
all websites and store views. You can optionally associate it with a specific website or store view
by selecting it from the list.
The following example shows how to associate a logo with the Madison Island English store view.
-
+
In the right pane, click Transactional Emails to expand it.
Enter the following information:
@@ -538,7 +538,7 @@
Updating a High-Resolution Logo Using the Admin Panel
The following figure shows an example.
-
+
Click Save Config in the upper right corner of the page.
@@ -604,4 +604,4 @@
Getting Help
-
\ No newline at end of file
+
diff --git a/guides/m1x/ce19-ee114/ce1.9_release-notes.html b/guides/v19.x/ce19-ee114/ce1.9_release-notes.html
similarity index 97%
rename from guides/m1x/ce19-ee114/ce1.9_release-notes.html
rename to guides/v19.x/ce19-ee114/ce1.9_release-notes.html
index 228dd1edf9..b44a5b4caa 100644
--- a/guides/m1x/ce19-ee114/ce1.9_release-notes.html
+++ b/guides/v19.x/ce19-ee114/ce1.9_release-notes.html
@@ -16,8 +16,8 @@
-
-{% include m1x/eol_message.html %}
+
+{% include v1x/eol_message.html %}
@@ -63,7 +63,7 @@
Magento Open Source Release Notes (1.9 and later)
Important Upgrade Information
-
Important: Use Magento Open Source 1.9.3.0 or later for all new Magento Open Source installations and upgrades to get the latest fixes, features, and security updates.
+
Important: Use Magento Open Source 1.9.3.0 or later for all new Magento Open Source installations and upgrades to get the latest fixes, features, and security updates.
Magento Open Source 1.9.4.5 Release Notes
@@ -423,7 +423,7 @@
Magento Open Source 1.9.3.1 Release Notes
-
Note: You currently cannot upgrade to this version using Magento Connect Manager. We expect to resolve this issue soon.
+
Note: You currently cannot upgrade to this version using Magento Connect Manager. We expect to resolve this issue soon.
Magento Open Source 1.9.3.0 Release Notes
See the following sections for information about this release:
Note: Some of the patches discussed in this section have EE_1.14.0.1 in the name. These patches were all tested against Open Source 1.9.x as well.
+
Note: Some of the patches discussed in this section have EE_1.14.0.1 in the name. These patches were all tested against Open Source 1.9.x as well.
General Magento Connect Patches
@@ -680,7 +680,7 @@
General Magento Connect Patches
To improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
Extension developers can now create an extensions with a dash character in the name. Merchants can install those extensions without issues.
Magento administrators who attempt to install an extension with insufficient file system privileges are now informed. Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the your Magento install dir/app/code/community directory structure, the Magento administrator sees an error message in the Magento Connect Manager.
-To set file system permissions appropriately, see After You Install Magento: Recommended File System Ownership and Privileges.
Magento Install Page Displays After SOAP v2 Index Page Refresh
Patch name: SUPEE-3762. Refreshing the SOAP v2 index page (http://your-magento-host-name/index.php/api/v2_soap/index/) results in all administrators and customers viewing the Magento installation page.
@@ -692,7 +692,7 @@
How to Get Patches For Magento Open Source
In the left pane, click Downloads.
Scroll down to the Magento Open Source Patches section.
Follow the prompts on your screen to download a patch for your version of Magento Open Source.
See the following sections for information about changes in this release:
@@ -741,7 +741,7 @@
Changes
Two new options to prevent "clickjacking" if you run Magento in a frame or iframe:
Enable frames only in the same domain.
Enable frames.
-
Important: For security reasons, Magento strongly recommends against running the Magento software in a frame.
+
Important: For security reasons, Magento strongly recommends against running the Magento software in a frame.
The options are available in the Admin Panel at System > Configuration > ADVANCED > Admin > Security and are named Allow Magento Backend to run in frame and Allow Magento Frontend to run in frame.
Enabling the option causes the X-Frame-Options request header to be sent.
@@ -754,7 +754,7 @@
Changes
Open Source 1.9 includes a fix that prevented some Discover credit cards from validating properly. The issue was that certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover cards should validate properly.
-
Important: This is not a security threat. No data has been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid Discover card numbers.
+
Important: This is not a security threat. No data has been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid Discover card numbers.
The default values for two configuration options changed. Both options can be found in the Admin Panel under System > Configuration > CATALOG > Catalog > Frontend. The new default values follow:
Products per Page on Grid Allowed Values is now 12, 24, 36.
Products per Page on Grid Default Value is now 12.
diff --git a/guides/m1x/ce19-ee114/ee1.14_release-notes.html b/guides/v19.x/ce19-ee114/ee1.14_release-notes.html
similarity index 98%
rename from guides/m1x/ce19-ee114/ee1.14_release-notes.html
rename to guides/v19.x/ce19-ee114/ee1.14_release-notes.html
index 479cf8a40e..f503dba90d 100644
--- a/guides/m1x/ce19-ee114/ee1.14_release-notes.html
+++ b/guides/v19.x/ce19-ee114/ee1.14_release-notes.html
@@ -16,8 +16,8 @@
-
-{% include m1x/eol_message.html %}
+
+{% include v1x/eol_message.html %}
Magento Commerce Release Notes (1.14 and later)
@@ -58,7 +58,7 @@
Magento Commerce Release Notes (1.14 and later)
Important Upgrade Information
-
Important: Use Magento Commerce 1.14.3.0 or later for all new Magento Commerce installations and upgrades to get the latest fixes, features, and security updates.
+
Important: Use Magento Commerce 1.14.3.0 or later for all new Magento Commerce installations and upgrades to get the latest fixes, features, and security updates.
Magento Commerce 1.14.4.5 Release Notes
@@ -435,7 +435,7 @@
Magento Commerce 1.14.3.1 Release Notes
-
Note: You currently cannot upgrade to this version using Magento Connect Manager. We expect to resolve this issue soon.
+
Note: You currently cannot upgrade to this version using Magento Connect Manager. We expect to resolve this issue soon.
Magento Commerce 1.14.3.0 Release Notes
@@ -697,7 +697,7 @@
Magento Commerce 1.14.0.1 Release Notes
Customers using a smartphone or other small viewport can expand subcategories in the web store that uses the new responsive theme.
Recent Patches
-
Note: The patches discussed in this section are built in to Commerce 1.14.1; you need to get them only if you're running an earlier Commerce version.
+
Note: The patches discussed in this section are built in to Commerce 1.14.1; you need to get them only if you're running an earlier Commerce version.
We'd like to draw your attention to several new patches that were recently posted to the Partner Portal and Support Center. These patches deliver important improvements, such as enabling several concurrent administrators to work with the product catalog, and to make it easier to install community-created translation packages.
To improve security, Magento Connect now uses HTTPS by default to download extensions, rather than FTP.
Extension developers can now create an extensions with a dash character in the name. Merchants can install those extensions without issues.
Magento administrators who attempt to install an extension with insufficient file system privileges are now informed. Typically, the Magento Admin Panel runs as the web server user. If this user has insufficient privileges to the your Magento install dir/app/code/community directory structure, the Magento administrator sees an error message in the Magento Connect Manager.
-To set file system permissions appropriately, see After You Install Magento: Recommended File System Ownership and Privileges.
Magento Install Page Displays After SOAP v2 Index Page Refresh
Patch name: PATCH_SUPEE-3762_EE_1.14.0.1_v1.sh. Refreshing the SOAP v2 index page (http://your-magento-host-name/index.php/api/v2_soap/index/) results in all administrators and customers viewing the Magento installation page.
@@ -739,7 +739,7 @@
How to Get Patches For Magento Commerce
In the left pane, click Downloads.
In the right pane, click Magento Commerce.
Follow the prompts on your screen to download a patch for your version of EE.
See the following sections for information about changes in this release:
@@ -758,7 +758,7 @@
Highlights
Magento Commerce 1.14 now supports Solr versions up to 3.6.2 natively (that is, without a patch). Catalog indexing happens efficiently and automatically in the background, with no manual intervention required, resulting in better administrative performance.
For more information about using Solr with Magento Commerce, see the Magento User Guide.
-Note: If you're using the Solr search engine with Commerce versions 1.13.1 or earlier, you must perform an additional step during upgrade due to the fact that the Solr schema changes in Commerce 1.14. You must copy two files to your Solr server—schema.xml and solrconfig.xml. For details, see the section on upgrading Solr in the Magento upgrade guide.
+Note: If you're using the Solr search engine with Commerce versions 1.13.1 or earlier, you must perform an additional step during upgrade due to the fact that the Solr schema changes in Commerce 1.14. You must copy two files to your Solr server—schema.xml and solrconfig.xml. For details, see the section on upgrading Solr in the Magento upgrade guide.
Cross-border trade: (Also referred to as pricing consistency.) We support European Union (EU) merchants operating across regions and geographies who want to show their customers a single price. Pricing is clean and uncluttered regardless of tax structures and rates that vary from country to country.
To enable cross-border trade in the Admin Panel, click System > Configuration > SALES > Tax > Calculation Settings, option Enable Cross Border Trade.
Two new options to prevent "clickjacking" if you run Magento in a frame or iframe:
Enable frames only in the same domain.
Enable frames.
-
Note: For security reasons, Magento strongly recommends against running the Magento software in a frame.
+
Note: For security reasons, Magento strongly recommends against running the Magento software in a frame.
The options are available in the Admin Panel at System > Configuration > ADVANCED > Admin > Security and are named Allow Magento Backend to run in frame and Allow Magento Frontend to run in frame.
Enabling the option causes the X-Frame-Options request header to be sent.
@@ -804,7 +804,7 @@
Changes
Magento Commerce 1.14 includes a fix that prevented some Discover credit cards from validating properly. The issue was that certain Discover credit card number ranges were not recognized as being valid. As a result of the fix, all Discover cards should validate properly.
-
Note: This is not a security threat. No data has been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid Discover card numbers.
+
Note: This is not a security threat. No data has been compromised or misused. It affects only the ability to validate certain credit card number ranges as valid Discover card numbers.
If you use the Solr search engine, you no longer need to manually reindex the Catalog Search Index (except after you upgrade to EE 1.14 from an earlier version).
The default values for two configuration options changed. Both options can be found in the Admin Panel under System > Configuration > CATALOG > Catalog > Frontend. The new default values follow:
Products per Page on Grid Allowed Values is now 12, 24, 36.
The iOS app for Magento MobileConnect was discontinued in 2015.
+
+
+
diff --git a/guides/v19.x/extension-dev-guide/bk-extension-dev-guide.md b/guides/v19.x/extension-dev-guide/bk-extension-dev-guide.md
new file mode 100644
index 0000000000..09ef9fab46
--- /dev/null
+++ b/guides/v19.x/extension-dev-guide/bk-extension-dev-guide.md
@@ -0,0 +1,8 @@
+---
+#group: php-developer-guide
+title: PHP Developer Guide
+layout: default
+---
+
+The PHP Developer Guide contains information for developers who want to know more about developing or modifying Magento components. With this knowledge you can extend or customize any of the existing components in the Magento application. You can also create components that introduce new functionality and distribute them to merchants.
+
diff --git a/guides/v19.x/howdoi/checkout/checkout_overview.html b/guides/v19.x/howdoi/checkout/checkout_overview.html
new file mode 100644
index 0000000000..cda475dce3
--- /dev/null
+++ b/guides/v19.x/howdoi/checkout/checkout_overview.html
@@ -0,0 +1,5 @@
+---
+layout: full-width
+---
+
+
+
+
{{ site.logo }}
diff --git a/_includes/m1x/eol_message.html b/_includes/m1x/eol_message.html
deleted file mode 100644
index 7ff4de61c1..0000000000
--- a/_includes/m1x/eol_message.html
+++ /dev/null
@@ -1,9 +0,0 @@
-
diff --git a/_includes/v1x/eol_message.html b/_includes/v1x/eol_message.html
new file mode 100644
index 0000000000..04c82db230
--- /dev/null
+++ b/_includes/v1x/eol_message.html
@@ -0,0 +1,9 @@
+
diff --git a/_includes/v1x/header-scripts.html b/_includes/v1x/header-scripts.html
new file mode 100644
index 0000000000..78ae074aa6
--- /dev/null
+++ b/_includes/v1x/header-scripts.html
@@ -0,0 +1,20 @@
+
+
\ No newline at end of file
diff --git a/_includes/v1x/header.html b/_includes/v1x/header.html
new file mode 100644
index 0000000000..81195edbdb
--- /dev/null
+++ b/_includes/v1x/header.html
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+ {% include v1x/header-scripts.html %}
+ 
-
-
-
-
Important: The default response for all APIs is JSON; however, this page currently uses mostly XML examples. We don't maintain this documentation much anymore so if you'd like to contribute some JSON, we'll acknowledge your help on this page. Edit this page on GitHub if you can help us out.
-
-
-
-
-
-
-{% include m1x/eol_message.html %}
-
-
Note: We'd like to make you aware that a security patch for older versions of Magento Community Edition has been posted (in
- the Magento Community Edition Patches section). This patch resolves a remote code execution vulnerability that
- enables an attacker with Magento administrator privileges to delete files and directories on a Magento
- installation. This vulnerability was discovered through our quarterly penetration testing process and has not been
- reported by merchants.
+
+
+
+
- 
-
- 
- 
- 
- 
- 
-
-
- NOTE: Click the header with authorization data and click Auto refresh in the opened pop-up in order to
- generate new values for oauth_nonce, oauth_timestamp, and oauth_signature at each request.
- 
-
- 
-
- 
- 
- 
- 
-
-
-
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-
-
-
-
-
-
-
-
Tip: The name and path to the Magento installation directory in your development system does not have to be the same as on your production system, although it might make some tasks simpler.
-
-
(Edit) in the row that includes the path 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 
-
- 
-
- 
-
-
-
-
-
Important: The default response for all APIs is JSON; however, this page currently uses mostly XML examples. We don't maintain this documentation much anymore so if you'd like to contribute some JSON, we'll acknowledge your help on this page. Edit this page on GitHub if you can help us out.
+
+
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
Note: We'd like to make you aware that a security patch for older versions of Magento Community Edition has been posted (in
+ the Magento Community Edition Patches section). This patch resolves a remote code execution vulnerability that
+ enables an attacker with Magento administrator privileges to delete files and directories on a Magento
+ installation. This vulnerability was discovered through our quarterly penetration testing process and has not been
+ reported by merchants.
+
+
+
+
+ 
+
+ 
+ 
+ 
+ 
+ 
+
+
+ NOTE: Click the header with authorization data and click Auto refresh in the opened pop-up in order to
+ generate new values for oauth_nonce, oauth_timestamp, and oauth_signature at each request.
+ 
+
+ 
+
+ 
+ 
+ 
+ 
+
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+
+
+
+
+
+
+
Tip: The name and path to the Magento installation directory in your development system does not have to be the same as on your production system, although it might make some tasks simpler.
+
+
(Edit) in the row that includes the path 
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+ 
+
+ 
+
+
+
+
+
Important: The default response for all APIs is JSON; however, this page currently uses mostly XML examples. We don't maintain this documentation much anymore so if you'd like to contribute some JSON, we'll acknowledge your help on this page. Edit this page on GitHub if you can help us out.
+
+
+
+
+
+
+{% include v1x/eol_message.html %}
+
+
Note: We'd like to make you aware that a security patch for older versions of Magento Community Edition has been posted (in
+ the Magento Community Edition Patches section). This patch resolves a remote code execution vulnerability that
+ enables an attacker with Magento administrator privileges to delete files and directories on a Magento
+ installation. This vulnerability was discovered through our quarterly penetration testing process and has not been
+ reported by merchants.
+ 
+
+ 
+ 
+ 
+ 
+ 
+
+
+ NOTE: Click the header with authorization data and click Auto refresh in the opened pop-up in order to
+ generate new values for oauth_nonce, oauth_timestamp, and oauth_signature at each request.
+ 
+
+ 
+
+ 
+ 
+ 
+ 
+
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 