Qoo10 Connector for CData Sync

Build 22.0.8462
  • Qoo10
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • GoodsDetail
        • GoodsInventoryOption
        • GoodsOption
      • Views
        • Brands
        • Categories
        • Claims
        • Goods
        • Makers
        • Orders
        • SellerDeliveryGroups
        • ShippingInfo
    • Connection String Options
      • Authentication
        • ApiKey
        • User
        • Password
      • Connection
        • URL
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Qoo10 Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Qoo10 data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Qoo10 connector can be used from the CData Sync application to pull data from Qoo10 and move it to any of the supported destinations.

Qoo10 Connector for CData Sync

Establishing a Connection

Create a connection to Qoo10 by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Qoo10 icon is not available, click the Add More icon to download and install the Qoo10 connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Qoo10

When using the Qoo10 APIs to connect to Qoo10, ApiKey, Password, and User are required.

Configure Access to Qoo10

To obtain ApiKey, User, and Password, follow the steps below:

  • To obtain API Key, you need to contact Qoo10 sales.
  • If you ask Qoo10 sales, API Key will be sent later.

Authenticate to Qoo10 Account

Set the following connection properties to connect:

  • ApiKey: Set API Key you received from Qoo10 sales.
  • User: Set User ID for logging in to QSM.
  • Password: Set Password for loggin in to QSM QSM.

Qoo10 Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Qoo10 Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

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

Query Processing

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

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Qoo10 Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Qoo10 Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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.

Qoo10 Connector for CData Sync

Data Model

The CData Sync App models Qoo10 objects as relational tables and views. A Qoo10 object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Qoo10 APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

The Sync App offloads as much of the SELECT statement processing as possible to the Qoo10 APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the Sync App circumvents API limitations with in-memory client-side processing.

Qoo10 Connector for CData Sync

Tables

The Sync App models the data in Qoo10 into a list of tables that can be queried using standard SQL statements.

Generally, querying Qoo10 tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Qoo10 Connector for CData Sync Tables

Name Description
GoodsDetail Retrieve and query information related goods.
GoodsInventoryOption Retrieve and query information related GoodsInventory info.
GoodsOption Retrieve and query information related ItemOption info.

Qoo10 Connector for CData Sync

GoodsDetail

Retrieve and query information related goods.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • ItemNo supports the '=' operator.
  • SellerCode supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM GoodsDetail WHERE ItemNo=625522959
SELECT * FROM GoodsDetail WHERE ItemNo=510833894 AND SellerCode='qoo10-201105-03'
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Insert

Required fields for an insert are: ItemTitle, SecondSubCatCd, ImageUrl, ItemDetail, RetailPrice, SellPrice, ItemQty, ExpireDate, ShippingNo and AdultYN.
Optional: ContactTel, ManufacturerCd, BrandCd, SellerCode, IndustrialCode, ProductionPlace, AvailableDateType, AvailableDateValue.

INSERT INTO GoodsDetail  (ItemTitle,SecondSubCatCd,ImageUrl,ItemDetail,RetailPrice,SellPrice,ItemQty,ExpireDate,ShippingNo,AdultYN) VALUES('Insert test 22','300000113','https://gd.image-qoo10.jp/CDATAJ-CDATA-SAMPLE-BAG/ai/347/344/1105344347_00.g_80-w-st_g.jpg','Just for testing purpose 2.',41,120,21,'2019/12/12','0','N')

Update

Qoo10 allows updates for the ItemTitle,ItemStatus, ItemDetail, SellPrice, ItemQty, ImageUrl, SecondSubCatCd, ManufacturerCd,BrandCd,IndustrialCode,ProductionPlace and ContactTel columns.

 UPDATE GoodsDetail SET ItemDetail = 'Test', SecondSubCatCd='300000113' WHERE ItemNo=624988017

Delete

GoodsDetail can be deleted by providing the ItemNo.

DELETE FROM GoodsDetail WHERE ItemNo=625401830

Columns

Name Type ReadOnly Description
ItemNo [KEY] Integer True

The item code of Qoo10.

ItemTitle String False

Item Title

ItemStatus String False

Item Status. Possible values are: (1 : On Queue, 2 : Available, 3 : Deleted)

MainCatCd String True

Item's main category code of the Qoo10. (ex.100000001)

MainCatNm String True

