WooCommerce への接続を追加

WooCommerce への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. WooCommerce アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからWooCommerce コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

WooCommerce への接続

WooCommerce に接続するには、サービスのインスタンスのURL も指定する必要があります。

• Url：接続するWooCommerce インスタンスのベースURL。例： http://localhost/woocommerce/

WooCommerce への認証

WooCommerce は、Basic 認証、"one-legged" OAuth 1.0認証、および標準OAuth 2.0認証をサポートします。

Basic 認証

ある種のプラグインやサーバーは、適切に構成されていない場合、Authorization ヘッダーに干渉する可能性があります。このような場合、ユーザーはBasic 認証を使用して資格情報を検証することができます。Basic 認証では、ユーザーがWooCommerce consumer_key およびWooCommerce consumer_secret をそれぞれユーザーとパスワードとして指定します。これらの資格情報は、リクエストごとにクエリパラメータとして送信されます。

Basic 認証を使用して認証するには、以下のプロパティを指定します。

• AuthScheme： Basic。
• ConsumerKey：WooCommerce コンシューマーキー（ユーザー）。
• ConsumerSecret：WooCommerce コンシューマーシークレット（パスワード）。

"One-Legged" 認証

one-legged（OAuth 1.0）認証は、WooCommerce 設定ページで生成された資格情報を使用します。 これらはWooCommerce OAuth 2.0プラグインを使用して生成された資格情報とは異なります。

one-legged 認証を使用して認証するには、以下のプロパティを指定します。

• AuthScheme： OAuthOneLegged。
• ConsumerKey
• ConsumerSecret

OAuth 2.0 認証

OAuth 2.0認証を有効にするには、すべてのOAuth フローでWooCommerce OAuth2 Plugin をインストールし、カスタムOAuth アプリケーションを作成してAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのWooCommerce への認証について詳しく説明します。カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 WooCommerce で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

OAuth アクセストークンの自動リフレッシュ：

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには：

1. はじめてデータに接続する前に、次の接続プロパティを設定します。
   • InitiateOAuth： REFRESH。
   • OAuthClientId：アプリケーション設定のクライアントId。
   • OAuthClientSecret：アプリケーション設定のクライアントシークレット。
   • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
   • OAuthSettingsLocation：Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
2. その後のデータ接続では、以下を設定します。
   • InitiateOAuth
   • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
2. 次の接続プロパティを設定します。
   • OAuthClientId：アプリケーション設定のクライアントId。
   • OAuthClientSecret：アプリケーション設定のクライアントシークレット。

3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

このセクションでは、WooCommerce Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、WooCommerce にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、WooCommerce API へのSQL の実行について詳しく説明します。

主要機能

• Sync App は、orders、customers、products などのWooCommerce エンティティをリレーショナルテーブルやビューとしてモデル化し、SQL を記述してWooCommerce データをクエリできるようにします。
• ストアドプロシージャを使用すると、システムツールの実行や、特定の配送地域で利用可能な場所の更新など、WooCommerce の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Sync App を使用するとWooCommerce アカウントへのあらゆる変更が即座に反映されます。

ビュー

WooCommerce からのデータへの読み取りまたは書き込みアクセスには、事前定義されたテーブル およびビュー を使用できます。

ストアドプロシージャ

Sync App を使用すると、ストアドプロシージャ を介してWooCommerce ツールの実行や特定の配送地域の場所の更新ができます。

システムテーブル

システムテーブル には、データベースに属するオブジェクトとリソースに関する情報が含まれています。

Sync App はWooCommerce のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

WooCommerce Connector for CData Sync テーブル

Name	Description
Attributes	Retrieve and modify product attributes.
Categories	Retrieve product categories.
Coupons	Retrieve and modify coupons.
Customers	Retrieve and modify customers.
OrderLineItems	Add, update and view the line items for an order.
OrderNotes	Retrieve and modify the notes for an order.
OrderRefunds	Retrieve and modify order refunds.
Orders	Retrieve and modify orders.
PaymentGateways	Retrieve and modify payment gateways.
ProductAttributeTerms	Retrieve the terms for an attribute.
ProductReviews	Retrieve and modify products reviews.
Products	Retrieve and modify products.
ProductShippingClasses	Retrieve and modify product shipping classes.
ProductTags	Retrieve and modify product tags.
ProductVariations	Retrieve and modify product variations.
SettingOptions	View and manage settings options.
ShippingZoneMethods	Retrieve and modify shipping zone methods.
ShippingZones	Retrieve and modify shipping zones.
TaxClasses	Retrieve and modify tax classes.
TaxRates	Retrieve and modify tax rates.
Webhooks	Retrieve and modify webhooks.

Retrieve and modify product attributes.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: Id. All other columns are processed client side.

SELECT * FROM Attributes WHERE Id = 4

Insert

The following attribute is required when performing an insert: Name.

INSERT INTO Attributes (Name) VALUES ('attribute_name')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	False	Attribute ID.
Name	String	False	Attribute name.
Slug	String	False	An alphanumeric identifier for the resource unique to its type.
Type	String	False	Type of attribute. By default only select is supported.
OrderBy	String	False	Default sort order. Options: menu_order, name, name_num and id. Defaults to menu_order.
HasArchives	Boolean	False	Enable/Disable attribute archives. Defaults to false.

Retrieve product categories.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Slug, Parent, Product. All other columns are processed client side.

SELECT * FROM Categories WHERE Id = 4
SELECT * FROM Categories WHERE Slug = 'criteria'
SELECT * FROM Categories WHERE Parent = 2

Insert

The following attribute is required when performing an insert: Name.

INSERT INTO Categories (Name) VALUES ('category_name')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
Name	String	False	Category name.
Slug	String	False	An alphanumeric identifier for the resource unique to its type.
Parent	Long	False	The ID for the parent of the resource.
Description	String	False	HTML description of the resource.
Display	String	False	Category archive display type. Options: default, products, subcategories and both.
MenuOrder	Integer	False	Menu order, used to custom sort the resource.
Count	Integer	True	Number of published products for the resource.
ImageId	Long	False	Image ID.
ImageDateCreated	Datetime	True	The date the image was created, in the site's timezone.
ImageDateModified	Datetime	True	The date the image was last modified, in the site's timezone.
ImageSrc	String	False	Image URL.
ImageName	String	False	Image name.
ImageAlt	String	False	Image alternative text.

Retrieve and modify coupons.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Code. All other columns are processed client side.

SELECT * FROM Coupons WHERE Id = 4
SELECT * FROM Coupons WHERE Code = 'criteria'

Update

To perform an update or insert using any of the aggregate columns which contain simple primitive arrays, we can simply pass a JSON array string as the value:

UPDATE Coupons SET ProductIdsAggregate = '[14, 16, 29]' WHERE ID = 42

To introduce new metadata fields which are not present in the schema, the 'metadata' pseudocolumn can be used. The update below will create two new metadata fields with keys 'key1' and 'key2' and set their respective values. If any of the keys specified already exists, its value will be updated.

UPDATE Coupons SET metadata = 'key1:val1, key2:val2' WHERE ID = 58

Insert

The following attribute is required when performing an insert: Code.

