Getting Started

Connecting to eBay

For information on the available WHL files for supported environments, and how to install the appropriate file for your Python distribution, see Package Installation.

For information on the module to import, and how to configure the necessary connection properties in a connection string, see Establishing a Connection.

Other available connection properties can be used to configure other aspects of the connector capabilities.

Python Version Support

The CData Python Connector for eBay can be installed and used in Python 3.10 or newer.

eBay Version Support

The connector allows a relational view of entities from the Trading, FileTransfer, BulkData, Feedback, and Merchandising APIs.

Package Installation

Dependencies

The Python connectors require that Python 3.10 or newer be installed.

Installation

The CData Python Connector for eBay is available as a WHL file for Windows, Linux, and Mac. Each connector is built using the Python 3.10 Stable ABI (indicated by the abi3 tag in the filename), so a single wheel supports any Python 3.10 or newer installation — there is no need to match your exact Python minor version. Use the "pip install" command with the appropriate WHL file for your platform.

Windows:

pip install cdata_ebay_connector-26.0.9655-cp310-abi3-win_amd64.whl

Linux:

pip install cdata_ebay_connector-26.0.9655-cp310-abi3-linux_x86_64.whl

macOS:

pip install cdata_ebay_connector-26.0.9655-cp310-abi3-macosx_12_0_arm64.whl

The macOS wheel supports arm64 (Apple Silicon) architectures only on macOS 12 and newer.

Regardless of the environment, certain distributions might require that the "pip3 install" command be used instead, to differentiate from a Python 2 distribution that might exist already. After installation, confirm whether the connector is successfully installed by running the "pip list" command. If "cdata_ebay_connector" is present in the list output by the command, then the installation was successful.

Upgrading

When upgrading, "pip install" does not automatically clean up old JRE files. To avoid leftover files that could cause JVM errors, uninstall the previous version before installing the new one.

Licensing

After the installation is complete, a separate step is needed to activate a license for the connector. Among the CData assets in the distribution's site packages, there is an install-license tool that activates this license. From within the distribution's site-packages folder, after navigating to the "cdata/installlic_ebay" folder, simply use a command like the below to activate the license. Omitting the <key> argument activates a trial license:

Windows:
```
./install-license.exe <key>
```
Linux / Mac:
```
./install-license.sh <key>
```

Sometimes, file access issues may cause pip to install the connector in a fallback file path that is not the python distribution's main or primary site-packages location. This can make it difficult to find where the connector was installed, and from there, the license activator. In that event, this python script below will print out the full file path of the connector's native file. This file will be stored in the mentioned cdata folder, from which the installlic_ebay folder is trivial to find:

import os
import cdata.ebay
path = os.path.abspath(cdata.ebay.__file__)
print(path)

Uninstallation

If the connector needs to be uninstalled for any reason, do so by running the pip uninstall command, as in the example below:

pip uninstall cdata-ebay-connector

Establishing a Connection

The objects available within our connector are accessible from the "cdata.ebay" module. To use the module's objects directly:

Import the module as follows:
```
import cdata.ebay as mod
```

To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:

mod.connect("DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")

Connecting to eBay APIs

Set the following to connect to eBay:

SiteID: Set this to the eBay site ID. By default this is "0" (the U.S. site).
UseSandbox: Set this to True to use a eBay sandbox account. By default, the connector connects to production environments.
RuName: Set this to the RuName (eBay Redirect URL name) that you will use to sign-in. Find this in your eBay Sign-in Settings.

Authenticating to eBay

The connector can authenticate to eBay using either the OAuth 2.0 authentication standard or Auth'n'Auth, the traditional authentication used by the eBay APIs.

User Accounts (OAuth)

Set AuthScheme to OAuth.

Desktop Applications

You need to create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
CallbackURL: Set to a URL containing the server name and port of the device running the connector. Any localhost address is usable. The default callback URL is: http://localhost:33333.

When you connect, the connector opens eBay's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from eBay and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Web Applications

When connecting via a Web application, you need to register a custom OAuth app with eBay. You can then use the connector to get and manage the OAuth token values. See Creating a Custom OAuth App for more information.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

InitiateOAuth: Set this to OFF.
OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to a URL containing the server name and port of the device running the connector. For example: http://localhost:33333. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in, and authorize the web application. After authenticating, the browser redirects you to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter. This value will be BASE64 encoded, so it must be decoded before proceeding.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the (BASE64 decoded) code parameter in the query string of the redirect URI.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the connector automatically refresh the OAuth access token, set the following on the first data connection.

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
OAuthSettingsLocation: Set this to the location where you want the connector to save the OAuth values, which persist across connections.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token. Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver, use OAuth with a user account on a headless machine. You need to authenticate on another device that has an internet browser.

Choose one of two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.
Then configure the connector to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- Set the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set this to the App ID (Client ID) in your keyset.
  - OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL and RuName. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the connector. You are then redirected to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter. If you're using the recommended value https://oauth.cdata.com/oauth/ as your "auth accepted URL", this value will be BASE64 encoded. You will need to decode this value before proceeding. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: Set this to REFRESH.
OAuthVerifier: Set this to the noted verifier code (the value of the code parameter in the redirect URI).
OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
OAuthSettingsLocation: Set this to the location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

User Accounts with Legacy Apps (Auth'n'Auth)

The connector can authenticate using eBay's legacy Auth'n'Auth protocol. Select this authentication scheme if you're using an older application that was built to use Auth'n'Auth.

Set AuthScheme to AuthNAuth.

You need to create a custom OAuth application. See Creating a Custom OAuth App for more information.

Access Token

An OAuthAccessToken is required when authenticating via Auth'n'Auth. Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
DevID: Set this to the Developer ID from your keyset.

Then call stored procedures to complete the token exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the RuName input to the eBay Redirect URL you specified in your app settings. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in, and authorize the web application. After authenticating, the browser redirects you to the redirect URI. There will be a parameter called sessionid appended to the redirect URI. Note the value of this parameter. If you are using the recommeded https://oauth.cdata.com/oauth/ as your "auth accepted URL", the value will be BASE64 encoded and will need to be decoded before proceeding.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the SessionId input parameter to either the value of the 'sessionid' in the query string of the authorization URL or the BASE64 decoded session ID from the callback URL.

Set the following connection properties to connect to data:

OAuthClientId: Set this to the App ID (Client ID) in your keyset.
OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
OAuthAccessToken: Set this to the Auth'n'Auth token returned by GetOAuthAccessToken.
Note: Auth'n'Auth tokens expire after 18 months. You will need to generate a new token after the token expires.
DevID: Set this to the Developer ID from your keyset.

Configuring JNI

Java Native Interface (JNI) is a standard programming interface for writing Java native methods and embedding the Java virtual machine into native applications.

The connector leverages the JNI for improved performance on Mac and Linux.

Configure the Config INI File

The Linux and Mac editions of the eBay python connector are configured with an ini file. This file is used to set several parameters, including JNI behavior. This file is to be located in:

{path_to_distribution_site-packages}/cdata/config.ini

Ensure that any configuration properties you set in the ini file fall under the following section name (adjust the 311 number if you are using an different python version from 3.11):

For Linux:
```
[ebay.cpython-311-x86_64-linux-gnu.so]
```
For Mac:
```
[ebay.cpython-311-darwin.so]
```

Configure the JNI connector's behavior by editing the properties in the connector's config.ini file. The connector can be configured as follows:

LOGFILE: Set this the same way as the CDATA_LOGFILE envrionment variable below.
JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
CLASS_PATH: Use a colon-separated list to configure the paths to the third-party jar libraries.

Configure Environment Variables

Additionally, set the following environment variables:

CDATA_JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
CDATA_JVM_OPTIONS: Place JVM options here.
CDATA_LOGFILE: Set this in the following scheme: <SCHEME>://<TAG>[|<LEVEL>]
- SCHEME: The options are STDOUT, FILE.
  - STDOUT: Both the native wrapper and odbc core log into stdout. The Logfile and Verbosity properties can override the behavior of ODBC core.
  - FILE: The native wrapper logs into <FILENAME> while the odbc core logs into <FILENAME>.driver.log. The Logfile and Verbosity properties can override the behavior of ODBC core.
- TAG
  - For STDOUT, set this to 1. For FILE, set this to the filename.
- LEVEL
  - Set to one of: FATAL | ERROR | WARNING | INFO | DEBUG

The following are some examples of this syntax:

STDOUT://1|DEBUG
FILE:///tmp/my_py.log|DEBUG

Custom Logger

The Python connector supports a custom logging mechanism for redirecting log output to any destination, such as a cloud storage service or logging framework. Use setCustomLoggerFactory() to register a factory function that creates a logger instance for each connection.

