Adding a Connection to au PAY Market

To add a connection to au PAY Market:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the au PAY Market icon is not available, click the Add More icon to download and install the au PAY Market connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to au PAY Market

When using the CData Sync App to connect to au PAY Market, ShopId and ApiKey are required.

Configure Access to au PAY Market

To obtain the ShopId and ApiKey, follow the steps below:

• Log in to Wow! magener site and go to "Apply for Using API" in the "Various Applications" menu.
• Agree to the "API Terms of Use".
• Click "Here to Issue API key" button.
• Click "Issue" button to generate the API key.
• Enter an appropriate IP address in "Register Source IP Address".
• Click "Register" button to save the settings.

Authenticate to au PAY Market Account

Set the following connection properties to connect:

• ShopId: Set the au PAY Market Shop ID of the connection destination.
• ApiKey: Set the Api key. Api Key you get from your au PAY Market store account.
• UseSandbox: Set to true when connecting to Sandbox.

This section details a selection of advanced features of the au PAY Market Sync App.

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

See Query Processing for more information.

Logging

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

Customizing the SSL Configuration

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

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

Connecting Through a Firewall or Proxy

HTTP Proxies

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

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

Other Proxies

Set the following properties:

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

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

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

The Sync App models the data in au PAY Market as a list of tables in a relational database that can be queried using standard SQL statements.

au PAY Market Connector for CData Sync Tables

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• StockCount column supports the =,<,<=,>,>= operators.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

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

Insert is not supported for this table

Update

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

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM InventoryChoices WHERE ItemCode LIKE 'CD001'

SELECT * FROM InventoryChoices WHERE LotNumber  = 1234455 AND ShopId = '123'

Insert

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') 

Batch Insert

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

Update

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'

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM InventoryHorizontalChoices WHERE ItemCode LIKE 'CD001'

SELECT * FROM InventoryHorizontalChoices WHERE LotNumber  = 1234455 AND ShopId = '123'

Insert

Insert is not supported from for this table

Update

au PAY Market allows updates for ChoicesHorizontalName column. ItemCode and ChoicesHorizontalCode are required.

UPDATE InventoryHorizontalChoices SET ChoicesHorizontalName = 'Mm' WHERE ItemCode = 'CD001' AND ChoicesHorizontalCode = 'M'

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM ItemDeliveries WHERE ItemCode LIKE '%CD00%'

SELECT * FROM ItemDeliveries WHERE ItemCode = 'CD001' AND LotNumber = 123543 

Insert

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) 

Batch Insert

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

Update

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

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM ItemDeliveryMethods WHERE ItemCode LIKE '%CD00%'

SELECT * FROM ItemDeliveryMethods WHERE ItemCode = 'CD001' AND LotNumber = 123543 

Insert

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) 

Batch Insert

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

Update

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'

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM ItemImages WHERE ItemCode LIKE '%CD00%'

SELECT * FROM ItemImages WHERE ItemCode = 'CD001' AND LotNumber = 123543 

Insert

All columns can be specified. ItemCode, ImageSeq are required for an insert.

INSERT INTO ItemImages (ItemCode, LotNumber, ImageName, ImageSeq) VALUES ('MD001', '9808450', 'M', 1)

Batch Insert

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 

Update

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'

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM ItemOptions WHERE ItemCode LIKE '%CD00%'

SELECT * FROM ItemOptions WHERE ItemCode = 'CD001' AND LotNumber = 123543 

Insert

All columns can be specified. ItemCode, ItemOptionSeq are required for an insert.

INSERT INTO ItemOptions (ItemCode,  ItemOptionSeq, ItemOptionTitle, ItemOption) VALUES ('Code0001',  '1', 'title1', 'option1')

Batch Insert

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 

Update

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'

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• ItemCode column supports the = and LIKE operators.
• ItemName column supports the LIKE operator.
• LotNumber, ShopId, SellMethodSegment, PostageSegment, Postage, CategoryId columns support the = operator.
• LimitedPassword column supports the IS NULL, IS NOT NULL operators.
• StockCount, PointRate pseudo-column support the =,<,<=,>,>= operators.
• HasTags, DeliveryId, DeliveryMethodId pseudo-columns support the = operator.

For example, the following queries are processed server side:

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

Insert

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' )

Update

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'

Batch Update

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

Delete

To delete items singlularly, provide the ItemCode and/or LotNumber

DELETE FROM Items   WHERE  ItemCode = 'itemCode' AND LotNumber = '123'

Batch Delete

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)

Columns

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. The allowed values are 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. The allowed values are 1, 2, 3.
ReducedTax	Integer	False		Reduced tax rate setting. The allowed values are 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. The allowed values are 1, 2.
SellNumberDispConfig	Integer	False		Reduced tax rate setting. The allowed values are 1, 2.
BuyNumLimtConfig	Integer	False		Reduced tax rate setting. The allowed values are 1, 2.
BuyNumMax	Integer	False		Reduced tax rate setting. The allowed values are 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. The allowed values are 1, 2.
ReturnRequestConfig	Integer	False		Return application. The allowed values are 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.

