ShipStation Connector Setup

Version 21.0.8126


ShipStation Connector Setup


The ShipStation connector allows you to integrate ShipStation into your data flow by pushing or pulling data from ShipStation. Follow the steps below to connect ArcESB to ShipStation.

Establish a Connection

To allow ArcESB to use data from ShipStation, you must first establish a connection using login credentials. You can create the connection from either the connector configuration pane or the Connections tab of the Settings page.

Note:

  • The login process is only required the first time the connection is created.
  • Connections to ShipStation can be re-used across multiple ShipStation connectors.

From the Connector Configuration Pane

  1. Drag a ShipStation connector into an ArcESB flow and give it a name.

  2. In the Connector Configuration pane, click + Create next to the Connection drop-down list.

  3. The Add Connection modal appears. Provide the requested information:

    • Name — The static name of the connection. Set this as desired.
    • Type — This is always set to ShipStation.
    • API Key — The API key for your ShipStation account.
    • API Secret — The API secret for your ShipStation account.
  4. If needed, click Advanced to open the drop-down menu of advanced connection settings. These should not be needed in most cases.

  5. Click Test Connection to ensure that ArcESB can connect to ShipStation with the provided information. If an error occurs, check all fields and try again.

  6. Click + Add Connection to finalize the connection.

  7. In the Connection drop-down list of the connector configuration pane, select the newly-created connection.

  8. Click Save Changes.

From the Settings Page

  1. Open the Settings page, and then click the Connections tab.

  2. Click + Add to open the Connection Type modal.

  3. Click ShipStation, then click Next.

  4. Continue from step 3 above for Connection Configuration Pane.

Select an Action

After establishing a connection to ShipStation, you must choose the action that the ShipStation connector will perform. ArcESB can interact with ShipStation in 5 ways. The table below outlines each action and where it belongs in an ArcESB flow:

Action Description Position in Flow
Lookup Retrieves a value from ShipStation and inserts that value into an already-existing Arc message in the flow.
The Lookup Query determines what value the connector will retrieve from ShipStation. It should be formatted as a SQL query against the ShipStation tables.
Middle
Select Retrieves data from ShipStation and brings it into ArcESB.
You can use the Filter panel to add filters to the Select. These filters function similarly to WHERE clauses in SQL.
Beginning
Execute Stored Procedures Treats data coming into the connector as input for a stored procedure, and then passes the result down the flow.
You can click the Show Sample Data button to provide sample inputs to the selected Stored Procedure and preview the results.
Middle
Create Shipping Label Creates a shipping label in ShipStation. End