Introduction

This page contains instructions for configuring ShipStation to allow your Distribution Center to automatically send orders to ShipStation and receive tracking numbers in return.

If you need information on configuring ShipStation to provide shipping ratings and print labels, see https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/3747217409 .

If you need information on configuring ShipStation as a Channel Partner, please see https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/3531407372 .

All three areas (ratings, distribution centers, and channel partners) use separate credentials to allow for different ShipStation stores.

Integrating ShipStation with UltraCart

This guide will walk you through integrating ShipStation with your UltraCart account for order fulfillment processing. This integration enables UltraCart to transmit orders to ShipStation and ensures proper SKU mapping and shipping method configuration. In additional to transmitting orders and receiving tracking numbers, this integration will also sync inventory from ShipStation to UltraCart items.

Overview

The integration process involves three main steps:

• Configuring the UltraCart transmission mechanism to connect with ShipStation.

• Configuring shipping methods, including custom codes for specific shipping options. Because of the flexibility of ShipStation, this is an optional step, but helpful for streamlining your workflow on the ShipStation side.

• Mapping SKUs for your items. This is required if your ShipStation sku differs from your UltraCart Item ID.

Prerequisites

• You must have an active ShipStation account.

• Log in to your ShipStation account in a separate browser window. You will need your ShipStation screens to generate API Keys.

Configuring the UltraCart Transmission Mechanism to Work with ShipStation

You will need two sets of API keys from ShipStation. Their API is in flux and UltraCart needs Version 1 keys for creating orders and receiving tracking numbers. UltraCart needs Version 2 keys for polling ShipStation inventory.

Version 1 Key Generation

1. Within your ShipStation account, navigate to Settings Page (gear icon at top right) → Account –> API Settings.

2. Select “V1 API” for the API version, then click Generate API Key.

3. We recommend setting the key expiration at 12 months, but you’re free to use any expiration. You’ll need to provide a new key when this one expires. UltraCart has no knowledge of key age, so you will need to monitor your ShipStation configuration to look for expiring keys. We recommend setting a calendar alert prior to the expiration. Alternatively, you may just monitor your UltraCart logs and look for the failures to appear when your key expires. But this method will require diligence and regular reviews to avoid delaying shipments.

4. You’ll be prompted to verify your password to proceed with the key generation.

5. Finally, you’ll need to enter a verification code that will be mailed or texted to you.

6. Copy both the Version 1 Key and Secret off somewhere secure as this is the only time you’ll see it.

Version 2 Key Generation

1. Within your ShipStation account, navigate to Settings Page (gear icon at top right) → Account –> API Settings.

2. Select “V2 API” for the API version and follow the instructions.

3. Copy your Production Key off somewhere secure. This key is visible later on if needed.

At this point, you should have:

1. Version 1 API Key

2. Version 1 API Secret

3. Version 2 API Key (there is no secret for Version 2)

Locate the ShipStation section and enter your three credentials.

Click the Save button.

Navigate back to this screen and your ShipStation stores list will now be populated. Select the ShipStation store.

Finally, there are transmit options to customize what information is sent to ShipStation. Set those as desired.

Open

Configuring Shipping Methods

After configuring the transmission mechanism, you should configure your shipping methods to ensure proper mapping between UltraCart and ShipStation. This is not required, but without providing shipping mappings, your ShipStation orders will show as “unmapped” and you will not have streamlined label printing accessible until you specify a mapping on the ShipStation side. If your store is tied to automatic fulfillment, unmapped shipping methods may cause errors or order rejection.

Navigate to your shipping methods in the Shipping section.

On the "Other" tab of your shipping method, scroll down to the Custom Shipping Method Codes section.   Enter the Custom Shipping Method Code for Transport = ShipStation.

You can find your list of shipping methods in your ShipStation screen by clicking the gear in the top right of the screen, then selecting Shipping → Carriers. For each carrier, click the Actions ellipsis and choose Manage services.

Open

Enter the name exactly as it appears in your ShipStation system.

Open

Item SKU Mapping

If your UltraCart item IDs and ShipStation SKUs are identical (especially if your ShipStation SKUs are the same as your UPPERCASED UltraCart Item IDs), SKU mapping will happen automatically, and no further action is required. However, if they differ, you must configure SKU mapping for each item.

For your distribution center that is connected to ShipStation, enter the SKU for each item if it differs from the actual Merchant Item ID.

Open

Conclusion

By following these steps, you will have successfully integrated ShipStation with your UltraCart account, enabling seamless order fulfillment and inventory management between the two systems.

Next Steps

• Test your configuration end-to-end by placing a test order to ensure that orders are transmitted correctly to ShipStation and shipping methods are mapped as expected.

• Review your ShipStation settings for any additional item configuration options.

• Read your logs! The Integration Logs have a wealth of information. Review them often! https://secure.ultracart.com/merchant/report/integrationLogApp.do#/

Open