CData Sync App は、Adobe Commerce データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
AdobeCommerce コネクタはCData Sync アプリケーションから使用可能で、AdobeCommerce からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はAdobeCommerce REST API をリレーショナルテーブルとしてモデル化します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
接続するには、URL を例えばhttp://yoursitename/magento2 に設定します。オプションで、接続先のストアのStoreCode を指定します(2つ以上存在する場合)。
To generate the AccessToken, Log in to the AdobeCommerce Stores > Settings > Configuration > Services > OAuth > Access Token.
このセクションでは、AdobeCommerce Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、AdobeCommerce にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、AdobeCommerce 2.x API を介して、アカウントをリレーショナルデータベースとしてモデル化します。この章で説明するデータモデルは、AdobeCommerce 環境がどのように見えるかの例を示します。実際のデータモデルは、AdobeCommerce アカウントに基づいて動的に取得されます。
Sync App はAdobeCommerce のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
AdobeStockAssetApiAsset | AdobeStockAssetApiAsset is an auto generated table |
BundleProductOption | BundleProductOption is an auto generated table. The supported operations are Delete, and Querying data from this table. |
CatalogAttributeSet | CatalogAttributeSet is an auto generated table. The supported operations are Update, Delete, and Querying data from this table. |
CatalogProductAttribute | CatalogProductAttribute is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
CmsBlock | CmsBlock is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
CmsPage | CmsPage is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
ConfigurableProductOption | ConfigurableProductOption is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
CustomerAddress | CustomerAddress is an auto generated table. The supported operations are Delete, and Querying data from this table. |
CustomerGroup | CustomerGroup is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
Customers | Customers is an auto generated table. The supported operations are Update, Delete, and Querying data from this table. |
DownloadableLink | DownloadableLink is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
DownloadableSample | DownloadableSample is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
EavAttributeSet | EavAttributeSet is an auto generated table. The supported operations are Update, Delete, and Querying data from this table. |
GiftMessageCart | GiftMessageCart is an auto generated table. The supported operations are Insert, and Querying data from this table. |
GiftMessageGuestCart | GiftMessageGuestCart is an auto generated table. The supported operations are Insert, and Querying data from this table. |
GiftMessageGuestItem | GiftMessageGuestItem is an auto generated table. The supported operations are Insert, and Querying data from this table. |
GiftMessageItem | GiftMessageItem is an auto generated table. The supported operations are Insert, and Querying data from this table. |
GuestBillingAddresses | GuestBillingAddresses is an auto generated table. The supported operations are Insert, and Querying data from this table. |
Inventory | Inventory is an auto generated table. The supported operations are Update, and Querying data from this table. |
InventoryApiSource | InventoryApiSource is an auto generated table |
InventoryApiStock | InventoryApiStock is an auto generated table |
OrderComments | OrderComments is an auto generated table. The supported operations are Insert, and Querying data from this table. |
Orders | Orders is an auto generated table. The supported operations are Insert, Update, and Querying data from this table. |
ProductAttributeGroup | ProductAttributeGroup is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
ProductAttributeOptions | ProductAttributeOptions is an auto generated table. The supported operations are Insert, Delete, and Querying data from this table. |
ProductCategories | ProductCategories is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
ProductCustomOption | ProductCustomOption is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
ProductMedia | ProductMedia is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
Products | Products is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
QuoteCart | QuoteCart is an auto generated table. The supported operations are Update, and Querying data from this table. |
QuoteCartItem | QuoteCartItem is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
QuoteGuestCartItem | QuoteGuestCartItem is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
SalesCreditmemo | SalesCreditmemo is an auto generated table. The supported operations are Insert, and Querying data from this table. |
SalesCreditmemoComments | SalesCreditmemoComments is an auto generated table. The supported operations are Insert, and Querying data from this table. |
SalesInvoice | SalesInvoice is an auto generated table. The supported operations are Insert, and Querying data from this table. |
SalesInvoiceComments | SalesInvoiceComments is an auto generated table. The supported operations are Insert, and Querying data from this table. |
SalesRule | SalesRule is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
SalesRuleCoupon | SalesRuleCoupon is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
SalesShipment | SalesShipment is an auto generated table. The supported operations are Insert, and Querying data from this table. |
SalesShipmentComments | SalesShipmentComments is an auto generated table. The supported operations are Insert, and Querying data from this table. |
TaxClass | TaxClass is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
TaxRate | TaxRate is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
TaxRule | TaxRule is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table. |
AdobeStockAssetApiAsset is an auto generated table
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
ID |
Category | String | False |
This is an auto-generated column |
CategoryId | Int | False |
Category |
CreationDate | String | False |
Creation date |
Creator | String | False |
This is an auto-generated column |
CreatorId | Int | False |
The creator |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsLicensed | Int | False |
Licensed |
MediaGalleryId | Int | False |
Media gallery asset id |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
BundleProductOption is an auto generated table. The supported operations are Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Sku or OptionId while the rest of the filter is executed client side within the Sync App.
The Sku column or the Sku and OptionId columns must be specified in the WHERE clause to retrieve results from BundleProductOption. Sku and OptionId can be used only with the equals (=) operator.
For example:
SELECT * FROM [BundleProductOption] WHERE Sku = '123'
SELECT * FROM [BundleProductOption] WHERE Sku = '123' AND OptionId = '1'
Bundle options can be deleted by providing the Sku and OptionId columns.
DELETE FROM BundleProductOption WHERE Sku = 'sjl-1999' AND OptionId = '1'
Name | Type | ReadOnly | Description |
ExtensionAttributes | String | False |
This is an auto-generated column |
OptionId [KEY] | Int | False |
Option id |
Position | Int | False |
Option position |
ProductLinks | String | False |
Product links |
Required | Bool | False |
Is required option |
Sku [KEY] | String | False |
Product sku |
Title | String | False |
Option title |
Type | String | False |
Input type |
CatalogAttributeSet is an auto generated table. The supported operations are Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
AttributeSetId [KEY] | Int | False |
Attribute set ID |
AttributeSetName | String | False |
Attribute set name |
EntityTypeId | Int | False |
Attribute set entity type id |
ExtensionAttributes | String | False |
This is an auto-generated column |
SearchCriteria | String | False |
This is an auto-generated column |
SortOrder | Int | False |
Attribute set sort order index |
TotalCount | Int | False |
Total count. |
CatalogProductAttribute is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
ApplyTo | String | False |
Apply to value for the element |
AttributeCode [KEY] | String | False |
Code of the attribute. |
AttributeId | Int | False |
Id of the attribute. |
BackendModel | String | False |
Backend model |
BackendType | String | False |
Backend type. |
DefaultFrontendLabel | String | False |
Frontend label for default store |
DefaultValue | String | False |
Default value for the element. |
EntityTypeId | String | False |
Entity type id |
ExtensionAttributes | String | False |
This is an auto-generated column |
FrontendClass | String | False |
Frontend class of attribute |
FrontendInput | String | False |
HTML for input element. |
FrontendLabels | String | False |
Frontend label for each store |
IsComparable | String | False |
The attribute can be compared on the frontend |
IsFilterable | Bool | False |
It used in layered navigation |
IsFilterableInGrid | Bool | False |
It is filterable in catalog product grid |
IsFilterableInSearch | Bool | False |
It is used in search results layered navigation |
IsHtmlAllowedOnFront | Bool | False |
The HTML tags are allowed on the frontend |
IsRequired | Bool | False |
Attribute is required. |
IsSearchable | String | False |
The attribute can be used in Quick Search |
IsUnique | String | False |
This is a unique attribute |
IsUsedForPromoRules | String | False |
The attribute can be used for promo rules |
IsUsedInGrid | Bool | False |
It is used in catalog product grid |
IsUserDefined | Bool | False |
Current attribute has been defined by a user. |
IsVisible | Bool | False |
Attribute is visible on frontend. |
IsVisibleInAdvancedSearch | String | False |
The attribute can be used in Advanced Search |
IsVisibleInGrid | Bool | False |
It is visible in catalog product grid |
IsVisibleOnFront | String | False |
The attribute is visible on the frontend |
IsWysiwygEnabled | Bool | False |
WYSIWYG flag |
Note | String | False |
The note attribute for the element. |
Options | String | False |
Options of the attribute (key => value pairs for select) |
Position | Int | False |
Position |
Scope | String | False |
Attribute scope |
SourceModel | String | False |
Source model |
UsedForSortBy | Bool | False |
It is used for sorting in product listing |
UsedInProductListing | String | False |
The attribute can be used in product listing |
ValidationRules | String | False |
Validation rules. |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
CmsBlock is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
ID |
BlockId | String | False |
blockId |
Active | Bool | False |
Active |
Content | String | False |
Content |
CreationTime | String | False |
Creation time |
Identifier | String | False |
Identifier |
Title | String | False |
Title |
UpdateTime | String | False |
Update time |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
CmsPage is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
ID |
PageId | String | False |
pageId |
Active | Bool | False |
Active |
Content | String | False |
Content |
ContentHeading | String | False |
Content heading |
CreationTime | String | False |
Creation time |
CustomLayoutUpdateXml | String | False |
Custom layout update xml |
CustomRootTemplate | String | False |
Custom root template |
CustomTheme | String | False |
Custom theme |
CustomThemeFrom | String | False |
Custom theme from |
CustomThemeTo | String | False |
Custom theme to |
Identifier | String | False |
Identifier |
LayoutUpdateXml | String | False |
Layout update xml |
MetaDescription | String | False |
Meta description |
MetaKeywords | String | False |
Meta keywords |
MetaTitle | String | False |
Meta title |
PageLayout | String | False |
Page layout |
SortOrder | String | False |
Sort order |
Title | String | False |
Title |
UpdateTime | String | False |
Update time |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
ConfigurableProductOption is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Sku or Id while the rest of the filter is executed client side within the Sync App.
The Sku column or the Sku and Id columns must be specified in the WHERE clause to retrieve results from ConfigurableProductOption. Sku and Id can be used only with the equals (=) operator.
For example:
SELECT * FROM [ConfigurableProductOption] WHERE Sku = '123' AND Id = '12'
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
This is an auto-generated column |
Sku | String | False |
sku |
AttributeId | String | False |
This is an auto-generated column |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsUseDefault | Bool | False |
This is an auto-generated column |
Label | String | False |
This is an auto-generated column |
Position | Int | False |
This is an auto-generated column |
ProductId | Int | False |
This is an auto-generated column |
Values | String | False |
This is an auto-generated column |
CustomerAddress is an auto generated table. The supported operations are Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by AddressId while the rest of the filter is executed client side within the Sync App.
The AddressId column must be specified in the WHERE clause to retrieve results from CustomerAddress. AddressId can be used only with the equals (=) operator.
For example:
SELECT * FROM [CustomerAddress] WHERE AddressId = '123'
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
ID |
AddressId | String | False |
addressId |
City | String | False |
City name |
Company | String | False |
Company |
CountryId | String | False |
Country code in ISO_3166-2 format |
CustomerId | Int | False |
Customer ID |
DefaultBilling | Bool | False |
If this address is default billing address |
DefaultShipping | Bool | False |
If this address is default shipping address. |
ExtensionAttributes | String | False |
This is an auto-generated column |
Fax | String | False |
Fax number |
Firstname | String | False |
First name |
Lastname | String | False |
Last name |
Middlename | String | False |
Middle name |
Postcode | String | False |
Postcode |
Prefix | String | False |
Prefix |
Region | String | False |
This is an auto-generated column |
RegionId | Int | False |
Region ID |
Street | String | False |
Street |
Suffix | String | False |
Suffix |
Telephone | String | False |
Telephone number |
VatId | String | False |
Vat id |
CustomerGroup is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Id |
Code | String | False |
Code |
ExtensionAttributes | String | False |
This is an auto-generated column |
TaxClassId | Int | False |
Tax class id |
TaxClassName | String | False |
Tax class name |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
Customers is an auto generated table. The supported operations are Update, Delete, and Querying data from this table.
The Customers table supports server-side processing for all columns in the WHERE clause. Most of these columns support server-side processing for the >, >=, <, <=, =, IN, NOT IN and LIKE operators.
The following examples show the types of queries processed server side.
SELECT * FROM Customers
SELECT * FROM Customers WHERE Id = '1'
SELECT * FROM Customers WHERE GroupId = 1
SELECT * FROM Customers WHERE CreatedAt > '2017-08-01'
SELECT * FROM Customers WHERE DefaultBilling IN (1, 2) AND Firstname LIKE '%i%' AND WebsiteId = 1 LIMIT 50
To add a Customer, the FirstName, LastName, and Email fields are required.
INSERT INTO Customers (FirstName, LastName, Email, WebsiteId, GroupId) VALUES ('John', 'Doe', 'john@example.com', 1, 1)
AdobeCommerce allows updates for the FirstName, LastName, MiddleName, Suffix, Email, GroupId, Prefix, DisableAutoGroupChange, and Taxvat columns. WebsiteId is a required value.
UPDATE Customers SET FirstName = 'Jane', Email = 'jane@example.com', GroupId = 2, DisableAutoGroupChange = '0', Prefix = 'x', Middlename = 'J', LastName = 'Doe', Suffix = 'y', Taxvat = 1, WebsiteId = 1 WHERE Id = 4
Customers can be deleted by providing the Id of the Customer and issuing a DELETE statement.
DELETE FROM Customers WHERE Id = 4
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Customer id |
Addresses | String | False |
Customer addresses. |
Confirmation | String | False |
Confirmation |
CreatedAt | Datetime | False |
Created at time |
CreatedIn | String | False |
Created in area |
DefaultBilling | String | False |
Default billing address id |
DefaultShipping | String | False |
Default shipping address id |
DisableAutoGroupChange | Int | False |
Disable auto group change flag. |
Dob | String | False |
Date of birth |
String | False |
Email address | |
ExtensionAttributes | String | False |
This is an auto-generated column |
Firstname | String | False |
First name |
Gender | Int | False |
Gender |
GroupId | Int | False |
Group id |
Lastname | String | False |
Last name |
Middlename | String | False |
Middle name |
Prefix | String | False |
Prefix |
StoreId | Int | False |
Store id |
Suffix | String | False |
Suffix |
Taxvat | String | False |
Tax Vat |
UpdatedAt | Datetime | False |
Updated at time |
WebsiteId | Int | False |
Website id |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
DownloadableLink is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Sku while the rest of the filter is executed client side within the Sync App.
The Sku column must be specified in the WHERE clause to retrieve results from DownloadableLink. Sku can be used only with the equals (=) operator.
For example:
SELECT * FROM [DownloadableLink] WHERE Sku = '123'
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Sample(or link) id |
Sku | String | False |
sku |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsShareable | Int | False |
Shareable status |
LinkFile | String | False |
relative file path |
LinkFileContent | String | False |
This is an auto-generated column |
LinkType | String | False |
This is an auto-generated column |
LinkUrl | String | False |
Link url or null when type is 'file' |
NumberOfDownloads | Int | False |
Of downloads per user |
Price | Double | False |
Price |
SampleFile | String | False |
relative file path |
SampleFileContent | String | False |
This is an auto-generated column |
SampleType | String | False |
This is an auto-generated column |
SampleUrl | String | False |
file URL |
SortOrder | Int | False |
This is an auto-generated column |
Title | String | False |
This is an auto-generated column |
DownloadableSample is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Sku while the rest of the filter is executed client side within the Sync App.
The Sku column must be specified in the WHERE clause to retrieve results from DownloadableSample. Sku can be used only with the equals (=) operator.
For example:
SELECT * FROM [DownloadableSample] WHERE Sku = '123'
To create a new downloadable sample, the Sku, SampleType, SortOrder and Title columns are required.
INSERT INTO DownloadableSample (Sku, SampleType, SortOrder, Title) VALUES ('WJ02', 'crosssell', 12, 'simple')
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Sample(or link) id |
Sku | String | False |
sku |
ExtensionAttributes | String | False |
This is an auto-generated column |
SampleFile | String | False |
relative file path |
SampleFileContent | String | False |
This is an auto-generated column |
SampleType | String | False |
This is an auto-generated column |
SampleUrl | String | False |
file URL |
SortOrder | Int | False |
Order index for sample |
Title | String | False |
Title |
EavAttributeSet is an auto generated table. The supported operations are Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
AttributeSetId [KEY] | Int | False |
Attribute set ID |
AttributeSetName | String | False |
Attribute set name |
EntityTypeId | Int | False |
Attribute set entity type id |
ExtensionAttributes | String | False |
This is an auto-generated column |
SearchCriteria | String | False |
This is an auto-generated column |
SortOrder | Int | False |
Attribute set sort order index |
TotalCount | Int | False |
Total count. |
GiftMessageCart is an auto generated table. The supported operations are Insert, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from GiftMessageCart. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [GiftMessageCart] WHERE CartId = '123'
To create a new gift message, the CartId, Message, Recipient and Sender columns are required.
INSERT INTO GiftMessageCart (Message, Recipient, Sender, CartId) VALUES ('sample', 'recipient name', 'sender name', '12')
Name | Type | ReadOnly | Description |
CustomerId | Int | False |
Customer ID. Otherwise, null. |
CartId | String | False |
cartId |
ExtensionAttributes | String | False |
This is an auto-generated column |
GiftMessageId [KEY] | Int | False |
Gift message ID. Otherwise, null. |
Message | String | False |
Message text. |
Recipient | String | False |
Recipient name. |
Sender | String | False |
Sender name. |
GiftMessageGuestCart is an auto generated table. The supported operations are Insert, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from GiftMessageGuestCart. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [GiftMessageGuestCart] WHERE CartId = '123'
To add a gift message, the CartId, Message, Recipient and Sender columns are required.
INSERT INTO GiftMessageGuestCart (Message, Recipient, Sender, CartId) VALUES ('sample', 'recipient name', 'sender name', '12')
Name | Type | ReadOnly | Description |
CustomerId | Int | False |
Customer ID. Otherwise, null. |
CartId | String | False |
cartId |
ExtensionAttributes | String | False |
This is an auto-generated column |
GiftMessageId [KEY] | Int | False |
Gift message ID. Otherwise, null. |
Message | String | False |
Message text. |
Recipient | String | False |
Recipient name. |
Sender | String | False |
Sender name. |
GiftMessageGuestItem is an auto generated table. The supported operations are Insert, and Querying data from this table.
The CartId and ItemId columns must be specified in the WHERE clause to retrieve results from GiftMessageGuestItem. CartId and ItemId can be used only with the equals (=) operator.
The Sync App will use the AdobeCommerce API to filter the results by CartId and ItemId while the rest of the filter is executed client side within the Sync App.
For example:
SELECT * FROM [GiftMessageGuestItem] WHERE ItemId = '123' AND CartId = '234'
To create a new gift message for an item, the CartId, ItemId, Message, Recipient and Sender columns are required.
INSERT INTO GiftMessageGuestItem (Message, Recipient, Sender, CartId, ItemId) VALUES ('sample', 'recipient name', 'sender name', '12', '13')
Name | Type | ReadOnly | Description |
CustomerId | Int | False |
Customer ID. Otherwise, null. |
CartId | String | False |
cartId |
ExtensionAttributes | String | False |
This is an auto-generated column |
GiftMessageId [KEY] | Int | False |
Gift message ID. Otherwise, null. |
Message | String | False |
Message text. |
Recipient | String | False |
Recipient name. |
Sender | String | False |
Sender name. |
GiftMessageItem is an auto generated table. The supported operations are Insert, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId and ItemId while the rest of the filter is executed client side within the Sync App.
The CartId and ItemId column must be specified in the WHERE clause to retrieve results from GiftMessageItem. CartId and ItemId can be used only with the equals (=) operator.
For example:
SELECT * FROM [GiftMessageItem] WHERE CartId = '123' AND ItemId = '234'
To create a new gift message for an item, the CartId, ItemId, Message, Recipient and Sender columns are required.
INSERT INTO GiftMessageItem (Message, Recipient, Sender, CartId, ItemId) VALUES ('sample', 'recipient name', 'sender name', '12', '13')
Name | Type | ReadOnly | Description |
CustomerId | Int | False |
Customer ID. Otherwise, null. |
CartId | String | False |
cartId |
ExtensionAttributes | String | False |
This is an auto-generated column |
GiftMessageId [KEY] | Int | False |
Gift message ID. Otherwise, null. |
Message | String | False |
Message text. |
Recipient | String | False |
Recipient name. |
Sender | String | False |
Sender name. |
GuestBillingAddresses is an auto generated table. The supported operations are Insert, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from GuestBillingAddresses. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [GuestBillingAddresses] WHERE CartId = '123'
To create a new GuestBillingAddresses, CartId, and FirstName are required.
INSERT INTO GuestBillingAddresses(CartId,FirstName) VALUES('a9f82365c3552','asdw')
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Id |
CartId | String | False |
cartId |
City | String | False |
City name |
Company | String | False |
Company |
CountryId | String | False |
Country id |
CustomerAddressId | Int | False |
Customer address id |
CustomerId | Int | False |
Customer id |
String | False |
Billing/shipping email | |
ExtensionAttributes | String | False |
This is an auto-generated column |
Fax | String | False |
Fax number |
Firstname | String | False |
First name |
Lastname | String | False |
Last name |
Middlename | String | False |
Middle name |
Postcode | String | False |
Postcode |
Prefix | String | False |
Prefix |
Region | String | False |
Region name |
RegionCode | String | False |
Region code |
RegionId | Int | False |
Region id |
SameAsBilling | Int | False |
Same as billing flag |
SaveInAddressBook | Int | False |
Save in address book flag |
Street | String | False |
Street |
Suffix | String | False |
Suffix |
Telephone | String | False |
Telephone number |
VatId | String | False |
Vat id |
Inventory is an auto generated table. The supported operations are Update, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by ProductSku while the rest of the filter is executed client side within the Sync App.
The ProductSKU column must be specified in the WHERE clause to retrieve results from Inventory.
For example:
SELECT * FROM Inventory WHERE ProductSKU = 'sjl-8082'
To update a product inventory, the ItemId of an existing item must be set along with the ProductSKU.
UPDATE [Inventory] SET Qty = '87' WHERE ProductSKU = 'sjl-8082' AND ItemId = '1'
Name | Type | ReadOnly | Description |
Items | String | False |
Items |
ProductSku [KEY] | String | False |
This is an auto generated column. |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
Backorders | Int | False |
Backorders status |
EnableQtyIncrements | Bool | False |
Whether Quantity Increments is enabled |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsDecimalDivided | Bool | False |
This is an auto-generated column |
IsInStock | Bool | False |
Stock Availability |
IsQtyDecimal | Bool | False |
This is an auto-generated column |
ItemId [KEY] | Int | False |
This is an auto-generated column |
LowStockDate | String | False |
This is an auto-generated column |
ManageStock | Bool | False |
Can Manage Stock |
MaxSaleQty | Double | False |
Maximum Qty Allowed in Shopping Cart data wrapper |
MinQty | Double | False |
Minimal quantity available for item status in stock |
MinSaleQty | Double | False |
Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation |
NotifyStockQty | Double | False |
Notify for Quantity Below data wrapper |
ProductId | Int | False |
This is an auto-generated column |
Qty | Double | False |
This is an auto-generated column |
QtyIncrements | Double | False |
Quantity Increments data wrapper |
ShowDefaultNotificationMessage | Bool | False |
This is an auto-generated column |
StockId | Int | False |
Stock identifier |
StockStatusChangedAuto | Int | False |
This is an auto-generated column |
UseConfigBackorders | Bool | False |
This is an auto-generated column |
UseConfigEnableQtyInc | Bool | False |
This is an auto-generated column |
UseConfigManageStock | Bool | False |
This is an auto-generated column |
UseConfigMaxSaleQty | Bool | False |
This is an auto-generated column |
UseConfigMinQty | Bool | False |
This is an auto-generated column |
UseConfigMinSaleQty | Int | False |
This is an auto-generated column |
UseConfigNotifyStockQty | Bool | False |
This is an auto-generated column |
UseConfigQtyIncrements | Bool | False |
This is an auto-generated column |
StockItem | String | False |
This is an auto-generated column |
StockStatus | Int | False |
This is an auto-generated column |
InventoryApiSource is an auto generated table
Name | Type | ReadOnly | Description |
CarrierLinks | String | False |
This is an auto-generated column |
City | String | False |
Source city |
ContactName | String | False |
Source contact name |
CountryId | String | False |
Source country id |
Description | String | False |
Source description |
String | False |
Source email | |
Enabled | Bool | False |
If source is enabled. For new entity can be null |
ExtensionAttributes | String | False |
This is an auto-generated column |
Fax | String | False |
Source fax |
Latitude | Double | False |
Source latitude |
Longitude | Double | False |
Source longitude |
Name | String | False |
Source name |
Phone | String | False |
Source phone number |
Postcode | String | False |
Source post code |
Region | String | False |
Region title if source has custom region |
RegionId | Int | False |
Region id if source has registered region. |
SearchCriteria | String | False |
This is an auto-generated column |
SourceCode | String | False |
Source code |
Street | String | False |
Source street name |
TotalCount | Int | False |
Total count. |
UseDefaultCarrierConfig | Bool | False |
Is need to use default config |
InventoryApiStock is an auto generated table
Name | Type | ReadOnly | Description |
ExtensionAttributes | String | False |
This is an auto-generated column |
Name | String | False |
Stock name |
SearchCriteria | String | False |
This is an auto-generated column |
StockId | Int | False |
Stock id |
TotalCount | Int | False |
Total count. |
OrderComments is an auto generated table. The supported operations are Insert, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Id while the rest of the filter is executed client side within the Sync App.
The Id column must be specified in the WHERE clause to retrieve results from OrderComments. Id can be used only with the equals (=) operator.
For example:
SELECT * FROM [OrderComments] WHERE Id = '123'
To create a new OrderComment, Id, Comment and ParentId are required.
INSERT INTO OrderComments(Comment,Id,ParentId) VALUES('ABdCdwawD',2,2)
Name | Type | ReadOnly | Description |
Comment | String | False |
Comment. |
Id | String | False |
id |
CreatedAt | Datetime | False |
Created-at timestamp. |
EntityId [KEY] | Int | False |
Order status history ID. |
EntityName | String | False |
Entity name. |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsCustomerNotified | Int | False |
Is-customer-notified flag value. |
IsVisibleOnFront | Int | False |
Is-visible-on-storefront flag value. |
ParentId | Int | False |
Parent ID. |
SearchCriteria | String | False |
This is an auto-generated column |
Status | String | False |
Status. |
TotalCount | Int | False |
Total count. |
Orders is an auto generated table. The supported operations are Insert, Update, and Querying data from this table.
The Orders table supports server-side processing for all columns in the WHERE clause. Most of these columns support server-side processing for the >, >=, <, <=, =, IN, NOT IN and LIKE operators.
The following examples show the types of queries processed server side.
SELECT * FROM Orders
SELECT * FROM Orders WHERE EntityId = '1'
SELECT * FROM Orders WHERE GroupId = 1
SELECT * FROM Orders WHERE CreatedAt > '2017-08-01'
SELECT * FROM Orders WHERE EntityId IN (1, 2) AND CustomerFirstname LIKE '%i%' AND OrderCurrencyCode = 'USD' LIMIT 50
You can insert items into an order using an INSERT statement. The 'Items' column can be specified using either the temporary table called 'OrderItems#TEMP' or as a simple string aggregate. 'Payment' aggregate column is required for INSERT and UPDATE operations on this table.
INSERT INTO OrderItems#TEMP (BasePrice, Sku) VALUES (299.99, '8915A40K4') INSERT INTO OrderItems#TEMP (BasePrice, Sku) VALUES (100, '7115AP0Z8') INSERT INTO Orders (GrandTotal, Items, Payment) VALUES (399.99, OrderItems#TEMP, '{...your payment aggregate here...}')
INSERT INTO Orders (GrandTotal, Items, Payment) VALUES (399.99, '{...Items aggregate here...}', '{...Payment aggregate here...}')
Name | Type | ReadOnly | Description |
AdjustmentNegative | Double | False |
Negative adjustment value. |
Id | String | False |
id |
AdjustmentPositive | Double | False |
Positive adjustment value. |
AppliedRuleIds | String | False |
Applied rule IDs. |
BaseAdjustmentNegative | Double | False |
Base negative adjustment value. |
BaseAdjustmentPositive | Double | False |
Base positive adjustment value. |
BaseCurrencyCode | String | False |
Base currency code. |
BaseDiscountAmount | Double | False |
Base discount amount. |
BaseDiscountCanceled | Double | False |
Base discount canceled. |
BaseDiscountInvoiced | Double | False |
Base discount invoiced. |
BaseDiscountRefunded | Double | False |
Base discount refunded. |
BaseDiscountTaxCompensationAmount | Double | False |
Base discount tax compensation amount. |
BaseDiscountTaxCompensationInvoiced | Double | False |
Base discount tax compensation invoiced. |
BaseDiscountTaxCompensationRefunded | Double | False |
Base discount tax compensation refunded. |
BaseGrandTotal | Double | False |
Base grand total. |
BaseShippingAmount | Double | False |
Base shipping amount. |
BaseShippingCanceled | Double | False |
Base shipping canceled. |
BaseShippingDiscountAmount | Double | False |
Base shipping discount amount. |
BaseShippingDiscountTaxCompensationAmnt | Double | False |
Base shipping discount tax compensation amount. |
BaseShippingInclTax | Double | False |
Base shipping including tax. |
BaseShippingInvoiced | Double | False |
Base shipping invoiced. |
BaseShippingRefunded | Double | False |
Base shipping refunded. |
BaseShippingTaxAmount | Double | False |
Base shipping tax amount. |
BaseShippingTaxRefunded | Double | False |
Base shipping tax refunded. |
BaseSubtotal | Double | False |
Base subtotal. |
BaseSubtotalCanceled | Double | False |
Base subtotal canceled. |
BaseSubtotalInclTax | Double | False |
Base subtotal including tax. |
BaseSubtotalInvoiced | Double | False |
Base subtotal invoiced. |
BaseSubtotalRefunded | Double | False |
Base subtotal refunded. |
BaseTaxAmount | Double | False |
Base tax amount. |
BaseTaxCanceled | Double | False |
Base tax canceled. |
BaseTaxInvoiced | Double | False |
Base tax invoiced. |
BaseTaxRefunded | Double | False |
Base tax refunded. |
BaseToGlobalRate | Double | False |
Base-to-global rate. |
BaseToOrderRate | Double | False |
Base-to-order rate. |
BaseTotalCanceled | Double | False |
Base total canceled. |
BaseTotalDue | Double | False |
Base total due. |
BaseTotalInvoiced | Double | False |
Base total invoiced. |
BaseTotalInvoicedCost | Double | False |
Base total invoiced cost. |
BaseTotalOfflineRefunded | Double | False |
Base total offline refunded. |
BaseTotalOnlineRefunded | Double | False |
Base total online refunded. |
BaseTotalPaid | Double | False |
Base total paid. |
BaseTotalQtyOrdered | Double | False |
Base total quantity ordered. |
BaseTotalRefunded | Double | False |
Base total refunded. |
BillingAddress | String | False |
This is an auto-generated column |
BillingAddressId | Int | False |
Billing address ID. |
CanShipPartially | Int | False |
Can-ship-partially flag value. |
CanShipPartiallyItem | Int | False |
Can-ship-partially-item flag value. |
CouponCode | String | False |
Coupon code. |
CreatedAt | Datetime | False |
Created-at timestamp. |
CustomerDob | String | False |
Customer date-of-birth (DOB). |
CustomerEmail | String | False |
Customer email address. |
CustomerFirstname | String | False |
Customer first name. |
CustomerGender | Int | False |
Customer gender. |
CustomerGroupId | Int | False |
Customer group ID. |
CustomerId | Int | False |
Customer ID. |
CustomerIsGuest | Int | False |
Customer-is-guest flag value. |
CustomerLastname | String | False |
Customer last name. |
CustomerMiddlename | String | False |
Customer middle name. |
CustomerNote | String | False |
Customer note. |
CustomerNoteNotify | Int | False |
Customer-note-notify flag value. |
CustomerPrefix | String | False |
Customer prefix. |
CustomerSuffix | String | False |
Customer suffix. |
CustomerTaxvat | String | False |
Customer value-added tax (VAT). |
DiscountAmount | Double | False |
Discount amount. |
DiscountCanceled | Double | False |
Discount canceled. |
DiscountDescription | String | False |
Discount description. |
DiscountInvoiced | Double | False |
Discount invoiced. |
DiscountRefunded | Double | False |
Discount refunded amount. |
DiscountTaxCompensationAmount | Double | False |
Discount tax compensation amount. |
DiscountTaxCompensationInvoiced | Double | False |
Discount tax compensation invoiced amount. |
DiscountTaxCompensationRefunded | Double | False |
Discount tax compensation refunded amount. |
EditIncrement | Int | False |
Edit increment value. |
EmailSent | Int | False |
Email-sent flag value. |
EntityId [KEY] | Int | False |
Order ID. |
ExtCustomerId | String | False |
External customer ID. |
ExtensionAttributes | String | False |
This is an auto-generated column |
ExtOrderId | String | False |
External order ID. |
ForcedShipmentWithInvoice | Int | False |
Forced-shipment-with-invoice flag value. |
GlobalCurrencyCode | String | False |
Global currency code. |
GrandTotal | Double | False |
Grand total. |
HoldBeforeState | String | False |
Hold before state. |
HoldBeforeStatus | String | False |
Hold before status. |
IncrementId | String | False |
Increment ID. |
IsVirtual | Int | False |
Is-virtual flag value. |
Items | String | False |
Array of items. |
OrderCurrencyCode | String | False |
Order currency code. |
OriginalIncrementId | String | False |
Original increment ID. |
Payment | String | False |
This is an auto-generated column |
PaymentAuthExpiration | Int | False |
Payment authorization expiration date. |
PaymentAuthorizationAmount | Double | False |
Payment authorization amount. |
ProtectCode | String | False |
Protect code. |
QuoteAddressId | Int | False |
Quote address ID. |
QuoteId | Int | False |
Quote ID. |
RelationChildId | String | False |
Relation child ID. |
RelationChildRealId | String | False |
Relation child real ID. |
RelationParentId | String | False |
Relation parent ID. |
RelationParentRealId | String | False |
Relation parent real ID. |
RemoteIp | String | False |
Remote IP address. |
SearchCriteria | String | False |
This is an auto-generated column |
ShippingAmount | Double | False |
Shipping amount. |
ShippingCanceled | Double | False |
Shipping canceled amount. |
ShippingDescription | String | False |
Shipping description. |
ShippingDiscountAmount | Double | False |
Shipping discount amount. |
ShippingDiscountTaxCompensationAmount | Double | False |
Shipping discount tax compensation amount. |
ShippingInclTax | Double | False |
Shipping including tax amount. |
ShippingInvoiced | Double | False |
Shipping invoiced amount. |
ShippingRefunded | Double | False |
Shipping refunded amount. |
ShippingTaxAmount | Double | False |
Shipping tax amount. |
ShippingTaxRefunded | Double | False |
Shipping tax refunded amount. |
State | String | False |
State. |
Status | String | False |
Status. |
StatusHistories | String | False |
Array of status histories. |
StoreCurrencyCode | String | False |
Store currency code. |
StoreId | Int | False |
Store ID. |
StoreName | String | False |
Store name. |
StoreToBaseRate | Double | False |
Store-to-base rate. |
StoreToOrderRate | Double | False |
Store-to-order rate. |
Subtotal | Double | False |
Subtotal. |
SubtotalCanceled | Double | False |
Subtotal canceled amount. |
SubtotalInclTax | Double | False |
Subtotal including tax amount. |
SubtotalInvoiced | Double | False |
Subtotal invoiced amount. |
SubtotalRefunded | Double | False |
Subtotal refunded amount. |
TaxAmount | Double | False |
Tax amount. |
TaxCanceled | Double | False |
Tax canceled amount. |
TaxInvoiced | Double | False |
Tax invoiced amount. |
TaxRefunded | Double | False |
Tax refunded amount. |
TotalCanceled | Double | False |
Total canceled. |
TotalCount | Int | False |
Total count. |
TotalDue | Double | False |
Total due. |
TotalInvoiced | Double | False |
Total invoiced amount. |
TotalItemCount | Int | False |
Total item count. |
TotalOfflineRefunded | Double | False |
Total offline refunded amount. |
TotalOnlineRefunded | Double | False |
Total online refunded amount. |
TotalPaid | Double | False |
Total paid. |
TotalQtyOrdered | Double | False |
Total quantity ordered. |
TotalRefunded | Double | False |
Total amount refunded. |
UpdatedAt | Datetime | False |
Updated-at timestamp. |
Weight | Double | False |
Weight. |
XForwardedFor | String | False |
X-Forwarded-For field value. |
ProductAttributeGroup is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by AttributeSetId while the rest of the filter is executed client side within the Sync App.
The AttributeSetId column must be specified in the WHERE clause to retrieve results from ProductAttributeGroup. AttributeSetId can be used only with the equals (=) operator.
For example:
SELECT * FROM [ProductAttributeGroup] WHERE AttributeSetId = '123'
Name | Type | ReadOnly | Description |
AttributeGroupId [KEY] | String | False |
Id |
AttributeGroupName | String | False |
Name |
AttributeSetId | Int | False |
Attribute set id |
ExtensionAttributes | String | False |
This is an auto-generated column |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
ProductAttributeOptions is an auto generated table. The supported operations are Insert, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by AttributeCode while the rest of the filter is executed client side within the Sync App.
The AttributeCode column must be specified in the WHERE clause to retrieve results from ProductAttributeOptions. AttributeCode can be used only with the equals (=) operator.
For example:
SELECT * FROM [ProductAttributeOptions] WHERE AttributeCode = '123'
To create a new ProductAttributeOption, AttributeCode, and Label are required.
INSERT INTO ProductAttributeOptions(AttributeCode, Label) VALUES(83,'asdw')
Name | Type | ReadOnly | Description |
IsDefault | Bool | False |
Default |
AttributeCode | String | False |
attributeCode |
Label [KEY] | String | False |
Option label |
SortOrder | Int | False |
Option order |
StoreLabels | String | False |
Option label for store scopes |
Value | String | False |
Option value |
ProductCategories is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Id while the rest of the filter is executed client side within the Sync App.
The Id column can be used to filter data within this table. The Id can be used only with the equals (=) operator.
The following examples show the types of queries processed server side.
SELECT * FROM ProductCategories
SELECT * FROM ProductCategories WHERE Id = 1
The Name and IsActive columns are required to create a new category.
INSERT INTO ProductCategories (Name, IsActive, Position) VALUES ('New category', '1', '0')
To update a category, you must set the Id column.
UPDATE ProductCategories SET Name = 'New category', IsActive = 1 WHERE Id = 1
Product categories can be deleted by providing the Id column.
DELETE FROM ProductCategories WHERE Id = 1
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
This is an auto-generated column |
CategoryId | String | False |
categoryId |
AvailableSortBy | String | False |
This is an auto-generated column |
Children | String | False |
This is an auto-generated column |
CreatedAt | Datetime | False |
This is an auto-generated column |
ExtensionAttributes | String | False |
This is an auto-generated column |
IncludeInMenu | Bool | False |
This is an auto-generated column |
IsActive | Bool | False |
Whether category is active |
Level | Int | False |
Category level |
Name | String | False |
Category name |
ParentId | Int | False |
Parent category ID |
Path | String | False |
This is an auto-generated column |
Position | Int | False |
Category position |
UpdatedAt | Datetime | False |
This is an auto-generated column |
ProductCount | Int | False |
Product count |
ProductCustomOption is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Sku or OptionId while the rest of the filter is executed client side within the Sync App.
The Sku column or Sku and OptionId columns must be specified in the WHERE clause to retrieve results from ProductCustomOption. Sku and OptionId can be used only with the equals (=) operator.
For example:
SELECT * FROM [ProductCustomOption] WHERE Sku = '334' AND OptionId = '123'
To create a new product custom option, the IsRequire, ProductSku, SortOrder, Title and Type columns are required.
INSERT INTO ProductCustomOption (IsRequire, ProductSku, SortOrder, Title, Type) VALUES (false, '01', 1, 'Title', 'Type')
Product custom options can be deleted by providing the Sku and OptionId columns.
DELETE FROM ProductCustomOption WHERE Sku = 'sjl-1999' AND OptionId = '1'
Name | Type | ReadOnly | Description |
ExtensionAttributes | String | False |
This is an auto-generated column |
FileExtension | String | False |
This is an auto-generated column |
ImageSizeX | Int | False |
This is an auto-generated column |
ImageSizeY | Int | False |
This is an auto-generated column |
IsRequire | Bool | False |
Is require |
MaxCharacters | Int | False |
This is an auto-generated column |
OptionId [KEY] | Int | False |
Option id |
Price | Double | False |
Price |
PriceType | String | False |
Price type |
ProductSku | String | False |
Product SKU |
Sku | String | False |
Sku |
SortOrder | Int | False |
Sort order |
Title | String | False |
Option title |
Type | String | False |
Option type |
Values | String | False |
This is an auto-generated column |
ProductMedia is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Sku while the rest of the filter is executed client side within the Sync App.
The Sku column must be specified in the WHERE clause to retrieve results from ProductMedia. Sku can be used only with the equals (=) operator.
For example:
SELECT * FROM [ProductMedia] WHERE Sku = 'sjl-8082'
To update a ProductMedia record, you must set Sku and EntryId (refers to the Id column).
UPDATE ProductMedia SET Label = 'lbl new' WHERE EntryId = '1' AND Sku = 'sjl-8082'
Product media can be deleted by providing Sku and EntryId (refers to the Id column).
DELETE FROM ProductMedia WHERE EntryId = 1 AND Sky = 'sjl-8082'
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Gallery entry ID |
Sku | String | False |
sku |
Content | String | False |
This is an auto-generated column |
Disabled | Bool | False |
If gallery entry is hidden from product page |
ExtensionAttributes | String | False |
This is an auto-generated column |
File | String | False |
File path |
Label | String | False |
Gallery entry alternative text |
MediaType | String | False |
Media type |
Position | Int | False |
Gallery entry position (sort order) |
Types | String | False |
Gallery entry image types (thumbnail, image, small_image etc) |
Products is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results with these operators while the rest of the filter is executed client side within the provider. Client-side execution can be turned off by setting SupportEnhancedSQL to false in which case any search criteria that invokes other operators will cause an error.
Custom Attributes will be dynamically retrieved as columns when querying this table. The Products table supports server-side processing for all columns in the WHERE clause. Most of these columns support server-side processing for the >, >=, <, <=, =, IN, NOT IN and LIKE operators.
The following examples show the types of queries processed server side.
SELECT * FROM Products
SELECT * FROM Products WHERE Sku = 'sjl-8082'
SELECT * FROM Products WHERE Status = 1
SELECT * FROM Products WHERE CreatedAt > '2017-08-01'
SELECT * FROM Products WHERE Id IN (250, 260) AND Name LIKE '%d%' AND Visibility = 4 LIMIT 50
To create a new product, Name, AttributeSetId, and Sku are required.
INSERT INTO Products (Sku, AttributeSetId, Name) VALUES ('sjl-1999', '4', 'insert prod')
To update a product, you must set the Sku and Price columns.
UPDATE Products SET Price = '88', CustomAttribute1 = 'ValidValue' WHERE Sku = 'sjl-1999'
Products can be deleted by providing the Sku column.
DELETE FROM Products WHERE Sku = 'sjl-1999'
Name | Type | ReadOnly | Description |
Id | Int | False |
Id |
AttributeSetId | Int | False |
Attribute set id |
CreatedAt | Datetime | False |
Created date |
ExtensionAttributes | String | False |
This is an auto-generated column |
MediaGalleryEntries | String | False |
Media gallery entries |
Name | String | False |
Name |
Options | String | False |
List of product options |
Price | Double | False |
Price |
ProductLinks | String | False |
Product links info |
Sku [KEY] | String | False |
Sku |
Status | Int | False |
Status |
TierPrices | String | False |
List of product tier prices |
TypeId | String | False |
Type id |
UpdatedAt | Datetime | False |
Updated date |
Visibility | Int | False |
Visibility |
Weight | Double | False |
Weight |
description | String | False |
Custom Attribute field |
short_description | String | False |
Custom Attribute field |
special_price | Decimal | False |
Custom Attribute field |
special_from_date | Datetime | False |
Custom Attribute field |
special_to_date | Datetime | False |
Custom Attribute field |
cost | Decimal | False |
Custom Attribute field |
manufacturer | Int | False |
Custom Attribute field |
meta_title | String | False |
Custom Attribute field |
meta_keyword | String | False |
Custom Attribute field |
meta_description | String | False |
Custom Attribute field |
image | String | False |
Custom Attribute field |
small_image | String | False |
Custom Attribute field |
thumbnail | String | False |
Custom Attribute field |
media_gallery | String | False |
Custom Attribute field |
old_id | Int | False |
Custom Attribute field |
tier_price | Decimal | False |
Custom Attribute field |
color | Int | False |
Custom Attribute field |
news_from_date | Datetime | False |
Custom Attribute field |
news_to_date | Datetime | False |
Custom Attribute field |
gallery | String | False |
Custom Attribute field |
minimal_price | Decimal | False |
Custom Attribute field |
custom_design | String | False |
Custom Attribute field |
custom_design_from | Datetime | False |
Custom Attribute field |
custom_design_to | Datetime | False |
Custom Attribute field |
custom_layout_update | String | False |
Custom Attribute field |
page_layout | String | False |
Custom Attribute field |
category_ids | String | False |
Custom Attribute field |
options_container | String | False |
Custom Attribute field |
required_options | String | False |
Custom Attribute field |
has_options | String | False |
Custom Attribute field |
image_label | String | False |
Custom Attribute field |
small_image_label | String | False |
Custom Attribute field |
thumbnail_label | String | False |
Custom Attribute field |
created_at | String | False |
Custom Attribute field |
updated_at | String | False |
Custom Attribute field |
country_of_manufacture | String | False |
Custom Attribute field |
quantity_and_stock_status | Int | False |
Custom Attribute field |
custom_layout | String | False |
Custom Attribute field |
url_key | String | False |
Custom Attribute field |
url_path | String | False |
Custom Attribute field |
msrp | Decimal | False |
Custom Attribute field |
msrp_display_actual_price_type | String | False |
Custom Attribute field |
price_type | Int | False |
Custom Attribute field |
sku_type | Int | False |
Custom Attribute field |
weight_type | Int | False |
Custom Attribute field |
price_view | Int | False |
Custom Attribute field |
shipment_type | Int | False |
Custom Attribute field |
links_purchased_separately | Int | False |
Custom Attribute field |
samples_title | String | False |
Custom Attribute field |
links_title | String | False |
Custom Attribute field |
links_exist | Int | False |
Custom Attribute field |
swatch_image | String | False |
Custom Attribute field |
tax_class_id | Int | False |
Custom Attribute field |
gift_message_available | String | False |
Custom Attribute field |
ryanattribute | String | False |
Custom Attribute field |
ryan_attribute | String | False |
Custom Attribute field |
deti_attr | String | False |
Custom Attribute field |
deti_attribut | String | False |
Custom Attribute field |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
QuoteCart is an auto generated table. The supported operations are Update, and Querying data from this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Cart/quote ID. |
CartId | String | False |
cartId |
BillingAddress | String | False |
This is an auto-generated column |
ConvertedAt | String | False |
Cart conversion date and time. Otherwise, null. |
CreatedAt | Datetime | False |
Cart creation date and time. Otherwise, null. |
Currency | String | False |
This is an auto-generated column |
Customer | String | False |
This is an auto-generated column |
CustomerIsGuest | Bool | False |
For guest customers, false for logged in customers |
CustomerNote | String | False |
Notice text |
CustomerNoteNotify | Bool | False |
Customer notification flag |
CustomerTaxClassId | Int | False |
Customer tax class ID. |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsActive | Bool | False |
Active status flag value. Otherwise, null. |
IsVirtual | Bool | False |
Virtual flag value. Otherwise, null. |
Items | String | False |
Array of items. Otherwise, null. |
ItemsCount | Int | False |
Number of different items or products in the cart. Otherwise, null. |
ItemsQty | Double | False |
Total quantity of all cart items. Otherwise, null. |
OrigOrderId | Int | False |
Original order ID. Otherwise, null. |
ReservedOrderId | Int | False |
Reserved order ID. Otherwise, null. |
SearchCriteria | String | False |
This is an auto-generated column |
StoreId | Int | False |
Store identifier |
TotalCount | Int | False |
Total count. |
UpdatedAt | Datetime | False |
Cart last update date and time. Otherwise, null. |
QuoteCartItem is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from QuoteCartItem. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [QuoteCartItem] WHERE CartId = '123'
Name | Type | ReadOnly | Description |
ExtensionAttributes | String | False |
This is an auto-generated column |
CartId | String | False |
cartId |
ItemId | Int | False |
Item ID. Otherwise, null. |
Name | String | False |
Product name. Otherwise, null. |
Price | Double | False |
Product price. Otherwise, null. |
ProductOption | String | False |
This is an auto-generated column |
ProductType | String | False |
Product type. Otherwise, null. |
Qty | Double | False |
Product quantity. |
QuoteId [KEY] | String | False |
Quote id. |
Sku | String | False |
Product SKU. Otherwise, null. |
QuoteGuestCartItem is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from QuoteGuestCartItem. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [QuoteGuestCartItem] WHERE CartId = '123'
Name | Type | ReadOnly | Description |
ExtensionAttributes | String | False |
This is an auto-generated column |
CartId | String | False |
cartId |
ItemId | Int | False |
Item ID. Otherwise, null. |
Name | String | False |
Product name. Otherwise, null. |
Price | Double | False |
Product price. Otherwise, null. |
ProductOption | String | False |
This is an auto-generated column |
ProductType | String | False |
Product type. Otherwise, null. |
Qty | Double | False |
Product quantity. |
QuoteId [KEY] | String | False |
Quote id. |
Sku | String | False |
Product SKU. Otherwise, null. |
SalesCreditmemo is an auto generated table. The supported operations are Insert, and Querying data from this table.
Name | Type | ReadOnly | Description |
Adjustment | Double | False |
Credit memo adjustment. |
Id | String | False |
id |
AdjustmentNegative | Double | False |
Credit memo negative adjustment. |
AdjustmentPositive | Double | False |
Credit memo positive adjustment. |
BaseAdjustment | Double | False |
Credit memo base adjustment. |
BaseAdjustmentNegative | Double | False |
Credit memo negative base adjustment. |
BaseAdjustmentPositive | Double | False |
Credit memo positive base adjustment. |
BaseCurrencyCode | String | False |
Credit memo base currency code. |
BaseDiscountAmount | Double | False |
Credit memo base discount amount. |
BaseDiscountTaxCompensationAmount | Double | False |
Credit memo base discount tax compensation amount. |
BaseGrandTotal | Double | False |
Credit memo base grand total. |
BaseShippingAmount | Double | False |
Credit memo base shipping amount. |
BaseShippingDiscountTaxCompensationAmnt | Double | False |
Credit memo base shipping discount tax compensation amount. |
BaseShippingInclTax | Double | False |
Credit memo base shipping including tax. |
BaseShippingTaxAmount | Double | False |
Credit memo base shipping tax amount. |
BaseSubtotal | Double | False |
Credit memo base subtotal. |
BaseSubtotalInclTax | Double | False |
Credit memo base subtotal including tax. |
BaseTaxAmount | Double | False |
Credit memo base tax amount. |
BaseToGlobalRate | Double | False |
Credit memo base-to-global rate. |
BaseToOrderRate | Double | False |
Credit memo base-to-order rate. |
BillingAddressId | Int | False |
Credit memo billing address ID. |
Comments | String | False |
Array of any credit memo comments. Otherwise, null. |
CreatedAt | Datetime | False |
Credit memo created-at timestamp. |
CreditmemoStatus | Int | False |
Credit memo status. |
DiscountAmount | Double | False |
Credit memo discount amount. |
DiscountDescription | String | False |
Credit memo discount description. |
DiscountTaxCompensationAmount | Double | False |
Credit memo discount tax compensation amount. |
EmailSent | Int | False |
Credit memo email sent flag value. |
EntityId [KEY] | Int | False |
Credit memo ID. |
ExtensionAttributes | String | False |
This is an auto-generated column |
GlobalCurrencyCode | String | False |
Credit memo global currency code. |
GrandTotal | Double | False |
Credit memo grand total. |
IncrementId | String | False |
Credit memo increment ID. |
InvoiceId | Int | False |
Credit memo invoice ID. |
Items | String | False |
Array of credit memo items. |
OrderCurrencyCode | String | False |
Credit memo order currency code. |
OrderId | Int | False |
Credit memo order ID. |
ShippingAddressId | Int | False |
Credit memo shipping address ID. |
ShippingAmount | Double | False |
Credit memo shipping amount. |
ShippingDiscountTaxCompensationAmount | Double | False |
Credit memo shipping discount tax compensation amount. |
ShippingInclTax | Double | False |
Credit memo shipping including tax. |
ShippingTaxAmount | Double | False |
Credit memo shipping tax amount. |
State | Int | False |
Credit memo state. |
StoreCurrencyCode | String | False |
Credit memo store currency code. |
StoreId | Int | False |
Credit memo store ID. |
StoreToBaseRate | Double | False |
Credit memo store-to-base rate. |
StoreToOrderRate | Double | False |
Credit memo store-to-order rate. |
Subtotal | Double | False |
Credit memo subtotal. |
SubtotalInclTax | Double | False |
Credit memo subtotal including tax. |
TaxAmount | Double | False |
Credit memo tax amount. |
TransactionId | String | False |
Credit memo transaction ID. |
UpdatedAt | Datetime | False |
Credit memo updated-at timestamp. |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
SalesCreditmemoComments is an auto generated table. The supported operations are Insert, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Id while the rest of the filter is executed client side within the Sync App.
The Id column must be specified in the WHERE clause to retrieve results from SalesCreditmemoComments. Id can be used only with the equals (=) operator.
For example:
SELECT * FROM [SalesCreditmemoComments] WHERE Id = '123'
To create a new SalesCreditmemoComment, Id, Comment and ParentId are required.
INSERT INTO SalesCreditmemoComments(Comment,Id,ParentId) VALUES('ABdCdwawD',2,2)
Name | Type | ReadOnly | Description |
Comment | String | False |
Comment. |
Id | String | False |
id |
CreatedAt | Datetime | False |
Created-at timestamp. |
EntityId [KEY] | Int | False |
Credit memo ID. |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsCustomerNotified | Int | False |
Is-customer-notified flag value. |
IsVisibleOnFront | Int | False |
Is-visible-on-storefront flag value. |
ParentId | Int | False |
Parent ID. |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
SalesInvoice is an auto generated table. The supported operations are Insert, and Querying data from this table.
Name | Type | ReadOnly | Description |
BaseCurrencyCode | String | False |
Base currency code. |
Id | String | False |
id |
BaseDiscountAmount | Double | False |
Base discount amount. |
BaseDiscountTaxCompensationAmount | Double | False |
Base discount tax compensation amount. |
BaseGrandTotal | Double | False |
Base grand total. |
BaseShippingAmount | Double | False |
Base shipping amount. |
BaseShippingDiscountTaxCompensationAmnt | Double | False |
Base shipping discount tax compensation amount. |
BaseShippingInclTax | Double | False |
Base shipping including tax. |
BaseShippingTaxAmount | Double | False |
Base shipping tax amount. |
BaseSubtotal | Double | False |
Base subtotal. |
BaseSubtotalInclTax | Double | False |
Base subtotal including tax. |
BaseTaxAmount | Double | False |
Base tax amount. |
BaseToGlobalRate | Double | False |
Base-to-global rate. |
BaseToOrderRate | Double | False |
Base-to-order rate. |
BaseTotalRefunded | Double | False |
Base total refunded. |
BillingAddressId | Int | False |
Billing address ID. |
CanVoidFlag | Int | False |
Can void flag value. |
Comments | String | False |
Array of any invoice comments. Otherwise, null. |
CreatedAt | Datetime | False |
Created-at timestamp. |
DiscountAmount | Double | False |
Discount amount. |
DiscountDescription | String | False |
Discount description. |
DiscountTaxCompensationAmount | Double | False |
Discount tax compensation amount. |
EmailSent | Int | False |
Email-sent flag value. |
EntityId [KEY] | Int | False |
Invoice ID. |
ExtensionAttributes | String | False |
This is an auto-generated column |
GlobalCurrencyCode | String | False |
Global currency code. |
GrandTotal | Double | False |
Grand total. |
IncrementId | String | False |
Increment ID. |
IsUsedForRefund | Int | False |
Is-used-for-refund flag value. |
Items | String | False |
Array of invoice items. |
OrderCurrencyCode | String | False |
Order currency code. |
OrderId | Int | False |
Order ID. |
SearchCriteria | String | False |
This is an auto-generated column |
ShippingAddressId | Int | False |
Shipping address ID. |
ShippingAmount | Double | False |
Shipping amount. |
ShippingDiscountTaxCompensationAmount | Double | False |
Shipping discount tax compensation amount. |
ShippingInclTax | Double | False |
Shipping including tax. |
ShippingTaxAmount | Double | False |
Shipping tax amount. |
State | Int | False |
State. |
StoreCurrencyCode | String | False |
Store currency code. |
StoreId | Int | False |
Store ID. |
StoreToBaseRate | Double | False |
Store-to-base rate. |
StoreToOrderRate | Double | False |
Store-to-order rate. |
Subtotal | Double | False |
Subtotal. |
SubtotalInclTax | Double | False |
Subtotal including tax. |
TaxAmount | Double | False |
Tax amount. |
TotalCount | Int | False |
Total count. |
TotalQty | Double | False |
Total quantity. |
TransactionId | String | False |
Transaction ID. |
UpdatedAt | Datetime | False |
Updated-at timestamp. |
SalesInvoiceComments is an auto generated table. The supported operations are Insert, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Id while the rest of the filter is executed client side within the Sync App.
The Id column must be specified in the WHERE clause to retrieve results from SalesInvoiceComments. Id can be used only with the equals (=) operator.
For example:
SELECT * FROM [SalesInvoiceComments] WHERE Id = '123'
To create a new SalesInvoiceComments, Comment and ParentId are required.
INSERT INTO SalesInvoiceComments(Comment,ParentId) VALUES('ABdsCwD',1)
Name | Type | ReadOnly | Description |
Comment | String | False |
Comment. |
Id | String | False |
id |
CreatedAt | Datetime | False |
Created-at timestamp. |
EntityId [KEY] | Int | False |
Invoice ID. |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsCustomerNotified | Int | False |
Is-customer-notified flag value. |
IsVisibleOnFront | Int | False |
Is-visible-on-storefront flag value. |
ParentId | Int | False |
Parent ID. |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
SalesRule is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
ActionCondition | String | False |
This is an auto-generated column |
ApplyToShipping | Bool | False |
The rule applies to shipping |
Condition | String | False |
This is an auto-generated column |
CouponType | String | False |
Coupon type |
CustomerGroupIds | String | False |
Ids of customer groups that the rule applies to |
Description | String | False |
Description |
DiscountAmount | Double | False |
Discount amount |
DiscountQty | Double | False |
Maximum qty discount is applied |
DiscountStep | Int | False |
Discount step |
ExtensionAttributes | String | False |
This is an auto-generated column |
FromDate | String | False |
The start date when the coupon is active |
IsActive | Bool | False |
The coupon is active |
IsAdvanced | Bool | False |
Is this field needed |
IsRss | Bool | False |
Whether the rule is in RSS |
Name | String | False |
Rule name |
ProductIds | String | False |
Product ids |
RuleId [KEY] | Int | False |
Rule id |
SimpleAction | String | False |
Simple action of the rule |
SimpleFreeShipping | String | False |
To grant free shipping |
SortOrder | Int | False |
Sort order |
StopRulesProcessing | Bool | False |
To stop rule processing |
StoreLabels | String | False |
Display label |
TimesUsed | Int | False |
How many times the rule has been used |
ToDate | String | False |
The end date when the coupon is active |
UseAutoGeneration | Bool | False |
To auto generate coupon |
UsesPerCoupon | Int | False |
Limit of uses per coupon |
UsesPerCustomer | Int | False |
Number of uses per customer |
WebsiteIds | String | False |
A list of websites the rule applies to |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
SalesRuleCoupon is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
Code | String | False |
Coupon code |
CouponId [KEY] | Int | False |
Coupon id |
CreatedAt | Datetime | False |
When the coupon is created |
ExpirationDate | String | False |
Expiration date |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsPrimary | Bool | False |
The coupon is primary coupon for the rule that it's associated with |
RuleId | Int | False |
The id of the rule associated with the coupon |
TimesUsed | Int | False |
The number of times the coupon has been used |
Type | Int | False |
Of coupon |
UsageLimit | Int | False |
Usage limit |
UsagePerCustomer | Int | False |
Usage limit per customer |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
SalesShipment is an auto generated table. The supported operations are Insert, and Querying data from this table.
Name | Type | ReadOnly | Description |
BillingAddressId | Int | False |
Billing address ID. |
Id | String | False |
id |
Comments | String | False |
Array of comments. |
CreatedAt | Datetime | False |
Created-at timestamp. |
CustomerId | Int | False |
Customer ID. |
EmailSent | Int | False |
Email-sent flag value. |
EntityId [KEY] | Int | False |
Shipment ID. |
ExtensionAttributes | String | False |
This is an auto-generated column |
IncrementId | String | False |
Increment ID. |
Items | String | False |
Array of items. |
OrderId | Int | False |
Order ID. |
Packages | String | False |
Array of packages, if any. Otherwise, null. |
ShipmentStatus | Int | False |
Shipment status. |
ShippingAddressId | Int | False |
Shipping address ID. |
ShippingLabel | String | False |
Shipping label. |
StoreId | Int | False |
Store ID. |
TotalQty | Double | False |
Total quantity. |
TotalWeight | Double | False |
Total weight. |
Tracks | String | False |
Array of tracks. |
UpdatedAt | Datetime | False |
Updated-at timestamp. |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
SalesShipmentComments is an auto generated table. The supported operations are Insert, and Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Id while the rest of the filter is executed client side within the Sync App.
The Id column must be specified in the WHERE clause to retrieve results from SalesShipmentComments. Id can be used only with the equals (=) operator.
For example:
SELECT * FROM [SalesShipmentComments] WHERE Id = '123'
To create a new SalesShipmentComments, Id, Comment and ParentId are required.
INSERT INTO SalesShipmentComments(Id,Comment,ParentId) VALUES(3,'ABCrwD',3)
Name | Type | ReadOnly | Description |
Comment | String | False |
Comment. |
Id | String | False |
id |
CreatedAt | Datetime | False |
Created-at timestamp. |
EntityId [KEY] | Int | False |
Invoice ID. |
ExtensionAttributes | String | False |
This is an auto-generated column |
IsCustomerNotified | Int | False |
Is-customer-notified flag value. |
IsVisibleOnFront | Int | False |
Is-visible-on-storefront flag value. |
ParentId | Int | False |
Parent ID. |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
TaxClass is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
ClassId [KEY] | Int | False |
Tax class ID. |
TaxClassId | String | False |
taxClassId |
ClassName | String | False |
Tax class name. |
ClassType | String | False |
Tax class type. |
ExtensionAttributes | String | False |
This is an auto-generated column |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
TaxRate is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Id |
Code | String | False |
Tax rate code |
ExtensionAttributes | String | False |
This is an auto-generated column |
Rate | Double | False |
Tax rate in percentage |
RegionName | String | False |
Region name |
TaxCountryId | String | False |
Country id |
TaxPostcode | String | False |
Postcode |
TaxRegionId | Int | False |
Region id |
Titles | String | False |
Tax rate titles |
ZipFrom | Int | False |
Zip range from |
ZipIsRange | Int | False |
Zip is range |
ZipTo | Int | False |
Zip range to |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
TaxRule is an auto generated table. The supported operations are Insert, Update, Delete, and Querying data from this table.
Name | Type | ReadOnly | Description |
Id [KEY] | Int | False |
Id |
CalculateSubtotal | Bool | False |
Calculate subtotal. |
Code | String | False |
Tax rule code |
CustomerTaxClassIds | String | False |
Customer tax class id |
ExtensionAttributes | String | False |
This is an auto-generated column |
Position | Int | False |
Sort order. |
Priority | Int | False |
Priority |
ProductTaxClassIds | String | False |
Product tax class id |
TaxRateIds | String | False |
Tax rate ids |
SearchCriteria | String | False |
This is an auto-generated column |
TotalCount | Int | False |
Total count. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
AdobeStockAssetApiGetAssetList | AdobeStockAssetApiGetAssetList is an auto generated table |
AdobeStockImageApiGetImageList | AdobeStockImageApiGetImageList is an auto generated table |
AnalyticsLinkProvider | AnalyticsLinkProvider is an auto generated table |
AsynchronousOperationsBulkStatus | AsynchronousOperationsBulkStatus is an auto generated table |
AsynchronousOperationsOperation | AsynchronousOperationsOperation is an auto generated table |
BillingAddresses | BillingAddresses is an auto-generated table. The supported operations are Querying data from this table. |
BundleProductLinkChildren | BundleProductLinkChildren is an auto generated table. The supported operations are Querying data from this table. |
CatalogCategoryAttribute | CatalogCategoryAttribute is an auto generated table. The supported operations are Querying data from this table. |
CatalogCategoryAttributeOptionOptions | CatalogCategoryAttributeOptionOptions is an auto generated table. The supported operations are Querying data from this table. |
CatalogCategoryLinkProducts | CatalogCategoryLinkProducts is an auto generated table. The supported operations are Querying data from this table. |
CatalogCategoryList | CatalogCategoryList is an auto generated table |
CatalogProductAttributeTypesList | CatalogProductAttributeTypesList is an auto generated table. The supported operations are Querying data from this table. |
CatalogProductLinkTypeList | CatalogProductLinkTypeList is an auto generated table. The supported operations are Querying data from this table. |
CatalogProductRenderList | CatalogProductRenderList is an auto generated table |
CatalogProductTierPriceTiers | CatalogProductTierPriceTiers is an auto generated table. The supported operations are Querying data from this table. |
CatalogProductTypeList | CatalogProductTypeList is an auto generated table. The supported operations are Querying data from this table. |
CheckoutAgreementsCheckoutAgreements | CheckoutAgreementsCheckoutAgreements is an auto generated table. The supported operations are Querying data from this table. |
CheckoutAgreementsCheckoutAgreementsList | CheckoutAgreementsCheckoutAgreementsList is an auto generated table |
ConfigurableProductLinkChildren | ConfigurableProductLinkChildren is an auto generated table. The supported operations are Querying data from this table. |
CustomerAccountBillingAddress | CustomerAccountBillingAddress is an auto generated table. The supported operations are Querying data from this table. |
CustomerAccountShippingAddress | CustomerAccountShippingAddress is an auto generated table. The supported operations are Querying data from this table. |
CustomerGroupDefault | CustomerGroupDefault is an auto generated table. The supported operations are Querying data from this table. |
DirectoryCountryInformationAcquirer | DirectoryCountryInformationAcquirer is an auto generated table. The supported operations are Querying data from this table. |
DirectoryCurrencyInformationAcquirer | DirectoryCurrencyInformationAcquirer is an auto generated table. The supported operations are Querying data from this table. |
GuestPaymentInformation | GuestPaymentInformation is an auto generated table. The supported operations are Querying data from this table. |
GuestPaymentMethods | GuestPaymentMethods is an auto generated table. The supported operations are Querying data from this table. |
GuestPaymentSelectedMethods | GuestPaymentSelectedMethods is an auto generated table. The supported operations are Querying data from this table. |
GuestShippingMethods | GuestShippingMethods is an auto generated table. The supported operations are Querying data from this table. |
InventoryApiGetSourcesAssignedToStockOrderedByPriority | InventoryApiGetSourcesAssignedToStockOrderedByPriority is an auto generated table |
InventoryApiGetStockSourceLinks | InventoryApiGetStockSourceLinks is an auto generated table |
InventoryApiSourceItem | InventoryApiSourceItem is an auto generated table |
OrderItems | OrderItems is an auto generated table. The supported operations are Querying data from this table. |
PaymentMethods | PaymentMethods is an auto generated table. The supported operations are Querying data from this table. |
PaymentSelectedMethods | PaymentSelectedMethods is an auto generated table. The supported operations are Querying data from this table. |
PayPalBraintreeAuth | PayPalBraintreeAuth is an auto generated table |
ProductAttributes | ProductAttributes is an auto generated table. The supported operations are Querying data from this table. |
QuoteCartTotal | QuoteCartTotal is an auto generated table. The supported operations are Querying data from this table. |
QuoteGuestCart | QuoteGuestCart is an auto generated table. The supported operations are Querying data from this table. |
QuoteGuestCartTotal | QuoteGuestCartTotal is an auto generated table. The supported operations are Querying data from this table. |
SalesTransaction | SalesTransaction is an auto generated table. The supported operations are Querying data from this table. |
ShippingMethods | ShippingMethods is an auto generated table. The supported operations are Querying data from this table. |
StoreGroup | StoreGroup is an auto generated table. The supported operations are Querying data from this table. |
Stores | Stores is an auto generated table. The supported operations are Querying data from this table. |
StoreWebsite | StoreWebsite is an auto generated table. The supported operations are Querying data from this table. |
AdobeStockAssetApiGetAssetList is an auto generated table
Name | Type | Description |
Id [KEY] | Int | This is an auto-generated column |
Aggregations | String | This is an auto-generated column |
SearchCriteria | String | This is an auto-generated column |
TotalCount | Int | Total count. |
AdobeStockImageApiGetImageList is an auto generated table
Name | Type | Description |
Id [KEY] | Int | This is an auto-generated column |
Aggregations | String | This is an auto-generated column |
SearchCriteria | String | This is an auto-generated column |
TotalCount | Int | Total count. |
AnalyticsLinkProvider is an auto generated table
Name | Type | Description |
InitializationVector | String | This is an auto-generated column |
Url | String | This is an auto-generated column |
AsynchronousOperationsBulkStatus is an auto generated table
The Sync App will use the AdobeCommerce API to filter the results by BulkUuid while the rest of the filter is executed client side within the Sync App.
The BulkUuid column must be specified in the WHERE clause to retrieve results from AsynchronousOperationsBulkStatus. BulkUuid can be used only with the equals (=) operator.
For example:
SELECT * FROM [AsynchronousOperationsBulkStatus] WHERE BulkUuid = '123'
Name | Type | Description |
BulkId | String | Bulk uuid |
BulkUuid | String | bulkUuid |
Description | String | Bulk description |
ExtensionAttributes | String | This is an auto-generated column |
OperationCount | Int | Total number of operations scheduled in scope of this bulk |
OperationsList | String | Operations list. |
StartTime | String | Bulk scheduled time |
UserId | Int | User id |
UserType | Int | User type |
AsynchronousOperationsOperation is an auto generated table
Name | Type | Description |
Id [KEY] | Int | Id |
BulkUuid | String | Bulk uuid |
ErrorCode | Int | Error code |
ExtensionAttributes | String | This is an auto-generated column |
ResultMessage | String | Result message |
ResultSerializedData | String | Serialized Data |
SearchCriteria | String | This is an auto-generated column |
SerializedData | String | Data |
Status | Int | Operation status |
TopicName | String | Queue Topic |
TotalCount | Int | Total count. |
BillingAddresses is an auto-generated table. The supported operations are Querying data from this table.
Name | Type | Description |
Id [KEY] | Int | Id |
CartId | String | cartId |
City | String | City name |
Company | String | Company |
CountryId | String | Country id |
CustomerAddressId | Int | Customer address id |
CustomerId | Int | Customer id |
String | Billing/shipping email | |
ExtensionAttributes | String | This is an auto-generated column |
Fax | String | Fax number |
Firstname | String | First name |
Lastname | String | Last name |
Middlename | String | Middle name |
Postcode | String | Postcode |
Prefix | String | Prefix |
Region | String | Region name |
RegionCode | String | Region code |
RegionId | Int | Region id |
SameAsBilling | Int | Same as billing flag |
SaveInAddressBook | Int | Save in address book flag |
Street | String | Street |
Suffix | String | Suffix |
Telephone | String | Telephone number |
VatId | String | Vat id |
BundleProductLinkChildren is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by ProductSku while the rest of the filter is executed client side within the Sync App.
The ProductSku column must be specified in the WHERE clause to retrieve results from BundleProductLinkChildren. ProductSku can be used only with the equals (=) operator.
For example:
SELECT * FROM [BundleProductLinkChildren] WHERE ProductSku = '123'
Name | Type | Description |
Id [KEY] | String | The identifier |
ProductSku | String | productSku |
CanChangeQuantity | Int | Whether quantity could be changed |
ExtensionAttributes | String | This is an auto-generated column |
IsDefault | Bool | Is default |
OptionId | Int | Option id |
Position | Int | Position |
Price | Double | Price |
PriceType | Int | Price type |
Qty | Double | Qty |
Sku | String | Linked product sku |
CatalogCategoryAttribute is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
ApplyTo | String | Apply to value for the element |
AttributeCode | String | Code of the attribute. |
AttributeId [KEY] | Int | Id of the attribute. |
BackendModel | String | Backend model |
BackendType | String | Backend type. |
DefaultFrontendLabel | String | Frontend label for default store |
DefaultValue | String | Default value for the element. |
EntityTypeId | String | Entity type id |
ExtensionAttributes | String | This is an auto-generated column |
FrontendClass | String | Frontend class of attribute |
FrontendInput | String | HTML for input element. |
FrontendLabels | String | Frontend label for each store |
IsComparable | String | The attribute can be compared on the frontend |
IsFilterable | Bool | It used in layered navigation |
IsFilterableInGrid | Bool | It is filterable in catalog product grid |
IsFilterableInSearch | Bool | It is used in search results layered navigation |
IsHtmlAllowedOnFront | Bool | The HTML tags are allowed on the frontend |
IsRequired | Bool | Attribute is required. |
IsSearchable | String | The attribute can be used in Quick Search |
IsUnique | String | This is a unique attribute |
IsUsedForPromoRules | String | The attribute can be used for promo rules |
IsUsedInGrid | Bool | It is used in catalog product grid |
IsUserDefined | Bool | Current attribute has been defined by a user. |
IsVisible | Bool | Attribute is visible on frontend. |
IsVisibleInAdvancedSearch | String | The attribute can be used in Advanced Search |
IsVisibleInGrid | Bool | It is visible in catalog product grid |
IsVisibleOnFront | String | The attribute is visible on the frontend |
IsWysiwygEnabled | Bool | WYSIWYG flag |
Note | String | The note attribute for the element. |
Options | String | Options of the attribute (key => value pairs for select) |
Position | Int | Position |
Scope | String | Attribute scope |
SearchCriteria | String | This is an auto-generated column |
SourceModel | String | Source model |
TotalCount | Int | Total count. |
UsedForSortBy | Bool | It is used for sorting in product listing |
UsedInProductListing | String | The attribute can be used in product listing |
ValidationRules | String | Validation rules. |
CatalogCategoryAttributeOptionOptions is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by AttributeCode while the rest of the filter is executed client side within the Sync App.
The AttributeCode column must be specified in the WHERE clause to retrieve results from CatalogCategoryAttributeOptionOptions. AttributeCode can be used only with the equals (=) operator.
For example:
SELECT * FROM [CatalogCategoryAttributeOptionOptions] WHERE AttributeCode = '123'
Name | Type | Description |
IsDefault | Bool | Default |
AttributeCode | String | attributeCode |
Label [KEY] | String | Option label |
SortOrder | Int | Option order |
StoreLabels | String | Option label for store scopes |
Value | String | Option value |
CatalogCategoryLinkProducts is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CategoryId while the rest of the filter is executed client side within the Sync App.
The CategoryId column must be specified in the WHERE clause to retrieve results from CatalogCategoryLinkProducts. CategoryId can be used only with the equals (=) operator.
For example:
SELECT * FROM [CatalogCategoryLinkProducts] WHERE CategoryId = '123'
Name | Type | Description |
CategoryId | String | Category id |
ExtensionAttributes | String | This is an auto-generated column |
Position | Int | This is an auto-generated column |
Sku [KEY] | String | This is an auto-generated column |
CatalogCategoryList is an auto generated table
Name | Type | Description |
Id [KEY] | Int | Category id. |
AvailableSortBy | String | Available sort by for category. |
Children | String | Children ids comma separated. |
CreatedAt | Datetime | Category creation date and time. |
ExtensionAttributes | String | This is an auto-generated column |
IncludeInMenu | Bool | Category is included in menu. |
IsActive | Bool | Whether category is active |
Level | Int | Category level |
Name | String | Category name |
ParentId | Int | Parent category ID |
Path | String | Category full path. |
Position | Int | Category position |
SearchCriteria | String | This is an auto-generated column |
TotalCount | Int | Total count. |
UpdatedAt | Datetime | Category last update date and time. |
CatalogProductAttributeTypesList is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
ExtensionAttributes | String | This is an auto-generated column |
Label [KEY] | String | Type label |
Value | String | Value |
CatalogProductLinkTypeList is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
Code [KEY] | Int | Link type code |
ExtensionAttributes | String | This is an auto-generated column |
Name | String | Link type name |
Type | String | Attribute type |
CatalogProductRenderList is an auto generated table
Name | Type | Description |
Id [KEY] | Int | Product identifier |
AddToCartButton | String | This is an auto-generated column |
AddToCompareButton | String | This is an auto-generated column |
CurrencyCode | String | Current or desired currency code to product |
ExtensionAttributes | String | This is an auto-generated column |
Images | String | Enough information, that needed to render image on front |
IsSalable | String | Information about product saleability (In Stock) |
Name | String | Product name |
PriceInfo | String | This is an auto-generated column |
StoreId | Int | Information about current store id or requested store id |
Type | String | Product type. Such as bundle, grouped, simple, etc... |
Url | String | Product url |
CatalogProductTierPriceTiers is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CustomerGroupId or Sku while the rest of the filter is executed client side within the Sync App.
The CustomerGroupId and Sku columns must be specified in the WHERE clause to retrieve results from CatalogProductTierPriceTiers. CustomerGroupId and Sku can be used only with the equals (=) operator.
For example:
SELECT * FROM [CatalogProductTierPriceTiers] WHERE CustomerGroupId = '234' AND Sku = '123'
Name | Type | Description |
CustomerGroupId [KEY] | Int | Customer group id |
Sku | String | sku |
ExtensionAttributes | String | This is an auto-generated column |
Qty | Double | Tier qty |
Value | Double | Price value |
CatalogProductTypeList is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
ExtensionAttributes | String | This is an auto-generated column |
Label [KEY] | String | Product type label |
Name | String | Product type code |
CheckoutAgreementsCheckoutAgreements is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
AgreementId [KEY] | Int | Agreement ID. |
CheckboxText | String | Agreement checkbox text. |
Content | String | Agreement content. |
ContentHeight | String | Agreement content height. Otherwise, null. |
ExtensionAttributes | String | This is an auto-generated column |
IsActive | Bool | Agreement status. |
IsHtml | Bool | * true - HTML. * false - plain text. |
Mode | Int | The agreement applied mode. |
Name | String | Agreement name. |
CheckoutAgreementsCheckoutAgreementsList is an auto generated table
Name | Type | Description |
AgreementId | Int | Agreement ID. |
CheckboxText | String | Agreement checkbox text. |
Content | String | Agreement content. |
ContentHeight | String | Agreement content height. Otherwise, null. |
ExtensionAttributes | String | This is an auto-generated column |
IsActive | Bool | Agreement status. |
IsHtml | Bool | * true - HTML. * false - plain text. |
Mode | Int | The agreement applied mode. |
Name | String | Agreement name. |
ConfigurableProductLinkChildren is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by Sku while the rest of the filter is executed client side within the Sync App.
The Sku column must be specified in the WHERE clause to retrieve results from ConfigurableProductLinkChildren. Sku can be used only with the equals (=) operator.
For example:
SELECT * FROM [ConfigurableProductLinkChildren] WHERE Sku = '123'
Name | Type | Description |
Id [KEY] | Int | Id |
AttributeSetId | Int | Attribute set id |
CreatedAt | Datetime | Created date |
ExtensionAttributes | String | This is an auto-generated column |
MediaGalleryEntries | String | Media gallery entries |
Name | String | Name |
Options | String | List of product options |
Price | Double | Price |
ProductLinks | String | Product links info |
Sku | String | Sku |
Status | Int | Status |
TierPrices | String | List of product tier prices |
TypeId | String | Type id |
UpdatedAt | Datetime | Updated date |
Visibility | Int | Visibility |
Weight | Double | Weight |
CustomerAccountBillingAddress is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CustomerId while the rest of the filter is executed client side within the Sync App.
The CustomerId column must be specified in the WHERE clause to retrieve results from CustomerAccountBillingAddress. CustomerId can be used only with the equals (=) operator.
For example:
SELECT * FROM [CustomerAccountBillingAddress] WHERE CustomerId = '123'
Name | Type | Description |
Id [KEY] | Int | ID |
City | String | City name |
Company | String | Company |
CountryId | String | Country code in ISO_3166-2 format |
CustomerId | Int | Customer ID |
DefaultBilling | Bool | If this address is default billing address |
DefaultShipping | Bool | If this address is default shipping address. |
ExtensionAttributes | String | This is an auto-generated column |
Fax | String | Fax number |
Firstname | String | First name |
Lastname | String | Last name |
Middlename | String | Middle name |
Postcode | String | Postcode |
Prefix | String | Prefix |
Region | String | This is an auto-generated column |
RegionId | Int | Region ID |
Street | String | Street |
Suffix | String | Suffix |
Telephone | String | Telephone number |
VatId | String | Vat id |
CustomerAccountShippingAddress is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CustomerId while the rest of the filter is executed client side within the Sync App.
The CustomerId column must be specified in the WHERE clause to retrieve results from CustomerAccountShippingAddress. CustomerId can be used only with the equals (=) operator.
For example:
SELECT * FROM [CustomerAccountShippingAddress] WHERE CustomerId = '123'
Name | Type | Description |
Id [KEY] | Int | ID |
City | String | City name |
Company | String | Company |
CountryId | String | Country code in ISO_3166-2 format |
CustomerId | Int | Customer ID |
DefaultBilling | Bool | If this address is default billing address |
DefaultShipping | Bool | If this address is default shipping address. |
ExtensionAttributes | String | This is an auto-generated column |
Fax | String | Fax number |
Firstname | String | First name |
Lastname | String | Last name |
Middlename | String | Middle name |
Postcode | String | Postcode |
Prefix | String | Prefix |
Region | String | This is an auto-generated column |
RegionId | Int | Region ID |
Street | String | Street |
Suffix | String | Suffix |
Telephone | String | Telephone number |
VatId | String | Vat id |
CustomerGroupDefault is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
Id [KEY] | Int | Id |
Code | String | Code |
ExtensionAttributes | String | This is an auto-generated column |
TaxClassId | Int | Tax class id |
TaxClassName | String | Tax class name |
DirectoryCountryInformationAcquirer is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
Id [KEY] | String | The country id for the store. |
CountryId | String | countryId |
AvailableRegions | String | The available regions for the store. |
ExtensionAttributes | String | This is an auto-generated column |
FullNameEnglish | String | The country full name (in English) for the store. |
FullNameLocale | String | The country full name (in store locale) for the store. |
ThreeLetterAbbreviation | String | The country 3 letter abbreviation for the store. |
TwoLetterAbbreviation | String | The country 2 letter abbreviation for the store. |
DirectoryCurrencyInformationAcquirer is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
AvailableCurrencyCodes | String | The list of allowed currency codes for the store. |
BaseCurrencyCode [KEY] | String | The base currency code for the store. |
BaseCurrencySymbol | String | The currency symbol of the base currency for the store. |
DefaultDisplayCurrencyCode | String | The default display currency code for the store. |
DefaultDisplayCurrencySymbol | String | The currency symbol of the default display currency for the store. |
ExchangeRates | String | The list of exchange rate information for the store. |
ExtensionAttributes | String | This is an auto-generated column |
GuestPaymentInformation is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from GuestPaymentInformation. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [GuestPaymentInformation] WHERE CartId = '123'
Name | Type | Description |
ExtensionAttributes | String | This is an auto-generated column |
CartId | String | cartId |
PaymentMethods | String | This is an auto-generated column |
Totals | String | This is an auto-generated column |
GuestPaymentMethods is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from GuestPaymentMethods. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [GuestPaymentMethods] WHERE CartId = '123'
Name | Type | Description |
Code [KEY] | String | Payment method code |
CartId | String | cartId |
Title | String | Payment method title |
GuestPaymentSelectedMethods is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from GuestPaymentSelectedMethods. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [GuestPaymentSelectedMethods] WHERE CartId = '123'
Name | Type | Description |
AdditionalData | String | Payment additional details |
CartId | String | cartId |
ExtensionAttributes | String | This is an auto-generated column |
Method [KEY] | String | Payment method code |
PoNumber | String | Purchase order number |
GuestShippingMethods is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from GuestShippingMethods. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [GuestShippingMethods] WHERE CartId = '123'
Name | Type | Description |
Amount | Double | Shipping amount in store currency. |
CartId | String | cartId |
Available | Bool | The value of the availability flag for the current shipping method. |
BaseAmount | Double | Shipping amount in base currency. |
CarrierCode | String | Shipping carrier code. |
CarrierTitle | String | Shipping carrier title. Otherwise, null. |
ErrorMessage | String | Shipping Error message. |
ExtensionAttributes | String | This is an auto-generated column |
MethodCode [KEY] | String | Shipping method code. |
MethodTitle | String | Shipping method title. Otherwise, null. |
PriceExclTax | Double | Shipping price excl tax. |
PriceInclTax | Double | Shipping price incl tax. |
InventoryApiGetSourcesAssignedToStockOrderedByPriority is an auto generated table
The Sync App will use the AdobeCommerce API to filter the results by StockId while the rest of the filter is executed client side within the Sync App.
The StockId column must be specified in the WHERE clause to retrieve results from InventoryApiGetSourcesAssignedToStockOrderedByPriority. StockId can be used only with the equals (=) operator.
For example:
SELECT * FROM [InventoryApiGetSourcesAssignedToStockOrderedByPriority] WHERE StockId = '123'
Name | Type | Description |
CarrierLinks | String | This is an auto-generated column |
StockId | String | stockId |
City | String | Source city |
ContactName | String | Source contact name |
CountryId | String | Source country id |
Description | String | Source description |
String | Source email | |
Enabled | Bool | If source is enabled. For new entity can be null |
ExtensionAttributes | String | This is an auto-generated column |
Fax | String | Source fax |
Latitude | Double | Source latitude |
Longitude | Double | Source longitude |
Name | String | Source name |
Phone | String | Source phone number |
Postcode | String | Source post code |
Region | String | Region title if source has custom region |
RegionId | Int | Region id if source has registered region. |
SourceCode | String | Source code |
Street | String | Source street name |
UseDefaultCarrierConfig | Bool | Is need to use default config |
InventoryApiGetStockSourceLinks is an auto generated table
Name | Type | Description |
ExtensionAttributes | String | This is an auto-generated column |
Priority | Int | Priority of the link |
SearchCriteria | String | This is an auto-generated column |
SourceCode | String | Source code of the link |
StockId | Int | Stock id |
TotalCount | Int | Total count. |
InventoryApiSourceItem is an auto generated table
Name | Type | Description |
ExtensionAttributes | String | This is an auto-generated column |
Quantity | Double | Source item quantity |
SearchCriteria | String | This is an auto-generated column |
Sku | String | Source item sku |
SourceCode | String | Source code |
Status | Int | Source item status (One of self::STATUS_*) |
TotalCount | Int | Total count. |
OrderItems is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by ItemId while the rest of the filter is executed client side within the Sync App.
The following examples demonstrate the types of queries processed on the server.
SELECT * FROM OrderItems
SELECT * FROM OrderItems WHERE ItemId = '3'
Name | Type | Description |
AdditionalData | String | Additional data. |
Id | String | id |
AmountRefunded | Double | Amount refunded. |
AppliedRuleIds | String | Applied rule IDs. |
BaseAmountRefunded | Double | Base amount refunded. |
BaseCost | Double | Base cost. |
BaseDiscountAmount | Double | Base discount amount. |
BaseDiscountInvoiced | Double | Base discount invoiced. |
BaseDiscountRefunded | Double | Base discount refunded. |
BaseDiscountTaxCompensationAmount | Double | Base discount tax compensation amount. |
BaseDiscountTaxCompensationInvoiced | Double | Base discount tax compensation invoiced. |
BaseDiscountTaxCompensationRefunded | Double | Base discount tax compensation refunded. |
BaseOriginalPrice | Double | Base original price. |
BasePrice | Double | Base price. |
BasePriceInclTax | Double | Base price including tax. |
BaseRowInvoiced | Double | Base row invoiced. |
BaseRowTotal | Double | Base row total. |
BaseRowTotalInclTax | Double | Base row total including tax. |
BaseTaxAmount | Double | Base tax amount. |
BaseTaxBeforeDiscount | Double | Base tax before discount. |
BaseTaxInvoiced | Double | Base tax invoiced. |
BaseTaxRefunded | Double | Base tax refunded. |
BaseWeeeTaxAppliedAmount | Double | Base WEEE tax applied amount. |
BaseWeeeTaxAppliedRowAmnt | Double | Base WEEE tax applied row amount. |
BaseWeeeTaxDisposition | Double | Base WEEE tax disposition. |
BaseWeeeTaxRowDisposition | Double | Base WEEE tax row disposition. |
CreatedAt | Datetime | Created-at timestamp. |
Description | String | Description. |
DiscountAmount | Double | Discount amount. |
DiscountInvoiced | Double | Discount invoiced. |
DiscountPercent | Double | Discount percent. |
DiscountRefunded | Double | Discount refunded. |
DiscountTaxCompensationAmount | Double | Discount tax compensation amount. |
DiscountTaxCompensationCanceled | Double | Discount tax compensation canceled. |
DiscountTaxCompensationInvoiced | Double | Discount tax compensation invoiced. |
DiscountTaxCompensationRefunded | Double | Discount tax compensation refunded. |
ExtensionAttributes | String | This is an auto-generated column |
ExtOrderItemId | String | External order item ID. |
FreeShipping | Int | Free-shipping flag value. |
IsQtyDecimal | Int | Is-quantity-decimal flag value. |
IsVirtual | Int | Is-virtual flag value. |
ItemId [KEY] | Int | Item ID. |
LockedDoInvoice | Int | Locked DO invoice flag value. |
LockedDoShip | Int | Locked DO ship flag value. |
Name | String | Name. |
NoDiscount | Int | No-discount flag value. |
OrderId | Int | Order ID. |
OriginalPrice | Double | Original price. |
ParentItem | String | This is an auto-generated column |
ParentItemId | Int | Parent item ID. |
Price | Double | Price. |
PriceInclTax | Double | Price including tax. |
ProductId | Int | Product ID. |
ProductOption | String | This is an auto-generated column |
ProductType | String | Product type. |
QtyBackordered | Double | Quantity backordered. |
QtyCanceled | Double | Quantity canceled. |
QtyInvoiced | Double | Quantity invoiced. |
QtyOrdered | Double | Quantity ordered. |
QtyRefunded | Double | Quantity refunded. |
QtyShipped | Double | Quantity shipped. |
QuoteItemId | Int | Quote item ID. |
RowInvoiced | Double | Row invoiced. |
RowTotal | Double | Row total. |
RowTotalInclTax | Double | Row total including tax. |
RowWeight | Double | Row weight. |
SearchCriteria | String | This is an auto-generated column |
Sku | String | SKU. |
StoreId | Int | Store ID. |
TaxAmount | Double | Tax amount. |
TaxBeforeDiscount | Double | Tax before discount. |
TaxCanceled | Double | Tax canceled. |
TaxInvoiced | Double | Tax invoiced. |
TaxPercent | Double | Tax percent. |
TaxRefunded | Double | Tax refunded. |
TotalCount | Int | Total count. |
UpdatedAt | Datetime | Updated-at timestamp. |
WeeeTaxApplied | String | WEEE tax applied. |
WeeeTaxAppliedAmount | Double | WEEE tax applied amount. |
WeeeTaxAppliedRowAmount | Double | WEEE tax applied row amount. |
WeeeTaxDisposition | Double | WEEE tax disposition. |
WeeeTaxRowDisposition | Double | WEEE tax row disposition. |
Weight | Double | Weight. |
PaymentMethods is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from PaymentMethods. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [PaymentMethods] WHERE CartId = '123'
Name | Type | Description |
Code [KEY] | String | Payment method code |
CartId | String | cartId |
Title | String | Payment method title |
PaymentSelectedMethods is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from PaymentSelectedMethods. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [PaymentSelectedMethods] WHERE CartId = '123'
Name | Type | Description |
AdditionalData | String | Payment additional details |
CartId | String | cartId |
ExtensionAttributes | String | This is an auto-generated column |
Method [KEY] | String | Payment method code |
PoNumber | String | Purchase order number |
PayPalBraintreeAuth is an auto generated table
Name | Type | Description |
ActionSuccess | String | To success page |
ClientToken | String | Client token |
DisplayName | String | Display name |
LoggedIn | Bool | This is an auto-generated column |
StoreCode | String | Current store code |
ProductAttributes is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by AttributeSetId while the rest of the filter is executed client side within the Sync App.
The AttributeSetId column must be specified in the WHERE clause to retrieve results from ProductAttributes. AttributeSetId can be used only with the equals (=) operator.
For example:
SELECT * FROM [ProductAttributes] WHERE AttributeSetId = '123'
Name | Type | Description |
ApplyTo | String | Apply to value for the element |
AttributeSetId | String | attributeSetId |
AttributeCode | String | Code of the attribute. |
AttributeId [KEY] | Int | Id of the attribute. |
BackendModel | String | Backend model |
BackendType | String | Backend type. |
DefaultFrontendLabel | String | Frontend label for default store |
DefaultValue | String | Default value for the element. |
EntityTypeId | String | Entity type id |
ExtensionAttributes | String | This is an auto-generated column |
FrontendClass | String | Frontend class of attribute |
FrontendInput | String | HTML for input element. |
FrontendLabels | String | Frontend label for each store |
IsComparable | String | The attribute can be compared on the frontend |
IsFilterable | Bool | It used in layered navigation |
IsFilterableInGrid | Bool | It is filterable in catalog product grid |
IsFilterableInSearch | Bool | It is used in search results layered navigation |
IsHtmlAllowedOnFront | Bool | The HTML tags are allowed on the frontend |
IsRequired | Bool | Attribute is required. |
IsSearchable | String | The attribute can be used in Quick Search |
IsUnique | String | This is a unique attribute |
IsUsedForPromoRules | String | The attribute can be used for promo rules |
IsUsedInGrid | Bool | It is used in catalog product grid |
IsUserDefined | Bool | Current attribute has been defined by a user. |
IsVisible | Bool | Attribute is visible on frontend. |
IsVisibleInAdvancedSearch | String | The attribute can be used in Advanced Search |
IsVisibleInGrid | Bool | It is visible in catalog product grid |
IsVisibleOnFront | String | The attribute is visible on the frontend |
IsWysiwygEnabled | Bool | WYSIWYG flag |
Note | String | The note attribute for the element. |
Options | String | Options of the attribute (key => value pairs for select) |
Position | Int | Position |
Scope | String | Attribute scope |
SourceModel | String | Source model |
UsedForSortBy | Bool | It is used for sorting in product listing |
UsedInProductListing | String | The attribute can be used in product listing |
ValidationRules | String | Validation rules. |
QuoteCartTotal is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from QuoteCartTotal. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [QuoteCartTotal] WHERE CartId = '123'
Name | Type | Description |
BaseCurrencyCode | String | Base currency code |
CartId | String | cartId |
BaseDiscountAmount | Double | Discount amount in base currency |
BaseGrandTotal | Double | Grand total in base currency |
BaseShippingAmount | Double | Shipping amount in base currency |
BaseShippingDiscountAmount | Double | Shipping discount amount in base currency |
BaseShippingInclTax | Double | Shipping including tax in base currency |
BaseShippingTaxAmount | Double | Shipping tax amount in base currency |
BaseSubtotal | Double | Subtotal in base currency |
BaseSubtotalInclTax | Double | Subtotal including tax in base currency |
BaseSubtotalWithDiscount | Double | Subtotal in base currency with applied discount |
BaseTaxAmount | Double | Tax amount in base currency |
CouponCode | String | Applied coupon code |
DiscountAmount | Double | Discount amount in quote currency |
ExtensionAttributes | String | This is an auto-generated column |
GrandTotal | Double | Grand total in quote currency |
Items | String | Totals by items |
ItemsQty | Int | Items qty |
QuoteCurrencyCode | String | Quote currency code |
ShippingAmount | Double | Shipping amount in quote currency |
ShippingDiscountAmount | Double | Shipping discount amount in quote currency |
ShippingInclTax | Double | Shipping including tax in quote currency |
ShippingTaxAmount | Double | Shipping tax amount in quote currency |
Subtotal | Double | Subtotal in quote currency |
SubtotalInclTax | Double | Subtotal including tax in quote currency |
SubtotalWithDiscount | Double | Subtotal in quote currency with applied discount |
TaxAmount | Double | Tax amount in quote currency |
TotalSegments | String | Dynamically calculated totals |
WeeeTaxAppliedAmount | Double | Item weee tax applied amount in quote currency. |
QuoteGuestCart is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from QuoteGuestCart. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [QuoteGuestCart] WHERE CartId = '123'
Name | Type | Description |
Id [KEY] | Int | Cart/quote ID. |
CartId | String | cartId |
BillingAddress | String | This is an auto-generated column |
ConvertedAt | String | Cart conversion date and time. Otherwise, null. |
CreatedAt | Datetime | Cart creation date and time. Otherwise, null. |
Currency | String | This is an auto-generated column |
Customer | String | This is an auto-generated column |
CustomerIsGuest | Bool | For guest customers, false for logged in customers |
CustomerNote | String | Notice text |
CustomerNoteNotify | Bool | Customer notification flag |
CustomerTaxClassId | Int | Customer tax class ID. |
ExtensionAttributes | String | This is an auto-generated column |
IsActive | Bool | Active status flag value. Otherwise, null. |
IsVirtual | Bool | Virtual flag value. Otherwise, null. |
Items | String | Array of items. Otherwise, null. |
ItemsCount | Int | Number of different items or products in the cart. Otherwise, null. |
ItemsQty | Double | Total quantity of all cart items. Otherwise, null. |
OrigOrderId | Int | Original order ID. Otherwise, null. |
ReservedOrderId | Int | Reserved order ID. Otherwise, null. |
StoreId | Int | Store identifier |
UpdatedAt | Datetime | Cart last update date and time. Otherwise, null. |
QuoteGuestCartTotal is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from QuoteGuestCartTotal. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [QuoteGuestCartTotal] WHERE CartId = '123'
Name | Type | Description |
BaseCurrencyCode | String | Base currency code |
CartId | String | cartId |
BaseDiscountAmount | Double | Discount amount in base currency |
BaseGrandTotal | Double | Grand total in base currency |
BaseShippingAmount | Double | Shipping amount in base currency |
BaseShippingDiscountAmount | Double | Shipping discount amount in base currency |
BaseShippingInclTax | Double | Shipping including tax in base currency |
BaseShippingTaxAmount | Double | Shipping tax amount in base currency |
BaseSubtotal | Double | Subtotal in base currency |
BaseSubtotalInclTax | Double | Subtotal including tax in base currency |
BaseSubtotalWithDiscount | Double | Subtotal in base currency with applied discount |
BaseTaxAmount | Double | Tax amount in base currency |
CouponCode | String | Applied coupon code |
DiscountAmount | Double | Discount amount in quote currency |
ExtensionAttributes | String | This is an auto-generated column |
GrandTotal | Double | Grand total in quote currency |
Items | String | Totals by items |
ItemsQty | Int | Items qty |
QuoteCurrencyCode | String | Quote currency code |
ShippingAmount | Double | Shipping amount in quote currency |
ShippingDiscountAmount | Double | Shipping discount amount in quote currency |
ShippingInclTax | Double | Shipping including tax in quote currency |
ShippingTaxAmount | Double | Shipping tax amount in quote currency |
Subtotal | Double | Subtotal in quote currency |
SubtotalInclTax | Double | Subtotal including tax in quote currency |
SubtotalWithDiscount | Double | Subtotal in quote currency with applied discount |
TaxAmount | Double | Tax amount in quote currency |
TotalSegments | String | Dynamically calculated totals |
WeeeTaxAppliedAmount | Double | Item weee tax applied amount in quote currency. |
SalesTransaction is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
AdditionalInformation | String | Array of additional information. Otherwise, null. |
Id | String | id |
ChildTransactions | String | Array of child transactions. |
CreatedAt | Datetime | Created-at timestamp. |
ExtensionAttributes | String | This is an auto-generated column |
IsClosed | Int | Is-closed flag value. |
OrderId | Int | Order ID. |
ParentId | Int | The parent ID for the transaction. Otherwise, null. |
ParentTxnId | String | Parent transaction business ID. |
PaymentId | Int | Payment ID. |
SearchCriteria | String | This is an auto-generated column |
TotalCount | Int | Total count. |
TransactionId [KEY] | Int | Transaction ID. |
TxnId | String | Transaction business ID. |
TxnType | String | Transaction type. |
ShippingMethods is an auto generated table. The supported operations are Querying data from this table.
The Sync App will use the AdobeCommerce API to filter the results by CartId while the rest of the filter is executed client side within the Sync App.
The CartId column must be specified in the WHERE clause to retrieve results from ShippingMethods. CartId can be used only with the equals (=) operator.
For example:
SELECT * FROM [ShippingMethods] WHERE CartId = '123'
Name | Type | Description |
Amount | Double | Shipping amount in store currency. |
CartId | String | cartId |
Available | Bool | The value of the availability flag for the current shipping method. |
BaseAmount | Double | Shipping amount in base currency. |
CarrierCode | String | Shipping carrier code. |
CarrierTitle | String | Shipping carrier title. Otherwise, null. |
ErrorMessage | String | Shipping Error message. |
ExtensionAttributes | String | This is an auto-generated column |
MethodCode [KEY] | String | Shipping method code. |
MethodTitle | String | Shipping method title. Otherwise, null. |
PriceExclTax | Double | Shipping price excl tax. |
PriceInclTax | Double | Shipping price incl tax. |
StoreGroup is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
Id [KEY] | Int | This is an auto-generated column |
DefaultStoreId | Int | This is an auto-generated column |
ExtensionAttributes | String | This is an auto-generated column |
Name | String | This is an auto-generated column |
RootCategoryId | Int | This is an auto-generated column |
WebsiteId | Int | This is an auto-generated column |
Stores is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
Id [KEY] | Int | This is an auto-generated column |
Code | String | This is an auto-generated column |
ExtensionAttributes | String | This is an auto-generated column |
Name | String | Store name |
StoreGroupId | Int | This is an auto-generated column |
WebsiteId | Int | This is an auto-generated column |
StoreWebsite is an auto generated table. The supported operations are Querying data from this table.
Name | Type | Description |
Id [KEY] | Int | This is an auto-generated column |
Code | String | This is an auto-generated column |
DefaultGroupId | Int | This is an auto-generated column |
ExtensionAttributes | String | This is an auto-generated column |
Name | String | Website name |
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to AdobeCommerce 2.x. |
URL | Set the URL to the HTTP or HTTPS endpoint of your AdobeCommerce system. For example, https://adobecommercehost/. We should not append magento2 as suffix in the url if you are connecting to cloud instance. |
User | Username of the currently authenticated user. Used to connect to AdobeCommerce 2.x servers only. |
Password | Password of the currently authenticated User . Used to connect to AdobeCommerce 2.x servers. |
AccessToken | The AdobeCommerce Access Token. |
StoreCode | Specifies the code of the store against which the API requests are executed. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
IncludeCustomAttributes | A boolean indicating if you would like to include custom attributes in the column listing. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | The maximum number of results to return per page from AdobeCommerce. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
RowScanDepth | Scan AdobeCommerce Product entities to determine unique columns. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TypeDetectionScheme | Enables scanning AdobeCommerce Product entities to determine unique columns. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to AdobeCommerce 2.x. |
URL | Set the URL to the HTTP or HTTPS endpoint of your AdobeCommerce system. For example, https://adobecommercehost/. We should not append magento2 as suffix in the url if you are connecting to cloud instance. |
User | Username of the currently authenticated user. Used to connect to AdobeCommerce 2.x servers only. |
Password | Password of the currently authenticated User . Used to connect to AdobeCommerce 2.x servers. |
AccessToken | The AdobeCommerce Access Token. |
StoreCode | Specifies the code of the store against which the API requests are executed. |
The type of authentication to use when connecting to AdobeCommerce 2.x.
Set the URL to the HTTP or HTTPS endpoint of your AdobeCommerce system. For example, https://adobecommercehost/. We should not append magento2 as suffix in the url if you are connecting to cloud instance.
Set the URL to the HTTP or HTTPS endpoint of your AdobeCommerce system. For example, https://adobecommercehost/. See the Getting Started section of the help documentation for connection guides to AdobeCommerce 2.
Username of the currently authenticated user. Used to connect to AdobeCommerce 2.x servers only.
Username of the currently authenticated user. Used to connect to AdobeCommerce 2.x servers only. See the Establishing a Connection section under Getting Started for more information on authenticating to different versions of AdobeCommerce.
If you are accessing AdobeCommerce as a customer, these credentials correspond to your customer account. To create an account, select Account > Register from the AdobeCommerce home page.
To allow administrator users to connect:
Password of the currently authenticated User . Used to connect to AdobeCommerce 2.x servers.
Password of the currently authenticated User. Used only to connect to AdobeCommerce 2.x servers.
The AdobeCommerce Access Token.
The AdobeCommerce Access Token used to authenticate the requests. The Access Token can be either Integration, Admin or Customer type.
Specifies the code of the store against which the API requests are executed.
The store code identifies a store in the AdobeCommerce system. Set the value "all" to execute the API requests on every store in the system. This value only applies to the CMS and Product related tables.
このセクションでは、本プロバイダーの接続文字列で設定可能な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 はAdobeCommerce への接続を開き、プロキシを経由して通信が行われます。 |
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 を設定します。
認証タイプは、次のどれかになります。
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 を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\AdobeCommerce 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 プロパティの全リストを提供します。
プロパティ | 説明 |
GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
IncludeCustomAttributes | A boolean indicating if you would like to include custom attributes in the column listing. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | The maximum number of results to return per page from AdobeCommerce. |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
RowScanDepth | Scan AdobeCommerce Product entities to determine unique columns. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
TypeDetectionScheme | Enables scanning AdobeCommerce Product entities to determine unique columns. |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
スキーマを生成して保存するユーザーの好みのタイミングを示します。
このプロパティは、Location で指定されたパスの.rsd ファイルにスキーマをアウトプットします。
有効な設定は次のとおりです。
GenerateSchemaFiles をOnUse に設定すると、Sync App はSELECT クエリを実行したときにスキーマを生成します。スキーマはクエリのそれぞれの参照されたテーブルに対して生成されます。
GenerateSchemaFiles をOnCreate に設定すると、CREATE TABLE クエリが実行されたときにのみスキーマが生成されます。
このプロパティのもう一つの使い方は、接続するときにデータベース内のすべてのテーブルのスキーマを取得することです。これには、GenerateSchemaFiles をOnStart に設定して接続します。
A boolean indicating if you would like to include custom attributes in the column listing.
Setting this to true will cause custom attributes to be included in the column listing.
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
The maximum number of results to return per page from AdobeCommerce.
The Pagesize property affects the maximum number of results to return per page from AdobeCommerce schema.
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
Scan AdobeCommerce Product entities to determine unique columns.
In the AdobeCommerce APIs, Product entities can have different sets of associated attributes. For example, clothing Products will also have Gender, Size, and Sleeve_Length attributes in addition to the standard columns.
When TypeDetectionScheme is set to "RowScan", the RowScanDepth property determines the number of objects to scan to determine the unique columns.
Setting a high value may decrease performance. Setting a low value may prevent the Sync App from retrieving the relevant columns for the table.
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
Enables scanning AdobeCommerce Product entities to determine unique columns.
In the AdobeCommerce APIs, Product entities can have different sets of associated attributes. For example, clothing Products will also have Gender, Size, and Sleeve_Length attributes in addition to the standard columns.
To access these unique columns, set the following connection properties:
RowScan | Setting TypeDetectionScheme to RowScan will scan objects (rows) to heuristically determine additional columns when you connect. The RowScanDepth determines the number of objects to be scanned. |
None | Setting TypeDetectionScheme to None will return only the standard columns. |
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Products WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。
テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
AdobeCommerce テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。