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:

https://support.efulfillmentservice.com/hc/en-us/articles/204336103

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 create the integration in the integration server.  Login to IS2, navigate to the integrations tab, and click the "+Add" button in the upper right.

 

 

Select Magento from the list of available platforms. You will then be presented with the screen shown below.

 

 

You should fill out the fields in the form with the following information:

Integration Name: A one word nickname for your integration with no spaces or special characters that helps you remember what store this integration is connected to.

WMS Target: Unless you have more than one WMS connected to IS2, this should populate automatically.  If you have more than one WMS connected, please select the WMS you would like the cart to integrate with.

Order/Inventory Sync Schedules: Select the frequency with which you would like this integration to pass data to/from to your store.

Store Url: Enter the url of your store in the format of http://www.YourStore.com. Make sure you use http:// or https:// to match your store url exactly.

Consumer Key, Consumer Secret, Access Token, and Access Token Secret: Copy these values from your Magento store as generated in step 2 above.  These values must exactly match the value in Magento.

History: Select from the options of 3, 5, 7, and 14 days, which represents the number of days of history we will 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.

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

Store View ID: This 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. 

 

Set in/out of stock for each SKU:  This option 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. 

Notify customer that order shipped: This setting allows ship notifications to customers to be triggered by completion of orders.

Create invoice after updating tracking: This setting will allow for the creation of invoices in Magento once we push tracking back to the cart.

Capture payment for invoice: If you enable this setting and the Create Invoice setting is enabled, we will direct Magento to capture payment for the created invoice as well.

Inventory Source: This 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.

Once you have filled out the form appropriately, simply click the "Save Integration" button at the bottom of the form, and your new integration will be created:

If you wish to test your new integration to make sure it is connected properly, the easiest way to tell is to click on the Cart Items button in your integration, which will bring up the following screen:

Click the Refresh Cart Items button, and if everything is connected properly, we should populate this screen with a list of items from your cart.  If this works, you should be able to turn on Order and Inventory Sync from the previous screen, and your integration should be up and running.

Shipment & Tracking Updates

Approximately 4 hours after orders ship in our WMS, tracking numbers for those orders will be available to send back to Magento.  Tracking updates are pushed out every 30 minutes at the 20 and 50 minute marks. 

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.  You can either set up ship mappings globally for all of your integrations, or for one single integration, if your carts use different ship methods.  To set up Global Ship Mappings, you simply click on the "Global Ship Maps" tab at the top navigation menu in IS2, and then follow the same instructions as below.

 

If you want to set up ship mappings solely for the Magento integration you have created, the first step is to click on "Ship Maps" in the Magento integration navigation.  This will bring up the following screen:

Simply click on "+ New Ship Map", which will bring you to the following form:

This form should be filled out as follows:

Cart Method: This is the shipping method that is used in Magento, which will be passed to us.  You must copy the text of the shipping method in your Magento cart exactly in order for the mapping to work.

WMS Shipping Code: Here you will select the ship method in your WMS that matches how you would like the order to be shipped.  If you are using the FCP as your WMS, you have the option of selecting either a specific ship method, or one of our rate shopping ship groups.

Signature Required/Hold Orders: Here you can select that signature is required for ship methods that support required signatures, or you can have orders held for a set amount of time to allow for fraud screening before they are passed on to your WMS.

Once you have filled out the form, click the Save button, and your ship mapping will be complete.  You will need to create one of these mappings for each ship method utilized in your cart.