Magento

From Fishbowl
Jump to: navigation, search

Icon.Magento.png The Magento module, located in the Integrations group, is an add-on module that can be installed from the Small.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 2.1 or higher. For older versions of Magento, use the Small.Magento Cart.png Magento Cart module.

Magento.png

The documentation on this page is for the most recent version of the Magento plugin. To update, see Update Fishbowl.

Install

  1. In any Fishbowl Client, open the Small.Plugin.png Plugin module, located in the Integrations group.
  2. Select the Magento plugin and click Install Now.
  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 Small.Magento.png Magento module from any Fishbowl Client by opening the Integrations module group.
  6. To grant access to additional users, open the Small.User Group.png User Group module and assign the Magento-View right to the appropriate groups as explained here.

Setup

  1. In the Small.Magento.png Magento module, enter the Store URL, for example https://magento2.mycompany.com
  2. Enter the username and password for an admin user.
  3. Click the Connect button in the Small.Magento.png Magento module to verify that the connection is valid and then click Save.

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

TABS

Shopping cart plugins in Fishbowl have a standardized layout. The images below apply to all shopping carts. When Small.Magento.png Magento has additional options, those options will be noted at the bottom of each section.

Order Import

Cart Order Import.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.


Order
Cart Order.png
  • Additional order data will be imported and displayed on the Details tab of the Small.Sales Order.png Sales Order module
  • Salesperson - Sales orders will be created using this salesperson.
  • Location Group - Sales orders will be created using this location group.
  • Class - When selected, sales orders will be created using this class as the sales order class.
  • Payment Terms - When selected, sales orders will be created using this payment term.
  • Shipping Item - When selected, sales orders will be created using this product as the default shipping item.
  • Shipping Terms - When selected, sales orders will be created using these shipping terms.
  • Discount Item - Discount item for the order discount amount from Magento. Can only specify a flat rate discount. The flat rate discount can be set to $0 in the Small.Discount.png Discount module and then the correct discount amount will be set when the order is imported from Magento.
  • Use Magento order number as Fishbowl SO number - When selected, sales orders will be created using the Magento order number as the Fishbowl sales order number. The Magento order number will always be stored on the Custom Field tab of the Small.Sales Order.png Sales Order module.
  • Assign Magento order number to Customer PO field - When selected, the Magento order number will be displayed in the Sales Order Customer PO field.
Small.Magento.png Additional Magento options
  • Combine line item discounts into flat rate order discount - When selected, line item discounts will be combined with order discounts for a single flat rate discount.
  • Remove '#' prefix from Magento Cart order numbers - When selected, Magento Cart order numbers will not have a '#' prefix when imported into Fishbowl.
Order Status Mapping
Cart Order Status Mapping.png
Use the table to assign Magento order statuses to Fishbowl order statuses. The Order Import task will only import orders from Magento that are in a status assigned to a Fishbowl order status. At least one active status mapping is required to use the Order Import task.
Customer
Cart Customer.png
Use the options below to determine how customers are created in Fishbowl and what information is imported into Fishbowl.
  • Use default customer - This option will associate all imported sales orders with the customer selected in the Customer Name field. This could be used with a generic Fishbowl customer such as Magento customer.
  • Use order Bill To address - Use the Bill To address from the Magento order instead of the Fishbowl address for the default/generic customer.
  • Use order Ship To address - Use the Ship To address from the Magento order instead of the Fishbowl address for the default/generic customer.
  • Use order customer - This option will import the Magento customer instead of using a generic customer.
  • Customer Name - Select the Magento field that contains that customer name that should be imported to Fishbowl.
  • Customer Contact - Select the Magento field that contains that customer contact that should be imported to Fishbowl.
  • Phone Number - Select the Magento field that contains that phone number that should be imported to Fishbowl.
  • Email Address - Select the Magento field that contains that email address that should be imported to Fishbowl.

Carrier Mapping
Cart Carrier Mapping.png
  • Use same carrier and carrier service for all orders - When selected, all orders imported from Magento will use the selected carrier and carrier service. If this option is unchecked, carriers can be mapped between Fishbowl and Magento.
Small.Magento.png Additional Magento options
Click here to see which carriers Magento supports.
Follow the instructions below to map carriers between Magento and Fishbowl.
  1. Log into Magento.
  2. Click the Stores menu on the left 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 2 flat rate.png

    Magento 2 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.
    Magento 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.
