Difference between revisions of "Advanced ShipStation"

From Fishbowl
Jump to: navigation, search
m (Text replacement - "===Order===" to "===Order Settings===")
m (Text replacement - "===Location Group===" to "===Location Group Settings===")
Line 36: Line 36:
 
{{Discounts|{{PAGENAME}}}}
 
{{Discounts|{{PAGENAME}}}}
  
===Location Group===
+
===Location Group Settings===
 
{{Location Group|{{PAGENAME}}}}
 
{{Location Group|{{PAGENAME}}}}
  

Revision as of 17:20, 17 June 2019

Icon.ShipStation.png The ShipStation 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 ShipStation's eCommerce shipping software. After an order has been picked in Fishbowl, the order information will be sent to ShipStation. After the order has been processed in ShipStation, carrier, service, tracking number, and carton costs will be sent back to Fishbowl.

File:ShipStation2.png
The documentation on this page is for the most recent version of the Small.ShipStation.png ShipStation 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.ShipStation.png ShipStation 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.ShipStation.png ShipStation module from any Fishbowl Client by opening the Integrations module group.
  6. To grant access to additional users, assign the ShipStation-View access right to the appropriate groups in the Small.User Group.png User Group module

Setup

Complete the steps to prepare for the Advanced ShipStation integration. Then enter a Store Name and any other required information on the Store Settings tab of the Small.Advanced ShipStation.png Advanced ShipStation module.

  1. Open the ShipStation API Settings page.
  2. Scroll to the bottom of the page to find the API Key and API Secret.
  3. Paste the API Key and API Secret into the Store Settings tab of the Small.ShipStation.png ShipStation module.
  4. Complete the Store Settings instructions.

TABS

Shopping cart 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.Advanced ShipStation.png Advanced ShipStation options or notes are included at the bottom of each section. System properties also allow advanced options to be enabled for the Small.Advanced ShipStation.png Advanced ShipStation plugin.

Store Settings

  1. If applicable, copy any needed setup information from the Advanced ShipStation website.
  2. Click the Store Settings tab of the Small.Advanced ShipStation.png Advanced ShipStation module.
  3. Enter a name in the Store Name field and any other required information.
  4. Click the Connect Button.png button and verify that the connection to the Advanced ShipStation website is working.
  5. Click the Save Button.png Save button at the top of the module to save the Advanced ShipStation settings.
  6. Click the New Button.png New button at the top of the module to configure another Advanced ShipStation store.
Small.Advanced ShipStation.png Additional Advanced ShipStation information
  • Enable Ship Quote Feature
  • Use Residential Shipping
  • Shipping Item
  • Use the order location group's default Main Address
  • Use a selected address for all orders

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. 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 Small.Sales Order.png Sales Order module.

  • Order field mapping - Use the mapping table to map Advanced ShipStation 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 currency conversion - Enabling this option will convert order currencies from the Fishbowl customer's default currency to your Fishbowl home currency, using the rates defined in the Small.Currency.png Currency module. When currency conversion is enabled, some additional fields will be available, including a currency/customer mapping table when Use a Default customer is selected.
  • 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 Small.Discount.png Discount module and then the correct discount amount will be set when the order is imported from Advanced ShipStation.
  • Default Salesperson - Sales orders will be created using this salesperson.
  • Default Class - If there is no class mapped from Advanced ShipStation, sales orders will be created using this class as the sales order class.
  • Default Payment Terms - If there are no payment terms mapped from Advanced ShipStation, sales orders will be created using this payment term.
  • Default Shipping Terms - If there are no shipping terms mapped from Advanced ShipStation, sales orders will be created using these shipping terms.
  • Order number prefix - An order number prefix can be defined which will be applied to order numbers mapped from Advanced ShipStation.
Small.Advanced ShipStation.png Additional Advanced ShipStation information
  • ShipStation Store - After integration, this field will display the stores configured in your ShipStation account.
  • ShipStation Source - After integration, this field will display the sources configured in your ShipStation account.
  • Combine all discounts - Enabling this option will sum up all of the line item discounts and apply them as one order discount.

