Magento Cart

From Fishbowl
Revision as of 20:06, 16 April 2018 by Ncarter (talk | contribs)
Jump to navigation Jump to search

Icon.Magento Cart.png The Magento Cart module, located in the Integrations group, is an add-on module that can be installed from the Icon.Plugin.png Plugin module. After installing the plugin, a new module is added that integrates with one or more Magento shopping carts. This plugin is specifically designed to integrate with Magento 1.7 through Magento 1.9 using the version 1.x XML-RPC API. For Magento 2.1 or higher, use the Icon.Magento.png Magento module.

Magento Cart.png



The documentation on this page is for the most recent version of the Icon.Magento Cart.png Magento Cart plugin. To get the most recent version, Update Fishbowl.

  1. In any Fishbowl Client, open the Icon.Plugin.png Plugin module, located in the Integrations group.
  2. Select the Icon.Magento Cart.png Magento Cart plugin and click Install.
  3. Completely close all Fishbowl Clients.
  4. Exit the Fishbowl Server by right-clicking the Fishbowl Server tray icon and selecting Exit.
  5. After re-opening the Fishbowl Server, the admin user can access the Icon.Magento Cart.png Magento Cart module from any Fishbowl Client by opening the Integrations group.
  6. To grant access to additional users, assign the Magento Cart-View access right to the appropriate groups in the Icon.User Group.png User Group module

Setup Template:Top

In order to connect to Magento, the Magento API must first be configured properly. Follow the steps below to create a role, create a user, and then enter the credentials into the store settings of the Icon.Magento Cart.png Magento Cart module.

1. Create a role

  1. Log into the Magento admin dashboard and navigate to System > Web Services > SOAP/XML-RPC - Roles.
    Magento Roles.png
  2. Click the Add New Role button.
    Magento New Role1.png
    • Enter a Name, such as Fishbowl, and then enter the Current Admin Password so that the role can be saved when completed.
  3. Click Role Resources on the left and select All from the Resource Access drop down.
    Magento New Role2.png
  4. Click the Save Role button.

2. Create a user

  1. Navigate to System > Web Services > SOAP/XML-RPC - Users.
    Magento Users.png
  2. Click the Add New User button.
    Fishbowl Integration Magento 4.png
    • Enter a User Name, such as Fishbowl.
    • Fill out the First Name, Last Name, and Email for the user being created.
    • Enter the Current Admin Password so that the user can be saved when completed.
    • Create an API Key for the user. This is essentially a password. Confirm the password in the API Key Confirmation field.
  3. Click User Role on the left and select the role created above.
    Fishbowl Integration Magento 5.png
  4. Click the Save User button.

3. Store Settings

  1. Open the Icon.Magento Cart.png Magento Cart module and enter the Store URL and the user credentials that were created above.
    Magento Credentials.png
  2. Click the Test Connection button to verify that the connection is valid and then click Save.

Multiple Magento carts can be configured by clicking the New Button.png New button, which will add another Magento Cart tab.

Australia/Canada Template:Top

When using the Magento plugin with Fishbowl Australia or Fishbowl Canada, some additional tax options are available in the Taxes section of the Order Import tab.

Magento Tax Province.png

  • Use Customer Tax Code - When selected, orders imported from Magento with tax will use the customer assigned tax code in Fishbowl. The tax amount on the Fishbowl sales order will be calculated using the tax code assigned in Fishbowl. If no tax code is assigned to the customer, the order will fail to import. New customers created will use the default tax code assigned in Fishbowl.
  • Use Customer Tax Code - When selected, orders imported from Magento with tax will use the associated product tax codes in Fishbowl.
  • Use Tax By Province - When selected, orders imported from Magento with tax will use orders ship to province to determine the orders tax in Fishbowl.

Tax rates can also be mapped using by the Magento product tax class ID as explained below.

  1. Open the Magento Admin Panel in a web browser.
  2. Click the Sales menu at the top.
  3. Hover over Tax and then click Product Tax Classes.
  4. Click the applicable tax rate.
  5. Locate the word id in the URL bar at the top of the browser and copy the number that follows id.
    Magento tax rate id.png
  6. Click the Product Import tab of the Icon.Magento Cart.png Magento Cart module and select Use product tax class mapping.
    Product Tax Class Mapping.png
  7. Click the Add Icon Button.png Add button, enter the id copied from Magento, and select the Fishbowl tax rate.
    Product Tax Class Mapping 2.png
  8. Click the Save to close the dialog, and then click the Save Button.png Save button on the module toolbar.Template:Vertical SpacerProduct Tax Class Mapping 3.png



  • Schedule - Select the Checked.png Active checkbox to import orders on a set schedule. Click the Run task Button.png Run task button to run the scheduled task right now. Data that has changed since the Last Sync date will be synchronized. This date will be updated automatically after a sync, or it can be manually edited to adjust which data will be synchronized.

