Connecting Magento 2

Arjav Patel Updated by Arjav Patel

The purpose of this guide is to detail the steps of connecting Convictional with your Magento 2 store.

Step One: Connect Platform

If you’re using Magento 2, ensure that you selected Magento 2 when your company was being created. To double check this, you should be able to see "Connect your Magento 2 Store" in the Integration Settings. If you do not see this section, please contact support@convictional.com.

You will also need to provide the URL of your store during sign-up.

Tip: The format of the store URL you will need is https://subdomain.store.com/

(Optional) Step Two: Store View

For sellers, the next steps require you to enable shipping and payment methods

If you do not wish to enable these for your default storeview, you can create a new storeview, and enable it only for that. Remember to ensure that products and inventory are also under that storeview's scope.

For buyers, you may wish to show Convictional products only on certain stores (ex. US store vs Canadian store). If you want to use multiple store views for different partners, you will have to create multiple Convictional accounts.

Note down the "code" of your storeview. You will use this in the next step. To obtain the code, navigate to your admin dashboard.

Then navigate to "Stores," then "All Stores" under "Settings."

For the store that you are interested in, note down the "Code" under the "Store View" column.

Step Three: Grant Permissions

In order to enable Convictional to integrate with your Magento 2 store, you will need to grant API key privileges.

This can be done in your Magento 2 Admin dashboard.

To navigate there, head to your Magento 2 Admin dashboard, and click "Stores" then "Configuration" under "Settings":

Next, navigate to "Services" and "OAuth":

On the right, click the dropdown for "Allow OAuth Access Tokens to be used as standalone Bearer tokens," and select "Yes":

At the top, click "Save Config":

Step Four: Generate the API keys

In order to connect with your store, you will need to provide Convictional with Magento 2 API keys.

These can be generated in your Magento 2 Admin dashboard.

To navigate there, head to your Magento 2 Admin dashboard store and click "System" then "Integrations" (it will be under "Extensions"):

Next, click to "Add New Integration":

Enter in "Convictional" for the Name, and you admin password:

Head to "API" under "Basic Settings." Select "All" on the "Resource Access" dropdown under "Available APIs":

At the top, beside "Save," click on the arrow, and then click "Save and Activate"

Click "Allow"

This will generate the API keys. It will look at this:

Copy-paste these keys into your Convictional Settings panel. If you have the code for the store view that you obtained in the previous step, enter it in here as well. Click "Save Credentials"

You will be notified that they saved correctly.

Tip: Within 30 minutes, your products will be visible within the Products tab.

Step Five: Index Management

This step is for buyers only

Convictional pushes a variety of data to your Magento store. Magento sometimes propagates these slowly, causing syncing issues. To circumvent this, you must enable the following settings:

Navigate to "System" then "Index Management" under "Tools" in your admin dashboard.

Use the dropdown to "Select All" indices.

Click on "Actions" and change the value to "Update by Schedule." Then click "Submit."

You must ensure that your Magento cron jobs are running as expected.

Step Six: Enable Delivery Method

This step is for sellers only

You must enable a shipping method for Convictional to be able to place orders on your Magento store.

To do this, navigate to your Magento 2 Admin dashboard, and click "Stores" then "Configuration" under "Settings." Then go to "Sales" then "Delivery Methods"

Enable "Flat Rate" or "Freeshipping" shipping by setting "Enabled" to "Yes." You may need to uncheck "Use system value" before you can do this.

Click "Save Config" at the top.

Step Seven: Enable Payment Method

This step is for sellers only

You must have a payment method enabled for Convictional to be able to place orders on your Magneto store.

To do this, navigate to your Magento 2 Admin dashboard, and click "Stores" then "Configuration" under "Settings." Then go to "Sales" then "Payment Methods"

Navigate to "Other Payment Methods" then expand "Check / Money Order."

Enable "Check / Money Order," "Cash On Delivery," or "Bank Transfer" shipping by setting "Enabled" to "Yes." You may need to uncheck "Use system value" before you can do this.

Click "Save Config" at the top.

Step Eight: Flush Cache

Navigate to "System" then "Cache Management" under "Tools" in your admin dashboard.

Click "Flush Cache"

Using the Magento CLI, run the following command:

php bin/magento indexer:reindex

You should see output that is similiar to this:

Next Steps

With your Magento 2 store now connected, we will be able to sync your information with your partners.

By default, we will sync active products, inventory counts, and order fulfillments. When your buyer receives or directly submits an order for your product, we will pass that order back into your store so that you can fulfill it.

Next, you'll want to set your pricing. You can do so on the Prices page.

Tip: You can also refer to our Pricing Guide for steps on how to setup your prices.

How did we do?

Connecting BigCommerce

Connecting WooCommerce

Contact