Build a Simple VCL Application for ShipStation Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

ShipStation FireDAC Components

Rapidly create and deploy powerful Delphi & C++Builder Apps that integrate with ShipStation.



How to build a simple VCL Application to view ShipStation data in RAD Studio using the CData FireDAC Components for ShipStation.

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData FireDAC Components for ShipStation, you gain access to live ShipStation data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve ShipStation data. This article will walk through connecting to ShipStation and creating a simple VCL application with the Form Designer.

Creating a VCL Application for ShipStation Data

The following instructions show how to use the Form Designer to create a simple VCL Forms application that shows the basic FireDAC objects needed to connect to ShipStation from any application.

The following example populates a TDBGrid control.

  1. Create a new VCL Forms Application.
  2. Drop a TFDPhysShipStationDriverLink and TFDConnection object onto the form.
  3. Double-click the TFDConnection object. The FireDAC Connection Editor is displayed. Select "CData.ShipStation" in the DriverId menu and configure the connection properties.

    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.

  4. Drop a TFDQuery object onto the form and set the properties below:

    • Connection - Set this property to the TFDConnection object, if this object is not already specified.
    • SQL - Click the button in the SQL property and enter a query.
    • Active - Set this property to true.
  5. Drop a TDataSource object onto the form and set the following property:

    • DataSet - In the menu for this property, select the name of the TFDQuery object.
  6. Drop a TDBGrid control onto the form and set the following property:

    • DataSource - Select the name of the TDataSource.
  7. Drop a TFDGUIxWaitCursor onto the form. This is required to avoid a run-time error.

You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.