The factory function receives the context string from the Logfile connection property (the portion after CUSTOM://) and must return an object with a writeLog(verbosity, message) method.

To enable custom logging:

Call setCustomLoggerFactory() with your factory function before opening connections.
Set Logfile to CUSTOM:// followed by a context string to identify the connection.
Set Verbosity to the desired log level.

The following example demonstrates a custom logger factory that creates a separate logger instance per connection:

import cdata.ebay as mod
import time

class MyLogger:
    def __init__(self, loggerId):
        self.loggerId = loggerId
    def writeLog(self, verbosity, message):
        print("[MyLogger " + self.loggerId + "] " + message)

def createLogger(context):
    return MyLogger(context[len("MyLoggerId="):])

mod.setCustomLoggerFactory(createLogger)

conn1 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=1;Verbosity=2;")
# do something with conn1
time.sleep(1)  # Wait for logs to flush from conn1

conn2 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=2;Verbosity=2;")
# do something with conn2
time.sleep(1)  # Wait for logs to flush from conn2

Creating a Custom OAuth App

There are two authentication methods available for connecting to eBay: using a token generated for accessing only personal data or using tokens that allow other users to access their own data. Both methods require you to join the eBay Developers Program.

Register and Get Your Keyset

After joining the eBay Developers Program, you can obtain the following values from the Developer Account Dashboard > Application Keysets page.

OAuthClientId (App ID)
DevID
OAuthClientSecret (Cert ID)

Creating an OAuth App

You can create OAuth apps meant to be used by either a single or multiple users. These scenarios are detailed in the following sections.

Single User

If you are working with your own account, follow the steps below to generate a token from eBay's user interface:

Go to your Developer Account Dashboard and open the User Access Tokens page.
Select the environment for your app.
- Select Production if you are searching for real items or listing real items to the live eBay site.
- Select Sandbox if you are creating test listings in the sandbox.
Underneath Get a User Token Here, select the authentication method to use when generating a token. OAuth tokens are valid for all eBay APIs (RESTful APIs and Traditional APIs), while Auth'n'Auth tokens are only valid for the Traditional APIs.
Click Sign in to Sandbox or Sign in to Production depending on the environment, and log in with credentials for either your sandbox or production eBay account.

Note: To enable OAuth authentication, you should check the OAuth Enabled checkbox under Your eBay Sign-in Settings for the RuName (eBay Redirect URL name) that you will be using to sign-in. If it is not enabled, then only the Auth'n'Auth authentication method will be supported. See the "Set Up an OAuth App" section for more information.

Multiple Users

eBay implements the OAuth authentication standard, which you can use to access your own data or allow other users to access their own data.

Follow the steps below to configure the user consent flow:

Go to your Developer Account Dashboard and open the User Access Tokens page.
Select the environment for your app.
- Select Production if you are searching for real items or listing real items to the live eBay site.
- Select Sandbox if you are creating test listings in the sandbox.
Underneath Your eBay Sign-in Settings in the Get a Token from eBay via Your Application section, add a new RuName (eBay Redirect URL) by clicking on Add eBay Redirect URL or expand the tab for the RuName that you will be using to authenticate.
Check the OAuth Enabled checkbox for your RuName. If it is not enabled, then only the Auth'n'Auth authentication method will be supported.
Set Your auth accepted URL to https://oauth.cdata.com/oauth/ since the eBay requires a secure Redirect URI (https) and does not accept a localhost URI.
Click Save to save your changes.
Select OAuth, then click Test Sign-In to verify that you can sign-in with your RuName.

Changelog

General Changes


Date	Version	Source	Category	Type	Description
2026-06-02	26.0.9649	eBay	Data Model	Removed	Removed the deprecated MostWatchedItems and SuggestedCategories views.
2026-05-27	26.0.9643	General	Connection	Removed	Removed the deprecated ReplaceInvalidTypesWithNull connection property. Use the ReplaceInvalidValuesWithNull property instead.
2026-05-22	26.0.9638	Python		Removed	Remove support for Intel x64 architecture on macOS
2026-05-07	26.0.9623	General	Data Model	Added	Added the ColumnCapabilities column to the sys_tablecolumns system table. This column is a bit mask denoting the column's write capabilities.
2026-05-07	26.0.9623	Python		Changed	Updated embedded JRE to jre-17.0.19+10 (Linux x64 / MacOs x64).
2026-05-06	26.0.9622	eBay	Data Model	Added	Added the following views: CategoryPolicies, ItemConditionPolicies, ItemConditions, ListingTypePolicies, MotorsListingPolicies, NegotiatedPricePolicies, and ShippingPolicies.
2026-05-06	26.0.9622	eBay	Data Model	Removed	Removed the deprecated Categories and CategoryFeatures views.
2026-05-05	26.0.9621	eBay	Data Model	Added	Added the following input parameters, which accept either JSON/XML aggregates or #TEMP table inputs: ItemSpecificsAggregate to the AddItem stored procedure. VariationSpecificsAggregate to the SetUserNotes stored procedure.
2026-05-05	26.0.9621	eBay	Data Model	Changed	Renamed the following parameters and removed the ability to provide multiple values for each: In the AddItem stored procedure: PictureUrl# to PictureUrl, ItemSpecificName# to ItemSpecificName, and ItemSpecificValue# to ItemSpecificValue. In the SetUserNotes stored procedure: VariationSpecificName# to VariationSpecificName and VariationSpecificValue# to VariationSpecificValue.
2026-04-15	26.0.9601	General	Query Exec	Changed	String comparisons using GREATER, LESS, and CONTAINS operators are now case-insensitive by default.
2026-04-08	26.0.9594	eBay	Security	Changed	TLS 1.3 is now supported by default for HTTP connections.
2026-03-30	26.0.9585	eBay	Data Model	Changed	Renamed all columns in the CategorySubtree, CategorySuggestions, CategoryTree, and ItemAspectsForCategory views, to begin with an uppercase letter. For example, the 'categoryName' column is renamed as 'CategoryName'.
2026-01-13	25.0.9509	General		Added	Added support for the REGEXP_REPLACE() string function.
2025-12-21	25.0.9486	Python		Added	Added support for custom loggers in Python connectors on Linux and macOS.
2025-12-05	25.0.9470	General		Added	Added support for the INSERT INTO SELECT statement, with driver-side execution for providers that do not support the operation natively.
2025-10-30	25.0.9434	Python		Changed	Updated embedded JRE to jre-17.0.17+10 (Linux x64 / MacOs x64).
2025-10-30	25.0.9434	eBay		Deprecated	The CategoryFeatures and Categories tables have been deprecated. While these tables may still return results, their functionality is no longer guaranteed.
2025-10-06	25.0.9410	General		Added	Support for parsing datetime formats using ".S" and ",S" for milliseconds and nanoseconds.
2025-09-12	25.0.9386	General		Added	Added the IsInsertable, IsUpdateable, and IsDeleteable columns to the sys_tables table.
2025-09-10	25.0.9384	General		Changed	All columns in statically defined Views are now reported as read-only.
2025-09-03	25.0.9377	General		Changed	Corrected the behavior when IN criteria with NULL values are used in the projection part. It now returns NULL instead of 0. For example, "NULL IN (1,2)" returns "NULL".
2025-09-01	25.0.9375	General		Added	Added support for using the CAST function with infinity values. This function can cast "inf" and "-inf" to DOUBLE, FLOAT, or REAL.
2025-08-21	25.0.9364	General		Changed	Report behavior change: Fixed inconsistent string value comparisons in non-table queries. For example, "SELECT 'A' = 'a'" previously returned false, but it now returns true.
2025-08-13	25.0.9356	General		Changed	Changed the maximum number of pages held in memory from 15 to 5 for the page providers to decrease heap usage.
2025-08-11	25.0.9354	eBay		Added	Added the connection property Scope.
2025-07-07	25.0.9319	Python		Removed	Removed the 32-bit version of Windows Python.
2025-07-02	25.0.9314	Python		Removed	Removed support for Python 3.9.
2025-06-25	25.0.9307	General		Removed	Removed the "ADLS Gen 1" value from the ConnectionType property.
2025-06-25	25.0.9307	Python		Added	Added support for Python 3.13 in Windows, Linux, and Mac editions.
2025-06-25	25.0.9307	Python		Removed	Removed support for Python 3.8 as it is no longer supported.
2025-06-20	25.0.9302	General		Added	Created the following functions: TEXT_ENCODE: encodes a string into a different charset (UTF8 → UTF7 and returns a binary array as the result). TEXT_DECODE: takes a binary array and decodes it back into a string when provided the charset. BASE64_ENCODE: takes a binary array and encodes it as a base64 string (varchar). BASE64_DECODE: takes a base 64-encoded string and decodes it into a binary array.
2025-06-18	25.0.9300	General		Changed	The internal code for exception handling has been refactored. Exception messages returned during certain error conditions may now have different wording or formatting.
2025-05-27	25.0.9278	General		Removed	Removed the "Proprietary" enum option from ProxyAuthscheme.
2025-05-12	25.0.9263	Python		Changed	Updated embedded JRE to jre-17.0.15+6 (Linux x64 / MacOS x64) and jre-17.0.15+6 (MacOS aarch64).
2025-04-01	25.0.9222	eBay		Removed	Removed the TopSellingProducts view.
2025-04-01	25.0.9222	eBay		Changed	The MostWatchedItems view is deprecated and usage is discouraged. The SuggestedCategories view is deprecated. Use CategorySuggestions instead.
2025-02-15	24.0.9177	General		Added	Added support for converting unsigned integer types to the nearest signed data type that has enough precision to hold the unsigned value.This is done for JDBC only because it does not have support for unsigned data types.
2024-11-27	24.0.9097	General		Added	Added ThreadId to LogModule output. Logfile lines now include the Thread ID associated with the action being performed.
2024-06-05	24.0.8922	Python		Added	Added support for Python 3.12.
2024-05-31	24.0.8917	eBay		Removed	Removed the Auto AuthScheme option. The default value for the AuthScheme connection property is now AuthNAuth.
2024-05-09	24.0.8895	General		Changed	The ROUND function previously did not accept negative precision values. That feature has now been restored.
2024-03-15	23.0.8840	General		Added	Created a new SQL function called STRING_COMPARE that provides java's String.compare() ability to SQL queries. Returns a number representative of the compared value of two strings
2024-02-21	23.0.8817	eBay		Changed	Removed MinimumRemnantSet and OriginatingPostalCode fields from AddItem stored procedure . These fields are deprecated. Removed OriginatingPostalCode field from TransactionShipping table. Replaced this field with new PostalCode field.
2023-12-20	23.0.8754	eBay		Added	Added new column 'Source' to the ItemSpecifics view.
2023-11-29	23.0.8733	General		Changed	The ROUND function doesn't accept the negative precision values anymore.
2023-11-29	23.0.8733	General		Changed	The returning types of the FDMonth, FDQuarter, FDWeek, LDMonth, LDQuarter, LDWeek functions are changed from Timestamp to Date. The return type of the ABS function will be consistent with the parameter value type.
2023-11-28	23.0.8732	General		Added	Added the HMACSHA256 formatter to allow for secrets to be decoded if it is in base64 format
2023-11-02	23.0.8706	eBay		Added	Added TransactionLinkedItems and TransactionRefunds views. Added ProductCompliancePolicyId, ProductCountryPolicy, ProductCountryPolicy, ProductCountryPolicy, TakeBackCountryPolicyId, TakeBackPolicyId of CustomPolicies container as inputs in AddItem stored procedure. Added ConditionAdditionalInfo, ConditionName, ConditionValue of ConditionDescriptors container as inputs in AddItem stored procedure.
2023-11-02	23.0.8706	eBay		Removed	Removed PayPalEmailAddress, ProductName, IntegratedMerchantCreditCardEnabled from ItemTransactions view. These fields are deprecated. Removed ExternalTransactionId, ExternalTransactionStatus, ExternalTransactionStatus, ExternalFeeOrCreditAmount, ExternalFeeOrCreditAmount, UnpaidItemType, UnpaidItemStatus from Transactions view. These fields are deprecated.
2023-08-29	23.0.8641	Python		Added	Added support for SQLAlchemy 2.0.
2023-06-20	23.0.8571	General		Added	Added the new sys_lastresultinfo system table.
2023-05-19	23.0.8539	Python		Added	Added support for Python 3.11 on Windows, Linux and Mac.
2023-05-16	23.0.8536	Python		Removed	Removed support for Python 3.7 on Windows and Linux
2023-05-08	23.0.8528	eBay		Replacements	Removed ActualDeliveryTime, EstimatedDeliveryTimeMax, EstimatedDeliveryTimeMin, HandleByTime, ScheduledDeliveryTimeMax, ScheduledDeliveryTimeMin, ShippingTrackingEvent and StoreId columns from TransactionShipping view. These are replaced by ShippingPackageInfo aggregate column.
2023-04-25	23.0.8515	General		Removed	Removed support for the SELECT INTO CSV statement. The core code doesn't support it anymore.
2022-12-14	22.0.8383	General		Changed	Added the Default column to the sys_procedureparameters table.
2022-11-17	22.0.8356	eBay		Added	Added PackageDepthUnit, PackageLengthUnit, PackageWidthUnit, WeightMajorUnit and WeightMinorUnit as inputs for AddItem. Added CreateOrderTask, CreateInventoryTask and GetResultFile as Stored Procedures, as a replacement for CreateReport and GetReport. Users can use the Tasks table, CreateInventoryTask or CreateOrderTask to create a download task, and download the generated file once completed using GetResultFile.
2022-11-17	22.0.8356	eBay		Removed	Removed ProductId from AddItem. Seller should use the ProductReferenceID field instead. Removed CalculatedShippingMeasurementSystem, CalculatedShippingMeasurementUnit, CalculatedShippingPackageLength, CalculatedShippingPackageDepth, CalculatedShippingPackageWidth from AddItem. These fields are deprecated. Package type, Package dimensions, and package weight should be specified in the ShippingPackageDetails container instead. For the provider, ShippingPackageDetails include:MeasurementUnit, MeasurementSystem, PackageDepth, PackageLength, PackageWidth, WeightMajor, WeightMinor. Removed Unit from AddItem, and added the following columns, PackageDepthUnit, PackageLengthUnit, PackageWidthUnit, WeightMajorUnit, WeightMinorUnit. Removed ThirdPartyCheckout from AddItem. Third-Party Checkout is no longer supported. Removed LinkedPayPalAccount, VerifiedUser, MinimumFeedbackScore, ZeroFeedbackScore from AddItem. No longer applicable and has been removed from the API. If this field is used, it will have no functional affect. Removed MaximumBuyerPolicyViolations, MaximumItemCount, MaximumBuyerPolicyViolationsPeriod. This type is no longer applicable and has been removed. Removed CategoryBasedAttributesPrefill. This field is no longer applicable, has no affect, and has been removed. Removed GalleryDuration. This feature has been completely removed. Removed MaximumUnpaidItemStrikesInfo, MaximumUnpaidItemStrikesInfoPeriod, TransactionId from AddItem. Removed CategorySpecifics table. GetCategorySpecifics has been deprecated and is no longer supported. Users should use the Taxonomy API's views instead, which include GetDefaultCategoryTreeId, GetCategoryTree, GetCategorySubtree, GetCategorySuggestions, GetItemAspectsForCategory, GetCompatibilityProperties and GetCompatibilityPropertyValues. Removed ListingType, ShipmentNotes from the CompleteSale Stored Procedure. These fields were only used to perform an action on Half.com, which was shut down. Removed the CreateDSRSummary Stored Procedure and DSRSummary table. Feedback API and DSR reports have been deprecated. Removed CreateReport and GetReport StoredProcedures. These are replaced by CreateOrderTask, CreateInventoryTask, GetResultFile and the Tasks table. Removed WarrantyDuration, WarrantyDurationOption, WarrantyOffered, WarrantyOfferedOption, WarrantyType, WarrantyTypeOption from ItemListing.
2022-11-17	22.0.8356	eBay		Changed	Renamed PossibleCompatibilites to PossibleCompatibilities in the ItemCompatibilityList table.
2022-11-17	22.0.8356	eBay		Replacements	Replaced CreateReport and GetReport with CreateOrderTask, CreateInventoryTask, GetResultFile and the Tasks table.
2022-11-15	22.0.8354	Python		Changed	Updated embedded JRE to jre8u345-b01(Linux x64 / MacOS x64) and jre-17.0.5+8(MacOS aarch64).
2022-11-03	22.0.8342	eBay		Added	Added GetDefaultCategoryTreeId, GetCategoryTree, GetCategorySubtree, GetCategorySuggestions, GetItemAspectsForCategory, GetCompatibilityProperties and GetCompatibilityPropertyValues Views.
2022-09-30	22.0.8308	General		Changed	Added the IsPath column to the sys_procedureparameters table.
2022-09-28	22.0.8306	eBay		Added	Added the new view SuggestedCategories.
2022-08-31	22.0.8278	eBay		Added	Added support for Output stream in GetReport as FileStream parameter.
2022-05-18	22.0.8173	Python		Added	Added support for Python 3.10 on Windows, Linux, and Mac Added support for Python 3.9 on Mac Added support for Mac M1
2022-05-18	22.0.8173	Python		Removed	Removed support for Python 3.6 on Windows and Linux
2021-12-20	21.0.8024	eBay		Added	Added support for an unlimited range of StartDateFrom-StartDateTo and EndDateFrom-EndDateTo for the ItemsListing table. Now is possible to query for 120 days and more.
2021-11-19	21.0.7993	eBay		Added	Added the Tasks table which includes SELECT and INSERT operations. Added the UploadFile Stored Procedure which initiates the upload task.
2021-10-27	21.0.7970	eBay		Removed	Removed the deprecated columns IncludeRecommendations and ShippingSurcharge from the AddItem stored procedure.
2021-09-02	21.0.7915	General		Added	Added support for the STRING_SPLIT table-valued function in the CROSS APPLY clause.
2021-08-07	21.0.7889	General		Changed	Added the KeySeq column to the sys_foreignkeys table.
2021-08-06	21.0.7888	General		Changed	Added the new sys_primarykeys system table.
2021-07-23	21.0.7874	General		Changed	Updated the Literal Function Names for relative date/datetime functions. Previously, relative date/datetime functions resolved to a different value when used in the projection as opposed to the predicate. For example: SELECT LAST_MONTH() AS lm, Col FROM Table WHERE Col > LAST_MONTH(). Formerly, the two LAST_MONTH() methods would resolve to different datetimes. Now, they will match. As a replacement for the previous behavior, the relative date/datetime functions in the criteria may have an 'L' appended to them. For example: WHERE col > L_LAST_MONTH(). This will continue to resolve to the same values that were previously calculated in the criteria. Note that the "L_" prefix will only work in the predicate - it not available for the projection.
2021-06-14	21.0.7835	eBay		Added	Added support for GetReturnPolicies, GetPaymentPolicies and GetFulfillmentPolicies Views. For all of them MarketplaceId is a required filter.
2021-04-25	21.0.7785	General		Added	Added support for handling client side formulas during insert / update. For example: UPDATE Table SET Col1 = CONCAT(Col1, " - ", Col2) WHERE Col2 LIKE 'A%'
2021-04-23	21.0.7783	General		Changed	Updated how display sizes are determined for varchar primary key and foreign key columns so they will match the reported length of the column.
2021-04-16	21.0.7776	General		Added	Non-conditional updates between two columns is now available to all drivers. For example: UPDATE Table SET Col1=Col2
2021-04-16	21.0.7776	General		Changed	Reduced the length to 255 for varchar primary key and foreign key columns.
2021-04-16	21.0.7776	General		Changed	Updated implicit and metadata caching to improve performance and support for multiple connections. Old metadata caches are not compatible - you need to generate new metadata caches if you are currently using CacheMetadata.
2021-04-16	21.0.7776	General		Changed	Updated index naming convention to avoid duplicates.
2020-09-15	20.0.7563	eBay		Added	Replaced the UseOAuth connection property with the AuthScheme connection property. Set the AuthScheme property to "OAuth" if you want to use OAuth 2.0 as an authentication method. If it is set to "AuthNAuth" or if it is not specified (auto), Auth'n'Auth will be used to authenticate.
2020-09-15	20.0.7563	eBay		Removed	Removed the UseOAuth input parameter from GetOAuthAccessToken and GetOAuthAuthorizationURL stored procedures. Depending on the configured AuthScheme connection property, these procedures will execute the operation that corresponds to either Auth'N'Auth or OAuth authentication method.

Using the Connector

This section provides a walk-through for writing eBay data access code in Python script.

For more information on the available data source entities and how to query them with SQL, see Data Model. For the SQL syntax, see SQL Compliance.

Connecting from Code

For information on how to deploy the connector and configure the connection to eBay, see Package Installation and Establishing a Connection.

For information on how to connect with the ebay.connector module and its related classes, see Connecting.

Executing SQL

The connection's cursor object is used to directly execute SQL queries. For information on how to execute SELECT statements and process the returned result sets, see Querying Data. For information on to modify the data in eBay with INSERT, UPDATE, and DELETE statements, see Modifying Data .

Executing Stored Procedures

You can call stored procedures by using the EXECUTE statement. For further information, see Calling Stored Procedures.

Connecting

Connecting with the cdata.ebay Module:

The connector's module is used directly to establish a connection with the data source. It does this by using a connection string as its argument. For example:

import cdata.ebay as mod
conn = mod.connect("DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")

Once the connection is created, you can use it to execute subsequent SQL queries.

Querying Data

After connecting as described in Connecting, you can use the open connection to execute SQL statements.

Executing Queries

To execute SQL statements that return data, use the execute() method. Once a query is executed, the result set is fetched from the cursor. This result set can then be iterated over to process the records individually.

For example:

cur = conn.execute("SELECT HitCount, Title FROM ItemListing")
rs = cur.fetchall()
for row in rs:
	print(row)

Parameterized Queries

Various Python collections, such as arrays and tuples, can act as additional arguments for the execute() method. This enables you to parameterize the queries executed and help to prevent SQL Injection.

For example:

cmd = "SELECT HitCount, Title FROM ItemListing WHERE AdminEndedItemsOnly = ?"
params = ["true"]
cur = conn.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

Modifying Data

The connection is also used to issue INSERT, UPDATE, and DELETE commands to the data source. Parameters can be used with these statements if desired.

Note that the connector does not support transactions. As with normal write operations, all SQL statements executed by this connector affect the data source immediately. Call the connection's commit() method following the execution.

Insert

The following example adds a new record to the table:

cmd = "INSERT INTO ItemListing (HitCount, Title) VALUES (?, ?)"
params = ["My Awesome Book", "My Awesome Book II"]
cur = conn.execute(cmd, params)
print("Records affected: ", cur.rowcount)

Update

The following example modifies an existing record in the table:

cmd = "UPDATE ItemListing SET Title = ? WHERE ItemId = ?"
params = ["My Awesome Book II", "Jq74mCczmFXk1tC10GB"]
cur = conn.execute(cmd, params)
print("Records affected: ", cur.rowcount)

Delete

The following example removes an existing record from the table:

cmd = "DELETE FROM ItemListing WHERE ItemId = ?"
params = ["Jq74mCczmFXk1tC10GB"]
cur = conn.execute(cmd, params)
print("Records affected: ", cur.rowcount)

Calling Stored Procedures

You can execute stored procedures using either the execute() or callproc() method of the connection.

Calling Stored Procedures Using Execute()

When you call stored procedures by issuing EXECUTE commands, the stored procedure arguments are parameterized. For example:

cmd = "EXECUTE AddItem BestOfferEnabled = ?"
params = ["false"]
conn.execute(cmd, params)

Calling Stored Procedures Using Callproc()

When you call stored procedured by issuing the callproc() method, the stored procedure arguments are a procedure name and a list of parameters. For example:

cur = conn.cursor()
params = ["false"]
cur.callproc("AddItem", params)

Using from Tools

The connector is integrated with other tools and packages within Python.

Python Integration Guides

The following sections show how to create and use connections with the connector in common packages in Python:

From SQLAlchemy
From Pandas
From Matplotlib
From Petl

Complete List of eBay Integration Quickstarts

For information on connecting from other applications, see eBay integration guides.

From SQLAlchemy

The CData Python Connector for eBay includes a Dialect class that enables integration with SQLAlchemy. Bear in mind that several aspects of connector functionality are not currently supported in SQLAlchemy 2.0 or above. If necessary, downgrade SQLAlchemy to version 1.4 or 1.3 before using this connector.

The following sections detail various aspects of this integration:

Connecting From SQLAlchemy

To construct a URL with which SQLAlchemy loads and uses the appropriate connector automatically, see Connecting

Reflecting Metadata With SQLAlchemy

To learn how to model eBay tables with mapped classes, see Reflecting Metadata.

Querying Data From SQLAlchemy

To learn how to use mapped classes to query the associated tables, see Querying Data.

Modifying Data From SQLAlchemy

The connector provides INSERT/UPDATE/DELETE functionality in SQLAlchemy. To learn how to call the session's execute() method to affect the data in the data source, see Modifying Data.

Connecting

Connecting With a Dialect URL

Establishing a connection using SQLAlchemy requires a specific URL format.

from sqlalchemy import create_engine
engine = create_engine("ebay:///?DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")

For SQLAlchemy 2.0, the dialect name is ebay_2. To establish a connection, use the following URL format:

from sqlalchemy import create_engine
engine = create_engine("ebay_2:///?DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")

Reflecting Metadata

SQLAlchemy can act as an Object-relational Map (ORM). This enables you to treat records of a database table as instantiable records. To leverage this functionality, you must reflect the underlying metadata in one of the following ways.

Note: The following examples employ SQLAlchemy 1.4.

Modeling Data Using a Mapping Class

Use "sqlalchemy.ext.declarative.declarative_base" to declare a mapping class for the table you wish to model in the ORM. A known table in the data model is modeled either partially or completely, as shown in the following example:

from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class ItemListing(Base):
	__tablename__ = "ItemListing"
	ItemId = Column(String, primary_key=True)
	HitCount = Column(String)
	Title = Column(String)

Automatically Reflecting Metadata

Rather than mapping tables manually, SQLAlchemy can discover the metadata for one or more tables automatically. To accomplish this across the entire data model, use automap_base:

from sqlalchemy import MetaData
from sqlalchemy.ext.automap import automap_base
meta = MetaData()
abase = automap_base(metadata=meta)
abase.prepare(autoload_with=engine)
ItemListing = abase.classes.ItemListing

You can also reflect a single table with an inspector. When reflecting this way, providing a list of specific columns to map is optional:

from sqlalchemy import MetaData, Table
from sqlalchemy import inspect
meta = MetaData()
insp = inspect(engine)
ItemListing_table = Table("ItemListing", meta)
insp.reflect_table(ItemListing_table, ["ItemId","Title"])

Querying Data

After you use the steps in Connecting to connect, and use one of the methods in Reflecting Metadata to reflect some of the metadata, you can use a session object to query data.

Querying Data Using the Query Method

If the mapping class has been prepared, use it with a session object to query the data source. After binding the engine to the session, provide the mapping class to the session's query method.

For example:

engine = create_engine("ebay:///?DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(ItemListing).filter_by(AdminEndedItemsOnly="true"):
	print("ItemId: ", instance.ItemId)
	print("HitCount: ", instance.HitCount)
	print("Title: ", instance.Title)
	print("---------")

Querying Data Using the Execute Method

The session object can also run the query with the execute() method alongside the appropriate Table object. Assuming you have an active session, the following is just as viable:

ItemListing_table = ItemListing.metadata.tables["ItemListing"]
for instance in session.execute(ItemListing_table.select().where(ItemListing_table.c.AdminEndedItemsOnly == "true")):
	print("Id: ", instance.Id)
	print("FullName: ", instance.Name)
	print("City: ", instance.BillingCity)
	print("---------")

Executing JOINs

Implicit Joining

If mapped classes of related eBay objects have a singular foreign key relationship, the classes are implicitly joined. After importing the necessary objects, a relationship is established between your two mapped classes, as in the example below:

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, String, Integer, DateTime, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship

Base = declarative_base()
class Contact(Base):
	__tablename__ = "Contact"
	Id = Column(Integer, primary_key=True)
	Name = Column(String)
	Email = Column(String)
	BirthDate = Column(DateTime)
	AccountId = Column(String, ForeignKey("Account.Id"))
	Account_Link = relationship("Account", back_populates="Contact_Link")

class Account(Base):
	__tablename__ = "Account"
	Id = Column(String, primary_key=True)
	Name = Column(String)
	BillingCity = Column(String)
	NumberOfEmployees = Column(Integer)
	Contact_Link = relationship("Contact", order_by=Contact.Id, back_populates="Account_Link")

Once the relationship is established, the tables are queried simultaneously using the session's query() method. For example:

rs = session.query(Account, Contact).filter(Account.Id == Contact.AccountId)
for Ac, Ct in rs:
  print("AccountId: ", Ac.Id)
  print("AccountName: ", Ac.Name)
  print("ContactId: ", Ct.Id)
  print("ContactName: ", Ct.Name)

Other Join Forms

In situations where mapped classes have either no foreign keys or multiple foreign keys, you may need different forms of the JOIN query to accommodate them. Using the earlier classes as examples, the following JOIN queries are possible as well:

Explicit condition (necessary if there are no foreign keys in your mapped classes):

rs = session.query(Account, Contact).join(Contact, Account.Id == Contact.AccountId)
for Ac, Ct in rs:

Left-to-right relationship:

rs = session.query(Account, Contact).join(Account.Contact_Link)
for Ac, Ct in rs:

Left-to-right relationship with explicit target:

rs = session.query(Account, Contact).join(Contact, Account.Contact_Link)
for Ac, Ct in rs:

String form of a left-to-right relationship:

rs = session.query(Account, Contact).join("Contact_Link")
for Ac, Ct in rs:

Other SQL Clauses

SQLAlchemy ORM also exposes support for other clauses in SQL, such as ORDER BY, GROUP BY, LIMIT, and OFFSET. All of these are supported by this connector:

ORDER BY

The following example sorts by a specified column using the session object's query() method:

rs = session.query(ItemListing).order_by(ItemListing.MinimumBestOfferPrice)
for instance in rs:
	print("ItemId: ", instance.ItemId)
	print("HitCount: ", instance.HitCount)
	print("Title: ", instance.Title)
	print("---------")

You can also use the session object's execute() method perform an ORDER BY. For example:

rs = session.execute(ItemListing_table.select().order_by(ItemListing_table.c.MinimumBestOfferPrice))
for instance in rs:

GROUP BY

The following example uses the session object's query() method to group records with a specified column:

rs = session.query(func.count(ItemListing.ItemId).label("CustomCount"), ItemListing.HitCount).group_by(ItemListing.HitCount)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("HitCount: ", instance.HitCount)
	print("---------")

You can also use the session object's execute() method to perform a GROUP BY:

rs = session.execute(ItemListing_table.select().with_only_columns([func.count(ItemListing_table.c.ItemId).label("CustomCount"), ItemListing_table.c.HitCount]).group_by(ItemListing_table.c.HitCount))
for instance in rs:

LIMIT and OFFSET

The following example uses the session object's query() method to skip the first 100 records and fetch the following 25:

rs = session.query(ItemListing).limit(25).offset(100)
for instance in rs:
	print("ItemId: ", instance.ItemId)
	print("HitCount: ", instance.HitCount)
	print("Title: ", instance.Title)
	print("---------")

You can also use the session object's execute() method to set a LIMIT or OFFSET:

rs = session.execute(ItemListing_table.select().limit(25).offset(100))
for instance in rs:

Aggregate Functions

Certain aggregate functions can also be used within SQLAlchemy by using the func module.

To import this module, execute:

from sqlalchemy.sql import func

Once func is imported, the following aggregate functions are available:

COUNT

The following example counts the number of records in a set of groups using the session object's query() method.

rs = session.query(func.count(ItemListing.ItemId).label("CustomCount"), ItemListing.HitCount).group_by(ItemListing.HitCount)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("HitCount: ", instance.HitCount)
	print("---------")

You can also execute COUNT using the session object's execute() method:

rs = session.execute(ItemListing_table.select().with_only_columns([func.count(ItemListing_table.c.ItemId).label("CustomCount"), ItemListing_table.c.HitCount])group_by(ItemListing_table.c.HitCount))
for instance in rs:

SUM

This example calculates the cumulative amount of a numeric column in a set of groups.

rs = session.query(func.sum(ItemListing.MinimumBestOfferPrice).label("CustomSum"), ItemListing.HitCount).group_by(ItemListing.HitCount)
for instance in rs:
	print("Sum: ", instance.CustomSum)
	print("HitCount: ", instance.HitCount)
	print("---------")

You can also invoke SUM using the session object's execute() method.

rs = session.execute(ItemListing_table.select().with_only_columns([func.sum(ItemListing_table.c.MinimumBestOfferPrice).label("CustomSum"), ItemListing_table.c.HitCount]).group_by(ItemListing_table.c.HitCount))
for instance in rs:

AVG

This example uses the session object's query() method to calculate the average amount of a numeric column in a set of groups:

rs = session.query(func.avg(ItemListing.MinimumBestOfferPrice).label("CustomAvg"), ItemListing.HitCount).group_by(ItemListing.HitCount)
for instance in rs:
	print("Avg: ", instance.CustomAvg)
	print("HitCount: ", instance.HitCount)
	print("---------")

You can also use the session object's execute() method to invoke AVG:

rs = session.execute(ItemListing_table.select().with_only_columns([func.avg(ItemListing_table.c.MinimumBestOfferPrice).label("CustomAvg"), ItemListing_table.c.HitCount]).group_by(ItemListing_table.c.HitCount))
for instance in rs:

MAX and MIN

This example finds the maximum value and minimum value of a numeric column in a set of groups.

rs = session.query(func.max(ItemListing.MinimumBestOfferPrice).label("CustomMax"), func.min(ItemListing.MinimumBestOfferPrice).label("CustomMin"), ItemListing.HitCount).group_by(ItemListing.HitCount)
for instance in rs:
	print("Max: ", instance.CustomMax)
	print("Min: ", instance.CustomMin)
	print("HitCount: ", instance.HitCount)
	print("---------")

You can also use the session object's execute() method to invoke MAX and MIN:

rs = session.execute(ItemListing_table.select().with_only_columns([func.max(ItemListing_table.c.MinimumBestOfferPrice).label("CustomMax"), func.min(ItemListing_table.c.MinimumBestOfferPrice).label("CustomMin"), ItemListing_table.c.HitCount]).group_by(ItemListing_table.c.HitCount))
for instance in rs:

Modifying Data

Commands can be executed individually by the session with a call to "execute()".

Obtaining the Table Object

The query supplied to this method is constructed using the associated Table object of a mapped class. This Table object is obtained from the mapped class's metadata field, as below:

ItemListing_table = ItemListing.metadata.tables["ItemListing"]

Once the table object is obtained, the write operations are executed in the following ways. The queries are executed immediately without the need for a call to "commit()":

Insert

The following example adds a new record to the table:

session.execute(ItemListing_table.insert(), {"HitCount": "My Awesome Book", "Title": "My Awesome Book II"})

Update

The following example modifies an existing record in the table:

session.execute(ItemListing_table.update().where(ItemListing_table.c.ItemId == "Jq74mCczmFXk1tC10GB").values(HitCount="My Awesome Book", Title="My Awesome Book II"))

Delete

The following example removes an existing record from the table:

session.execute(ItemListing_table.delete().where(ItemListing_table.c.ItemId == "Jq74mCczmFXk1tC10GB"))

From Pandas

When combined with the connector, Pandas can be used to generate data frames that contain your eBay data. Once created, a data frame can be passed to various other Python packages.

Connecting

Pandas relies on an SQLAlchemy engine to execute queries. Before you can use Pandas you must import it:

import pandas as pd
from sqlalchemy import create_engine
engine = create_engine("ebay:///?DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")

Querying Data

In Pandas, SELECT queries are provided in a call to the read_sql() method, alongside a relevant connection object. Pandas executes the query on that connection, and returns the results in the form of a data frame, which can be used for a variety of purposes.

df = pd.read_sql("""
	SELECT
	   HitCount,
	   Title,
     $exNumericCol;
	FROM ItemListing;""", engine)
print(df)

Modifying Data

To insert new records into a table, create a new data frame, and define its fields accordingly. When that is done, call to_sql() on the data frame to perform the INSERT operation with the connector, as shown in the example below. You must set the "if _exists" argument to "append" to prevent Pandas from attempting building the table from scratch. To prevent Pandas from writing the data frame index as a column, set index=False.

df = pd.DataFrame({"HitCount": ["My Awesome Book"], "Title": ["My Awesome Book II"]})
df.to_sql("ItemListing", con=engine, if_exists="append", index=False)

From Matplotlib

Matplotlib contains a number of tools that can graphically model eBay data after being fed a data frame From Pandas.

Using PyPlot

Before any Matplotlib tool, such as pyplot, can be used, it must be imported:

from matplotlib import pyplot as plt

Once a Pandas data frame is obtained, it can be used to create a plot visualizing eBay data. For example, the following plot generates and displays a bar graph relating HitCount and MinimumBestOfferPrice values:

df.plot(kind="bar", x="HitCount", y=["MinimumBestOfferPrice"])
plt.show()

From Petl

The connector can be used to create ETL applications and pipelines for CSV data in Python using Petl.

Install Required Modules

Install the Petl modules using the pip utility.

pip install petl

Connecting

After you import the modules, including the CData Python Connector for eBay, you can use the connector's connect function to create a connection using a valid eBay connection string. If you prefer not to use a direct connection, you can use a SQLAlchemy engine.

import petl as etl
import cdata.ebay as mod
cnxn = mod.connect("DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")

Extract, Transform, and Load the eBay Data

Create a SQL query string and store the query results in a DataFrame.

sql = "SELECT	HitCount, Title FROM ItemListing "
table1 = etl.fromdb(cnxn,sql)

Loading Data

With the query results stored in a DataFrame, you can load your data into any supported Petl destination. The following example loads the data into a CSV file.

etl.tocsv(table1,'output.csv')

Modifying Data

Insert new rows into eBay tables using Petl's appenddb function.

table1 = [['HitCount','Title'],['My Awesome Book','My Awesome Book II']]
etl.appenddb(table1,cnxn,'ItemListing')

Schema Discovery

The extension supports schema discovery by using SQL queries to available System Tables.

Using SQL

The following sections describe the discovery of metadata through several System Tables:

Tables and Views
Columns
Procedures

Tables and Views

The connector possesses system tables that are used to discover the tables and views available in the data model. Of these system tables, "sys_tables" and "sys_views" are used to fetch information about the available tables and views respectively:

Tables

import cdata.ebay as mod
conn = mod.connect("DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tables"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Views

import cdata.ebay as mod
conn = mod.connect("DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")
cur = conn.cursor()
cmd = "SELECT * FROM sys_views"
cur.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

Columns

The available columns for any given table are fetched from a system table called "sys_tablecolumns". A specific table name is provided in the WHERE criteria to restrict the table from which the column information is fetched:

import cdata.ebay as mod
conn = mod.connect("DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tablecolumns WHERE TableName = 'ItemListing'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Procedures

A system table called "sys_procedures" is queried to obtain the available stored procedures that are executed:

import cdata.ebay as mod
conn = mod.connect("DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedures"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Parameters

The input parameters of any stored procedure are similarly obtained from the "sys_procedureparameters" system table:

import cdata.ebay as mod
conn = mod.connect("DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'AddItem'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Advanced Features

This section details a selection of advanced features of the eBay connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the connector for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Caching Data

Caching Data enables faster access to data and reduces the number of API calls, improving performance. The connector supports a simple caching model where multiple connections can also share the cache over time. When configuring the cache connection, you can specify automatic or explicit data caching.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to eBay and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Exception Handling

For an overview of how exceptions are reported and the components of an exception, see Exception Handling.

User Defined Views

The CData Python Connector for eBay supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from a tool.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

Create a JSON-formatted configuration file defining the views you want.
DDL statements.

Defining Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM ItemListing WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Defining Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Working with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customizing the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to connect to other proxies, set ProxyAutoDetect to False and read further.

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the connector uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Caching Data

Caching data provides several benefits, including faster access to data and reducing the number of API calls, which improve performance. The connector supports a simple caching model where multiple connections can also share the cache over time. You can enable and configure caching features by setting the necessary connection properties.

Configuring the Cache Connection

Configuring the Caching Database

This section describes the properties for caching data to the persistent store of your choice.

CacheLocation

The CacheLocation property species the path to a file-system-based database. When caching is enabled, a file-system-based database is used by default. If CacheLocation is not specified, this database is stored at the path in Location. If neither of these connection properties are specified, the connector uses a platform-dependent default location.

CacheConnection

The CacheConnection property specifies a database driver and the connection string to the caching database.

CacheDriver and CacheProvider

Both the CacheDriver and CacheProvider properties are supported. Each specifies a database driver and the connection string to the caching database. CacheDriver is designed for Linux and MacOS; CacheProvider is Windows-based.

Automatically Caching Data

Automatically caching data is useful when you do not want to rebuild the cache for each query. When you query data for the first time, the connector automatically initializes and builds a cache in the background. When AutoCache = true, the connector uses the cache for subsequent query executions, resulting in faster response times.

Configuring Automatic Caching

Caching the ItemListing Table

The following example caches the ItemListing table in the file specified by the CacheLocation property of the connection string.

SELECT HitCount, Title FROM ItemListing WHERE AdminEndedItemsOnly = 'true'

Common Use Case

A common use for automatically caching data is to improve driver performance when making repeated requests to a live data source, such as building a report or creating a visualization. With auto caching enabled, repeated requests to the same data may be executed in a short period of time, but within an allowable tolerance (CacheTolerance) of what is considered "live" data.

Explicitly Caching Data

With explicit caching (AutoCache = false), you decide exactly what data is cached and when to query the cache instead of the live data. Explicit caching gives you full control over the cache contents by using CACHE Statements. This section describes some strategies to use the caching features offered by the connector.

Creating the Cache

To load data in the cache, issue the following statement.

CACHE SELECT * FROM tableName WHERE ...

Once the statement is issued, any matching data in tableName is loaded into the corresponding table.

Updating the Cache

This section describes two ways to update the cache.

Updating with the SELECT Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. However, this statement does not delete extra rows that are already in the cache. This statement only merges the new rows or updates the existing rows.

CACHE SELECT * FROM ItemListing WHERE AdminEndedItemsOnly = 'true'

Updating with the TRUNCATE Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. This statement can also delete rows in the cache table that are not present in the live data source.

  CACHE WITH TRUNCATE SELECT * FROM ItemListing WHERE AdminEndedItemsOnly = 'true'

Query the Data in Online or Offline Mode

This section describes how to query the data in online or offline mode.

Online: Select Cached Tables

You can use the tableName#CACHE syntax to explicitly execute queries to the cache while still online, as shown in the following example.

SELECT * FROM ItemListing#CACHE

Offline: Select Cached Tables

With Offline = true, SELECT statements always execute against the local cache database, regardless of whether you explicitly specify the cached table or not. Modification of the cache is disabled in Offline mode to prevent accidentally updating only the cached data. Executing a DELETE/UPDATE/INSERT statement while in Offline mode results in an exception.

The following example selects from the local cache but not the live data source because Offline = true.

SELECT * FROM ItemListing WHERE AdminEndedItemsOnly='true' ORDER BY Title ASC

Delete Data from the Cache

You can delete data from the cache by building a direct connection to the database. Note that the connector does not support manually deleting data from the cache.

Common Use Case

A common use for caching is to have an application always query the cached data and only update the cache at set intervals, such as once every day or every two hours. There are two ways in which this can be implemented:

AutoCache = false and Offline = false. All queries issued by the application explicitly reference the tableName#CACHE table. When the cache needs to be updated, the application executes a tableName#CACHE ... statement to bring the cached data up to date.
Offline = true. Caching is transparent to the application. All queries are executed against the table as normal, so most application code does not need to be aware that caching is done. To update the cached data, simply create a separate connection with Offline = false and execute a tableName#CACHE ... statement.

Data Type Mapping

The connector maps types from the data source to the corresponding data type available in the chosen cache database. The following table shows the mappings between the data types configured in the schema and the data types in the database. Some schema types have synonyms which are all listed in the Schema column.

Data Type Mapping

Note: String columns can map to different data types depending on their length.


Schema	.NET	JDBC	SQL Server	Derby	MySQL	Oracle	SQLite	Access
int, integer, int32	Int32	int	int	INTEGER	INT	NUMBER	integer	LONG
smallint, short, int16	Int16	short	smallint	SMALLINT	SMALLINT	NUMBER	integer	SHORT
double, float, real	Double	double	float	DOUBLE	DOUBLE	NUMBER	double	DOUBLE
date	DateTime	java.sql.Date	date	DATE	DATE	DATE	date	DATETIME
datetime, timestamp	DateTime	java.sql.Date	datetime	TIMESTAMP	DATETIME	TIMESTAMP	datetime	DATETIME
time, timespan	TimeSpan	java.sql.Time	time	TIME	TIME	TIMESTAMP	datetime	DATETIME
string, varchar	String	java.lang.String	If length > 4000: nvarchar(max), Otherwise: nvarchar(length)	If length > 32672: LONG VARCHAR, Otherwise VARCHAR(length)	If length > 255: LONGTEXT, Otherwise: VARCHAR(length)	If length > 4000: CLOB, Otherwise: VARCHAR2(length)	nvarchar(length)	If length > 255: LONGTEXT, Otherwise: VARCHAR(length)
long, int64, bigint	Int64	long	bigint	BIGINT	BIGINT	NUMBER	bigint	LONG
boolean, bool	Boolean	boolean	tinyint	SMALLINT	BIT	NUMBER	tinyint	BIT
decimal, numeric	Decimal	java.math.BigDecimal	decimal	DECIMAL	DECIMAL	DECIMAL	decimal	CURRENCY
uuid	Guid	java.util.UUID	nvarchar(length)	VARCHAR(length)	VARCHAR(length)	VARCHAR2(length)	nvarchar(length)	VARCHAR(length)
binary, varbinary, longvarbinary	byte[]	byte[]	binary(1000) or varbinary(max) after SQL Server 2000, image otherwise	BLOB	LONGBLOB	BLOB	BLOB	LONGBINARY

Query Processing

CData has a client-side SQL engine built into the connector library. This enables support for the full capabilities that SQL-92 offers, including filters, aggregations, functions, etc.

For sources that do not support SQL-92, the connector offloads as much of SQL statement processing as possible to eBay and then processes the rest of the query in memory (client-side). This results in optimal performance.

For data sources with limited query capabilities, the connector handles transformations of the SQL query to make it simpler for the connector. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The eBay Query Evaluation component examines SQL queries and returns information indicating what parts of the query the connector is not capable of executing natively.

The eBay Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.

There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.

More Information

For a full discussion of how CData handles query processing, see CData Architecture: Query Execution.

Logging

Capturing connector logging can be very helpful when diagnosing error messages or other unexpected behavior.

Basic Logging

To begin capturing connector logging, set these properties:

Logfile: A filepath that designates the name and location of the log file.
Verbosity: A numerical value (1-5) that determines the amount of detail in the log. See the page in the Connection Properties section for an explanation of the five levels.
MaxLogFileSize: When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
MaxLogFileCount: A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. Minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Once these properties are set, the connector populates the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it is created.

Log Verbosity

The verbosity level determines the amount of detail that the connector reports to the Logfile. Supported Verbosity levels range from 1 to 5.

The following list describes each level:


1	Setting Verbosity to 1 logs the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2	Setting Verbosity to 2 logs everything included in Verbosity 1, cache queries, and additional information about the request.
3	Setting Verbosity to 3 also logs HTTP headers, as well as the body of the request and the response.
4	Setting Verbosity to 4 also logs transport-level communication with the data source. This includes SSL negotiation.
5	Setting Verbosity to 5 also logs communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

For normal operations, Verbosity should not be set to greater than 1. At higher verbosities you can log substantial amounts of data, which can delay execution times.

To refine the logged content further by showing/hiding specific categories of information, see LogModules.

Sensitive Data

Verbosity levels of 3 and higher may capture information that you do not want shared outside of your organization. The following lists information of concern for each level:

Verbosity 3: The full body of the request and the response, which includes all the data returned by the connector
Verbosity 4: SSL certificates
Verbosity 5: Any extra transfer data not included at Verbosity 3, such as non human-readable binary transfer data

Note: Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.

Advanced Logging

You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property. This property allows you to filter the logging using a semicolon-separated list of logging modules.

Example property value:

LogModules=INFO;EXEC;SSL;SQL;META;

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:


Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

Exception Handling

Exceptions can be surfaced from either the API or the CData Python Connector for eBay. Each exception will have an error code, an error message, and a SQL state.

Error Codes

The error code classifies the type of error.


0	NONE	Used for unclassified errors and internally handled errors. This code also covers data source-specific errors that do not fit in any specific category.
65537	TCP_UNKNOWN_HOST	Unable to resolve a hostname (DNS failure).
65538	TCP_CONNECTION_REFUSED	Could not connect to the remote port.
65539	TCP_AUTH_FAILED	Login failed when using a binary authentication protocol. Use this for auth errors when the protocol is not HTTP (LDAP, SASL, Kerberos, ...).
65540	TCP_TIMEOUT	Did not receive a response after sending a request to the server.
65541	TCP_PROTOCOL	For wire protocol drivers. Either the server sent a bad packet that we are unable to process, or we cannot construct a packet to send.
131073	TLS_SERVER_UNTRUSTED	Could not verify SSL server certificate.
131074	TLS_CLIENT_UNTRUSTED	Server did not accept the client certificate we sent.
196609	OAUTH_DECRYPT_FAILED	OAuthEncryptKey did not decrypt the OAuthSettings file.
196610	OAUTH_MISSING_CLIENT_INFO	OAuthClientId / OAuthClientSecret / OAuthJWTCert is missing.
196611	OAUTH_MISSING_PROP	General OAuth property missing. OAUTH_MISSING_CLIENT_INFO is used for missing client ID/secret and JWT cert.
196612	OAUTH_NO_ACCESS_TOKEN	Unable to retrieve access token. Only use this when getting a token in GetOAuthAccessToken / RefreshOAuthAccessToken.
196613	OAUTH_TOKEN_EXPIRED	The access token expired. Normally used with a RefreshOAuth/OAuthException behavior.
196614	OAUTH_INVALID_PROP	OAuth property has an invalid value. OAUTH_MISSING_CLIENT_INFO / OAUTH_MISSING_PROP is used if the value is not set.
262145	HTTP_REQUEST_TIMEOUT	Did not receive a response from the HTTP server.
262146	HTTP_CLIENT_ERROR	Generic HTTP 4xx error. Only use for 4xx errors not covered by other codes.
262147	HTTP_AUTH_FAILED	HTTP 401 error.
262148	HTTP_LIMIT_EXCEEDED	HTTP 429 error.
262149	HTTP_SERVER_ERROR	HTTP 5xx error.
262150	HTTP_NOT_FOUND_ERROR	HTTP 404 error.
327681	CORE_TIMEOUT	General timeout. Not related to a specific network request.
327682	CORE_OP_NOT_ALLOWED	Operation blocked by provider permissions.
327683	CORE_CONNECTION_CONFIG	Connection configuration is not valid.
327684	CORE_SERIALIZE	Failed to encode data into a specific format (XML, JSON, CSV, ...).
327685	CORE_DESERIALIZE	Failed to decode data from a specific format (XML, JSON, CSV, ...).
393217	SQL_SYNTAX_ERROR	Unable to parse a SQL query.
393218	SQL_MISSING_COLUMNS	Query did not include required columns.
393219	SQL_MISSING_PARAMS	Stored procedure call did not include required parameters.
393220	SQL_QUERY_NOT_SUPPORTED	A part of the query is not allowed in the current context.
458753	SSH_SERVER_UNTRUSTED	Could not verify SSH server.
524289	STORAGE_LIST_EXCEPTION	Issue listing storage resources.
524290	STORAGE_RESOURCE_NOT_FOUND	Issue finding storage resources.
524291	STORAGE_ROOT_RESOURCE_NOT_FOUND	The root resource (bucket/share/drive) was not found; cannot create it in flat file drivers.
524292	STORAGE_RESOURCE_NOT_A_DIRECTORY	Storage resource is not a directory.
524293	STORAGE_RESOURCE_NOT_A_FILE	Storage resource is not a file.
524294	STORAGE_PERMISSIONS_DENIED	Storage permissions denied.

SQL State

The SQL state is used when throwing generic provider errors to the wrapper and indicates the success or failure of a call.

Some of the common SQL states are listed below:


07007	REQUIRED_CLAUSE	Class Code 07: Dynamic SQL Error.
08001	OPEN_CONNECTION	Class Code 08: Connection Exception. The connection was unable to be established to the application server or other server.
08004	REJECT_CONNECTION	The application server rejected establishment of the connection.
42501	PRIVILEGE_IDENTIFIED_OBJECT	Class Code 42: Syntax Error or Access Rule Violation. The authorization ID does not have the privilege to perform the specified operation on the identified object.
42506	AUTH_FAILED	Owner authorization failure occurred.
42601	SQL_SYNTAX	A character, token, or clause is invalid or missing.

Error Message

The error message provides more detailed reasoning about why the error occurred. It provides an explanation of the issue, and may include steps on how to resolve it.

SQL Compliance

The CData Python Connector for eBay supports several operations on data, including querying, deleting, modifying, and inserting.

SELECT Statements

See SELECT Statements for a syntax reference and examples.

See Data Model for information on the capabilities of the eBay API.

INSERT Statements

See INSERT Statements for a syntax reference and examples, as well as retrieving the new records' Ids.

UPDATE Statements

The primary key ItemId is required to update a record. See UPDATE Statements for a syntax reference and examples.

DELETE Statements

The primary key ItemId is required to delete a record. See DELETE Statements for a syntax reference and examples.

CACHE Statements

CACHE statements allow granular control over the connector's caching functionality. For a syntax reference and examples, see CACHE Statements.

For more information on the caching feature, see Caching Data.

EXECUTE Statements

Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.

Names and Quoting

Table and column names are considered identifier names; as such, they are restricted to the following characters: [A-Z, a-z, 0-9, _:@].
To use a table or column name with characters not listed above, the name must be quoted using square brackets ([name]) in any SQL statement.
Parameter names can optionally start with the @ symbol (e.g., @p1 or @CustomerName) and cannot be quoted.
Strings must be quoted using single quotes (e.g., 'John Doe').

SQL Functions

The connector provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.

The connector interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and connector syntax for the DATENAME function:

SQL Server:
```
SELECT DATENAME(yy,GETDATE())
```
connector:
```
SELECT DATENAME('yy',GETDATE())
```

String Functions

These functions perform string manipulations and return a string value. See STRING Functions for more details.

Date Functions

These functions perform date and date time manipulations. See DATE Functions for more details.

Math Functions

These functions provide mathematical operations. See MATH Functions for more details.

STRING Functions

ASCII(character_expression)

Returns the ASCII code value of the left-most character of the character expression.

character_expression: The character expression.

                      SELECT ASCII('0');
                      --  Result: 48

BASE64_ENCODE(input_binary)

Returns the Base64-encoded string form of a binary input.

input_binary: The binary value to encode.

                        SELECT BASE64_ENCODE(BinaryData);
                    -- Result: 'QmFzZTY0RW5jb2RlZA=='

BASE64_DECODE(input_string)

Returns the binary result of decoding a Base64-encoded string.

input_string: The Base64-encoded string.

                        SELECT BASE64_DECODE('QmFzZTY0RW5jb2RlZA==');
                    -- Result: (binary output)

CHAR(integer_expression)

Converts the integer ASCII code to the corresponding character.

integer_expression: The integer from 0 through 255.

                      SELECT CHAR(48);
                      -- Result: '0'

CHARINDEX(expressionToFind ,expressionToSearch [,start_location ])

Returns the starting position of the specified expression in the character string.

expressionToFind: The character expression to find.
expressionToSearch: The character expression, typically a column, to search.
start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT CHARINDEX('456', '0123456');
                      -- Result: 4

                      SELECT CHARINDEX('456', '0123456', 5);
                      -- Result: -1

CHAR_LENGTH(character_expression),

Returns the number of UTF-8 characters present in the expression.

character_expression: The set of characters to be evaluated for length.

				 SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
				 -- Result: 11

CONCAT(string_value1, string_value2, ..., string_valueN)

Returns the string that is the concatenation of two or more string values.

string_value1: The first string to be concatenated.
string_value2: The second string to be concatenated.
string_valueN: (optional) Any additional strings to be concatenated.

                      SELECT CONCAT('Hello, ', 'world!');
                      -- Result: 'Hello, world!'

CONTAINS(expressionToSearch, expressionToFind)

Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.

expressionToSearch: The character expression, typically a column, to search.
expressionToFind: The character expression to find.

                      SELECT CONTAINS('0123456', '456');
                      -- Result: 1

                      SELECT CONTAINS('0123456', 'Not a number');
                      -- Result: 0

ENDSWITH(character_expression, character_suffix)

Returns 1 if character_expression ends with character_suffix; otherwise, 0.

character_expression: The character expression.
character_suffix: The character suffix to search for.

                      SELECT ENDSWITH('0123456', '456');
                      -- Result: 1

                      SELECT ENDSWITH('0123456', '012');
                      -- Result: 0

FILESIZE(uri)

Returns the number of bytes present in the file at the specified file path.

uri: The path of the file from which to read the size.

				SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
				-- Result: 23684

FORMAT(value [, parseFormat], format )

Returns the value formatted with the specified format.

value: The string to format.
format: The string specifying the output syntax of the date or numeric format.
parseFormat: The string specifying the input syntax of the date value. Not applicable to numeric types.

                      SELECT FORMAT(12.34, '#');
                      -- Result: 12

                      SELECT FORMAT(12.34, '#.###');
                      -- Result: 12.34

                      SELECT FORMAT(1234, '0.000E0');
                      -- Result: 1.234E3
                      
                      SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
                      -- Result: 2019-01-01
                      
                      SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
                      -- Result: '2019-01-01'

HASHBYTES(algorithm, value)

Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.

algorithm: The algorithm to use for hashing. Must be one of MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, or SHA3_512.
value: The value to hash. Must be either a string or byte array.

                      SELECT HASHBYTES('MD5', 'Test');
                      -- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B

INDEXOF(expressionToSearch, expressionToFind [,start_location ])

Returns the starting position of the specified expression in the character string.

expressionToSearch: The character expression, typically a column, to search.
expressionToFind: The character expression to find.
start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT INDEXOF('0123456', '456');
                      -- Result: 4

                      SELECT INDEXOF('0123456', '456', 5);
                      -- Result: -1

ISALPHABETIC(character_expression)

Returns 1 if the character expression consists only of alphabetic characters; otherwise, 0.

character_expression: The string expression to evaluate.

                      SELECT ISALPHABETIC('Hello');
                      -- Result: 1

                      SELECT ISALPHABETIC('Hello123');
                      -- Result: 0

                      SELECT ISALPHABETIC('Hello!');
                      -- Result: 0

ISALPHANUMERIC(character_expression)

Returns 1 if the character expression consists only of alphabetic and numeric characters; otherwise, 0.

character_expression: The string expression to evaluate.

                      SELECT ISALPHANUMERIC('Hello123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('Hello.123');
                      -- Result: 0

ISNUMERIC(character_expression)

Returns 1 if the character expression consists only of numeric digits and up to one decimal point; otherwise, 0.

character_expression: The string expression to evaluate.

                      SELECT ISNUMERIC('123');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45.67');
                      -- Result: 0

                      SELECT ISNUMERIC('12a3');
                      -- Result: 0

JSON_EXTRACT(json, jsonpath)

Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to extract.
jsonpath: The XPath used to select the nodes. The JSONPath must be a string constant. The values of the nodes selected will be returned in a token-separated list.

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
                      -- Result: '{"data":1}'

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
                      -- Result: 1

                      SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
                      -- Result: 2

LEFT ( character_expression , integer_expression )

Returns the specified number of characters counting from the left of the specified string.

character_expression: The character expression.
integer_expression: The positive integer that specifies how many characters will be returned counting from the left of character_expression.

                      SELECT LEFT('1234567890', 3);
                      -- Result: '123'

LEN(string_expression)

Returns the number of characters of the specified string expression.

string_expression: The string expression.

                      SELECT LEN('12345');
                      -- Result: 5

LOCATE(substring,string)

Returns an integer representing how many characters into the string the substring appears.

substring: The substring to find inside larger string.
string: The larger string that is searched for the substring.
start locations: An optional integer that sets the character position (offset) from which to start searching.

				SELECT LOCATE('sample','XXXXXsampleXXXXX');
				-- Result: 6

                SELECT LOCATE('sample', 'XXXXXsampleXXXXX', 7)
                -- Result: 0

LOWER ( character_expression )

Returns the character expression with the uppercase character data converted to lowercase.

character_expression: The character expression.

                      SELECT LOWER('MIXED case');
                      -- Result: 'mixed case'

LTRIM(character_expression)

Returns the character expression with leading blanks removed.

character_expression: The character expression.

                      SELECT LTRIM('     trimmed');
                      -- Result: 'trimmed'

MASK(string_expression, mask_character [, start_index [, end_index ]])

Replaces the characters between start_index and end_index with the mask_character within the string.

string_expression: The string expression to be searched.
mask_character: The character to mask with.
start_index: The optional number of characters to leave unmasked at beginning of string. Defaults to 0.
end_index: The optional number of characters to leave unmasked at end of string. Defaults to 0.

                        SELECT MASK('1234567890','*',);
                        -- Result: '**********'
                        SELECT MASK('1234567890','*', 4);
                        -- Result: '1234******'
                        SELECT MASK('1234567890','*', 4, 2);
                        -- Result: '1234****90'

NCHAR(integer_expression)

Returns the Unicode character with the specified integer code as defined by the Unicode standard.

integer_expression: The integer from 0 through 65535 (0 through xFFFF).

OCTET_LENGTH(character_expression),

Returns the number of bytes present in the expression.

character_expression: The set of characters to be be evaluated.

				 SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
				 -- Result: 4

PATINDEX(pattern, expression)

Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.

pattern: The character expression that contains the sequence to be found. The wild-card character % can be used only at the start or end of the expression.
expression: The expression, typically a column, to search for the pattern.

                      SELECT PATINDEX('123%', '1234567890');
                      -- Result: 1

                      SELECT PATINDEX('%890', '1234567890');
                      -- Result: 8

                      SELECT PATINDEX('%456%', '1234567890');
                      -- Result: 4

POSITION(expressionToFind IN expressionToSearch)

Returns the starting position of the specified expression in the character string.

expressionToFind: The character expression to find.
expressionToSearch: The character expression, typically a column, to search.

                      SELECT POSITION('456' IN '123456');
                      -- Result: 4

                      SELECT POSITION('x' IN '123456');
                      -- Result: 0

QUOTENAME(character_string [, quote_character])

Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.

character_string: The string of Unicode character data. The string is limited to 128 characters. Inputs greater than 128 characters return null.
quote_character: An optional single character to be used as the delimiter. These include:
- a single quotation mark (')
- a left or right bracket ([])
- a double quotation mark (")
- a left or right parenthesis ( () )
- a greater or less than sign (><)
- a left or right brace ({})
- a backtick (`)
If quote_character is not specified brackets are used. If an unacceptable character is supplied, it returns NULL.

                      SELECT QUOTENAME('table_name');
                      -- Result: '[table_name]'

                      SELECT QUOTENAME('table_name', '"');
                      -- Result: '"table_name"'

                      SELECT QUOTENAME('table_name', '[');
                      -- Result: '[table_name]'

REGEXP_REPLACE(expr, pattern [, replacement [, position [, occurrence [, match_type]]]])

Replaces occurrences of a regular expression pattern in the input string with a specified value and returns the resulting string.

expr: The string expression to be searched.
pattern: The regular expression pattern to match.
replacement: (optional) The string to replace each matched occurrence of pattern with. Supports backreferences \1 through \9 and escape sequences \n, \r, \t, and \\. By default, this argument is an empty string, meaning matched portions are removed from the output string.
position: (optional) The 1-based starting position used when searching for regular expression matches in expr. The default is 1. All characters prior to the starting position are included in the output string unaltered. Skipped characters are ignored when calculating regular expression matches, even if they match pattern.
occurrence: (optional) Specifies whether all occurrences of pattern,, or only a specific occurrence of pattern are replaced. The default is 0, which means all occurrences of pattern are replaced with replacement. Set to 1 to only replace the first instance of the pattern; 2 to replace the second; etc.
match_type: (optional) Modifiers used to customize matching behavior. Supported values are: 'c' (case-sensitive, default), 'i' (case-insensitive), 'm' (multiline), 'n' (dot matches newline), 'x' (extended mode). These can be freely combined by including the letters back to back. For example, 'im' applies the functionality of both 'i' and 'm'. The regular expression syntax used is that of the Extended mode ('x') ignores whitespace and allows inline comments. If the pattern needs to match a literal space, it must be explicitly escaped.

                      SELECT REGEXP_REPLACE('abc123def456', '\d+', 'NUM');
                      -- Result: 'abcNUMdefNUM'

                      SELECT REGEXP_REPLACE('Hello\nHELLO\nhello', '^hello', 'X', 1, 0, 'im');
                      -- Result: 'X\nX\nX'

REPLACE(string_expression, string_pattern, string_replacement)

Replaces all occurrences of a string with another string.

string_expression: The string expression to be searched. This can be a character or binary data type.
string_pattern: The substring to be found. Cannot be an empty string.
string_replacement: The replacement string.

                      SELECT REPLACE('1234567890', '456', '|');
                      -- Result: '123|7890'

                      SELECT REPLACE('123123123', '123', '.');
                      -- Result: '...'

                      SELECT REPLACE('1234567890', 'a', 'b');
                      -- Result: '1234567890'

REPLICATE ( string_expression ,integer_expression )

Repeats the string value the specified number of times.

string_expression: The string to replicate.
integer_expression: The repeat count.

                      SELECT REPLACE('x', 5);
                      -- Result: 'xxxxx'

REVERSE ( string_expression )

Returns the reverse order of the string expression.

string_expression: The string.

                      SELECT REVERSE('1234567890');
                      -- Result: '0987654321'

RIGHT ( character_expression , integer_expression )

Returns the right part of the string with the specified number of characters.

character_expression: The character expression.
integer_expression: The positive integer that specifies how many characters of the character expression will be returned.

                      SELECT RIGHT('1234567890', 3);
                      -- Result: '890'

RTRIM(character_expression)

Returns the character expression after it removes trailing blanks.

character_expression: The character expression.

                      SELECT RTRIM('trimmed     ');
                      -- Result: 'trimmed'

SOUNDEX(character_expression)

Returns the four-character Soundex code, based on how the string sounds when spoken.

character_expression: The alphanumeric expression of character data.

                      SELECT SOUNDEX('smith');
                      -- Result: 'S530'

SPACE(repeatcount)

Returns the string that consists of repeated spaces.

repeatcount: The number of spaces.

                      SELECT SPACE(5);
                      -- Result: '     '

SPLIT(string, delimiter, offset)

Returns a section of the string between to delimiters.

string: The string to split.
delimiter: The character to split the string with.
offset: The number of the split to return. Positive numbers are treated as offsets from the left, and negative numbers are treated as offsets from the right.

                      SELECT SPLIT('a/b/c/d', '/', 1);
                      -- Result: 'a'
                      SELECT SPLIT('a/b/c/d', '/', -2);
                      -- Result: 'c'

STARTSWITH(character_expression, character_prefix)

Returns 1 if character_expression starts with character_prefix; otherwise, 0.

character_expression: The character expression.
character_prefix: The character prefix to search for.

                      SELECT STARTSWITH('0123456', '012');
                      -- Result: 1

                      SELECT STARTSWITH('0123456', '456');
                      -- Result: 0

STR ( float_expression [ , integer_length [ , integer_decimal ] ] )

Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.

float_expression: The float expression.
length: The optional total length to return. This includes decimal point, sign, digits, and spaces. The default is 10.
decimal: The optional number of places to the right of the decimal point. The decimal must be less than or equal to 16.

                      SELECT STR('123.456');
                      -- Result: '123'

                      SELECT STR('123.456', 2);
                      -- Result: '**'

                      SELECT STR('123.456', 10, 2);
                      -- Result: '123.46'

STUFF(character_expression , integer_start , integer_length , replaceWith_expression)

Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.

character_expression: The string expression.
start: The integer value that specifies the location to start deletion and insertion. If start or length is negative, null is returned. If start is longer than the string to be modified, character_expression, null is returned.
length: The integer that specifies the number of characters to delete. If length is longer than character_expression, deletion occurs up to the last character in replaceWith_expression.
replaceWith_expression: The expression of character data that will replace length characters of character_expression beginning at the start value.

                      SELECT STUFF('1234567890', 3, 2, 'xx');
                      -- Result: '12xx567890'

SUBSTRING(string_value FROM start FOR length)

Returns the part of the string with the specified length; starts at the specified index.

string_value: The character string.
start: The positive integer that specifies the start index of characters to return.
length: Optional. The positive integer that specifies how many characters will be returned.

                      SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
                      -- Result: '34'

                      SELECT SUBSTRING('1234567890' FROM 3);
                      -- Result: '34567890'

You can also drop the FROM and FOR clauses:

                    SELECT SUBSTRING('1234567890', 3, 2)
                    --Result: '34'
                    SELECT SUBSTRING('1234567890', 3)
                    --Result: '34567890'

TEXT_ENCODE(input_string, charset)

Returns binary output by encoding a string using the specified character set.

input_string: The plain text string.
charset: The character set to use, such as 'UTF-8', 'ISO-8859-1'.

                    SELECT TEXT_ENCODE('Café', 'UTF-8');
                    -- Result: (binary output)

TEXT_DECODE(input_binary, charset)

Returns a string decoded from binary data using the specified character set.

input_binary: The binary value to decode.
charset: The character set used for decoding.

                    SELECT TEXT_DECODE(BinaryData, 'UTF-8');
                    -- Result: 'Café'

TOSTRING(string_value1)

Converts the value of this instance to its equivalent string representation.

string_value1: The string to be converted.

                      SELECT TOSTRING(123);
                      -- Result: '123'

                      SELECT TOSTRING(123.456);
                      -- Result: '123.456'

                      SELECT TOSTRING(null);
                      -- Result: ''

TRIM(trimspec trimchar FROM string_value)

Returns the character expression with leading and/or trailing blanks removed.

trimspec: Optional. If included must be one of the keywords BOTH, LEADING or TRAILING.
trimchar: Optional. If included should be a one-character string value.
string_value: The string value to trim.

                      SELECT TRIM('     trimmed     ');
                      -- Result: 'trimmed'

                      SELECT TRIM(LEADING FROM '     trimmed     ');
                      -- Result: 'trimmed     '

                      SELECT TRIM('-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
                      -- Result: '-----trimmed'

UNICODE(ncharacter_expression)

Returns the integer value defined by the Unicode standard of the first character of the input expression.

ncharacter_expression: The Unicode character expression.

UPPER ( character_expression )

Returns the character expression with lowercase character data converted to uppercase.

character_expression: The character expression.

                      SELECT UPPER('MIXED case');
                      -- Result: 'MIXED CASE'

XML_EXTRACT(xml, xpath [, separator])

Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.

xml: The XML document to extract.
xpath: The XPath used to select the nodes. The nodes selected will be returned in a token-separated list.
separator: The optional token used to separate the items in the flattened response. If this is not specified, the separator will be a comma.

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
                      -- Result: 'a,e,i,o,u'

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
                      -- Result: 'a;e;i;o;u'

MATH Functions

ABS ( numeric_expression )

Returns the absolute (positive) value of the specified numeric expression.

numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT ABS(15);
                      -- Result: 15

                      SELECT ABS(-15);
                      -- Result: 15

ACOS ( float_expression )

Returns the arc cosine, the angle in radians whose cosine is the specified float expression.

float_expression: The float expression that specifies the cosine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ACOS(0.5);
                      -- Result: 1.0471975511966

ASIN ( float_expression )

Returns the arc sine, the angle in radians whose sine is the specified float expression.

float_expression: The float expression that specifies the sine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ASIN(0.5);
                      -- Result: 0.523598775598299

ATAN ( float_expression )

Returns the arc tangent, the angle in radians whose tangent is the specified float expression.

float_expression: The float expression that specifies the tangent of the angle to be returned.

                      SELECT ATAN(10);
                      -- Result: 1.47112767430373

ATN2 ( float_expression1 , float_expression2 )

Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.

float_expression1: The float expression that is the y-coordinate.
float_expression2: The float expression that is the x-coordinate.

                      SELECT ATN2(1, 1);
                      -- Result: 0.785398163397448

CEILING ( numeric_expression ) or CEIL( numeric_expression )

Returns the smallest integer greater than or equal to the specified numeric expression.

numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT CEILING(1.3);
                      -- Result: 2

                      SELECT CEILING(1.5);
                      -- Result: 2

                      SELECT CEILING(1.7);
                      -- Result: 2

COS ( float_expression )

Returns the trigonometric cosine of the specified angle in radians in the specified expression.

float_expression: The float expression of the specified angle in radians.

                      SELECT COS(1);
                      -- Result: 0.54030230586814

COT ( float_expression )

Returns the trigonometric cotangent of the angle in radians specified by float_expression.

float_expression: The float expression of the angle in radians.

                      SELECT COT(1);
                      -- Result: 0.642092615934331

DEGREES ( numeric_expression )

Returns the angle in degrees for the angle specified in radians.

numeric_expression: The angle in radians, an expression of an indeterminate numeric data type except for the bit data type.

                      SELECT DEGREES(3.1415926);
                      -- Result: 179.999996929531

EXP ( float_expression )

Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.

float_expression: The float expression.

                      SELECT EXP(2);
                      -- Result: 7.38905609893065

EXPR ( expression )

Evaluates the expression.

expression: The expression. Operators allowed are +, -, *, /, ==, !=, >, <, >=, and <=.

                      SELECT EXPR('1 + 2 * 3');
                      -- Result: 7

                      SELECT EXPR('1 + 2 * 3 == 7');
                      -- Result: true

FLOOR ( numeric_expression )

Returns the largest integer less than or equal to the numeric expression.

numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT FLOOR(1.3);
                      -- Result: 1

                      SELECT FLOOR(1.5);
                      -- Result: 1

                      SELECT FLOOR(1.7);
                      -- Result: 1

GREATEST(int1,int2,....)

Returns the greatest of the supplied integers.

				SELECT GREATEST(3,5,8,10,1)
				-- Result: 10

HEX(value)

Returns a the equivalent hex for the input value.

value: A string or numerical value to be converted into hex.

				SELECT HEX(866849198);
				-- Result: 33AB11AE
				
				SELECT HEX('Sample Text');
				-- Result: 53616D706C652054657874

JSON_AVG(json, jsonpath)

Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4.5

JSON_COUNT(json, jsonpath)

Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 2

JSON_MAX(json, jsonpath)

Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
                      -- Result: 4

JSON_MIN(json, jsonpath)

Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4

JSON_SUM(json, jsonpath)

Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.

json: The JSON document to compute.
jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 9

LEAST(int1,int2,....)

Returns the least of the supplied integers.

				SELECT LEAST(3,5,8,10,1)
				-- Result: 1

LOG ( float_expression [, base ] )

Returns the natural logarithm of the specified float expression.

float_expression: The float expression.
base: The optional integer argument that sets the base for the logarithm.

                      SELECT LOG(7.3890560);
                      -- Result: 1.99999998661119

LOG10 ( float_expression )

Returns the base-10 logarithm of the specified float expression.

float_expression: The expression of type float.

                      SELECT LOG10(10000);
                      -- Result: 4

MOD(dividend,divisor)

Returns the integer value associated with the remainder when dividing the dividend by the divisor.

dividend: The number to take the modulus of.
divisor: The number to divide the dividend by when determining the modulus.

				SELECT MOD(10,3);
				-- Result: 1

NEGATE(real_number)

Returns the opposite to the real number input.

real_number: The real number to find the opposite of.

				SELECT NEGATE(10);
				-- Result: -10
				
				SELECT NEGATE(-12.4)
				--Result: 12.4

PI ( )

Returns the constant value of pi.

                  SELECT PI()
                  -- Result: 3.14159265358979

POWER ( float_expression , y )

Returns the value of the specified expression raised to the specified power.

float_expression: The float expression.
y: The power to raise float_expression to.

                      SELECT POWER(2, 10);
                      -- Result: 1024

                      SELECT POWER(2, -2);
                      -- Result: 0.25

RADIANS ( float_expression )

Returns the angle in radians of the angle in degrees.

float_expression: The degrees of the angle as a float expression.

                      SELECT RADIANS(180);
                      -- Result: 3.14159265358979

RAND ( [ integer_seed ] )

Returns a pseudorandom float value from 0 through 1, exclusive.

seed: The optional integer expression that specifies the seed value. If seed is not specified, a seed value at random will be assigned.

                      SELECT RAND();
                      -- This result may be different, since the seed is randomized
                      -- Result: 0.873159630165044

                      SELECT RAND(1);
                      -- This result will always be the same, since the seed is constant
                      -- Result: 0.248668584157093

ROUND ( numeric_expression [ ,integer_length] [ ,function ] )

Returns the numeric value rounded to the specified length or precision.

numeric_expression: The expression of a numeric data type.
length: The optional precision to round the numeric expression to. When this is omitted, the default behavior will be to round to the nearest whole number.
function: The optional type of operation to perform. When the function parameter is omitted or has a value of 0 (default), numeric_expression is rounded. When a value other than 0 is specified, numeric_expression is truncated.

                      SELECT ROUND(1.3, 0);
                      -- Result: 1

                      SELECT ROUND(1.55, 1);
                      -- Result: 1.6

                      SELECT ROUND(1.7, 0, 0);
                      -- Result: 2

                      SELECT ROUND(1.7, 0, 1);
                      -- Result: 1
                      
                      SELECT ROUND (1.24);
                      -- Result: 1.0

SIGN ( numeric_expression )

Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.

numeric_expression: The expression of an indeterminate data type except for the bit data type.

                      SELECT SIGN(0);
                      -- Result: 0

                      SELECT SIGN(10);
                      -- Result: 1

                      SELECT SIGN(-10);
                      -- Result: -1

SIN ( float_expression )

Returns the trigonometric sine of the angle in radians.

float_expression: The float expression specifying the angle in radians.

                     SELECT SIN(1);
                     -- Result: 0.841470984807897

SQRT ( float_expression )

Returns the square root of the specified float value.

float_expression: The expression of type float.

                      SELECT SQRT(100);
                      -- Result: 10

SQUARE ( float_expression )

Returns the square of the specified float value.

float_expression: The expression of type float.

                      SELECT SQUARE(10);
                      -- Result: 100

                      SELECT SQUARE(-10);
                      -- Result: 100

TAN ( float_expression )

Returns the tangent of the input expression.

float_expression: The expression of type float.

                      SELECT TAN(1);
                      -- Result: 1.5574077246549

TRUNC(decimal_number,precision)

Returns the supplied decimal number truncated to have the supplied decimal precision.

decimal_number: The decimal value to truncate.
precision: The number of decimal places to truncate the decimal number to.

				SELECT TRUNC(10.3423,2);
				-- Result: 10.34

_ROW_NUMBER_()

Returns a row index as an additional column.

				SELECT ColumnName, _ROW_NUMBER_() FROM TableName
				-- Result: ColumnData, 0
				ColumnData2, 1
				ColumnData3, 2

DATE Functions

CURRENT_DATE()

Returns the current date value.

                  SELECT CURRENT_DATE();
                  -- Result: 2018-02-01

CURRENT_TIMESTAMP()

Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.

                  SELECT CURRENT_TIMESTAMP();
                  -- Result: 2018-02-01 03:04:05

DATEADD (datepart , integer_number , date [, dateformat])

Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.

datepart: The part of the date to add the specified number to. The valid values and abbreviations are
- year (yy, yyyy)
- quarter (qq, q)
- month (mm, m)
- week (wk, ww)
- weekday (dw)
- dayofyear (dy, y)
- day (dd, d)
- hour (hh)
- minute (mi, n)
- second (ss, s)
- millisecond (ms)
number: The number to be added.
date: The expression of the datetime data type.
dateformat: The optional output date format.

                  SELECT DATEADD('d', 5, '2018-02-01');
                  -- Result: 2018-02-06

                  SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
                  -- Result: 2018-02-01 05:00:00

DATEDIFF ( datepart , startdate , enddate )

Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.

datepart: The part of the date that is the time interval of the difference between the start date and end date. The valid values and abbreviations are:
- Year (year, yyyy, yy)
- Quarter (quarter, qq, q)
- Month (month, mm, m)
- Week (week, wk, ww)
- Weekday (weekday, dw)
- Dayofyear (dayofyear, dy, y)
- Day (day, dd, d)
- Hour (hour, hh)
- Minute (minute, mi, n)
- Second (second, ss, s)
- Millisecond (millisecond, ms)
startdate: The datetime expression of the start date.
enddate: The datetime expression of the end date.

                  SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
                  -- Result: 9

                  SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
                  -- Result: 12

DATE_FORMAT(date,format)

Returns the date or timestamp in the format specified. This function mirrors the MySQL DATE_FORMAT function.

date: A date or timestamp string.
format: The specifier string of the desired output format. The list of supported format specifiers comes from the MySQL DATE_FORMAT function (see link to MySQL documentation above).

					SELECT DATE_FORMAT('9/4/2021 3:11:53 AM','%h')
					-- Result: 03

DATEFROMPARTS(integer_year, integer_month, integer_day)

Returns the datetime value for the specified year, month, and day.

year: The integer expression specifying the year.
month: The integer expression specifying the month.
day: The integer expression specifying the day.

                    SELECT DATEFROMPARTS(2018, 2, 1);
                    -- Result: 2018-02-01

DATENAME(datepart , date)

Returns the character string that represents the specified date part of the specified date.

datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), and nanosecond (ns).
date: The datetime expression.

                     SELECT DATENAME('yy', '2018-02-01');
                     -- Result: '2018'

                     SELECT DATENAME('dw', '2018-02-01');
                     -- Result: 'Thursday'

DATEPART(datepart, date [,integer_datefirst])

Returns a character string that represents the specified date part of the specified date.

datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), nanosecond (ns), ISODOW, ISO_WEEK (isoweek, isowk,isoww), and ISOYEAR.
date: The datetime string.
datefirst: The optional integer representing the first day of the week. The default is 7, Sunday.

                    SELECT DATEPART('yy', '2018-02-01');
                    -- Result: 2018

                    SELECT DATEPART('dw', '2018-02-01');
                    -- Result: 5

DATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_milliseconds)

Returns the datetime value for the specified date parts.

year: The integer expression specifying the year.
month: The integer expression specifying the month.
day: The integer expression specifying the day.
hour: The integer expression specifying the hour.
minute: The integer expression specifying the minute.
seconds: The integer expression specifying the seconds.
milliseconds: The integer expression specifying the milliseconds.

                    SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
                    -- Result: 2018-02-01 01:02:03.456

DATETIME2FROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the datetime value for the specified date parts.

year: The integer expression specifying the year.
month: The integer expression specifying the month.
day: The integer expression specifying the day.
hour: The integer expression specifying the hour.
minute: The integer expression specifying the minute.
seconds: The integer expression specifying the seconds.
fractions: The integer expression specifying the fractions of the second.
precision: The integer expression specifying the precision of the fraction.

				    SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
                    -- Result: 2018-02-01 01:02:03.456

DATE_TRUNC(date, datepart)

Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.

date: The datetime string that specifies the date.
datepart: Refer to the Oracle documentation for valid datepart syntax.

				    SELECT DATE_TRUNC('05-04-2005', 'YY');
                    -- Result: '1/1/2005'
					
                    SELECT DATE_TRUNC('05-04-2005', 'MM');
                    -- Result: '5/1/2005'

DATE_TRUNC2(datepart, date, [weekday])

Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.

datepart: One of 'millennium', 'century', 'decade', 'year', 'quarter', 'month', 'week', 'day', 'hour', 'minute' or 'second'.
date: The datetime string that specifies the date.
weekday: The optional day of the week to use as the first day for 'week'. One of 'sunday', 'monday', etc.

                    SELECT DATE_TRUNC2('year', '2020-02-04');
                    -- Result: '2020-01-01'

                    SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
                    -- Result: '2020-02-02', which is the previous Monday

DAY(date)

Returns the integer that specifies the day component of the specified date.

date: The datetime string that specifies the date.

                    SELECT DAY('2018-02-01');
                    -- Result: 1

DAYNAME(date)

Returns the name of the day of the week of the specified date.

date: The datetime string that specifies the date.

                    SELECT DAYNAME('8/18/2021');
                    -- Result: Wednesday

DAYOFMONTH(date)

Returns the day of the month of the given date part.

date: The datetime string that specifies the date.

				  SELECT DAYOFMONTH('04/15/2000');
				  -- Result: 15

DAYOFWEEK(date)

Returns the day of the week of the given date part.

date: The datetime string that specifies the date.

				  SELECT DAYOFWEEK('04/15/2000');
				  -- Result: 7

DAYOFYEAR(date)

Returns the day of the year of the given date part.

date: The datetime string that specifies the date.

				  SELECT DAYOFYEAR('04/15/2000');
				  -- Result: 106

EOMONTH(date [, integer_month_to_add ]) or LAST_DAY(date)

Returns the last day of the month that contains the specified date with an optional offset.

date: The datetime expression specifying the date for which to return the last day of the month.
integer_month_to_add: The optional integer expression specifying the number of months to add to the date before calculating the end of the month.

                  SELECT EOMONTH('2018-02-01');
                  -- Result: 2018-02-28
                  
                  SELECT LAST_DAY('2018-02-01');
                  -- Result: 2018-02-28

                  SELECT EOMONTH('2018-02-01', 2);
                  -- Result: 2018-04-30

EXTRACT(date_part FROM date_column_name)

Returns the last day of the month that contains the specified date with an optional offset.

date_part: One of the following date components: YEAR, MONTH, DAY, HOUR, MINUTE, SECOND.
date_column_name: The name of a date column in a table.

                  SELECT EXTRACT(YEAR FROM DateColumn)
                  -- Result: 2021

FDWEEK(date)

Returns the first day of the week of the given date part.

date: The datetime string that specifies the date.
weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the week.

				  SELECT FDWEEK('02-08-2018');
				  -- Result: 2/4/2018

          SELECT FDWEEK('02-08-2018', 1)
          --Result: 02/11/2018

FDMONTH(date)

Returns the first day of the month of the given date part.

date: The datetime string that specifies the date.
month to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the month.

				  SELECT FDMONTH('02-08-2018');
				  -- Result: 2/1/2018

          SELECT FDMONTH('02-08-2018', 1) 
          --Result: 03/01/2018

FDQUARTER(date)

Returns the first day of the quarter of the given date part.

date: The datetime string that specifies the date.
quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the quarter.

				  SELECT FDQUARTER('05-08-2018');
				  -- Result: 4/1/2018

          SELECT FDQUARTER('05-08-2018',1)
          --Result: 07/01/2018

FILEMODIFIEDTIME(uri)

Returns the time stamp associated with the Date Modified of the relevant file.

uri: An absolute path pointing to a file on the local file system.

				 SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
				 -- Result: 6/25/2019 10:06:58 AM

FROM_DAYS(datevalue)

Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.

datevalue: A integer value representing the number of days since 1582-10-15.

				SELECT FROM_DAYS(736000);
				-- Result: 2/6/2015

FROM_UNIXTIME(time, issecond)

Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.

time: The time stamp value from epoch time. Milliseconds are accepted.
issecond: Indicates the time stamp value is milliseconds to epoch time.

                      SELECT FROM_UNIXTIME(1540495231, 1);
                      -- Result: 2018-10-25 19:20:31

                      SELECT FROM_UNIXTIME(1540495357385, 0);
                      -- Result: 2018-10-25 19:22:37

GETDATE()

Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.

                  SELECT GETDATE();
                  -- Result: 2018-02-01 03:04:05

GETUTCDATE()

Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.

In addition, GETUTCDATE can take an optional second parameter, a date and time that are converted to UTC.

                  SELECT GETUTCDATE();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

                  SELECT GETUTCDATE('2020/08/31 13:56:00')
                  --Result: '2020-08-31 17:56:00'

HOUR(date)

Returns the hour component from the provided datetime.

date: The datetime string that specifies the date.

				SELECT HOUR('02-02-2020 11:30:00');
				-- Result: 11

ISDATE(date, [date_format])

Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.

date: The datetime string.
date_format: The optional datetime format.

                      SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
                      -- Result: 1

                      SELECT ISDATE('Not a date');
                      -- Result: 0

LAST_WEEK()

Returns a time stamp equivalent to exactly one week before the current date.

				SELECT LAST_WEEK();	//Assume the date is 3/17/2020	
			 -- Result: 3/10/2020 00:00:00

LAST_MONTH()

Returns a time stamp equivalent to exactly one month before the current date.

	
				SELECT LAST_MONTH(); //Assume the date is 3/17/2020
				-- Result: 2/17/2020 00:00:00

LAST_YEAR()

Returns a time stamp equivalent to exactly one year before the current date.

				SELECT LAST_YEAR();	//Assume the date is 3/17/2020	
				-- Result: 3/10/2019 00:00:00

LDWEEK(date)

Returns the last day of the provided week.

date: The datetime string.
weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the week.

				SELECT LDWEEK('02-02-2020');
				-- Result: 2/8/2020

LDMONTH(date)

Returns the last day of the provided month.

date: The datetime string.
months to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the month.

				SELECT LDMONTH('02-02-2020');
				-- Result: 2/29/2020

        SELECT LDMONTH('02-08-2020', 1)
        --Result: 03/31/2020

LDQUARTER(date)

Returns the last day of the provided quarter.

date: The datetime string.
quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the quarter.

				SELECT LDQUARTER('02-02-2020');
				-- Result: 3/31/2020

        SELECT LDQUARTER('02-02-2020',1)
        --Result: 06/30/2020

MAKEDATE(year, days)

Returns a date value from a year and a number of days.

year: The year
days: The number of days into the year. Value must be greater than 0.

          SELECT MAKEDATE(2020, 1);
          -- Result: 2020-01-01

MINUTE(date)

Returns the minute component from the provided datetime.

date: The datetime string that specifies the date.

				SELECT MINUTE('02-02-2020 11:15:00');
				-- Result: 15

MONTH(date)

Returns the month component from the provided datetime.

date: The datetime string that specifies the date.

				SELECT MONTH('02-02-2020');
				-- Result: 2

QUARTER(date)

Returns the quarter associated with the provided datetime.

date: The datetime string that specifies the date.

				SELECT QUARTER('02-02-2020');
				-- Result: 1

SECOND(date)

Returns the second component from the provided datetime.

date: The datetime string that specifies the date.

				SELECT SECOND('02-02-2020 11:15:23');
				-- Result: 23

SMALLDATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute)

Returns the datetime value for the specified date and time.

year: The integer expression specifying the year.
month: The integer expression specifying the month.
day: The integer expression specifying the day.
hour: The integer expression specifying the hour.
minute: The integer expression specifying the minute.

                      SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
                      -- Result: 2018-02-01 01:02:00

STRTODATE(string,format)

Parses the provided string value and returns the corresponding datetime.

string: The string value to be converted to datetime format.
format: A format string which describes how to interpret the first string input. A few special formats are available as well, including UNIX, UNIXMILIS, TICKS, and FILETICKS.

				SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
				-- Result: 4/3/2020

SYSDATETIME()

Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.

                  SELECT SYSDATETIME();
                  -- Result: 2018-02-01 03:04:05

SYSUTCDATETIME()

Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.

                  SELECT SYSUTCDATETIME();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

TIMEFROMPARTS(integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the time value for the specified time and with the specified precision.

hour: The integer expression specifying the hour.
minute: The integer expression specifying the minute.
seconds: The integer expression specifying the seconds.
fractions: The integer expression specifying the fractions of the second.
precision : The integer expression specifying the precision of the fraction.

                      SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
                      -- Result: 01:02:03.456

TO_DAYS(date)

Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.

date: The datetime string that specifies the date.

				SELECT TO_DAYS('02-06-2015');
				-- Result: 736000

WEEK(date)

Returns the week (of the year) associated with the provided datetime.

date: The datetime string that specifies the date.

				SELECT WEEK('02-17-2020 11:15:23');
				-- Result: 8

YEAR(date)

Returns the integer that specifies the year of the specified date.

date: The datetime string.

                      SELECT YEAR('2018-02-01');
                      -- Result: 2018

Date Literal Functions

The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.

L_TODAY()

The current day.

  SELECT * FROM MyTable WHERE MyDateField = L_TODAY()

L_YESTERDAY()

The previous day.

  SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()

L_TOMORROW()

The following day.

  SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()

L_LAST_WEEK()

Every day in the preceding week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()

L_THIS_WEEK()

Every day in the current week.

  SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()

L_NEXT_WEEK()

Every day in the following week.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()

Also available:

L_LAST/L_THIS/L_NEXT MONTH
L_LAST/L_THIS/L_NEXT QUARTER
L_LAST/L_THIS/L_NEXT YEAR

L_LAST_N_DAYS(n)

The previous n days, excluding the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)

L_NEXT_N_DAYS(n)

The following n days, including the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)

Also available:

L_LAST/L_NEXT_90_DAYS

L_LAST_N_WEEKS(n)

Every day in every week, starting n weeks before current week, and ending in the previous week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)

L_NEXT_N_WEEKS(n)

Every day in every week, starting the following week, and ending n weeks in the future.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)

Also available:

L_LAST/L_NEXT_N_MONTHS(n)
L_LAST/L_NEXT_N_QUARTERS(n)
L_LAST/L_NEXT_N_YEARS(n)

SELECT Statements

A SELECT statement can consist of the following basic clauses.

SELECT
INTO
FROM
JOIN
WHERE
GROUP BY
HAVING
UNION
ORDER BY
LIMIT

SELECT Syntax

The following syntax diagram outlines the syntax supported by the SQL engine of the connector:

SELECT {
  [ TOP <numeric_literal> | DISTINCT ]
  { 
    * 
    | { 
        <expression> [ [ AS ] <column_reference> ] 
        | { <table_name> | <correlation_name> } .* 
      } [ , ... ] 
  }
  { 
    FROM <table_reference> [ [ AS ] <identifier> ] 
  } [ , ... ]
  [ [  
      INNER | { { LEFT | RIGHT | FULL } [ OUTER ] } 
    ] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ] 
  ] [ ... ] 
  [ WHERE <search_condition> ]
  [ GROUP BY <column_reference> [ , ... ]
  [ HAVING <search_condition> ]
  [ UNION [ ALL ] <select_statement> ]
  [ 
    ORDER BY 
    <column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
  ]
  [ 
    LIMIT <expression>
    [ 
      { OFFSET | , }
      <expression> 
    ]
  ] 
} | SCOPE_IDENTITY() 

<expression> ::=
  | <column_reference>
  | @ <parameter> 
  | ?
  | COUNT( * | { [ DISTINCT ] <expression> } )
  | { AVG | MAX | MIN | SUM | COUNT } ( <expression> ) 
  | NULLIF ( <expression> , <expression> ) 
  | COALESCE ( <expression> , ... ) 
  | CASE <expression>
      WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
    [ ELSE { <expression> | NULL } ]
    END 
  | {RANK() | DENSE_RANK()} OVER ([PARTITION BY <column_reference>] {ORDER BY <column_reference>})
  | <literal>
  | <sql_function> 

<search_condition> ::= 
  {
    <expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN | IS DISTINCT FROM | IS NOT DISTINCT FROM } [ <expression> ]
  } [ { AND | OR } ... ]

Examples

Return all columns:
```
SELECT * FROM ItemListing
```

Rename a column:

SELECT [Title] AS MY_Title FROM ItemListing

Cast a column's data as a different data type:

SELECT CAST(MinimumBestOfferPrice AS VARCHAR) AS Str_MinimumBestOfferPrice FROM ItemListing

Search data:

SELECT * FROM ItemListing WHERE AdminEndedItemsOnly = 'true'

Return the number of items matching the query criteria:
```
SELECT COUNT(*) AS MyCount FROM ItemListing 
```
Return the number of unique items matching the query criteria:
```
SELECT COUNT(DISTINCT Title) FROM ItemListing 
```
Return the unique items matching the query criteria:
```
SELECT DISTINCT Title FROM ItemListing 
```

Sort a result set in ascending order:

SELECT HitCount, Title FROM ItemListing  ORDER BY Title ASC

Restrict a result set to the specified number of rows:
```
SELECT HitCount, Title FROM ItemListing LIMIT 10 
```
Parameterize a query to pass in inputs at execution time. This enables you to create prepared statements and mitigate SQL injection attacks.
```
SELECT * FROM ItemListing WHERE AdminEndedItemsOnly = @param
```

See Explicitly Caching Data for information on using the SELECT statement in offline mode.

Pseudo Columns

Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from eBay.

    SELECT * FROM ItemListing WHERE Pseudo = '@Pseudo'

Aggregate Functions

For SELECT examples using aggregate functions, see Aggregate Functions.

JOIN Queries

See JOIN Queries for SELECT query examples using JOINs.

Date Literal Functions

Date Literal Functions contains SELECT examples with date literal functions.

Window Functions

See Window Functions for SELECT examples containing window functions.

Table-Valued Functions

See Table-Valued Functions for SELECT examples with table-valued functions.

Aggregate Functions

COUNT

Returns the number of rows matching the query criteria.

SELECT COUNT(*) FROM ItemListing WHERE AdminEndedItemsOnly = 'true'

COUNT(DISTINCT)

Returns the number of distinct, non-null field values matching the query criteria.

SELECT COUNT(DISTINCT HitCount) AS DistinctValues FROM ItemListing WHERE AdminEndedItemsOnly = 'true'

AVG

Returns the average of the column values.

SELECT Title, AVG(MinimumBestOfferPrice) FROM ItemListing WHERE AdminEndedItemsOnly = 'true'  GROUP BY Title

MIN

Returns the minimum column value.

SELECT MIN(MinimumBestOfferPrice), Title FROM ItemListing WHERE AdminEndedItemsOnly = 'true' GROUP BY Title

MAX

Returns the maximum column value.

SELECT Title, MAX(MinimumBestOfferPrice) FROM ItemListing WHERE AdminEndedItemsOnly = 'true' GROUP BY Title

SUM

Returns the total sum of the column values.

SELECT SUM(MinimumBestOfferPrice) FROM ItemListing WHERE AdminEndedItemsOnly = 'true'

JOIN Queries

The CData Python Connector for eBay supports standard SQL joins like the following examples.

Inner Join

An inner join selects only rows from both tables that match the join condition:

Left Join

A left join selects all rows in the FROM table and only matching rows in the JOIN table:

Window Functions

Window functions allow you to create computed fields from a group of rows (a window) that return a result for each row, as opposed to one computed result for a set of rows, as is the case with aggregate functions. The connector supports the following window function syntax.

Note: Window function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with window functions may not be optimal.

Window Function Clauses

OVER

The OVER clause defines the window over which window functions are performed.

SELECT A, B, <window function> OVER (<window frame>) FROM TableName

The <window function> refers to any supported window function clause, and the <window frame> refers to one or more clauses that specify the logic by which the window is defined.

PARTITION BY

The PARTITION BY clause subdivides a window into sub-windows called partitions. For each unique value in the column specified in the PARTITION BY clause, every record with that value collectively forms an individual partition.

SELECT A, B, <window function> OVER (PARTITION BY A ORDER BY B) From ItemListing

The <window function> refers to any supported window function clause.

Window Functions

The connector supports math, ranking, and analytic window functions.

Math

These window functions perform mathematical operations on the records within the window.

COUNT()

Calculates the number of records in each partition. The calculated column is of the data type "int".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT() OVER (PARTITION BY Role) FROM Employees

COUNT_BIG()

Calculates the number of records in each partition. The calculated column is of the data type "bigint".

In each partition, every record will display the total number of records in that partition.

SELECT Name, Role, Earnings, COUNT_BIG() OVER (PARTITION BY Role) FROM Employees

MIN(numeric_column)

Calculates the minimum value of a numerical column per partition.

In each partition, every record will display the minimum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MIN(Earnings) OVER (PARTITION BY Role) FROM Employees

MAX(numeric_column)

Calculates the maximum value of a numerical column per partition.

In each partition, every record will display the maximum value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MAX(Earnings) OVER (PARTITION BY Role) FROM Employees

SUM(numeric_column)

Calculates the sum of a numerical column per partition.

In each partition, every record will display the sum of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, SUM(Earnings) OVER (PARTITION BY Role) FROM Employees

AVG(numeric_column)

Calculates the average value of a numerical column per partition.

In each partition, every record will display the average value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, AVG(Earnings) OVER (PARTITION BY Role) FROM Employees

MEDIAN(numeric_column)

Calculates the median value of a numerical column per partition.

In each partition, every record will display the median value of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, MEDIAN(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEV(numeric_column)

Calculates the standard deviation of a numerical column per partition.

In each partition, every record will display the standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEV(Earnings) OVER (PARTITION BY Role) FROM Employees

STDEVP(numeric_column)

Calculates the population standard deviation of a numerical column per partition.

In each partition, every record will display the population standard deviation of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, STDEVP(Earnings) OVER (PARTITION BY Role) FROM Employees

VAR(numeric_column)

Calculates the statistical standard variance of a numerical column per partition.

In each partition, every record will display the statistical standard variance of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VAR(Earnings) OVER (PARTITION BY Role) FROM Employees

VARP(numeric_column)

Calculates the variance population of a numerical column per partition.

In each partition, every record will display the variance population of numeric_column across the records in that partition.

SELECT Name, Role, Earnings, VARP(Earnings) OVER (PARTITION BY Role) FROM Employees

Ranking

These window functions rank records that fall within the window and its partitions.

RANK()

Assigns a rank number to each record in a window based on the value of the column specified in the required ORDER BY clause.

If two or more records have an equal value in the in ranked column, they all receive the same rank number and the rank count increments internally, skipping ahead one rank number for each record with a duplicate value in the ORDER BY column.

SELECT HitCount, Title, RANK() OVER (ORDER BY Title) AS Rank FROM ItemListing

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT HitCount, Title, RANK() OVER (PARTITION BY HitCount ORDER BY Title) AS Rank FROM ItemListing

DENSE_RANK()

Operates like the RANK() function, but it doesn't increment the internal rank counter for each record with a duplicate value in the ranked column.

This means that, while records with identical values in the ORDER BY column still share a rank number, the function never skips a rank number.

SELECT HitCount, Title, DENSE_RANK() OVER (PARTITION BY HitCount ORDER BY Title) AS Rank FROM ItemListing

If you add a PARTITION BY clause, a separate set of ranks is calculated for each partition.

SELECT HitCount, Title, DENSE_RANK() OVER (PARTITION BY HitCount ORDER BY Title) AS Rank FROM ItemListing

ROW_NUMBER()

Calculates a row number for each record. An ORDER BY clause in the OVER clause is required.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (ORDER BY Role) FROM Employees

If you define multiple partitions with PARTITION BY, a new set of row numbers are calculated for each partition.

SELECT Name, Role, Earnings, ROW_NUMBER() OVER (PARTITION BY Role ORDER BY Earnings) FROM Employees

NTILE()

Distributes rows of an ordered partition into a specified number of approximately equal groups, or buckets. It assigns each group a bucket number starting from one. For each row in a group, the NTILE() function assigns a bucket number representing the group to which the row belongs.

The syntax of NTILE() is:

NTILE(buckets) OVER (
    [PARTITION BY partition_expression, ... ]
    ORDER BY sort_expression [ASC | DESC], ...
)

The following are paramaters that NTILE() supports:

buckets: The number of buckets into which the rows are divided. The buckets can be an expression or subquery that evaluates to a positive integer. It cannot be a window function.
PARTITION BY: distributes rows of a result set into partitions to which the NTILE() function is applied.
ORDER BY is clause that specifies the logical order of rows in each partition to which the NTILE() is applied.

If the number of rows is not divisible by the buckets, the NTILE() function returns groups of two sizes with the difference by one. The larger groups always precede the smaller group in the order set by ORDER BY in the OVER() clause.

If the total of rows is divisible by the number of buckets, the function divides the rows evenly among buckets. The following statement creates a new table named ntile_demo that stores 10 integers:

CREATE TABLE sales.ntile_demo (
	v INT NOT NULL
);
	
INSERT INTO sales.ntile_demo(v) 
VALUES(1),(2),(3),(4),(5),(6),(7),(8),(9),(10);	
	
SELECT * FROM sales.ntile_demo;

This statement uses the NTILE() function to divide ten rows into three groups:

SELECT 
	v, 
	NTILE (3) OVER (
		ORDER BY v
	) buckets
FROM 
	sales.ntile_demo;

Analytical

These window functions perform analytical operations on the records within the window.

PERCENT_RANK()

Calculates the relative rank SQL Percentile of each row. It returns values greater than zero, but the maximum value is one. It does not count any NULL values. This function is nondeterministic.

The syntax of PERCENT_RANK() is:

PERCENT_RANK() OVER (
      [PARTITION BY partition_expression, ... ]
      ORDER BY sort_expression [ASC | DESC], ...
  )

This syntax uses the following parameters.

PARTITION BY: By default, SQL Server treats the whole data set as a single set. You can specify the PARTITION BY clause to divide data into multiple sets. The Percent_Rank function performs the analytical calculations on each set. This parameter is optional.
ORDER BY: Sorts the data in either ascending or descending order. This parameter is required.

Table-Valued Functions

Table-valued functions are functions that return a table (rowset).

Note: Table-valued function support is an experimental feature of the connector. This functionality extends beyond the connector's core scope of being SQL-92 compliant. As such, performance with these functions may not be optimal.

Table-Valued Function Clauses

CROSS APPLY

The CROSS APPLY operator is used to perform a subquery on each row of a table or resultset produced by a preceding table expression.

<table_expression_1> CROSS APPLY <table_expression_2>

The second table expression can reference results from the first table expression to create derived columns or an altered recordset via a table-valued function.

Each resulting record is an instance of the record it's splitting, with all the same column values, except for the column(s) containing the value split by the function.

WITH

The WITH clause is used alongside certain table-valued functions to match against constructs within the structure being split (keys, element names, attribute names, etc.) and/or to specify metadata for the columns generated from the function.

SELECT A.ColumnName, X.DerivedColumnName FROM TableName A CROSS APPLY <table-valued function> WITH (DerivedColumnName varchar(255)) AS X

Table-Valued Functions

STRING_SPLIT(input_text,delimiter)

Takes each record in the recordset of the preceding table expression, splits the column containing delimiters (input_text) into substrings separated by the delimiter, and returns one record per substring.

input_text: A column whose value you want to parse.
delimiter: The character used to split the value of the column specified in input_text.

Suppose there is a column called "SplitColumn" with the following content:

One-Two-Three

To unpack this value across multiple records:

SELECT A.ID, X.Value FROM [TableWithDelimitedStringField] A CROSS APPLY STRING_SPLIT(A.SplitColumn,'-') WITH (Value VARCHAR(255)) AS X

-- Results:
-----------
|ID|Value|
|1|One|
|1|Two|
|1|Three|

JSONTABLE(json_content,[jsonpath])

For each record in the recordset of the preceding table expression, returns one record for each instance of a key in a JSON array (json_content) that matches the key(s) specified in the WITH clause, at the scope specified by the "jsonpath" input.

json_content: A JSON "table" (array of objects). The contents can nest, but this must be a single JSON array, not any other JSON structure, at the root level.
- The values of every instance of the key(s) provided in the WITH clause are retrievable only for substructures which are immediate children of the root-level JSON array.
jsonpath: An optional JSONPath query defining the scope, within the json_content array, that you want to pull content from. The JSON key(s) identified in the WITH clause must exist at the scope defined in this parameter. This defaults to the JSON root ($).

Consider a sample table with a single record, including an ID column and column with JSON content called "JSONColumn" with the following content:

[
	{
		"name": "Samuel",
		"email": "sam@gmail.com",
		"extrainfo": {
			"city": "Seattle"
		}
	},
	{
		"name": "Katherine",
		"email": "kat@gmail.com",
	},
	{
		"name": "George",
		"email": "george23@gmail.com",
	},
	{
		"name": "Carlos",
		"email": "carlos32@gmail.com",
	}
]

To extract all values for a certain key, specify the scope in the JSONTABLE function and provide the desired key(s) in the WITH clause.

SELECT A.ID, X.name FROM [TableWithJSONField] A CROSS APPLY JSONTABLE(A.JSONColumn) WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1 |Samuel|
|1 |Katherine|
|1 |George|
|1 |Carlos|

XMLTABLE(xml_content,[xpath,child_type])

For each record in the resultset of the preceding table expression, returns one record for each of the elements and/or attributes in an XML structure (xml_content) that match the tag name(s) and/or attribute name(s) specified in the WITH clause, at the scope specified in the "xpath" input.

xml_content: A column containing an XML structure.
xpath: An optional XPath that specifies the scope within the XML structure at which the connector extracts content matching the tag/attribute name(s) specified in the WITH clause.
- When extracting the content of sub-elements, the connector can retrieve all content from tags at the root level, (depth 0) immediate children of the root (depth 1), and children of those children (depth 2).
- When extracting element attribute content, the connector can retrieve all content from tags containing the specified attribute at the root level (depth 0) and from immediate children of root-level elements (depth 1).
child_type: An optional parameter that specifies the part(s) of the parent element (specified in the xpath input) that the column(s) provided in the WITH clause are checked against to identify content.
- You can supply the following values:
  - 0: The column(s) in the WITH clause are checked for matches against the parent element's attribute names and sub-element tag names.
  - 1: The column(s) in the WITH clause are checked for matches against the parent element's attribute names.
  - 2: The column(s) in the WITH clause are checked for matches against the parent element's sub-element tag names.
- When not supplied, this defaults to 0.

Extracting Sub-Element Values

Consider a sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<shoppingList>
    <item>
        <name>Apples</name>
        <quantity>3</quantity>
        <unit>Kg</unit>
    </item>
    <item>
        <name>Bread</name>
        <quantity>2</quantity>
        <unit>Loaf</unit>
		<extrainfo>
			<Type>Whole-Grain</Type>
		</extrainfo>
    </item>
    <item>
        <name>Milk</name>
        <quantity>1</quantity>
        <unit>Carton</unit>
    </item>
    <item>
        <name>Eggs</name>
        <quantity>12</quantity>
        <unit></unit>
    </item>
</shoppingList>

To extract sub-element content, specify the scope in the XMLTABLE function and provide the desired element name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 1.

SELECT A.ID, X.name FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/item') WITH (name VARCHAR(255)) AS X

-- Results: 
|ID|name|
---------
|1|Apples|
|1|Bread|
|1|Milk|
|1|Eggs|

Extracting Values Using Element Tag Attributes

Suppose you have this sample table with a single record, including an ID column and a column with XML content called "XMLContent" with the following content:

<restaurant>
  <dish type="appetizer">
    <name lang="en">Caprese Salad</name>
    <chef>Chef Giovanni</chef>
    <price currency="USD">9.99</price>
  </dish>
  <dish type="main-course">
    <name lang="fr">Boeuf Bourguignon</name>
    <chef>Chef Marie</chef>
    <price currency="EUR">19.99</price>
  </dish>
  <dish type="dessert">
    <name lang="es">Tres Leches Cake</name>
    <chef>Chef Alejandro</chef>
    <price currency="MXN">89.99</price>
  </dish>
</restaurant>

To extract attribute content, specify the scope in the XMLTABLE function and provide the desired attribute name(s) in the WITH clause. Note that this will not work if the XMLTABLE function's child_type input is set to 2.

SELECT A.ID, X.type FROM [TableWithXMLField] A CROSS APPLY XMLTABLE(A.XMLContent,'//*/dish') WITH (type VARCHAR(255)) AS X

-- Results: 
|ID|type|
---------
|1|appetizer|
|1|main-course|
|1|dessert|

CSVTABLE(csv_content,[delimiter])

For each record in the resultset of the preceding table expression, reads from a column that contains a CSV table (csv_content) and for each record in that CSV table, returns one record containing the value of the CSV column(s) specified in the WITH clause.

csv_content: A column containing a CSV table.
delimiter: An optional custom delimiter (instead of a comma) which splits the CSV content contained in the csv_content input.

Consider a sample table with a single record, including an ID column and a column containing CSV table called "CSVContent" with the following content:

Name;Category;Price
Apple;Fruit;0.99
Spaghetti;Pasta;5.49
Chicken Breast;Meat;8.99
Broccoli;Vegetable;2.49

To select every value in the "Name" column and account for the custom delimiter (;):

SELECT A.ID, X.Name FROM [TableWithCSVField] A CROSS APPLY CSVTABLE(A.CSVContent,';') WITH (Name VARCHAR(255)) AS X

-- Results:
|ID|Name|
-----------
|1|Apple|
|1|Spaghetti|
|1|Chicken Breast|
|1|Broccoli|

UPDATE Statements

To modify existing records, use UPDATE statements.

Update Syntax

The UPDATE statement takes as input a comma-separated list of columns and new column values as name-value pairs in the SET clause, as shown in the following example:

UPDATE <table_name> SET <select_statement> | {<column_reference> = <expression> [ , ... ]} WHERE { ItemId = <expression>  } [ { AND | OR } ... ] 

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

The following is an example query:

UPDATE ItemListing SET Title='My Awesome Book II' WHERE ItemId = @myItemId

DELETE Statements

To delete information from a table, use DELETE statements.

DELETE Syntax

The DELETE statement requires the table name in the FROM clause and the row's primary key in the WHERE clause, as shown in the following example:

<delete_statement> ::= DELETE FROM <table_name> WHERE { ItemId = <expression> } [ { AND | OR } ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

The following is an example query:

DELETE FROM ItemListing WHERE ItemId = @myItemId

CACHE Statements

When caching is enabled, CACHE statements provide complete control over the data that is cached and the table to which it is cached. The CACHE statement executes the SELECT statement specified and caches its results to a table with the same name in the cache database or to table specified in <cached_table_name>. The connector updates or inserts rows to the cache depending on whether or not they already exist in the cache, so the primary key, which is used to identify existing rows, must be included in the selected columns.

See Caching Data for more information on different caching strategies.

CACHE Statement Syntax

The cache statement may include the following options that alter its behavior:

CACHE [ <cached_table_name> ] [ WITH TRUNCATE | AUTOCOMMIT | SCHEMA ONLY | DROP EXISTING | ALTER SCHEMA ] <select_statement>

WITH TRUNCATE

If this option is set, the connector removes existing rows in the cache table before adding the selected rows. Use this option if you want to refresh the entire cache table but keep its existing schema.

AUTOCOMMIT

If this option is set, the connector commits each row individually. Use this option if you want to ignore the rows that could not be cached due to some reason. By default, the entire result set is cached as a single transaction.

DROP EXISTING

If this option is set, the connector drops the existing cache table before caching the new results. Use this option if you want to refresh the entire cache table, including its schema.

SCHEMA ONLY

If this option is set, the connector creates the cache table based on the SELECT statement without executing the query.

ALTER SCHEMA

If this option is set, the connector alters the schema of the existing table in the cache if it does not match the schema of the SELECT statement. This option results in new columns or dropped columns, if the schema of the SELECT statement does not match the cached table.

Common Queries

Use the following cache statement to cache all rows of a table:

CACHE SELECT * FROM ItemListing

Use the following cache statement to cache all rows of a table into the cache table CachedItemListing:

CACHE CachedItemListing SELECT * FROM ItemListing

Use the following cache statement for incremental caching. The DateModified column may not exist in all tables. The cache statement shows how incremental caching would work if there were such a column. Also, notice that, in this case, the WITH TRUNCATE and DROP EXISTING options are specifically omitted, which would have deleted all existing rows.

CACHE CachedItemListing SELECT * FROM ItemListing WHERE DateModified > '2013-04-04'

Use the following cache statements to create a table with all available columns that will then cache only a few of them. The sequence of statements cache only HitCount and Title even though the cache table CachedItemListing has all the columns in ItemListing.

CACHE CachedItemListing SCHEMA ONLY SELECT * FROM ItemListing
CACHE CachedItemListing SELECT HitCount, Title FROM ItemListing

EXECUTE Statements

To execute stored procedures, you can use EXECUTE or EXEC statements.

EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.

Stored Procedure Syntax

To execute a stored procedure as an SQL statement, use the following syntax:

 
{ EXECUTE | EXEC } <stored_proc_name> 
{
  [ @ ] <input_name> = <expression>
} [ , ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

Example Statements

Reference stored procedure inputs by name:

EXECUTE my_proc @second = 2, @first = 1, @third = 3;

Execute a parameterized stored procedure statement:

EXECUTE my_proc second = @p1, first = @p2, third = @p3;

PIVOT and UNPIVOT

PIVOT and UNPIVOT can be used to change a table-valued expression into another table.

PIVOT

PIVOT rotates a table-value expression by turning unique values from one column into multiple columns in the output. PIVOT can run aggregations where required on any column value.

PIVOT Synax

 
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"

UNPIVOT

UNPIVOT carries out nearly the opposite to PIVOT by rotating columns of a table-valued expressions into column values.

UNPIVOT Sytax

 
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"

For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)

Data Model

The CData Python Connector for eBay models entities in the eBay API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.

The connector uses the eBay API to process supported filters. The connector processes other filters client-side within the connector.

Note: If you're using the Auth'n'Auth authentication scheme, there are some tables and views you cannot access. See AuthNAuth Limitations for a list of these limitations.

Tables

The CData Python Connector for eBay models Item Listings in tables so that they can be easily queried, updated, and deleted. You can list items on your eBay store by calling the AddItem stored procedure.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

AuthNAuth Limitations

If you use the Auth'n'Auth authentication scheme, the following tables/views are Unavailable:

Sell API
- Tables
  - Tasks
- Views
  - FulfillmentPolicies
  - PaymentPolicies
  - ReturnPolicies
- Stored Procedures
  - UploadFile
  - GetResultFile
  - CreateOrderTask
  - CreateInventoryTask
Commerce API
- Views
  - CategorySuggestions
  - CategorySubtree
  - CompatibilityProperties
  - CompatibilityPropertyValues
  - CategoryTree
  - DefaultCategoryTreeId
  - ItemAspectsForCategory

Tables

The connector models the data in eBay as a list of tables in a relational database that can be queried using standard SQL statements.

CData Python Connector for eBay Tables


Name	Description
ItemListing	Update, delete, and query Item Listings for sellers.
ItemVariations	Item Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size; each variation would specify a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.)
Tasks	Retrieves all the tasks for the marketplace you specify using the MarketplaceId query parameter.

ItemListing

Update, delete, and query Item Listings for sellers.

Table Specific Information

Select

The following query retrieves seller items. By default this query returns items that were added in the last 100 days.

SELECT * FROM ItemListing

ItemListing is the only table that supports ORDER BY. Only two columns can be used for ordering: StartTime and EndTime. The following query retrieves items that end between the specified time, ordered by the item ending soonest.

SELECT * FROM ItemListing WHERE EndTimeFrom = '2016-01-25' AND EndTimeTo = '2016-02-05' ORDER BY EndTime

INSERT

The AddItem stored procedure provides the functionality to add a new item.

Update

The inputs that are required for an update depend on the type of the item and its category. At least the ItemId and one property of the item must be provided in an update.

UPDATE ItemListing SET Title = 'My Awesome Item' WHERE ItemId = '123456789'

After one item in a multiquantity listing has been sold, sellers cannot change the values in the Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields. However, all other fields are still editable.

Delete

The ItemId and EndingReason must be specified to delete an item.

DELETE FROM ItemListing WHERE ItemId = '123456789' AND  EndingReason = 'LostOrBroken'

Columns


Name	Type	ReadOnly	Description
ItemId [KEY]	String	False	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
Title	String	False	Name of the item as it appears in the listing or search results.
AutoPay	Boolean	False	If true, the seller requests immediate payment for the item.
BuyerProtection	String	False	Flag to indicate the eligibility of an item for the PayPal Buyer Protection program.
BuyItNowPrice	Decimal	False	This field is only applicable for auction listings. By specifying a Buy It Now price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately.
ConditionDescription	String	False	This string field is used by the seller to more clearly describe the condition of items that are not brand new.
Country	String	False	Defines the 2-letter ISO 3166 country code.
Currency	String	False	Currency associated with the price information of the item. 3-letter ISO 4217 currency code.
Description	String	False	The description of the item by the seller. In listing requests, you can use CDATA tags to submit your description if you want to use HTML or XML-reserved characters in the description.
HideFromSearch	Boolean	False	Whether the listing is hidden from all searches occurring on eBay.
HitCount	Integer	False	The number of page views for the item.
Adult	Boolean	False	If true, the item is listed in a Mature category.
BestOfferAutoAcceptPrice	Decimal	False	The price at which Best Offers are automatically accepted. Similar in use to MinimumBestOfferPrice.
CheckoutEnabled	Boolean	False	This flag indicates whether or not the Checkout Enabled preference of the seller is turned on (at account level or at listing level).
StartTime	Datetime	False	The StartTime for when the item was listed.
EndTime	Datetime	False	Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration), or the actual end time if the item has ended.
MinimumBestOfferPrice	Decimal	False	Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller.
ViewItemURL	String	False	The URL of the Web page where a user can view the listing. On the U.S. site, this is called the View Item page.
ViewItemURLForNaturalSearch	String	False	This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines.
ListingDuration	String	False	Describes the number of days the seller wants the listing to be active (available for bidding/buying).
ListingType	String	False	The format of the listing the seller wants to use, such as Chinese auction or fixed price.
Location	String	False	Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold), and it does not end within 12 hours.
CategoryId	String	False	Category Id for the first (or only) category in which the item is listed (or will be listed, if the item is new).
CategoryName	String	False	This string value is the display name of the eBay primary category, as it would appear on the eBay website.
PrivateListing	Boolean	False	If true, designates the listing as private.
Quantity	Integer	False	The meaning of this value depends on the context.
QuantityAvailableHint	String	False	Indicates the type of message that will be returned describing the quantity available for the item.
QuantityThreshold	Integer	False	The quantity threshold above which the seller prefers not to show the actual quantity available.
ReservePrice	Decimal	False	The lowest price at which the seller is willing to sell the item.
Refund	String	False	Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers.
RefundOption	String	False	Indicates how the seller will compensate the buyer for a returned item.
ReturnsAccepted	String	False	Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers.
ReturnsAcceptedOption	String	False	Indicates whether the seller allows the buyer to return the item. One of the following values: ReturnsAccepted or ReturnsNotAccepted. If you specify ReturnsNotAccepted, the View Item page will indicate that returns are not accepted instead.
ReturnsWithin	String	False	Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers.
ReturnsWithinOption	String	False	The buyer can return the item within this period of time from the day they receive the item.
ShippingCostPaidBy	String	False	Display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers.
ShippingCostPaidByOption	String	False	The party who pays the shipping cost for a returned item.
ItemRevised	Boolean	False	This field is returned as true if the original listing has been revised.
SellerName	String	False	The name of the seller. This field is used as part of the address.
CurrentPrice	Decimal	False	The current price of the item in the original listing currency.
ListingStatus	String	False	Specifies an active or ended listing status in the processing workflow.
PromotionalEndTime	Datetime	False	End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
PromotionalOriginalPrice	Decimal	False	Original price of an item whose price a seller has reduced with the Promotional Price Display feature.
PromotionalStartTime	Datetime	False	Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature.
QuantitySold	Integer	False	The total number of items purchased so far in the lifetime of the listing. Subtract this from Quantity to determine the quantity available.
ReserveMet	Boolean	False	Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified.
SecondChanceEligible	Boolean	False	Part of the Second Chance Offer feature, which indicates whether the seller can extend a second chance offer for the item.
Site	String	False	The name of the site on which the item is listed.
SKU	String	False	A SKU (stock keeping unit) is an identifier defined by a seller.
StartPrice	Decimal	False	The original price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes the original price.
TimeLeft	String	False	Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
TotalQuestionCount	Integer	False	The number of questions asked about this item. Applies to eBay Motors Pro applications only.
WatchCount	Integer	False	The number of watches placed on this item from the My eBay accounts of the buyers.
StoreCategoryId	Long	False	Unique identifier of a primary custom category in which to list the item.
StoreCategoryId2	Long	False	Unique identifier for the secondary custom category in which to list the item.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
AdminEndedItemsOnly	Boolean	Specifies whether to return only items that were administratively ended based on a policy violation.
EndTimeFrom	Datetime	Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter. Each of the time ranges must be a value less than 120 days.
EndTimeTo	Datetime	Specifies the latest (most recent) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter. Each of the time ranges must be a value less than 120 days.
GranularityLevel	String	Specifies the subset of item and user fields to return.
StartTimeFrom	Datetime	Specifies the earliest (oldest) date to use in a date range filter based on item start time.
StartTimeTo	Datetime	Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified.
UserId	String	Specifies the seller whose items will be returned. UserId is an optional input. If not specified, retrieves listings for the user identified by the authentication token passed in the request.
DetailLevel	String	Detail levels are instructions that define standard subsets of data to return for particular tables. The allowed values are ReturnAll.
EndingReason	String	Indicates the reason the seller ended the listing early.

ItemVariations

Item Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size; each variation would specify a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.)

Table Specific Information

Select

An item Id must be specified to get variations for the item which this Id represents.

                                          
SELECT * FROM ItemVariations WHERE ItemId = '110187147205'

Insert

The fields which are required for insert are ItemId, VariationSpecificsAggregate, StartPrice, and Quantity. VariationSpecificsAggregate should contain variation specifics structured in XML format. For instance, the following VariationSpecificsAggregate adds a large blue item:

<NameValueList>
  <Name>Color</Name>
  <Value>Blue</Value>
</NameValueList>
<NameValueList>
  <Name>Size</Name>
  <Value>L</Value>
</NameValueList>

The following query adds a variation of a large blue item with a StartPrice of 15 and a Quantity of 100.

                                          
INSERT INTO ItemVariations (ItemId, VariationSpecificsAggregate, Quantity, StartPrice) VALUES ('110188946596', '<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>', '100', '15')

Update

You can use ItemId and VariationSpecificsAggregate to update an item variation.

VariationSpecificsAggregate should be in XML format and should contain all specifics which identify a variation.

UPDATE ItemVariations SET Quantity = '5' WHERE ItemId = '110188946596' AND VariationSpecificsAggregate = '<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>'

Alternatively, the ItemId and SKU columns can be used to identify the variation to update.

UPDATE ItemVariations SET StartPrice = '80.9', Quantity = '22' WHERE ItemId = '110555774107' AND SKU = 'SHOE-BLACK-7'

Delete

ItemId and VariationSpecificsAggregate are required for deleting a variation.

                                          
DELETE FROM ItemVariations WHERE ItemId = '110188946596' AND VariationSpecificsAggregate = '<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>'

Columns


Name	Type	ReadOnly	Description
ItemId [KEY]	String	False	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
VariationSpecificsAggregate [KEY]	String	False	A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values.
StartPrice	Decimal	False	The price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes this price.
Currency	String	False	Currency associated with the price information of the item. 3-letter ISO 4217 currency code.
Quantity	Integer	False	This value indicates the quantity of items in the specific variation that are available for purchase.
QuantitySold	Integer	False	The total number of items purchased so far. Subtract this from Quantity to determine the quantity available.
SKU	String	False	A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the use of the seller (not for buyers).
EAN	String	False	This field is used if the seller wishes to identify each product variation within a multivariation listing by an EAN (European Article Number) value.
ISBN	String	False	This field is used if the seller wishes to identify each product variation within a multivariation listing by an ISBN (International Standard Book Number) value.
UPC	String	False	This field is used if the seller wishes to identify each product variation within a multivariation listing by a UPC (Universal Product Code) value.
ListingStatus	String	False	Specifies a listing with an active or ended status in the eBay processing workflow.

Tasks

Retrieves all the tasks for the marketplace you specify using the MarketplaceId query parameter.

Select

The Select query requires either FeedType or TaskId as a mandatory filter. You can use the following SQL queries to obtain the necessary values:

SELECT * FROM [Tasks] WHERE FeedType = 'LMS_ADD_ITEM'

SELECT * FROM [Tasks] WHERE TaskId = 'task-10-1261553'

Some of the fields are named with the suffix Aggr. These fields display the content of the JSON tag with the same name that is returned from the API endpoint.

Insert

FeedType, MarketplaceID and SchemaVersion are required in the Insert query. You can follow the query below to obtain the required values through SQL:

INSERT INTO [Tasks] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')

Columns


Name	Type	ReadOnly	Description
TaskId [KEY]	String	True	The ID of the task that was submitted in the request.
Status	String	True	The enumeration value that indicates the state of the task that was submitted in the request.
FeedType	String	False	The feed type associated with the task.
CreationDate	Datetime	True	The date the task was created.
UploadSummaryAggr	String	True	This container provides summary information on an upload feed (not applicable for download feed types).

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceID	String	MarketplaceID of your Ebay account.
SchemaVersion	String	The schema version number associated with the task.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Python Connector for eBay Views


Name	Description
Bidders	Query eBay users that bid on a specified listing, regardless of whether the listing has ended.
CategoryPolicies	Returns category policy metadata for all leaf categories on the specified marketplace.
CategorySubtree	Retrieve all nodes of the category tree hierarchy (the subtree) below a specified category in a specified category tree.
CategorySuggestions	Return an array of suggested categories that eBay has determined correspond to keywords that describe an item.
CategoryTree	Retrieve the complete category tree corresponding to a specified category tree ID.
CompatibilityProperties	Retrieve an array of parts compatibility aspects that are used to describe compatible vehicles.
CompatibilityPropertyValues	Retrieve an array of parts compatibility aspect values that are used to describe compatible vehicles.
Countries	Lists the country code and associated name of the countries supported by the eBay system, regardless of the site specified in the request.
Currencies	Query the supported Currencies in eBay.
DefaultCategoryTreeId	Retrieve the default category tree reference for a specific eBay marketplace.
FulfillmentPolicies	Retrieves all the fulfillment policies configured for the marketplace you specify using the MarketplaceId query parameter.
HighestBidder	Query the Highest Bidder of the eBay users who bid on a specified listing, regardless of whether the listing has ended.
ItemAspectsForCategory	Retrieve an array of aspects that are appropriate for describing items in a specified category.
ItemCompatibilityList	Query compatability categories and possible compatability values for a specific item.
ItemConditionPolicies	Returns item condition policy metadata for each category on the specified marketplace, with one row per category.
ItemConditions	Returns the item conditions supported by each category on the specified marketplace, with one row per condition per category.
ItemShipping	Query details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension, weight, and packaging/handling costs.
ItemSpecifics	Query item specifics for a specific item.
ItemTransactions	Query order line item (transaction) information for a specified listing. For auction listings, order line items are not created until the auction ends with a winning bidder, or if the Buy It Now feature is enabled for the listing and used by the buyer to purchase the item. For fixed-price listings, order line items are created after a buyer has committed to purchase the item(s).
ListingTypePolicies	Returns the listing type policies for the specified marketplace, with each row representing a listing type and duration combination per category.
MotorsListingPolicies	Returns eBay Motors policy metadata for all leaf categories on the specified marketplace.
NegotiatedPricePolicies	Returns the negotiated price (Best Offer) policies for the specified marketplace.
OrderPayments	Query all payments of the orders, in which the authenticated user is either the buyer or seller. By default, only payment details of orders made in the last 90 days are returned. Payment details of orders older than 90 days can be retrieved by specifying OrderId.
Orders	Query all orders in which the authenticated user is either the buyer or seller. By default, only orders made in the last 90 days are returned. Orders older than 90 days can be retrieved by specifying OrderId.
OrderShipping	Query shipping details of the orders in which the authenticated user is either the buyer or seller. By default, only shipping details of orders made in the last 90 days are returned. Shipping details of orders older than 90 days can be retrieved by specifying OrderId.
PaymentPolicies	Retrieves all the payment policies configured for the marketplace you specify using the MarketplaceId query parameter.
ReturnPolicies	Retrieves all the return policies configured for the marketplace you specify using the MarketplaceId query parameter.
ShippingCarriers	Query Shipping Carriers supported by the specified site.
ShippingCategories	A shipping service category supported for the site.
ShippingLocations	Lists the regions and locations supported by eBay's shipping services. Returns all shipping locations supported by eBay, regardless of the site specified in the request.
ShippingPolicies	Returns shipping policy metadata for all leaf categories on the specified marketplace.
ShippingServices	Query Shipping Services supported by the specified eBay site.
Sites	Lists all available eBay sites and their associated SiteID numbers.
TransactionLinkedItems	Query all linked line items of the transactions in which the authenticated user is either the buyer or seller. By default, only linked line items of transactions made in the last 90 days are returned. Linked line items of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.
TransactionPayments	Query all payments of the transactions in which the authenticated user is either the buyer or seller. By default, only payments of transactions made in the last 90 days are returned. Payments of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.
TransactionRefunds	Query all refunds of the transactions in which the authenticated user is either the buyer or seller. By default, only refunds of transactions made in the last 90 days are returned. Refunds of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.
Transactions	Query all transactions in which the authenticated user is either the buyer or seller. By default, only transactions of orders made in the last 90 days are returned. Transactions of orders older than 90 days can be retrieved by specifying OrderId.
TransactionShipping	Query shipping details of the transactions in which the authenticated user is either the buyer or seller. By default, only shipping details of transaction made in the last 90 days are returned. Shipping details of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

Bidders

Query eBay users that bid on a specified listing, regardless of whether the listing has ended.

Table Specific Information

Select

The only supported columns for filtering are ItemId and ListMode. An ItemId must be specified for retrieving data from this view.

SELECT * FROM Bidders WHERE ItemId = '1234567'

SELECT * FROM Bidders WHERE ItemId = '1234567' AND ListMode = 'EndedListing'

Columns


Name	Type	Description
Action	String	Indicates the type of offer being made on the specified listing.
MaxBid	Decimal	Amount of the offer placed. For auction listings, the amount bid on the item (subject to outbid by other buyers). For fixed-price listings, the fixed sale price at which the item is purchased. For auction listings with an active Buy It Now option, this amount will be either the Buy It Now price for purchase or the amount of a bid, depending on the offer type.
Currency	String	The three-digit currency code for the Max Bid.
ConvertedPrice	Decimal	The price in the currency specified.
ConvertedPriceCurrency	String	The three-digit currency Id of the converted price.
HighestBid	Decimal	Amount the highest bidder has bid on the item. Applicable to only auction listings where there is progressive bidding and winning bidders are determined based on the highest bid.
HighestBidCurrency	String	The three-digit currency code for the highest bid.
Quantity	Integer	Specifies the number of items the user tendering the offer intends to purchase, bid on, or make a Best Offer on.
SecondChanceEnabled	Boolean	Indicates whether user is willing to be the recipient of second chance offers.
SiteCurrency	String	Unique Id identifying the currency in which the localized offer amounts are expressed.
TimeBid	Datetime	Date and time the offer or bid was placed.
UserId	String	Unique eBay user Id for the user.
UserCountry	String	The two-digit code representing the country of the user.
UserFeedbackScore	Integer	The aggregate feedback score for a user. A feedback score for a user is the net positive feedback minus the net negative feedback left for the user.
ItemId	String	The Id of the item. The bidders who bid on this item are returned.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
ListMode	String	Specifies which bidder information to return. EndedListing returns all nonwinning bidders for ended listings only. It can be used only by a seller. SecondChanceEligibleEndedListing returns all nonwinning bidders for an ended listing who have not yet received a Second Chance Offer and noted interest in receiving a Second Chance Offer. It can be used only by a seller. ViewAll returns all bidders for an ended or still-active listing. It can be used by any user. The allowed values are EndedListing, SecondChanceEligibleEndedListing, ViewAll.

CategoryPolicies

Returns category policy metadata for all leaf categories on the specified marketplace.

Columns


Name	Type	Description
CategoryId [KEY]	String	The unique identifier of the eBay leaf category.
CategoryTreeId	String	The unique identifier of the category tree.
AutoPayEnabled	Boolean	If true, the category supports immediate payment for listings.
B2bVatEnabled	Boolean	If true, the category supports business-to-business (B2B) VAT listings. Applicable to eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only.
EanSupport	String	Indicates whether European Article Numbers (EANs) are supported or required when listing products in the category.
Expired	Boolean	If true, the category is no longer a valid eBay category on the site and items may not be listed in this category.
IntangibleEnabled	Boolean	If true, the category supports the listing of intangible goods or services.
IsbnSupport	String	Indicates whether International Standard Book Numbers (ISBNs) are supported or required when listing products in the category.
Lsd	Boolean	If true (Lot Size Disabled), the category does not support lot listings.
MinimumReservePrice	Double	The minimum reserve price for an auction listing in this category. A value of 0.0 indicates no minimum reserve price.
Orpa	Boolean	If true (Override Reserve Price Allowed), the marketplace allows reserve prices but this category does not.
Orra	Boolean	If true (Override Reduce Reserve Allowed), the seller can reduce or remove a reserve price that had already been reduced for an active auction listing.
PaymentMethods	String	An array of acceptable offline payment methods for listing items in the category.
ReduceReserveAllowed	Boolean	If true, the category allows the seller to reduce an item's reserve price.
ReservePriceAllowed	Boolean	If true, reserve prices are allowed for auction listings in this category.
UpcSupport	String	Indicates whether Universal Product Codes (UPCs) are supported or required when listing products in the category.
ValueCategory	Boolean	If true, the leaf category is designated by eBay as a value category. Value categories can be used as a secondary category at no extra charge.
Virtual	Boolean	If true, the category is a virtual category in which items may not be listed.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceId	String	The eBay marketplace for which policy information is retrieved.
Filter	String	Limits the response by returning metadata for specified leaf categories only. Format: categoryIds:{catId1\|catId2\|catId3}. Maximum 50 category IDs.

CategorySubtree

Retrieve all nodes of the category tree hierarchy (the subtree) below a specified category in a specified category tree.

Table Specific Information

Select

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId and CategoryId is required to make a request and the rest of the filter is executed client-side within the connector.

CategoryTreeId supports the '=' comparison.
CategoryId supports the '=' comparison.

For example:

    SELECT * FROM CategorySubtree WHERE CategoryTreeId = 0 AND CategoryId = 11450

Columns


Name	Type	Description
CategoryTreeId [KEY]	String	The unique identifier of the eBay category tree to which this subtree belongs.
CategoryTreeVersion	String	The version of the category tree identified by categoryTreeId.
CategorySubtreeNode	String	Contains details of all nodes of the category subtree hierarchy below a specified node. This is a recursive structure.
Category	String	Contains details about the current category tree node.
CategoryName	String	The name of the category identified by categoryId.
CategoryTreeNodeLevel	Integer	The absolute level of the current category tree node in the hierarchy of its category tree.
ChildCategoryTreeNodes	String	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
Category	String	Contains details about the current category tree node.
CategoryName	String	The name of the category identified by categoryId.
CategoryTreeNodeLevel	Integer	The absolute level of the current category tree node in the hierarchy of its category tree.
ChildCategoryTreeNodes	String	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
Category	String	Contains details about the current category tree node.
CategoryName	String	The name of the category identified by categoryId.
CategoryTreeNodeLevel	Integer	The absolute level of the current category tree node in the hierarchy of its category tree.
ChildCategoryTreeNodes	String	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
LeafCategoryTreeNode	Boolean	A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.
ParentCategoryTreeNodeHref	String	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
LeafCategoryTreeNode	Boolean	A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.
ParentCategoryTreeNodeHref	String	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
LeafCategoryTreeNode	Boolean	A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.
ParentCategoryTreeNodeHref	String	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
CategoryId	String	The unique identifier of the category at the top of the subtree being requested.

CategorySuggestions

Return an array of suggested categories that eBay has determined correspond to keywords that describe an item.

Table Specific Information

Select

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId and Q is required to make a request and the rest of the filter is executed client-side within the connector.

CategoryTreeId supports the '=' comparison.
Q supports the '=' comparison.

For example:

    SELECT * FROM CategorySuggestions WHERE CategoryTreeId = 0 AND Q = 'iphone'

Columns


Name	Type	Description
CategoryTreeId [KEY]	String	The unique identifier of the eBay category tree from which suggestions are returned.
CategoryTreeVersion	String	The version of the category tree identified by categoryTreeId.
CategorySuggestions	String	Contains details about one or more suggested categories that correspond to the provided keywords.
Category	String	Contains details about the suggested category.
CategoryId	String	The unique identifier of the eBay category within its category tree.
CategoryName	String	The name of the category identified by categoryId.
CategoryTreeNodeAncestors	String	An ordered list of category references that describes the location of the suggested category in the specified category tree.
CategoryId	String	The unique identifier of the eBay ancestor category.
CategoryName	String	The name of the ancestor category identified by categoryId.
CategorySubtreeNodeHref	String	The href portion of the getCategorySubtree call that retrieves the subtree below the ancestor category node.
CategoryTreeNodeLevel	String	The absolute level of the ancestor category node in the hierarchy of its category tree.
CategoryTreeNodeLevel	Integer	The absolute level of the category tree node in the hierarchy of its category tree.
Relevancy	String	This field is reserved for internal or future use.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
Q	String	A quoted string that describes or characterizes the item being offered for sale.

CategoryTree

Retrieve the complete category tree corresponding to a specified category tree ID.

Table Specific Information

Select

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId is required to make a request and the rest of the filter is executed client-side within the connector.

CategoryTreeId supports the '=' comparison.

For example:

    SELECT * FROM CategoryTree WHERE CategoryTreeId = 0

Columns


Name	Type	Description
CategoryTreeId [KEY]	String	The unique identifier of the eBay category tree for the specified marketplace.
CategoryTreeVersion	String	The version of the category tree identified by categoryTreeId.
ApplicableMarketplaceIds	String	A list of one or more identifiers of the eBay marketplaces that use this category tree.
RootCategoryNode	String	Contains details of all nodes of the category tree hierarchy, starting with the root node and down to the leaf nodes.
Category	String	Contains details about the current category tree node.
CategoryId	String	The unique identifier of the eBay category within its category tree.
CategoryName	String	The name of the category identified by categoryId.
CategoryTreeNodeLevel	Integer	The absolute level of the current category tree node in the hierarchy of its category tree.
ChildCategoryTreeNodes	String	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
Category	String	Contains details about the current category tree node.
CategoryId	String	The unique identifier of the eBay category within its category tree.
CategoryName	String	The name of the category identified by categoryId.
CategoryTreeNodeLevel	Integer	The absolute level of the current category tree node in the hierarchy of its category tree.
ChildCategoryTreeNodes	String	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
Category	String	Contains details about the current category tree node.
CategoryId	String	The unique identifier of the eBay category within its category tree.
CategoryName	String	The name of the category identified by categoryId.
CategoryTreeNodeLevel	Integer	The absolute level of the current category tree node in the hierarchy of its category tree.
ChildCategoryTreeNodes	String	An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes.
LeafCategoryTreeNode	Boolean	A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.
ParentCategoryTreeNodeHref	String	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
LeafCategoryTreeNode	Boolean	A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.
ParentCategoryTreeNodeHref	String	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.
LeafCategoryTreeNode	Boolean	A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array.
ParentCategoryTreeNodeHref	String	The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node.

CompatibilityProperties

Retrieve an array of parts compatibility aspects that are used to describe compatible vehicles.

Table Specific Information

Select

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId and CategoryId is required to make a request and the rest of the filter is executed client-side within the connector.

CategoryTreeId supports the '=' comparison.
CategoryId supports the '=' comparison.

For example:

    SELECT * FROM CompatibilityProperties WHERE CategoryTreeId = 101 AND CategoryId = 33559

Columns


Name	Type	Description
CategoryTreeId [KEY]	String	This is the unique identifier of category tree.
CategoryId	String	The unique identifier of an eBay category.
CompatibilityPropertyName	String	This is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category.
CompatibilityPropertyLocalizedName	String	This is the localized name of the compatible vehicle property.

CompatibilityPropertyValues

Retrieve an array of parts compatibility aspect values that are used to describe compatible vehicles.

Table Specific Information

Select

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId, CategoryId and CompatibilityProperty is required to make a request and the rest of the filter is executed client-side within the connector.

CategoryTreeId supports the '=' comparison.
CategoryId supports the '=' comparison.
CompatibilityProperty supports the '=' comparison.

For example:

    SELECT * FROM CompatibilityPropertyValues WHERE CategoryTreeId = 101 AND CategoryId = 33559 AND CompatibilityProperty = 'Trim'

Columns


Name	Type	Description
CategoryTreeId [KEY]	String	This is the unique identifier of category tree.
CompatibilityProperty [KEY]	String	This is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category.
CategoryId [KEY]	String	The unique identifier of an eBay category.
CompatibilityPropertyValues	String	Each value field shows one applicable compatible vehicle property value.

Countries

Lists the country code and associated name of the countries supported by the eBay system, regardless of the site specified in the request.

Columns


Name	Type	Description
Country	String	Two-letter code representing a country. These two-letter codes are typically used in Add/Revise/Relist calls when referring to a country.
Description	String	Full country name for display purposes. May be similar to (but not necessarily identical to) CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser).
DetailVersion	String	Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTime	Datetime	Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
DetailName	String	A designation of what kind of information you wish returned for the specified eBay site. The allowed values are CountryDetails.

Currencies

Query the supported Currencies in eBay.

Table Specific Information

Select

Returns all supported currencies. No columns are supported for filtering.

SELECT * FROM Currencies

Columns


Name	Type	Description
Currency	String	The three-digit currency code as defined in ISO 4217.
Description	String	Full currency name for display purposes.
DetailVersion	String	Returns the latest version number for this field.
UpdateTime	Datetime	Gives the time in GMT that the feature fields for the details were last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
DetailName	String	If set to a value of CurrencyDetails, additional currency details are returned. The allowed values are CurrencyDetails.

DefaultCategoryTreeId

Retrieve the default category tree reference for a specific eBay marketplace.

Table Specific Information

Select

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The MarketplaceId is required to make a request and the rest of the filter is executed client-side within the connector.

MarketplaceId supports the '=' comparison.

For example:

    SELECT * FROM DefaultCategoryTreeId WHERE MarketplaceId = 'EBAY_US'

Columns


Name	Type	Description
CategoryTreeId [KEY]	String	The unique identifier of the eBay category tree for the specified marketplace.
CategoryTreeVersion	String	The version of the category tree identified by categoryTreeId.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceId	String	The ID of the eBay marketplace for which the category tree ID is being requested.

FulfillmentPolicies

Retrieves all the fulfillment policies configured for the marketplace you specify using the MarketplaceId query parameter.

Select

MarketplaceId is required filter in the Select query. You can follow the query below to obtain the required values through SQL:

SELECT * FROM FulfillmentPolicies WHERE MarketplaceId = 'EBAY_US'

Some of the fields are named with the suffix Aggr. These fields display the content of the JSON tag with the same name that is returned from the API endpoint.

Columns


Name	Type	Description
FulfillmentPolicyId [KEY]	String	A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created.
Name	String	A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.
Description	String	An optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users).
CategoryTypesAggr	String	The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. (Currently, each policy can be set to only one categoryTypes value at a time.)
MarketplaceId	String	The ID of the eBay marketplace to which this fulfillment policy applies.
FreightShipping	Boolean	If set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs.
GlobalShipping	Boolean	Indicates if the seller has opted-in to the eBay Global Shipping Program and that they use that service for their international shipments.
HandlingTimeValue	Integer	The maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order.
HandlingTimeUnit	String	A time-measurement unit that specifies a singular period of time used for HandlingTimeValue.
LocalPickup	Boolean	Identifies if the shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location).
PickupDropOff	Boolean	If set to true, the seller offers the
ShipToLocationsAggr	String	This object contains the regionIncluded and regionExcluded fields, which define the geographical regions that a seller does and does not cover by the associated shipping policy.
ShippingOptionsAggr	String	A list that defines the seller's shipping configurations for DOMESTIC and INTERNATIONAL order shipments.

HighestBidder

Query the Highest Bidder of the eBay users who bid on a specified listing, regardless of whether the listing has ended.

Table Specific Information

Select

The only supported columns for filtering are ItemId and ListMode. An ItemId must be specified for retrieving data from this view.

SELECT * FROM HighestBidder WHERE ItemId = '1234567'

SELECT * FROM HighestBidder WHERE ItemId = '1234567' AND ListMode = 'EndedListing'

Columns


Name	Type	Description
ItemId	String	The Id of the item. The bidders who bid on this item are returned.
HighBidder	String	eBay user Id for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance offer candidate.
HighestBid	Decimal	Bid amount offered by the highest bidder.
Currency	String	Currency code of the bid.
ListingStatus	String	Specifies the status of an active or ended listing in the processing workflow of the eBay system. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
ListMode	String	Specifies which bidder information to return. EndedListing returns all nonwinning bidders for ended listings only. It can be used only by a seller. SecondChanceEligibleEndedListing returns all nonwinning bidders for an ended listing who have not yet received a Second Chance Offer and noted interest in receiving a Second Chance Offer. It can be used only by a seller. ViewAll returns all bidders for an ended or still-active listing. It can be used by any user. The allowed values are EndedListing, SecondChanceEligibleEndedListing, ViewAll.

ItemAspectsForCategory

Retrieve an array of aspects that are appropriate for describing items in a specified category.

Table Specific Information

Select

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId and CategoryId is required to make a request and the rest of the filter is executed client-side within the connector.

CategoryTreeId supports the '=' comparison.
CategoryId supports the '=' comparison.

For example:

    SELECT * FROM ItemAspectsForCategory WHERE CategoryTreeId = 101 AND CategoryId = 67726

Columns


Name	Type	Description
CategoryTreeId [KEY]	String	The unique identifier of the eBay category tree from which the specified category's aspects are being requested.
Aspects	String	A list of item aspects (for example, color) that are appropriate or necessary for accurately describing items in a particular leaf category.
AspectConstraint	String	Information about the formatting, occurrence, and support of this aspect.
AspectApplicableTo	String	This value indicate if the aspect identified by the aspects.localizedAspectName field is a product aspect or an item/instance aspect.
AspectDataType	String	The data type of this aspect.
AspectEnabledForVariations	Boolean	A value of true indicates that this aspect can be used to help identify item variations.
AspectFormat	String	Returned only if the value of aspectDataType identifies a data type that requires specific formatting.
AspectMaxLength	Integer	The maximum length of the item/instance aspect's value.
AspectMode	String	The manner in which values of this aspect must be specified by the seller (as free text or by selecting from available options).
AspectRequired	Boolean	A value of true indicates that this aspect is required when offering items in the specified category.
AspectUsage	String	The enumeration value returned in this field will indicate if the corresponding aspect is recommended or optional.
ExpectedRequiredByDate	String	The expected date after which the aspect will be required.
ItemToAspectCardinality	String	Indicates whether this aspect can accept single or multiple values for items in the specified category.
AspectValues	String	A list of valid values for this aspect (for example: Red, Green, and Blue), along with any constraints on those values.
LocalizedValue	String	The localized value of this aspect.
ValueConstraints	String	Not returned if the value of the localizedValue field can always be selected for this aspect of the specified category.
ApplicableForLocalizedAspectName	String	The name of the control aspect on which the current aspect value depends.
ApplicableForLocalizedAspectValues	String	Contains a list of the values of the control aspect on which this aspect's value depends.
LocalizedAspectName	String	The localized name of this aspect (for example: Colour on the eBay UK site).
RelevanceIndicator	String	The relevance of this aspect. This field is returned if eBay has data on how many searches have been performed for listings in the category using this item aspect.
SearchCount	Integer	The number of recent searches (based on 30 days of data) for the aspect.
CategoryId	String	The unique identifier of an eBay category.

ItemCompatibilityList

Query compatability categories and possible compatability values for a specific item.

Columns


Name	Type	Description
ItemId [KEY]	String	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
CompatibilityAttributes	String	A list of all potential compatability catagories for the specified item.
PossibleCompatibilities	String	A list of all possible compatability values for the specified item.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
IncludeItemCompatibilityList	Boolean	This is used to include ItemCompatibilityList items and should not be set manually.

ItemConditionPolicies

Returns item condition policy metadata for each category on the specified marketplace, with one row per category.

Columns


Name	Type	Description
CategoryId [KEY]	String	The unique identifier of the eBay leaf category.
CategoryTreeId	String	The unique identifier of the category tree.
ItemConditionRequired	Boolean	If true, you must specify an item condition when listing items in this category.
ItemConditions	String	An aggregated array of all valid item conditions for this category, including condition IDs and descriptions.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceId	String	The eBay marketplace for which policy information is retrieved.
Filter	String	Limits the response by returning metadata for specified leaf categories only. Format: categoryIds:{catId1\|catId2\|catId3}. Maximum 50 category IDs.

ItemConditions

Returns the item conditions supported by each category on the specified marketplace, with one row per condition per category.

Columns


Name	Type	Description
CategoryId [KEY]	String	The unique identifier of the eBay leaf category.
CategoryTreeId	String	The unique identifier of the category tree.
ItemConditionRequired	Boolean	If true, you must specify an item condition when listing items in this category.
ConditionId [KEY]	String	The ID of the item condition. Standard values include 1000 (New), 1500 (Open box), 2000 (Certified Refurbished), 2500 (Seller refurbished), 3000 (Used), 7000 (For parts or not working).
ConditionDescription	String	The human-readable label for the condition, such as New, Used, or Certified - Refurbished. This value is typically localized for each site.
ConditionHelpText	String	A detailed description of the condition denoted by the ConditionId and ConditionDescription.
Usage	String	Indicates usage restrictions for the condition. Currently, the only supported value is RESTRICTED, meaning the seller must be pre-approved to use this condition. Applies to Certified Refurbished and other refurbished conditions.
ConditionDescriptors	String	An aggregated array of condition descriptors for graded items such as trading cards. Contains descriptor IDs, names, constraints, and values.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceId	String	The eBay marketplace for which policy information is retrieved.
Filter	String	Limits the response by returning metadata for specified leaf categories only. Format: categoryIds:{catId1\|catId2\|catId3}. Maximum 50 category IDs.

ItemShipping

Query details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension, weight, and packaging/handling costs.

Table Specific Information

Select

The DestinationCountryCode and ItemId filters must be specified for retrieving data from this view. Also, the QuantitySold filter can be used but it is optional.

SELECT * FROM ItemShipping WHERE ItemId = '110177686055' AND DestinationCountryCode = 'US'

Columns


Name	Type	Description
ItemId	String	The item Id that uniquely identifies the item listing for which to retrieve the data. Required input.
DestinationCountryCode	String	Destination country code. If DestinationCountryCode is US, a postal code is required and it represents the U.S. ZIP code. Default: US.
ExpeditedService	Boolean	Indicates whether the service is an expedited shipping service.
FreeShipping	Boolean	Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.
ImportCharge	Decimal	The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
Currency	String	Currency Id
ShippingService	String	A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
ShippingInsuranceCost	Decimal	The insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCost	Decimal	A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
ShippingServiceCost	Decimal	The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.
ShippingServicePriority	Integer	Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.
ShippingTimeMax	Integer	The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
ShippingTimeMin	Integer	The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
QuantitySold	Integer	Number of items sold to a single buyer and to be shipped together.
DestinationPostalCode	String	Destination country postal code (or ZIP code for U.S.). Ignored if no country code is provided. Optional tag for some countries. More likely to be required for large countries.

ItemSpecifics

Query item specifics for a specific item.

Columns


Name	Type	Description
ItemId	String	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
Attribute	String	The name of the attribute for the specified item.
Specifics	String	Comma separated list of values for the specified item attribute.
Source	String	Enumerated value indicating whether the Item Specific was manually input or selected during listing/revision/re-listing time, or if the Item Specific name-value pair came from an eBay catalog product that the listing is associated with.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
IncludeItemSpecifics	Boolean	This is used to include ItemSpecifics items and should not be set manually.

ItemTransactions

Query order line item (transaction) information for a specified listing. For auction listings, order line items are not created until the auction ends with a winning bidder, or if the Buy It Now feature is enabled for the listing and used by the buyer to purchase the item. For fixed-price listings, order line items are created after a buyer has committed to purchase the item(s).

Table Specific Information

Select

The ItemId column must be specified to retrieve transaction information.

Get all transactions related to a specific item:

SELECT * FROM ItemTransactions WHERE ItemId = '012345678901'

Filter the number of transactions returned by specifying the number of days in the past:

SELECT * FROM ItemTransactions WHERE ItemId = '012345678901' AND NumberOfDays = '25'

Get information for a specific transaction that was made for a specific item:

SELECT * FROM ItemTransactions WHERE ItemId = '012345678901' AND TransactionId = '0'

Columns


Name	Type	Description
OrderLineItemId [KEY]	String	A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemId and TransactionId with a hyphen in between these two Ids.
TransactionId	String	The unique identifier for a transaction that was made for a specific item. If a TransactionId is provided, any specified time filter is ignored.
ItemId	String	Unique identifier for an eBay item listing.
HandlingCost	Decimal	The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete. The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing.
ShippingCost	Decimal	The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
AdjustmentAmount	Decimal	Adjustment amount entered by the buyer. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.
AmountPaid	Decimal	The total amount the buyer paid for the order line item.
Currency	String	A standard 3-digit ISO 4217 currency code for currency used in countries around the world.
BestOfferSale	Boolean	Indicates whether or not the order line item was created as the result of the seller accepting a Best Offer from a buyer.
BuyerId	String	Unique eBay user Id for the user.
BuyerCheckoutMessage	String	This field is returned if a buyer left a comment for the seller during the checkout flow.
CreatedDate	Datetime	Indicates the creation time of the order line item.
DepositType	String	This value indicates whether or not the seller requires a deposit for the vehicle. This field is only applicable to U.S. eBay Motors listings. Otherwise, this field is returned as an empty value.
EBayPlusTransaction	Boolean	If true, this transaction is for an item that was purchased under the eBay Plus program.
ExtendedOrderId	String	A unique identifier for an eBay order.
FinalValueFee	Decimal	A Final Value Fee is calculated and charged to the account of a seller immediately upon creation of an order line item.
Gift	Boolean	This boolean field is returned as true if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items.
GiftSummaryMessage	String	This free-form text contains the message that the purchaser of the digital gift card left for the recipient of the gift card.
IntangibleItem	Boolean	This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. Intangible items are not eligible for the PayPal Seller Protection program, so the seller will not be able to open an Unpaid Item case against the buyer.
InvoiceSentTime	Datetime	This field indicates the date and time that an order invoice was sent from the seller to the buyer. This field is only returned if an invoice (containing the order line item) was sent to the buyer.
IsMultiLegShipping	Boolean	If IsMultilegShipping is true, the Global Shipping Program (GSP) will be used to ship the order line item to an international buyer.
LogisticsPlanType	String	This field will be returned only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the Click and Collect feature.
PaidTime	Datetime	Indicates the time when the order was marked paid. This field is not returned until payment has been made by the buyer. This field will not be returned for orders where the buyer has received partial or full refunds.
QuantityPurchased	Integer	This value indicates the number of identical items purchased at the same time by the same buyer from one listing.
ShippedTime	Datetime	Indicates the time when the items associated with the order were marked as shipped. This value will only be visible to the user on either side of the order. An order can be marked as shipped in My eBay, Selling Manager Pro, or programmatically by the seller through the CompleteSale stored procedure.
ShippingConvenienceCharge	Decimal	The amount that the seller is being charged for the convenience of an eBay Now delivery.
ExpeditedService	Boolean	Indicates whether the service is an expedited shipping service.
ShippingServiceImportCharge	Decimal	The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
ShippingInsuranceCost	Decimal	The insurance cost associated with shipping a single item with this shipping service.
ShippingPackageInfo	String	If the order is being delivered through eBay Now, it contains information on the status of the order, the unique identifier of the store where the order is originating from, and the expected and actual delivery times.
ShippingService	String	A shipping service option being offered by the seller to ship an item to a buyer.
ShippingServiceAdditionalCost	Decimal	The cost of shipping each additional item if the same buyer purchases one or more of the same line item.
ShippingServiceCost	Decimal	The base cost using the shipping service specified in the ShippingService field to ship the item. In the case of a multiple quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases one or more of the same line item.
ShippingServicePriority	Integer	This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.
ShippingTimeMax	Integer	The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
ShippingTimeMin	Integer	The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
BuyerSelectedShipping	Boolean	Indicates whether the buyer has selected shipping details during checkout.
CheckoutStatus	String	Indicates the current status of the checkout flow for the order.
CompleteStatus	String	Indicates whether checkout is complete, incomplete, or pending for an order.
DigitalStatus	String	The current state of a purchased digital gift card.
EBayPaymentStatus	String	Indicates the success or failure of the online payment for an order by the buyer.
InquiryStatus	String	This field gives the status of an Item Not Received (INR) Inquiry by the buyer. This field is only returned if the buyer has created an INR Inquiry.
LastTimeModified	Datetime	Indicates date and time the status of an order was last updated (in GMT).
PaymentHoldStatus	String	This field indicates the type and/or status of a payment hold on the item.
PaymentInstrument	String	The payment method used by a German buyer who was offered the Pay Upon Invoice option. This field will only be returned if a German buyer was offered the Pay Upon Invoice option. Otherwise, the payment method selected by the buyer is returned in the PaymentMethodUsed field.
PaymentMethodUsed	String	The payment method that the buyer selected to pay for the order. If checkout is not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.
ReturnStatus	String	This field gives the status of a return request from the buyer. This field is only returned if the buyer has initiated a return request or has escalated an existing return request into a return case.
TransactionPrice	Decimal	The price of the order line item (transaction).

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
ModTimeFrom	Datetime	The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemId. The ModTimeFrom field is the starting date range.
ModTimeTo	Datetime	The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemId. The ModTimeTo field is the ending date range.
NumberOfDays	Integer	This time filter specifies the number of days (24-hour periods) in the past to search for order line items.

ListingTypePolicies

Returns the listing type policies for the specified marketplace, with each row representing a listing type and duration combination per category.

Columns


Name	Type	Description
CategoryId [KEY]	String	The unique identifier of the eBay leaf category.
CategoryTreeId	String	The unique identifier of the category tree.
DigitalGoodDeliveryEnabled	Boolean	If true, the category supports digital good delivery, indicating that a listing can be created for a digital item, such as a PDF or a song.
PickupDropOffEnabled	Boolean	If true, the category supports the click and collect feature, where a buyer can purchase certain items on eBay and then pick up those items at a participating store.
ListingDurations	String	EBay listing types and the supported durations for the corresponding leaf category. If a specific eBay listing type does not appear for a leaf category, it indicates that the category does not support that listing type.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceId	String	The eBay marketplace for which policy information is retrieved.
Filter	String	Limits the response by returning metadata for specified leaf categories only. Format: categoryIds:{catId1\|catId2\|catId3}. Maximum 50 category IDs.

MotorsListingPolicies

Returns eBay Motors policy metadata for all leaf categories on the specified marketplace.

Columns


Name	Type	Description
CategoryId [KEY]	String	The unique identifier of the eBay leaf category.
CategoryTreeId	String	The unique identifier of the category tree.
DepositSupported	Boolean	If true, the category supports the use of a deposit or down payment on a motor vehicle listing.
EbayMotorsProAdFormatEnabled	String	Indicates whether eBay Motors Pro sellers can use classified ads in this category. Values from AdFormatEnabledEnum.
EbayMotorsProAutoAcceptEnabled	Boolean	If true, the category supports Best Offer Auto Accept for eBay Motors Pro listings.
EbayMotorsProAutoDeclineEnabled	Boolean	If true, the category allows auto-decline for Best Offers on eBay Motors Pro classified ad listings.
EbayMotorsProBestOfferEnabled	String	Indicates whether Best Offer features are supported for eBay Motors Pro classified ad listings. Values from ClassifiedAdBestOfferEnabledEnum.
EbayMotorsProCompanyNameEnabled	Boolean	If true, the category supports including company name in seller contact information for eBay Motors Pro.
EbayMotorsProContactByAddressEnabled	Boolean	If true, the category supports including address in seller contact information for eBay Motors Pro.
EbayMotorsProContactByEmailEnabled	Boolean	If true, the category supports including email in seller contact information for eBay Motors Pro.
EbayMotorsProContactByPhoneEnabled	Boolean	If true, the category supports including telephone in seller contact information for eBay Motors Pro.
EbayMotorsProCounterOfferEnabled	Boolean	If true, counter offers are allowed on Best Offers for eBay Motors Pro classified ad listings in this category.
EbayMotorsProPaymentMethodCheckOutEnabled	String	Indicates whether the payment method should be displayed for eBay Motors Pro classified ad listings. Values from ClassifiedAdPaymentMethodEnabledEnum.
EbayMotorsProPhoneCount	Integer	The number of phone numbers that can be included in contact information for eBay Motors Pro.
EbayMotorsProSellerContactDetailsEnabled	Boolean	If true, seller-level contact information is available for eBay Motors Pro classified ad listings.
EbayMotorsProShippingMethodEnabled	Boolean	If true, shipping options should be displayed for eBay Motors Pro classified ad listings in this category.
EbayMotorsProStreetCount	Integer	The number of street addresses allowed in contact information for eBay Motors Pro.
EpidSupported	Boolean	If true, the category supports the use of an eBay Product ID (ePID) to identify compatible motorcycles and scooters.
KTypeSupported	Boolean	If true, the category supports the use of a K type to identify compatible cars and trucks. Supported on AU, DE, ES, FR, IT, and UK marketplaces.
LocalListingDistances	String	Supported distances in miles for different Local Market subscription types in this category.
LocalMarketAdFormatEnabled	String	Indicates whether Local Market classified ad listings are supported in this category. Values from AdFormatEnabledEnum.
LocalMarketAutoAcceptEnabled	Boolean	If true, the category supports auto-accept for Best Offers on Local Market classified ad listings.
LocalMarketAutoDeclineEnabled	Boolean	If true, the category supports auto-decline for Best Offers on Local Market classified ad listings.
LocalMarketBestOfferEnabled	String	Indicates whether Best Offer is enabled or required for Local Market classified ad listings. Values from ClassifiedAdBestOfferEnabledEnum.
LocalMarketCompanyNameEnabled	Boolean	If true, the category supports including company name in seller contact information for Local Market listings.
LocalMarketContactByAddressEnabled	Boolean	If true, the category supports including address in seller contact information for Local Market listings.
LocalMarketContactByEmailEnabled	Boolean	If true, the category supports including email in seller contact information for Local Market listings.
LocalMarketContactByPhoneEnabled	Boolean	If true, the category supports including telephone in seller contact information for Local Market listings.
LocalMarketCounterOfferEnabled	Boolean	If true, counter offers are allowed on Best Offers for Local Market classified ad listings in this category.
LocalMarketNonSubscription	Boolean	If true, the category supports creating Local Market listings without a subscription. Only available to licensed vehicle dealers.
LocalMarketPaymentMethodCheckOutEnabled	String	Indicates whether the payment method should be displayed for Local Market classified ad listings. Values from ClassifiedAdPaymentMethodEnabledEnum.
LocalMarketPhoneCount	Integer	The number of phone numbers that can be included in contact information for Local Market listings.
LocalMarketPremiumSubscription	Boolean	If true, the category supports Premium level subscription to Local Market listings. Only available to licensed vehicle dealers.
LocalMarketRegularSubscription	Boolean	If true, the category supports Regular level subscription to Local Market listings. Only available to licensed vehicle dealers.
LocalMarketSellerContactDetailsEnabled	Boolean	If true, seller-level contact information is available for Local Market classified ad listings.
LocalMarketShippingMethodEnabled	Boolean	If true, shipping methods should be displayed for Local Market classified ad listings in this category.
LocalMarketSpecialitySubscription	Boolean	If true, the category supports Speciality level subscription to Local Market listings. Only available to licensed vehicle dealers.
LocalMarketStreetCount	Integer	The number of street addresses allowed in contact information for Local Market listings.
MaxGranularFitmentCount	Integer	Maximum number of compatible applications allowed per item at the most detailed granularity (e.g., Year, Make, Model, Trim, Engine).
MaxItemCompatibility	Integer	Maximum number of compatible applications allowed per item when specifying parts compatibility manually.
MinItemCompatibility	Integer	Minimum number of required compatible applications for listing items. A value of 0 means it is not mandatory.
NonSubscription	String	Indicates whether the category supports Local Market listings without a vehicle subscription. Values from GeographicExposureEnum.
PremiumSubscription	String	Indicates whether the category supports Local Market listings with a Premium vehicle subscription. Values from GeographicExposureEnum.
RegularSubscription	String	Indicates whether the category supports Local Market listings with a Regular vehicle subscription. Values from GeographicExposureEnum.
SellerProvidedTitleSupported	Boolean	If true, the category supports seller-provided titles for motor vehicle listings on US or Canada Motors marketplaces.
SpecialitySubscription	String	Indicates whether the category supports Local Market listings with a Specialty vehicle subscription. Values from GeographicExposureEnum.
VinSupported	Boolean	If true, Vehicle Identification Number (VIN) is supported in this category.
VrmSupported	Boolean	If true, Vehicle Registration Mark (VRM) is supported in this category.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceId	String	The eBay marketplace for which policy information is retrieved. Use EBAY_MOTORS_US for eBay US Motors categories.
Filter	String	Limits the response by returning metadata for specified leaf categories only. Format: categoryIds:{catId1\|catId2\|catId3}. Maximum 50 category IDs.

NegotiatedPricePolicies

Returns the negotiated price (Best Offer) policies for the specified marketplace.

Columns


Name	Type	Description
CategoryId [KEY]	String	The unique identifier of the eBay leaf category.
CategoryTreeId	String	The unique identifier of the category tree.
BestOfferAutoAcceptEnabled	Boolean	If true, the category supports the setting of an auto-accept value as part of the Best Offer.
BestOfferAutoDeclineEnabled	Boolean	If true, the category supports the setting of an auto-decline value as part of the Best Offer.
BestOfferCounterEnabled	Boolean	If true, the category supports the making of counteroffers to Best Offers by the seller.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceId	String	The eBay marketplace for which policy information is retrieved.
Filter	String	Limits the response by returning metadata for specified leaf categories only. Format: categoryIds:{catId1\|catId2\|catId3}. Maximum 50 category IDs.

OrderPayments

Query all payments of the orders, in which the authenticated user is either the buyer or seller. By default, only payment details of orders made in the last 90 days are returned. Payment details of orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information

Select

Examples of querying the OrderPayments view:

SELECT * FROM OrderPayments WHERE ModTimeFrom = '2/22/2018'

SELECT * FROM OrderPayments WHERE NumberOfDays = '30'

Columns


Name	Type	Description
PaymentId [KEY]	String	A unique transaction ID for the payment.
OrderId	String	A unique identifier for an eBay order.
FeeOrCreditAmount	Decimal	Fee Amount is a positive value and Credit Amount is a negative value.
Payee	String	The person or organization who is to receive the payment allocation.
Payer	String	This field indicates the eBay user or eBay partner who submitted the payment.
PaymentAmount	Decimal	The amount of the payment that is allocated to the payee.
PaymentStatus	String	The current status of a buyer payment that is allocated to a specified payee.
PaymentTime	Datetime	The date and time when the payment is received by the payee.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
CreateTimeFrom	Datetime	Specifies the start of the date range for which to retrieve payment details of the orders created within this date range.
CreateTimeTo	Datetime	Specifies the end of the date range for which to retrieve payment details of the orders created within this date range.
ModTimeFrom	Datetime	Specifies the start of the date range for which to retrieve payment details of the orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	Specifies the end of the date range for which to retrieve payment details of the orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	All eBay payment details of the orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	Filters the returned payment details of the orders based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	Filters the returned payment details of the orders based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Orders

Query all orders in which the authenticated user is either the buyer or seller. By default, only orders made in the last 90 days are returned. Orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information

Select

Examples of querying the Orders view:

SELECT * FROM Orders WHERE OrderId = '110276240386-28854859001'

SELECT * FROM Orders WHERE OrderId IN ('110276240386-28854859001', '110277719772-28859911001')

SELECT * FROM Orders WHERE CreateTimeFrom = '2018-02-10' AND CreateTimeTo = '2018-03-16'

SELECT * FROM Orders WHERE OrderStatus = 'Active'

SELECT * FROM Orders WHERE NumberOfDays = '26'

Columns


Name	Type	Description
OrderId [KEY]	String	A unique identifier for an eBay order.
ExtendedOrderId	String	The unique identifier of the order in legacy format, as traditionally used by the Trading API.
BuyerUserId	String	eBay user ID of the order's buyer.
SellerUserId	String	This is the eBay user ID of the order's seller.
OrderStatus	String	This enumeration value indicates the current status of the order. Applicable Values: Active, All, Cancelled, Completed, Inactive.
AdjustmentAmount	Decimal	This value indicates the dollar amount by which the buyer has adjusted the order total.
AmountPaid	Decimal	This value indicates the total amount of the order.
AmountSaved	Decimal	This value indicates the shipping discount experienced by the buyer as a result of creating a Combined Invoice order.
CreatedTime	Datetime	Timestamp that indicates the date and time that the order was created.
ShippedTime	Datetime	Timestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped.
PaymentMethod	String	The payment method that the buyer selected to pay for the order.
PaymentStatus	String	This value indicates the payment status of an order.
CheckoutStatus	String	Container consisting of details related to the current checkout status of the order.
SellerEmail	String	The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call.
SubTotal	Decimal	The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs.
Total	Decimal	The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.
CancelCompleteDate	Datetime	Timestamp indicating when the cancellation process of an eBay order has been completed.
CancelInitiationDate	Datetime	This timestamp indicates when the cancellation of the eBay order was initiated.
CancelInitiator	String	This value indicates which party initiated the cancellation of the eBay order.
CancelReason	String	This value indicates the reason why the order cancellation was initiated.
CancelStatus	String	The current status for the order cancellation request if it exists.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
CreateTimeFrom	Datetime	Specifies the start of the date range for which to retrieve orders created within this date range.
CreateTimeTo	Datetime	Specifies the end of the date range for which to retrieve orders created within this date range.
ModTimeFrom	Datetime	Specifies the start of the date range for which to retrieve orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	Specifies the end of the date range for which to retrieve orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	All eBay orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	Filters the returned orders based on the role of the user. The user's role is either buyer or seller.

OrderShipping

Query shipping details of the orders in which the authenticated user is either the buyer or seller. By default, only shipping details of orders made in the last 90 days are returned. Shipping details of orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information

Select

Examples of querying the OrderShipping view:

SELECT * FROM OrderShipping WHERE NumberOfDays = '30'

SELECT * FROM OrderShipping WHERE CreateTimeFrom = '2018-02-10' AND CreateTimeTo = '2018-03-16'

Columns


Name	Type	Description
OrderId [KEY]	String	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
AddressId	String	Unique ID for a user's address in the eBay database.
CityName	String	The name of the user's city.
Country	String	The two-digit code representing the country of the user.
CountryName	String	The name of the user's country.
AddressName	String	User's name for the address.
Phone	String	User's primary phone number.
PostalCode	String	User's postal code.
StateOrProvince	String	The state or province of the user's address. Whether it's a state or a province will depend on the region and/or country.
Street1	String	The first line of the user's street address.
Street2	String	The second line of the user's street address (such as an apartment number or suite number).
ShippingCharge	Decimal	The dollar value in this field indicates the amount that the seller is being charged (at order level) for the convenience of an eBay On Demand Delivery.
ExpeditedService	Boolean	Indicates whether the service is an expedited shipping service.
ShippingImportCharge	Decimal	The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program.
ShippingInsuranceCost	Decimal	The insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCost	Decimal	The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item.
ShippingServiceCost	Decimal	The base cost of shipping the item using the shipping service specified in the ShippingService field.
ActualDeliveryTime	Datetime	This timestamp indicates when the order was actually delivered to the buyer.
EstimatedDeliveryTimeMax	Datetime	The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery.
EstimatedDeliveryTimeMin	Datetime	The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery.
HandleByTime	Datetime	This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window.
ScheduledDeliveryTimeMax	Datetime	The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order.
ScheduledDeliveryTimeMin	Datetime	The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order.
ShippingTrackingEvent	String	This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value.
StoreId	String	The unique identifier of the store from where the order will be delivered.
SalesTaxAmount	Decimal	The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information.
SalesTaxPercent	Float	Percent of an item's price to be charged as the sales tax for the order.
SalesTaxState	String	State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value.
ShipmentTrackingNumbers	String	The tracking numbers assigned by the shipping carriers.
ShippingCarriers	String	The name of the shipping carriers used to ship the items.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
CreateTimeFrom	Datetime	Specifies the start of the date range for which to retrieve shipping details of the orders created within this date range.
CreateTimeTo	Datetime	Specifies the end of the date range for which to retrieve shipping details of the orders created within this date range.
ModTimeFrom	Datetime	Specifies the start of the date range for which to retrieve shipping details of the orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	Specifies the end of the date range for which to retrieve shipping details of the orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	All eBay shipping details of the orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	Filters the returned shipping details of the orders based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	Filters the returned shipping details of the orders based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

PaymentPolicies

Retrieves all the payment policies configured for the marketplace you specify using the MarketplaceId query parameter.

Select

MarketplaceId is required filter in the Select query. You can follow the query below to obtain the required values through SQL:

SELECT * FROM PaymentPolicies WHERE MarketplaceId = 'EBAY_US'

Some of the fields are named with the suffix Aggr. These fields display the content of the JSON tag with the same name that is returned from the API endpoint.

Columns


Name	Type	Description
PaymentPolicyId [KEY]	String	A unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created.
Description	String	The Description of the payment policy.
Name	String	The Description of the payment policy.
CategoryTypesName	String	The Category Type name value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't.
DepositAggr	String	Amounts and due dates for deposits on motor vehicle listings on eBay Motors. Is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES.
MarketplaceId	String	The ID of the eBay marketplace to which the payment policy applies.
ImmediatePay	Boolean	If set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item).
PaymentMethodAggr	String	If the seller is not opted-in to managed payments, this container returns a list of the payment methods accepted by the seller.
RecipientAccountReferenceId	String	Contains the PayPal email address of the recipient (buyer) if referenceType is set to PAYPAL_EMAIL.
RecipientAccountReferenceType	String	A reference a recipient's account. Currently only PAYPAL_EMAIL is valid.

ReturnPolicies

Retrieves all the return policies configured for the marketplace you specify using the MarketplaceId query parameter.

Select

MarketplaceId is required filter in the Select query. You can follow the query below to obtain the required values through SQL:

SELECT * FROM ReturnPolicies WHERE MarketplaceId = 'EBAY_US'

Some of the fields are named with the suffix Aggr. These fields display the content of the JSON tag with the same name that is returned from the API endpoint.

Columns


Name	Type	Description
ReturnPolicyId [KEY]	String	A unique eBay-assigned ID for this policy.
Description	String	The seller-defined description of the return policy for internal use (this value is not displayed to end users).
Name	String	The category type to which the policy applies (motor vehicles or non-motor vehicles).
CategoryTypesName	String	The category type to which the policy applies (motor vehicles or non-motor vehicles).
MarketplaceId	String	The ID of the eBay marketplace to which this return policy applies.
ExtendedHolidayReturnsOffered	String	If set to true, the seller offers an Extended Holiday Returns policy for their listings.
InternationalOverrideAggr	String	If populated, specifies the seller's policies for international returns (items that require postage via an international shipping service).
RefundMethod	String	Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns.
RestockingFeePercentage	String	For sellers who accept returns, this field is filled if they charge buyers a restocking fee when items are returned.
ReturnInstructions	String	Contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page.
ReturnMethod	String	Valid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns.
ReturnPeriodValue	String	Specifies the amount of time the buyer has to return an item.
ReturnPeriodUnit	String	Specifies the unit of measure of amount of time the buyer has to return an item.
ReturnsAccepted	Boolean	If set to true, the seller accepts returns.
ReturnShippingCostPayer	String	This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER.

ShippingCarriers

Query Shipping Carriers supported by the specified site.

Columns


Name	Type	Description
ShippingCarrierId	Integer	Numeric identifier.
Description	String	Display string that applications can use to present a list of shipping carriers in a more user-friendly format (such as in a drop-down list).
DetailVersion	String	Returns the latest version number for this field.
ShippingCarrier	String	The code for the shipping carrier.
UpdateTime	Datetime	Gives the time in GMT that the feature flags for the details were last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
DetailName	String	A designation of what kind of information you wish returned for the specified eBay site. The allowed values are ShippingCarrierDetails.

ShippingCategories

A shipping service category supported for the site.

Columns


Name	Type	Description
ShippingCategory [KEY]	String	Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category. For more information on these shipping categories, and which services fall into which category, see the Shipping Basics page on the eBay Shipping Center site.
Description	String	Display string that applications can use to present a list of shipping categories in a more user-friendly format (such as in a drop-down list). This field is localized per site.
DetailVersion	String	Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTime	Datetime	Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
DetailName	String	A designation of what kind of information you wish returned for the specified eBay site. The allowed values are ShippingCategoryDetails.

ShippingLocations

Lists the regions and locations supported by eBay's shipping services. Returns all shipping locations supported by eBay, regardless of the site specified in the request.

Columns


Name	Type	Description
ShippingLocation [KEY]	String	Short name or abbreviation for a region (e.g., Asia) or location (e.g. Japan).
Description	String	Display string that applications can use to present a list of shipping locations in a more user-friendly format (such as in a drop-down list). This field is localized in the language of the site.
DetailVersion	String	Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTime	Datetime	Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
DetailName	String	A designation of what kind of information you wish returned for the specified eBay site. The allowed values are ShippingLocationDetails.

ShippingPolicies

Returns shipping policy metadata for all leaf categories on the specified marketplace.

Columns


Name	Type	Description
CategoryId [KEY]	String	The unique identifier of the eBay leaf category.
CategoryTreeId	String	The unique identifier of the category tree.
GlobalShippingEnabled	Boolean	If true, the Global Shipping Program (GSP) is supported for the category. GSP is only supported by the eBay UK marketplace (EBAY_GB).
Group1MaxFlatShippingCostValue	String	The maximum flat shipping cost for shipping service group 1.
Group1MaxFlatShippingCostCurrency	String	The currency of the maximum flat shipping cost for shipping service group 1 (ISO 4217 code).
Group2MaxFlatShippingCostValue	String	The maximum flat shipping cost for shipping service group 2.
Group2MaxFlatShippingCostCurrency	String	The currency of the maximum flat shipping cost for shipping service group 2 (ISO 4217 code).
Group3MaxFlatShippingCostValue	String	The maximum flat shipping cost for shipping service group 3.
Group3MaxFlatShippingCostCurrency	String	The currency of the maximum flat shipping cost for shipping service group 3 (ISO 4217 code).
HandlingTimeEnabled	Boolean	If true, a seller's stated handling time is enabled for the category. Generally needed for shipped items, not necessarily for freight or local pickup.
MaxFlatShippingCostValue	String	The maximum cost the seller can charge for the first domestic flat-rate shipping service. Mutually exclusive with group shipping costs.
MaxFlatShippingCostCurrency	String	The currency of the maximum flat shipping cost (ISO 4217 code). Mutually exclusive with group shipping costs.
ShippingTermsRequired	Boolean	If true, the category requires sellers to specify shipping details at listing time.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
MarketplaceId	String	The eBay marketplace for which shipping policy information is retrieved.
Filter	String	Limits the response by returning metadata for specified leaf categories only. Format: categoryIds:{catId1\|catId2\|catId3}. Maximum 50 category IDs.

ShippingServices

Query Shipping Services supported by the specified eBay site.

Table Specific Information

Select

The following query retrieves all available Shipping Services. There are no supported filters for this view.

SELECT * FROM ShippingServices

Columns


Name	Type	Description
ShippingServiceId [KEY]	Integer	Numeric identifier. A value greater than 50000 represents an international shipping service.
CODService	Boolean	This flag is returned as true if the corresponding ShippingService value is a COD (Cash-On-Delivery) service.
CostGroupFlat	Boolean	If returned, this is the shipping service group to which the shipping service belongs.
Description	String	A user-friendly description of shipping service options.
DetailVersion	String	Returns the latest version number for this field.
DimensionsRequired	Boolean	Whether the shipping service option requires that package dimensions are provided by the seller.
ExpeditedService	Boolean	Indicates whether the shipping service is an expedited shipping service. Only returned for sites for which the Get It Fast feature is enabled and only if true.
InternationalService	Boolean	Indicates whether the shipping service is an international shipping service.
MappedToShippingServiceId	Integer	The Id of another shipping service that will be used when a shipping service is deprecated.
ShippingCategory	String	Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category.
ShippingService	String	The name of the shipping service option. If the ValidForSellingFlow column is not true, this particular shipping service option is no longer valid and cannot be offered to buyers through a listing.
ShippingTimeMax	Integer	The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service.
ShippingTimeMin	Integer	The minimum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service.
SurchargeApplicable	Boolean	True if a surcharge applies for any region that this service ships to.
UpdateTime	Datetime	Gives the time in GMT that the feature flags for the details were last updated.
ValidForSellingFlow	Boolean	If this field is returned as true, the shipping service option can be used. If this field is returned as false, the shipping service option is not currently supported.
WeightRequired	Boolean	If true, a seller who selects this package type for the listing and then offers this shipping service must specify WeightMajor and WeightMinor in the item definition. If not returned, WeightRequired is false.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
DetailName	String	A designation of what kind of information you wish returned for the specified eBay site. The allowed values are ShippingServiceDetails.

Sites

Lists all available eBay sites and their associated SiteID numbers.

Columns


Name	Type	Description
SiteID	Integer	Numeric identifier for an eBay site. If you are using the SOAP API, you use numeric site IDs in the request URL. If you are using the XML API, you use numeric site IDs in the X-EBAY-API-SITEID header.
SiteName	String	Short name that identifies an eBay site. Usually, an eBay site is associated with a particular country or region (e.g., US or Belgium_French). Specialty sites (e.g., eBay Stores) use the same site ID as their associated main eBay site. The US eBay Motors site is an exception to this convention.
DetailVersion	String	Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
UpdateTime	Datetime	Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
DetailName	String	A designation of what kind of information you wish returned for the specified eBay site. The allowed values are SiteDetails.

TransactionLinkedItems

Query all linked line items of the transactions in which the authenticated user is either the buyer or seller. By default, only linked line items of transactions made in the last 90 days are returned. Linked line items of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

Columns


Name	Type	Description
ID [KEY]	String	The unique identifier of the linked order line item.
TransactionId	String	Unique identifier for an eBay sales transaction.
OrderId	String	The unique identifier of the order to which the linked line item belongs.
EstimatedDeliveryTimeMax	Datetime	Indicates the latest date and time to receive the order.
EstimatedDeliveryTimeMin	Datetime	Indicates the earliest date and time to receive the order.
SellerUserID	String	The eBay user ID of the seller who sold the linked line item.
ItemName	String	Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name.
ItemValue	String	Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier.
ItemsTitle	String	This field is used to specify the title of the listing.
CreateTimeFrom	Datetime	Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
CreateTimeTo	Datetime	Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
ModTimeFrom	Datetime	Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

TransactionPayments

Query all payments of the transactions in which the authenticated user is either the buyer or seller. By default, only payments of transactions made in the last 90 days are returned. Payments of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

View Specific Information

Select

Examples of querying the TransactionPayments view:

SELECT * FROM TransactionPayments WHERE OrderRole = 'Seller'

SELECT * FROM TransactionPayments WHERE OrderId = '110277719772-28859911001'

Columns


Name	Type	Description
TransactionReferenceId [KEY]	String	A unique transaction ID for the payment.
TransactionId	String	The unique identifier of the transaction the payment has been made for.
OrderId	String	The unique identifier of the order the payment has been made for.
FeeOrCreditAmount	Decimal	Fee Amount is a positive value and Credit Amount is a negative value.
Payee	String	The person or organization who is to receive the payment allocation.
Payer	String	This field indicates the eBay user or eBay partner who submitted the payment.
PaymentAmount	Decimal	The amount of the payment that is allocated to the payee.
PaymentStatus	String	The current status of a buyer payment that is allocated to a specified payee.
PaymentTime	Datetime	The date and time when the payment is received by the payee.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
CreateTimeFrom	Datetime	Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
CreateTimeTo	Datetime	Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
ModTimeFrom	Datetime	Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

TransactionRefunds

Query all refunds of the transactions in which the authenticated user is either the buyer or seller. By default, only refunds of transactions made in the last 90 days are returned. Refunds of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

Columns


Name	Type	Description
ReferenceId [KEY]	String	This dollar value is the amount of the refund to the buyer for this specific refund transaction.
TransactionId	String	The unique identifier of the transaction the payment has been made for.
OrderId	String	The unique identifier of the order the payment has been made for.
FeeOrCreditAmount	Decimal	Fee Amount is a positive value and Credit Amount is a negative value.
RefundTo	String	This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant.
RefundType	String	This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item.
RefundAmount	Decimal	This dollar value is the amount of the refund to the buyer for this specific refund transaction.
RefundStatus	String	This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item.
RefundTime	Datetime	This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED).
CreateTimeFrom	Datetime	Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
CreateTimeTo	Datetime	Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days.
ModTimeFrom	Datetime	Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Transactions

Query all transactions in which the authenticated user is either the buyer or seller. By default, only transactions of orders made in the last 90 days are returned. Transactions of orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information

Select

Examples of querying the Transactions view.

SELECT * FROM Transactions WHERE OrderRole = 'Seller'

SELECT * FROM Transactions WHERE OrderId = '110276240386-28854859001'

SELECT * FROM Transactions WHERE CreateTimeFrom = '2/10/2018' AND CreateTimeTo = '3/16/2018'

Columns


Name	Type	Description
TransactionId [KEY]	String	Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item.
OrderId	String	The Id that uniquely identifies the item listing. The Id is generated by eBay after an item is listed. You cannot choose or revise this value.
ItemId	String	The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed.
ItemSite	String	The name of the site on which the item is listed.
ItemTitle	String	This field is used to specify the title of the listing.
ActualHandlingCost	Decimal	The handling cost that the seller has charged for the order line item.
ActualShippingCost	Decimal	The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete.
BuyerEmail	String	Email address for the user.
BuyerFirstName	String	The first name of the buyer who purchased the order.
BuyerLastName	String	The last name of the buyer who purchased the order.
CreatedDate	Datetime	Indicates the creation time of the order line item.
Price	Decimal	The price of the order line item.
SiteId	String	The site upon which the order line item (transaction) was created.
PaidTime	Datetime	Indicates the time when the order was marked paid.
DigitalRecipientEmail	String	This field displays the email address of the sender/purchaser of the digital gift card.
DigitalRecipientName	String	This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card.
DigitalSenderEmail	String	This field displays the email address of the sender/purchaser of the digital gift card.
DigitalSenderName	String	This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card
DigitalDeliveryMethod	String	This value indicates the method in which the digital gift card will be delivered to the buyer.
EBayPlusTransaction	Boolean	If true, this transaction is for an item that was purchased under the eBay Plus program.
FinalValueFee	Decimal	A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item.
GuaranteedDelivery	Boolean	This field is returned as true if the order line item is qualified for eBay Guaranteed Delivery, or false if it is not eligible.
GuaranteedShipping	Boolean	This field is returned as true if the seller chose to use eBay's Guaranteed Shipping feature at listing time.
InvoiceSentTime	Datetime	This field indicates the date/time that an order invoice was sent from the seller to the buyer.
DigitalStatus	String	This enumeration value indicates the current state of a purchased digital gift card.
InquiryStatus	String	This field gives the status of a buyer's Item Not Received (INR) Inquiry.
ReturnStatus	String	This field gives the status of a buyer's return request.
TotalTaxAmount	Decimal	This value indicates the total tax amount for the order line item, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
CreateTimeFrom	Datetime	Specifies the start of the date range for which to retrieve transactions of orders created within this date range.
CreateTimeTo	Datetime	Specifies the end of the date range for which to retrieve transactions of orders created within this date range.
ModTimeFrom	Datetime	Specifies the start of the date range for which to retrieve transactions of orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	Specifies the end of the date range for which to retrieve transactions of orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	All eBay transactions that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	Filters the returned transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	Filters the returned transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

TransactionShipping

Query shipping details of the transactions in which the authenticated user is either the buyer or seller. By default, only shipping details of transaction made in the last 90 days are returned. Shipping details of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

View Specific Information

Select

Examples of querying the TransactionShipping view:

SELECT * FROM TransactionShipping WHERE ModTimeFrom = '2/22/2018' AND ModTimeTo = '3/4/2018'

SELECT * FROM TransactionShipping WHERE OrderId = '110277719772-28859911001'

SELECT * FROM TransactionShipping WHERE OrderId IN ('110277719772-28859911001', '110276240386-28854859001')

Columns


Name	Type	Description
TransactionId [KEY]	String	Unique identifier for the transaction.
OrderId	String	Unique identifier for the order.
InternationalPackagingHandlingCosts	Decimal	Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge).
PostalCode	String	Postal code for the location from which the package will be shipped.
PackagingHandlingCosts	Decimal	Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge).
ShippingIrregular	Boolean	This boolean field indicates that the shipping package is considered an irregular shape and/or size by the shipping carrier, and thus requires special handling.
ExpeditedService	Boolean	Indicates whether the service is an expedited shipping service.
ShippingImportCharge	Decimal	The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program.
ShippingInsuranceCost	Decimal	The insurance cost associated with shipping a single item with this shipping service.
ShippingServiceAdditionalCost	Decimal	The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item.
ShippingServiceCost	Decimal	The base cost of shipping the item using the shipping service specified in the ShippingService field.
ShippingPackageInfo	String	This aggregate contains all shipping package info.
ShipmentTrackingNumbers	String	The tracking numbers assigned by the shipping carriers.
ShippingCarriers	String	The name of the shipping carriers used to ship the items.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.


Name	Type	Description
CreateTimeFrom	Datetime	Specifies the start of the date range for which to retrieve shipping details of the transactions in orders created within this date range. By default the date range is 90 days.
CreateTimeTo	Datetime	Specifies the end of the date range for which to retrieve shipping details of the transactions in orders created within this date range. By default the date range is 90 days.
ModTimeFrom	Datetime	Specifies the start of the date range for which to retrieve shipping details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo	Datetime	Specifies the end of the date range for which to retrieve shipping details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays	Integer	All eBay shipping details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole	String	Filters the returned shipping details of the transactions based on the role of the user. The user's role is either buyer or seller.
OrderStatus	String	Filters the returned shipping details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with eBay.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from eBay, along with an indication of whether the procedure succeeded or failed.

CData Python Connector for eBay Stored Procedures


Name	Description
AddItem	Create and publish a new Item Listing on an eBay site.
CompleteSale	Do various tasks after the creation of a single line item or multiple line item order. For example, complete a sale and leave feedback.
CreateInventoryTask	This procedure creates an inventory-related download task for a specified feed type with optional filter criteria.
CreateOrderTask	This procedure creates an order download task with filter criteria for the order report.
GetOAuthAccessToken	Gets the OAuth access token from eBay.
GetOAuthAuthorizationURL	Gets the eBay authorization URL. Access the URL returned in the output in an Internet browser. This requests the access token that can be used as part of the connection string to eBay.
GetResultFile	This procedure retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz).
RefreshOAuthAccessToken	Refreshes the OAuth access token used for authentication with EBay.
SetUserNotes	Add, replace, and delete My eBay notes for items that are being tracked in the My eBay Selling and Buying areas.
UploadFile	Uploads a file to the EBay account.

AddItem

Create and publish a new Item Listing on an eBay site.

Stored Procedure Specific Information

Upon the successful creation of an Item Listing, an Item Id is returned in the response along with the estimated fees for listing the Item. After adding an item, you can use the ItemListing table to update, delete, and query.

The inputs required to add any item are the following: Title, Description, CategoryId, StartPrice, ConditionId, Country, Currency, DispatchTimeMax, ListingDuration, ListingType, PaymentMethod, PayPalEmailAddress, Quantity, Location, and ReturnsAcceptedOption.

You also need to specify several inputs required to select a shipping type: Flat or Calculated. Both shipping types require a ShippingService to be specified.

Add an Item

You can follow the procedure below to obtain the required values and add an item through SQL:

Use the CategoryTree view to browse the category hierarchy and find a leaf CategoryId for your item. A leaf category Id is required to add an item.
Use the ShippingServices view to select a Shipping Service. The value of the ValidForSellingFlow column must be true; otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

Selecting Flat Shipping

The following inputs are required for the Flat shipping type: ShippingType, ShippingService, ShippingServicePriority, and ShippingServiceCost.

Selecting CalculatedShipping

The Calculated shipping type requires additional information related to package stats. The following inputs are required for this shipping type: ShippingType, WeightMajor, WeightMinor, OriginatingPostalCode, ShippingService, and ShippingServicePriority.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.

Input


Name	Type	Required	Description
Title	String	False	Name of the item as it appears in the listing or search results.
Description	String	False	The description of the item by the seller. In listing requests, you can use CDATA tags to submit your description if you want to use HTML or XML-reserved characters in the description.
CategoryId	String	False	Category Id for the first (or only) category in which the item is listed (or will be listed, if the item is new).
StartPrice	String	False	The original price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes the original price.
ConditionId	String	False	An identifier for the condition of the item. For example, 1000 for New or 3000 for Used.
Country	String	False	Defines the 2-letter ISO 3166 country code.
Currency	String	False	Currency associated with the price information of the item. 3-letter ISO 4217 currency code.
DispatchTimeMax	String	False	Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. This time does not include the shipping time (the transit time of the carrier). Including this field fulfills 'Handling time' being required for input.
ListingDuration	String	False	Describes the number of days the seller wants the listing to be active (available for bidding/buying).
ListingType	String	False	The format of the listing the seller wants to use, such as Chinese auction or fixed price.
Location	String	False	Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold), and it does not end within 12 hours.
ReturnsAcceptedOption	String	False	Indicates whether the seller allows the buyer to return the item. One of the following values: ReturnsAccepted or ReturnsNotAccepted. If you specify ReturnsNotAccepted, the View Item page will indicate that returns are not accepted instead.
SubTitle	String	False	Subtitle to use in addition to the title.
Quantity	String	False	The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing.
Sku	String	False	A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product.
UUID	String	False	Universally unique constraint tag. Use UUID to ensure that you only list a particular item once, particularly if you are listing many items at once.
ScheduleTime	String	False	Allows the user to specify the time that the listing becomes active on eBay.
PaymentMethod	String	False	Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item.
PayPalEmailAddress	String	False	The PayPal email address of the seller.
LiveAuction	String	False	This field must be included and set to true if the listing will be a part of a Live Auction. This boolean field is returned as true in the ItemList table if the listing is part of a Live Auction. See the eBay Live Auctions home page for more information about Live Auctions on eBay.com.
LotSize	String	False	A lot is a set of two or more similar items included in a single listing that must be purchased together in a single order line item. The LotSize value is the number of items in the lot. This field is required if two or more items are including in one listing.
PostalCode	String	False	Postal code of the place where the item is located. This value is used for proximity searches.
TaxCategory	String	False	Tax exception category code.
UseTaxTable	String	False	Indicates whether the tax table of the seller is to be used when applying and calculating sales tax for an order line item.
VIN	String	False	This field displays the Vehicle Identification Number, which is a unique serial number for a motor vehicle.
VRM	String	False	Vehicle Registration Mark, which is a unique identifier for a motor vehicle in the UK.
CategoryMappingAllowed	String	False	Controls how eBay handles cases in which the category no longer exists in the current category structure: If true, eBay will use the new Id for the listing; if false, an error is returned.
UseRecommendedProduct	String	False	If true, and the item details in the request match a product in the eBay catalog, the matching product is used to list the item.
ShippingType	String	False	The shipping cost model offered by the seller.
ShippingService	String	False	A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, query the ShippingServices view; the ShippingService returned must have a value of true in the ValidForSellingFlow column.
ShippingServicePriority	String	False	This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services.
ShippingServiceCost	String	False	The base cost of shipping the item by using the shipping service specified in the ShippingService field, if one was specified. This column includes the packaging and handling cost for flat and calculated shipping. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. This value reflects savings from a promotional shipping service option. Also applicable to Half.com.
ShippingServiceAdditionalCost	String	False	The cost of shipping each additional item if the same buyer purchases multiple quantities of the same line item. If less than ShippingServiceCost, this column gives the buyer a shipping discount. This field is required when creating a multiple-quantity fixed-price listing. This field is not applicable for single-quantity listings.
FreeShipping	String	False	Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.
ShippingPackage	String	False	The nature of the package used to ship the item(s). Required for calculated shipping only.
ShippingIrregular	String	False	Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling.
MeasurementUnit	String	False	Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, it overrides the system specified by measurementSystem. If MeasurementUnit and measurementSystem are not specified, the following defaults will be used: English: US Metric: CA, CAFR, AU.
MeasurementSystem	String	False	System of Measurement for PackageDepth, PackageLength, PackageWidth, WeightMajor, and WeightMinor (English or Metric).
PackageDepth	String	False	Depth of the package needed to ship the item.
PackageDepthUnit	String	False	Unit of measurement for PackageDepth (e.g., in, cm).
PackageLength	String	False	Length of the package needed to ship the item.
PackageLengthUnit	String	False	Unit of measurement for PackageLength (e.g., in, cm).
PackageWidth	String	False	Width of the package needed to ship the item.
PackageWidthUnit	String	False	Unit of measurement for PackageWidth (e.g., in, cm).
WeightMajor	String	False	The major unit used to specify the weight of a shipping package. For example, lbs.
WeightMajorUnit	String	False	Unit of measurement for WeightMajor.
WeightMinor	String	False	The minor unit used to specify the weight of a shipping package. For example, oz.
WeightMinorUnit	String	False	Unit of measurement for WeightMinor.
BestOfferEnabled	String	False	This field indicates whether or not the Best Offer feature is enabled for this item.
ShipToRegistrationCountry	String	False	The seller includes and sets this field to true as a mechanism to block bidders who reside (according to their eBay primary shipping address) in countries that are on the ship-to exclusion list.
StoreCategoryId	String	False	Unique identifier of a primary custom category in which to list the item.
StoreCategoryName	String	False	Category name of a primary custom category in which to list the item.
StoreCategoryId2	String	False	Unique identifier for the secondary custom category in which to list the item.
StoreCategoryName2	String	False	Name of the secondary custom category in which to list the item.
DaysToFullPayment	String	False	This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are 3, 7 (default), 10, and 14.
Brand	String	False	The brand of the product. eBay searches against the names that are publicly available in its product catalogs. This means you can specify the well-known brand name that an average user would recognize. Both Brand and MPN must be specified if the BrandMPN column is used.
BrandMPN	String	False	The manufacturer part number of the product. Use the value specified by the manufacturer.
EAN	String	False	Applicable for listing use cases only (not buy-side searching). EAN is a unique 8 or 13 digit identifier that many industries (such as book publishers) use to identify products.
IncludeeBayProductDetails	String	False	This boolean field controls whether or not an eBay catalog product is used to help create or revise an item listing.
IncludeStockPhotoURL	String	False	If true, indicates that the item listing includes the stock photo.
ISBN	String	False	Applicable for listing use cases only (not buy-side searching). ISBN is a unique identifer for books (an international standard). Specify a 10 or 13 character ISBN.
ProductReferenceId	String	False	The short global reference Id for a catalog product.
UPC	String	False	Applicable for listing use cases only (not buy-side searching). UPC is a unique, 12-character identifier that many industries use to identify products.
UseStockPhotoURLAsGallery	String	False	If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. IncludeStockPhotoURL must also be true and Item.
PaymentProfileId	String	False	The unique identifier of a Business Policies payment profile. A PaymentProfileId or PaymentProfileName can be specified.
PaymentProfileName	String	False	The name of a Business Policies payment profile. A PaymentProfileId or PaymentProfileName can be specified.
ReturnProfileId	String	False	The unique identifier of a Business Policies return policy profile. A ReturnProfileId or ReturnProfileName can be specified.
ReturnProfileName	String	False	The name of a Business Policies return policy profile. A ReturnProfileId or ReturnProfileName can be specified.
ShippingProfileId	String	False	The unique identifier of a Business Policies shipping policy profile. A ShippingProfileId or ShippingProfileName can be specified.
ShippingProfileName	String	False	The name of a Business Policies shipping policy profile. A ShippingProfileId or ShippingProfileName can be specified.
BusinessSeller	String	False	If true, this indicates that the seller is a business user and intends to use listing features that are offered to business users only.
RestrictedToBusiness	String	False	If true, this indicates that the seller elects to offer the item exclusively to business users. If false or not specified, this indicates that the seller elects to offer the item to all users.
VATPercent	String	False	VAT rate for the item, if any.
PhotoDisplay	String	False	Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS).
PictureUrl	String	False	Source of the picture. Accepts a single URL, a JSON / XML aggregate of {Url} rows, or a #TEMP table reference. Examples: 'a.jpg' \| '[{Url:a.jpg},{Url:b.jpg}]' \| 'Pics#TEMP'.
GalleryURL	String	False	This field is used internally only. The Gallery image is always the first PictureURL passed in and this field is set to that value.
ItemSpecificName	String	False	Single Item Specific name (e.g. 'Release Title'). Pair with ItemSpecificValue. For multiple specifics, use ItemSpecificsAggregate instead.
ItemSpecificValue	String	False	Single Item Specific value, paired with ItemSpecificName. For multiple specifics, use ItemSpecificsAggregate instead.
ItemSpecificsAggregate	String	False	Multiple Item Specifics as a JSON / XML aggregate or a #TEMP table reference. Each row is {Name, Value}; Value may be a scalar, a JSON primitive array, multiple XML Value siblings, or a #TEMP reference. Example: '[{Name:Size,Value:[L,M]},{Name:Color,Value:Red}]'. When this is set, the singular ItemSpecificName / ItemSpecificValue inputs are ignored.
ProductCompliancePolicyId	String	False	This field is used if the seller wants to apply one or more seller-created global product compliance policies that will be used in a listing.
ProductCountryPolicy	String	False	Defines the 2-letter country code set.
ProductCountryPolicyId	String	False	The policy Id specifying product compliance policy information.
TakeBackCountryPolicy	String	False	Defines the 2-letter country code set.
TakeBackCountryPolicyId	String	False	The policy Id specifying take-back policy information.
TakeBackPolicyId	String	False	This field is used if the seller wants to apply a global take-back policy to the listing.
ConditionAdditionalInfo	String	False	This text provides additional information about a condition descriptor.
ConditionName	String	False	A numeric ID is passed in this field. This numeric ID maps to the name of a condition descriptor.
ConditionValue	String	False	A numeric ID is passed in this field. This numeric ID maps to the value associated with a condition descriptor name.

Result Set Columns


Name	Type	Description
ItemId	String	The unique identifier of the created item.
StartTime	String	Starting date and time for the new listing.
EndTime	String	Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the ListingDuration field at listing time.
FeesAggregate	String	An array of fees associated with the creation of the listing.
DiscountReason	String	One or more listing fee/upgrade discount types being offered by eBay to the seller. Applicable values: CustomCode, Promotion, SpecialOffer.

CompleteSale

Do various tasks after the creation of a single line item or multiple line item order. For example, complete a sale and leave feedback.

Input


Name	Type	Required	Description
FeedbackCommentText	String	False	Textual comment that explains, clarifies, or justifies the Feedback rating specified in FeedbackCommentType. This field is required if feedback is left.
FeedbackCommentType	String	False	This value indicates the Feedback rating for the user specified in the FeedbackTargetUser field. This field is required if feedback is left.For example, positive or negative.
FeedbackTargetUser	String	False	Username of the target user.
ItemId	String	False	Id of the item sold.
OrderId	String	False	A unique identifier that identifies a single line item or multiple line item order.
OrderLineItemId	String	False	A unique identifier for an eBay order line item based upon the concatenation of ItemId and TransactionId with a hyphen in between these two Ids. For a single line item order, the OrderLineItemId value can be passed into the OrderId field.
Paid	String	False	Whether the buyer has paid for the order. True or False.
ShipmentTrackingNumber	String	False	The tracking number assigned by the shipping carrier to the item shipment. This field and the ShippingCarrierUsed field are mutually dependent. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber.
ShippingCarrierUsed	String	False	The name of the shipping carrier used to ship the item. This field and the ShipmentTrackingNumber field are mutually dependent. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed.
ShippedTime	String	False	The date and time that the seller handed off the packages to the shipping carrier. If this field is not included in the call, the timestamp of the call execution is used as the shipped time.
Shipped	String	False	The seller includes and sets this field to true if the order has been shipped. If the call is successful, the order line items are marked as Shipped in My eBay. For example, true or false.
TransactionId	String	False	Unique identifier for an eBay order line item (transaction).

Result Set Columns


Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

CreateInventoryTask

This procedure creates an inventory-related download task for a specified feed type with optional filter criteria.

Input


Name	Type	Required	Description
SchemaVersion	String	False	Optional. The schemaVersion/version number of the file format (use the schema version of the API to which you are programming). LMS Version or Seller Hub feed schema version. For Seller Hub feed types, set the value of schemaVersion to '1.0'.
FeedType	String	False	Optional. The feed type associated with the task. Defaults to LMS_ACTIVE_INVENTORY_REPORT.
ListingFormat	String	False	Optional. The type of buying option for the order. Possible values are AUCTION,FIXED_PRICE.

Result Set Columns


Name	Type	Description
Success	String	True or false depending on whether the procedure was successful.
TaskId	String	The ID of the created download task.
Description	String	Extra details on the procedure's success or failure.

CreateOrderTask

This procedure creates an order download task with filter criteria for the order report.

Input


Name	Type	Required	Description
SchemaVersion	String	True	Required. The schema version of the LMS OrderReport. For the LMS_ORDER_REPORT feed type, see the OrderReport reference page https://developer.ebay.com/devzone/merchant-data/CallRef/OrderReport.html to see the present schema version. The schemaVersion value is the version number shown at the top left of the OrderReport page.
FeedType	String	False	Optional. The feed type associated with the task. Defaults to LMS_ORDER_REPORT.
CreationDateRangeFrom	String	False	Optional. The creation date range of the orders you want returned. Set the date range so it contains less than 10 days (maximum). If you do not specify a DateRange, results from the last 10 days will be returned by default. Example: 2022-11-18T19:09:02.768Z.
CreationDateRangeTo	String	False	Optional. The end date for the date range, which is inclusive. If the parent type is included, both the from and/or the to fields become conditionally required. Example: 2022-11-26T19:09:02.768Z.
OrderStatus	String	False	Optional. The order status of the orders returned. If the filter is omitted from createOrderTask call, orders that are in both ACTIVE and COMPLETED states are returned. Possible values are ACTIVE or COMPLETED.

Result Set Columns


Name	Type	Description
Success	String	True or false depending on whether the procedure was successful.
TaskId	String	The ID of the created download task.
Description	String	Extra details on the procedure's success or failure.

GetOAuthAccessToken

Gets the OAuth access token from eBay.

Input


Name	Type	Required	Description
Verifier	String	False	The verifier token returned by EBay after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode.
CallbackUrl	String	False	The URL the user will be redirected to after authorizing your application.
RuName	String	False	The Redirect URL name on the Token from eBay via your Application section of the User Tokens page.
SessionId	String	False	The session Id needed to authenticate when using Auth and Auth.
Scope	String	False	The scope or permissions you are requesting.
AuthMode	String	False	The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP.
State	String	False	An opaque value used by the client to maintain state between the request and callback.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The OAuth token.
OAuthRefreshToken	String	The OAuth refresh token.
ExpiresIn	String	The remaining lifetime for the access token in seconds.

GetOAuthAuthorizationURL

Gets the eBay authorization URL. Access the URL returned in the output in an Internet browser. This requests the access token that can be used as part of the connection string to eBay.

Input


Name	Type	Required	Description
CallbackUrl	String	False	The URL that eBay will return to after the user has authorized your app. Set this if you're using theOAuth AuthScheme andYour auth accepted URL in your eBay Sign-in Settings is set to`https://oauth.cdata.com/oauth/`.
RuName	String	False	The Redirect URL name on the Token from eBay via your Application section of the User Tokens page.
State	String	False	An opaque value used by the client to maintain state between the request and callback.
Scope	String	False	The scope or permissions you are requesting. Required only for the OAuth authentication.

Result Set Columns


Name	Type	Description
URL	String	The URL to be entered into a Web browser to obtain the verifier token, which you will need to submit back with the GetOAuthAccessToken stored procedure.

GetResultFile

This procedure retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz).

Input


Name	Type	Required	Description
TaskId	String	False	Required. The ID of the task associated with the file you want to download. This ID was generated when the task was created.
DownloadPath	String	False	Local path to save the generated report to.

Result Set Columns


Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.
FileName	String	The name of the generated file as generated by the API.
FileData	String	If the DownloadPath is left blank, the downloaded file's content will be output as a BASE64 encoded string.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with EBay.

Input


Name	Type	Required	Description
OAuthRefreshToken	String	False	The old token to be refreshed.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The authentication token returned from EBay.
ExpiresIn	String	The remaining lifetime on the access token.

SetUserNotes

Add, replace, and delete My eBay notes for items that are being tracked in the My eBay Selling and Buying areas.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.

Input


Name	Type	Required	Description
Action	String	True	The seller must include this field and set it to 'AddOrUpdate' to add a new user note or update an existing user note, or set it to 'Delete' to delete an existing user note.
ItemId	String	False	Unique identifier of the listing to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay.
NoteText	String	False	This field is needed if the Action is AddOrUpdate. The text supplied in this field will completely replace any existing My eBay note for the specified item.
OrderLineItemId	String	False	A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. OrderLineItemID can be used in the input instead of an ItemID/TransactionID pair to identify an order line item.
SKU	String	False	SKU value of the item variation to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay. A SKU (stock keeping unit) value is defined by and used by the seller to identify a variation within a fixed-price, multiple- variation listing. The SKU value is assigned to a variation of an item through the Variations.Variation.SKU element.
TransactionId	String	False	Unique identifier for the order line item to which the My eBay note will be attached. Notes can only be added to order line items that are currently being tracked in My eBay. Buyers can view user notes made on order line items in the PrivateNotes field of the WonList container in GetMyeBayBuying, and sellers can view user notes made on order line items in the PrivateNotes field of the SoldList and DeletedFromSoldList containers in GetMyeBaySellinging.
VariationSpecificName	String	False	Single Variation Specific name. Pair with VariationSpecificValue. For multiple, use VariationSpecifics instead.
VariationSpecificValue	String	False	Single Variation Specific value, paired with VariationSpecificName. For multiple, use VariationSpecifics instead.
VariationSpecifics	String	False	Multiple Variation Specifics as a JSON / XML aggregate or a #TEMP table reference. Each row is {Name, Value}; Value may be a scalar, a JSON primitive array, multiple XML Value siblings, or a #TEMP reference. When set, the singular VariationSpecificName / VariationSpecificValue inputs are ignored.

Result Set Columns


Name	Type	Description
Success	String	This value shows a boolean indication of whether the operation was successful or not.

UploadFile

Uploads a file to the EBay account.

Stored Procedure Specific Information

This procedure associates the specified file with the specified task ID and uploads the input file. After the file has been uploaded, the processing of the file begins.

The inputs required to upload a file are the following: TaskID and FilePath.

Upload a file

You can follow the procedure below to submit a successful upload file procedure:

Use the Tasks table to create a new Task. You can use the following query:

INSERT INTO [Tasks] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')

You can get newly generated TaskID either from the generated keys, or by using the Tasks table again to select.

    Statement stat = conn.createStatement();
    stat.executeUpdate("INSERT INTO [Tasks] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')", Statement.RETURN_GENERATED_KEYS);
    ResultSet rs = stat.getGeneratedKeys();
    while (rs.next()) {
      for (int i = 1; i <= rs.getMetaData().getColumnCount(); i++) {
        System.out.println(rs.getMetaData().getColumnName(i) + "=" + rs.getString(i));
      }
    }

or

SELECT * FROM [Tasks] WHERE FeedType = 'LMS_ADD_ITEM' AND CreationDate > '2021-11-16 09:19:00'

Use this task id as input together with the FilePath of the file to be uploade, in the UploadFile stored procedure.

    CallableStatement callableStatement = conn.prepareCall("UploadFile");
    callableStatement.setString("TaskID", "task-5-1XXXXX");
    callableStatement.setString("FilePath", "C:\\Users\\User\\Documents\\upload.csv");

    boolean ret = callableStatement.execute();
    if (!ret) {
      int count = callableStatement.getUpdateCount();
      if (count != -1) {
        System.out.println("Affected rows: " + count);
      }
    } else {
      ResultSet rs = callableStatement.getResultSet();
      while (rs.next()) {
        for (int i = 1; i <= rs.getMetaData().getColumnCount(); i++) {
          System.out.println(rs.getMetaData().getColumnName(i) + "=" + rs.getString(i));
        }
      }
    }

Then your file should be processing. To track the status you can execute a SELECT query in the Tasks table with the TaskID, and check the Status column.
```
SELECT Status FROM [Tasks] WHERE TaskID = '{Generated Task ID}'
```

Input


Name	Type	Required	Description
TaskID	String	True	The task_id associated with the file that will be uploaded. This ID was generated when the specified task was created.
FilePath	String	False	The absolute path of the file to be uploaded.
FileName	String	False	The name of the uploaded file. It should be specified only when uploading the content as InputStream. (With extension)

Result Set Columns


Name	Type	Description
Success	String	This parameter sets whether the operation was successful or not.
Description	String	Description message of the upload operation. It might be an error message or a successful message.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for eBay:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.
IsInsertable	Boolean	Whether the table can be inserted into.
IsDeleteable	Boolean	Whether rows can be deleted from the table.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the ItemListing table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName = 'ItemListing'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.
ColumnCapabilities	Int32	A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the AddItem stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'AddItem' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'AddItem' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native eBay procedure.

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the ItemListing table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='ItemListing'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are OAuth and AuthNAuth.
SiteID	The Id of the eBay site to which you want to send the request. By default this is 0, (U.S.).
UseSandbox	A boolean indicating if you are using a sandbox account.
DevID	Your Developer Id, as registered with the eBay Developers Program.
RuName	The Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data.

OAuth

Property	Description
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
CallbackURL	Identifies the URL users return to after authenticating to eBay via OAuth (Custom OAuth applications only).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
OAuthVerifier	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
Logfile	Specifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSize	Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCount	Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Caching

Property	Description
AutoCache	Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProvider	The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheDriver	The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnection	Specifies the connection string for the specified cache database.
CacheLocation	Specifies the path to the cache when caching to a file.
CacheTolerance	Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.
Offline	Gets the data from the specified cache database instead of live eBay data.
CacheMetadata	Determines whether the provider caches table metadata to a file-based cache database.

Miscellaneous

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Readonly	Toggles read-only access to eBay from the provider.
RTK	Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are OAuth and AuthNAuth.
SiteID	The Id of the eBay site to which you want to send the request. By default this is 0, (U.S.).
UseSandbox	A boolean indicating if you are using a sandbox account.
DevID	Your Developer Id, as registered with the eBay Developers Program.
RuName	The Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data.

Remarks

The Redirect URL name used for validation. This property is only needed if you are using the connector to allow other users to access their own data. You can obtain this by clicking User Tokens from your developer account, clicking Get a Token from eBay via Your Application, and then clicking Add eBay Redirect URL.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
CallbackURL	Identifies the URL users return to after authenticating to eBay via OAuth (Custom OAuth applications only).
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
OAuthVerifier	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

"OFF"

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for:

Logging in users.
Exchanging user credentials for an OAuth access token to be used for authentication.
Providing limited access to applications.

The options for initiating and maintaining OAuth access are named for the parts of that flow that the connector handles:


OFF	The connector provides no automatic OAuth flow initiation. The OAuth flow is handled entirely by the user. This means that the user must refresh the token manually, and reconnect with an updated OAuthAccessToken property when the current token expires.
GETANDREFRESH	The connector handles the entire OAuth flow (both GET and REFRESH). This means that if a token already exists, the connector refreshes it when necessary; if no token currently exists, the connector obtains it by prompting the user to login.
REFRESH	The user obtains the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate.) After the user logs in, the connector handles the refresh of the OAuth Access Token.

For more information on how to set up OAuth and use this property when configuring a connection, see Establishing a Connection.

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the connector and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. The timeout is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Note: Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthSettingsLocation

Specifies the location of the settings file where OAuth values are saved.

Data Type

string

Default Value

"%APPDATA%\\CData\\Ebay Data Provider\\OAuthSettings.txt"

Remarks

Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.

You can store OAuth values in a central file for shared access to those values, in either of the following ways:

Set InitiateOAuth to either GETANDREFRESH or REFRESH and specify a filepath to the OAuth settings file.
Use memory storage to load the credentials into static memory.

The following sections provide more detail on each of these methods.

Specifying the OAuthSettingsLocation Filepath

The default OAuth setting location is %APPDATA%\\CData\\Ebay Data Provider\\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory. Default values vary, depending on the user's operating system.

Windows (ODBC and Power BI): registry://%DSN%
Windows: %APPDATA%CDataEbay Data Provider\OAuthSettings.txt
Mac: %APPDATA%/CData/Ebay Data Provider/OAuthSettings.txt
Linux: %APPDATA%/CData/Ebay Data Provider/OAuthSettings.txt

Loading Credentials Via Memory Storage

Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.

Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.

To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

Supported Storage Types

memory://: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)
registry://: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name like registry://CData Python Connector for eBay Data Source, or registry://%DSN%.
%DSN%: The name of the DSN you are connecting with.
Default (no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with %APPDATA% or %PROGRAMFILES%.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CallbackURL

Identifies the URL users return to after authenticating to eBay via OAuth (Custom OAuth applications only).

Data Type

The OAuth access token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Possible Values

NONE, TUNNEL, SOCKS4, SOCKS5

Data Type

string

Default Value

"NONE"

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the connector connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the connector opens a connection to eBay. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the connector opens a connection to eBay. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the connector sends data to eBay. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Data Type

bool

Default Value

true

Remarks

When this connection property is set to True, the connector checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the connector to connect to a specific proxy server, set ProxyAutoDetect to False.

On Windows, the connector reads the proxy settings from the Internet Options in the registry, specifically the registry key HKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Internet Settings\. On Windows 10 and later, this corresponds to the Proxy Settings found in the Windows Settings.

Note that these settings apply only to the current user of the machine. If you're running an application as a service, the connector does not read your own user's settings. You must instead manually supply the proxy settings in the connector's connection properties.

On Mac, the connector reads proxy settings from the system-configured CFNetwork settings.

On Linux, this property is unsupported, and is set to False by default.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Data Type

string

Default Value

""

Remarks

The connector only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the connector instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Data Type

int

Default Value

80

Remarks

The connector only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the connector instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Possible Values

BASIC, DIGEST, NONE, NEGOTIATE, NTLM

Data Type

string

Default Value

"BASIC"

Remarks

Note: The connector only uses this ProxyAuthScheme when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the authentication method specified in your system proxy settings.

Supported authentication types :

BASIC: The connector performs HTTP basic authentication.
DIGEST: The connector performs HTTP digest authentication.
NTLM: The connector retrieves an NTLM token.
NEGOTIATE: The connector retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

Note: The connector only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the username specified in your system proxy settings.

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The connector only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the connector instead uses the password specified in your system proxy settings.

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Possible Values

AUTO, ALWAYS, NEVER, TUNNEL

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the connector uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Data Type

string

Default Value

""

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Logfile	Specifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSize	Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCount	Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Logfile

Specifies the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.

Data Type

string

Default Value

""

Remarks

This property specifies the location and name of the log file where the connector records its operations, including authentication events, query execution, and connection details. If the specified file does not exist, the connector creates it. Ensure that the user or the service running the connector has write access to the specified path or file. Without sufficient permissions, the log file is not created.

Sensitive information from the connection string, such as passwords and tokens, is automatically masked in the logs. However, sensitive information present in the data itself may not be masked.

If you specify a relative path for Logfile, and if the Location property is set, that directory is used as the base path for the log file.

Additional properties allow you to customize logging behavior:

Use Verbosity to control the level of detail of the log file.
Manage log file size with MaxLogFileSize and control the number of retained log files with MaxLogFileCount.
Filter specific log modules by adjusting the LogModules property.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the connector includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Data Type

string

Default Value

""

Remarks

The connector writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual connector operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the connector to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:


Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

MaxLogFileSize

Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.

Data Type

string

Default Value

"100MB"

Remarks

For values lower than 100 KB, the connector uses 100 KB as the minimum allowable size.

To control the total number of log files retained, use the MaxLogFileCount property in conjunction with this property. Together, these properties allow you to manage the size and retention of log files effectively.

MaxLogFileCount

Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Data Type

int

Default Value

-1

Remarks

Each log file name includes the date and time for easier identification.

This property accepts the following values:

A value of 2 or higher sets the maximum number of log files retained.
A value of 1 retains only one log file. When it reaches the maximum size, the file is deleted and replaced by a new one, leaving no history beyond the current log.
A value of 0 or negative indicates no limit on the number of log files, and logging continues indefinitely.

To manage log file size, use the MaxLogFileSize property. The two properties work together to control the size and retention of log files in the logging folder.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

"%APPDATA%\\CData\\Ebay Data Provider\\Schema"

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\Ebay Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Caching

This section provides a complete list of the Caching properties you can configure in the connection string for this provider.

Property	Description
AutoCache	Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheProvider	The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.
CacheDriver	The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnection	Specifies the connection string for the specified cache database.
CacheLocation	Specifies the path to the cache when caching to a file.
CacheTolerance	Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.
Offline	Gets the data from the specified cache database instead of live eBay data.
CacheMetadata	Determines whether the provider caches table metadata to a file-based cache database.

AutoCache

Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, the connector automatically caches the contents of tables targeted by SELECT queries. The content of these tables is cached to the cache database specified by the CacheConnection and CacheProvider connection properties.

CacheProvider

The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations.

Data Type

string

Default Value

""

Remarks

You can cache to ADO.NET providers saved in your ADO.NET global assembly cache (GAC).

CData ADO.NET providers automatically register themselves with the GAC during installation, so you don't need to do so manually.

Third-party ADO.NET providers may or may not automatically register themselves with the GAC during installation. If you want to cache to a third-party ADO.NET provider, consult the documentation for that provider to determine what steps (if any) you must take to register them with the GAC. Once they have been registered, you can supply their namespace in this connection property.

You must also set the CacheConnection connection property to provide a connection string for the specified ADO.NET provider.

The following sections show connection examples and address other requirements for several popular database providers. Refer to CacheConnection for more information on typical connection properties.

SQLite

You can use the Microsoft ADO.NET Provider for SQLite to cache to SQLite databases.

CacheProvider=Microsoft.Data.Sqlite;CacheConnection='DataSource=C:\\Users\\Public\\cache.db;'DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

MySQL

To cache to MySQL, you can use the CData ADO.NET Provider for MySQL:

Cache Provider=System.Data.CData.MySQL;Cache Connection='Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=myUser;Password=myPassword;Security Token=myToken;

SQL Server

You can use the Microsoft .NET Framework Provider for SQL Server, included in the .NET Framework, to cache to SQL Server:

Cache Provider=System.Data.SqlClient;Cache Connection="Server=MyMACHINE\MyInstance;Database=SQLCACHE;User Id=root;Password=admin";DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

Oracle

To cache to Oracle, you can use the Oracle Data Provider for .NET, as shown in the following example:

Cache Provider=Oracle.DataAccess.Client;Cache Connection='User Id=scott;Password=tiger;Data Source=ORCL';DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

The Oracle Data Provider for .NET also requires the Oracle Database Client. When you download the Oracle Database Client, ensure that its bitness matches the bitness of your machine. When you install, select either the Runtime or Administrator installation type. The Instant Client is not sufficient.

PostgreSQL

To cache to PostgreSQL, you can use the CData ADO.NET Provider for PostgreSQL:

Cache Provider=System.Data.CData.PostgreSQL;Cache Connection='Server=localhost;Port=5432;Database=cache;User=postgres;Password=123456';User=myUser;Password=myPassword;Security Token=myToken;

CacheDriver

The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

Note: You must add the JAR file of the specified JDBC driver to the classpath. For CData JDBC drivers, you can find this JAR file in the "lib" subfolder of that driver's installation directory.

You must also set the CacheConnection connection property to provide a connection string for the specified JDBC driver.

For Linux systems and macOS, you need to create a config.ini file on the installation path of the driver (site-packages/cdata). The config.ini file has the following format (the driver and the path of the JDBC driver):

[salesforce.cpython-38-x86_64-linux-gnu.so]
CLASSPATH = /home/usrname/Downloads/lib/cdata.jdbc.postgresql.jar

Examples

The following examples show how to cache to several major databases. For more information on the JDBC URL syntax and typical connection properties, see CacheConnection.

Derby and Java DB

Java DB is the Oracle distribution of Derby. You must add the Derby JDBC driver's JAR file, derbytools.jar, to your classpath to cache to Java DB.

The Derby JDBC driver's JAR file is bundled in db-derby-10.17.1.0-bin.zip, which you can download from this page. You can find derbytools.jar in the "lib" subfolder of this zip file.

After adding derbytools.jar to the classpath, you can cache to a Java DB database as follows:

jdbc:ebay:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

To cache to an in-memory database, use a JDBC URL like the following:

jdbc:ebay:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:ebay:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

MySQL

The following is a JDBC URL for the CData JDBC Driver for MySQL:

  jdbc:ebay:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:ebay:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:ebay:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .

PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:ebay:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';DevID=MyDevID;OAuthClientId=MyAppID;OAuthClientSecret=MyCertID;RuName=MyRuName;SiteID=0;OAuthAccessToken=MyOAuthAccessToken

CacheConnection

Specifies the connection string for the specified cache database.

Data Type

string

Default Value

""

Remarks

The target cache database is determined by a combination of this connection property and the CacheProvider connection property. Both properties are required to use the specified cache database.

The connection string specified in this connection property is passed directly to the specified in the CacheProvider connection property. Consult the documentation for the specified for more information on its available connection properties.

Examples of common cache database settings can be found below.

SQLite

MySQL

The following are typical connection properties:

Server: The IP address or domain name of the server hosting the MySQL database that you want to cache to.
Port: The port on the specified server where your MySQL instance is running.
Database: The name of the MySQL database that you want to cache to. Must match the name of a MySQL database hosted on the specified server.
User: The username of a user registered with the selected MySQL database.
Password: The password associated with the specified MySQL user.

SQL Server

The following are typical SQL Server connection properties:

Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, specify the host name and the instance name, separated by a backslash.
Port: The port on the specified server where your SQL Server instance is running.
Database: The name of the SQL Server database you want to cache to. Must match the name of a SQL Server database hosted on the specified server.
Integrated Security: To use the current Windows account for authentication, set this option to True. To authenticate with User and Password instead, set this option to False.
User Id: The username of a user registered with the selected SQL Server database. This property is only needed if you are not using integrated security.
Password: The password associated with the specified SQL Server user. This property is only needed if you are not using integrated security.

Oracle

The following are typical connection properties:

Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
User Id: The username of a user registered with the selected Oracle database.
Password: The password associated with the specified Oracle user.

PostgreSQL

The following are typical connection properties:

Host: The address of the server hosting the PostgreSQL database.
Port: The port on the specified host server where your PostgreSQL database is hosted.
Database: The name of the PostgreSQL database you want to cache to. Must match the name of a PostgreSQL database hosted on the specified server.
User name: The username of a user registered with the selected PostgreSQL database.
Password: The password associated with the specified user.

CacheLocation

Specifies the path to the cache when caching to a file.

Data Type

string

Default Value

"%APPDATA%\\CData\\Ebay Data Provider"

Remarks

The CacheLocation is a simple, file-based cache.

If left unspecified, the default location is %APPDATA%\\CData\\Ebay Data Provider, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

CacheTolerance

Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True.

Data Type

int

Default Value

600

Remarks

When you execute a query for tables in the cache, the connector checks the time elapsed since the last update to the cache.

If the last update to the cache is older than the value of this connection property (measured in seconds), the connector refreshes the cache.

Otherwise, the connector returns data directly from the cache.

Offline

Gets the data from the specified cache database instead of live eBay data.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, all queries execute against the cache database instead of the live eBay data.

In this mode, some SQL operations like INSERT, UPDATE, DELETE, and CACHE are disabled.

CacheMetadata

Determines whether the provider caches table metadata to a file-based cache database.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, as you execute queries, table metadata in the eBay catalog is cached to the cache database specified by CacheConnection and CacheProvider, or, if those connection properties are not set, to the user's home directory.

The location of your home directory varies by platform:


Platform	Home Directory
Windows	%APPDATA%\\CData\\Ebay Data Provider
Mac	~/Library/Application Support/CData/Ebay Data Provider
Unix	~/.config/CData/Ebay Data Provider

A table's metadata is retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

When there are a large number of eBay tables and columns for the connector to retrieve during metadata discovery, the connector may take a while to list all table metadata.

You may experience slow metadata retrieval when:

Your eBay instance naturally has a large table count.
The connector has been configured, via its connection properties, to discover more tables than it would under its default configuration.
You make many short-lived connections to the connector.

With CacheMetadata enabled, all retrieved metadata is mirrored in the cache database. This means that any subsequent attempts by the connector to discover metadata are much faster, as this metadata is then read directly from the cache database, without needing to spend time requesting metadata from eBay.

When Not to Use CacheMetadata

The connector automatically persists metadata in memory for up to an hour when you first discover the metadata for a table or view, so CacheMetadata is generally not necessary.

CacheMetadata is not ideal in scenarios where you are working with volatile metadata. The first time you query a table, the connector caches its metadata to the cache database file. This cache is not dynamically updated to reflect updates to the table schema, so you must delete and rebuild the cache database file to pick up new, changed, or deleted columns.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Readonly	Toggles read-only access to eBay from the provider.
RTK	Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Caching Configuration


Property	Description
CachePartial=True	Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True	Passes the specified query to the cache database instead of using the SQL parser of the connector.

Integration and Formatting


Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Readonly

Toggles read-only access to eBay from the provider.

Data Type

bool

Default Value

false

Remarks

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM ItemListing WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the connector only sees that view.

For further information, see User Defined Views.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

AdoptOpenJDK / Adoptium Temurin JRE 17.0.18_8

Apache License, Version 2.0

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Eclipse Distribution License - v 1.0

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Eclipse Foundation, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Eclipse Public License - v 2.0

THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS "Contribution" means:

a) in the case of the initial Contributor, the initial content Distributed under this Agreement, and
b) in the case of each subsequent Contributor:
- i) changes to the Program, and
- ii) additions to the Program;
where such changes and/or additions to the Program originate from and are Distributed by that particular Contributor. A Contribution "originates" from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include changes or additions to the Program that are not Modified Works.

"Contributor" means any person or entity that Distributes the Program. "Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions Distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement or any Secondary License (as applicable), including Contributors.

"Derivative Works" shall mean any work, whether in Source Code or other form, that is based on (or derived from) the Program and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship.

"Modified Works" shall mean any work in Source Code or other form that results from an addition to, deletion from, or modification of the contents of the Program, including, for purposes of clarity any new file in Source Code form that contains any contents of the Program. Modified Works shall not include works that contain only declarations, interfaces, types, classes, structures, or files of the Program solely in each case in order to link to, bind by name, or subclass the Program or Modified Works thereof.

"Distribute" means the acts of a) distributing or b) making available in any manner that enables the transfer of a copy.

"Source Code" means the form of a Program preferred for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Secondary License" means either the GNU General Public License, Version 2.0, or any later versions of that license, including any exceptions or additional permissions as identified by the initial Contributor.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, Distribute and sublicense the Contribution of such Contributor, if any, and such Derivative Works.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in Source Code or other form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to Distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
e) Notwithstanding the terms of any Secondary License, no Contributor makes additional grants to any Recipient (other than those set forth in this Agreement) as a result of such Recipient's receipt of the Program under the terms of a Secondary License (if permitted under the terms of Section 3).

3. REQUIREMENTS 3.1 If a Contributor Distributes the Program in any form, then:

a) the Program must also be made available as Source Code, in accordance with section 3.2, and the Contributor must accompany the Program with a statement that the Source Code for the Program is available under this Agreement, and informs Recipients how to obtain it in a reasonable manner on or through a medium customarily used for software exchange; and
b) the Contributor may Distribute the Program under a license different than this Agreement, provided that such license:
- i) effectively disclaims on behalf of all other Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
- ii) effectively excludes on behalf of all other Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
- iii) does not attempt to limit or alter the recipients' rights in the Source Code under section 3.2; and
- iv) requires any subsequent distribution of the Program by any party to be under a license that satisfies the requirements of this section 3.