Item's main category name of the Qoo10. (ex.Women's Clothing)

FirstSubCatCd String True

Item's sub-category code of the Qoo10. (ex.200000001)

FirstSubCatNm String True

Item's sub-category category name of the Qoo10. (ex.Dresses)

SecondSubCatCd String False

Item's 2nd sub-category code of the Qoo10. (ex.300000001)

SecondSubCatNm String True

Item's sub-category category name of the Qoo10. (ex.Dresses)

SellerCode String False

Item code managed by the seller.

IndustrialCode String False

Industrial Code such as JAN Code or ISBN etc. If you fill in the standard code, the item would be exposed in the price comparison sites.

RetailPrice Decimal False

Reference price of the item.

SellPrice Decimal False

Price of the item.

SettlePrice Decimal True

Settle price of the item.

ItemQty Integer False

Available item Qty

ExpireDate Date True

Expiry date to sell the item Please input with this format (yyyy-mm-dd). If you input

ManufacturerCd String False

Manufacturer code that is registered in Qoo10. (ex. 21750)

ManufacturerNm String True

Manufacturer name that is registered in Qoo10.

BrandCd String False

Brand code that is registered in Qoo10. (ex. 21750)

BrandNm String True

Brand name that is registered in Qoo10.

AdultYN String False

If the item is an adult product, the value is 'Y'. If not, the value is 'N'

ShippingNo Intiger False

Qoo10 Shipping fee code.

ContactTel String False

Contact number of the seller.

ItemDetail String False

Description of the item.

ImageUrl String False

The Standard image of item.

ProductionPlace String False

Place of production.

AvailableDateType String True

Information of the available shipping date type ( null : do not edit 0: do not set 1 : preparing date , 2 : release date )

AvailableDateValue String True

If Type= 1(Preparing date), preparing date (dd) enter : ex) 5. If Type 2=(release date), set release date(YYYY-MM-DD) : ex) 2011-09-15. If Type null, the setting value = null : do not edit

Qoo10 Connector for CData Sync

GoodsInventoryOption

Retrieve and query information related GoodsInventory info.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • ItemNo supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM GoodsInventoryOption WHERE ItemNo=621050268
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Insert

Required fields for an insert are ItemNo, Name1, Value1, Price and Quantity.
Optional: Name2, Value2, Name3, Value3, ItemTypeCode.

INSERT INTO GoodsInventoryOption (ItemNo, Name1, Value1, Price, Quantity) values ('621050268','Color', 'Red', '93', '971')

Update

Qoo10 allows updates for the Price and Quantity columns.

UPDATE GoodsInventoryOption SET Price=172,Quantity=332 WHERE ItemNo=621068441
UPDATE GoodsInventoryOption SET Price=172,Quantity=332 WHERE ItemNo=621068441 AND ItemTypeCode='CD0000091'
UPDATE GoodsInventoryOption SET Price=150,Quantity=150 WHERE ItemNo=621050268 AND OptionNo='Size:-:XL:-:Color:-:Blue'

Delete

GoodsInventoryOption can be deleted by providing the ItemNo or ItemNo and ItemTypeCode or ItemNo and OptionNo.

DELETE FROM GoodsInventoryOption WHERE ItemNo=621068441
DELETE FROM GoodsInventoryOption WHERE ItemNo=621068441 AND ItemTypeCode='CD0000091'
DELETE FROM GoodsInventoryOption WHERE ItemNo=625522959 AND OptionNo='Color:-:Red'

Columns

Name Type ReadOnly Description
ItemNo [KEY] String True

The item code of Qoo10.

OptionNo [KEY] String True

Code of the option.

Name1 String True

OptionName1

Value1 String True

OptionValue1

Name2 String True

OptionName2

Value2 String True

OptionValue2

Name3 String True

OptionName3

Value3 String True

OptionValue3

Price Decimal False

OptionPrice

Quantity Integer False

Quantity

ItemTypeCode String False

Item Type Code

Qoo10 Connector for CData Sync

GoodsOption

Retrieve and query information related ItemOption info.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • ItemNo supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM GoodsOption WHERE ItemNo=621052282
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Insert

Required fields for an insert are ItemNo, Name, Value and Price. Optional: OptionCode.

INSERT INTO GoodsOption (ItemNo,Name,Value,Price) values ('624988017','test-92','p33',3)