Template:Subtab Template:Cart Order

  • Remove '#' prefix from Magento Cart order numbers - When selected, Magento Cart order numbers will not have a '#' prefix when imported into Fishbowl.

Template:Subtab Template:Cart Order Status Mapping

Template:Subtab Template:Cart Customer

Template:Subtab Template:Cart Carrier Mapping Click here to see which carriers Magento supports.

Follow the instructions below to map carriers between Magento and Fishbowl.
  1. Log into the Magento Admin panel.
  2. Click the System menu and then select Configuration.
  3. In the Sales section on the left, click Shipping Methods.
  4. Expand the desired shipping method and copy the Title and Method.
    Magento flat rate.png

    Magento UPS.png
  5. Open the Carrier Mapping section on the Order Import tab and then click the New Icon Button.png New button.
    Magento carrier mapping done.png
  6. Enter the exact Title and Method into Fishbowl with the following format Title - Method. Below are several examples.Template:Vertical SpacerMagento carrier mapping.png
    • Flat Rate - Fixed
    • Free Shipping - Free
    • United Parcel Service - Next Day Air
    • United Parcel Service - Ground
  7. Select the corresponding Fishbowl Carrier Service and then click the Save button.

Template:Subtab Template:Cart Payment Mapping

Follow the instructions below to map payment methods between Magento and Fishbowl.
  1. Log into the Magento Admin panel using Google Chrome.
  2. Click the System menu and then select Configuration.
  3. In the Sales section on the left, click Payment Methods.
  4. Right-click the header of the desired payment method and select Inspect.
    Magento payment method inspect.png
  5. In the section highlighted by Chrome, copy the text between "payment_ and -head".
  6. Open the Payment Mapping section on the Order Import tab and then click the New Icon Button.png New button.
    Magento payment mapping done.png
  7. Enter the Magento payment ID into Fishbowl. Below are several examples.Template:Vertical SpacerMagento payment mapping.png
    • checkmo
    • cashondelivery
    • authorizenet
    • banktransfer
  8. Select the corresponding Fishbowl Payment Method and then click the Save button.

Template:Subtab Template:Cart Taxes

Template:Tab Template:Cart Order Fulfillment

  • If a carrier on an order is not an approved carrier by Magento it will be set to Custom Value.
  • For a list of accepted carriers please see Carriers.

Template:Tab Template:Cart Product Import

Template:Tab Template:Cart Product Export

Template:Tab Template:Cart Inventory Update


  • Only new orders are imported. Orders are not updated once they have been imported. Returns and refunds are not imported.
  • The attributes and IDs for orders and products can be viewed or modified by clicking the Small.Shopify.png Shopify button at the top of the Icon.Sales Order.png Sales Order module and the Icon.Product.png Product module.
  • To view the scheduled tasks for the Icon.Shopify.png Shopify module, open the Icon.Schedule.png Schedule module.
  • A scheduled task can be run manually by double-clicking the task.
  • Enter an email address in the Icon.Schedule.png Schedule module to receive error notifications.
  • To view the history of a scheduled task, including the result/error, click the History Icon Button.png History button in the Icon.Schedule.png Schedule module.
  • More details about recent errors can be viewed by opening the Icon.Data.png Data module and clicking the Server Log Button.png Server Log button.
  • Check for multiple versions of the Shopify.jar file in C:\Program Files\Fishbowl\plugins\ or \Applications\Fishbowl\plugins\ on a Mac. If there are two Shopify versions, exit the Fishbowl Server and remove the older version on all client and server computers.
  • When syncing products from Magento to Fishbowl, products will match Magento SKU to Fishbowl Product Number field. If no match exists, a new product will be created.
  • When shipping multiple cartons for a single Magento order, only the cartons with tracking numbers will be exported back to Magento. If orders seem to be missing on the Magento site, verify that each of the cartons for that order have tracking in Fishbowl.

Release Notes

4.17 - 4/12/2018 - Fishbowl 2018.4
  • Addition of a new order status mapping table. You can now import multiple statuses at the same time.
4.16 - 3/8/2018 - Fishbowl 2018.3
  • Changed background color on headers in the Order Import tab when using the dark theme for better visibility.
  • Payment import now pulls in currency rate if “Use Currency Conversion” is turned on in Fishbowl.
  • Bug Fixes
4.15 - 1/31/2018 - Fishbowl 2018.1
  • No longer updating product catalog visibility during product export.