3.2 When the Program is Distributed as Source Code:

a) it must be made available under this Agreement, or if the Program (i) is combined with other material in a separate file or files made available under a Secondary License, and (ii) the initial Contributor attached to the Source Code the notice described in Exhibit A of this Agreement, then the Program may be made available under the terms of such Secondary Licenses, and
b) a copy of this Agreement must be included with each copy of the Program.

3.3 Contributors may not remove or alter any copyright, patent, trademark, attribution notices, disclaimers of warranty, or limitations of liability (‘notices') contained within the Program from any copy of the Program which they Distribute, provided that Contributors may add their own appropriate notices.

4. COMMERCIAL DISTRIBUTION Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be Distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to Distribute the Program (including its Contributions) under the new version.

Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved. Nothing in this Agreement is intended to be enforceable by any entity that is not a Contributor or Recipient. No third-party beneficiary rights are created under this Agreement.

Exhibit A – Form of Secondary Licenses Notice "This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), version(s), and exceptions or additional permissions here}."

Simply including a copy of this Agreement, including this Exhibit A is not sufficient to license the Source Code under Secondary Licenses.

If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

GNU Classpath

Classpath is distributed under the terms of the GNU General Public License with the following clarification and special exception.

Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination.

As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

As such, it can be used to run, create and distribute a large class of applications and applets. When GNU Classpath is used unmodified as the core class library for a virtual machine, compiler for the java languge, or for a program written in the java programming language it does not affect the licensing for distributing those programs directly.

OpenJDK Assembly Exception

The OpenJDK source code made available by Oracle America, Inc. (Oracle) at openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU General Public License <http://www.gnu.org/copyleft/gpl.html> version 2 only ("GPL2"), with the following clarification and special exception.

Linking this OpenJDK Code statically or dynamically with other code is making a combined work based on this library. Thus, the terms and conditions of GPL2 cover the whole combination.

As a special exception, Oracle gives you permission to link this OpenJDK Code with certain code licensed by Oracle as indicated at http://openjdk.java.net/legal/exception-modules-2007-05-08.html ("Designated Exception Modules") to produce an executable, regardless of the license terms of the Designated Exception Modules, and to copy and distribute the resulting executable under GPL2, provided that the Designated Exception Modules continue to be governed by the licenses under which they were offered by Oracle.

As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code to build an executable that includes those portions of necessary code that Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 with the Classpath exception). If you modify or add to the OpenJDK code, that new GPL2 code may still be combined with Designated Exception Modules if the new code is made subject to this exception by its copyright holder.

