Connect to X-Cart Data in DBArtisan

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart ODBC Driver

The X-Cart ODBC Driver is a powerful tool that allows you to connect with live data from X-Cart, directly from any applications that support ODBC connectivity.

Access X-Cart data like you would a database - read, write, and update X-Cart Orders, Products, Items, etc. through a standard ODBC Driver interface.

Use wizards in DBArtisan to configure X-Cart data as a data source.

The CData ODBC Driver for X-Cart seamlessly integrates X-Cart data into database management tools like DBArtisan by enabling you to access X-Cart data as a database. This article shows how to create an data source for X-Cart in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate X-Cart Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then follow the steps below to register X-Cart data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic ODBC.
  3. Enter a name for the data source and select the DSN.
  4. Finish the wizard to connect to X-Cart data. X-Cart entities are displayed in the Datasource Explorer.

You can now work with X-Cart data as you work with any other database. See the driver help documentation for more information on the queries supported by the X-Cart API.