Update

Qoo10 allows updates for the Price and Qty columns.

UPDATE GoodsOption SET Price = '200', OptionCode='FFJ4HFH8HS8H' WHERE ItemNo='624988017' AND OptionNo='Jacket:-:CDATA'

Columns

Name Type ReadOnly Description
ItemNo [KEY] String True

The item code of Qoo10.

OptionNo [KEY] String True

Code of the option.

Name String True

OptionName

Value String True

OptionValue

Price Decimal False

OptionPrice

OptionCode String False

OptionCode

Qoo10 Connector for CData Sync

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Qoo10 Connector for CData Sync Views

Name Description
Brands Returns data regarding brands registered on Qoo10.
Categories Returns data regarding category list. Data are returned in Japanese language by default.
Claims Returns data regarding claim info. ClaimStaus column is required to be specified for this view. ClaimStaus = 4 by default. Possible values are 1,2,3,4,5,6.
Goods Retrieve ItemCode, ItemStatus and SellerCode related goods.
Makers Returns data regarding manufacturers registered on Qoo10.
Orders Returns data regarding orders. ShippingStatus column is required to be specified for this view.
SellerDeliveryGroups Returns data regarding seller delivery group info.
ShippingInfo Returns data regarding shipping info. ShippingStatus column is required to be specified for this view.

Qoo10 Connector for CData Sync

Brands

Returns data regarding brands registered on Qoo10.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Keyword supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM Brands WHERE Keyword='test'
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type Description
Keyword String Keyword for the search.
ManufacturerNo [KEY] String Manufacturer No
ManufacturerName String Manufacturer Name
EnglishManufacturerName String Manufacturer Name in English

Qoo10 Connector for CData Sync

Categories

Returns data regarding category list. Data are returned in Japanese language by default.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Language supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM Categories WHERE Language = 'EN'

Columns

Name Type Description
SmallCatagoryCode [KEY] String Small Catagory Code
SmallCatagoryName String Small Catagory Name
MediumCatagoryCode String Medium Catagory Code
MediumCatagoryName String Medium Catagory Name
LargeCatagoryCode String Large Catagory Code
LargeCatagoryName String Large Catagory Name
Language String Language of text in the response.

Qoo10 Connector for CData Sync

Claims

Returns data regarding claim info. ClaimStaus column is required to be specified for this view. ClaimStaus = 4 by default. Possible values are 1,2,3,4,5,6.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • ClaimStatus supports the '=' operator.
  • Date supports the '=', '<' and '>' operators.
For example, the following query is processed server side:
SELECT * FROM Claims WHERE ClaimStatus=2
SELECT * FROM Claims WHERE ClaimStatus=4 AND Date>'2017-04-24' AND Date<'2019-04-23'
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type Description
ClaimStatus String Processing state. 1-Cancel request. 2-Cancelling. 3-Cancel completed. 4-Return request. 5-Returning. 6-Return completed.

The allowed values are 1, 2, 3, 4, 5, 6.

CancelRefundDate Datetime Cancel / Return / Exchange Completion Date.
Reason String Reason for return, exchange.
RequestDate Datetime Request date for cancellation / return / exchange.
OrderDate Datetime Date of the order.
PaymentDate Datetime Date of the payment.
ShippingDate Datetime Shipping date.
DeliveredDate Datetime Delivered date.
OrderNo [KEY] String Code of the order.
PackNo String The code of pack.
ItemCode String The item code of Qoo10.
SellerItemCode String Merchant product code.
ItemTitle String Product name.
OrderQty Integer Quantity of the order.
PaymentNation String Payment nation.
Currency String Currency.
PaymentAmount String Settlement amount.
DeliveryCompanyReturn String Delivery company return.
TrackingNoReturn String Tracking code return.
ZipCode String ZipCode.
PaymentReturnShipping String Payment return shipping.
ItemCondition String Condition of the item.
Receiver String Receiver of the order.
ReceiverTel String Telephone number of the receiver.
ReceiverMobile String Mobile number of the receiver.
Buyer String Person who made the order.
BuyerTel String Telephone number of the buyer.
BuyerMobile String Mobile number of the buyer.
CODCancelPrice Decimal COD cancel price.
CODQrefundPrice Decimal COD refound price.
CODCancelRelatedOrder String COD cancel related order.
Date Date Date range.

