CData Sync App は、au PAY Market データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
au PAY Market コネクタはCData Sync アプリケーションから使用可能で、au PAY Market からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はau PAY Market API を利用してau PAY マーケットへの双方向連携を実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
CData Sync App を使用してau PAY マーケットに接続する場合は、ShopId およびApiKey が必要です。
ShopId およびApiKey を取得するには、以下の手順に従ってください。
次の接続プロパティを設定して接続します。
このセクションでは、au PAY Market Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、au PAY Market オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 au PAY Market オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、au PAY Market API へのSQL の実行について詳しく説明します。
ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。
Sync App はau PAY Market のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Inventory | Stock database of nventory data in au PAY Market. Retrieve and update stock information. |
| InventoryChoices | Retrieve and update information related to inventory choices. |
| InventoryHorizontalChoices | Retrieve information related to inventory horizontal choices. |
| ItemDeliveries | Retrieve and update information related to item deliveries. |
| ItemDeliveryMethods | Retrieve and information related to item delivery methods. |
| ItemImages | Retrieve and update information related to item images. |
| ItemOptions | Retrieve and update information related to item options. |
| Items | Retrieve information related to Items.Query, add, update and delete products. |
| ItemSpecifications | Retrieve and update information related to item specifications. |
| OrderItems | Retrieve information related to order items. |
| Orders | Retrieve and query information related to orders. |
Stock database of nventory data in au PAY Market. Retrieve and update stock information.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Inventory WHERE ItemCode LIKE 'CD001' AND StockCount > 12 AND StockCount <= 30
SELECT * FROM Inventory WHERE LotNumber = 1234455 AND ShopId = '123' AND StockCount = 12
Insert is not supported for this table
au PAY Market allows updates for all columns. ItemCode is required.
UPDATE Inventory SET StockShippingDayId = 'id', StockShippingDayDisplayText = 'display text', DisplayStockSegment = 'categ', ChoicesStockLowerDescription = 'desc', DisplayStockThreshold = 'threshold' WHERE ItemCode = 'MD001' AND LotNumber = 9808450
InventoryChoices, InventoryVerticalChoices, InventoryHorizontalChoices columns contain information on the subtables with the same names. These fields can be updated as aggregated values, or by using temporary tables.
UPDATE Inventory SET InventoryChoices = '<choicesStocks>
<choicesStockCount>5</choicesStockCount>
<choicesStockHorizontalCode>M</choicesStockHorizontalCode>
<choicesStockVerticalCode>Green</choicesStockVerticalCode>
</choicesStocks>
<choicesStocks>
<choicesStockCount>2</choicesStockCount>
<choicesStockHorizontalCode>S</choicesStockHorizontalCode>
<choicesStockVerticalCode>Green</choicesStockVerticalCode>
</choicesStocks>
<choicesStocks>
<choicesStockCount>4</choicesStockCount>
<choicesStockHorizontalCode>M</choicesStockHorizontalCode>
<choicesStockVerticalCode>Red</choicesStockVerticalCode>
</choicesStocks>
<choicesStocks>
<choicesStockCount>0</choicesStockCount>
<choicesStockHorizontalCode>S</choicesStockHorizontalCode>
<choicesStockVerticalCode>Red</choicesStockVerticalCode>
</choicesStocks>',
InventoryHorizontalChoices = '<choicesStockHorizontals>
<choicesStockHorizontalCode>S</choicesStockHorizontalCode>
<choicesStockHorizontalName>S</choicesStockHorizontalName>
<choicesStockHorizontalSeq>1</choicesStockHorizontalSeq>
</choicesStockHorizontals>
<choicesStockHorizontals>
<choicesStockHorizontalCode>M</choicesStockHorizontalCode>
<choicesStockHorizontalName>M</choicesStockHorizontalName>
<choicesStockHorizontalSeq>2</choicesStockHorizontalSeq>
</choicesStockHorizontals>',
InventoryVerticalChoices = '<choicesStockVerticals>
<choicesStockVerticalCode>Red</choicesStockVerticalCode>
<choicesStockVerticalName>Red</choicesStockVerticalName>
<choicesStockVerticalSeq>1</choicesStockVerticalSeq>
</choicesStockVerticals>
<choicesStockVerticals>
<choicesStockVerticalCode>Green</choicesStockVerticalCode>
<choicesStockVerticalName>Green</choicesStockVerticalName>
<choicesStockVerticalSeq>2</choicesStockVerticalSeq>
</choicesStockVerticals>'
WHERE ItemCode = 'Cd001' AND LotNumber = 9808450
INSERT INTO InventoryChoices#TEMP (ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('M', 'Green', 5)
INSERT INTO InventoryChoices#TEMP (ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('S', 'Green', 2)
INSERT INTO InventoryChoices#TEMP (ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('M', 'Red', 4)
INSERT INTO InventoryChoices#TEMP (ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('S', 'Red', 0)
INSERT INTO InventoryVerticalChoices#TEMP (ChoicesVerticalCode, ChoicesVerticalName, ChoicesVerticalSeq) VALUES ('Red', 'Red', 1)
INSERT INTO InventoryVerticalChoices#TEMP (ChoicesVerticalCode, ChoicesVerticalName, ChoicesVerticalSeq) VALUES ('Green', 'Green', 2)
INSERT INTO InventoryHorizontalChoices#TEMP (ChoicesHorizontalCode, ChoicesHorizontalName, ChoicesHorizontalSeq) VALUES ('S', 'S', 1)
INSERT INTO InventoryHorizontalChoices#TEMP (ChoicesHorizontalCode, ChoicesHorizontalName, ChoicesHorizontalSeq) VALUES ('M', 'M', 2)
UPDATE Inventory SET InventoryChoices = 'InventoryChoices#TEMP', InventoryVerticalChoices = 'InventoryVerticalChoices#TEMP', InventoryHorizontalChoices = 'InventoryHorizontalChoices#TEMP' WHERE ItemCode = 'CD001' AND LotNumber = 9808450
au PAY Market allows updates in batches for all columns except InventoryChoices, InventoryVerticalChoices and InventoryHorizontalChoices. ItemCode is required.
INSERT INTO Inventory#TEMP (StockShippingDayId, DisplayStockThreshold, ItemCode, LotNumber) VALUES ('a', 'threshold1', 'CD001', 9808450)
INSERT INTO Inventory#TEMP (StockShippingDayId, DisplayStockThreshold, ItemCode, LotNumber) VALUES ('b', 'threshold2', 'CD002', 9804323)
INSERT INTO Inventory#TEMP (StockShippingDayId, DisplayStockThreshold, ItemCode, LotNumber) VALUES ('c', 'threshold3', 'CD003', 9804312)
UPDATE Inventory SET (StockShippingDayId, DisplayStockThreshold, ItemCode, LotNumber) SELECT StockShippingDayId, DisplayStockThreshold, ItemCode, LotNumber FROM Inventory#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| ItemCode [KEY] | String | False |
Product code. | |
| LotNumber | Long | False |
Lot number. | |
| StockCount | Integer | False |
Usually the number of stock. | |
| StockSegment | String | False |
Stock division. | |
| StockShippingDayId | String | False |
Normal inventory shipping day ID. | |
| StockShippingDayDisplayText | String | False |
Inventory shipping information. | |
| DisplayStockSegment | String | False |
Stock display category. | |
| DisplayStockThreshold | String | False |
Stock display threshold. | |
| ChoicesStockHorizontalItemName | String | False |
Choices by stock horizontal axis item name. | |
| ChoicesStockVerticalItemName | String | False |
Choices by stock horizontal axis item name. | |
| ChoicesStockUpperDescription | String | False |
Choices by stock upper description. | |
| ChoicesStockLowerDescription | String | False |
Choices by stock lower description. | |
| DisplayChoicesStockSegment | Integer | False |
The remaining choices by stock Display category. | |
| DisplayChoicesStockThreshold | Integer | False |
Choices by stock display threshold. | |
| DisplayBackorderMessage | String | False |
Out of stock message. | |
| InventoryHorizontalChoices | String | False |
Aggregated data for inventory horizontal options. Readable data found at sub-table with the same name. | |
| InventoryVerticalChoices | String | False |
Aggregated data for inventory vertical options. Readable data found at sub-table with the same name. | |
| InventoryChoices | String | False |
Aggregated data for inventory choices. Readable data found at sub-table with the same name. | |
| ShopId | String | False |
Store account. |
Retrieve and update information related to inventory choices.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM InventoryChoices WHERE ItemCode LIKE 'CD001'
SELECT * FROM InventoryChoices WHERE LotNumber = 1234455 AND ShopId = '123'
All columns can be specified. ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode are required for an Insert
INSERT INTO InventoryChoices (ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount, ChoicesShippingDayId, ChoicesShippingDayDisplayText) VALUES ('CD001', 'S', 'Red', 3, '2132', 'text')
All columns can be specified. ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode are required.
INSERT INTO InventoryChoices#TEMP (ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('CD001', 'S', 'Red', 0)
INSERT INTO InventoryChoices#TEMP (ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('CD001', 'M', 'Red', 4)
INSERT INTO InventoryChoices#TEMP (ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('CD001', 'S', 'Yellow', 3)
INSERT INTO InventoryChoices SELECT ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount FROM InventoryChoices#TEMP
au PAY Market allows updates for all columns. ItemCode is required.
UPDATE InventoryChoices SET ChoicesCount = 0, ChoicesShippingDayId = '2132', ChoicesShippingDayDisplayText = 'txt' WHERE ItemCode = 'CD001' AND ChoicesHorizontalCode = 'S' AND ChoicesVerticalCode = 'Red'
au PAY Market allows updates in batches for all columns. ItemCode, ChoicesHorizontalCode and ChoicesVerticalCode are required.
INSERT INTO InventoryChoices#TEMP (ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('CD001', 'S', 'Red', 0)
INSERT INTO InventoryChoices#TEMP (ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('CD001', 'M', 'Red', 4)
INSERT INTO InventoryChoices#TEMP (ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('CD001', 'S', 'Yellow', 3)
UPDATE InventoryChoices SET (ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) SELECT ItemCode, ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount FROM InventoryChoices#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| ItemCode [KEY] | String | False |
Inventory.ItemCode |
Product code. |
| LotNumber | Long | False |
Inventory.LotNumber |
Lot number. |
| ChoicesHorizontalCode [KEY] | String | False |
Choice horizontal code. | |
| ChoicesVerticalCode [KEY] | String | False |
Choice vertical code. | |
| ChoicesCount | String | False |
Choice count.. | |
| ChoicesShippingDayId | String | False |
Choice shipping date id. | |
| ChoicesShippingDayDisplayText | String | False |
Choice shipping date information. | |
| ShopId | String | False |
Store account. |
Retrieve information related to inventory horizontal choices.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM InventoryHorizontalChoices WHERE ItemCode LIKE 'CD001'
SELECT * FROM InventoryHorizontalChoices WHERE LotNumber = 1234455 AND ShopId = '123'
Insert is not supported from for this table
au PAY Market allows updates for ChoicesHorizontalName column. ItemCode and ChoicesHorizontalCode are required.
UPDATE InventoryHorizontalChoices SET ChoicesHorizontalName = 'Mm' WHERE ItemCode = 'CD001' AND ChoicesHorizontalCode = 'M'
au PAY Market allows updates in batches for ChoicesHorizontalName. ItemCode and ChoicesHorizontalCode are required.
INSERT INTO InventoryHorizontalChoices#TEMP (ItemCode, ChoicesHorizontalCode, ChoicesHorizontalName) VALUES ('CD001', 'S', 'S')
INSERT INTO InventoryHorizontalChoices#TEMP (ItemCode, ChoicesHorizontalCode, ChoicesHorizontalName) VALUES ('CD001', 'M', 'M')
UPDATE InventoryHorizontalChoices SET (ItemCode, ChoicesHorizontalCode, ChoicesHorizontalName) SELECT ItemCode, ChoicesHorizontalCode, ChoicesHorizontalName FROM InventoryHorizontalChoices#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| ItemCode [KEY] | String | False |
Inventory.ItemCode |
Product code. |
| LotNumber | Long | False |
Inventory.LotNumber |
Lot number. |
| ChoicesStockHorizontalItemName | String | False |
Choices by stock horizontal axis item name. | |
| ChoicesHorizontalCode [KEY] | String | False |
Horizontal choice code. | |
| ChoicesHorizontalName | String | False |
Horizontal choice name. | |
| ChoicesHorizontalSeq | String | False |
Horizontal choice sequence. | |
| ShopId | String | False |
Store account. |
Retrieve and update information related to item deliveries.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM ItemDeliveries WHERE ItemCode LIKE '%CD00%'
SELECT * FROM ItemDeliveries WHERE ItemCode = 'CD001' AND LotNumber = 123543
All columns can be specified. ItemCode, DeliveryId, DeliverySeq are required for an insert.
INSERT INTO ItemDeliveries (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('Code0001', '9804120', '10', 1)
All columns can be specified. ItemCode, DeliveryId, DeliverySeq are required.
INSERT INTO ItemDeliveries#TEMP (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('Code0001', '9804120', '10', 1)
INSERT INTO ItemDeliveries#TEMP (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('Code0001', '9804120', '11', 2)
INSERT INTO ItemDeliveries#TEMP (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('Code0001', '9804120', '12', 3)
INSERT INTO ItemDeliveries SELECT ItemCode, LotNumber, DeliveryId, DeliverySeq FROM ItemDeliveries#TEMP
au PAY Market allows updates for all columns. ItemCode, DeliveryId are required.
UPDATE ItemDeliveries SET DeliveryId = '10', DeliverySeq = 1 WHERE ItemCode = 'Code0001' AND LotNumber = 9804120
au PAY Market allows updates in batches for all columns. ItemCode, DeliveryId are required.
INSERT INTO ItemDeliveries#TEMP (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('Code0001', '9804120', '10', 1)
INSERT INTO ItemDeliveries#TEMP (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('Code0001', '9804120', '11', 2)
INSERT INTO ItemDeliveries#TEMP (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('Code0001', '9804120', '12', 3)
UPDATE ItemDeliveries SET (ItemCode, LotNumber, DeliveryId, StockSegment) SELECT ItemCode, LotNumber, DeliveryId, DeliverySeq FROM ItemDeliveries#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| ItemCode [KEY] | String | False |
Items.ItemCode |
Product code. |
| LotNumber | Long | False |
Items.LotNumber |
Lot number. |
| DeliveryId [KEY] | String | False |
Delivery id. | |
| DeliverySeq | String | False |
Delivery sequence. | |
| ShopId | String | False |
Store account. |
Retrieve and information related to item delivery methods.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM ItemDeliveryMethods WHERE ItemCode LIKE '%CD00%'
SELECT * FROM ItemDeliveryMethods WHERE ItemCode = 'CD001' AND LotNumber = 123543
All columns can be specified. ItemCode, DeliveryMethodId, DeliveryMethodSeq are required for an insert.
INSERT INTO ItemDeliveryMethods (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq) VALUES ('MD001', '9808450', 'M', 1)
All columns can be specified. ItemCode, DeliveryMethodId, DeliveryMethodSeq are required.
INSERT INTO ItemDeliveryMethods#TEMP (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq) VALUES ('MD001', '9808450', 'M', 1)
INSERT INTO ItemDeliveryMethods#TEMP (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq) VALUES ('MD001', '9808450', 'S', 2)
INSERT INTO ItemDeliveryMethods#TEMP (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq) VALUES ('MD001', '9808450', 'F', 3)
INSERT INTO ItemDeliveryMethods SELECT ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq FROM ItemDeliveryMethods#TEMP
au PAY Market allows updates for all columns. ItemCode, DeliveryMethodId are required.
UPDATE ItemDeliveryMethods SET DeliveryMethodId = 'M', DeliveryMethodSeq = 1 WHERE ItemCode = 'MD001' AND LotNumber = '9808450'
au PAY Market allows updates in batches for all columns. ItemCode, DeliveryMethodId are required.
INSERT INTO ItemDeliveryMethods#TEMP (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq) VALUES ('MD001', '9808450', 'M', 1)
INSERT INTO ItemDeliveryMethods#TEMP (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq) VALUES ('MD001', '9808450', 'S', 2)
INSERT INTO ItemDeliveryMethods#TEMP (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq) VALUES ('MD001', '9808450', 'F', 3)
UPDATE ItemDeliveryMethods SET ( ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq ) SELECT ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq FROM ItemDeliveryMethods#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| ItemCode [KEY] | String | False |
Items.ItemCode |
Product code. |
| LotNumber | Long | False |
Items.LotNumber |
Lot number. |
| DeliveryMethodId [KEY] | String | False |
Delivery method id. | |
| DeliveryMethodSeq | String | False |
Delivery method sequence. | |
| DeliveryMethodName | String | False |
Delivery method name. | |
| ShopId | String | False |
Store account. |
Retrieve and update information related to item images.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM ItemImages WHERE ItemCode LIKE '%CD00%'
SELECT * FROM ItemImages WHERE ItemCode = 'CD001' AND LotNumber = 123543
All columns can be specified. ItemCode, ImageSeq are required for an insert.
INSERT INTO ItemImages (ItemCode, LotNumber, ImageName, ImageSeq) VALUES ('MD001', '9808450', 'M', 1)
All columns can be specified. ItemCode, ImageSeq are required.
INSERT INTO ItemImages#TEMP (ItemCode, LotNumber, ImageName, ImageSeq) VALUES ('MD001', '9808450', 'M', 1)
INSERT INTO ItemImages#TEMP (ItemCode, LotNumber, ImageName, ImageSeq) VALUES ('MD001', '9808450', 'S', 2)
INSERT INTO ItemImages#TEMP (ItemCode, LotNumber, ImageName, ImageSeq) VALUES ('MD001', '9808450', 'F', 3)
INSERT INTO ItemImages SELECT ItemCode, LotNumber, ImageId, ImageSeq FROM ItemImages#TEMP
au PAY Market allows updates for all columns. ItemCode, ImageSeq are required.
UPDATE ItemImages SET ImageName = 'M', ImageSeq = 1 WHERE ItemCode = 'MD001' AND LotNumber = '9808450'
au PAY Market allows updates in batches for all columns. ItemCode, ImageSeq are required.
INSERT INTO ItemImages#TEMP (ItemCode, LotNumber, ImageName, ImageSeq) VALUES ('MD001', '9808450', 'M', 1)
INSERT INTO ItemImages#TEMP (ItemCode, LotNumber, ImageName, ImageSeq) VALUES ('MD001', '9808450', 'S', 2)
INSERT INTO ItemImages#TEMP (ItemCode, LotNumber, ImageName, ImageSeq) VALUES ('MD001', '9808450', 'F', 3)
UPDATE ItemImages SET ( ItemCode, LotNumber, ImageName, ImageSeq ) SELECT ItemCode, LotNumber, ImageName, ImageSeq FROM ItemImages#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| LotNumber | Long | False |
Items.LotNumber |
Lot number. |
| ItemCode [KEY] | String | False |
Items.ItemCode |
Product code. |
| ImageSeq [KEY] | String | False |
Product image order. | |
| ImageUrl | String | False |
Product image URL. | |
| ImageName | String | False |
Product image name. | |
| ShopId | String | False |
Store account. |
Retrieve and update information related to item options.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM ItemOptions WHERE ItemCode LIKE '%CD00%'
SELECT * FROM ItemOptions WHERE ItemCode = 'CD001' AND LotNumber = 123543
All columns can be specified. ItemCode, ItemOptionSeq are required for an insert.
INSERT INTO ItemOptions (ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('Code0001', '1', 'title1', 'option1')
All columns can be specified. ItemCode, ItemOptionSeq are required.
INSERT INTO ItemOptions#TEMP (ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('Code0001', '1', 'title1', 'option1')
INSERT INTO ItemOptions#TEMP (ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('Code0001', '2', 'title2', 'option2')
INSERT INTO ItemOptions#TEMP (ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('Code0001', '3', 'title7', 'option7')
INSERT INTO ItemOptions SELECT ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption FROM ItemOptions#TEMP
au PAY Market allows updates for all columns. ItemCode, ItemOptionSeq are required.
UPDATE ItemOptions SET ItemOptionTitle = 'title1', ItemOption = 'Code0001' WHERE ItemCode = 'MD001' AND ItemOptionSeq = '1'
au PAY Market allows updates in batches for all columns. ItemCode, ItemOptionSeq are required.
INSERT INTO ItemOptions#TEMP (ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('Code0001', '1', 'title1', 'option1')
INSERT INTO ItemOptions#TEMP (ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('Code0001', '2', 'title2', 'option2')
INSERT INTO ItemOptions#TEMP (ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('Code0001', '3', 'title7', 'option7')
UPDATE ItemOptions SET ( ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption ) SELECT ItemCode, ItemOptionSeq, ItemOptionTitle, ItemOption FROM ItemOptions#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| ItemCode [KEY] | String | False |
Items.ItemCode |
Product code. |
| LotNumber | Long | False |
Items.LotNumber |
Lot number. |
| ItemOptionSeq [KEY] | String | False |
Item option squence. | |
| ItemOptionTitle | String | False |
Item option title. | |
| ItemOption | String | False |
Item option value. | |
| ShopId | String | False |
Store account. |
Retrieve information related to Items.Query, add, update and delete products.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Items WHERE ItemCode LIKE 'CD001' AND StockCount > 12 AND StockCount <= 30 AND PointRate = 15
SELECT * FROM Items WHERE LotNumber = 1234455 AND ShopId = '123' AND StockCount = 12 AND PointRate > 12 AND PointRate <= 30 AND HasTags = 2 AND DeliveryId = 'devID' AND DeliveryMethodId = 'devMetID'
SELECT * FROM Items WHERE ItemName LIKE 'name' SellMethodSegment = 1 AND PostageSegment = 'abc' AND Postage = 'cde' AND CategoryId = 'catID' AND LimitedPassword IS NOT NULL
You can specify all columns that are not readonly. ItemCode is required. ItemSpecifications, ItemOptions, ItemOptionCommissions, ItemImages, ItemDeliveries, ItemDeliveryMethods, Inventory contain information that has also been exposed in subtables with matching names. These values can be specified as aggregated data or taken from temporary tables.
INSERT INTO ItemDeliveryMethods#TEMP (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq, DeliveryMethodName) VALUES ('itCode5', '1', '11', 1, 'methodName')
INSERT INTO ItemDeliveryMethods#TEMP (ItemCode, LotNumber, DeliveryMethodId, DeliveryMethodSeq, DeliveryMethodName) VALUES ('itCode5', '1', '13', 2, 'methodName2')
INSERT INTO ItemDeliveries#TEMP (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('itCode5', '1', '11', 1)
INSERT INTO ItemDeliveries#TEMP (ItemCode, LotNumber, DeliveryId, DeliverySeq) VALUES ('itCode5', '1', '12', 2)
INSERT INTO ItemOptions#TEMP (ItemCode, LotNumber, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('itCode5', '1', '1', 'title1', 'option1')
INSERT INTO ItemOptions#TEMP (ItemCode, LotNumber, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('itCode5', '1', '2', 'title2', 'option2')
INSERT INTO ItemOptions#TEMP (ItemCode, LotNumber, ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('itCode5', '1', '3', 'title3', 'option3')
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationSeq, SpecificationName, SpecificationValue) VALUES ('itCode5', '1', '1', 'specname1', 'specvalue1')
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationSeq, SpecificationName, SpecificationValue) VALUES ('itCode5', '1', '2', 'specname2', 'specvalue2')
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationSeq, SpecificationName, SpecificationValue) VALUES ('itCode5', '1', '3', 'specname3', 'specvalue3')
INSERT INTO InventoryChoices#TEMP (ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('M', 'Green', 5)
INSERT INTO InventoryChoices#TEMP (ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('S', 'Green', 2)
INSERT INTO InventoryChoices#TEMP (ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('M', 'Red', 4)
INSERT INTO InventoryChoices#TEMP (ChoicesHorizontalCode, ChoicesVerticalCode, ChoicesCount) VALUES ('S', 'Red', 0)
INSERT INTO InventoryVerticalChoices#TEMP (ChoicesVerticalCode, ChoicesVerticalName, ChoicesVerticalSeq) VALUES ('Red', 'Red', 1)
INSERT INTO InventoryVerticalChoices#TEMP (ChoicesVerticalCode, ChoicesVerticalName, ChoicesVerticalSeq) VALUES ('Green', 'Green', 2)
INSERT INTO InventoryHorizontalChoices#TEMP (ChoicesHorizontalCode, ChoicesHorizontalName, ChoicesHorizontalSeq) VALUES ('S', 'S', 1)
INSERT INTO InventoryHorizontalChoices#TEMP (ChoicesHorizontalCode, ChoicesHorizontalName, ChoicesHorizontalSeq) VALUES ('M', 'M', 2) ;
INSERT INTO Inventory#TEMP ( StockSegment, InventoryChoices, InventoryVerticalChoices, InventoryHorizontalChoices, ChoicesStockVerticalItemName, ChoicesStockHorizontalItemName ) VALUES ('2', 'InventoryChoices#TEMP', 'InventoryVerticalChoices#TEMP', 'InventoryHorizontalChoices#TEMP', 'Color', 'Size')
INSERT INTO Items (ItemCode, LotNumber, ItemName, ItemOptions, ItemSpecifications, ItemPrice, TaxSegment, PostageSegment, Postage, CategoryId, SaleStatus, ItemDeliveries, ItemDeliveryMethods, description, Inventory) VALUES ('itCode5', '1', 'name', 'ItemOptions#TEMP', 'ItemSpecifications#TEMP', 2345, 1, 1, '', 37020203, 1, 'ItemDeliveries#TEMP', 'ItemDeliveryMethods#TEMP', 'desc', 'Inventory#TEMP' )
au PAY Market allows UPDATEs for all columns that are not readonly. ItemCode is required. The values for linked subtables can be specified as aggregated data or taken from temporary tables.
UPDATE Items SET ItemName = 'name', ItemOptions = 'ItemOptions#TEMP', ItemSpecifications = 'ItemSpecifications#TEMP', ItemPrice = 2345, ItemDeliveries = 'ItemDeliveries#TEMP', ItemDeliveryMethods = 'ItemDeliveryMethods#TEMP', description = 'Desc', Inventory = 'Inventory#TEMP' WHERE ItemCode = 'itCode5'
au PAY Market allows UPDATEs in batches for all columns that are not readonly except ItemSpecifications, ItemOptions, ItemOptionCommissions, ItemImages, ItemDeliveries, ItemDeliveryMethods, Inventory. ItemCode is required.
INSERT INTO Items#TEMP (ItemCode, ItemName, SearchKeywords, PointRate) VALUES ('MD001', 'name1', '<searchKeywords><searchKeyword>abc</searchKeyword><searchKeywordSeq>1</searchKeywordSeq></searchKeywords><searchKeywords><searchKeyword>test</searchKeyword> <searchKeywordSeq>2</searchKeywordSeq></searchKeywords><searchKeywords><searchKeyword>lolo</searchKeyword> <searchKeywordSeq>3</searchKeywordSeq></searchKeywords>', 1)
INSERT INTO Items#TEMP (ItemCode, ItemName, SearchKeywords, PointRate) VALUES ('Code0001', 'name2', '<searchKeywords><searchKeyword>abc</searchKeyword><searchKeywordSeq>1</searchKeywordSeq></searchKeywords><searchKeywords><searchKeyword>test</searchKeyword> <searchKeywordSeq>2</searchKeywordSeq></searchKeywords><searchKeywords><searchKeyword>lolo</searchKeyword><searchKeywordSeq>3</searchKeywordSeq></searchKeywords>', 1)
Update Items (ItemCode, ItemName, SearchKeywords, PointRate) SELECT ItemCode, ItemName, SearchKeywords, PointRate FROM Items#TEMP
To delete items singlularly, provide the ItemCode and/or LotNumber
DELETE FROM Items WHERE ItemCode = 'itemCode' AND LotNumber = '123'
To delete items in batches, provide the ItemCode and/or LotNumber
Insert INTO Items#TEMP (ItemCode) VALUES ('it1')
INSERT INTO Items#TEMP (ItemCode) VALUES ('it2')
INSERT INTO Items#TEMP (ItemCode) VALUES ('it3')
INSERT INTO Items#TEMP (LotNumber) VALUES ('lot1')
INSERT INTO Items#TEMP (ItemCode, LotNumber) VALUES ('it4', 'lot4')
INSERT INTO Items#TEMP (ItemCode, LotNumber) VALUES ('it5', 'lot5')
INSERT INTO Items#TEMP (ItemCode, LotNumber) VALUES ('MD001', '9808451')
INSERT INTO Items#TEMP (ItemCode, LotNumber) VALUES ('MD002', '9808452')
INSERT INTO Items#TEMP (ItemCode, LotNumber) VALUES ('MD003', '9808453')
DELETE FROM Items WHERE EXISTS (SELECT LotNumber, ItemCode FROM Items#TEMP)
| Name | Type | ReadOnly | References | Description |
| ItemCode [KEY] | String | False |
Product code. | |
| LotNumber | Long | False |
Lot number. | |
| ItemName | String | False |
Product name. | |
| ItemManagementId | String | False |
Product id for management. | |
| ItemManagementName | String | False |
Product name for management. | |
| ItemPrice | Decimal | False |
Selling price. | |
| SellMethodSegment | Integer | False |
Sales methods. 1: Normal sale 2: Reservation sale. 使用できる値は次のとおりです。1, 2 | |
| ReleaseDate | Date | False |
Selling date. | |
| ReserveRegistrationDate | Date | True |
Registration Date. | |
| MakerRetailPrice | Decimal | False |
Manufacturer suggested retail price | |
| MakerRetailPriceUrl | String | False |
Manufacturer suggested retail price URL | |
| TaxSegment | Integer | False |
Tax consumtion. 使用できる値は次のとおりです。1, 2, 3 | |
| ReducedTax | Integer | False |
Reduced tax rate setting. 使用できる値は次のとおりです。1, 2 | |
| PostageSegment | String | False |
Shipping classification. | |
| Postage | String | False |
Extra Shipping. | |
| SellStartDate | Datetime | False |
Sales start date and time. | |
| SellEndDate | Datetime | False |
End of sale date. | |
| CountdownTimerConfig | Integer | False |
Reduced tax rate setting. 使用できる値は次のとおりです。1, 2 | |
| SellNumberDispConfig | Integer | False |
Reduced tax rate setting. 使用できる値は次のとおりです。1, 2 | |
| BuyNumLimtConfig | Integer | False |
Reduced tax rate setting. 使用できる値は次のとおりです。1, 2 | |
| BuyNumMax | Integer | False |
Reduced tax rate setting. 使用できる値は次のとおりです。1, 2 | |
| PublicStartDate | Datetime | True |
Publication date and time information. | |
| LimitedOrderSegment | String | False |
The maximum purchase settings category. | |
| LimitedOrderCount | Integer | False |
The maximum purchase count. | |
| Description | String | False |
Product Description. | |
| DescriptionForSP | String | False |
Product description for SP. | |
| DescriptionForPC | String | False |
Product description for PC. | |
| DetailTitle | String | False |
Item details title. | |
| DetailDescription | String | False |
Item details description. | |
| SearchKeywords | String | False |
Search keywords related to the item. | |
| CategoryId | String | True |
Category ID. | |
| CategoryName | String | True |
Category name. | |
| Tags | String | False |
Search tags related to the item. | |
| Jan | String | False |
JAN code. | |
| Isbn | String | False |
ISBN code. | |
| ItemModel | String | False |
Model number. | |
| LimitedPassword | String | False |
Password restrictions setting entry field. | |
| LimitedPasswordPageTitle | String | False |
Password restrictions page title. | |
| LimitedPasswordPageMessage | String | False |
Password restrictions page message. | |
| SaleStatus | String | False |
Sale status. | |
| PointRate | Integer | False |
Point magnification. | |
| FavoriteCount | Integer | True |
My favorite number. | |
| ReceiptRequestCount | Integer | True |
Stock count requested. | |
| StockRequestConfig | Integer | False |
Incoming request settings. 使用できる値は次のとおりです。1, 2 | |
| ReturnRequestConfig | Integer | False |
Return application. 使用できる値は次のとおりです。1, 2 | |
| StockRequestCount | Integer | False |
Number of arrival requests. | |
| DeliveryLeadtimeId | String | False |
Delivery lead time ID. | |
| ItemSpecifications | String | False |
Aggregated data for item specifications. Readable data found at sub-table with the same name. | |
| ItemOptions | String | False |
Aggregated data for item options. Readable data found at sub-table with the same name. | |
| ItemOptionCommissions | String | False |
Aggregated data for item option commissions. Readable data found at sub-table with the same name. | |
| ItemImages | String | False |
Aggregated data for item images. Readable data found at sub-table with the same name. | |
| ItemDeliveries | String | False |
Aggregated data for item deliveries. Readable data found at sub-table with the same name. | |
| ItemDeliveryMethods | String | False |
Aggregated data for item delivery methods. Readable data found at sub-table with the same name. | |
| Inventory | String | False |
Aggregated data for item stock information. Readable data found at sub-table with the same name. | |
| ShopId | String | False |
Store account. | |
| EGiftProductFlg | String | True |
0: Not possible, 1: Possible If there is no specification, 0: Not possible will be applied. *Available only at specified stores. | |
| ItemOptionReqFlg | String | True |
1: Required, 0: Not required. If not specified, 1:Required will be applied. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| StockCount | Integer |
Number of items in stock. |
| HasTags | Integer |
The presence or absence of tags 1: No tags set 2: Tags have been set. 使用できる値は次のとおりです。1, 2 |
| DeliveryId | String |
Identifier of the item delivery. |
| DeliveryMethodId | String |
Identifier of the item delivery method |
Retrieve and update information related to item specifications.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM ItemImages WHERE ItemCode LIKE '%CD00%'
SELECT * FROM ItemImages WHERE ItemCode = 'CD001' AND LotNumber = 123543
All columns can be specified. ItemCode, SpecificationSeq are required for an insert.
INSERT INTO ItemSpecifications (ItemCode, LotNumber, SpecificationName, Specificationseq) VALUES ('MD001', '9808450', 'M', 1)
All columns can be specified. ItemCode, SpecificationSeq are required.
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationName, SpecificationValue, SpecificationSeq) VALUES ('MD001', '9808450', 'TESTtt 1', 'val1', 1)
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationName, SpecificationValue, SpecificationSeq) VALUES ('MD001', '9808450', 'i dyti ', 'val2', 2) ;
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationName, SpecificationValue, SpecificationSeq) VALUES ('MD001', '9808450', 'er', 'val3', 3)
INSERT INTO ItemSpecifications SELECT ItemCode, LotNumber, ImageId, SpecificationSeq FROM ItemSpecifications#TEMP
au PAY Market allows updates for all columns. ItemCode, SpecificationSeq are required.
UPDATE ItemSpecifications SET SpecificationName = 'M', Specificationseq = 1 WHERE ItemCode = 'MD001' AND LotNumber = 9808450
au PAY Market allows updates in batches for all columns. ItemCode, SpecificationSeq are required.
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationName, SpecificationValue, SpecificationSeq) VALUES ('MD001', '9808450', 'TESTtt 1', 'val1', 1)
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationName, SpecificationValue, SpecificationSeq) VALUES ('MD001', '9808450', 'i dyti ', 'val2', 2) ;
INSERT INTO ItemSpecifications#TEMP (ItemCode, LotNumber, SpecificationName, SpecificationValue, SpecificationSeq) VALUES ('MD001', '9808450', 'er', 'val3', 3)
UPDATE ItemSpecifications SET (ItemCode, LotNumber, SpecificationName, SpecificationValue, SpecificationSeq ) SELECT ItemCode, LotNumber, SpecificationName, SpecificationValue, SpecificationSeq FROM ItemSpecifications#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| ItemCode [KEY] | String | False |
Items.ItemCode |
Product code. |
| LotNumber | Long | False |
Items.LotNumber |
Lot number. |
| SpecificationTitle | String | True |
Specification title. | |
| SpecificationSeq [KEY] | String | False |
Specification item sequence. | |
| SpecificationName | String | False |
Specification name. | |
| SpecificationValue | String | False |
Specification value. | |
| ShopId | String | False |
Store account. |
Retrieve information related to order items.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM OrderItems WHERE OrderId = 1234
SELECT * FROM OrderItems WHERE OrderDate > '2018/12/13' AND OrderDate < '2019/12/13'
SELECT * FROM OrderItems WHERE ItemManagementId LIKE 'manage id' AND ItemName LIKE 'name' AND OrderDate = '01/01/2019'
Insert is not supported for this table
au PAY Market allows updates for the ItemPrice, Unit columns. OrderId and OrderItemId are required.
UPDATE OrderItems SET ItemPrice = 123, Unit = 12 WHERE OrderId = 12345 AND OrderItemId = 123456
au PAY Market allows batch updates for the ItemPrice, Unit columns. OrderId and OrderItemId are required.
INSERT INTO OrderItems#TEMP (Unit, OrderItemId, OrderId) VALUES (12, 211700, 211700)
INSERT INTO OrderItems#TEMP (Unit, OrderItemId, OrderId) VALUES (13, 211701, 211700)
INSERT INTO OrderItems#TEMP (Unit, OrderItemId, OrderId) VALUES (14, 211702, 211700)
UPDATE OrderItems SET (Unit, OrderItemId, OrderId) SELECT Unit, OrderItemId, OrderId FROM OrderItems#TEMP
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| OrderId [KEY] | Long | False |
Orders.OrderId |
Order Id. |
| OrderItemId [KEY] | Long | False |
Order item Id. | |
| OrderDate | Datetime | True |
Order date. | |
| ItemManagementId | String | True |
Administrative id. | |
| ItemCode | String | True |
Item code. | |
| LotNumber | Long | True |
Lot number. | |
| ItemName | String | True |
Product name. | |
| ItemOption | String | True |
Item option information the buyer has selected. | |
| ItemCancelStatus | String | True |
Cancellation status. N = Sold C = Cancelled. | |
| BeforeDiscount | Decimal | True |
Itemm price before discount. | |
| Discount | Decimal | True |
Applied discount. | |
| ItemPrice | Decimal | False |
Item price. | |
| Unit | Integer | False |
Number of ordered units. | |
| TotalItemPrice | Decimal | True |
Total item price. | |
| TaxType | String | True |
Commodity tax classification that has been registered at the time of exhibition. N = No tax, I = Tax included, E = Outside tax. | |
| ReducedTax | String | True |
Reduced tax rate setting. | |
| TaxRate | String | True |
Sales tax rate. | |
| GiftPoint | Long | True |
The number of points granted to the purchaser in the order. | |
| ShippingDayDisplayText | String | True |
Shipping day information. | |
| ShippingTimelimitDate | Date | True |
Shipping deadline. | |
| ShopId | String | True |
Store account. |
Retrieve and query information related to orders.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM Orders WHERE OrderId = 1234
SELECT * FROM Orders WHERE OrderDate > '2018/12/13' AND OrderDate < '2019/12/13'
SELECT * FROM Orders WHERE MailAddress LIKE 'address' AND OrdererName LIKE 'name' AND OrdererKana LIKE 'kana' AND OrdererPhoneNumber1 LIKE '123456789' AND SenderName LIKE 'sender name' AND SenderKana LIKE 'sender kana' AND SenderPhoneNumber1 LIKE '123456789'
SELECT * FROM Orders WHERE SellMethodSegment = 1 AND DeliveryId = 1 AND DeliveryMethodId = 'method id' AND Nickname = 'nickname' AND LotNumber = 12345 AND ItemManagementId = 'manage id' AND ItemCode = 'CD001' AND ItemName = 'item name' AND SettlementId = 'settle id' AND CardStatus = 'NL' AND AtmStatus = 'ND' AND NetBankingStatus = 'WT' AND CarrerStatus = 'NR' AND AuPaymentStatus = 'we' AND CvsStatus = 'ED' AND CvsExpire = 12 AND Device = 'P' AND HasUsePoint = 2 AND HasCoupon = 2 AND GiftPointStatus = 1 AND GetRawMailAddress = 1 AND IsWowmaMember = 1
SELECT * FROM Orders WHERE DeliveryRequestDay IS NULL AND Memo IS NOT NULL AND UserComment IS NULL AND OrderDate = '01/01/2019'
Insert is not supported for this table
au PAY Market allows updates for the OrdererPhoneNumber1, OrderDate, ReleaseDate, OrdererName, OrdererKana, OrdererZipCode, OrdererAddress, OrdererPhoneNumber2, SenderName, SenderKana, SenderZipCode, SenderAddress, SenderPhoneNumber1, SenderPhoneNumber2, SenderShopCode, SettlementName, Memo, PostagePrice, ChargePrice, DeliveryMethodId, DeliveryId, DeliveryRequestTime, ShippingDate, ShippingCarrier, ShippingNumber, OrderItems columns. OrderId is required.
UPDATE Orders SET OrdererPhoneNumber1 = '090-1111-2223', OrderDate = '2019-01-15', ReleaseDate = '2019/01/15', OrdererName = 'orderer name', OrdererKana = 'orderer kana', OrdererZipCode = '192-0002', OrdererAddress = 'orderer address', OrdererPhoneNumber2 = '3462256264', SenderName = 'sender name', SenderKana = 'sender phonetic', SenderZipCode = '192-0002', SenderAddress = 'address', SenderPhoneNumber1 = '24624621-2222', SenderPhoneNumber2 = '24665226', SenderShopCode = '123', SettlementName = 'settle name', Memo = 'THE MEMO', PostagePrice = 0, ChargePrice = 0, DeliveryMethodId = '234', DeliveryId = 'id', DeliveryRequestTime = 'morning', ShippingDate = '2018-05-04', ShippingCarrier = 'the carrier', ShippingNumber = '1234' WHERE OrderId = 12345
OrderItems column contains information on the OrderItems subtable. This field can be updated as an aggregate, or by using temporary tables.
UPDATE Orders SET OrderItems = '<detail> <orderDetailId>211700</orderDetailId> <unit>12</unit> </detail> <detail> <orderDetailId>211701</orderDetailId> <unit>13</unit> </detail> <detail> <orderDetailId>211702</orderDetailId> <unit>14</unit> </detail>' WHERE OrderId = 12345
INSERT INTO OrderItems#TEMP (Unit, OrderItemId) VALUES (12, 211700)
INSERT INTO OrderItems#TEMP (Unit, OrderItemId, OrderId) VALUES (13, 211701, 12345)
INSERT INTO OrderItems#TEMP (Unit, OrderItemId, OrderId) VALUES (14, 211702, 12345)
UPDATE Orders SET OrderItems = 'OrderItems#TEMP' WHERE OrderId = 12345
Delete is not supported for this table
| Name | Type | ReadOnly | References | Description |
| OrderId [KEY] | Long | False |
Order Id. | |
| OrderDate | Datetime | False |
Date of the order. | |
| OrderStatus | String | True |
Order status. New acceptance, before shipping, payment waiting for credit, waiting ships, waiting ships after a payment, waiting completion, pending, cancellation, various custom statuses. (Possible status names have been registered by Takashi store in the sales order management). | |
| SellMethodSegment | Integer | True |
Sales methods. : Normal sale 2: Reservation sale. | |
| ReleaseDate | Date | False |
Order release date. | |
| SiteAndDevice | String | True |
Purchased the site name (Wowma! / Wowma! For au) and device type (PC / SP / KT). | |
| MailAddress | String | True |
Order mail address. | |
| OrdererName | String | False |
Name of the orderer. | |
| OrdererKana | String | False |
Phonetic name of the orderer. | |
| OrdererZipCode | String | False |
Zip code of the orderer. | |
| OrdererAddress | String | False |
Address of the orderer. | |
| OrdererPhoneNumber1 | String | False |
Phone number of the orderer. | |
| OrdererPhoneNumber2 | String | False |
Second phone number of the orderer. | |
| Nickname | String | True |
This is blank for non-members at the time of purchase. | |
| SenderName | String | False |
Name of the sender. | |
| SenderKana | String | False |
Phonetic name of the sender. | |
| SenderZipCode | String | False |
Zip code of the sender. | |
| SenderAddress | String | False |
Address of the sender. | |
| SenderPhoneNumber1 | String | False |
Phone number of the sender. | |
| SenderPhoneNumber2 | String | False |
Second phone number of the sender. | |
| SenderShopCode | String | False |
Sender shop code. | |
| OrderOption | String | True |
Order option. | |
| SettlementName | String | False |
Name of the settlement. Bank transfer, postal transfer, cash on delivery, credit card settlement, etc. | |
| UserComment | String | True |
Comments the user leaves for the order. | |
| Memo | String | False |
Memo user leaves for the order. | |
| ContactStatus | String | True |
Indicating whether the e-mail has been sent. Y: done N: pending | |
| ContactDate | Datetime | True |
Date that the e-mail was sent. | |
| AuthorizationStatus | String | True |
Indicating whether credit has already been authorized. Y: done N: pending | |
| AuthorizationDate | Datetime | True |
Date the credit authorization. | |
| PaymentStatus | String | True |
Indicating whether a payment has already been done. Y: done N: pending | |
| PaymentDate | Datetime | True |
Payment date. | |
| ShipStatus | String | True |
Indicating whether shipping has already been processed. Y: done N: pending | |
| ShipDate | Datetime | True |
Date the item will be shipped. | |
| PrintStatus | String | True |
Indicating whether the invoice has already been printed. Y: done N: pending | |
| PrintDate | Datetime | True |
The date the invoice has been printed. | |
| CancelStatus | String | True |
Cancellation status. N = Sold, C = Cancel | |
| CancelReason | Integer | True |
Cancellation reason. 1: No Contact (purchaser), 2: Absence of return (purchaser), 3: Refusal (purchaser), 4: Payment deadline over (purchaser), 5: Card settlement examination not possible (purchaser), 6: Others (purchaser), 7: Settlement method change (store), 8: Missing item (store), 9: Other (store) | |
| CancelComment | String | True |
Cancellation comments. | |
| TotalSalePrice | Decimal | True |
The sum of the contract prices from the order. | |
| TotalSalePriceNormalTax | Long | True |
[Breakdown] Total sales (10%) | |
| TotalSalePriceReducedTax | Long | True |
[Breakdown] Total sales (8%) | |
| TotalSalePriceNoTax | Long | True |
[Breakdown] Total sales (0%) | |
| TotalSaleUnit | Integer | True |
The sum of the contract prices from the number of items sold. | |
| PostagePrice | Decimal | False |
Price of the postage. | |
| PostagePriceTaxRate | String | True |
Postage tax rate | |
| ChargePrice | Decimal | False |
Charge price. | |
| ChargePriceTaxRate | String | True |
Fee tax rate | |
| TotalItemOptionPrice | Decimal | True |
Option fee (total) | |
| TotalItemOptionPriceTaxRate | String | True |
Option fee (total) tax rate | |
| TotalGiftWrappingPrice | Decimal | True |
Gift fee (total) | |
| TotalGiftWrappingPriceTaxRate | String | True |
Gift fee (total) tax rate | |
| TotalPrice | Decimal | True |
The sum of the total sales concluded in the same cart, adding consumption tax, commission and postage. | |
| TotalPriceNormalTax | Long | True |
[Breakdown] Subtotal billing amount (10%) | |
| TotalPriceReducedTax | Long | True |
[Breakdown] Subtotal billing amount (8%) | |
| TotalPriceNoTax | Long | True |
[Breakdown] Subtotal billing amount (0%) | |
| PremiumType | String | True |
Ponta Pass Premium Award Program application categories | |
| PremiumIssuePrice | Decimal | True |
Ponta Pass Premium Benefit Program application amount | |
| PremiumMallPrice | Decimal | True |
Mall burden postage | |
| PremiumShopPrice | Decimal | True |
Store burden postage | |
| CouponTotalPrice | Decimal | True |
The total price of coupons. | |
| CouponTotalPriceNormalTax | Long | True |
[Breakdown] Coupon usage (10%) | |
| CouponTotalPriceReducedTax | Long | True |
[Breakdown] Coupon usage (8%) | |
| CouponTotalPriceNoTax | Long | True |
[Breakdown] Coupon usage (0%) | |
| UsePoint | Long | True |
Points used. | |
| UsePointNormalTax | Long | True |
[Breakdown] Points used (10%) | |
| UsePointReducedTax | Long | True |
[Breakdown] Points used (8%) | |
| UsePointNoTax | Long | True |
[Breakdown] Points used (0%) | |
| UsePointCancel | String | True |
Indicator of use-point cancellation. Y = use point cancellation, N = Use point without cancellation, null = No points available. | |
| UseAuPointPrice | Long | True |
Price of using AuPoint. | |
| UseAuPointPriceNormalTax | Long | True |
[Breakdown] Usage of au points and au WALLET points (including au Wowma!) (10%) | |
| UseAuPointPriceReducedTax | Long | True |
[Breakdown] Usage of au points and au WALLET points (including au Wowma!) (8%) | |
| UseAuPointPriceNoTax | Long | True |
[Breakdown] Usage of au points and au WALLET points (including au Wowma!) (0%) | |
| UseAuPoint | Long | True |
Indicator of the use of AuPoint. | |
| UseAuPointCancel | String | True |
Indicator of the use of AuPoint cancellation. | |
| RequestPrice | Decimal | True |
Requested price. | |
| RequestPriceNormalTax | Long | True |
[Breakdown] Billing amount (10%) | |
| RequestPriceReducedTax | Long | True |
[Breakdown] Billing amount (8%) | |
| RequestPriceNoTax | Long | True |
[Breakdown] Billing amount (0%) | |
| PointFixedDate | Date | True |
Fixed date if the order has not been finalized. | |
| PointFixedStatus | String | True |
Point fixed date status. Y = definite, N = undetermined, null = No points given | |
| SettleStatus | String | True |
Credit card settlement. NL: Not Credit AD: Credit success TD: Sales success AE: Credit failed TE: Sale Failure CD: Settlement cancel , convenience store settlement, NL: Billing information has not been acquired ED: Claim waiting ND: Awaiting payment EX: Payment expired CD: Paid TC: Payment Stop, ATM settlement, NL: Billing information has not been acquired ED: Blaim waiting ND: Awaiting payment EX: Payment expired CD: Paid TC: Payment Stop , bank net banking settlement, NL: Claim waiting ND: aAaiting payment WT: Payment Checking CD: Paid TC: Payment Stop , carrier settlement (docomo Mobile payment / au simple settlement / Softbank collectively payment), NR: Billable outside the UC: Checking AD: Provisional billing CD: Billing cancel ER: The settlement process fails TD: Settlement processing completion , collectively au payment, NR: Billable outside TS: Provisional billing TC: Billing cancel ER: The settlement process fails TD: Settlement process is completed. | |
| AuthoriTimelimitDate | String | True |
Credit Date + payment processing period of each settlement method (according to the settlement method). | |
| PageantResult | Integer | True |
0: Success 1: Failure | |
| PageantResponseCode | String | True |
Response code that is returned from the Pageant | |
| PageantResponseDetail | String | True |
Response code is returned from the Pageant Details | |
| PageantOrderId | String | True |
ID to put string the order information of the settlement information and the mall side. | |
| PageantRequestPrice | Decimal | True |
Amount of money that was charged from the purchaser in the settlement. | |
| PageantRequestPriceNormalTax | Long | True |
[Breakdown] Settlement charge amount (10%) | |
| PageantRequestPriceReducedTax | Long | True |
[Breakdown] Amount charged for settlement (8%) | |
| PageantRequestPriceNoTax | Long | True |
[Breakdown] Settlement charge amount (0%) | |
| CouponType | String | True |
Funds type of coupon which was used at the time of purchase. | |
| CouponKey | String | True |
Unique string that indicates the type of coupon which was used at the time of purchase. | |
| CardJudgement | String | True |
Value indicating the result of the examination from the order information at the time of purchase. 1 = Examination completed, fraud likelihood is low, 2 = Examination completed, fraud likelihood is high, 3 = Examination completed, suspicious points, 0 = system error, null = examination excluded. | |
| DeliveryName | String | True |
Delivery name. Mail, courier, cool flight, a small courier, large courier, convenience store receipt, over-the-counter receipt, other (delivery method name Takashi store has registered at the store). | |
| DeliveryMethodId | String | False |
Delivery method ID that Takashi store has registered at the store building. | |
| DeliveryId | String | False |
Delivery id. M: mail T: courier | |
| DeliveryRequestDay | Date | False |
Requested day of the delivery. | |
| DeliveryRequestTime | String | False |
Requested time of the delivery. | |
| ShippingDate | Date | False |
Shipping date. | |
| ShippingCarrier | Integer | False |
Shipping carrier. 1: Black cat Yamato, 2: Sagawa Express, 3: JP Express (formerly Nippon Express), 4: Fukuyama Transporting, 5: Seino Transportation, 6: Japan Post, 7: Rakuten EXPRESS | |
| ShippingNumber | String | False |
Shipping number. | |
| YamatoLnkMgtNo | String | True |
In B2 cloud of Yamato Transport, number required when capturing a convenience store receipt of order data. | |
| OrderItems | String | False |
Aggregated data for inventory choices. Readable data found at sub-table with the same name. | |
| ShopId | String | False |
Store account. | |
| ElecReceiptIssueStatus | Integer | False |
Elec Receipt Issue Status | |
| ElecReceiptIssueTimes | Integer | False |
Elec Receipt Issue Times | |
| EGiftTradeFlg | Integer | True |
EGift Trade Flag. | |
| PontaPassCampaignApplyFlg | String | True |
0: Not applicable 1: Target |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| LotNumber | Long |
Lot number. |
| ItemManagementId | String |
Administration id. |
| ItemCode | String |
Item code in the order items. |
| ItemName | String |
Item name. |
| SettlementId | String |
Settlement id. |
| CardStatus | String |
Card settlement status. 使用できる値は次のとおりです。NL, AD, TD, AE, TE, CD |
| AtmStatus | String |
Atm settlement status. 使用できる値は次のとおりです。NL, ED, ND, EX, CD, TC |
| NetBankingStatus | String |
Net banking settlement status. 使用できる値は次のとおりです。NL, ND, WT, CD, TC |
| CarrerStatus | String |
Carrer settlement status. 使用できる値は次のとおりです。NR, AD, CD, ER, TD |
| AuPaymentStatus | String |
Au payment settlement status. 使用できる値は次のとおりです。NR, TS, TC, ER, TD |
| CvsStatus | String |
Cvs settlement status. 使用できる値は次のとおりです。NL, ED, ND, EX, CD |
| CvsExpire | Integer |
Csv expiration. |
| Device | String |
Device type. P: PC K: mobile S: smartphone 使用できる値は次のとおりです。P, K, S |
| HasUsePoint | Integer |
Integer filtering by use points availability. 0: No use points 1: Existing 2: Pre-cancellation. 使用できる値は次のとおりです。0, 1, 2 |
| HasCoupon | Integer |
0: No 1: There are 2: pre-cancellation 使用できる値は次のとおりです。0, 1, 2 |
| GiftPointStatus | Integer |
0: undefined 1: confirmed 使用できる値は次のとおりです。0, 1 |
| GetRawMailAddress | Integer |
0: do not get 1: get 使用できる値は次のとおりです。0, 1 |
| IsWowmaMember | Integer |
0: undefined 1: confirmed 使用できる値は次のとおりです。0, 1 |
| EGiftTrade | String |
0: Orders not eligible, 1: Orders eligible for gifts for anyone. *Available only at specified stores |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| InventoryVerticalChoices | Retrieve information related to inventory vertical choices. |
| ItemOptionComissions | Retrieve information related to item option commissions. |
| ItemOptionComissionValues | Retrieve information related to item option commission values. |
| OrderItemOptionComissions | Retrieve information related to item option commissions. |
| OrderItemOptionComissionValues | Retrieve information related to item option commission values. |
Retrieve information related to inventory vertical choices.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM InventoryVerticalChoices WHERE ItemCode LIKE 'CD001'
SELECT * FROM InventoryVerticalChoices WHERE LotNumber = 1234455 AND ShopId = '123'
| Name | Type | References | Description |
| LotNumber | Long |
Inventory.ItemCode | Lot number. |
| ItemCode [KEY] | String |
Inventory.LotNumber | Product code. |
| ChoicesStockVerticalItemName | String | Choices by stock vertical axis item name. | |
| ChoicesVerticalCode [KEY] | String | Vertical choice code. | |
| ChoicesVerticalName | String | Vertical choice name. | |
| ChoicesVerticalSeq | String | Vertical choice sequesnce. | |
| ShopId | String | Store account. |
Retrieve information related to item option commissions.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM ItemOptionComissions WHERE ItemCode LIKE '%CD00%'
SELECT * FROM ItemOptionComissions WHERE ItemCode = 'CD001' AND LotNumber = 123543
| Name | Type | References | Description |
| ItemCode [KEY] | String |
Items.ItemCode | Product code. |
| LotNumber | Long |
Items.LotNumber | Lot number. |
| ItemOptionCommissionSeq [KEY] | String | Item option commission sequence. | |
| ItemOptionCommissionTitle | String | Item option commission title. | |
| ItemOptionCommissionNote | String | Item option commission note. | |
| ShopId | String | Store account. |
Retrieve information related to item option commission values.
The Sync App will use the au PAY Market API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.
SELECT * FROM ItemOptionComissionValues WHERE ItemCode LIKE '%CD00%'
SELECT * FROM ItemOptionComissionValues WHERE ItemCode = 'CD001' AND LotNumber = 123543
| Name | Type | References | Description |
| LotNumber | Long |
ItemOptionComissions.LotNumber | Lot number. |
| ItemCode [KEY] | String |
ItemOptionComissions.ItemCode | Product code. |
| ItemOptionCommissionSeq [KEY] | String |
ItemOptionComissions.ItemOptionCommissionSeq | Item option commission sequence. |
| ItemOptionCommissionValSeq [KEY] | String | Item option commission value sequence. | |
| ItemOptionCommissionVal | String | Item option commission value. | |
| ItemOptionCommissionPrice | Decimal | Item option commission price. | |
| ShopId | String | Store account. |
Retrieve information related to item option commissions.
| Name | Type | References | Description |
| OrderId [KEY] | Long |
Orders.OrderId | Order Id. |
| OrderItemId [KEY] | Long | Order item Id. | |
| OrderDate | Datetime | Order date. | |
| ItemOptionCommissionSeq [KEY] | String | Item option commission sequence. | |
| ItemOptionCommissionTitle | String | Item option commission title. | |
| ShopId | String | Store account. |
Retrieve information related to item option commission values.
| Name | Type | References | Description |
| OrderItemId [KEY] | Long | Order item Id. | |
| OrderDate | Datetime | Order date. | |
| ItemOptionCommissionSeq [KEY] | String |
ItemOptionComissions.ItemOptionCommissionSeq | Item option commission sequence. |
| ItemOptionCommissionValSeq [KEY] | String | Item option commission value sequence. | |
| ItemOptionCommissionVal | String | Item option commission value. | |
| ItemOptionCommissionPrice | Decimal | Item option commission price. | |
| ShopId | String | Store account. |
| プロパティ | 説明 |
| APIKey | Api Key you get from your au PAY Market store account. |
| ShopId | Store account ID of your au PAY Market store. |
| UseSandbox | Specify if you are connecting to a test environment or a production account. Defaults to FALSE. |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| APIKey | Api Key you get from your au PAY Market store account. |
| ShopId | Store account ID of your au PAY Market store. |
| UseSandbox | Specify if you are connecting to a test environment or a production account. Defaults to FALSE. |
Api Key you get from your au PAY Market store account.
Api Key you get from your au PAY Market store account.
Store account ID of your au PAY Market store.
Store account ID of your au PAY Market store.
Specify if you are connecting to a test environment or a production account. Defaults to FALSE.
The property will default to FALSE, in case you are connection to a test environment, set this to TRUE.
このセクションでは、本プロバイダーの接続文字列で設定可能な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 | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がau PAY Market への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がau PAY Market への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がau PAY Market にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\auPAYMarket Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Items WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。