Access ShipStation Data in Anypoint Using SQL

Ready to get started?

Download for a free trial:

Download Now

Learn more:

ShipStation MuleSoft Connector



Create a simple Mule Application that uses HTTP and SQL with the CData Mule Connector for ShipStation to create a JSON endpoint for ShipStation data.

The CData Mule Connector for ShipStation connects ShipStation data to Mule applications enabling read functionality with familiar SQL queries. The Connector allows users to easily create Mule Applications to backup, transform, report, and analyze ShipStation data.

This article demonstrates how to use the CData Mule Connector for ShipStation inside of a Mule project to create a Web interface for ShipStation data. The application created allows you to request ShipStation data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData Mule Connector to create a Web interface for the 200+ available data sources.

  1. Create a new Mule Project in Anypoint Studio.
  2. Add an HTTP Connector to the Message Flow.
  3. Configure the address for the HTTP Connector.
  4. Add a CData ShipStation Connector to the same flow, after the HTTP Connector.
  5. Create a new Connection (or edit an existing one) and configure the properties to connect to ShipStation (see below). Once the connection is configured, click Test Connection to ensure the connectivity to ShipStation.

    Use the BASIC Authentication standard to connect.

    1. Login to your ShipStation account
    2. Click on the settings icon in the upper right corner. A column menu will show up on the left
    3. Click Account -> API Settings
    4. On the API Settings page, note the API Key and API Secret.

    Authenticating to ShipStation

    • APIKey: Set this to the API key from the API settings page.
    • APISecret: Set this to the Secret key from the API settings page.
  6. Configure the CData ShipStation Connector.
    1. Set the Operation to 'Select with Streaming'.
    2. Set the Query type to Dynamic.
    3. Set the SQL query to SELECT * FROM #[message.inboundProperties.'http.query.params'.get('table')] to parse the URL parameter table and use it as the target of the SELECT query. You can customize the query further by referencing other potential URL parameters.
  7. Add a Transform Message Component to the flow.
    1. Map the Payload from the input to the Map in the output.
    2. Set the Output script to the following to convert the payload to JSON:
      %dw 1.0
      %output application/json
      ---
      payload
              
  8. To view your ShipStation data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default) and pass a table name as the table URL parameter: http://localhost:8081?table=Tags
    The Tags data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with ShipStation data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the Mule Connector for ShipStation and see the CData difference in your Mule Applications today.