INSERT INTO Coupons (Code) VALUES ('coupon_code')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the object.
Code	String	False	Coupon code.
Amount	String	False	The amount of discount. Should always be numeric, even if setting a percentage.
DateCreated	Datetime	True	The date the coupon was created, in the site's timezone.
DateModified	Datetime	True	The date the coupon was last modified, in the site's timezone.
DiscountType	String	False	Determines the type of discount that will be applied. Options: percent, fixed_cart and fixed_product. Defaults to fixed_cart.
Description	String	False	Coupon description.
DateExpires	Datetime	False	The date the coupon expires, in the site's timezone.
UsageCount	Integer	True	Number of times the coupon has been used already.
IndividualUse	Boolean	False	If true, the coupon can only be used individually. Other applied coupons will be removed from the cart. Defaults to false.
ProductIdsAggregate	String	False	List of product IDs the coupon can be used on.
ExcludedProductIdsAggregate	String	False	List of product IDs the coupon cannot be used on.
UsageLimit	Integer	False	How many times the coupon can be used in total.
UsageLimitPerUser	Integer	False	How many times the coupon can be used per customer.
LimitUsageToXItems	Integer	False	Max number of items in the cart the coupon can be applied to.
FreeShipping	Boolean	False	If true and if the free shipping method requires a coupon, this coupon will enable free shipping. Defaults to false.
ProductCategoriesAggregate	String	False	List of category IDs the coupon applies to.
ExcludedProductCategoriesAggregate	String	False	List of category IDs the coupon does not apply to.
ExcludeSaleItems	Boolean	False	If true, this coupon will not be applied to items that have sale prices. Defaults to false.
MinimumAmount	String	False	Minimum order amount that needs to be in the cart before coupon applies.
MaximumAmount	String	False	Maximum order amount allowed when using the coupon.
EmailRestrictionsAggregate	String	False	List of email addresses that can use this coupon.
UsedByAggregate	String	True	List of user IDs (or guest email addresses) that have used the coupon.

Retrieve and modify customers.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Email, Role. All other columns are processed client side.

SELECT * FROM Customers WHERE Id = 4
SELECT * FROM Customers WHERE Email = '[email protected]'
SELECT * FROM Customers WHERE Username = 'user' AND IsPayingCustomer = true

Update

To introduce new metadata fields which are not present in the schema, the 'metadata' pseudocolumn can be used. The update below will create two new metadata fields with keys 'key1' and 'key2' and set their respective values. If any of the keys specified already exists, its value will be updated.

UPDATE Customers SET metadata = 'key1:val1, key2:val2' WHERE ID = 58

Insert

The following attribute is required when performing an insert: Email.

INSERT INTO Customers (Email) VALUES ('[email protected]')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
DateCreated	Datetime	True	The date the customer was created, in the site's timezone.
DateModified	Datetime	True	The date the customer was last modified, in the site's timezone.
Email	String	False	The email address for the customer.
FirstName	String	False	Customer first name.
LastName	String	False	Customer last name.
Role	String	True	Customer role.
Username	String	False	Customer login name.
Password	String	False	Customer password. write-only
IsPayingCustomer	Bool	True	Is the customer a paying customer? read-only
AvatarUrl	String	True	Avatar URL.
MetaData	String	False	Meta data. See Customer - Meta data properties
BillingFirstName	String	False	First name.
BillingLastName	String	False	Last name.
BillingCompany	String	False	Company name.
BillingAddress1	String	False	Address line 1
BillingAddress2	String	False	Address line 2
BillingCity	String	False	City name.
BillingState	String	False	ISO code or name of the state, province or district.
BillingPostcode	String	False	Postal code.
BillingCountry	String	False	ISO code of the country.
BillingEmail	String	False	Email address.
BillingPhone	String	False	Phone number.
ShippingFirstName	String	False	First name.
ShippingLastName	String	False	Last name.
ShippingCompany	String	False	Company name.
ShippingAddress1	String	False	Address line 1
ShippingAddress2	String	False	Address line 2
ShippingCity	String	False	City name.
ShippingState	String	False	ISO code or name of the state, province or district.
ShippingPostcode	String	False	Postal code.
ShippingCountry	String	False	ISO code of the country.

Add, update and view the line items for an order.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: TotalTax, OrderId. All other columns are processed client side. If the 'OrderId' filter is not specified, the Sync App will fetch a list of all the orders and perform a request for each order in the list.

SELECT * FROM OrderLineItems WHERE OrderId = 13
SELECT * FROM OrderLineItems WHERE TotalTax = 14.21

Insert

The following attribute is required when performing an insert: OrderId.

INSERT INTO OrderLineItems (Productid, Quantity, OrderId) VALUES (28, 9, 35)

Update

The following attribute is required when performing an update: OrderId.

UPDATE OrderLineItems SET Quantity = 12 WHERE Id = 4 AND OrderId = 35

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	False	Item ID.
Name	String	False	Product name.
ProductId	Long	False	Product ID.
VariationId	Long	False	Variation ID, if applicable.
Quantity	Integer	False	Quantity ordered.
TaxClass	String	False	Tax class of product.
Subtotal	String	False	Line subtotal (before discounts).
SubtotalTax	String	True	Line subtotal tax (before discounts).
Total	String	False	Line total (after discounts).
TotalTax	String	True	Line total tax (after discounts).
Taxes	String	True	Line taxes. See Order - Taxes properties read-only
MetaData	String	False	Meta data. See Order - Meta data properties
Sku	String	True	Product SKU.
Price	String	True	Product price.
OrderId	String	True	Id of the order.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
ReferenceNumber	String	This column will be used in Bulk operations to get specific values from the Temp tables.

Retrieve and modify the notes for an order.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: OrderId. All other columns are processed client side. If the 'OrderId' filter is not specified, the Sync App will fetch a list of all the orders and perform a request for each order in the list.

SELECT * FROM OrderNotes WHERE OrderId = 21

Insert

The following attributes are required when performing an insert: Note, OrderId.

INSERT INTO OrderNotes (Note, OrderId) VALUES ("note_text", 144)

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	False	Unique identifier for the resource.
Author	String	True	Order note author.
DateCreated	Datetime	True	The date the order note was created, in the site's timezone.
Note	String	False	Order note content.
CustomerNote	Boolean	False	If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only. Defaults to false.
AddedByUser	Boolean	False	If true, this note will be attributed to the current user. If false, the note will be attributed to the system. Defaults to false.
OrderId	String	True	Id of the order.

Retrieve and modify order refunds.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: OrderId. All other columns are processed client side. If the 'OrderId' filter is not specified, the Sync App will fetch a list of all the orders and perform a request for each order in the list.

SELECT * FROM OrderRefunds WHERE OrderId = 21

Insert

The following attribute is required when performing an insert: OrderId.

INSERT INTO OrderRefunds (OrderId) VALUES (33)

Columns

Name	Type	ReadOnly	Description
Id	Long	False	Unique identifier for the resource.
DateCreated	Datetime	True	The date the order refund was created, in the site's timezone.
Amount	String	False	Refund amount.
Reason	String	False	Reason for refund.
RefundedBy	Long	False	User ID of user who created the refund.
RefundedPayment	Boolean	True	If the payment was refunded via the API. See api_refund.
LineItems	String	False	Line items data. See Order refund - Line items properties
ApiRefund	Boolean	False	When true, the payment gateway API is used to generate the refund. Defaults to true. write-only
OrderId	String	True	Id of the order.