Payment Mapping
Cart Payment Mapping.png
  • Create payments in Fishbowl - When selected, payments from the Magento transaction will be shown in the Small.Payment Viewer.png Payment Viewer module.
  • Use same payment method for all orders - When selected, all orders imported from Magento will use the selected payment method. If this option is unchecked, payment methods can be mapped between Fishbowl and Magento.
Small.Magento.png Additional Magento options
Follow the instructions below to map payment methods between Magento and Fishbowl.
  1. Log into Magento using Google Chrome.
  2. Click the Stores 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 2 payment method inspect.png
  5. In the section highlighted by Chrome, copy the text between "payment_us_ 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.
    Magento payment mapping.png
    • checkmo
    • cashondelivery
    • authorizenet
    • banktransfer
  8. Select the corresponding Fishbowl Payment Method and then click the Save button.
Taxes
Cart Taxes.png
  • Flat Rate Tax Item - When selected, the tax amount from the Magento order will appear on the Fishbowl sales order as a flat rate line item. The flat rate amount can be set to $0 in the Small.Tax Rate.png Tax Rate module and then the correct total tax amount will be set when the order is imported from Magento.
Small.Magento.png Additional Magento options
Australia/Canada
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. Magento 2 does not have its own module to manage tax classes, which makes it a little more difficult to find the ID.
  1. Open the Magento Admin Dashboard in Google Chrome.
  2. Click the Products menu on the left.
  3. Click Catalog and then click a product name.
  4. Right-click the Tax Class name and select Inspect. Then click the highlighted drop-down arrow to the left of the first highlighted line.
    Inspect Tax Class.png
  5. Some additional lines will appear at the bottom. Copy the value after the tax class name.
    Tax Class Id.png
  6. Click the Product Import tab of the Small.Magento.png Magento 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.
    Product Tax Class Mapping 3.png

Order Fulfillment

Cart Order Fulfillment.png
  • Schedule - Select the Checked.png Active checkbox to export orders on a set schedule. Click the Run task Button.png Run task button to run the scheduled task right now.
  • Update Magento order status - When selected, Magento orders will be updated after the product(s) on the order have been shipped in Fishbowl. If left blank, Fishbowl will not update the status of the Magento order.

Small.Magento.png Additional Magento options

  • Check Magento order status before fulfilling - When selected, the Magento order status will be checked prior to attempting to send fulfillment information. If the Magento order status has changed, no fulfillment information will be sent. This will increase the time required to complete the order fulfillment task.
  • 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.

Product Import

Cart Product Import.png

When pulling products to Fishbowl, the product sync should usually be scheduled to run before the order import. This will avoid any errors caused by new products that need to be imported before the order can be created in Fishbowl.

  • Schedule - Select the Checked.png Active checkbox to import products on a set schedule. Click the Run task Button.png Run task button to run the scheduled task right now.
  • Field Mapping - Click the appropriate checkbox for linking products, and then selecting the product fields that match between Fishbowl and Magento.
  • Weight UOM - If the weight UOM isn't set in Magento, the default UOM listed here will be used.
  • Size UOM - If the size UOM isn't set in Magento, the default UOM listed here will be used.


Product Export

Cart Product Export.png
  • Schedule - Select the Checked.png Active checkbox to export products on a set schedule. Click the Run task Button.png Run task button to run the scheduled task right now.
  • Field Mapping - Use the icon buttons on the right side of the table to edit the field mappings. Click the Add Icon Button.png Add button to see all available fields. After a product has been pushed to Magento, any changes made to the product in Fishbowl will update the product in Magento.
  • Weight UOM - If the weight UOM isn't set in Magento, the default UOM listed here will be used.
  • Size UOM - If the size UOM isn't set in Magento, the default UOM listed here will be used.
  • Product Tree Filter - The export can be limited to certain product tree categories. If this field is left blank, all products will be included in the export.
  • Export All Products - Selecting this option will ignore the last sync date and attempt to push all of the Fishbowl products to Magento. The product tree filter in this panel will still apply.
  • Update Settings - This section has similar options to the Create Settings. After the initial product export, only the selected fields will be updated.


Inventory Update