Pseudo-Columns

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. The allowed values are 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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM ItemImages WHERE ItemCode LIKE '%CD00%'

SELECT * FROM ItemImages WHERE ItemCode = 'CD001' AND LotNumber = 123543 

Insert

All columns can be specified. ItemCode, SpecificationSeq are required for an insert.

INSERT INTO ItemSpecifications (ItemCode, LotNumber, SpecificationName, Specificationseq) VALUES ('MD001', '9808450', 'M', 1)

Batch Insert

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  

Update

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

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• OrderId, ShopId, LotNumber, ItemCode columns support the = operator.
• OrderDate column supports the =,<,<=,>,>= operators.
• ItemManagementId, ItemName columns support the LIKE operator.

For example, the following queries are processed server side:

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

Insert is not supported for this table

Update

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

Batch Update

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

Delete is not supported for this table

Columns

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.

Select

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.

• OrderId, ShopId, SellMethodSegment, Nickname, DeliveryMethodId and DeliveryId columns support the = operator.
• OrderDate column supports the =,<,<=,>,>= operators.
• MailAddress, OrdererName, OrdererKana, OrdererPhoneNumber1, SenderName, SenderKana, SenderPhoneNumber1 and DeliveryId columns support the LIKE operator.
• UserComment, Memo, DeliveryRequestDay columns support the IS NULL, IS NOT NULL operator.
• LotNumber, ItemCode, SettlementId, CardStatus, AtmStatus, NetBankingStatus, CarrerStatus, AuPaymentStatus, CvsStatus, CvsExpire, Device, HasUsePoint, HasCoupon, GiftPointStatus, GetRawMailAddress, IsWowmaMember pseudo-columns support the = operator.
• ItemManagementId, ItemName pseudo-columns support the LIKE operator.

For example, the following queries are processed server side:

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

Insert is not supported for this table

Update

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

Delete is not supported for this table

Columns

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		au Smart Pass Premium Award Program application categories
PremiumIssuePrice	Decimal	True		au Smart 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

Pseudo-Columns

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. The allowed values are NL, AD, TD, AE, TE, CD.
AtmStatus	String	Atm settlement status. The allowed values are NL, ED, ND, EX, CD, TC.
NetBankingStatus	String	Net banking settlement status. The allowed values are NL, ND, WT, CD, TC.
CarrerStatus	String	Carrer settlement status. The allowed values are NR, AD, CD, ER, TD.
AuPaymentStatus	String	Au payment settlement status. The allowed values are NR, TS, TC, ER, TD.
CvsStatus	String	Cvs settlement status. The allowed values are NL, ED, ND, EX, CD.
CvsExpire	Integer	Csv expiration.
Device	String	Device type. P: PC K: mobile S: smartphone The allowed values are P, K, S.
HasUsePoint	Integer	Integer filtering by use points availability. 0: No use points 1: Existing 2: Pre-cancellation. The allowed values are 0, 1, 2.
HasCoupon	Integer	0: No 1: There are 2: pre-cancellation The allowed values are 0, 1, 2.
GiftPointStatus	Integer	0: undefined 1: confirmed The allowed values are 0, 1.
GetRawMailAddress	Integer	0: do not get 1: get The allowed values are 0, 1.
IsWowmaMember	Integer	0: undefined 1: confirmed The allowed values are 0, 1.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

au PAY Market Connector for CData Sync Views

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM InventoryVerticalChoices WHERE ItemCode LIKE 'CD001'

SELECT * FROM InventoryVerticalChoices WHERE LotNumber  = 1234455 AND ShopId = '123'

Columns

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM ItemOptionComissions WHERE ItemCode LIKE '%CD00%'

SELECT * FROM ItemOptionComissions WHERE ItemCode = 'CD001' AND LotNumber = 123543 

Columns

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.

Select

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.

• LotNumber, ShopId columns support the = operator.
• ItemCode column supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM ItemOptionComissionValues WHERE ItemCode LIKE '%CD00%'

SELECT * FROM ItemOptionComissionValues WHERE ItemCode = 'CD001' AND LotNumber = 123543 

Columns

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.

Columns

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.

Columns

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.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
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.

SSL

---

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

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

---

Property	Description
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.

Remarks

Api Key you get from your au PAY Market store account.

Store account ID of your au PAY Market store.

Remarks

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.

Remarks

The property will default to FALSE, in case you are connection to a test environment, set this to TRUE.

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

---

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

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

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

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

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

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

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

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

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

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

Remarks

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

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

The TCP port for a proxy-based firewall.

Remarks

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

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

Remarks

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

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

Remarks

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

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

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

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

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

Remarks

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

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

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

The TCP port the ProxyServer proxy is running on.

Remarks

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

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

Remarks

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

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

The authentication type can be one of the following:

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

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

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

Remarks

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

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

user@domain
domain\user

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

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

See the Logging page for an overview.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

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

Remarks

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

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

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

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

Remarks

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

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

Remarks

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

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

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

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

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

Remarks

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

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

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

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

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

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

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

Remarks

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

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

Remarks

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

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

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

Remarks

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

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

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

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

Note that the specified path is not embedded in quotation marks.