Magento Cart

From Fishbowl
Revision as of 22:02, 25 August 2017 by Ncarter (talk | contribs) (TABS)
Jump to: navigation, 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 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 1.7 through Magento 1.9 using the version 1.x XML-RPC API. For Magento 2.1 or higher, use the x16px Magento 2.x module.

Magento Cart.png


Video

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

Install

  1. In any Fishbowl Client, open the Small.Plugin.png Plugin module, located in the Integrations group.
  2. Select the Small.Magento Cart.png Magento Cart 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 Cart.png Magento Cart module from any Fishbowl Client by opening the Integrations module group.
  6. To grant access to additional users, assign the Magento Cart-View access right to the appropriate groups in the Small.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 Small.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 Small.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.

Mapping Template:Top

The table below shows how data transfers between Magento and Fishbowl.

Magento Product
Fishbowl Product
The product mapping can be customized by selecting any combination of the following fields on the Product Import or Product Export tab.

Name
Short Description
Description
SKU
Price
Weight
Meta Title
Meta Keyword
Meta Description

Product
Description
Price
Details
UPC
SKU
Weight

Magento order with specified status
Fishbowl sales order
Magento order number
Customer PO field, sales order number (optional)
Order date
Fulfillment date
Customer name & billing address
Bill To
Customer name & shipping address
Ship To
Customer
Creates a new customer or uses the generic customer specified in the Customer section of the Order Import tab.
Taxes
The tax options can be set under the Taxes section of the Order Import tab.
Order gift message
Order Note on the Details tab of the Small.Sales Order.png Sales Order module.
Item gift message
Order Note on the Details tab of the Small.Sales Order.png Sales Order module.
Email
Email field of the Details tab of the Small.Sales Order.png Sales Order module
Phone
Phone field of the Details tab of the Small.Sales Order.png Sales Order module
Carrier
Carriers can be mapped on the Order Import tab. For more information, see Carriers.
Payment method
Payment methods can on the Order Import tab. For more information, see Payment methods.
Magento order with Complete status
Fishbowl fulfilled sales order
After an order is fulfilled in Fishbowl, it will be marked as Complete in Magento.
Magento quantity
Fishbowl Available For Sale quantity
Only inventory that has changed since the last export will be updated.

Carriers

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.

Payment methods

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.

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 Small.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

TABS

Order Import

  • 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.
Order
  • Location Group - Sales orders will be created using this location group.
  • SO Status - Orders can be imported as an estimate, issued, or fulfilled status. Setting orders to fulfilled status will import orders and then quick fulfill them.
  • Shipping Item - When selected, sales orders will be created using this product as the default shipping item.
  • Magento Order Status - This selection determines which status of Magento orders will be imported into Fishbowl.
  • 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.
  • Add order discounts as a flat rate discount item - When selected, incoming orders with discounts will apply discounts on the sales order as a separate, flat rate discount item.
  • 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.
  • Apply order discounts to line items - When selected, incoming orders with discounts will apply discounts to the line items on the sales order.
Customer
  • Use default customer - When selected, sales orders will be created using this customer for every order.
    • If this option is not selected, unique customer information for each order will be imported from Magento.
    • Alternatively, create a generic/web customer in Fishbowl that will be used for all imported orders.
    • Address information will be imported for each order regardless of this option.
  • Salesperson - Sales orders will be created using this salesperson.
  • Payment Terms - When selected, sales orders will be created using this payment term.
  • Shipping Terms - When selected, sales orders will be created using these shipping terms.
  • Class - When selected, sales orders will be created using this class as the sales order class.
  • Customer Status - When selected, imported customers will be created with the selected status.
  • Use company name for new customers - When selected, the Company name from the bill to address of the Magento order will be created as the customer name in Fishbowl.
Carrier Mapping
  • 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 by following the instructions here.
Payment Mapping
  • 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 by following the instructions here.
Taxes
  • Calculate Order Tax - 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.
  • 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.


Order Fulfillment

  • 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. 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.
  • 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.


Product Import

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. 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.
  • Field Mapping - Use the icon buttons on the right side of the table to edit the field mappings.
  • 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.
  • Australia and Canada users can find instructions for product tax class mappings here.


Product Export

  • 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. 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.
  • Field Mapping - Use the icon buttons on the right side of the table to edit the field mappings. After a product has been pushed to Magento, any changes made to the product in Fishbowl will update the following fields in Magento: Name, Short Description, Description, SKU, Price, Weight, Meta Title, Meta Keyword, and Meta Description.
  • 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.
  • Australia and Canada users can find instructions for product tax class mappings here.


Inventory Update

  • 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. 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.
  • 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.

Troubleshooting

  • Enter an email address in the Small.Schedule.png Schedule module to receive error notifications.
  • To view the scheduled tasks for the cart, open the Small.Schedule.png Schedule module.
  • To reduce errors, the suggested order for running tasks is Products, ImportOrder, Inventory, ExportOrder.
  • A scheduled task can be run manually by double-clicking the task.
  • 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.
  • The Last Sync field can be used to reset the last sync date. This can be used to force a more complete sync, instead of just syncing items that have changed since the last sync.
  • 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.
  • 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.

Release Notes

Version 3.4

  • Released on Aug 14, 2017
  • Compatible with Fishbowl version 2017.6 and higher

Features and Fixes

  • Fixed weight and size UOM issue on product import being set incorrectly for products created in FB

Version 3.3

  • Released on July 28, 2017
  • Compatible with Fishbowl version 2017.6 and higher

Features and Fixes

  • Fixed payment mapping bug where orders were imported but no payment was created with the payment mapping set

Version 3.2

  • Released on July 13, 2017
  • Compatible with Fishbowl version 2017.6 and higher

Features and Fixes

  • 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

Version 3.1

  • Released June 20, 2017
  • Compatible with Fishbowl version 2017.5 and higher

Features and Fixes

  • Compatibility fix for 2017.5 version of Fishbowl

Version 3.0

  • Released May 22, 2017
  • Compatible with Fishbowl version 2017.4 and higher

Features and Fixes

  • User interface enhancements and fixes including new layout for the order import panel, fixed combo boxes, and allowing typing enter to work 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

Version 2.5

  • Released on April 26, 2017
  • Compatible with Fishbowl Version 2017.3 and higher

Features and Fixes

  • 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.

Version 2.4

  • Released on April 13, 2017
  • Compatible with Fishbowl version 2017.3 and higher

Features and Fixes

  • Compatibility fixes for 2017.3 version of Fishbowl
  • Fixed tax functionality for Australia and Canada versions of Fishbowl

Release Version 2.3

  • Release Date April 04, 2017
  • Works with FB version 2017.2 and higher

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.

Release Version 2.2

  • Release date March 16, 2017
  • Works with FB version 2017.1 and newer

Features and Fixes

  • 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

Release Version 2.1

  • Release date March 9, 2017
  • Works with FB version 2017.1 and newer

Features and Fixes

  • 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.

Release Version 2.0

  • Released on February 9,2017
  • Works with FB Version 2017.1 and older

Features and Fixes

  • 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

Released on 10/13/2016

  • 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.