4.12 - 1/12/2018 - Fishbowl 2017.13
  • Enhancement to the Order Import. If the carrier is empty on the data coming from the shopping cart, it will be defaulted to "Will Call" in Fishbowl.
  • Enhancement to the Order Import. The customer phone number and email will attempt to be pulled from the shopping cart customer data. If that data isn't available on the customer, then it will attempt to be pulled from the billing address on the order. If that data isn't available in the billing address, then it will be pulled from the shipping address.
  • Enhancement to Canada version of Fishbowl. Added an option in the Order Import panel to allow for prioritizing which tax is used on orders. If check box is checked, product tax will be used first. If no product tax has been assigned, then province tax will be used.
4.11 - 12/8/2017 - Fishbowl 2017.11
  • Enhancement to allow payments to be applied to Sales Orders in an "Estimate" status when orders are imported.
  • Added a checkbox option to either include or exclude the "#" prefix from Sales Order numbers.
4.10 - 11/21/2017 - Fishbowl 2017.11
  • Enhancement so "Miscellaneous Fees" come in on orders.
  • Enhancement for international customers where the tax code moves between Fishbowl and their channel. Tax code must exist in Fishbowl for it to be used with this process.
  • Fixed a bug where imported orders weren't being "Fulfilled" in Fishbowl when the "Fulfilled" status option is selected in the Order Import.
  • Fixed a bug where Carrier information was importing into Fishbowl, but not the Carrier Service.
  • Fixed a bug where the Customer name from the Ship To address wasn't being put in the "Name" field on the address.
4.9 - 11/20/2017 - Fishbowl 2017.11
  • Fixed a type conversion bug.
4.8 - 11/16/2017 - Fishbowl 2017.11
  • Improved the way Fishbowl looks at Class on orders.
  • Improved plugin UI for Order Import.
  • Added a checkbox to Product Export to allow all products to be exported
  • Improved error messages.
  • Enhancement to save a product's attribut id in a custom field so it can be sent up to the channel. Applicable to new products being imported into Fishbowl. For existing products, custom field must manually be filled in.
  • Fixed a bug with payment mapping.
  • Fixed a bug with the Customer selection on Order Import.
  • Fixed a bug where orders with kits weren't being fulfilled.
  • Fixed a bug where discounts were being duplicated on orders.
  • Fixed a bug where incorrect address were being applied to orders for Default customers.
4.7 - 10/30/2017 - Fishbowl 2017.10
  • Improved the process for customer creation in Fishbowl. Fishbowl now looks at the Last Name, Zip Code, and Email Address from the Billing Address on orders when creating customers. If all fields match, the order is applied to that customer in Fishbowl. If they don't match, a new customer is created.
  • Fixed a bug with the way flat rate discounts were being added to orders
4.6 - 10/9/2017 - Fishbowl 2017.9
  • Fixed a bug with tracking numbers being sent to incorrect orders in shopping cart.
  • Fixed a bug with order import not calculating line item percentage-based discounts correctly.
  • Product Import and Product Export required field mappings are not editable.
4.5 - 9/12/2017 - Fishbowl 2017.7
  • Fixed a bug with the refresh button.
  • Fixed a bug with sales order line item type associated with kits.
  • Fixed a bug in the Canada version where non-inventory items weren't being taxed by province.
4.4 - 9/7/2017 - Fishbowl 2017.7
  • Fixed issue with customers getting a "number format exception" error.
4.3 - 9/6/2017 - Fishbowl 2017.7
  • Fixed issue with order import where discounts weren't being applied correctly in Fishbowl.
4.2 - 8/31/2017 - Fishbowl 2017.7
  • Interim Release
4.1 - 8/29/2017 - Fishbowl 2017.7
  • Interim Release
4.0 - 8/25/2017 - Fishbowl 2017.7
  • New layout and mapping options
3.4 - 8/14/2017 - Fishbowl 2017.6
  • Fixed weight and size UOM issue on product import being set incorrectly for products created in FB
3.3 - 7/28/2017 - Fishbowl 2017.6
  • Fixed payment mapping bug where orders were imported but no payment was created with the payment mapping set
3.2 - 7/13/2017 - Fishbowl 2017.6
  • Compatibility fixes for 2017.6 version of Fishbowl
  • Fixed an issue in AU version where order total from Magento and payment in FB were incorrect
  • Fixed in AU version so Shipping and Discount items reflect accurate tax codes and amounts
  • Fixed bug where the bill to company was being used in the ship to address block
  • Fixed bug for CA version where order items didn't use the correct tax code when using the province tax mapping
3.1 - 6/20/2017 - Fishbowl 2017.5
  • Compatibility fix for 2017.5 version of Fishbowl
