• By Bruma Pty. Ltd
  • contact
    DecEzy Knowledge Base

    Knowledge Base

    Setting Up Magento

    Author admin acount on January 14, 2014 | Print | Bookmark

    Setting Up Magento Integration

    DecEzy has eCommerce functionality, which allows it to integrate with a Magento eCommerce site. To do this, both Magento and DecEzy need to be set up in a specific way. This article is intended to detail how both of these should be set up to allow them to communicate with each other.

    Before progressing, it is assumed that Magento has already been installed, and the user is logged in as an administrator.

    Setting up the API User in Magento

    When DecEzy communicates with DecEzy, it needs to log on using a special kind of user - an API user. In this case, we need to set up a SOAP user (SOAP is the API protocol).

    To do this, we will need to do two things:

    • Create an API role that has full access.
    • Create a new API user, and assign the API role to it.

    The detailed steps on how to do this follow:

    First we need to set up an API role. This is done by, on the top menu, selecting System>Web Services>SOAP/XML-RPC - Roles:

    In the Roles setup page, click on the "Add New Role" button:

    You will be asked for a role name. Enter one as appropriate (we have entered "super"):

    Then click "Save Role"

    Now the role is saved, we can assign resources (or permissions) to it. To do this, click on "Role Resources" on the left hand side:

    When the Role Resources page is first opened, it should look a little like the screenshot below. We wish to assign all resources to this role, so in the "Resource Access" option, select All.

    After selecting all, the resource allocations should look like this:

    Now click on "Save Role" to save the role.

    Now to set up the user. First we open up the SOAP Users. This is done by, on the top menu, selecting System>Web Services>SOAP/XML-RPC - Users:

    Click on "Add New User":

    You will be prompted to enter some details, as shown below. Be sure to keep a note of the username and API Key (password) you enter. After entering the appropriate details, click on "Save User":


    Now to assign the super role to this user. To do this, follow the steps as shown below:

    • Click on "User Role".
    • Check the radio button next to the "super" role.
    • Click on "Save User".

    You have now set up your API user.

    Setting up DecEzy

    Now to set up DecEzy. To do this, open the website setup from the top menu - Web>Websites:

    This will open a list of the websites that are setup in DecEzy. If this list is blank, select Webstore>Add New. If the webstore is already setup (at least partially), select Webstore>Open:


    On the main tab of the website setup card, there are some essential details that need to be filled in:

    • Name - The name is only used within DecEzy in order to identify it. Any identifier text can be put in here ("Main website", "Customer Portal", etc)
    • Website URL - This is the URL of the website that DecEzy is to integrate with. It should be entered in the same way that customers will enter it (don't enter any admin details to it).
    • Website Username/Password - This is the username and password (API Key) that were created in the steps above.
    • Website ID - This is the Magento ID of the website that this setup is for. As a Magento installation can contain multiple websites, the ID of the website needs to be entered here. If the connection details (URL/Username/Password) have been set up correctly, the user should be able to select the Website ID by using the button on the right hand side of the website ID textbox.

    Some other important (but not essential) fields:

    • Web Prices Include Tax - Determines if the prices (web price breaks) setup in the item management window (in DecEzy) include tax or not.
    • Tax Code - The tax code used when creating web orders.
    • Image Upload Options - DecEzy can process images before they are uploaded, to change their format, or reduce the size. This can be useful if the images are stored in large files on your system. Please note, this is not mandatory - Magento will reprocess images itself when uploaded.

    Upload Colour Images

    The "Upload Colour Images" field determines how the images associated with an items colour's are uploaded. There are two options:

    • To Main Item - With this option, all the colour images are uploaded to the main configurable product in Magento, with the images label being the colour text.
    • To SKU - With this option, all the colour images are uploaded to the simple products that are linked to the configurable product in Magento.

    Which option for "Upload Colour Images" is best for you depends on what themes/extensions you are using with your magento installation.

    On the right hand side of this page is where the attribute information is setup for this website These are explained in the next section:

    Essential Attributes and Attribute Groups

    There are a number of attributes and attribute sets that are essential. Without these, DecEzy cannot upload data to Magento. These are:

    • Size Colour Attribute Set
    • Size Attribute Set
    • Colour Attribute Set
    • Default Attribute Set
    • Size Attribute Code
    • Colour Attribute Code
    • Brand Attribute Code

    All these values can be set up automatically by DecEzy, and once they are set up in Magento, the appropriate values will be automatically populated in DecEzy. In order to do this, select Website>Setup Magento from the bottom menu:

    Non-Essential Attributes

    There are a number of non-essential attributes that can be setup in DecEzy. These are:

    • Brand Item Code
    • Item Code
    • Item Style
    • 1st Colour Component
    • 2nd Colour Component
    • Cust. Groups Catgegory

    If these attributes are set up (in both Magento, and in the DecEzy setup), then DecEzy will attempt to upload values to these attributes in Magento. If they are not set up in DecEzy, then no attempt will be made to upload data to them.

    DecEzy can set up these attributes in Magento for you. To do this, select the appropriate option from the bottom menu, as shown below:

    Image Tab

    When images are uploaded to Magento, a label (or caption) can be associated with it. The image labels on the Image tab of the website setup cardcontrol what these labels are. If no label is setup here, then images will have no label when uploaded.

    Webstore Setup

    The remainder of the web setup is done on the webstore setup. This is structured like this to suit the structure of Magento, which allows for multiple "Webstores" on each website. Typically there will only be one webstore for a website, but the possibility of having more is allowed for.

    To get to the webstore setup, select Website>Open Webstores from the bottom menu:

    Then from the webstore list, select Webstore>open (or "Add New" if a webstore does not yet exist)

    A number of fields here are required to be setup before Magento integration can happen:

    • Name - The name is just used internally, so any identifying text can go here (eg "eCommerce site")
    • Store ID - As each Magento website can have multiple stores, the ID of the store needs to be selected. If the website API details are setup correct (see in the above section), the user should be able to click on the button in the Store ID textbox to see a list of the available magento stores.
    • Root Category ID - The Root Category is required, so that DecEzy knows to place any items it uploads (sub-categories will be made within the selected category). To select a category, click on the button in the right of the "Root Category ID". When that is clicked, DecEzy will load all the existing categories from Magento. You can expand any existing categories you like in the tree, but after you have found the one you are after, click on OK. If you are unsure what to select, select the "Default Category". (see below for a screenshot of this):

    Other details to populate on the Webstore Setup Card are:

    • Upload Items - Indicates that items are to be uploaded to the website. Generally this should be ticked if the website is being used as a normal eCommerce store.
    • Upload Standard Items - Indicats that standard items are to be uploaded to the website. Generally this should be ticked if the website is being used as a customer portal.
    • Freight Item - The non-stock item that will be used for the freight component of web orders.


    Tax Class ID

    When an product is uploaded to Magento, it needs to have a tax class ID. The value setup in this field is what is uploaded to Magento. Unfortunately, we cannot select the tax class ID from within DecEzy - you need to find the ID from Magento. So log into Magento as the administrator, and from the top menu, select Sales>Tax>Product Tax Classes:


    From the list of tax classes listed, select the one you wish to use for new products. In this example, we are going to select "Taxable Goods"

    The page that appears should look something like the screenshot below. The ID that you need does not appear in the page, but rather it appears in the URL. It is the number that appears after the "admin/tax_class_product/edit/id". In the screenshot below it is 2, which is highlighted for emphasis. This is the value that must be entered into the "Product Tax Class ID" and "Customer Tax Class ID" on the website setup card.

    Extending Magento's API

    In order to use Magento with DecEzy, Magento's API neesd to be extended. For more information about this, view this article: Extending Magento's API

    Was this article helpful?

    Yes No

    Category: Using DecEzy

    Last updated on April 25, 2016 with 797 views