Setting Up Magento

Setting Up Magento


These instructions are for Magento 1.

The latest version of Magento is Magento 2. If you have Magento 2, the setup instructions for that version can be found here.

You can view your current version of Magento by logging into the Admin panel and scrolling to the very bottom.

Integration Specs

  • Supported functions:
    • Order Download
    • Shipment Confirmation - Detailed
    • Inventory Sync
  • Works with:
    • Magento Enterprise
    • Magento Community
  • Required Parameters

Step-by-step guide

  1. Login to your Magento store (Not your account at
  2. Go to: System -> Web Services -> SOAP/XML RPC - Roles
    1. Click: Add New Role, Give it a name like CartRover then click Role Resources.
  3. Check Shopping Cart, Sales, Catalog Inventory and everything in them. Also make sure Catalog > Product > Update is selected.
  4. Click Save Role at the top.
  5. Next, go to: System -> Web Services -> SOAP/XML RPC - Users
    1. Click: Add new user
    2. Click: Create API Key
      1. Or fill out the form and choose and save a long random string for the API Key.
  6. In the sidebar, click User Role. Then select the role you just created.


Orders must have the order state processing for CartRover to download them. Note that Magento has both a "status" and "state" field for orders. You can map your statuses to the desired state within Magento.

The minimum supported version of Magento is 1.3

Additional Options

WSI Compliance Mode Enabled

CartRover needs to know the WS-I Compliance mode Magento is in.

To see how this is set, go to System > Configuration > Magento Core API and look at: WS-I Compliance. The default is usually No.

While you're here, please set Enable WSDL Cache to Yes to improve your site efficiency.

Limit to single Store ID

This allows you to only pull orders for a specific Store ID, rather than all stores.

To find your Store ID, go to System -> Manage Stores and click on the desired store name in the right column.

The Store ID will be listed in the URL of the webpage:

    • Related Articles

    • Magento orders missing products

      Problem After upgrading Magento to version or above, orders in CartRover no longer contain any products. The inventory sync may have stopped working as well. Solution This is caused by a bug in Magento. There are currently two options you ...
    • Invalid carrier specified - Magento

      Problem Could not upload tracking information to Magento because "Invalid carrier specified." This is caused when you ship orders using a carrier not defined in Magento. Solution Option 1: Add the missing carrier To solve the issue you need to add ...
    • Access Denied - Magento

      Problem Some Magento actions fail with "Access Denied". Example: Solution This is caused by the API user not being given enough permissions. Go to: System -> Web Services -> Users Look at which "Role" the API user is assigned to. Go to: System -> Web ...
    • Invalid api path - Magento

      Problem CartRover displays the following error message when connecting to Magento: Invalid api path Solution This error is most commonly caused by improperly adding custom endpoints to the Magento API, which breaks/blocks the standard API endpoints. ...
    • Magento 1 Settings

      This page covers the various options that can be set in CartRover and in your Magento 1 account.  CartRover Settings Setting Description Default Other Options WSI Compliance Mode Enabled Usually "No". See here for more info No Yes Order Status Filter ...