Back to all categories

Integrations

  Training Videos

  Payment Gateway

  Plugin

The ShipStation module, located in the Integrations group, is an add-on module that can be installed from the Plugin module. After installing the plugin, a new module is added that integrates with ShipStation's eCommerce shipping software. To migrate from the older plugin, click here.

Install

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

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

Setup

Complete the steps below to configure the ShipStation integration. If you are migrating from the old plugin, review the ShipStation to Advanced ShipStation migration article.

1. Open the ShipStation API Settings page.
   
2. Scroll to the bottom of the page and copy the API Key and API Secret.
3. Click the Settings button on the module toolbar of the ShipStation module and paste the API Key and API Secret.
4. Click the Test Connection button and verify that the connection to the ShipStation website is working.
5. Click the Pull ShipStation Data button and then configure the settings below.
6. Click the Save button at the bottom of the window to save the ShipStation settings.

Module Options

The ShipStation module has two layout options. To access this option, click the Tools menu and then select Module Options.

• When Tab Navigation is enabled, each schedule is displayed as an individual tab.
  
• When Tab Navigation is disabled, the schedules are located in the Schedule Type dropdown at the top of the Schedule pane.
  

The documentation below uses the tab layout.

Ship Quote

Click the Ship Quote button in the Sales Order module to get a ship quote. The quote can also be added to the order.

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 ShipStation options or notes are included at the bottom of each section.

Order Import

• Schedule - Select the Active checkbox to import orders on a set schedule. Click the 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. If additional options are available, they can be enabled by selecting Use Advanced Options at the bottom of the Schedule section.
  

Order Settings

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

• Order field mapping - Use the mapping table to map 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.
• Enable State/Province Code Creation - If an order is being imported with a state or country code that does not exist in Fishbowl, the code will be automatically created in Fishbowl instead of throwing an error.
• Order number prefix - An order number prefix can be defined which will be applied to order numbers mapped from ShipStation.
• Default Salesperson - Sales orders will be created using this salesperson.
• Default Class - If there is no class mapped from 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 ShipStation, sales orders will be created using this payment term.
• Default Shipping Terms - If there are no shipping terms mapped from ShipStation, sales orders will be created using these shipping terms.
• Combine all discounts - Enabling this option will sum up all of the line item discounts and apply them as one order discount.
• 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 Discount module and then the correct discount amount will be set when the order is imported from ShipStation.
• 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 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.
• Filter ShipStation Orders - If selected, orders will only be imported from the selected stores and sources. If this option is disabled, orders will be imported from all stores and sources.

Order Item Settings

• Item field mapping - Use the mapping table to map ShipStation 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.
• Shipping item - Select the shipping type product that will be added as a line item to orders when applicable. It will contain the shipping price to be paid by the customer.
• Ignore miscellaneous items - If this option is selected, ShipStation order items that are not related to an actual ShipStation product record will be ignored and no Fishbowl line item will be created.
• Enable order import product linking - ShipStation order items will be matched to Fishbowl products based on the defined field mapping. If the ShipStation 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 ShipStation item field.
• ShipStation item field - The ShipStation order item field that will match the selected Fishbowl product field.

Order Status Settings

Use the table to assign ShipStation order statuses to Fishbowl order statuses. The Order Import task will only import orders from ShipStation that are in a status assigned to a Fishbowl order status. If the Fishbowl order status is set to Historical, the order will be imported into Fishbowl, but it will not affect inventory or accounting. At least one active status mapping is required to use the Order Import task.

Location Group Settings

• Use default location group - Select a default location group for imported orders.
• Use location group mapping - Use the table to map location groups between ShipStation and Fishbowl.

Customer Settings

Use the options below to determine how customers are created in Fishbowl and what information is imported into Fishbowl.

• Enable advanced mapping settings - This option enables additional customer mapping options and control over customer creation.
• Enable wholesale & retail settings - After enabling this option, additional fields will allow you to assign your retail orders to use a default Fishbowl customer while allowing your wholesale customers to be mapped as unique customers. This requires the ShipStation order or the ShipStation customer to have a Wholesale tag. Tags can be managed in ShipStation by clicking the Tag button near the top of the window.
  
• 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 ShipStation Customer.

• Use order billing address - Use the billing address from the ShipStation order instead of the address for the default customer.
• Use order shipping address - Use the shipping address from the ShipStation order instead of the address for the default customer.
• Use store mapping - This option will allow you to map you ShipStation stores to Fishbowl customers.

• Use the order customer and addresses - This option will import the addresses and customer from the ShipStation order instead of using a generic customer.

• Field - Select the ShipStation 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.

Carrier Settings

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

Payment Settings

• Create payments in Fishbowl - When selected, payments from the ShipStation transaction will be shown in the Payment Viewer module.

