ShipWorks Application by Kibo eCommerce

Configuration Guide

Current Version: 2.0.0 (November 2015)
Install: Kibo eCommerce App Marketplace
More Info: Version History

ShipWorks is shipping software designed specifically for online business. ShipWorks can integrate with multiple online marketplaces and provides a centralized place for order tracking, management, and fulfillment.

The ShipWorks Application by Kibo eCommerce integrates your Kibo eCommerce tenant with your ShipWorks account. If you already use ShipWorks for order management and fulfillment, you can use this app to download order data from Kibo eCommerce, fulfill orders from ShipWorks as usual, and automatically upload order status and tracking back into Kibo eCommerce to keep both systems in sync.

Application Features

Note: ShipWorks requires you to purchase a license for each store you create in the ShipWorks software.

Install the App

You can install the ShipWorks Application by Kibo eCommerce directly from the Kibo eCommerce App Marketplace:

  1. Go to:
  2. In the Search field, enter: ShipWorks
  3. Click the app icon.
  4. On the app page, click Install Now.

Configure the App

Configuration Requirements

Configure Account Settings in Kibo eCommerce

  1. In Admin, go to System > Customization > Applications.
  2. Click ShipWorks.
  3. Click the Configuration link to open the app configuration dialog.
  4. On the Account tab, enter a short (6 characters max) User Name for the app to use. This name is just an identifier for the application, and does not have to match your login credentials for ShipWorks.
  5. Click Generate Password. A new unique password appears below the user name.
  6. Leave the configuration dialog open. You will use it in the next section.

Configure Downloads to ShipWorks

The ShipWorks Application allows you to customize how frequently order information is sent from Kibo eCommerce to ShipWorks by specifying filters based on order and payment status:

  1. In the configuration dialog, go to the Preferences tab.
  2. Specify the Order Status filters. The default is to download orders to ShipWorks when they move to Accepted, Processing, or Submitted, but you can choose any or none of the available options. Kibo eCommerce does not download orders that move to Complete, because complete orders have already shipped. Note: If you do not specify an Order Status filter, all orders are downloaded to ShipWorks when they meet the Payment Status conditions.
  3. Specify the Payment Status filters. The default is to download orders to ShipWorks when they move to Paid.Note: If you do not specify a Payment Status filter, all orders are downloaded to ShipWorks when they move to Paid, unless you select Ignore Payment Status.
  4. Specify whether to Send Bundle components as separate Line Items. If you select this option, you can edit the individual items in a product bundle in ShipWorks.
  5. Click Save.

Tip: If you deselect all possible download filters AND select Ignore Payment Status, the ShipWorks Application downloads orders according to the Order Status filter defaults (Accepted/Processing/Submitted). If you no longer want to send any orders to ShipWorks, disable downloads for your Kibo eCommerce store in ShipWorks.

Configure Your Store in ShipWorks

You can now use the User Name, generated Password, and Module URL from Kibo eCommerce to connect ShipWorks to your Kibo eCommerce site(s):

  1. Open ShipWorks.
  2. Select Manage > Stores and click Add Store.
  3. Select Generic - Module and click Next.
  4. On the Store Setup page, paste the User Name, Password, and Module URL from the app configuration dialog in Kibo eCommerce.
  5. Click Next. ShipWorks establishes a connection to Kibo eCommerce through the ShipWorks Application, retrieving the name and address of your Kibo eCommerce store.
  6. Complete the remaining steps of the ShipWorks Setup.
  7. (Optional) Repeat these steps for each Kibo eCommerce site you want to add as a store in ShipWorks.

Configuring Multiple Stores

If you maintain multiple Kibo eCommerce sites, you can set up multiple stores in ShipWorks to handle shipping and fulfillment for each store. Simply repeat the steps in the previous procedure for each store. The ShipWorks app recognizes each site on your tenant and provides unique Module and Shipment URLs that you can use for each ShipWorks store.

You can use the same User Name and Password to create each store in ShipWorks. Only the store URLs must be unique.

Note: ShipWorks requires you to purchase a license for each store you create in the ShipWorks software.

Enable the App

