Natively Connect to X-Cart Data in PHP

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.



The CData ODBC driver for X-Cart enables you to create PHP applications with connectivity to X-Cart data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for X-Cart into your LAMP or WAMP stack to build X-Cart-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to X-Cart data, execute queries, and output the results.

Configure a DSN

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.

Establish a Connection

Open the connection to X-Cart by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC XCart Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC XCart Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM PROFILES WHERE Language = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC XCart Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM PROFILES WHERE Language = ?"); $success = odbc_execute($query, array('en'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC XCart Source","user","password"); $query = odbc_exec($conn, "SELECT ProfileId, FirstName FROM PROFILES WHERE Language = 'en'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC X-Cart data Source","user","password"); $query = odbc_exec($conn, "SELECT ProfileId, FirstName FROM PROFILES WHERE Language = 'en'"); while($row = odbc_fetch_array($query)){ echo $row["ProfileId"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC X-Cart data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM PROFILES WHERE Language = ?"); $success = odbc_execute($query, array('en')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are X-Cart-specific adaptations of the PHP community documentation for all ODBC functions.