ShipStation Plugin Integration

Overview

ShipStation is a shipping and e-commerce solution designed to help businesses streamline their order fulfillment processes. They provide a centralized platform where you can manage online orders and automate shipping processes across various sales channels.

Besides the standard ShipStation API integration, Sellercloud offers another integration that pulls orders from ShipStation’s integrated channels and imports them into Sellercloud for in-house management.

Sellercloud can connect to ShipStation by utilizing the below plugins:

• ShipStation Order Import – Imports orders from ShipStation into Sellercloud.

• ShipStation Tracking Export – Exports order tracking information from Sellercloud to ShipStation. This plugin is typically used if you prefer to manage the shipping aspects of your order fulfillment operations through Sellercloud.

• ShipStation Tracking Import – Imports tracking information for orders that originated from and are shipped via ShipStation into Sellercloud. The plugin also checks the warehouse of the first item in the order and deducts the quantity from the respective warehouse Picking Bin for clients who use Skustack.
• ShipStation Order Cancelled Import – The plugin imports cancelled orders information from ShipStation into Sellercloud.

Contact Sellercloud Support to install the above 4 plugins on your server.

Prerequisites

To use ShipStation’s API, you’ll first need to generate a ShipStation API key and API secret that will be included in Sellercloud’s API calls. 

Custom Company Settings

Create the following Custom Company Settings on the company created for the integration:

• ShipStation_API_Key – The API key, used as a username for the authorization in ShipStation.

• ShipStation_API_Secret – The API secret, used as a password for the authorization in ShipStation.

• ShipStation_API_URL – Optional setting, used to override the default API endpoint URL, If the setting is not created, or is left empty, it defaults to: https://ssapi.shipstation.com/orders and https://ssapi.shipstation.com/orders/markasshipped based on the plugin.

• ShipStation_LastSuccessfulExecution – This setting is required, so the integration differentiates between orders that are already imported into Sellercloud and new orders, created after the last successful execution of the plugin. 

• ShipStation_TimeToFilterOrdersBeforeLastExec – Optional setting that will modify the time span from the last successful execution time to filter the orders. The value should be negative so it subtracts from the time (e.g. ‘-2’ <- will subtract 2 days; exact value: ‘-01:00:00’ subtracts 1 hour <- format is hour:minute:seconds).

• ShipStation_TrackingImport_API_URL – Optional setting. The default is https://ssapi.shipstation.com/shipments.

• ShipStation_TrackingImport_LastSuccessfulExecution – Automatically populated by the plugin. Clear the setting if you want to get all available shipments.

• ShipStation_TrackingImport_TimeToFilterOrdersBeforeLastExec – Optional Setting – Time to offset the ShipStation_TrackingImport_LastSuccessfulExecution. Will subtract the time span from the last successful execution time to filter the orders (e.g. ‘2’ <- will subtract 2 days, exact: ’01:00:00′ subtracts 1 hour <- format is hour:minute:seconds).

• ShipStation_CancelledOrdersLastExecution – Automatically populated by the plugin. Clear the setting if you want to get all available shipments.

• ShipStation_CancelledOrdersTimeToFilterOrdersBeforeLastExec – Optional setting that will subtract the time span from the last successful execution time to filter the cancelled orders.

• ShipStation_API_TrackingExport_NotifyCustomer – Optional setting. When Sellercloud updates the tracking, this setting will send a True or False value, based on the order configuration to inform the customer, or not.
• ShipStation_API_TrackingExport_NotifyChannel – Optional setting. When Sellercloud updates the tracking, it will send a True or False based on your configuration to notify the channel for tracking updates.

Sellercloud Support

Custom fields from ShipStation orders can be imported as Custom Columns in Sellercloud’s order records.

Contact Sellercloud Support to request the following Custom Order Columns:

• SHIPSTATION_CUSTOM_FIELD1

• SHIPSTATION_CUSTOM_FIELD2

• SHIPSTATION_CUSTOM_FIELD3

Order Import

This plugin pulls orders from your ShipStation integrated channels, based on their status and creation date, and replicates them into Sellercloud as Unshipped and Paid. This includes retrieving and recording customer details and other order information from ShipStation. 

Bear in mind that ShipStation Channel Order ID is generated as OrderSourceOrderID in Sellercloud and the ShipStation Order Number data is stored internally. 

Automate Order Import

To create a Scheduled Task that imports ShipStation orders automatically into Sellercloud, based on a custom frequency:

