Magento Plugin

The Magento plugin provides the ability to pull all Magento products into Checkout Champ. Once the steps are enabled your Magento store can redirect to CheckoutChamp to complete the checkout process.


Step 1 - Install the app on your Magento store

1. Download the app here

  1. Unzip the file into the app > code folder on your Magento store

3. Open a command prompt. Navigate to the project root directory in the app > store folder.

4. Run php bin/magento setup:upgrade

5. Run php bin/magento setup:di:compile

6. Run php bin/magento setup:static:static-content:deploy -f

7. Run php bin/magento cache:flush

Step 2 - Configure Magento Security

  1. Login to Magento

  2. Go to Stores > Configuration > Services > Magento Web API > Web API Security

  3. Set Allow Anonymous Guest Access to Yes

  4. Save

Step 3 - Setup the CheckoutChamp Plugin

Login to the CheckoutChamp page builder. Navigate to your funnel and drag the Magento page type to the funnel canvas if you have not done so already.

Click on the Magento page

Click the settings gear icon to open the plugin settings.

storeURL = your Magento store url (minus the https://)

userName = your Magento store user name

password = your Magento store password

campaignId = optional. Use this to assign your Magento products to a specific campaign. If blank, a new campaign is created when the products are pulled from Magento . If grayed out, then all products will load into the funnel/campaign that the plugin was added to.

gatewayId= optional. The gatewayId to assign to the CRM campaign products created from the Magento products. Entering a value here will save the effort of manually editing the campaign products to assign a merchant account. gatewayId can be found on the MID List on the CRM side of your account under Merchants Gateway List. Press Create Plugin to save.

Step 4 - Synchronize Products

This process will pull your Magento products into your Checkout Champ account.

Login to CheckoutChamp and navigate to the Magento funnel

Click on the Magento page

Click the Settings gear icon to open the plugin details

Press the blue Sync Products button

The product sync will take a few minutes (or longer depending on the number of products in your Magento store). When the sync is finished, go to the funnel Settings and open Offers or Upsells to view/edit the imported products.

Step 5 - Configure Magento Redirect

  1. Login to Magento

  2. Go to Stores > Configuration > CheckoutChamp

  3. Enable the redirect

  4. Set Checkout URL to the full URL of the CheckoutChamp checkout page

  5. Save

Troubleshooting Product Sync Errors

Disable the redirect on your Magento store

  1. Login to Magento

  2. Go to Stores > Configuration > CheckoutChamp

  3. Set Enable = No

  4. Save

Disable the app on your Magento store

  1. Go to the project root directory in the app > code folder

  2. Run php bin/magento module:disable CheckoutChamp_Meta

Uninstall the app on your Magento store

  1. On your Magento store go to Admin > Stores > Attributes > Products

  2. Click on Additional Data Id

  3. Click on Delete Attribute

  4. Remove the module CheckoutChamp_Meta from app/etc/config.php

  5. Remove the module CheckoutChamp_Meta from table setup_module

  6. remove the folder app/code/CheckoutChamp

Last updated