Shipper Integration | ShipStation API

Shipper Integration | ShipStation API



OMS can integrate with the ShipStation shipping API so that when an item is dispatched using a scan point, a shipment is created in the ShipStation system and a shipping label for one of your enabled ShipStation carriers is generated . You must have an account with ShipStation before you can configure this shipping integration. 

 

Locating the shipping integration settings

After logging into OMS, select  Companies  from the Settings menu: 

Generic_Filesystem_Integration-001.png

Search for the company you wish to create an integration for. You can search by the name of the company or the company reference number:



Unless advised by CG Enginners team otherwise then the integration should always be applied to the DROPSHIP company in OMS


Generic_Filesystem_Integration-002.png

 

 

When you have found the company you wish to create an integration for, hover your mouse over it and click on the  details  icon to edit that companies details:

 

Generic_Filesystem_Integration-003.png

 

Open the  Integrations  tab, followed by the  Shipping  tab then select  ShipStation  from the dropdown menu:






Explanation of the ShipStation Integration settings


The screenshot below shows the ShipStation shipping integration settings.



Element name
Element Description
Enabled
This checkbox must be ticked to activate the integration.
API key
Enter your companies ShipStation API key here
API secret
Enter your companies ShipStation API secret here
Always Use Cheapest Available Service
Ticking this will select the cheapest service available for the order in your ShipStation account.  No shipping method needs to be set on the order in OMS if this is enabled.
Package Code
Choice of Package or Parcel.  Package is accepted by most US carriers, Parcel for UK carriers.
From Postal Code
Enter the postcode that the shipments will be sent from.



ShipStation Carrier and Service Codes

Orders that have the shipping carrier field set as "ShipStation" and whose company has the ShipStation shipping integration enabled will use the ShipStation shipping integration when the item/s from that order have been scanned at the Dispatch Scan Point in OMS.

If the "Always Use Cheapest Available Service" is enabled on the integration then no shipping method is required to be set on the order, the cheapest available option in the connected ShipStation account will be used.

If the "Always Use Cheapest Available Service" is not enabled then the shipping method of the order needs to be set using the following format.

shipstation_carrier_code|shipstation_service_code

A full list of ShipStation carrier and service codes can be found on the link below.


Creating a ShipStation Shipping label

Once the ShipStation shipping integration has been configured, you can generated a ShipStation shipping label PDF from within OMS by taking the following steps.

From within OMS, click on the  Order Manager  tab and find the order you wish to create a shipping label for.  When you have found the order you wish to ship, click on its order information icon:

Hermes-006.png

 

After clicking on the action icon for the order, select  Items Overview  from the menu on the left then copy the  Item ID  :

 

Hermes-007.png

 

Finally, select  Item (Dispatch)  from the Scan Points tab then either scan the barcode on the orders jobsheet or paste the  Item ID  in the Dispatch Item box to generate the shipping label PDF for the order:

 

Hermes-008.png

Example ShipStation Shipping Label

Shipstation Package Codes Mapping

The Shipstation integration offers more flexibility and control regarding Package Codes on orders.  Users can now either setup some Package Code mapping on the integration, or setup order level Package Code mapping.

Package Code Mapping
The Package Code dropdown must be set to blank.  Afterwards users must define a map of all methods they plan on using, in the following format:
"[method]: [packageCode]"
When setup correctly, it will look like this:
"
rm_intl_business_parcels_mail_large_letter_zone_sort: large_letter
rm_intl_business_parcels_zone_sort_priority_ie: parcel
rm_48: large_letter
rm_24: parcel
"
This allows you to specify in advance which method maps to which Package Code.

Order Level Package Code Mapping
To set this on an Order Level users need to make a change to the integration, and you need to modify what methods your orders map too.  This can be controlled with Shipping Mapping. To set it up on the integration, on the Package Code dropdown, change the option to "Dynamic".

To set up the new order mapping, you must change the format the methods come in with, from "carrier|method", to "carrier|method|package_code".
For example, instead of mapping an order method to "royal_mail|rm_48", you would map it instead to "royal_mail|rm_48|large_letter" (or "royal_mail|rm_48|parcel" if you need to use the Parcel package code for this order).
When using methods with multiple potential Package Codes, this allows users to use whichever Package Code is appropriate for that order.
The two methods for package code mapping are mutually exclusive.

Shipstation Order Stacking

Previously when users dispatched an order with a Shipstation carrier and method set, one listing would be created within the Shipstation interface, per attempt to dispatch an order.

This integration has been updated so that now when on order is dispatched with a Shipstation carrier and method, the order will create an attribute, that makes sure it references the same Shipstation listing each time. 

This can be found within orders in Order Manager, under the Attributes tab as shown in the example below. This image is using a test order and the values were created as an example.

Please note, if an order has any incorrect information such as invalid addressed, users must either delete the order attribute within the Platform or fix the order within Shipstation. Either method being completed will result in the order being dispatched correctly. 

Updated Shipstation API Shipping Integration Features
At KornitX we have continued to develop updates for variants and this is due to the fact we pride ourselves on constant evolution and the release of new features and enhancements every week. We have detailed each new enhancement below. If you are interested in knowing what features arrive, they will be continually updated within the "Core Platform Feature Updates" Article - CLICK HERE
This will continue to be updated below whenever a new enhancement is rolled out to improve the ShipStation Supplier Integration, a time stamp will be labelled with each feature

Shipstation integration now supports sending the insurance trigger
This was added on 03-09-2021
The Shipstation Integration is set up to now support sending an insurance trigger from one of three options. This can easily be set within the "Shipper Integrations" and "Shipstation" integration with the "Shipping Insurance" dropdown where you can select either "shipurance", "carrier" or "provider". As shown in the below screenshot.

For more information on the types of insurance options please reference the linked Shipstation document - Click Here

Shipstation now supports webhook for pulling status of orders shipping inside Shipstation
This was added on 11-10-2021
The ShipStation integration has been updated to ensure KornitX can pull the order status from ShipStation. This means that if you were to dispatch from ShipStation instead of platform, we will pull in the dispatch and shipping reference information and will update within platform.

It is important to note this also means if you were to update this data in the platform, it will then update within the ShipStation interface. Meaning regardless of how you gather this data, it will always pull into the subsequent area - be that platform or ShipStation.

Shipstation now supports Targeting A Store ID
This was added on 22-09-2021
The Shipstaton Shipping Integration has been updated to ensure you can now target a specific store ID. To be able to set this simply edit your integegration and fill in yiur numerical store ID into the "Store ID" field which has been shown below. 


    • Related Articles

    • Shipper Integration | ParcelHub

      Introduction This article has been created to show how to setup the Shipper Integration that Kornit X has built to connect to ParcelHub.  Setup To setup the ParcelHub integration, please head to your Dropship company and within the advanced settings ...
    • Shipper Integration | Paragon HDX

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to Paragon HDX.  Setup To setup the Paragon HDX integration, please head to your company and within the advanced settings head ...
    • Shipper Integration | Generic Label

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to a Generic Label. Setup To setup the Generic Label integration, please head to your company and within the advanced settings ...
    • Shipper Integration | GLS Spain

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to GLS Spain. Setup To setup the GLS Spain integration, please head to your company and within the advanced settings head to ...
    • Shipper Integration | DHL US

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to DHL US. Setup To setup the DHL US integration, please head to your company and within the advanced settings head to ...