Setting Up Magento 2


  • Due to several bugs in early versions of Magento 2, make sure you have updated to the latest Magento version before connecting to CartRover.
  • Since Magento is self-hosted and highly customizable, you are expected to have IT contacts who can manage and debug any issues that appear in your Magento installation or server as these are out of CartRover's control. If you do not, we recommend considering a cloud hosted shopping cart platform instead (eg: Shopify, BigCommerce, etc).


Magento version 2.1.10 or above is required.

Version below this may work, but are not guaranteed. Use the CartRover Free Trial to hook up your cart and verify everything works.

Integration Specs:

Step-by-step guide

Enable Pop-ups

Please make sure that you have added CartRover ( to Pop-ups Blocker White list. 

For more information, please go to Enable Pop-ups for CartRover

  1. Go to CartRover and setup a new Magento cart or click Edit Setup for an existing one.
  2. Enter your Magento store URL.
  3. Click the Grant US API Access button.
    1. You will be directed to your Magento Admin page where you should login to your account if it is not done automatically.
    2. If you are not directed to the admin section, you will need to verify and correct your Magento URL. DO NOT close the CartRover tab.
    3. If you don't have login access yourself, Instead click Share Setup Link, enter the client's email and click Save. They will receive a setup email. Instructions for client to follow: Cart Setup Share
  4. Within the Magento admin section, go to System > Extensions > Integrations
  5. Click Add New Integration and then enter the following fields. The URL entries must match exactly!
    1. Name: CartRover (or another name that lets you know who this connection is for)
    2. Email:
    3. Callback URL:
    4. Identity link URL:
  6. Click API on the left hand side of the screen.
  7. Select the Sales, Products, Carts, and Stores->Settings->Configuration->Inventory Section sections.
  8. Click Save at the top of the screen.
  9. Click the Activate link on the new line labeled CartRover
  10. Click Allow in the upper right.
  11. Close the CartRover window that pops up
  12. Confirm the connection and then return to the original CartRover page where you will be informed if the connection was successful.
  13. Click OK at the bottom of the page to save.

Important Note

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 view and map your statuses to the desired state within Magento by going to Stores > Order Status.

Shipping Notification Email Bug

There is currently a bug in Magento which causes the shipment notification email sent to the customer to not list the products properly. If you are having this issue, you can follow the status of this Magento issue here.

General Integration Guidelines

Unable to render {include} The included page could not be found.