# 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](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Step-1---Install-the-app-on-your-Magento-store)
* [Step 2 - Configure Magento Security](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Step-2---Configure-Magento-Security)
* [Step 3 - Setup the CheckoutChamp Plugin](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Step-3---Setup-the-CheckoutChamp-Plugin)
* [Step 4 - Synchronize Products](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Step-4---Synchronize-Products)
* [Step 5 - Configure Magento Redirect](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Step-5---Configure-Magento-Redirect)
* [Troubleshooting Product Sync Errors](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Troubleshooting-Product-Sync-Errors)
* [Disable the redirect on your Magento store](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Disable-the-redirect-on-your-Magento-store)
* [Disable the app on your Magento store](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Disable-the-app-on-your-Magento-store)
* [Uninstall the app on your Magento store](https://konnektive.atlassian.net/wiki/spaces/CC/pages/2371649587/Magento+Plugin+-+Checkout+Champ#Uninstall-the-app-on-your-Magento-store)

***

### Step 1 - Install the app on your Magento store <a href="#step-1-install-the-app-on-your-magento-store" id="step-1-install-the-app-on-your-magento-store"></a>

1\. Download the app here

{% file src="<https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2Fwhs7VnrCTzvrnsYfNQjH%2FCheckoutChamp.zip?alt=media&token=4628fbe6-a7b2-4c47-95d1-bc57d72204f4>" %}

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

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FhrgWfV55GSYWDRaNaGwy%2Fimage.png?alt=media&#x26;token=0ddeea87-4c49-469e-9cb4-6becb7e8010b" alt=""><figcaption></figcaption></figure>

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 <a href="#step-2-configure-magento-security" id="step-2-configure-magento-security"></a>

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

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FWstaP0eMMSN7OJoYAIdp%2Fimage.png?alt=media&#x26;token=c03264b6-21e9-4611-9f10-332f6b56e3f0" alt=""><figcaption></figcaption></figure>

### Step 3 - Setup the CheckoutChamp Plugin <a href="#step-3-setup-the-checkoutchamp-plugin" id="step-3-setup-the-checkoutchamp-plugin"></a>

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.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FgS1EWuQzYnxg7wYizQxq%2Fimage.png?alt=media&#x26;token=6ca94b86-4774-403f-8b05-2a9160f5fca1" alt=""><figcaption></figcaption></figure>

Click on the Magento page

Click the settings gear icon to open the plugin settings.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2Fa7ja5bzySuMytwdtaH89%2Fimage.png?alt=media&#x26;token=b5e1c4bb-55a2-40de-af23-6f7aa28f8bb1" alt="" width="458"><figcaption></figcaption></figure>

**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.\ <br>

### Step 4 - Synchronize Products <a href="#step-4-synchronize-products" id="step-4-synchronize-products"></a>

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

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2Fyg79ZfjLU2BJURQoGtmv%2Fimage.png?alt=media&#x26;token=60f4c0f9-143d-493b-95bc-aa33bc0f7a95" alt="" width="450"><figcaption></figcaption></figure>

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 product&#x73;**.**

Variant detail information will be synced from Magento. For more information about Product Variations please view this [article](https://app.gitbook.com/s/iAC0G99SjXjSv2GM5PAE/konnektive-crm/crm-setup/product-setup/product-variations) .

&#x20;

### Step 5 - Configure Magento Redirect <a href="#step-5-configure-magento-redirect" id="step-5-configure-magento-redirect"></a>

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

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FNS5xruCZaebZlGv5dDjS%2Fimage.png?alt=media&#x26;token=4de42a1b-ad18-4a45-84a5-68e109588c72" alt=""><figcaption></figcaption></figure>

### Troubleshooting Product Sync Errors <a href="#troubleshooting-product-sync-errors" id="troubleshooting-product-sync-errors"></a>

### Disable the redirect on your Magento store <a href="#disable-the-redirect-on-your-magento-store" id="disable-the-redirect-on-your-magento-store"></a>

1. Login to Magento
2. Go to **Stores > Configuration > CheckoutChamp**
3. Set **Enable** = No
4. Save

### Disable the app on your Magento store <a href="#disable-the-app-on-your-magento-store" id="disable-the-app-on-your-magento-store"></a>

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 <a href="#uninstall-the-app-on-your-magento-store" id="uninstall-the-app-on-your-magento-store"></a>

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**

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2F0KVi1c97eTrjg6by6YTz%2Fimage.png?alt=media&#x26;token=3d455a06-a9da-451e-a9d6-d647d4301462" alt=""><figcaption></figcaption></figure>