Natively Connect to ShipStation Data in PHP

Drop the CData ODBC Driver for ShipStation into your LAMP or WAMP stack to build ShipStation-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to ShipStation 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.

Use the BASIC Authentication standard to connect.

1. Login to your ShipStation account
2. Click on the settings icon in the upper right corner. A column menu will show up on the left
3. Click Account -> API Settings
4. On the API Settings page, note the API Key and API Secret.

Authenticating to ShipStation

• APIKey: Set this to the API key from the API settings page.
• APISecret: Set this to the Secret key from the API settings page.

Establish a Connection

Open the connection to ShipStation by calling the or methods. To close connections, use or .

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

Connections opened with are closed when the script ends. Connections opened with the 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 ShipStation Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Tags WHERE CustomerId = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC ShipStation Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Tags WHERE CustomerId = ?");
$success = odbc_execute($query, array('1368175'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC ShipStation Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'");
 

Process Results

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

$conn = odbc_connect("CData ODBC ShipStation data Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

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

$conn = odbc_connect("CData ODBC ShipStation data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Tags WHERE CustomerId = ?");
$success = odbc_execute($query, array('1368175'));
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 ShipStation-specific adaptations of the PHP community documentation for all ODBC functions.