ShipStation API Shipping Integration

ShipStation API Shipping Integration



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


Updated Shipstation API Shipping Integeration 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
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 - LINKED HERE

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 variant 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

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

    • Related Articles

    • ShipStation XML Integration Documentation

      While this ShipStation integration will still work as described here, we now have a ShipStation API integration which you should use in place of this.  Details of how to integrate with the ShipStation API can be found here. Shipstation is a service ...
    • MWW Supplier Integration

      Overview It is now possible to send orders directly to the MWW On Demand platform via the new Custom Gateway supplier integration. If you would like to take advantage of this feature, please contact Custom Gateway Support quoting your MWW API key. ...
    • Royal Mail Shipping API Shipping Integration

      OMS is now able to integrate directly with Royal Mail’s shipping API so that when an item is dispatched using a scan point, a shipment is created in Royal Mail’s system and an official Royal Mail shipping label returned to the user. OMS will only ...
    • Transglobal Express Shipping Integration

      OMS can integrate with Transglobal Express' shipping API so that when an item is dispatched using a scan point, a shipment is created in  Transglobal Express'  system and an official  Transglobal Express  shipping label is created for the user. You ...
    • Yodel Shipping Integration

      OMS can integrate with Yodel's shipping API so that when an item is dispatched using a scan point, a shipment is created in Yodels system and an official Yodel shipping label is created for the user. You must have an account with Yodel before you can ...