Ready to get started?

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

 Download Now

Learn more:

eBay Icon eBay ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with eBay auction data including Items, Bidders, Transactions, and more!

Build MVC Applications with Connectivity to eBay Data



This article shows how to use only the Entity Framework and the CData ADO.NET provider to access eBay from an ASP.NET MVC application.

In this article, we will guide you through the process of utilizing wizards within Visual Studio to seamlessly integrate the CData ADO.NET Provider for eBay into a basic MVC (Model, View, Controller) project.

Create the Entity Framework Model

Follow the steps below to save connection properties and map tables to entities in the data model.

  1. Create a new MVC project in Visual Studio. In this example, the project name is MvcEbayApp.
  2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the eBay Entity Framework provider for your project. See the "LINQ and Entity Framework" chapter in the help documentation for a guide.

    Note that MVC 3 scaffolding and MVC 4 scaffolding do not support Entity Framework 6. You can use your scaffolding with Entity Framework 6 by upgrading to the latest version of MVC.

  3. To add the .edmx file from the designer, right-click your Models folder and click Add New Item. Select ADO.NET Entity Data Model, name the model, and click Add. In this example, the name of the model is EbayModel.
  4. In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
  5. Click New Connection. Select CData eBay Data Source in the dialog that is displayed.
  6. Specify the required connection string properties.

    If you will be accessing your own account, you can generate an OAuthAccessToken from your developer account dashboard. You can also allow other users to securely access their own accounts.

    Both of these methods require you to create an application key set to obtain values for the following connection properties: AppId, CertId, DevId, and SiteId.

    The user consent flow additionally requires the RuName and CallbackURL.

    See the "Getting Started" chapter in the help documentation for a guide to using OAuth.

    A typical connection string is below:

    AppId=MyAppId;CertId=MyCertId;DevId=MyDevId;SiteId=MySiteId;RuName=MyRuName;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
  7. Name the connection and select whether to include sensitive information, such as connection credentials, in the connection string. For simplicity, this example saves sensitive information in Web.config. The connection settings are saved as EbayEntities.

  8. Select the tables and views you need. In this example, ItemListing is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.
  9. Build your project to complete this step.

Scaffold the Controller and Views

Once you've established the model and completed the project build, you can employ ASP.NET Scaffolding wizards to generate both the controller and the views.

  1. In Solution Explorer, right-click the controllers folder and click Add -> Controller. Select MVC 5 Controller with views, using Entity Framework.
  2. In the Add Controller dialog that is then displayed, select the following options:

    • Model class: Select a table you imported; for example, ItemListing.
    • Data context class: Select your context class.
  3. Leave the default values for the other fields.

You can now access the list of ItemListing records at http://MySite/ItemListing. Next to each record are links to edit, delete, and see more information. You can also create new ItemListing records. With every state change the site picks up any data changes.