3.0 - 5/22/2017 - Fishbowl 2017.4
  • User interface enhancements and fixes including new layout for the order import panel, fixed combo boxes, and enter keyboard stroke works in dialog boxes
  • Removed the settings button from the toolbar, moving payment and carrier mapping to the order import panel
  • Improved error messages when order sync fails
  • Improved tool tips to add clarity
  • Fixed bug when option to create payments in Fishbowl was unchecked allowing payments to still go over to FB when Magento order status is invoiced or complete
  • Fixed bug when option to create payments in Fishbowl was unchecked and an order would fail if no payment method was mapped
  • Set the 'last sync dates' to when the user clicks save on the interface for first run on order import, order export, and inventory. Products have a historical last sync date set on first run.
  • Added option to create order level discounts
  • Updated the schedule panel modifying the run task and reset last sync date options
  • Fixed to allow incoming orders to use the already specified SO item type for products
  • Fixed bug where carriage returns in the address blocks brought in the letter "n" to the Fishbowl SO
  • Fixed bug when default customer was selected in the plugin interface and new customers were still created
  • Fixed bug to not allow user to map payment method and carrier to more than one mapping
  • Added functionality to send partial shipment data to Magento
  • Fixed bug where items broken out in FB in multiple cartons didn't update correctly in Magento
  • Added option to use company name as the customer name in FB for new customer creation
  • Added option to allow FB to calculate tax based on customer assigned tax code
  • Added company name to bill to and ship to addresses
  • Added ability to set customer status for new customer creation

Australia and Canada Only

  • Fixed bug where order tax rounding resulted in different order amounts in Fishbowl than Magento
  • Add option to use province tax mapping in CA version
  • Add option to use customer assigned tax code in CA version
  • Added option to map product tax codes between FB and Magento
  • Fixed bug where shipping line items did not use the product tax code
2.5 - 4/26/2017 - Fishbowl 2017.3
  • When syncing inventory from FB to Magento and the product has been deactivated in Magento, we received "product not exist" error back from Magento. A more user friendly error message was added for this scenario.
  • Fixed bug during product sync when saving product id.
2.4 - 4/13/2017 - Fishbowl 2017.3
  • Compatibility fixes for 2017.3 version of Fishbowl
  • Fixed tax functionality for Australia and Canada versions of Fishbowl
2.3 - 4/4/2017 - Fishbowl 2017.2

Considerations before updating to Version 2.3

  • If using the carrier and payment mappings in version 2.3, please read through the setup instructions on this wiki page. Carrier(s) and payment(s) names from Magento much match exactly when entered.
  • If checkbox is set to use order tax, the order import will fail unless the customer in FB has a tax rate assigned.

Features and Fixes

  • Added checkbox option to use company name when creating new customer on SO Import
  • Fixed product mapping error when no SKU specified for product sync from FB to Magento
  • Added ability to map payment(s) and carrier(s) between Magento and FB.
  • Added flexibility for product field mappings between Magento and FB.
  • Changed product sync to separate scheduled tasks for importing and exporting products.
  • Added checkbox option to use order based tax rate calculations instead of flat rate tax items.
  • AU customers only - added checkbox option to include the product tax class mapping between FB and Magento.
  • Australia and Canada customers only - added product tax class mappings between FB and Magento.
  • Australia and Canada only - fixed tax functionality to set the tax rate correctly.
2.2 - 3/16/2017 - Fishbowl 2017.1
  • Changed product mapping options to have FB Fields as static and Magento as dynamic
  • Added product weight mapping
  • Fixed kit inventory syncing to report correct kit quantity to Magento
  • Fixed kit export sync to Magento
  • Mapped company name from Magento orders to FB
  • When importing orders from Magento to FB in a pending status we no longer create a payment for the order
  • Mapped address line 2 in Bill to and Ship to addresses
  • Improved the reset last sync functionality
2.1 - 3/9/2017 - Fishbowl 2017.1
  • Enhancement to store Magento Cart Store ID in SO Custom Field
  • Last Sync Date now sets to when scheduled task starts
  • New products created correctly in FB when pulling from Magento.
Note - product will try to map Magento SKU to FB Product Number. If no match then a new product will be created.
2.0 - 2/9/2017 - Fishbowl 2017.1
  • Ability to push product price and description changes from FB to Magento after initial product sync
  • Added more product field mapping options for SKU, Name, and Description fields
  • Customer email from Magento order now imports to the FB SO
  • Magento Store identity is now stored on the FB SO
  • Line item identity is now stored in SO Line Item custom field
  • If the FB carrier is set to UPS, USPS, FEDEX or DHL that will be sent to Magento, otherwise the value "custom" is sent along with the tracking number.
  • Configurable Products now import correctly to FB
  • Zero Dollar Orders now import to FB
  • Line item level discounts now apply correctly
  • Issue: Saving the sales person is required for import order, even when the task is not active.
  • Resolution: Required fields are only required on active tasks.