Ready to get started?

Learn more about the CData ODBC Driver for UPS or download a free trial:

Download Now

Query UPS Data as a MySQL Database in Node.js

Execute MySQL queries against UPS data from Node.js.

You can use the SQL Gateway from the ODBC Driver for UPS to query UPS data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to UPS Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

The driver uses five pieces of information in order to authenticate its actions with the UPS service.

  • Server: This controls the URL where the requests should be sent. Common testing options for this are: https://wwwcie.ups.com/ups.app/xml and https://wwwcie.ups.com/webservices
  • AccessKey: This is an identifier that is required to connect to a UPS Server. This value will be provided to you by UPS after registration.
  • UserId: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
  • Password: This value is used for logging into UPS. This value is the one you chose to login with when registering for service with UPS.
  • AccountNumber: This is a valid 6-digit or 10-digit UPS account number.
  • PrintLabelLocation: This property is required if one intends to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to UPS data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query UPS from Node.js

The following example shows how to define a connection and execute queries to UPS with the mysql module. You will need the following information:

  • Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
  • Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
  • Database name: The DSN you configured for the MySQL remoting service.

Connect to UPS data and start executing queries with the code below:

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData UPS Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Senders', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();