After configuration, enable the ShipWorks Application for Kibo eCommerce to apply its functionality to your tenant.

  1. In Admin, go to System > Customization > Applications.
  2. Click ShipWorks.
  3. Click Enable App.

Congratulations! You can now preview ShipWorks Application functionality on your site.

Use the App

Manage Orders

Once you configure and enable the ShipWorks Application, the app and ShipWorks handle most of the order management process. The amount of order processing you must do in Kibo eCommerce depends on how you configure your order download filters.

If you use the default filters set on the Preferences tab of the app configuration dialog, Kibo eCommerce sends orders to ShipWorks when the following state changes occur:

Note: The ShipWorks Application does not download Complete orders, because complete orders have already shipped. Complete orders will still show a Store Status of Processing in ShipWorks.

The most common workflow is to allow Kibo eCommerce to validate an order, fulfill the order from ShipWorks, and capture payment in Kibo eCommerce. Using at least these default download filters minimizes the risk of orders getting out of sync between ShipWorks and Kibo eCommerce.

Download Frequency

ShipWorks checks Kibo eCommerce for new downloads at the time interval you specified when you configured your store in ShipWorks. You can change this download frequency in the Store Settings dialog in ShipWorks:

  1. Go to Manage > Stores.
  2. Select your store and click Edit.
  3. Go to the Store Settings tab.
  4. Use the Downloading settings to change your download frequency.

Tip: You can manually download orders at any time by clicking the Download button on the Home tab in ShipWorks.

Upload Frequency

When you create a store in ShipWorks, ShipWorks automatically creates an action to upload shipment details when the shipment is processed. After you ship an order in ShipWorks, you can go to the Orders module in Kibo eCommerce Admin to confirm that the Fulfillment Status is Fulfilled. Select the order and go to the Fulfillment tab on the Order Details page to see the fulfillment timestamp and tracking number from ShipWorks. The next section describes how to configure ShipWorks to send more order details to Kibo eCommerce.

Tip: You can manually upload orders at any time by clicking the Update Online button on the Home tab in ShipWorks.

Capture Additional Order Details

You can configure ShipWorks to send more detailed packaging information, such as package weights and carrier information, to Kibo eCommerce. To do this, you must modify the action that sends the updated order info back to Kibo eCommerce.

In the following example, you will update your Store Update action in ShipWorks to handle a common scenario: An order that requires multiple packages (and tracking numbers) within the same order.

1. Disable the Default Store Update Action for Your Store

  1. In ShipWorks, go to Manage > Actions to launch the Action Manager.
  2. Select the Store Update action and click Edit.
  3. Go to the Settings tab. If your Kibo eCommerce store is checked in the Only run the action for these stores list, uncheck the checkbox and click OK.

2. Create a New Action that Checks if All Shipments are Processed

  1. In the Action Manager, click New Action.
  2. Give the action a meaningful name, such as Mozu Shipment Update.
  3. Under When the following occurs, select A filter's content changes.
  4. In the new drop-down that appears, click the Create link under Quick Filter to launch the Filter Editor.
  5. Name the filter. For example: Mozu Shipment Filter.
  6. Click the Add Condition icon ().
  7. Click the Order Total link and select For Every > Shipment under Contents.
  8. Click next to If All of the following conditions are met.
  9. Click the Provider link and select Processed Status under Shipment.
  10. From the drop-down menu, select Processed.
  11. Click OK. You have now created a filter that checks whether every shipment in an order has a status of "Processed".

3. Create the Web Request to Send Data to Kibo eCommerce

  1. In the Action Editor, click Add Task and select Send web request under External.
  2. For Send the request, select Using the results of processing a template as a POST from the drop-down menus.
  3. In the Template drop-down, expand System > Utility and select XML Source.
  4. For the Request URL, enter the Shipment URL from the ShipWorks Application configuration dialog in Kibo eCommerce.
  5. Select the Use basic authentication checkbox.
  6. Enter the User Name and Password from the ShipWorks Application.
  7. Click OK to save.

With this new action, ShipWorks now only uploads orders to Kibo eCommerce when every line item in the order is processed.