This article describes custom queries supported for ODBC, provides step-by-step details to set up Custom Queries, and explains how to reset default queries.
- The ODBC option is only available for ShipStation Enterprise accounts.
- Contact ShipStation Enterprise Support to enable this feature.
- Visit How can I contact ShipStation Support? (please see Step 4) to schedule a call.
- If you are not the developer who set up your database, do not attempt to make this connection. ShipStation ODBC is an advanced tool that connects ShipStation to an existing ODBC database. Please confer with your IT adviser first to see if ODBC is the best fit for your business needs.
ATTENTION DEVELOPERS and SYSTEM ADMINS:
- Back up all necessary data BEFORE connecting your ODBC database to ShipStation.
By default, ShipStation ODBC only imports orders from a single table or file. However, this standard query may not be the best option for your business needs. This can be the case if your data is in multiple tables, if you need to specify WHERE or GROUP BY clauses to improve performance, or if you need to restrict the importing data. In such cases, the better solution may be to create a View in your database.
NOTE: Any issues caused by custom queries fall beyond our troubleshooting scope! If you use ODBC beyond its default queries, ShipStation cannot troubleshoot any issues with order data transmitting improperly, nor any errors this may cause within your database.
ShipStation supports the following query types:
This query is required to import orders.
During import, this query determines how many orders will be loaded into the software. This query is required if using BatchOrder.
This query is used to post back status for imported orders. This query is optional if you do not wish to post back the tracking number, status, etc.
- If you attempt to import an order using Custom Queries and the required query type does not exist, the import will fail and you will receive an error.
- To resolve this issue, either disable Custom Queries or update your query to include the missing query type.
Step-by-step details to set up Custom Queries
1. Right-click the ShipStation ODBC icon and click Settings.
2. Select the store that needs to be updated and click Edit.
3. Click the checkbox for Custom Queries in the window that appears, and click Browse to locate the query you wish to customize.
An explorer window will open to a directory containing a readme file and sample queries. Your queries must be located in this directory.
- For more information about the ShipStation custom query variables, import DB column names, and postback values, consult the sample queries and Readme.txt file contained in the directory.
- These items are also included at the bottom of this article.
Please note that the following query names are the only available options:
4. Edit the store and uncheck the Custom Queries checkbox if you ever need to return to the standard queries.