Qoo10 Connector for CData Sync

Goods

Retrieve ItemCode, ItemStatus and SellerCode related goods.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • ItemStatus supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM Goods WHERE ItemStatus='S2'
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type Description
ItemNo [KEY] String The item code of Qoo10.
ItemStatus String Item Status. Possible values: S0(Unidentified), S1(Standby), S2(Active).

The allowed values are S0, S1, S2.

SellerCode String Item code managed by the seller.

Qoo10 Connector for CData Sync

Makers

Returns data regarding manufacturers registered on Qoo10.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Keyword supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM Makers WHERE Keyword='test'
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type Description
Keyword String Keyword for the search.
ManufacturerNo [KEY] String Manufacturer No
ManufacturerName String Manufacturer Name
EnglishManufacturerName String Manufacturer Name in English

Qoo10 Connector for CData Sync

Orders

Returns data regarding orders. ShippingStatus column is required to be specified for this view.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • ShippingStatus supports the '=' operator.
  • SearchCondition supports the '=' operator.
  • Date supports the '=', '<' and '>' operators.
For example, the following query is processed server side:
SELECT * FROM Orders WHERE ShippingStatus='1'
SELECT * FROM Orders WHERE ShippingStatus=1 AND SearchCondition='2' AND Date>'2017-04-24' AND Date<'2019-04-23'
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type Description
OrderNo [KEY] String Code of the order.
SellerID String Id of the seller.
PackNo String The code of pack.
PackingNo String Number of the packing.
ShippingStatus String Status of the shipping. 1 : Waiting for Shipping 2 : Request Shipping 3 : Check Order.
OrderDate Datetime Date of the order.
PaymentDate Datetime Date of the payment.
Buyer String Person who made the order.
BuyerGata String Buyer gata.
BuyerTel String Telephone number of the buyer.
BuyerMobile String Mobile number of the buyer.
BuyerEmail String Email of the buyer.
OrderType String Type of the order.
ItemCode String The item code of Qoo10.
ItemTitle String Title of the item.
Option String Order option.
OptionCode String Option code.
OrderPrice Decimal Price of the order.
OrderQty Integer Quantity of the order.
Discount Decimal Discount of the order.
Total Decimal Total price of the order.
SettlePrice Decimal Settle price of the order.
Receiver String Receiver of the order.
ReceiverGata String Receiver of the order.
ReceiverTel String Telephone number of the receiver.
ReceiverMobile String Mobile number of the receiver.
SenderName String Name of the sender.
SenderTel String Telephone number of the sender.
SenderNation String Nation of the sender.
SenderZipCode String ZipCode of the sender.
SenderAddr String Address of the sender.
RelatedOrder String Related order.
SellerDeliveryNo String Number of the delivery.
VoucherCode String Code of the voucher.
PaymentNation String Payment nation.
PaymentMethod String Method of the payment.
CodPrice Decimal Cod price.
CartDiscountSeller Decimal Cart Discount Seller.
CartDiscountQoo10 Decimal Cart Discount Qoo10.
Currency String Currency.
Date Date Date range.
SearchCondition String Inquiry Date Type. 1: (Order date), 2:(Payment date), 3 :(Shipping date), 4 :(Delivered date). Default :1.

Qoo10 Connector for CData Sync

SellerDeliveryGroups

Returns data regarding seller delivery group info.

View Specific Information

Qoo10 does not support any column for filtering this view.

Columns

Name Type Description
ShippingNo [KEY] Integer Shipping Group No
ShippingFee Decimal Shipping rate
ShippingType String Shipping type
FreeCondition Decimal Free Shipping Condition
Region String Shippign Option by Region Y/N
Oversea String Shipping Oversea Y/N
TranscName String Delivery Company

Qoo10 Connector for CData Sync

ShippingInfo

Returns data regarding shipping info. ShippingStatus column is required to be specified for this view.

Select

The Sync App will use the Qoo10 API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • ShippingStatus supports the '=' operator.
  • SearchCondition supports the '=' operator.
  • Date supports the '=', '<' and '>' operators.