Cart Inventory Update.png
  • Schedule - Select the Checked.png Active checkbox to export inventory levels to Magento on a set schedule. Click the Run task Button.png Run task button to run the scheduled task right now.
  • Location Group - When selected, the Available For Sale inventory quantity will be used from this location group only. If left blank, the quantity from all location groups will be used.
  • Product Tree Filter - The export can be limited to certain product tree categories. If this field is left blank, all products will be included in the export.

Small.Magento.png Additional Magento options

  • SKU Mapping - Select if the Magento SKU matches the Fishbowl SKU or the Fishbowl Product. Inventory updating requires specifying the mapping between Magento SKU and the corresponding product field in Fishbowl.

Troubleshooting

  • To view the scheduled tasks for the cart, open the Small.Schedule.png Schedule module.
  • A scheduled task can be run manually by double-clicking the task.
  • Enter an email address in the Small.Schedule.png Schedule module to receive error notifications.
  • To view the history of a schedule task, including the result/error, click the History Icon Button.png History button in the Small.Schedule.png Schedule module.
  • More details about recent errors can be viewed by opening the Small.Data.png Data module and clicking the Server Log Button.png Server Log button.
  • Check for multiple versions of the plugin .jar file in C:\Program Files\Fishbowl\plugins\ or \Applications\Fishbowl\plugins\ on a Mac. If there are two versions of the same plugin, exit the Fishbowl Server and remove the older version on all client and server computers.
  • Inventory sync uses the Magento 2 SKU instead of product id
  • When syncing inventory the Magento 2 Product Name will update if changed in FB
  • Product updates pushed from FB to Magento 2 update in the Magento database but don't necessarily display in the user interface correctly
  • If updating products in FB, when you udpate the SKU and other fields in FB, only the SKU field with be updated in Magento 2
  • If you are getting a Failed to run scheduled task error, it is likely due to upgrading from Magento 3.x to 4.x because of the layout change within the plugin. The following fix re-installs the plugin, which will require you to re-enter your store login information and import/export settings. Make sure to write that information down before proceeding with the following steps.
  1. Open the Small.Plugin.png Plugin module and click the Uninstall button.
  2. Restart the Fishbowl server.
  3. Open the Small.Plugin.png Plugin module, click the Install button, and then restart the Fishbowl server again.
  4. Enter the store login information and the import/export settings and then click the Save button.

Release Notes

2.20 - 7/12/2018 - Fishbowl 2018.7
  • Bug Fixes
  • Updated for compatibility with Fishbowl version 2018.7
2.19 – 6/14/2018 - Fishbowl 2018.6
  • Product import tab redesign. Now includes an order sync for situations where all products exist in both Fishbowl and the webstore.
  • Product export tab redesign. Export and update have been separated. It’s now possible to update item fields in the webstore without doing a full product export.
  • Settings have been relocated. They are now in a new tab.
  • Added the ability to map a carrier service to an order priority in Fishbowl.
2.18.2 – 5/15/2018 - Fishbowl 2018.5
  • Fixed a bug that was causing settings to not save.
2.18 – 5/11/2018 - Fishbowl 2018.5
  • Redesigned Customer section in Order Import tab. **Reconfiguration of the customer settings will be required when you update to this version or beyond.
2.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.
2.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.
2.15 - 1/31/2018 - Fishbowl 2018.1
  • No longer updating product catalog visibility during product export.
  • Added the ability to check if orders have been completed or cancelled before attempting to fulfill.
  • Payment is not imported to Fishbowl for $0 orders.
  • Payment terms are now pulled from the UI drop down instead of customer.
2.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.
2.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.
  • Updated our API call for Order Fulfillment to match the changes in Magento's documentation.
2.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.
2.9 - 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
2.8 - 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
2.7 - 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.
2.6 - 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.
2.5 - 9/7/2017 - Fishbowl 2017.7
  • Fixed issue with customers getting a "number format exception" error.
2.4 - 9/6/2017 - Fishbowl 2017.7
  • Fixed issue with order import where discounts weren't being applied correctly in Fishbowl.
2.3 - 8/31/2017 - Fishbowl 2017.7
  • Interim Release
1.2 - 8/9/2017 - Fishbowl 2017.6
  • Fixed authentication issue for customers using SSL
1.1 - 7/26/2017 - Fishbowl 2017.6
  • Fixed bug when validating carts purchased
  • Updated label in connection settings from "API Key" to "Password" to add clarity
1.0 - 7/13/2017 - Fishbowl 2017.6
  • Compatible with Magento version 2.1.6