Magento 2.0.X + Integration Instructions

Please Note: This integration requires Magento 2.0 or greater. If you are using an older version of Magento, please see our earlier instructions here:

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/add-ons, 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.

Step 1: Enable Magento API

To enable the API within Magento, visit Magento > System > Integrations menu option and click on Add New Integration.


Step 2: Generate API Keys

After you click the "Add New Integration" button you will enter a name for the integration then click on the API tab on the left.

On the API page, you will see a list of Available APIs that you can give us access to, you will need to give us access to the Sales and Product APIs as shown below, then click Save.

Clients wishing to sync inventory to a specific Inventory Source should also select/allow the following permissions under the Stores section.


You will then need to click the Allow button to confirm you are giving us access to those APIs:

Once saved you will then need to Activate the integration, do this by clicking the link shown below.


Once you activate the integration the Consumer Key, Consumer Secret, Access Token, and Access Token Secret will be displayed. These you will need to input into your 'Integration Settings' page within the FCP so keep them available so you can copy and past them in the next step.

Step 3: Fulfillment Control Panel Settings

Once you have obtained your key and secret you will need to enter them into your Fulfillment Control Panel account. Choose Add Integration from the Integration menu.




Select Magento2 from the list of available platforms and click the “Add new Integration” button. You will then be presented with the screen shown below.



The Store Url of your store should be entered in the format of make sure you use http:// or https:// as required.

Then the Consumer Key, Consumer Secret, Access Token, and Access Token Secret must be copied exactly as they appear in Magento.

History is a drop-down with the option of 3, 5, 7, and 14 days, which represents the number of days of history to check for created orders. For example, if you select the number “5” in this field we will only retrieve orders created within the last five days.

Storeview is an optional setting that will tell the FCP to only pull in orders that match a particular Storeview ID. Below is an example of where to get this information from Magento's support documentation. 

Inventory Source is an optional setting for Magento versions 2.4+ that will allow EFS to sync inventory back to a specified inventory source in your Magento cart.  The inventory will be synced back to the Source listed in this field, which should match a Source in your cart.  Your inventory should be appropriately associated with the source in your cart.
If the field is blank, inventory will be synced back to the cart's default source.
If a value is given, we will only sync to the specified source.
We do not validate this information, or whether appropriate permissions have been given in the cart.  It is client responsibility to ensure they enter this information and allow access correctly.




Order Status is the status of orders we will retrieve from your Magento store. It is most common to use “processing” for this status. 

Set in/out of stock for each SKU allows you to choose whether or not the FCP will change the In/Out of Stock flag on each SKU when we sync inventory counts to your store. 

The next set of options determines the intervals at which we check for new orders and, optionally, send available inventory counts back to Magento (please see the Item List & Inventory Sync Guide for more information on inventory syncing). 

If you have more than one Magento2 store you may assign a “nickname” to each store to better identify options and settings for each one.

Click the “Add new Integration” button to finalize the integration settings. You should see a success message at the top of your screen.

To verify that we can connect to your Magento store choose View Integrations from the Integration menu. For each integration, you have configured, you will see a set of options displayed as colored icons. Click the “suitcase” icon to view the items in your Magento store.




You should see a searchable list of products from your store. The list will indicate if the product SKU matches a SKU in our system.


If you do not see a list of products and, instead, see an error message it is likely that  your Store Url or one or more of the keys/tokens has been incorrectly entered in our system.

Shipment & Tracking Updates

Approximately 4 hours after the order ships we will send tracking numbers back to Magento, for orders shipped previously. 

Shipping Methods

When we retrieve your orders from Magento the shipping methods are shown as strings of text such as “Free Shipping” or “USPS International Express” or “Federal Express Ground”. This text needs to be translated to our internal codes by setting up mappings within the integration configuration.


From your Fulfillment Control Panel account choose View Integrations from the Integration menu and then click the “envelope” icon to view existing shipping mappings.



Carefully type or “copy and paste” the exact text of your shipping method options from Magento into the Cart Shipping Method field, then choose from the list of available shipping methods. Next, click the “Add Mapping” button, and then click the link in the success message to refresh the list (you will need to do this before you can add another method).



Optional Features

We also have a feature which will synchronize the available inventory counts from our warehouse back to your Magento store. This is useful if you don't want to sell products that are out of stock. More information on Inventory Syncing can be found here.


Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk