Introduction
These instructions will show you how to configure your Fulfillment Control Panel and PrestaShop accounts to sync orders and inventory levels.
Currently, some older versions of PrestaShop require Debug Mode to be turned on in order for us to access all features of the API. If you have a more recent version of PrestaShop, you can ignore the following instructions on turning on Debug Mode, and can skip straight to activating the Webservice Feature.
Note: Each install of this shopping cart is unique due to several outside factors (i.e. platform where it’s installed, version of php, plugins/addons, etc.) These instructions have been tested and are known to be working with the base install of the cart in our test environment. EFS troubleshooting of issues will be limited to the install configuration that is known to be working with our integration. All other troubleshooting (and associated expense) will have to be done by you and/or your developer.
Turning on Debug Mode
You can now easily turn on Debug Mode from your PrestaShop dashboard. Simply login to your store's dashboard, and click Advanced Parameters, then click on Performance in the sidebar menu. This will display settings in the main window, and you'll be looking for the panel labelled Debug Mode. Under that, you will see a toggle for Debug Mode, which you should flip to on.
Once Debug Mode is active we are now free to activate the Webservice feature of PrestaShop.
Activating PrestaShop's Webservice Feature
(For both Cloud(Hosted) and Downloaded(Self-Hosted) Stores
To begin, you will want to log into the backend of your PrestaShop Store. Once you log into your store you will want to navigate to ADVANCED PARAMETERS > Webservice in your sidebar menu.
The webservice feature is disabled by default, and must be enabled first. You will see the following popup, and you should click “Enable PrestaShop’s webservice" to on:
Then click on the “Add new webservice key” button to add a new web service account.
Once you are in the Webservice Accounts screen you will click the Generate button to generate a new Key. Then you can enter in a Key Description (i.e. EFS Integration) and make sure the Status is set to Yes.
Under the Permissions section you will need to check the All check box for the View(GET) and the Fast view (HEAD) columns:
Also you will need to check the following checkboxes:
order_carriers > Modify (PUT), Add(POST)
order_details > Modify (PUT)
order_histories > Modify (PUT), Add(POST)
orders > Modify (PUT)
products > Modify (PUT)
stock_availables > Modify (PUT)
As shown here:
Finally hit the Save icon at the bottom of the page to save your changes. You will need to copy the Key you generated in this step and paste it into the integration settings for the integration you will create below. Once you have finished configuring the webservice, you should turn off Debug Mode, as leaving it on can cause performance and security issues.
Add PrestaShop Integration to the Integration Portal
Once you have obtained your webservice Key you can create your PrestaShop integration in the Integration Portal. You can start by navigating to the integrations tab of the Integration Portal, and clicking the blue “+Add” button in the upper right:
Select PrestaShop from the list of available platforms, which will bring up the following form:
You should fill out these fields with the following information:
Integration Name: Create a nickname that will help you identify what store this integration is connected to. Please use one word with letters and numbers, no spaces or special characters.
WMS Target: Only necessary if you have multiple WMS connections, otherwise will default to FCP. If you have multiple WMS connections, select the one you wish this integration to point to.
Order/Inventory Sync Schedules: Set the schedule at which you want the integration to sync data with PrestaShop.
API URL: This URL was created when you activated Webservice in PrestaShop and created a new webservice key. This url can be found in the webservice section of PrestaShop at the very top, as shown below:
API KEY: This is the key that was generated in PrestaShop when you set up the webservice. You should copy this key exactly as it is found and paste it here.
History: Select the age of orders you would like us to pull in with this integration. Orders older than this setting will not be synced.
Multi-language enabled for cart: Select whether you have multiple languages enabled for your PrestaShop store.
Default Language ID: If you selected yes on Multi-language enabled, you will need to navigate to International>Localization>Languages as shown below, and enter the ID number for the English entry:
If you selected no on Multi-language enabled, just put a 1 in this field.
Finally, click the “Save Integration” button in the lower right, and your integration will be created:
You can confirm that everything is working properly by going to the cart items section of your integration and clicking the “Refresh Cart Items” button. If everything is connected correctly, this should populate your cart items page with the products in your PrestaShop store.
Shipment & Tracking Updates
There is an approximately 4 hour delay from the time we ship an order until we send tracking numbers back to PrestaShop.
Shipping Methods
When we retrieve your orders from PrestaShop the shipping methods are shown as strings of text such as “Free Shipping” or “USPS International Express” or “Federal Express Ground”. You can view/setup the shipping methods in PrestaShop by going to SHIPPING > Carriers
Once you have your shipping methods setup to your liking within PrestaShop, these need to be translated to our internal codes by setting up mappings within the integration configuration. Begin by navigating to the Ship Maps section of your integration, and clicking the “+New Ship Map” button, which will bring up the following form:
All you need to do is copy the Name from your shipping method in PrestaShop, and enter that in the Cart Method field above. Then select the shipping code in your WMS that you would like orders with this shipping method to ship by. Finally, select whether you would like required signatures for services that support them, or whether you want orders with this ship method to be held for fraud screening. Then click save, and repeat as necessary until you have mapped all your ship methods in PrestaShop.
At this point, you should be completely setup, and you can turn on your order and inventory syncing to start sending orders to our system.
⠀
0 Comments