Retrieve and modify orders.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, ParentId, Status, DateModified, ProductId. All other columns are processed client side.

SELECT * FROM Orders WHERE Id = 4
SELECT * FROM Orders WHERE ParentId = 4
SELECT * FROM Orders WHERE Status = 'pending' AND CustomerId = 501

Update

To perform an update or insert using any of the aggregate columns which contain object arrays, we can use a temporary table, or pass the value as a JSON string:

INSERT INTO OrderCouponLines#TEMP (Code) VALUES ('CouponCode')
UPDATE Orders SET CouponLinesAggregate = 'OrderCouponLines#TEMP' WHERE ID = 14

To introduce new metadata fields which are not present in the schema, the 'metadata' pseudocolumn can be used. The update below will create two new metadata fields with keys 'key1' and 'key2' and set their respective values. If any of the keys specified already exists, its value will be updated.

UPDATE Orders SET metadata = 'key1:val1, key2:val2' WHERE ID = 58

Insert

This table does not have any required attributes when performing an insert.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
ParentId	Long	False	Parent order ID.
Number	String	True	Order number.
OrderKey	String	True	Order key.
CreatedVia	String	True	Shows where the order was created.
Version	String	True	Version of WooCommerce which last updated the order.
Status	String	False	Order status. Options: pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Defaults to pending.
Currency	String	False	Currency the order was created with, in ISO format. Options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, IRT, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR and ZMW. Defaults to USD.
DateCreated	Datetime	True	The date the order was created, in the site's timezone.
DateModified	Datetime	True	The date the order was last modified, in the site's timezone.
DiscountTotal	String	True	Total discount amount for the order.
DiscountTax	String	True	Total discount tax amount for the order.
ShippingTotal	String	True	Total shipping amount for the order.
ShippingTax	String	True	Total shipping tax amount for the order.
CartTax	String	True	Sum of line item taxes only.
Total	String	True	Grand total.
TotalTax	String	True	Sum of all taxes.
PricesIncludeTax	Boolean	True	True the prices included tax during checkout.
CustomerId	Long	False	User ID who owns the order. 0 for guests. Defaults to 0.
CustomerIpAddress	String	True	Customer's IP address.
CustomerUserAgent	String	True	User agent of the customer.
CustomerNote	String	False	Note left by customer during checkout.
PaymentMethod	String	False	Payment method ID.
PaymentMethodTitle	String	False	Payment method title.
TransactionId	String	False	Unique transaction ID.
DatePaid	Datetime	True	The date the order was paid, in the site's timezone.
DateCompleted	Datetime	True	The date the order was completed, in the site's timezone.
CartHash	String	True	MD5 hash of cart items to ensure orders are not modified.
LineItemsAggregate	String	False	Line items data. See Order - Line items properties
TaxLinesAggregate	String	True	Tax lines data. See Order - Tax lines properties read-only
ShippingLinesAggregate	String	False	Shipping lines data. See Order - Shipping lines properties
FeeLinesAggregate	String	False	Fee lines data. See Order - Fee lines properties
CouponLinesAggregate	String	False	Coupons line data. See Order - Coupon lines properties
RefundsAggregate	String	True	List of refunds. See Order - Refunds properties read-only
SetPaid	Boolean	False	Define if the order is paid. It will set the status to processing and reduce stock items. Defaults to false. write-only
BillingFirstName	String	False	First name.
BillingLastName	String	False	Last name.
BillingCompany	String	False	Company name.
BillingAddress1	String	False	Address line 1
BillingAddress2	String	False	Address line 2
BillingCity	String	False	City name.
BillingState	String	False	ISO code or name of the state, province or district.
BillingPostcode	String	False	Postal code.
BillingCountry	String	False	Country code in ISO 3166-1 alpha-2 format.
BillingEmail	String	False	Email address.
BillingPhone	String	False	Phone number.
ShippingFirstName	String	False	First name.
ShippingLastName	String	False	Last name.
ShippingCompany	String	False	Company name.
ShippingAddress1	String	False	Address line 1
ShippingAddress2	String	False	Address line 2
ShippingCity	String	False	City name.
ShippingState	String	False	ISO code or name of the state, province or district.
ShippingPostcode	String	False	Postal code.
ShippingCountry	String	False	Country code in ISO 3166-1 alpha-2 format.
ProductId	Long	False	Limit result set to resources assigned to a specific product.

Retrieve and modify payment gateways.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: Id. All other columns are processed client side.

SELECT * FROM PaymentGateways WHERE Id = 'id'

Update

The following attribute is required when performing an update: Id.

UPDATE PaymentGateways SET Title='Credit card / debit card', Description='Enter your card details' WHERE Id = 'woocommerce_payments'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Payment gateway ID.
Title	String	False	Payment gateway title on checkout.
Description	String	False	Payment gateway description on checkout.
Order	Integer	False	Payment gateway sort order.
Enabled	Boolean	False	Payment gateway enabled status.
MethodTitle	String	True	Payment gateway method title.
MethodDescription	String	True	Payment gateway method description.
MethodSupportsAggregate	String	True	Supported features for this payment gateway.
SettingsTitleId	String	True	A unique identifier for the setting.
SettingsTitleDefault	String	True	Default value for the setting.
SettingsTitleDescription	String	True	A human readable description for the setting used in interfaces.
SettingsTitleLabel	String	True	A human readable label for the setting used in interfaces.
SettingsTitlePlaceholder	String	True	Placeholder text to be displayed in text inputs.
SettingsTitleTip	String	True	Additional help text shown to the user about the setting.
SettingsTitleType	String	True	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsTitleValue	String	True	Setting value.
SettingsInstructionsDefault	String	True	Default value for the setting.
SettingsInstructionsDescription	String	True	A human readable description for the setting used in interfaces.
SettingsInstructionsLabel	String	True	A human readable label for the setting used in interfaces.
SettingsInstructionsPlaceholder	String	True	Placeholder text to be displayed in text inputs.
SettingsInstructionsTip	String	True	Additional help text shown to the user about the setting.
SettingsInstructionsType	String	True	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsInstructionsValue	String	True	Setting value.

Retrieve the terms for an attribute.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Slug, AttributeId, ProductId. All other columns are processed client side. If the 'AttributeId' filter is not specified, the Sync App will fetch a list of all the attributes and perform a request for each attribute in the list.

SELECT * FROM ProductAttributeTerms WHERE AttributeId = 4
SELECT * FROM ProductAttributeTerms WHERE ProductId = 41 AND Slug = 'criteria'

ProductAttributeTerms.rsd

Insert

The following attributes are required when performing an insert: Name, AttributeId.

INSERT INTO ProductAttributeTerms (Name, AttributeId) VALUES ('term_name', 2)

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
Name	String	False	Term name.
Slug	String	False	An alphanumeric identifier for the resource unique to its type.
Description	String	False	HTML description of the resource.
MenuOrder	Integer	False	Menu order, used to custom sort the resource.
Count	Integer	True	Number of published products for the resource.
AttributeId	Long	True	Id of the attribute.

Retrieve and modify products reviews.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Status, Reviewer, ReviewerEmail, ProductId. All other columns are processed client side.

