LINQ to ShipEngine Data

This article illustrates using LINQ to access tables within the ShipEngine via the CData ADO.NET Data Provider for ShipEngine. To achieve this, we will use LINQ to Entity Framework, which facilitates the generation of connections and can be seamlessly employed with any CData ADO.NET Data Providers to access data through LINQ.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

1. In a new project in Visual Studio, right-click on the project and choose to add a new item. Add an ADO.NET Entity Data Model.
2. Choose EF Designer from Database and click Next.
3. Add a new Data Connection, and change your data source type to "CData ShipEngine Data Source".

4. Enter your data source connection information.

   Start by setting the Profile connection property to the location of the ShipEngine Profile on disk (e.g. C:\profiles\ShipEngine.apip). Next, set the ProfileSettings connection property to the connection string for ShipEngine (see below).

   ShipEngine API Profile Settings

   Retrieve your ShipEngine API Key from the Dashboard at app.shipengine.com under API Management.

   Below is a typical connection string:

   Profile=C:\profiles\ShipEngine.apip;ProfileSettings='APIKey=your_api_key';


5. If saving your entity connection to App.Config, set an entity name. In this example we are setting APIEntities as our entity connection in App.Config.
6. Enter a model name and select any tables or views you would like to include in the model.

Using the entity you created, you can now perform select commands. For example:

APIEntities context = new APIEntities();

var batcherrorsQuery = from batcherrors in context.BatchErrors
  select batcherrors;

foreach (var result in batcherrorsQuery) {
  Console.WriteLine("{0} {1} ", result.Id, result.BatchId);
}

See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.