To connect your Prestashop to ChannelEngine, it is necessary to install our Prestashop plugin. This guide will explain how to download, install and configure our plugin. Once installed, you can manage all orders and shipments in the same way you handle regular orders from your webshop.
There are several requirements to install the ChannelEngine Prestashop extension:
- Prestashop 1.6.x(Prestashop 1.7 is temporarily NOT supported: in the latest 1.7 versions of Prestashop there is a ‘composer package’ dependency on the same package our plugin uses, except Prestashop relies on an older version. This causes fatal errors and a workaround is currently being developed)
- Access to the Prestashop admin.
Downloading the extension
On our integration page, you can find both a link to our Github account where you can download the plugin source code as well as a direct link to the .zip file. Please note that if you download the source file from Github, you will need to manually include all relevant composer packages as well.
These packages are already included in the zip file, so in most cases, it’s recommended to download that file.
Installing the extension
The installation is started by logging in in the Prestashop Admin and opening the “Modules and Service” page. Press the “Add new module” option on the top right side of the page.
Select the file under “Choose a file” and upload the module zip file by pressing “Upload this module” (Figure 1). A green install button will appear when uploading is done, click this button to install the plugin.
Now that the plugin is installed, it can be configured from the “Modules and Service” list. Use the search bar to find “ChannelEngine” and click the “Configure” button.
There are several settings which you can configure:
- API Key & Account Name: these credentials are located in your ChannelEngine environment on the Settings > Settings page. From this page, the fields “Account name“ and “API Key“ (Figure 3) need to be copied into the Prestashop plugin general settings.
- Expected shipping period for back orders: this is the number of days expected for back orders to take.
- Auto select carrier: Prestashop already expects a carrier on an order (for handling shipping costs etc). By enabling this setting you let Prestashop set this carrier.
- Carrier for new orders: only applicable if ‘auto select carrier’ is not enabled. If you only have one fixed carrier and disabled ‘auto select carrier’ you can set your default carrier here.
- Status for new orders: this is the default status an order will have once we have forwarded it to Prestashop. This is configurable in case you have some sort of warehouse management plugin that requires a specific order state in order to process new orders.
- Language: this is the language of the shop (only applicable if you use a multi-shop) you want to use for supplying product information.
Once you’ve set up all these options it’s time to test if a product feed can be generated and added to ChannelEngine. This product feed URL is always http(s)://[TheUrlOfYourPrestashopInstallation]/index.php?fc=module&module=channelengine&controller=Callback&type=feed. An example would be https://prestashop.channelengine.com/index.php?fc=module&module=channelengine&controller=Callback&type=feed.
This generates an XML feed which can be added in ChannelEngine at Products > Product feeds. More information on how to add a product feed and how to ‘map’ feed attributes to attributes in ChannelEngine can be found here.
Once that has been done, your products will be loaded into ChannelEngine.
Please note: should your feed fail to be loaded in ChannelEngine, try to open it in a new browser tab. If that gives you a ‘500 Internal Server Error’ there is an issue in generating the feed. In your web servers error_log* you can find the specific reason, but in most cases, it’s the lack of available PHP memory.
In order to send all the product data to ChannelEngine, this data will temporarily be stored in the PHP memory. Depending on the amount of (active) products in your Prestashop, this can take up quite some space. If you don’t have enough PHP memory you will see an error like “php fatal error: allowed memory size of [x] bytes exhausted”. Please consult your web host whether it’s possible to increase this limit (it’s a setting in PHP.ini that can be changed, but the web host must allow it to allocate more memory).
* the exact location can vary based on your specific web server – please consult your web host if you can’t find it.
Activating your connection
After installing and configuring the plugin and after adding the feed to ChannelEngine, you can send an email to firstname.lastname@example.org. We will then verify your installation by checking if orders and returns can be submitted to Prestashop and if so, you can start using ChannelEngine!