Difference between revisions of "WooCommerce"

From Fishbowl
Jump to: navigation, search
(Release Notes)
Line 25: Line 25:
 
Multiple WooCommerce carts can be configured by clicking the {{Button|New}}, which will add another '''WooCommerce''' tab.
 
Multiple WooCommerce carts can be configured by clicking the {{Button|New}}, which will add another '''WooCommerce''' tab.
  
== Mapping {{top}} ==
+
{{Clear}}
 
 
The table below shows how data transfers between WooCommerce and Fishbowl.
 
 
 
{| class="prettytable"
 
|-
 
!WooCommerce Product||{{Arrow|Both}}||Fishbowl Product
 
|-
 
|colspan="3" width = "10"|The product mapping can be customized by selecting any combination of the following fields on the [[#Product Import|Product Import]] or [[#Product Export|Product Export]] tab.
 
|-
 
|
 
<br>Name
 
<br>Description
 
<br>Short Description
 
<br>SKU
 
<br>Price
 
<br>Weight
 
<br>Length
 
<br>Width
 
<br>Height
 
|
 
|
 
Product
 
<br>Description
 
<br>Price
 
<br>Details
 
<br>UPC
 
<br>SKU
 
<br>UOM
 
<br>Weight
 
<br>Weight UOM
 
<br>Length
 
<br>Height
 
|-
 
!WooCommerce order with [[#Order|specified status]] ||{{Arrow|Right}}|| Fishbowl sales order
 
|-
 
|WooCommerce order number||{{Arrow|Right}}|| WooCommerce Order Number Custom Field, sales order number (optional)
 
|-
 
|Order date ||{{Arrow|Right}}|| Fulfillment date
 
|-
 
|Customer name & billing address ||{{Arrow|Right}}|| Bill To
 
|-
 
|Customer name & shipping address ||{{Arrow|Right}}|| Ship To
 
|-
 
|Customer ||{{Arrow|Right}}|| Creates a new customer or uses the generic customer specified in the [[#Customer|'''Customer''' section of the '''Order Import''' tab]].
 
|-
 
|Taxes ||{{Arrow|Right}}|| The tax options can be set under the [[#Taxes|'''Taxes''' section of the '''Order Import''' tab]].
 
|-
 
|Order gift message||{{Arrow|Right}}|| Order '''Note''' on the {{ModuleTab|Sales Order|Details}}.
 
|-
 
|Item gift message||{{Arrow|Right}}|| Order '''Note''' on the {{ModuleTab|Sales Order|Details}}.
 
|-
 
|Email||{{Arrow|Right}}||'''Email''' field of the {{ModuleTab|Sales Order|Details}}
 
|-
 
|Phone||{{Arrow|Right}}||'''Phone''' field of the {{ModuleTab|Sales Order|Details}}
 
|-
 
|Carrier||{{Arrow|Right}}||Carriers can be mapped on the '''Order Import''' tab. For more information, see [[#Carriers|Carriers]].
 
|-
 
|Payment method||{{Arrow|Right}}||Payment methods can on the '''Order Import''' tab. For more information, see [[#Payment methods|Payment methods]].
 
|-
 
|Customer provided notes||{{Arrow|Right}}||[[Sales_Order#Details_tab|Fishbowl order notes]]
 
|-
 
!WooCommerce order with '''Complete''' status ||{{Arrow|Left}}|| Fishbowl fulfilled sales order
 
|-
 
|colspan="3" width = "10"|After an order is fulfilled in Fishbowl, it will be marked as '''Complete''' in WooCommerce.
 
|-
 
!WooCommerce quantity ||{{Arrow|Left}}|| Fishbowl '''Available For Sale''' quantity
 
|-
 
|colspan="3" width = "10"|Only inventory that has changed since the last export will be updated.
 
|}
 
 
 
 
= TABS =  
 
= TABS =  
  
{{H2|Order Import}} [[File:WooCommerce Schedule Import Order Tab.png|right]]
+
{{Tab|Cart|Order Import}}
 
 
 
{{Schedule|import orders|Run task}}
 
{{Schedule|import orders|Run task}}
  
:{{HideH2|Order}} [[File:WooCommerce Schedule Import Order Orders.png|right]]
+
{{Subtab|WooCommerce|Order}}
:* '''Location Group''' - Sales orders will be created using this location group.
+
{{Cart Order|WooCommerce}}
:* '''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.
 
:* '''WooCommerce Order Status''' - This selection determines which status of WooCommerce orders will be imported into Fishbowl.
 
:* '''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.
 
:* '''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.
 
:* '''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 WooCommerce. Can only specify a flat rate discount. The flat rate discount can be set to $0 in the {{Module|Discount}} and then the correct discount amount will be set when the order is imported from WooCommerce.
 
:* '''Apply order discounts to line items''' -  When selected, incoming orders with discounts will apply discounts to the line items on the sales order.
 
  
:{{HideH2|Customer}} [[File:WooCommerce Schedule Import Order Customer.png|right]]
+
{{Subtab|Cart|Order Status Mapping}}
:* '''Use default customer''' - All orders will be put under the selected Fishbowl customer and use the customer's default address as the billing and shipping address on orders.
+
{{Cart Order Status Mapping|WooCommerce}}
:* '''Use Customer on order''' - All orders will use the customer name, billing address, and shipping address attached to the shopping cart order.
 
:* '''Use company name for new customers''' - When selected, the company name from the bill to address of the shopping cart order will be created as the customer name in Fishbowl.
 
  
:{{HideH2|Carrier Mapping}} [[File:WooCommerce Schedule Import Order Carrier Mapping.png|right]]
+
{{Subtab|Cart|Customer}}
:* '''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, WooCommerce carriers can be mapped to Fishbowl carriers.
+
{{Cart Customer|WooCommerce}}
  
:{{HideH2|Payment Mapping}} [[File:WooCommerce Schedule Import Order Payment Mapping.png|right]]
+
{{anchor|Carriers}}
:* '''Create payments in Fishbowl''' - When selected, payments from the WooCommerce transaction will be shown in the {{Module|Payment Viewer}}.
+
{{Subtab|Cart|Carrier Mapping}}
:* '''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, WooCommerce payment methods can be mapped to Fishbowl payment methods.
+
{{Cart Carrier Mapping|WooCommerce}}
  
:{{HideH2|Taxes}} [[File:WooCommerce Schedule Import Order Taxes.png|right]]
+
{{Subtab|Cart|Payment Mapping}}
:* '''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 {{Module|Tax Rate}} and then the correct total tax amount will be set when the order is imported from WooCommerce.
+
{{Cart Payment Mapping|WooCommerce}}
  
{{H2|Order Fulfillment}} [[File:WooCommerce Schedule Export Order Tab.png|right]]
+
{{Subtab|Cart|Taxes}}
 +
{{Cart Taxes|WooCommerce}}
  
{{Order export}}
+
{{Tab|WooCommerce|Order Fulfillment}}
{{Schedule|export orders|Run task}}
+
{{Cart Order Fulfillment|WooCommerce}}
* '''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.
+
* '''Check WooCommerce order status before fulfilling''' - When selected, the WooCommerce store order status will be checked prior to attempting to send fulfilment 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 sync.
* '''Send tracking''' - When selected, WooCommerce orders will be updated with the Fishbowl carrier name, carton tracking numbers, and ship date. This requires the latest [https://woocommerce.com/products/shipment-tracking WooCommerce Shipment Tracking plugin].
+
* '''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.
{{H2|Product Import}} [[File:WooCommerce Schedule Products Tab.png|right]]
 
  
{{Products before orders}}
+
{{Tab|Cart|Product Import}}
 +
{{Cart Product Import|WooCommerce}}
  
{{Schedule|import products|Run task}}
+
{{Tab|Cart|Product Export}}
* '''Field Mapping''' - Use the icon buttons on the right side of the table to edit the field [[#Mapping|mappings]].
+
{{Cart Product Export|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.
 
  
{{H2|Product Export}} [[File:WooCommerce product export tab.png|right]]
+
{{Tab|Cart|Inventory Update}}
 
+
{{Cart Inventory Update|WooCommerce}}
{{Schedule|export products|Run task}}
 
* '''Field Mapping''' - Use the icon buttons on the right side of the table to edit the field [[#Mapping|mappings]]. After a product has been pushed to WooCommerce, any changes made to the product in Fishbowl will update the following fields in WooCommerce: '''Title''', '''Description''', '''SKU''', '''Price''', '''Weight''', '''Tags''', '''Meta Title''', and '''Meta Description'''.
 
* '''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 push all Fishbowl products to WooCommerce, regardless of the last sync date. Selecting this option may cause the Product Export sync to take a long time to run, depending on how many products you have. The Product Tree Filter will still apply.
 
 
 
{{H2|Inventory Update}} [[File:WooCommerce Schedule Inventory Tab.png|right]]
 
 
 
{{Schedule|export inventory levels to WooCommerce|Run task}}
 
* '''Location Group''' - When selected, the [[Inventory#Inventory_status_terms|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.
 
  
 
{{Clear}}
 
{{Clear}}
 
 
= Troubleshooting =
 
= Troubleshooting =
 
{{Cart Troubleshooting}}
 
{{Cart Troubleshooting}}

Revision as of 19:05, 16 April 2018

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

Install

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

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

Setup Template:Top

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

Template:Tab

  • 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

Template:Subtab Template:Cart Order Status Mapping

Template:Subtab Template:Cart Customer

Template:Subtab Template:Cart Carrier Mapping

Template:Subtab Template:Cart Payment Mapping

Template:Subtab Template:Cart Taxes

Template:Tab Template:Cart Order Fulfillment

  • Check WooCommerce order status before fulfilling - When selected, the WooCommerce store order status will be checked prior to attempting to send fulfilment 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 sync.
  • 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.

Template:Tab Template:Cart Product Import

Template:Tab Template:Cart Product Export

Template:Tab Template:Cart Inventory Update

Troubleshooting

  • 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 viewed or modified by clicking the Small.Shopify.png Shopify button at the top of the Small.Sales Order.png Sales Order module and the Small.Product.png Product module.
  • To view the scheduled tasks for the Small.Shopify.png Shopify module, 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 scheduled 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 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.
  • 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

Version 3.12

  • Released on April 12, 2018
  • Compatible with Fishbowl version 2018.4 and higher

Features and Fixes

  • Addition of a new order status mapping table. You can now import multiple statuses at the same time.

Version 3.11

  • Released on Mar 8, 2018
  • Compatible with Fishbowl version 2018.3

Features and Fixes

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

Version 3.10

  • Released on Jan 31, 2018
  • Compatible with Fishbowl version 2018.1

Features and Fixes

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

Version 3.6

  • Released on Jan 12, 2018
  • Compatible with Fishbowl version 2017.13

Features and Fixes

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

Version 3.5

  • Released on Dec 8, 2017
  • Compatible with Fishbowl version 2017.11

Features and Fixes

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

Version 3.4

  • Released on Nov 21, 2017
  • Compatible with Fishbowl version 2017.11

Features and Fixes

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

Version 3.3

  • Released on Nov 16, 2017
  • Compatible with Fishbowl version 2017.11

Features and Fixes

  • 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

Version 3.2

  • Released on Oct 30, 2017
  • Compatible with Fishbowl version 2017.10

Features and Fixes

  • 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

Version 3.1

  • Released on Oct 17, 2017
  • Compatible with Fishbowl version 2017.10

Features and Fixes

  • Plugin now allows customers who's stores use "Https" to connect via the plugin

Version 3.0

  • Released on Oct 5, 2017
  • Compatible with Fishbowl version 2017.9

Features and Fixes

  • New layout and mapping options

Version 2.14

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

Features and Fixes

  • Fixed issue when the order import has multiple line items of the same product using the total price for the line item unit price

Version 2.13

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

Version 2.12

  • Released on June 12, 2017
  • Compatible with Fishbowl version 2017.4 and higher

Features and Fixes

  • Fixed tracking functionality when sending fulfillment to WooCommerce order(s).

Version 2.11

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

Version 2.9

  • Released on March 15, 2017
  • Works with Fishbowl version 2017.2 and higher

Features and Fixes

  • Compatibility fixes for 2017.2 version of Fishbowl

Version 2.8

  • Released on March 10, 2017
  • Works with Fishbowl version 2017.1 and higher

Features and Fixes

  • Fixed issue with inventory not updating for product variants

Version 2.6

  • Released on March 01, 2017
  • Works with Fishbowl version 2017.1 and higher

Features and Fixes

  • 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

Version 2.5

  • Released on February 09, 2017
  • Works with Fishbowl version 2016.14

Features and Fixes

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

Version 2.4

  • Released on October 13, 2016
  • Works with 2016 version of Fishbowl

Features and Fixes

  • Issue: OrderID can now be a string, not just an integer field.
  • Resolution: Our field once again matches the updated field from WooCommerce.