Plugins are called modules in the magento2 environment. This page shows you the whole installation process of a module in magento2.
Especially for users of a composer, this page will provide further help: https://belvg.com/blog/how-to-install-module-manually-on-magento-2.html
Step 1: Install the plugin/module in the shop
Step 1: "Install the plugin/module in the shop" is only needed, if tracking has to be available.
If only order-handling or the export is required, you can jump directly to Step 2: "Setup the module in Magento2"
If you install the module via ZIP-archive on your webserver, you have to be the owning user of the Magento directory (probably www-data).
Copy the content of the appended install-folder into the appropriate folder of your Magento installation. This should be as default:
<magentoRoot>/app/code/
If this folder does not exist, please create it. In the end, it should look like this:
<magentoRoot>/app/code/ChannelpilotSolutions/
Tracking/
API/
Payment/
Shipping/
After that, the plugin has to be activated in your system.
If you have a module manager in your Magento backend, please navigate to the page and activate all entries which are called "channelpilotsolutions" or similar:
System -> Web Setup Wizard -> Component Manager
OR
System -> Tool -> Web Setup Wizard -> Module-ManagerIf there is no module or component manager installed, you have to use the magento command line to active the module. This command checks, installs and activates all available modules in your Magento backend:
php bin/magento setup:upgrade
Step 2: Setup the module in Magento2
There are some steps which are necessary to activate the functions of the module:
create a store: the StoreCode is needed
create an integration: API rights have to be set and accessToken is needed
create order status: for correct processing of orders
Magento URL: is needed for registration (the URL from the Magento backend is needed, not the URL of the shop)
Create a store, get the StoreCode and activate OAuth
Please check if there is a minimum of one shop created and activated in your backend here:
Stores -> Settings -> All Stores
For the activation you need the "code" from "Store view". If there is only one shop available, this should be "default".
After this step, you have to activate the option "Allow OAuth Access Tokens to be used as standalone Bearer tokens" (since Magento 2.4.5) here:
Stores -> Configuration -> Services -> OAuth
Under "Consumer Settings" you will find the option, which has be to set to "Yes"
After the configuration option is activated, you have to refresh the cache type “configuration” in the cache management via:
System -> Tools -> Cache Management
There you have to click "Configuration" to select the row. Make sure that the action is set on "Refresh" and click on "Submit". Then the option from above is working.
Setup tracking
This step for "Setup the tracking" is only needed, if tracking has to be available and if the module was installed under Step 1: "Install the plugin/module in the shop".
If you don't want to use the tracking, you can skip this step.
To use the tracking, you have to configure the installed module. To finalize this, you will need the tracking key from your Channel Pilot Pro Shop, which has to be configured. Please contact your account manager for this.
Stores -> Configuration -> Channel Pilot
Please make the following settings, to transfer this information to the sales tracking script:
Tracking Key: a key from your Channel Pilot Pro Shop (ask your account manager)
Item Number: select ID or SKU
Cookie Mode: select First or Last cookie mode
Margin: all datafields of type decimal or text can be chosen here (even custom product attribute)
Create an integration, set API rights and get the access token
Create a new integration with a unique name like "Channel Pilot Pro" and the necessary "API - Access Rights":
System -> Extensions -> Integrations
In the settings of each integration, you have to activate "API rights".
The necessary settings are listed below. We recommend to grant full access (all rights) to make sure that no other process blocks anything.
If you want to grant full access, there is a known issue in Magento2 if you set the option to "ALL". Please use "Custom" and activate the highest level of all rights. This will include all rights below.
If all necessary rights are granted, you have to save the integration. Then there will be 4 keys available under "Integration Details".
For the next step you will need the "Access Token".
Create order status and assign the right state
Now you have to create a new order status and assign the correct settings.
Stores -> Settings -> Order Status
The status which has to be created needs the following settings:
Status code: imported
Status label: Successfully imported from Channel Pilot Pro (can be defined free)
Order state: pending
Use order status as default: false (not activated)
Visible on storefront: false (not activated)
Register your installation
If all steps above are done, you have to register your installation. This provides you with the information which your account manager needs to activate your Magento2 connection on Channel Pilot Pro side.
Please visit the following page: https://magento.channelpilot.com/install
Type in the following information:
shopUrl -> the url to your Magento2 installation (not the shop URL)
shopCode -> the shop code you got from the shop setup
accessToken -> the access token you got during the integration setup
Click on "Senden" and then you will get two links:
exportUrl: this will provide you with a product export from your Magento 2 shop which is setup behind the shop from which you used the shopCode
registrationUrl: your account manager needs this URL to register your Magento 2 setup on Channel Pilot Pro
Export:
The export is only recommended for a maximum of ~ 1000 SKU. Because the connection works with the Magento-API, the API does not support a large amount of product data through this connection point.










