Difference between revisions of "Advanced ShipStation"

From Fishbowl
Jump to: navigation, search
(Store Settings)
Line 17: Line 17:
  
 
==Store Settings==
 
==Store Settings==
{{Store Settings|{{PAGENAME}}}}
+
{{Store Settings|ShipStation}}
 
:{{Notes|ShipStation}}
 
:{{Notes|ShipStation}}
 
:*'''Enable Ship Quote''' - This option enables the {{Button|SS Ship Quote|Ship Quote}} in the {{Module|Sales Order|Buttons}}.
 
:*'''Enable Ship Quote''' - This option enables the {{Button|SS Ship Quote|Ship Quote}} in the {{Module|Sales Order|Buttons}}.

Revision as of 15:17, 10 July 2019

Icon.Advanced ShipStation.png The Advanced ShipStation module, located in the Integrations group, is an add-on module that can be installed from the Small.Plugin.png Plugin module. The older ShipStation plugin is being replaced by the Small.Advanced ShipStation.png Advanced ShipStation module, which adds new features such as the ability to import orders from ShipStation. After installing the plugin, a new module is added that integrates with ShipStation's eCommerce shipping software.

Advanced ShipStation.png
The documentation on this page is for the most recent version of the Small.Advanced ShipStation.png Advanced 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.Advanced ShipStation.png Advanced ShipStation 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.Advanced ShipStation.png Advanced ShipStation module from any Fishbowl Client by opening the Integrations module group.
  6. To grant access to additional users, assign the Advanced 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.Advanced ShipStation.png Advanced 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.ShipStation.png ShipStation options or notes are included at the bottom of each section.

Store Settings

ShipStation Store Settings.png
  1. If applicable, copy any needed setup information from the ShipStation website.
  2. Click the Store Settings tab of the Small.ShipStation.png 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 ShipStation website is working.
  5. Click the Save Button.png Save button at the top of the module to save the ShipStation settings.
  6. Click the New Button.png New button at the top of the module to configure another ShipStation store.
Small.ShipStation.png Additional ShipStation information
  • Use Residential Shipping - With this option enabled, the residential address rates will be displayed in the ship quote.
  • Add Shipping Item - This option adds the selected shipping item to the order with the rate selected from the ship quote.
  • Use Location Group Address - A ship from location is required to retrieve shipping rates. This option will use default main address from the order's location group.

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 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 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.
  • Order number prefix - An order number prefix can be defined which will be applied to order numbers mapped from ShipStation.
Small.ShipStation.png Additional 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.

Order Item Settings

Cart Order Item Settings.png
  • 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.

Location Group Settings

Cart Location Group.png
  • Use a 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.

Order Status Mapping

Cart Order Status Mapping.png
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. At least one active status mapping is required to use the Order Import task.

Customer Settings

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 ShipStation Customer.
  • Use the ShipStation Billing Address - Use the billing address from the ShipStation order instead of the address for the default customer.
  • Use the ShipStation Shipping Address - Use the shipping address from the ShipStation order instead of the address for the default customer.
  • Use the ShipStation Customer and Addresses - This option will import the addresses and customer from the ShipStation order instead of using a generic customer.
  • Name - Select the 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 Settings

Cart Carrier Mapping.png
  • 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

Cart Payment Mapping.png
  • Create payments in Fishbowl - When selected, payments from the 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 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.
  • 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 ShipStation. This is a required setting if Use Currency Conversion is enabled in the Small.Currency.png Currency module.

Tax Settings

Cart Taxes.png
  • 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 Small.Tax Rate.png 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.

Shipment Export

ShipStation Shipment Export.png
  • Schedule - Select the Checked.png Active checkbox to export shipments 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.

Shipment Settings

ShipStation Shipment Settings.png
  • ShipStation Store - Select the ShipStation store.
  • Size UOM - Select the ShipStation size UOM.
  • Weight UOM - Select the ShipStation weight UOM.
  • Shipment statuses - Shipments with the selected statuses will be included in the export. At least one selection is required.
  • Order types - Shipments for the selected order types will be included in the shipment export. At least one selection is required.
  • Order field mapping - Use the mapping table to map ShipStation order fields to Fishbowl order fields.

Ship Item Settings

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

Location Group Settings

ShipStation Location Group.png
Select one warehouse to assign to all exported shipments, or use location group mapping to dynamically determine the warehouse based on the order location group.
  • Default Warehouse - Select one warehouse to assign to all exported shipments.
  • Use location group mapping - Use the table to dynamically determine the warehouse based on the order location group.

Address Settings

ShipStation Address Settings.png
  • Use Residential Shipping - With this option enabled, all shipping addresses will be marked as Residential on export.
  • Use the mapping table to determine how your ShipStation order addresses will be built.

Carrier Settings

Cart Carrier Mapping.png
  • 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

ShipStation Fulfillment Import.png
  • Schedule - Select the Checked.png Active checkbox to import fulfillment data 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.
  • Ignore shipping cost - With this option enabled, the shipping cost from ShipStation will not be set on the shipment carton.
  • Do not update carrier/service - If this option is selected, the carrier and service of the Fishbowl shipment will not be updated.
  • Use a 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.
  • Use carrier mapping - When selected, the table can be used to map carriers between ShipStation and Fishbowl.

Fulfillment Export

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. 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 order status - When selected, ShipStation orders will be updated after the product(s) on the order have been shipped in Fishbowl. Shipment tracking information will also be sent from Fishbowl to ShipStation.
  • Check order status - When selected, the ShipStation order status will be checked prior to attempting to send fulfillment information. If the ShipStation order status has changed, no fulfillment information will be sent. This will increase the time required to complete the order fulfillment task.

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

  1. Link existing products - This option will match existing products in Fishbowl and ShipStation where data matches in the selected fields.
  2. Import products - This option will import products from ShipStation into Fishbowl, creating them based on the field mapping and selected settings. If the weight or size UOM isn't set in ShipStation, the default UOMs listed here will be used.

Product Export

ShipStation 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.
  • Update linked products in ShipStation- 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. 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 ShipStation. The product tree filter will still apply.

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