VOOZH about

URL: https://www.cdata.com/kb/tech/shipstation-ado-devexpress.rst

⇱ DataBind ShipStation Data to the DevExpress Data Grid


DataBind ShipStation Data to the DevExpress Data Grid

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the CData ADO.NET Provider for ShipStation with the DevExpress Windows Forms and Web controls to provide ShipStation data to a chart.

The ADO.NET Provider for ShipStation by CData incorporates conventional ADO.NET data access components compatible with third-party controls. You can adhere to the standard ADO.NET data binding procedures to establish two-way access to real-time data through UI controls. This article will demonstrate the utilization of CData components for data binding with DevExpress UI Controls (Windows Forms and Web controls), specifically binding to a chart that visualizes live data.

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.

Windows Forms Controls

The code below shows how to populate a DevExpress chart with ShipStation data. The ShipStationDataAdapter binds to the Series property of the chart control. The Diagram property of the control defines the x- and y-axes as the column names.

using (ShipStationConnection connection = new ShipStationConnection(
"APIKey='YourAPIKey';APISecret='YourAPISecret'")) {
 ShipStationDataAdapter dataAdapter = new ShipStationDataAdapter(
 "SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'", connection);
 
 DataTable table = new DataTable();
 dataAdapter.Fill(table);
 DevExpress.XtraCharts.Series series = new DevExpress.XtraCharts.Series();
 chartControl1.Series.Add(series);
 series.DataSource = table;
 series.ValueDataMembers.AddRange(new string[] { "Color" });
 series.ArgumentScaleType = DevExpress.XtraCharts.ScaleType.Qualitative;
 series.ArgumentDataMember = "Id";
 series.ValueScaleType = DevExpress.XtraCharts.ScaleType.Numerical;
 chartControl1.Legend.Visibility = DevExpress.Utils.DefaultBoolean.False;
 ((DevExpress.XtraCharts.SideBySideBarSeriesView)series.View).ColorEach = true; 
}
👁 The complete code example and the resulting chart.

Web Controls

The code below shows how to populate a DevExpress Web control with ShipStation data. The ShipStationDataAdapter binds to the Series property of the chart; the Diagram property defines the x- and y-axes as the column names.

using DevExpress.XtraCharts;

using (ShipStationConnection connection = new ShipStationConnection(
"APIKey='YourAPIKey';APISecret='YourAPISecret'"))
{
 ShipStationDataAdapter ShipStationDataAdapter1 = new ShipStationDataAdapter("SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'", connection);
 DataTable table = new DataTable();
 ShipStationDataAdapter1.Fill(table);
 DevExpress.XtraCharts.Series series = new Series("Series1", ViewType.Bar);
 WebChartControl1.Series.Add(series);
 series.DataSource = table;
 series.ValueDataMembers.AddRange(new string[] { "Color" });
 series.ArgumentScaleType = ScaleType.Qualitative;
 series.ArgumentDataMember = "Id";
 series.ValueScaleType = ScaleType.Numerical;
 ((DevExpress.XtraCharts.SideBySideBarSeriesView)series.View).ColorEach = true;
}
👁 An ASP.NET application created with the ADO.NET Provider and the DevExpress Web Forms control. (Salesforce is shown.)

Ready to get started?

Download a free trial of the ShipStation Data Provider to get started:

 Download Now

Learn more:

👁 ShipStation Icon
ShipStation ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with ShipStation.