Cloud

Build 25.0.9539
  • au PAY Market
    • Getting Started
      • Establishing a Connection
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Inventory
        • InventoryChoices
        • InventoryHorizontalChoices
        • ItemDeliveries
        • ItemDeliveryMethods
        • ItemImages
        • ItemOptions
        • Items
        • ItemSpecifications
        • OrderItems
        • Orders
      • Views
        • InventoryVerticalChoices
        • ItemOptionComissions
        • ItemOptionComissionValues
        • OrderItemOptionComissions
        • OrderItemOptionComissionValues
      • Stored Procedures
        • CancelOrder
        • CancelOrderItem
        • ChangeOrderStatus
        • ManagePaymentMethods
        • UpdatePointStatus
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • APIKey
        • ShopId
        • UseSandbox
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • PseudoColumns
        • ThrowsKeyNotFound
        • Timeout
    • Third Party Copyrights

au PAY Market - CData Cloud

Overview

CData Cloud offers access to au PAY Market across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to au PAY Market through CData Cloud.

CData Cloud allows you to standardize and configure connections to au PAY Market as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: au PAY Market appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

This page provides a guide to Establishing a Connection to au PAY Market in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to au PAY Market

Establishing a Connection shows how to authenticate to au PAY Market and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from au PAY Market through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

CData Cloud

Establishing a Connection

Connect to au PAY Market by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to au PAY Market

When using the CData Cloud 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.

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

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.

CData Cloud

Data Model

The CData Cloud 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.

CData Cloud

Tables

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

CData Cloud - au PAY Market 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.

CData Cloud

Inventory

Stock database of nventory data in au PAY Market. Retrieve and update stock information.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

InventoryChoices

Retrieve and update information related to inventory choices.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

InventoryHorizontalChoices

Retrieve information related to inventory horizontal choices.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

ItemDeliveries

Retrieve and update information related to item deliveries.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

ItemDeliveryMethods

Retrieve and information related to item delivery methods.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

ItemImages

Retrieve and update information related to item images.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

ItemOptions

Retrieve and update information related to item options.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

Items

Retrieve information related to Items.Query, add, update and delete products.

Select

The Cloud 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 Cloud.

  • 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.

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

CData Cloud

ItemSpecifications

Retrieve and update information related to item specifications.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

OrderItems

Retrieve information related to order items.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

Orders

Retrieve and query information related to orders.

Select

The Cloud 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 Cloud.

  • 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

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

EGiftTrade String

0: Orders not eligible, 1: Orders eligible for gifts for anyone. *Available only at specified stores

CData Cloud

Views

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.

CData Cloud - au PAY Market 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.

CData Cloud

InventoryVerticalChoices

Retrieve information related to inventory vertical choices.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

ItemOptionComissions

Retrieve information related to item option commissions.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

ItemOptionComissionValues

Retrieve information related to item option commission values.

Select

The Cloud 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 Cloud.

  • 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.

CData Cloud

OrderItemOptionComissions

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.

CData Cloud

OrderItemOptionComissionValues

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.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with au PAY Market.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from au PAY Market, along with an indication of whether the procedure succeeded or failed.

CData Cloud - au PAY Market Stored Procedures

Name Description
CancelOrder Cancel the specified order.
CancelOrderItem Remove order item.
ChangeOrderStatus Change the order status of the specified order.
ManagePaymentMethods Manage payment methods of the specified order. Confirm or cancel the settlement methods.
UpdatePointStatus Update order point information.

CData Cloud

CancelOrder

Cancel the specified order.

Input

Name Type Required Description
OrderId Long True Order ID
ShopId String False Store account.
CancelReason Integer True 1: No Contact (purchaser), 2: issing 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).

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

CancelComment String True Provide a comment in case of cancellation reason 9.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

CData Cloud

CancelOrderItem

Remove order item.

Input

Name Type Required Description
ShopId String False Store account.
OrderItemId Long True Order item id to be removed.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

CData Cloud

ChangeOrderStatus

Change the order status of the specified order.

Input

Name Type Required Description
OrderId Long True Order ID
ShopId String False Store account.
OrderStatus String True Specify the order status.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

CData Cloud

ManagePaymentMethods

Manage payment methods of the specified order. Confirm or cancel the settlement methods.

Input

Name Type Required Description
OrderId Long True Order ID.
ShopId String False Store account.
PaymentMethod Integer True Settlement method of the order. 1- Credit card processing, 2- Individual mobile phone company processing, 3- AU company processing.

The allowed values are 1, 2, 3.

PaymentAction String True Confirm or cancel the settlement method of the order.

The allowed values are CONFIRM, CANCEL.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

CData Cloud

UpdatePointStatus

Update order point information.

Input

Name Type Required Description
OrderId Long True Order ID
ShopId String False Store account.
Type Integer True Type of update. 1: Fixed date, 2: Fixed date extension.

The allowed values are 1, 2.

PointFixedDate Date False Points date. Required if Type is 2.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

CData Cloud

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for au PAY Market:

  • sys_catalogs: Lists the available databases.
  • sys_schemas: Lists the available schemas.
  • sys_tables: Lists the available tables and views.
  • sys_tablecolumns: Describes the columns of the available tables and views.
  • sys_procedures: Describes the available stored procedures.
  • sys_procedureparameters: Describes stored procedure parameters.
  • sys_keycolumns: Describes the primary and foreign keys.
  • sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

CData Cloud

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Items table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Items' 

Columns

Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the ChangeOrderStatus stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ChangeOrderStatus' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ChangeOrderStatus' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native au PAY Market procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Items table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Items' 
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

CData Cloud

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

CData Cloud

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

CData Cloud

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

CData Cloud

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

CData Cloud

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported string functions.LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSSupported numeric functions.ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSSupported date/time functions.NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll supported SQL capabilities for this driver.SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

CData Cloud

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String The database-generated Id returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Connection String Options

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

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

Authentication


PropertyDescription
APIKeyApi Key you get from your au PAY Market store account.
ShopIdStore account ID of your au PAY Market store.
UseSandboxSpecify if you are connecting to a test environment or a production account. Defaults to FALSE.

SSL


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

Logging


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

Authentication

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


PropertyDescription
APIKeyApi Key you get from your au PAY Market store account.
ShopIdStore account ID of your au PAY Market store.
UseSandboxSpecify if you are connecting to a test environment or a production account. Defaults to FALSE.
CData Cloud

APIKey

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

Data Type

string

Default Value

""

Remarks

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

CData Cloud

ShopId

Store account ID of your au PAY Market store.

Data Type

string

Default Value

""

Remarks

Store account ID of your au PAY Market store.

CData Cloud

UseSandbox

Specify if you are connecting to a test environment or a production account. Defaults to FALSE.

Data Type

bool

Default Value

false

Remarks

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

CData Cloud

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

CData Cloud

Logging

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


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

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


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
CData Cloud

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

CData Cloud

Miscellaneous

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


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Cloud

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539