LINQ to X-Cart Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with X-Cart.



LINQ provides general-purpose query facilities in .NET Framework 3.0 and above and provides one easy way to programmatically access data through from CData ADO.NET Data Providers. This example uses LINQ to access information from the X-Cart Data Provider.

This article demonstrates how to use LINQ to access X-Cart tables through the CData ADO.NET Data Provider for X-Cart. To do this you will LINQ to Entity Framework, which is used to generate the connection and can be used with any CData ADO.NET Data Providers to access data via 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 X-Cart Data Source".
  4. Enter your data source connection information.

    An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

    • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
    • Search for REST API Module. Install the Module.
    • After the module has been installed, you need to set it up.
      • Go to the Settings section for the REST API Module.
      • On the settings page specify the API Key (only read)
    • Set the ApiKey and Url to the connection property to connect to data.

    Below is a typical connection string:

    Url=https://example.com/shop;ApiKey=MyApiKey;
  5. If saving your entity connection to App.Config, set an entity name. In this example we are setting XCartEntities 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:

XCartEntities context = new XCartEntities(); var profilesQuery = from profiles in context.PROFILES select profiles; foreach (var result in profilesQuery) { Console.WriteLine("{0} {1} ", result.Id, result.ProfileId); }

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