This Magento component documentation will be restructured, however, the presented information is valid and applicable.
Magento is a very flexible and scalable eCommerce software and platform that allows online merchants to control the look, content and functionality of their eCommerce store.
Magento offers a number of powerful marketing, search engine optimisation and catalog-management tools that help you really boost your online shop.
Our Magento connector talks to XML-RPC v1 API of Magento. It is available in all versions of Magento starting from 1.1, including Enterprise, Go, and Community. more information can be found in Magento API documentation.
Magento Account Authentication
To use Magento connector, you need to add your account details into our system or as we call it Authenticate it. This usually means finding the right kind of information from your Magento installation and filling-in the form when adding the new Magento account:
- Name your account (required) - Give any name that you can easily recognise afterwards.
Magento domain (required) - This is your site domain name excluding
http://and special symbols (e.g. slashes). For example, if your Magento domain on your browser window is something like
http://magento.yoursite.com/...then you must input only
magento.yoursite.compart in this field.
- API Login (required) - Your Magento API Login. This is NOT your admin or username that you use to login into your Magento installation. This is a separate API login that you have to create (read further for more).
- API Password (required) - Your Magento API login password. Again this is NOT your admin or user password that you use to login into the Magento installation. This API password is created separately along with the API login name (read further for more).
- Port - Automatically set to 80.
Setting up your API login and API Password
We are going to assume that we have a fresh Magento installation The default setup for the new installed Magento has no API users nor API roles, which means we need to configure both. Here are the steps necessary to follow:
Login into Magento admin panel:
Here we use admin username and password to login into the Magento installation.
Create API Role
Go to System tab > WebServices > SOAP/XML-RPC - Roles:
After when you click you are given an opportunity to Add New Role. If you had already added an API Role then keep reading further.
For a simplicity, we can name this new Role
fullsince we are going to give this role full access. Please type your administrative password to create this role.
When the role is created we can check to see the setup of that role. The Role Info is currently displayed here.
Role Resources tab has the necessary setup option that we need to tune. If we pull-down the menu near the Resource Access we can choose between All or Custom. From here we can do all sorts of customizations but for simplicity, we will choose All and save this role.
The Role Users tab is empty by default if you have just created this role. However, it would contain the users who have this particular role if you have already done this procedure before.
Create a new user with this specific role
Go to System tab > WebServices > SOAP/XML-RPC - Users:
Here we need to add a new user:
Now we need to fill in all the necessary information:
- User Name - give a username which you can remember. This username is going to be used as API Login.
- First Name - Fill in as appropriate
- Last Name - Same, fill-in as appropriate
- Email - a valid e-mail address
- Current Admin Password - give the current Magento installation admin password
- API Key - type-in a memorable phrase so that you can remember. This is not the same as admin password.
- API Key Confirmation - re-type the same memorable phrase
Change to User Role tab and make sure that this newly created user has the appropriate API Role. Since we named our role as
fulland we knew that it actually means a full access:
After all our efforts, finally, we can come back and add all the necessary credentials in the "New Magento Account" form.
Query Sales Orders
Magento connector can also be used to Query Sales Orders from your Magento Account. This trigger provides a possibility to get more than 425 unique record fields for each sales order. The only required field here is the Magento account credentials:
Magento connector can be used as a trigger component to Get Customers data which would return 38 unique fields for each customer including billing and shipping address fields. The only required field here is the Magento account access.
Create / Update Product
Create or Update Product action can accept data in 31 unique fields from the previous connector, while only one field, Product SKU is required for this connector to function along with connected Magento account.
To fully use the abilities of this connector we have provided additional filtering possibilities that can help you to access only one specific segment of products. To achieve that you can select the appropriate drop-down menu options to suit your needs:
Here is a quick overview of the values that you can expect from these menu options:
- Account (required) - this is where you select your already authenticated account or add the new one. More details are available in Magento Account Authentication section.
Product Attribute Set - This is the information you can access in your Magento Admin panel by going to
Catalog > Attributes > Manage Attribute Sets. This is specific to your Magento eCommerce store.
Product Type - This information can be accessed by going into your Magento Admin panel
Catalog > Manage Productswhere the Type is one of the columns in the table. It is not the scope of this document to describe all the product types (try this link for explanation) but generally they can be:
- Simple products,
- Grouped products,
- Configurable products,
- Virtual products,
- Bundle products and
- Downloadable products.
Default product status - This field can have two values -
Assign Product Category
This connector accepts information only in 3 fields, two of which are required:
Update Inventory connector can accept data in 16 unique fields describing the product inventory. For this connector to function we need at least one field, Product ID or SKU to have a value.