Configure Magento API Access

Getting started with Price Desk – Connect your Magento store

To connect Price Desk with your Magento store you need to create an API user in Magento. Unlike a normal user account which permits a person to log in to the back end of your Magento store with a web browser, an API user account allows software to connect with and issue commands and requests to your store; what actions are permitted will be defined by the role, which is what we’ll define first.

Step 1:

Log in to your Magento admin panel as a user with administrator access, and navigate to the following:

System > Web Services > SOAP/XML-RPC Roles

Step 2:

Click on Add New Role

Step 3:

Give this role a name, we suggest ‘Price Desk’

Step 4:

Click on Role Resources on the left, click in the checkbox marked Catalog (it will select all the options beneath it), then click Save Role:

Congratulations, you have created a role called Price Desk, which will permit an API user with that role to access your catalog. Once connected, Price Desk will be able to fetch your product data and your categories.

Step 5:

Now you need to create the API username and password, navigate to system menu as follows:

System > Web Services > SOAP/XML-RPC Users

Step 6:

Click on Add New User

Step 7:

The API username and password can be anything, but we suggest making them both a random string of characters and we like to use to generate a random username and password, as follows (Click here to generate your own):

Using the two random strings from, copy and paste the top one into the User Name box, and the bottom one into the API Key + API Key Confirmation boxes. Don’t close the window yet, as you’ll also need to copy and paste these values into Price Desk.

Next, fill out the First Name, Last Name, and Email boxes with whatever values you choose, we suggest Price, Desk, and your email address, as per the screenshot below:

Step 8:

Click on User Role on the left, and select the role ‘Price Desk’ which we created in Step 4, then click Save User.

Step 9:

Congratulations, the user and role have been configured in Magento. All that remains is to paste those random values into Price Desk (you didn’t close the tab, did you?).

Then click SAVE.

If the configuration is correct Price Desk will save the settings and ask you about Optional Data for your channel, you can skip this step (it can be configured later).

Click on ‘Import Now’ to begin importing the data into Price Desk. It may take a while depending on the size of your catalogue and other factors.

It’ll continue running in the background until it’s finished.

Next, you might want to set up some suppliers and import the price lists.


Important information:

  1. Price Desk will not make any changes to your store, products or categories.
  2. Any price changes will require your confirmation/approval within Price Desk before they are submitted to your store.
  3. Price Desk is a tool for changing prices, up or down. Pricing always remains your responsibility.

Other useful information about getting started with Price Desk:

  1. You will get the most value from Price Desk if you take the time to import your supplier price files and link them to your products – this lets Price Desk calculate your profit margin. If your supplier has a daily price file you can configure Price Desk to fetch it each day so your pricing is ‘live’ and always up to date.
  2. If you have barcodes for your products, you can use our Price Monitor feature which fetches competitor price offers from a leading comparison shopping site.
0 replies

Leave a Reply

Want to join the discussion?
Feel free to contribute!

Leave a Reply

Your email address will not be published. Required fields are marked *