WooCommerce

From Fishbowl
Jump to: navigation, search

Icon.WooCommerce.png The WooCommerce 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 WooCommerce shopping carts.

The plugin currently supports WooCommerce REST API V2

WooCommerce.png

The documentation on this page is for the most recent version of the WooCommerce 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 WooCommerce 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.WooCommerce.png WooCommerce 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 WooCommerce-View right to the appropriate groups as explained here.

Setup

In order to connect to WooCommerce, the WooCommerce API must first be configured properly. Follow the instructions below to generate an API Key.

  1. Log into the Wordpress Dashboard, for example www.mycompany.com
  2. Open the settings for Wordpress permalinks by clicking Settings and then selecting Permalinks.
    Permalink 1.png
  3. Below Common Settings, select Post name.
    Permalink 2.png
  4. Scroll down to Product permalink base and verify that Default is selected and then click Save Changes.
    Permalink 3.png
  5. Open the settings for WooCommerce by clicking WooCommerce and then selecting Settings.
    WooCommerce1.png
  6. Click the API tab, select Enable the REST API, and then click Save Changes.
    WooCommerce2.png
  7. Click Keys/Apps and then click the Add Key button.
    WooCommerce3.png
  8. Enter a Description, User, select Read/Write, and then click Generate API Key.
    WooCommerce4.png
  9. Enter the WooCommerce store URL into the Small.WooCommerce.png WooCommerce module, for example woocommerce.mycompany.com
  10. Click the Copy buttons and then paste the Consumer Key and Consumer Secret into the Small.WooCommerce.png WooCommerce module.
  11. Click the Test Connection button in the Small.WooCommerce.png WooCommerce module to verify that the connection is valid and then click Save.

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

TABS

Shopping cart plugins in Fishbowl have a standardized layout. The images below apply to all shopping carts. When Small.WooCommerce.png WooCommerce 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 WooCommerce. 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 WooCommerce.
  • Use WooCommerce order number as Fishbowl SO number - When selected, sales orders will be created using the WooCommerce order number as the Fishbowl sales order number. The WooCommerce order number will always be stored on the Custom Field tab of the Small.Sales Order.png Sales Order module.
  • Assign WooCommerce order number to Customer PO field - When selected, the WooCommerce order number will be displayed in the Sales Order Customer PO field.
Small.WooCommerce.png Additional WooCommerce 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.
Order Status Mapping
Cart Order Status Mapping.png
Use the table to assign WooCommerce order statuses to Fishbowl order statuses. The Order Import task will only import orders from WooCommerce 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 WooCommerce customer.
  • Use order Bill To address - Use the Bill To address from the WooCommerce order instead of the Fishbowl address for the default/generic customer.
  • Use order Ship To address - Use the Ship To address from the WooCommerce order instead of the Fishbowl address for the default/generic customer.
  • Use order customer - This option will import the WooCommerce customer instead of using a generic customer.
  • Customer Name - Select the WooCommerce field that contains that customer name that should be imported to Fishbowl.
  • Customer Contact - Select the WooCommerce field that contains that customer contact that should be imported to Fishbowl.
  • Phone Number - Select the WooCommerce field that contains that phone number that should be imported to Fishbowl.
  • Email Address - Select the WooCommerce 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 WooCommerce will use the selected carrier and carrier service. If this option is unchecked, carriers can be mapped between Fishbowl and WooCommerce.
Payment Mapping
Cart Payment Mapping.png
  • Create payments in Fishbowl - When selected, payments from the WooCommerce 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 WooCommerce will use the selected payment method. If this option is unchecked, payment methods can be mapped between Fishbowl and WooCommerce.
Taxes
Cart Taxes.png
  • Flat Rate Tax Item - When selected, the tax amount from the WooCommerce 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 WooCommerce.

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 WooCommerce order status - When selected, WooCommerce 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 WooCommerce order.

Small.WooCommerce.png Additional WooCommerce options

  • Check WooCommerce order status before fulfilling - When selected, the WooCommerce order status will be checked prior to attempting to send fulfillment information. If the WooCommerce order status has changed, no fulfillment information will be sent. This will increase the time required to complete the order fulfillment task.
  • Send tracking - When selected, WooCommerce orders will be updated with the Fishbowl carrier name, carton tracking numbers, and ship date. This requires the WooCommerce Shipment Tracking plugin.

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 WooCommerce.
  • Weight UOM - If the weight UOM isn't set in WooCommerce, the default UOM listed here will be used.
  • Size UOM - If the size UOM isn't set in WooCommerce, 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 WooCommerce, any changes made to the product in Fishbowl will update the product in WooCommerce.
  • Weight UOM - If the weight UOM isn't set in WooCommerce, the default UOM listed here will be used.
  • Size UOM - If the size UOM isn't set in WooCommerce, 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 WooCommerce. 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 WooCommerce 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.

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.
  • If you are getting a Failed to run scheduled task error, it is likely due to upgrading from WooCommerce 2.x to 3.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.
    First, open the Plugin module and click the Uninstall button for the WooCommerce plugin. Then restart the Fishbowl server. Next, open the Plugin module, click the Install button for the WooCommerce plugin, and then restart the Fishbowl server again. Finally, re-enter the store login information and the import/export settings and then click the Save button.