SELECT * FROM ProductReviews WHERE Id = 4
SELECT * FROM ProductReviews WHERE ReviewerEmail = '[email protected]'

Insert

The following attributes are required when performing an insert: ProductId, Reviewer, Review.

INSERT INTO ProductReviews (ProductId, Reviewer, ReviewerEmail, Review) VALUES (167, 'reviewer', '[email protected]', 'review_content')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
DateCreated	Datetime	True	The date the review was created, in the site's timezone.
ProductId	Long	False	Unique identifier for the product that the review belongs to.
Status	String	False	Status of the review. Options: approved, hold, spam, unspam, trash and untrash. Defauls to approved.
Reviewer	String	False	Reviewer name.
ReviewerEmail	String	False	Reviewer email.
Review	String	False	The content of the review.
Rating	Integer	False	Review rating (0 to 5).
Verified	Boolean	False	Shows if the reviewer bought the product or not.

Retrieve and modify products.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Slug, Type, Status, Sku, Price, OnSale, TaxClass, StockStatus, ShippingClass, ParentId. The price filter can be used with the <, > conditions and may be used twice to specify a range. All other columns are processed client side.

SELECT * FROM Products WHERE Id = 4
SELECT * FROM Products WHERE Slug = 'criteria' AND OnSale = true
SELECT * FROM Products WHERE Price < 14.99 AND Price > 11.99

Update

To perform an update or insert using any of the aggregate columns which contain simple primitive arrays, we can simply pass a JSON array string as the value:

UPDATE Products SET Name = 'ProductName', RelatedIdsAggregate = '[14, 16, 29]' WHERE ID = 42

To perform an update or insert using any of the aggregate columns which contain object arrays, we can use a temporary table, or pass the value as a JSON string:

INSERT INTO ProductCategories#TEMP (Name) VALUES ('Category')
INSERT INTO ProductCategories#TEMP (Name) VALUES ('Category2')
UPDATE Products SET CategoriesAggregate = 'ProductCategories#TEMP' WHERE ID = 167

To introduce new metadata fields which are not present in the schema, the 'metadata' pseudocolumn can be used. The update below will create two new metadata fields with keys 'key1' and 'key2' and set their respective values. If any of the keys specified already exists, its value will be updated.

UPDATE Products SET metadata = 'key1:val1, key2:val2' WHERE ID = 58

Insert

This table does not have any required attributes when performing an insert.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
Name	String	False	Product name.
Slug	String	False	Product slug.
Permalink	String	True	Product URL.
DateCreated	Datetime	True	The date the product was created, in the site's timezone.
DateModified	Datetime	True	The date the product was last modified, in the site's timezone.
Type	String	False	Product type. Options: simple, grouped, external and variable. Defaults to simple.
Status	String	False	Product status (post status). Options: draft, pending, private and publish. Defaults to publish.
Featured	Boolean	False	Featured product. Defaults to false.
CatalogVisibility	String	False	Catalog visibility. Options: visible, catalog, search and hidden. Defaults to visible.
Description	String	False	Product description.
ShortDescription	String	False	Product short description.
Sku	String	False	Unique identifier.
Price	String	True	Current product price.
RegularPrice	String	False	Product regular price.
SalePrice	String	False	Product sale price.
DateOnSaleFrom	Datetime	False	Start date of sale price, in the site's timezone.
DateOnSaleTo	Datetime	False	End date of sale price, in the site's timezone.
PriceHtml	String	True	Price formatted in HTML.
OnSale	Boolean	True	Shows if the product is on sale.
Purchasable	Boolean	True	Shows if the product can be bought.
TotalSales	Integer	True	Amount of sales.
Virtual	Boolean	False	If the product is virtual. Defaults to false.
Downloadable	Boolean	False	If the product is downloadable. Defaults to false.
Downloads	String	False	List of downloadable files. See Product - Downloads properties
DownloadLimit	Integer	False	Number of times downloadable files can be downloaded after purchase. Defaults to -1.
DownloadExpiry	Integer	False	Number of days until access to downloadable files expires. Defaults to -1.
ExternalUrl	String	False	Product external URL. Only for external products.
ButtonText	String	False	Product external button text. Only for external products.
TaxStatus	String	False	Tax status. Options: taxable, shipping and none. Defaults to taxable.
TaxClass	String	False	Tax class.
ManageStock	Boolean	False	Stock management at product level. Defaults to false.
StockQuantity	Integer	False	Stock quantity.
StockStatus	String	False	Controls the stock status of the product. Options: instock, outofstock, onbackorder. Defaults to instock.
Backorders	String	False	If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Defaults to no.
BackordersAllowed	Boolean	True	Shows if backorders are allowed.
Backordered	Boolean	True	Shows if the product is on backordered.
SoldIndividually	Boolean	False	Allow one item to be bought in a single order. Defaults to false.
Weight	String	False	Product weight.
ShippingRequired	Boolean	True	Shows if the product need to be shipped.
ShippingTaxable	Boolean	True	Shows whether or not the product shipping is taxable.
ShippingClass	String	False	Shipping class slug.
ShippingClassId	Long	True	Shipping class ID.
ReviewsAllowed	Boolean	False	Allow reviews. Defaults to true.
AverageRating	String	True	Reviews average rating.
RatingCount	Integer	True	Amount of reviews that the product have.
RelatedIdsAggregate	String	True	List of related products IDs.
UpsellIdsAggregate	String	False	List of up-sell products IDs.
CrossSellIdsAggregate	String	False	List of cross-sell products IDs.
ParentId	Long	False	Product parent ID.
PurchaseNoteAggregate	String	False	Optional note to send the customer after purchase.
CategoriesAggregate	String	False	List of categories. See Product - Categories properties
TagsAggregate	String	False	List of tags. See Product - Tags properties
ImagesAggregate	String	False	List of images. See Product - Images properties
AttributesAggregate	String	False	List of attributes. See Product - Attributes properties
DefaultAttributesAggregate	String	False	Defaults variation attributes. See Product - Default attributes properties
VariationsAggregate	String	True	List of variations IDs.
GroupedProductsAggregate	String	False	List of grouped products ID.
MenuOrder	Integer	False	Menu order, used to custom sort products.
MetaData	String	False	Meta data. See Product - Meta data properties
DimensionsLength	String	False	Product length.
DimensionsWidth	String	False	Product width.
DimensionsHeight	String	False	Product height.

Retrieve and modify product shipping classes.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Slug, ProductId. All other columns are processed client side.

SELECT * FROM ProductShippingClasses WHERE Id = 4
SELECT * FROM ProductShippingClasses WHERE ProductId = 16

Insert

The following attribute is required when performing an insert: Name.

INSERT INTO ProductShippingClasses (Name) VALUES ('class_name')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
Name	String	False	Shipping class name.
Slug	String	False	An alphanumeric identifier for the resource unique to its type.
Description	String	False	HTML description of the resource.
Count	Integer	True	Number of published products for the resource.
ProductId	Long	False	Limit result set to resources assigned to a specific product.

Retrieve and modify product tags.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Slug, Product, HideEmpty. All other columns are processed client side.