For example, the following query is processed server side:
SELECT * FROM ShippingInfo WHERE ShippingStatus = '1'
SELECT * FROM ShippingInfo WHERE ShippingStatus = '3' AND SearchCondition = '2' AND Date > '2017-04-24' AND Date < '2019-04-23'
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name Type Description
ShippingStatus String Status of the shipping. 1 : Waiting for Shipping 2 : Request Shipping 3 : Check Order.
SellerID String Id of the seller.
OrderNo [KEY] String Code of the order.
DeliveredDate Datetime Date of the delivery.
SellerItemCode String The code of seller.
SellerDiscount Decimal The code of seller.
ItemTitle String Title of the item.
ShippingCountry String Country specified for shipping.
EstShippingDate Datetime Est Shipping date.
ShippingDate Datetime Shipping date.
ZipCode String ZipCode.
ShippingAddr String Shipping address.
Addr1 String First address.
Addr2 String Second address.
HopeDate String Hope date.
ShippingWay String ShippingWay.
ShippingMsg String Message of the shipping.
ShippingRate Decimal Rate of the shipping.
ShippingRateType String Rate type of the shipping.
SellerDeliveryNo String Number of the delivery.
DeliveryCompany String Delivery company.
TrackingNo String Invoice number.
Gift String Gift.
BranchName String Branch name.
PickupAddress String Pickup address.
PickupzipCode String Pick up zip code.
SearchCondition String Inquiry Date Type. 1: (Order date), 2:(Payment date), 3 :(Shipping date), 4 :(Delivered date). Default :1.
Date Date Date range.

Qoo10 Connector for CData Sync

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


PropertyDescription
ApiKeyApi Key you get from your Qoo10 account.
UserThe Qoo10 user account used to authenticate.
PasswordThe password used to authenticate the user.

Connection


PropertyDescription
URLHost domain where you want to get data from your Qoo10 account.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous


PropertyDescription
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Qoo10 Connector for CData Sync

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
ApiKeyApi Key you get from your Qoo10 account.
UserThe Qoo10 user account used to authenticate.
PasswordThe password used to authenticate the user.
Qoo10 Connector for CData Sync

ApiKey

Api Key you get from your Qoo10 account.

Remarks

Api Key you get from your Qoo10 account.

Qoo10 Connector for CData Sync

User

The Qoo10 user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the Qoo10 server.

Qoo10 Connector for CData Sync

Password

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

Qoo10 Connector for CData Sync

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.


PropertyDescription
URLHost domain where you want to get data from your Qoo10 account.
Qoo10 Connector for CData Sync

URL

Host domain where you want to get data from your Qoo10 account.

Remarks

Host domain where you want to get data from your Qoo10 account. Possible options are:
JP: api.qoo10.jp
SG: api.qoo10.sg
ID: www.qoo10.co.id/
CN: api.qoo10.cn/
MY: www.qoo10.my/
HK: www.qoo10.hk/
COM: api.qoo10.com/

Qoo10 Connector for CData Sync

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.
Qoo10 Connector for CData Sync

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Qoo10 Connector for CData Sync

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.
Qoo10 Connector for CData Sync

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type Default Port Description
TUNNEL 80 When this is set, the Sync App opens a connection to Qoo10 and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Qoo10 Connector for CData Sync

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

Qoo10 Connector for CData Sync

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

Qoo10 Connector for CData Sync

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

Qoo10 Connector for CData Sync

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Qoo10 Connector for CData Sync

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Qoo10 Connector for CData Sync

ProxyAutoDetect

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

Qoo10 Connector for CData Sync

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

Qoo10 Connector for CData Sync

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

Qoo10 Connector for CData Sync

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Qoo10 Connector for CData Sync

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

Qoo10 Connector for CData Sync

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

Qoo10 Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTODefault setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Qoo10 Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Qoo10 Connector for CData Sync

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogModulesCore modules to be included in the log file.
Qoo10 Connector for CData Sync

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Qoo10 Connector for CData Sync

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Qoo10 Connector for CData Sync

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Qoo10 Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Qoo10 Connector for CData Sync

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Qoo10 Connector for CData Sync

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Qoo10 Connector for CData Sync

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Qoo10 Connector for CData Sync

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Qoo10 Connector for CData Sync

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Qoo10 Connector for CData Sync

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Qoo10 Connector for CData Sync

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Qoo10 Connector for CData Sync

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

Qoo10 Connector for CData Sync

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App 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 Sync App.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM GoodsDetail 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"

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462