ShipStation API Integration

Overview

Learn how to integrate your ShipStation account within Sellercloud.

Amazon’s Seller-Fulfilled Prime orders should not be sent to ShipStation to ship because they will not be properly flagged as Prime orders, which may cause them to ship using your own carrier accounts. Seller-Fulfilled Prime orders should only ship through Sellercloud or Shipbridge by following these instructions. You can exclude these orders from going to ShipStation by using a saved search that determines which orders to send.

By default, when sending kits to ShipStation, only Kit Parent information will be sent. The option to send kit components is available if you add the Custom Setting ShipStation Send Kit Components and set the value to TRUE.

Integrate with ShipStation

This API integration is hosted on Shipstation and cannot be set up directly from Sellercloud. Below are the instructions on how to configure the Custom Store, which will allow the connection:

  1. Log in to your ShipStation account, click on the settings Gear icon.
  2. Click Selling Channels > Store Setup > Connect a Store.
  3. Select Custom Store from the list of options.
  4. Enter the credentials required to connect to Sellercloud:
    1. The URL to the Custom XML Page is https://server-id.ws.sellercloud.com/shipstation/. Replace the server-id with your server ID. For example, if your Sellercloud URL is https://zz.cwa.sellercloud.com, the ZZ at the start of the URL is your server ID.
      For TF servers, the URL should end with .us instead of .com and instead of your server ID, make sure to write your team name: https://team.ws.sellercloud.us/shipstation/
    2. Username and Password should be the credentials to the Sellercloud account with which you want to ship. Make sure the user has all the necessary company, order and tracking permissions.

  5. Most statuses can be left as-is except the Awaiting Shipment Status, which should be set to InProcess:
  6. Click Connect.
  7. Open the Orders page and sync the store, and the order should come in. (The Sync button is on the top right of the page to the left of the Settings button.)

Upon shipping the order, the complete tracking information will be sent to Sellercloud, and the order will be marked in Sellercloud as shipped. By default, orders that ShipStation pulls from Sellercloud have a last-modified date between the start date and end date that ShipStation sent in the request, and they fit the following criteria:

  • DropShip is None
  • Order Status is InProcess
  • Order is Charged (or set to Allow Shipping Even if Not Paid)
To use a saved search with custom filters for ShipStation, as described below, you must add these three criteria as filters. Otherwise, orders that are Unpaid, Dropshipped, and OnHold may also be sent to ShipStation.

Send Specific Orders

If you only want to send specific orders to ShipStation, you can create a Saved Search that selects orders.

  1. Create a saved search for orders with the following filters and any additional filters you want to use when sending orders to ShipStation:
    1. DropShip is None
    2. Order Status is InProcess
    3. Order is Charged (or set to Allow Shipping Even if Not Paid)
  2. Go to the Employee and check what the selected Default Company is. This is important because only that company will be checked for a Saved Search for ShipStation.
  3. Go to Settings and open that same Company. Create a Custom Company Setting called ShipStation Saved SearchID:
    1. Go to Settings > Companies > Manage Companies > Open a company.
    2. Go to Toolbox > Custom Settings > Click the + icon to add a custom setting > Populate the fields > Click Save.saved search
  4. Enter the ID of the search you want to use. When there is a search ID in that setting, only orders that come up as results of that search will be pulled.
If you add another custom company setting called Shipstation Send Warehouse Name and set its Value to True, Sellercloud will include the Ship From warehouse with each order. This is important if your ShipStation is set up for multiple warehouses!

You can see the requests sent by ShipStation in the order’s action documents. If items in the order are unknown, the order will not go to ShipStation.

Using the custom setting ShipStationSendSecondOrderSourceOrderIDInsteadOfPromiseDate will send both order numbers. The second order will replace the Promise Date.


Integrate Multiple ShipStation Accounts

To integrate multiple ShipStation accounts:

  1. Create a Sellercloud Employee for each ShipStation account you want to link. You will use the Sellercloud employee’s User Name and Password to set up a custom store in ShipStation.
  2. For each ShipStation account, create Saved Searches for orders you want to pull.
  3. You should link each ShipStation account to a unique Sellercloud Company by configuring the Default Company field on the Employee Details page. ShipStation will check these companies’ custom settings for saved search IDs.
  4. For each ShipStation account:
    1. In the Company created for this account, create a Custom Company Setting and name it ShipStation Saved SearchID (requires checking Enable Custom Company Settings in your Client Settings).client setting
    2. Enter the Saved Search ID for the orders that are required for this account into the ShipStation Saved SearchID Custom Company Setting.
    3. On the settings page of the Sellercloud employee used in ShipStation, set the Company to the one used to pull the orders.
We recommend that you make sure all Companies have a ShipStation saved search associated with them when setting up multiple Accounts.

Send Fields to ShipStation

By default, Sellercloud sends the following fields to ShipStation:

  • Shipstation OrderID and OrderNumber are both mapped to the Sellercloud OrderID.
  • Internal Notes contain the ShipBy date (OrderShippingPromiseDate) if one was provided by the channel.
  • We pass through if it is a gift order and there is a gift message.
  • CustomField1 = OrderSource (and Subtype if there is one).
  • CustomField2 = OrderSourceOrderID.
  • CustomField3 = Sellercloud CompanyName.
  • Shipping & Billing Address, TimeOfOrder, Shipping & Payment method, etc., are all mapped as expected ProductInfo= Mapped as standard.
Sellercloud also supports customizing which fields are sent to ShipStation. We can build a plugin with which you can map specific Sellercloud fields to ShipStation fields and ensure all of the necessary information is sent. Contact our Support Team for more information and to make a request.

ShipStation Merchant SKU Mapping

When the custom company setting ShipStation Send Original ProductID is not enabled, the SKU sent to ShipStation will be the Sellercloud SKU (ProductID).
When it is enabled, the SKU sent to Shipstation will be the Sellercloud Merchant SKU for that specific channel.

Note that If ShipStation Send Original ProductID is enabled and both ProductID and Merchant SKU are available, the order in Sellercloud will display ProductIDRequested (the SKU that was requested when the order was pulled in Sellercloud) or ProductIDOriginal if ProductIDRequested is not available.


Was this article helpful?

Need Support?
Can't find the answer you're looking for?
Contact Support