SELECT * FROM ProductTags WHERE Id = 4
SELECT * FROM ProductTags WHERE Slug = 'criteria'
SELECT * FROM ProductTags WHERE ProductId = 16

Insert

The following attribute is required when performing an insert: Name.

INSERT INTO ProductTags (Name) VALUES ('tag_name')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
Name	String	False	Tag name.
Slug	String	False	An alphanumeric identifier for the resource unique to its type.
Description	String	False	HTML description of the resource.
Count	Integer	True	Number of published products for the resource.
ProductId	Long	False	Limit result set to resources assigned to a specific product.

Retrieve and modify product variations.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: Id, Sku, Price, OnSale, Status, TaxClass, StockStatus, ProductId, ParentId. The price filter can be used with the <, > conditions and may be used twice to specify a range. All other columns are processed client side.

SELECT * FROM ProductVariations WHERE Id = 4
SELECT * FROM ProductVariations WHERE Price < 14.99 AND Price > 11.99 AND OnSale = true

Update

To introduce new metadata fields which are not present in the schema, the 'metadata' pseudocolumn can be used. The update below will create two new metadata fields with keys 'key1' and 'key2' and set their respective values. If any of the keys specified already exists, its value will be updated.

UPDATE ProductVariations SET metadata = 'key1:val1, key2:val2' WHERE ID = 58 AND ProductID = 80

To update Stock information, you must set ManageStock to true. For example:

UPDATE ProductVariations SET StockQuantity = 6, ManageStock = true WHERE ID = 58 AND ProductID = 80

Insert

The following attribute is required when performing an insert: ProductId.

INSERT INTO ProductVariations (ProductId) VALUES (167)

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
DateCreated	Datetime	True	The date the variation was created, in the site's timezone.
DateModified	Datetime	True	The date the variation was last modified, in the site's timezone.
Description	String	False	Variation description.
Permalink	String	True	Variation URL.
Sku	String	False	Unique identifier.
Price	String	True	Current variation price.
RegularPrice	String	False	Variation regular price.
SalePrice	String	False	Variation sale price.
DateOnSaleFrom	Datetime	False	Start date of sale price, in the site's timezone.
DateOnSaleTo	Datetime	False	End date of sale price, in the site's timezone.
OnSale	Boolean	True	Shows if the variation is on sale.
Status	String	False	Variation status. Options: draft, pending, private and publish. Defaults to publish.
Purchasable	Boolean	True	Shows if the variation can be bought.
Virtual	Boolean	False	If the variation is virtual. Defaults to false.
Downloadable	Boolean	False	If the variation is downloadable. Defaults to false.
DownloadsAggregate	String	False	List of downloadable files. See Product variation - Downloads properties
DownloadLimit	Integer	False	Number of times downloadable files can be downloaded after purchase. Defaults to -1.
DownloadExpiry	Integer	False	Number of days until access to downloadable files expires. Defaults to -1.
TaxStatus	String	False	Tax status. Options: taxable, shipping and none. Defaults to taxable.
TaxClass	String	False	Tax class.
ManageStock	String	False	Stock management at variation level. Defaults to false. If the stock is managed by product and not variaation then the value is parent.
StockQuantity	Integer	False	Stock quantity.
StockStatus	String	False	Controls the stock status of the product. Options: instock, outofstock, onbackorder. Defaults to instock.
Backorders	String	False	If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Defaults to no.
BackordersAllowed	Boolean	True	Shows if backorders are allowed.
Backordered	Boolean	True	Shows if the variation is on backordered.
Weight	String	False	Variation weight.
ShippingClass	String	False	Shipping class slug.
ShippingClassId	String	True	Shipping class ID.
AttributesAggregate	String	False	List of attributes. See Product variation - Attributes properties
MenuOrder	Integer	False	Menu order, used to custom sort products.
MetaData	String	False	Meta data. See Product variation - Meta data properties
DimensionsLength	String	False	Variation length.
DimensionsWidth	String	False	Variation width.
DimensionsHeight	String	False	Variation height.
ImageId	Long	False	Image ID.
ImageDateCreated	Datetime	True	The date the image was created, in the site's timezone.
ImageDateModified	Datetime	True	The date the image was last modified, in the site's timezone.
ImageSrc	String	False	Image URL.
ImageName	String	False	Image name.
ImageAlt	String	False	Image alternative text.
ProductId	Long	True	Id of the product.
ParentId	Long	False	The id of the parent, filtered server side.

View and manage settings options.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, SettingId. All other columns are processed client side. If the 'SettingId' filter is not specified, the Sync App will fetch a list of all the settings and perform a request for each setting in the list.

SELECT * FROM SettingOptions WHERE Id = 'woocommerce_excluded_report_order_statuses'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	A unique identifier for the setting.
Label	String	True	A human readable label for the setting used in interfaces.
Description	String	True	A human readable description for the setting used in interfaces.
Value	String	False	Setting value.
Default	String	True	Default value for the setting.
Tip	String	True	Additional help text shown to the user about the setting.
Placeholder	String	True	Placeholder text to be displayed in text inputs.
Type	String	True	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
GroupId	String	True	An identifier for the group this setting belongs to.
SettingId	String	True	Id of the setting group.

Retrieve and modify shipping zone methods.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: InstanceId, ZoneId. All other columns are processed client side. If the 'ZoneId' filter is not specified, the Sync App will fetch a list of all the zones and perform a request for each zone in the list.

SELECT * FROM ShippingZoneMethods WHERE InstanceId = 4 AND ZoneId = 11

Insert

The following attributes are required when performing an insert: MethodId, ZoneId.

INSERT INTO ShippingZoneMethods (MethodId, ZoneId) VALUES ('flat_rate', 1)

Columns

Name	Type	ReadOnly	Description
InstanceId [KEY]	Long	False	Shipping method instance ID.
Enabled	Boolean	False	Shipping method enabled status.
MethodDescription	String	False	hipping method description.
MethodId	String	False	Shipping method ID.
MethodTitle	String	False	Shipping method title.
Order	Integer	False	Shipping method sort order.
Title	String	False	Shipping method customer facing title.
SettingsTitleId	String	True	A unique identifier for the setting.
SettingsTitleLabel	String	True	A human readable label for the setting used in interfaces.
SettingsTitleDescription	String	True	A human readable description for the setting used in interfaces.
SettingsTitleType	String	True	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsTitleValue	String	False	Setting value.
SettingsTitleDefault	String	True	Default value for the setting.
SettingsTitleTip	String	True	Additional help text shown to the user about the setting.
SettingsTitlePlaceholder	String	True	Placeholder text to be displayed in text inputs.
SettingsTaxStatusId	String	True	A unique identifier for the setting.
SettingsTaxStatusLabel	String	True	A human readable label for the setting used in interfaces.
SettingsTaxStatusDescription	String	True	A human readable description for the setting used in interfaces.
SettingsTaxStatusType	String	True	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsTaxStatusValue	String	False	Setting value.
SettingsTaxStatusDefault	String	True	Default value for the setting.
SettingsTaxStatusTip	String	True	Additional help text shown to the user about the setting.
SettingsTaxStatusPlaceholder	String	True	Placeholder text to be displayed in text inputs.
SettingsCostId	String	True	A unique identifier for the setting.
SettingsCostLabel	String	True	A human readable label for the setting used in interfaces.
SettingsCostDescription	String	True	A human readable description for the setting used in interfaces.
SettingsCostType	String	True	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsCostValue	String	False	Setting value.
SettingsCostDefault	String	True	Default value for the setting.
SettingsCostTip	String	True	Additional help text shown to the user about the setting.
SettingsCostPlaceholder	String	True	Placeholder text to be displayed in text inputs.
SettingsTypeId	String	True	A unique identifier for the setting.
SettingsTypeLabel	String	True	A human readable label for the setting used in interfaces.
SettingsTypeDescription	String	True	A human readable description for the setting used in interfaces.
SettingsTypeType	String	True	Type of setting. Options: text, email, number, color, password, textarea, select, multiselect, radio, image_width and checkbox.
SettingsTypeValue	String	False	Setting value.
SettingsTypeDefault	String	True	Default value for the setting.
SettingsTypeTip	String	True	Additional help text shown to the user about the setting.
SettingsTypePlaceholder	String	True	Placeholder text to be displayed in text inputs.
ZoneId	Long	True	Id of the shipping zone.

Retrieve and modify shipping zones.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: Id. All other columns are processed client side.

SELECT * FROM ShippingZones WHERE Id = 13

Insert

The following attribute is required when performing an insert: Name.

INSERT INTO ShippingZones (Name) VALUES ('zone_name')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
Name	String	False	Shipping zone name.
Order	Integer	False	Shipping zone order.

Retrieve and modify tax classes.

Table Specific Information

Select

The Sync App will process all filters client side.

Insert

The following attribute is required when performing an insert: Name.

INSERT INTO TaxClasses (Name) VALUES ('tax_class_name')

Columns

Name	Type	ReadOnly	Description
Slug [KEY]	String	True	Unique identifier for the resource.
Name	String	False	Tax class name. required

Retrieve and modify tax rates.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Class. All other columns are processed client side.

SELECT * FROM TaxRates WHERE Id = 4

Insert

This table does not have any required attributes when performing an insert.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
Country	String	False	Country ISO 3166 code. See ISO 3166 Codes (Countries) for more details
State	String	False	State code.
Postcode	String	False	Postcode/ZIP.
City	String	False	City name.
Rate	String	False	Tax rate.
Name	String	False	Tax rate name.
Priority	Integer	False	Tax priority. Only 1 matching rate per priority will be used. To define multiple tax rates for a single area you need to specify a different priority per rate. Defaults to 1.
Compound	Boolean	False	Whether or not this is a compound rate. Compound tax rates are applied on top of other tax rates. Defaults to false.
Shipping	Boolean	False	Whether or not this tax rate also gets applied to shipping. Defaults to true.
Order	Integer	False	Indicates the order that will appear in queries.
Class	String	False	Tax class. Defaults to standard.
Postcodes	String	False	Postcodes/ZIP.
Cities	String	False	City names.

Retrieve and modify webhooks.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Status. All other columns are processed client side.

SELECT * FROM Webhooks WHERE Id = 4

Insert

The following attributes are required when performing an insert: Topic, DeliveryUrl.

INSERT INTO Webhooks (Topic, DeliveryUrl) VALUES ('order.updated', 'http://url.com')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Long	True	Unique identifier for the resource.
Name	String	False	A friendly name for the webhook.
Status	String	False	Webhook status. Options: active, paused and disabled. Defaults to active.
Topic	String	False	Webhook topic.
Resource	String	True	Webhook resource.
Event	String	True	Webhook event.
HooksAggregate	String	True	WooCommerce action names associated with the webhook.
DeliveryUrl	String	True	The URL where the webhook payload is delivered.
Secret	String	False	Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will Defaults to a MD5 hash from the current user's ID
DateCreated	Datetime	True	The date the webhook was created, in the site's timezone.
DateModified	Datetime	True	The date the webhook was last modified, in the site's timezone.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

WooCommerce Connector for CData Sync ビュー

Name	Description
Continents	Retrieve continents.
Countries	Retrieve countries.
Currencies	Retrieve available currencies.
OrderCouponLines	Retrieve the coupon lines for an order.
OrderFeeLines	Retrieve the fee lines for an order.
OrderRefundLineItems	Retrieve the line items for a refund.
OrderShippingLines	Retrieve the shipping lines for an order.
OrderTaxLines	Retrieve the tax lines for an order.
ProductAttributes	Retrieve product attributes.
ProductCategories	Retrieve product categories.
ProductImages	Retrieve images for a product.
SalesReport	Executes a Sales report.
SettingGroups	Retrieve settings groups.
ShippingLocations	Retrieve shipping zone locations.
ShippingMethods	Retrieve shipping methods.
States	Retrieve shipping states.
SystemStatus	Retrieve system status items.
SystemStatusPages	Retrieve and system status items.
SystemStatusTools	Retrieve system status tools.
TopSellersReports	Execute a top sellers report.
TotalsReport	Execute a totals report.

Retrieve continents.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
Code	String	2 character continent code.
Name	String	Full name of continent.
CountriesAggregate	String	List of countries on this continent. See Continents - Countries properties read-only

Retrieve countries.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
Code	String	ISO3166 alpha-2 country code.
Name	String	Full name of country.
StatesAggregate	String	List of states in this country. See Countries - States properties read-only

Retrieve available currencies.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
Code	String	ISO4217 currency code.
Name	String	Full name of currency.
Symbol	String	Currency symbol.

Retrieve the coupon lines for an order.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: OrderId. All other columns are processed client side.

SELECT * FROM OrderCouponLines WHERE OrderId = 144

Columns

Name	Type	Description
Id [KEY]	Long	Item ID.
Code	String	Coupon code.
Discount	String	Discount total.
DiscountTax	String	Discount total tax.
MetaData	String	Meta data. See Order - Meta data properties
OrderId	String	Id of the order.

Retrieve the fee lines for an order.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: OrderId. All other columns are processed client side. If the 'OrderId' filter is not specified, the Sync App will fetch a list of all the orders and perform a request for each order in the list.

SELECT * FROM OrderFeeLines WHERE OrderId = 21

Columns

Name	Type	Description
Id [KEY]	Long	Item ID.
Name	String	Fee name.
TaxClass	String	Tax class of fee.
TaxStatus	String	Tax status of fee. Options: taxable and none.
Total	String	Line total (after discounts).
TotalTax	String	Line total tax (after discounts).
Taxes	String	Line taxes. See Order - Taxes properties read-only
MetaData	String	Meta data. See Order - Meta data properties
OrderId	String	Id of the order.

Retrieve the line items for a refund.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: OrderId, RefundId. All other columns are processed client side. If the 'OrderId' filter is not specified, the Sync App will fetch a list of all the orders and perform a request for each order in the list. The above behaviour will happen apply also for refunds, if 'RefundId' is not specified.

SELECT * FROM OrderRefundLineItems WHERE OrderId = 16

Columns

Name	Type	Description
Id	Long	Item ID.
Name	String	Product name.
ProductId	Long	Product ID.
VariationId	Long	Variation ID, if applicable.
Quantity	Integer	Quantity ordered.
TaxClass	Integer	Tax class of product.
Subtotal	String	Line subtotal (before discounts).
SubtotalTax	String	Line subtotal tax (before discounts).
Total	String	Line total (after discounts).
TotalTax	String	Line total tax (after discounts).
TaxesAggregate	String	Line taxes. See Order refund line item - Taxes properties read-only
MetaDataAggregate	String	Meta data. See Order refund - Meta data properties
Sku	String	Product SKU.
Price	String	Product price.
OrderId	String	Id of the order.
RefundId	String	Id of the refund.

Retrieve the shipping lines for an order.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: OrderId. All other columns are processed client side. If the 'OrderId' filter is not specified, the Sync App will fetch a list of all the orders and perform a request for each order in the list.

SELECT * FROM OrderShippingLines WHERE OrderId = 21

Columns

Name	Type	Description
Id [KEY]	Long	Item ID.
MethodTitle	String	Shipping method name.
MethodId	String	Shipping method ID.
Total	String	Line total (after discounts).
TotalTax	String	Line total tax (after discounts).
Taxes	String	Line taxes. See Order - Taxes properties read-only
MetaData	String	Meta data. See Order - Meta data properties
OrderId	Long	Id of the order.

Retrieve the tax lines for an order.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: OrderId. All other columns are processed client side. If the 'OrderId' filter is not specified, the Sync App will fetch a list of all the orders and perform a request for each order in the list.

SELECT * FROM OrderTaxLines WHERE OrderId = 12

Columns

Name	Type	Description
Id [KEY]	Long	Item ID.
RateCode	String	Tax rate code.
RateId	String	Tax rate ID.
Label	String	Tax rate label.
Compound	Boolean	Show if is a compound tax rate.
TaxTotal	String	Tax total (not including shipping taxes).
ShippingTaxTotal	String	Shipping tax total.
MetaData	String	Meta data. See Order - Meta data properties
OrderId	Long	Id of the order.

Retrieve product attributes.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: ProductId. All other columns are processed client side. If the 'ProductId' filter is not specified, the Sync App will fetch a list of all the products and perform a request for each product in the list.

SELECT * FROM ProductAttributes WHERE ProductId = 4

Columns

Name	Type	Description
Id [KEY]	Long	Attribute ID.
Name	String	Attribute name.
Slug	String	An alphanumeric identifier for the resource unique to its type.
Type	String	Type of attribute. By default only select is supported.
OrderBy	String	Default sort order. Options: menu_order, name, name_num and id. Defaults to menu_order.
HasArchives	Boolean	Enable/Disable attribute archives. Defaults to false.
ProductId	Long	Id of the product.

Retrieve product categories.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, Slug, ProductId. All other columns are processed client side. If the 'ProductId' filter is not specified, the Sync App will fetch a list of all the products and perform a request for each product in the list.

SELECT * FROM ProductCategories WHERE Id = 4
SELECT * FROM ProductCategories WHERE Slug = 'criteria'

Columns

Name	Type	Description
Id [KEY]	Long	Unique identifier for the resource.
Name	String	Category name.
Slug	String	An alphanumeric identifier for the resource unique to its type.
ProductId	Long	Id of the product.

Retrieve images for a product.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Id, DateCreated, DateModified, Src, Name, Alt, ProductId. All other columns are processed client side. If the 'ProductId' filter is not specified, the Sync App will fetch a list of all the products and perform a request for each product in the list.

SELECT * FROM ProductImages WHERE Id = 4
SELECT * FROM ProductImages WHERE ProductId = 6

Columns

Name	Type	Description
Id [KEY]	Long	Image ID.
DateCreated	Datetime	The date the image was created, in the site's timezone.
DateModified	Datetime	The date the image was last modified, in the site's timezone.
Src	String	Image URL.
Name	String	Image name.
Alt	String	Image alternative text.
ProductId	Long	Id of the product.

Executes a Sales report.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Period, StartDate, EndDate. All other columns are processed client side.

SELECT * FROM SalesReport WHERE Period = 'week' AND StartDate = '01/01/2019'

Columns

Name	Type	Description
TotalSales	String	Gross sales in the period.
NetSales	String	Net sales in the period.
AverageSales	String	Average net daily sales.
TotalOrders	Integer	Total of orders placed.
TotalItems	Integer	Total of items purchased.
TotalTax	String	Total charged for taxes.
TotalShipping	String	Total charged for shipping.
TotalRefunds	Integer	Total of refunded orders.
TotalDiscount	Integer	Total of coupons used.
TotalsGroupedBy	String	Group type.
TotalsAggregate	String	Totals.
Period	String	Report period. Defaults to week. Options: week, month, last_month and year.
StartDate	Date	Return sales for a specific start date, the date need to be in the YYYY-MM-DD format.
EndDate	Date	Return sales for a specific end date, the date need to be in the YYYY-MM-DD format.

Retrieve settings groups.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
Id [KEY]	String	A unique identifier that can be used to link settings together.
Label	String	A human readable label for the setting used in interfaces.
Description	String	A human readable description for the setting used in interfaces.
ParentId	String	ID of parent grouping.

Retrieve shipping zone locations.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: ZoneId. All other columns are processed client side. If the 'ZoneId' filter is not specified, the Sync App will fetch a list of all the zones and perform a request for each zone in the list.

SELECT * FROM ShippingLocations WHERE ZoneId = 13

Columns

Name	Type	Description
Code	String	Shipping zone location code.
Type	String	Shipping zone location type. Options: postcode, state, country and continent. Defaults to country.
ZoneId	Long	Id of the shipping zone.

Retrieve shipping methods.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: Id. All other columns are processed client side.

SELECT * FROM ShippingMethods WHERE Id = 'flat_rate'

Columns

Name	Type	Description
Id [KEY]	String	Method ID.
Title	String	Shipping method title.
Description	String	Shipping method description.

Retrieve shipping states.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: Country. All other columns are processed client side. If the 'Country' filter is not specified, the Sync App will fetch a list of all the countries and perform a request for each country in the list.

SELECT * FROM States WHERE Country = 'Germany'

Columns

Name	Type	Description
Country	String	State code.
Code	String	State code.
Name	String	Full name of the state.

Retrieve system status items.

Table Specific Information

Select

This table represents a singleton entity.

Columns