Location Group Settings

Cart Location Group.png
  • Use a default location group - Select a default location group for imported orders.
  • Use location group mapping - This option is disabled in the Advanced ShipStation plugin.

Order Status Mapping

Cart Order Status Mapping.png
Use the table to assign Advanced ShipStation order statuses to Fishbowl order statuses. The Order Import task will only import orders from Advanced ShipStation 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 a Default customer - 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 Advanced ShipStation Customer.
  • Use the Advanced ShipStation Billing Address - Use the billing address from the Advanced ShipStation order instead of the address for the default customer.
  • Use the Advanced ShipStation Shipping Address - Use the shipping address from the Advanced ShipStation order instead of the address for the default customer.
  • Use the Advanced ShipStation Customer and Addresses - This option will import the addresses and customer from the Advanced ShipStation order instead of using a generic customer.
  • Name - Select the Advanced ShipStation field that contains the customer name that should be imported into Fishbowl.
  • Alternate Name - An alternate field mapping when the primary mapping does not contain data.

Carrier Mapping

Cart Carrier Mapping.png
  • Use default carrier/service - When selected, all orders imported from Advanced ShipStation will use the selected carrier and carrier service. If this option is unchecked, carriers can be mapped between Fishbowl and Advanced ShipStation. 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 Advanced ShipStation and Fishbowl.

Payment Mapping

Cart Payment Mapping.png
  • Create payments in Fishbowl - When selected, payments from the Advanced ShipStation transaction will be shown in the Small.Payment Viewer.png Payment Viewer module.
  • Use a default payment method - When selected, all orders imported from Advanced ShipStation will use the selected payment method.
  • Use Payment method mapping - When selected, the table can be used to map payment methods between Advanced ShipStation and Fishbowl.
  • Always create payments - If no payment data exists for the order from Advanced ShipStation, 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.
  • 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 Small.Currency.png Currency module.
  • Currency - Select the currency type you accept in Advanced ShipStation. This is a required setting if Use Currency Conversion is enabled in the Small.Currency.png Currency module.

Taxes

Cart Taxes.png
  • Import Taxes - When selected, the tax amount from the Advanced ShipStation 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 Advanced ShipStation. 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.

Order Item Settings

ShipStation Order Item Settings.png
  • Ignore miscellaneous items - Miscellaneous items will not be created if no product ID is found on the ShipStation order item.
  • Enable order import product linking - If a product is not already linked, the plugin will attempt to find a match based on the field mapping table.

Product Import

Cart 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 Advanced ShipStation. A product link is created by storing the Advanced ShipStation product ID in Fishbowl. Select ONE of the following options:

  1. Link existing products - This option will match existing products in Fishbowl and Advanced ShipStation where data matches in the selected fields.
  2. Import products - This option will import products from Advanced ShipStation into Fishbowl, creating them based on the field mapping and selected settings. If the weight or size UOM isn't set in Advanced ShipStation, the default UOMs 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. 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.

Select ANY of the following options:

  1. Export new products- Map the fields that should be exported from Fishbowl to Advanced ShipStation. A default weight UOM and size UOM can also be specified. The selected product trees will be included, or all product trees will be included if the field is left blank. Selecting the Export all products option will ignore the last sync date and attempt to push all of the Fishbowl products to Advanced ShipStation. The product tree filter will still apply.
  2. Update linked products - This section has the same options as the Export new products section above. After the initial product export, only the selected fields will be updated.

Troubleshooting

  • The attributes and IDs for orders and products can viewed or modified by clicking the Small.Advanced ShipStation.png Advanced ShipStation 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.Advanced ShipStation.png Advanced ShipStation 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 Advanced ShipStation.jar file in C:\Program Files\Fishbowl\plugins\ or \Applications\Fishbowl\plugins\ on a Mac. If there are two Advanced ShipStation versions, exit the Fishbowl Server and remove the older version on all client and server computers.

Release Notes