CData Python Connector for eBay

CData Python Connector for eBay

Overview

Key Features

Getting Started

Using the Python Connector/Using from Tools

SQLAlchemy ORM

Pandas

Schema Discovery

Advanced Features

SQL Compliance

Data Model

Connection String Options

Getting Started

Connecting to eBay

Python Version Support

eBay Version Support

See Also

Package Installation

Dependencies

Installation

Upgrading

Licensing

Uninstallation

Establishing a Connection

Connecting to eBay APIs

Authenticating to eBay

User Accounts (OAuth)

Desktop Applications

Web Applications

Headless Machines

User Accounts with Legacy Apps (Auth'n'Auth)

Access Token

Configuring JNI

Configure the Config INI File

Configure Environment Variables

Custom Logger

Creating a Custom OAuth App

Register and Get Your Keyset

Creating an OAuth App

Single User

Multiple Users

Changelog

General Changes

Using the Connector

Connecting from Code

Executing SQL

Executing Stored Procedures

Connecting

Connecting with the cdata.ebay Module:

Querying Data

Executing Queries

Parameterized Queries

Modifying Data

Insert

Update

Delete

Calling Stored Procedures

Calling Stored Procedures Using Execute()

Calling Stored Procedures Using Callproc()

Using from Tools

Python Integration Guides

Complete List of eBay Integration Quickstarts

From SQLAlchemy

Connecting From SQLAlchemy

Reflecting Metadata With SQLAlchemy

Querying Data From SQLAlchemy

Modifying Data From SQLAlchemy

Connecting

Connecting With a Dialect URL

Reflecting Metadata

Modeling Data Using a Mapping Class

Automatically Reflecting Metadata

Querying Data

Querying Data Using the Query Method

Querying Data Using the Execute Method

Executing JOINs

Implicit Joining

Other Join Forms

Other SQL Clauses