• Use a default payment method - When selected, all orders imported from ShipStation will use the selected payment method.
• Use Payment method mapping - When selected, the table can be used to map payment methods between ShipStation and Fishbowl.
• Always create payments - If no payment data exists for the order from 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.

Tax Settings

• Import Taxes - When selected, the tax amount from the 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 Tax Rate module and then the correct total tax amount will be set when the order is imported from 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.
• 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 ShipStation.
  • Import ShipStation tax as line item note - Import the ShipStation tax as a line item note in Fishbowl.

Shipment Export

• Schedule - Select the Active checkbox to export shipments on a set schedule. Click the 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.

Shipment Settings

• Order field mapping - Use the mapping table to map ShipStation order fields to Fishbowl order fields.
• Order types - Shipments for the selected order types will be included in the shipment export.
• Shipment statuses - Shipments with the selected statuses will be included in the export.
• Size UOM - Select the ShipStation size UOM.
• Weight UOM - Select the ShipStation weight UOM.
• ShipStation Store - Select the ShipStation store that exported shipments will be assigned to. If no selection is made, ShipStation will default to the first manual store on your account.
• Remove Prefix - When selected, the S prefix will be removed from the Fishbowl shipment number before it is sent to ShipStation.

Ship Item Settings

• Item field mapping - Use the mapping table to map Fishbowl shipment item fields to ShipStation order item fields.

Location Group Settings

Select one location to assign to all exported shipments, or use location group mapping to dynamically determine the location based on the order location group. Orders with unmapped locations will not be exported.

• Use default ship from location - Select a default ShipStation location to be assigned to all exported shipments.
• Use location group mapping - Use the table to dynamically determine the location based on the order location group.

Address Settings

• Ship to address mapping - Use the table to choose which {{{1}}} fields are imported into the Fishbowl Ship To Name and Street Line fields.
• Bill to address mapping - Use the table to choose which {{{1}}} fields are imported into the Fishbowl Bill To Name and Street Line fields.

Carrier Settings

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

Fulfillment Import

• Schedule - Select the Active checkbox to import fulfillment data on a set schedule. Click the 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.
• Ignore shipping cost - With this option enabled, the shipping cost from ShipStation will not be set on the shipment carton.
• Fulfill order - Select this option if you want the Fishbowl order and shipment to be fulfilled.
• Update carrier - If this option is selected, the carrier and service of the Fishbowl shipment will be updated.
• Use default carrier - When selected, all orders imported from ShipStation will use the selected carrier and carrier service. If this option is unchecked, carriers can be mapped between Fishbowl and ShipStation.
• Use carrier mapping - When selected, the table can be used to map carriers between ShipStation and Fishbowl.

Product Import

• Schedule - Select the Active checkbox to import products on a set schedule. Click the 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 ShipStation 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 ShipStation. A product link is created by storing the ShipStation product ID in Fishbowl.

• Link Existing Products will match existing products in Fishbowl and ShipStation where data matches in the selected fields.
• Import Products will import products from ShipStation into Fishbowl, creating them based on the field mapping and settings below.

Product Export

• Schedule - Select the Active checkbox to export products on a set schedule. Click the 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 Linked Products - Map the fields that should be imported from ShipStation to Fishbowl. If the weight or size UOM isn't set in ShipStation, the default UOMs listed here will be used. 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 ShipStation. The product tree filter will still apply.

Troubleshooting

• If there is an API Logs button at the top of the module, it can be used to see any errors that have been logged. You can leave the API Logs window open while you work in Fishbowl and click the Refresh button at the bottom of the window as needed.
• 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 ShipStation button at the top of the Sales Order module and the Product module.
• To view the scheduled tasks for the ShipStation module, open the Schedule module.
• A scheduled task can be run manually by double-clicking the task.
• Enter an email address in the Schedule module to receive error notifications.
• To view the history of a scheduled task, including the result/error, click the History button in the Schedule module.
• More details about recent errors can be viewed by opening the Data module and clicking the Server Log button.
• Check for multiple versions of the ShipStation.jar file in C:\Program Files\Fishbowl\plugins\ or \Applications\Fishbowl\plugins\ on a Mac. If there are two ShipStation versions, exit the Fishbowl Server and remove the older version on all client and server computers.

Release Notes

For additional changes, see Master Plugin.

• Improved error messaging
• Fixed bug with the combine all discounts option not saving the setting correctly in the UI
• Separated order notes and order item notes into separate corresponding fields when orders are imported into FB
• General UI fixes
• Fixed product export tab issue for Canadian users of the plugin
• Fixed duplicate shipment export issue
• Fixed mapping issue with shipping product not mapping to the paid flag in SS
• Fixed issue with split shipments not pushing up to SS

• Initial Release