1. Navigate to Settings > Scheduled Tasks > Manage Scheduled Tasks.
2. Click the green + icon: Create New Scheduled Task.
3. Complete as follows:
   1. Click Task Type and select Import Orders.
   2. Set the Task Name.
   3. Select the Company.
   4. Select the Start Time.
   5. Click CREATE.
4. The following message appears at the bottom of your screen: “Scheduled task created successfully. Click Here to configure the task details.” – click the link.
5. Click the Edit button on the top right.
6. In the Details section:
   1. Click Create Orders For Company and select the company designated for this integration.
   2. Click the Plugin menu and select ShipStation Order Import.
7. In the Import Options section, set Import From to None.
8. In the Frequency section, specify the task frequency. For optimal performance, select a range between thirty minutes and one hour.
9. In the General section, click the Enable button.
10. Click Save on the top right.

Tracking Export

The plugin sends tracking information from Sellercloud to ShipStation, matching the orders by their ShipStation Order ID.

Before you move on, create a Saved Search for orders filtered by:

• Company – The company you created for the integration.
• Order Status – InProcess or Completed
• Payment Status – Charged
• Shipping Status – Fully Shipped
• Tracking Uploaded – No

Automate Tracking Export

To create a Scheduled Task that exports order tracking automatically, based on a custom frequency:

1. Navigate to Settings > Scheduled Tasks > Manage Scheduled Tasks.
2. Click the green + icon: Create New Scheduled Task.
3. Complete as follows:
   1. Click Task Type and select Export Orders.
   2. Set the Task Name.
   3. Select the Company.
   4. Select the Start Time.
   5. Click CREATE.
4. The following message appears at the bottom of your screen: “Scheduled task created successfully. Click Here to configure the task details.” – click the link.
5. Click the Edit button on the top right.
6. In the Details section:
   1. Click the User ID menu and select your ID.
   2. Click the Saved Search menu and select the saved search you created earlier.
   3. Click the Export Via menu and select ShipStation Tracking Export.
   4. Check This Is Tracking Export.
7. In the Export Options section, set Export To to None.
8. In the Frequency section, specify the task frequency. For optimal performance, select a range between thirty minutes and one hour.
9. In the General section, click the Enable toggle button.
10. Click Save on the top right.

Tracking Import

This plugin pulls tracking information for ShipStation fulfilled orders, imported by the Order Import plugin. The plugin also checks the warehouse of the first item in the order and deducts the quantity from the respective warehouse Picking Bin for clients who use Skustack.

Automate Tracking Import

To create a Scheduled Task that imports ShipStation orders tracking information automatically into Sellercloud, based on a custom frequency:

1. Navigate to Settings > Scheduled Tasks > Manage Scheduled Tasks.
2. Click the green + icon: Create New Scheduled Task.
3. Complete as follows:
   1. Click Task Type and select Import Orders.
   2. Set the Task Name.
   3. Select the Company.
   4. Select the Start Time.
   5. Click CREATE.
4. The following message appears at the bottom of your screen: “Scheduled task created successfully. Click Here to configure the task details.” – click the link.
5. Click the Edit button on the top right.
6. In the Details section:
   1. Click Create Orders For Company and select the company designated for this integration.
   2. Click the Plugin menu and select ShipStation Tracking Import.
7. In the Import Options section, set Import From to None.
8. In the Frequency section, specify the task frequency. For optimal performance, select a range between thirty minutes and one hour.
9. In the General section, click the Enable button.
10. Click Save on the top right.

Cancelled Orders Import

This plugin imports cancelled orders information from ShipStation into Sellercloud.

Automate Cancelled Orders Import

To create a Scheduled Task that imports ShipStation cancelled orders automatically into Sellercloud, based on a custom frequency:

1. Navigate to Settings > Scheduled Tasks > Manage Scheduled Tasks.
2. Click the green + icon: Create New Scheduled Task.
3. Complete as follows:
   1. Click Task Type and select Import Orders.
   2. Set the Task Name.
   3. Select the Company.
   4. Select the Start Time.
   5. Click CREATE.
4. The following message appears at the bottom of your screen: “Scheduled task created successfully. Click Here to configure the task details.” – click the link.
5. Click the Edit button on the top right.
6. In the Details section:
   1. Click Create Orders For Company and select the company designated for this integration.
   2. Click the Plugin menu and select ShipStation Order Cancelled Import.
7. In the Import Options section, set Import From to None.
8. In the Frequency section, specify the task frequency. For optimal performance, select a range between thirty minutes and one hour.
9. In the General section, click the Enable button.
10. Click Save on the top right.