Name	Type	Description
ActivePluginsAggregate	String	Active plugins.
PagesAggregate	String	WooCommerce pages.
EnvironmentHomeUrl	String	Home URL.
EnvironmentSiteUrl	String	Site URL.
EnvironmentWcVersion	String	WooCommerce version.
EnvironmentLogDirectory	String	Log directory.
EnvironmentLogDirectoryWritable	Boolean	Is log directory writable? read-only
EnvironmentWpVersion	String	WordPress version.
EnvironmentWpMultisite	Boolean	Is WordPress multisite? read-only
EnvironmentWpMemoryLimit	Integer	WordPress memory limit.
EnvironmentWpDebugMode	Boolean	Is WordPress debug mode active? read-only
EnvironmentWpCron	Boolean	Are WordPress cron jobs enabled? read-only
EnvironmentLanguage	String	WordPress language.
EnvironmentServerInfo	String	Server info.
EnvironmentPhpVersion	String	PHP version.
EnvironmentPhpPostMaxSize	Integer	PHP post max size.
EnvironmentPhpMaxExecutionTime	Integer	PHP max execution time.
EnvironmentPhpMaxInputVars	Integer	PHP max input vars.
EnvironmentCurlVersion	String	cURL version.
EnvironmentSuhosinInstalled	Boolean	Is SUHOSIN installed? read-only
EnvironmentMaxUploadSize	Integer	Max upload size.
EnvironmentMysqlVersion	String	MySQL version.
EnvironmentDefaultTimezone	String	Default timezone.
EnvironmentFsockopenOrCurlEnabled	Boolean	Is fsockopen/cURL enabled? read-only
EnvironmentSoapclientEnabled	Boolean	Is SoapClient class enabled? read-only
EnvironmentDomdocumentEnabled	Boolean	Is DomDocument class enabled? read-only
EnvironmentGzipEnabled	Boolean	Is GZip enabled? read-only
EnvironmentMbstringEnabled	Boolean	Is mbstring enabled? read-only
EnvironmentRemotePostSuccessful	Boolean	Remote POST successful? read-only
EnvironmentRemotePostResponse	String	Remote POST response.
EnvironmentRemoteGetSuccessful	Boolean	Remote GET successful? read-only
EnvironmentRemoteGetResponse	String	Remote GET response.
DatabaseWcDatabaseVersion	String	WC database version.
DatabasePrefix	String	Database prefix.
DatabaseMaxmindGeoipDatabase	String	MaxMind GeoIP database.
DatabaseTablesAggregate	String	Database tables.
ThemeName	String	Theme name.
ThemeVersion	String	Theme version.
ThemeVersionLatest	String	Latest version of theme.
ThemeAuthorUrl	String	Theme author URL.
ThemeIsChildTheme	Boolean	Is this theme a child theme? read-only
ThemeHasWoocommerceSupport	Boolean	Does the theme declare WooCommerce support? read-only
ThemeHasWoocommerceFile	Boolean	Does the theme have a woocommerce.php file? read-only
ThemeHasOutdatedTemplates	Boolean	Does this theme have outdated templates? read-only
ThemeOverridesAggregate	String	Template overrides.
ThemeParentName	String	Parent theme name.
ThemeParentVersion	String	Parent theme version.
ThemeParentAuthorUrl	String	Parent theme author URL.
SettingsApiEnabled	Boolean	REST API enabled? read-only
SettingsForceSsl	Boolean	SSL forced? read-only
SettingsCurrency	String	Currency.
SettingsCurrencySymbol	String	Currency symbol.
SettingsCurrencyPosition	String	Currency position.
SettingsThousandSeparator	String	Thousand separator.
SettingsDecimalSeparator	String	Decimal separator.
SettingsNumberOfDecimals	Integer	Number of decimals.
SettingsGeolocationEnabled	Boolean	Geolocation enabled? read-only
SettingsTaxonomiesAggregate	String	Taxonomy terms for product/order statuses.
SecuritySecureConnection	Boolean	Is the connection to your store secure? read-only
SecurityHideErrors	Boolean	Hide errors from visitors? read-only

Retrieve and system status items.

Table Specific Information

Select

The Sync App will process all filters client side.

Columns

Name	Type	Description
PageName	String	Name of the page.
PageId	String	Id of the page.
PageSet	String	Whether the page is set.
PageExists	String	Whether the page exists.
PageVisible	String	Whether the page is visible.
Shortcode	String	Page short code.
ShortcodeRequired	String	Whether shortcode is required.
ShortcodePresent	String	Whether shortcode is present.

Retrieve system status tools.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available column for this table is: Id. All other columns are processed client side.

SELECT * FROM SystemStatusTools WHERE Id = 'install_pages'

Columns

Name	Type	Description
Id [KEY]	String	A unique identifier for the tool.
Name	String	Tool name.
Action	String	What running the tool will do.
Description	String	Tool description.
Success	Boolean	Did the tool run successfully?
Message	String	Tool return message.
Confirm	Boolean	Confirm execution of the tool. Defaults to false. write-only

Execute a top sellers report.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: Title, ProductId, Quantity, StartDate, EnDDate. All other columns are processed client side.

SELECT * FROM TopSellersReports WHERE Title = 'criteria'
SELECT * FROM TopSellersReports WHERE ProductId = 4

Columns

Name	Type	Description
Title	String	Product title.
ProductId	Long	Product ID.
Quantity	Integer	Total number of purchases.
StartDate	Date	Return the report for a specific start date.
EndDate	Date	Return the report for a specific end date.

Execute a totals report.

Table Specific Information

Select

WooCommerce allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns support only the = comparison, unless stated otherwise. The available columns for this table are: ReportType, StartDate, EndDate. All other columns are processed client side.

SELECT * FROM TotalsReport WHERE ReportType = 'reviews' AND StartDate = '01/01/2019'

Columns

Name	Type	Description
Slug	String	An alphanumeric identifier for the resource.
Name	String	Review type name.
Total	String	Amount of reviews.
ReportType	String	Type of the report. Must be one of: reviews, products, orders, customers, coupons.
StartDate	Date	Return the report for a specific start date.
EndDate	Date	Return the report for a specific end date.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
AuthScheme	Whether to use Basic Authentication, the one-legged OAuth 1.0 Authentication or the OAuth 2.0 Authentication when connecting to WooCommerce.
URL	The URL of the WooCommerce instance.

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
ConsumerKey	The consumer key assigned by WooCommerce when creating the authentication credentials. If this property is set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.
ConsumerSecret	The consumer secret assigned by WooCommerce when creating the authentication credentials. If this and the ConsumerKey properties are set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	WooCommerce から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	Whether to use Basic Authentication, the one-legged OAuth 1.0 Authentication or the OAuth 2.0 Authentication when connecting to WooCommerce.
URL	The URL of the WooCommerce instance.

Whether to use Basic Authentication, the one-legged OAuth 1.0 Authentication or the OAuth 2.0 Authentication when connecting to WooCommerce.

解説

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• Basic: Set this to use Basic user / password authentication. Note that Basic authentication is only supported over HTTPS. If using Basic authentication, the credentials will be sent as query parameters with every request.
• OAuthOneLegged: Set this to use the one-legged OAuth 1.0 Authentication.
• OAuth: Set this to perform OAuth 2.0 authentication.

The URL of the WooCommerce instance.

解説

The URL of the WooCommerce instance.

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
ConsumerKey	The consumer key assigned by WooCommerce when creating the authentication credentials. If this property is set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.
ConsumerSecret	The consumer secret assigned by WooCommerce when creating the authentication credentials. If this and the ConsumerKey properties are set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

The consumer key assigned by WooCommerce when creating the authentication credentials. If this property is set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.

解説

As part of creating a new set of credentials, you will receive the ConsumerKey and ConsumerSecret values.

The consumer secret assigned by WooCommerce when creating the authentication credentials. If this and the ConsumerKey properties are set, and InitiateOAuth is OFF, the provider will authenticate using one-legged OAuth1.0.

解説

As part of creating a new set of credentials, you will receive the ConsumerKey and ConsumerSecret values.

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はWooCommerce への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\WooCommerce Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

Platform	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	WooCommerce から返されるページあたりの結果の最大数。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

WooCommerce から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、WooCommerce から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。

解説

テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。

大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

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

指定されたパスは引用符で囲まれていないことに注意してください。