ShipStation XML Integration Documentation

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 that works with most leading US couriers. It will enable you to book collections and generate carriers labels from the OMS Order Manager without duplicate import

To enable you need to

  1. Set up a Custom Store in Shipstation in Marketplace Stores for Gateway OMS
  2. Next you will need to to set up a shipstation callback URL
  3. The user name will be guid (i.e. 12345) and the password is your api key
  4. You can also set up some Automation Rules in Shipstation to handle the different Shipping Methods & Carriers specified in OMS
  5. Finally you will need to make sure you have set a rule to determine the package dimensions and weight for each product - these can be passed from OMS
  6. Once an order has been marked as "Despatched" in OMS the order will automatically transfer to Shipstation 

Order Processing Workflow


  • in Order Manager,
    • mark the order(s) as Dispatched, either manually or using the ‘scan and dispatch’ screen, but do not fill in a tracking number
  • in ShipStation,
    • click the Update icon at the top
    • new orders arrive in the ‘Awaiting Shipment’ area in the Orders screen
    • check that the carrier, service, dimensions and weight have been set
      • (your automatic rules will fill these in for most orders)
    • tick next to the order(s) and click Ship Orders at the top
    • labels will now be generated for these orders
  • follow your usual dispatch process from here


Which Orders go to ShipStation?

  • status must be ‘Dispatched’
  • tracking number must be blank


Technical Requirements for Order Data in Order Manager


  • shipping_country must be a 2-letter ISO code
  • shipping_method will be used when you set up rules in ShipStation, and is generally taken directly from whichever company puts the order into the system
  • for US addresses, shipping_address_3 must be the 2-letter state code


ShipStation Configuration


Add a new store with:

  • for Marketplace, choose “Custom Store”
  • for the username, enter the GUID  of the company submitting the orders, eg. 12345
  • for the password, enter the API Key for that company
  • for the URL, enter
  • for the “Awaiting Payment statuses” enter “unknown”
  • for the “Awaiting Shipment statuses” enter “ready”
  • for the “Shipped statuses” enter “shipped”
  • for the “Cancelled statuses” enter “cancelled”

Now set up automation rules as required, for example you could have:


  • a rule which looks for a certain SKU, and sets the package dimensions and weight
  • a rule which looks for a certain quantity of items and sets the carrier and service

    • Related Articles

    • XML (Generic Filesystem) Supplier Integration

      This video covers our XML supplier integration where we can pass orders details from OMS to an external system in an XML Format. We also call this integration "Generic Filesystem". For more information please reference this developer log - CLICK HERE ...
    • 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 ...
    • XML Accounting Integration

      The following video details the XML accounting integrations that Custom Gateway has created to allow order details once dispatched to pass to an XML file via SFTP to a location where they can be collected and imported into your accounts package.
    • 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. ...
    • YourSurprise Supplier Integration

      This is a new Supplier Integration made to connect with the YourSurprise API. Settings Username & Password: These are YourSurprise specific settings, They should be provided by YourSurprise to the customer when they set up an account with ...