Release Notes

The plugin currently supports WooCommerce REST API V2

3.20 - 7/12/2018 - Fishbowl 2018.7
  • Bug Fixes
  • Updated for compatibility with Fishbowl version 2018.7
3.14 – 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.
3.13.2 – 5/15/2018 - Fishbowl 2018.5
  • Fixed a bug that was causing settings to not save.
3.13 – 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.
3.12 - 4/12/2018 - Fishbowl 2018.4
  • Addition of a new order status mapping table. You can now import multiple statuses at the same time.
3.11 - 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.
3.10 - 1/31/2018 - Fishbowl 2018.1
  • Changed the way we were formatting the price.
  • 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.
3.6 - 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.
  • Fixed a bug where the comma in the price value was being replaced by a period when exporting products that have a price over $1,000.
3.5 - 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 tracking information from being sent to WooCommerce. You must have the most up-to-date "WooCommerce Shipment Tracking" plugin in WooCommerce for tracking information to be sent from Fishbowl to WooCommerce. If checked, and you don't have the Woo plugin, the scheduled task will error out.
3.4 - 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.
3.3 - 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
  • 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
3.2 - 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
  • Fixed some bugs with the Order Import
3.1 - 10/17/2017 - Fishbowl 2017.10
  • Plugin now allows customers who's stores use "Https" to connect via the plugin
3.0 - 10/5/2017 - Fishbowl 2017.9
  • New layout and mapping options
2.14 - 7/26/2017 - Fishbowl 2017.6
  • Fixed issue when the order import has multiple line items of the same product using the total price for the line item unit price
2.13 - 7/13/2017 - Fishbowl 2017.6
  • Fixed issue in AU version where shipping and discount items do not use the correct tax codes and are calculated incorrectly
  • Fixed inventory quantity update not looking at allocated items in FB
  • Fixed product sync to work with kits
  • Enhanced inventory sync to sync inventory kit quantity correctly
2.12 - 6/12/2017 - Fishbowl 2017.4
  • Fixed tracking functionality when sending fulfillment to WooCommerce order(s).
2.11 - 3/13/2017 - Fishbowl 2017.3
  • Compatibility fixes for 2017.3 version of Fishbowl
  • Fixed bug on order import task where the task wasn't using the last sync date correctly
  • Fixed tax functionality for Australia and Canada versions of Fishbowl
2.9 - 3/15/2017 - Fishbowl 2017.2
  • Compatibility fixes for 2017.2 version of Fishbowl
2.8 - 3/10/2017 - Fishbowl 2017.1
  • Fixed issue with inventory not updating for product variants
2.6 - 3/1/2017 - Fishbowl 2017.1
  • Updated plugin to work with the latest version of WooCommerce (2.6.14) and Wordpress (4.7.2) with the latest API version
  • Fixed Kit Inventory handling
  • Added Product Dimension to product fields synced between FB and Woo
  • Added Product weight to product fields synced between FB and Woo
  • Added more product field mapping options
  • Added shipment tracking feature. Please note this feature requires the WooCommerce Tracking Plugin be enabled in WooCommerce
  • Bugfix to bring back the product ID correctly to FB on product sync
  • Fixed last sync date and added option to set specific date when resetting last sync date
2.5 - 2/9/2017 - Fishbowl 2016.14
  • Issue: Orders are using the customer address information instead of the order address which causes a null error when importing orders.
  • Resolution: Order address is now being used so the order import can successfully run.
  • Issue: When a user has the "company" field populated but nor first or last name a blank customer record is created.
  • Resolution: Customer record no longer includes blank data.
  • Issue: Using the Avalara Avatax plugin with WooCommerce cannot pull in orders because of an error that occurs when attempting to sync.
  • Resolution: Orders with Avatax now correctly sync.
2.4 - 10/13/2016 - Fishbowl 2016
  • Issue: OrderID can now be a string, not just an integer field.
  • Resolution: Our field once again matches the updated field from WooCommerce.