Difference between revisions of "Square"

From Fishbowl
Jump to navigation Jump to search
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Module Introduction|Square|Integrations}} is an add-on module that can be installed from the {{Module|Plugin}}. After installing the plugin, a new module is added that integrates with one or more [https://www.Square.com/?ref=fishbowlinv Square] shopping carts.
+
{{Module Introduction|Square|Integrations}} is an add-on module that can be installed from the {{Module|Plugin}}. After installing the plugin, a new module is added that integrates with [https://squareup.com/us/en/point-of-sale Square Point of Sale].
 
 
{{IntroImage}}
 
  
 
{{Plugin Install|Square|Integrations}}
 
{{Plugin Install|Square|Integrations}}
  
 
==Setup==
 
==Setup==
{{Setup|{{PAGENAME}}}}
+
{{Plugin Setup|{{PAGENAME}}}}
  
# Click the {{Button|Settings}} on the module toolbar of the {{Module|Square}}.
+
# Click the {{Button|Settings}} on the module toolbar of the {{Module|Square}}.<br>[[File:{{PAGENAME}}_Store_Settings.png]]
# Create an account, or sign into an existing account.
+
# In the dialog window, click the blue link and sign in to your Square account to obtain the '''Auth code'''.
# Click the '''Save''' button at the bottom of the window to save the Square settings.
+
# Paste the '''Auth Code''' into the dialog and then click {{Button|Connect|Initialize Connection}}.
 +
# Click the '''Save''' button at the bottom of the dialog window.
  
 
=TABS=
 
=TABS=
Line 16: Line 15:
  
 
==Product Import==
 
==Product Import==
{{Product Import|{{PAGENAME}}}}
+
{{Product Import|{{PAGENAME}}|Square}}
 +
:{{Notes|{{PAGENAME}}}}
 +
:* '''Unlink Missing Products''' - This option will remove the product linking in Fishbowl for products that no longer exist.
  
 
==Product Export==
 
==Product Export==
 
{{Product Export|{{PAGENAME}}}}
 
{{Product Export|{{PAGENAME}}}}
:{{Notes|{{PAGENAME}}}}
 
:*{{Include Product Image|{{PAGENAME}}}}
 
  
 
==Inventory Update==
 
==Inventory Update==
Line 27: Line 26:
  
 
==POS Import==
 
==POS Import==
{{Order Import}}
+
{{Order Import|Square}}
  
 
===Order Settings===
 
===Order Settings===
Line 35: Line 34:
  
 
===Order Item Settings===
 
===Order Item Settings===
{{Order Item Settings|{{PAGENAME}}}}
+
{{ImageSubtab|Order Item Settings|{{PAGENAME}}}}
 +
:* '''Item field mapping''' - Use the mapping table to map {{PAGENAME}} order item fields to Fishbowl order item fields. If the Fishbowl price is not mapped, then the price from the Fishbowl product will be used and any applicable pricing rules applied. If the Fishbowl description is not mapped, then the description from the Fishbowl product will be used.
 +
:* '''Ignore miscellaneous items''' - If this option is selected, {{PAGENAME}} order items that are not related to an actual {{PAGENAME}} product record will be ignored and no Fishbowl line item will be created.
 +
:* '''Enable order import product linking''' - {{PAGENAME}} order items will be matched to Fishbowl products based on the defined field mapping. If the {{PAGENAME}} product has been linked by ID to a Fishbowl product, that will take precedence.
 +
::* '''Product field''' - The Fishbowl product field that will match the selected {{PAGENAME}} item field.
 +
::* '''{{PAGENAME}} item field''' - The {{PAGENAME}} order item field that will match the selected Fishbowl product field.
 +
 
 +
===Order Status Settings===
 +
{{Order Status Mapping|{{PAGENAME}}}}
  
 
===Location Group Settings===
 
===Location Group Settings===
{{Location Group Mapping|{{PAGENAME}}}}
+
{{ImageSubtab|Location Group Mapping|{{PAGENAME}}}}
 
+
:* '''Use order location mapping''' - Define a location group mapping using the mapping table.
===Order Status Mapping===
+
:* '''Use location group class as order class''' - This option will set the class for the order to the location group's class.
{{Order Status Mapping|{{PAGENAME}}}}
 
  
 
===Customer Settings===
 
===Customer Settings===
 
{{Customer|{{PAGENAME}}}}
 
{{Customer|{{PAGENAME}}}}
 +
 +
===Address Settings===
 +
{{Address|{{PAGENAME}}}}
  
 
===Carrier Settings===
 
===Carrier Settings===
 
{{Carrier Mapping|{{PAGENAME}}}}
 
{{Carrier Mapping|{{PAGENAME}}}}
:{{Notes|{{PAGENAME}}}}
 
::Follow the instructions below to map carriers between Square and Fishbowl.
 
::# Log into Square.
 
::# Click the '''Settings''' menu on the left and then select '''Shipping''' to see which carriers are enabled on your account.
 
::# Click [https://help.Square.com/api/reference/fulfillment#tracking-company-property here] to see which carriers Square supports.
 
::# Open the '''Carrier Mapping''' section on the '''Order Import''' tab and then click the {{Icon Button|New}}.
 
::# Enter the Square carrier and service information into Fishbowl. Sometimes it is easiest to find the exact carrier name in the error log for the order import task.<br>[[File:Square carrier mapping.png]]
 
::# Select the corresponding '''Fishbowl Carrier/Service'''
 
::# Select the [[Sales_Order#Details_tab|Sales Order Priority]] that corresponds with this carrier/service. This helps Fishbowl users to identify orders with express shipping that need to be picked and shipped quickly.
 
::# Click '''Add''' to save the mapping, or click '''Next''' to save the mapping and enter a new mapping.
 
  
 
===Payment Settings===
 
===Payment Settings===
 
{{Payment Mapping|{{PAGENAME}}}}
 
{{Payment Mapping|{{PAGENAME}}}}
:{{Notes|{{PAGENAME}}}}
 
::Follow the instructions below to map payment methods between Square and Fishbowl.
 
::# Log into Square.
 
::# Click the '''Settings''' menu on the left and then select '''Payment providers''' to see which providers are enabled on your account.
 
::# Copy the exact payment method name from any of the sections listed under '''Payment providers'''. Below are some examples.
 
::#* PayPal Express Checkout
 
::#* Square Payments
 
::#* Amazon Pay
 
::#* Authorize.net
 
::#* Bitpay
 
::#* Cash on Delivery (COD)
 
::#* Bank Deposit
 
::#* Money Order
 
::# Open the '''Payment Mapping''' section on the '''Order Import''' tab and then click the {{Icon Button|New}}.<br>[[File:Square payment mapping done.png]]
 
::# Paste the Square payment method name into Fishbowl.<br>[[File:Square payment mapping.png]]
 
::# Select the corresponding '''Fishbowl Payment Method''' and then click the '''Save''' button.
 
  
 
===Tax Settings===
 
===Tax Settings===

Latest revision as of 16:45, 31 August 2021

Icon.Square.png The Square module, located in the Integrations group, is an add-on module that can be installed from the Icon.Plugin.png Plugin module. After installing the plugin, a new module is added that integrates with Square Point of Sale.

Install

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

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

Setup

Complete the steps below to configure the Square integration.

  1. Click the Settings Button.png Settings button on the module toolbar of the Icon.Square.png Square module.
    Square Store Settings.png
  2. In the dialog window, click the blue link and sign in to your Square account to obtain the Auth code.
  3. Paste the Auth Code into the dialog and then click Connect Button.png Initialize Connection button.
  4. Click the Save button at the bottom of the dialog window.

TABS

Several plugins in Fishbowl have a standardized layout. Some of the images below show the options that are most common between all plugins. Any additional Small.Square.png Square options or notes are included at the bottom of each section. System properties also allow advanced options to be enabled for e-commerce plugins.

Product Import

Square Product Import.png
  • 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.
NOTE: When setting up the shopping cart integration for the first time you will want to adjust the Last Sync to a date before any of your products were created (for example, setting the year to 2000) so that all of the products on your website will be imported.

The Product Import task imports products into Fishbowl from Square. A product link is created by storing the Square product ID in Fishbowl.

  • Link Existing Products will match existing products in Fishbowl and Square where data matches in the selected fields.
  • Import Products will import products from Square into Fishbowl, creating them based on the field mapping and settings below.
Small.Square.png Additional Square information
  • Unlink Missing Products - This option will remove the product linking in Fishbowl for products that no longer exist.

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. 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.
  • Product Create Settings - Enable Export new products and then map the fields that should be exported from Fishbowl to Square. A default weight UOM and size UOM can also be specified. Using the Product Tree Filter will limit the products exported to those in the selected product tree category. If left blank, all products will be included in the export. Selecting the Export all products option will ignore the last sync date and attempt to push all of the Fishbowl products to Square. The product tree filter will still apply.
  • Product Update Settings - Enable Update linked products and then map the fields that should be exported from Fishbowl to Square. This section has the same options as the Product Create Settings section above. 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 Square 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.
NOTE: When setting up the shopping cart integration for the first time you will want to adjust the Last Sync to a date before any of your products were created (for example, setting the year to 2000) so that it includes all of your products (or any applicable product tree filter) when updating inventory levels.
  • Export company wide inventory - Include inventory quantities from all location groups in the inventory sync. If this option is unchecked, selected location groups can be added by clicking the Add Icon Button.png Add button.
  • Inventory Type - Select the inventory quantity that should be used during the update: Available, Inventory On Hand, or Available To Pick.
  • Product Tree filter - The export can be limited to a specific product tree category. If this field is left blank, all products will be included in the export.
  • Specify Min/Max Inventory Quantity - With this option enabled, the maximum inventory quantity sent to Square can be limited. For example, if there is an available quantity of 4000 in Fishbowl, the quantity in Square could be set to 999. If there is an available quantity of 3 in Fishbowl, the minimum quantity field could be used to send a quantity of 10 to Square.
  • Include Quantities Available To Build - When enabled, this option calculates and includes available to build quantities from applicable bills of material in the inventory push. When a product is sold individually but also used as an input for a bill of material, both quantities are pushed to the channel when applicable. Please note, this could lead to overselling in the scenario described..

POS Import

Square 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. 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 Settings

Cart Order.png

Additional order data will be imported and displayed on the Details tab of the Icon.Sales Order.png Sales Order module.

  • Order field mapping - Use the mapping table to map Square order fields to Fishbowl order fields. If no field is mapped to the Fishbowl Order Number, then it will be generated by Fishbowl. If no date field is mapped to the Fishbowl Date Scheduled, then it will be set to the date of import.
  • Use Customer Defaults - The following order defaults will be used when no data is mapped from Square in the mapping table above. "Use Customer Defaults" will use values from the Fishbowl customer when available.
  • Default Salesperson - Sales orders will be created using this salesperson.
  • Default Class - If there is no class mapped from Square, sales orders will be created using this class as the sales order class.
  • Default Payment Terms - If there are no payment terms mapped from Square, sales orders will be created using this payment term.
  • Default Shipping Terms - If there are no shipping terms mapped from Square, sales orders will be created using these shipping terms.
  • Default Priority - The default priority to be set on imported orders.
  • Discount item - Select the flat rate discount type that will be added as a line item to imported orders. The flat rate discount can be set to $0 in the Icon.Discount.png Discount module and then the correct discount amount will be set when the order is imported from Square.
  • Order number prefix - An order number prefix can be defined which will be applied to order numbers mapped from Square.
Small.Square.png Additional Square information
  • Combine all discounts - Enabling this option will sum up all of the line item discounts and apply them as one order discount.
  • Add Discount Code to Notes - Enabling this option will add the discount code to the line item notes.

Order Item Settings

Square Order Item Settings.png
  • Item field mapping - Use the mapping table to map Square order item fields to Fishbowl order item fields. If the Fishbowl price is not mapped, then the price from the Fishbowl product will be used and any applicable pricing rules applied. If the Fishbowl description is not mapped, then the description from the Fishbowl product will be used.
  • Ignore miscellaneous items - If this option is selected, Square order items that are not related to an actual Square product record will be ignored and no Fishbowl line item will be created.
  • Enable order import product linking - Square order items will be matched to Fishbowl products based on the defined field mapping. If the Square product has been linked by ID to a Fishbowl product, that will take precedence.
  • Product field - The Fishbowl product field that will match the selected Square item field.
  • Square item field - The Square order item field that will match the selected Fishbowl product field.

Order Status Settings

Cart Order Status Mapping.png
Use the table to assign Square order statuses to Fishbowl order statuses. The Order Import task will only import orders from Square 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.

Location Group Settings

Square Location Group Mapping.png
  • Use order location mapping - Define a location group mapping using the mapping table.
  • Use location group class as order class - This option will set the class for the order to the location group's class.

Customer Settings

Cart Customer.png
Use the options below to determine how customers are created in Fishbowl and what information is imported into Fishbowl.
  • Enable multi-currency settings - Order prices will be converted from the channel order currency to the Fishbowl currency assigned to the mapped customer. Requires Fishbowl currency conversion to be enabled.
  • Enable advanced mapping settings - Opens up additional customer mapping options and control over customer creation.
  • Use a default customer for all orders - This option will associate all imported sales orders with the customer selected in the Customer field. This could be used with a generic Fishbowl customer such as Square Customer.
  • Use order billing address - Use the billing address from the Square order instead of the address for the default customer.
  • Use order shipping address - Use the shipping address from the Square order instead of the address for the default customer.
  • Use the order customer and addresses - This option will import the addresses and customer from the Square order instead of using a generic customer.
  • Field - Select the Square field that contains the customer name that should be imported into Fishbowl.
  • Alternate Field - An alternate field mapping when the primary mapping does not contain data.

Address Settings

Cart Address Settings.png
  • Ship to address mapping - Use the table to choose which Square fields are imported into the Fishbowl Ship To Name and Street Line fields.
  • Bill to address mapping - Use the table to choose which Square fields are imported into the Fishbowl Bill To Name and Street Line fields.
  • Coalesce addresses - If one address is missing, use the existing address for both the shipping and billing address.
  • Create missing states - Automatically create missing states.
  • Mark addresses residential - Import all shipping addresses as residential.

Carrier Settings

Cart Carrier Mapping.png
  • Use default carrier/service - When selected, all orders imported from Square will use the selected carrier and carrier service. If this option is unchecked, carriers can be mapped between Fishbowl and Square. Each mapping will also set the Sales Order Priority so that Fishbowl users can identify orders with express shipping that need to be picked and shipped quickly.
  • Use carrier mapping - When selected, the table can be used to map carriers between Square and Fishbowl.

Payment Settings

Cart Payment Mapping.png
  • Create payments in Fishbowl - When selected, payments from the Square transaction will be shown in the Icon.Payment Viewer.png Payment Viewer module.
  • Use a default payment method - When selected, all orders imported from Square will use the selected payment method.
  • Use Payment method mapping - When selected, the table can be used to map payment methods between Square and Fishbowl.
  • Always create payments - If no payment data exists for the order from Square, this option will always create a payment in Fishbowl equaling the order total. If payment mapping is enabled, orders without payment data will show "None" as the payment method type.
  • Remove taxes from payment - When selected, the tax amount will be deducted from the payment total.
  • Remove shipping from payment - Enabling this option may lead to order disparities between Square and Fishbowl for totals and payments.
  • Ignore international payments - Payments will not be created for orders placed outside the United States. This setting is only available if Use Currency Conversion is enabled in the Icon.Currency.png Currency module.
  • Currency - Select the currency type you accept in Square. This is a required setting if Use Currency Conversion is enabled in the Icon.Currency.png Currency module.

Tax Settings

Cart Taxes.png
  • Import Taxes - When selected, the tax amount from the Square 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 Icon.Tax Rate.png Tax Rate module and then the correct total tax amount will be set when the order is imported from Square. If taxes are not imported, the Fishbowl payment will equal the order total before tax.
  • Use Default Tax Item - With this option selected, the same tax item will be used for all orders.
  • Use State Tax Mapping - This option allows different tax items to be used based on the Ship To state/province. If this option is enabled, the plugin will give an error when trying to import an order with a state that has not been mapped.
  • Use Fishbowl Tax - Select a Fishbowl tax rate that will be used to calculate the order tax in Fishbowl. Tax calculations done by Fishbowl may differ from those done in Square.
    • Import Square tax as line item note - Import the Square tax as a line item note in Fishbowl.

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 be viewed or modified by clicking the Small.Square.png Square button at the top of the Icon.Sales Order.png Sales Order module and the Icon.Product.png Product module.
  • To view the scheduled tasks for the Icon.Square.png Square module, open the Icon.Schedule.png Schedule module.
  • A scheduled task can be run manually by double-clicking the task.
  • Enter an email address in the Icon.Schedule.png Schedule module to receive error notifications.
  • To view the history of a scheduled task, including the result/error, click the History Icon Button.png History button in the Icon.Schedule.png Schedule module.
  • More details about recent errors can be viewed by opening the Icon.Data.png Data module and clicking the Server Log Button.png Server Log button.
  • Check for multiple versions of the Square.jar file in C:\Program Files\Fishbowl\plugins\ or \Applications\Fishbowl\plugins\ on a Mac. If there are two Square versions, exit the Fishbowl Server and remove the older version on all client and server computers.

Release Notes