Getting Started

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

Connecting to Yahoo Shopping

Establishing a Connection shows how to authenticate to Yahoo Shopping and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Yahoo Shopping through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Yahoo Shopping 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 Yahoo Shopping

Yahoo Shopping provides embedded OAuth credentials that simplify connection from a Desktop application or a Headless machine. To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Yahoo Shopping from:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
Web: access to data via a shared website. Authenticated via custom OAuth only.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Yahoo Shopping, see Connection.

When the access token expires, the Cloud refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token, do the following:

The first time you connect to data, set these connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your custom OAuth application settings.
- OAuthClientSecret: The client secret in your custom OAuth application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
On subsequent data connections, set:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set these connection properties:
- OAuthClientId: The Client Id in your custom OAuth application settings.
- OAuthClientSecret: The Client Secret in your custom OAuth application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Yahoo Shopping via a desktop application or a headless machine. If you want to use the embedded OAuth application, all you need to do to connect is to:

set AuthScheme to OAuth,
get and set the OAuthAccessToken, and
set the necessary configuration parameters.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Yahoo Shopping".)

However, you must create a custom OAuth application to connect to Yahoo Shopping via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

control branding of the authentication dialog;
control the redirect URI that the application redirects the user to after the user authenticates; or
customize the permissions that you are requesting from the user.

Procedure

This procedure creates a custom OAuth application and obtains the OAuth values for your application, the OAuthClientId, and OAuthClientSecret.

Log into Yahoo Developers Network.
Access the Application Management site at https://e.developer.yahoo.co.jp/.
Click Create New Application.
Specify a name for the new application.
Set up a Redirect URL for the new application:
- For desktop applications, select the client type for the application type. Specify a redirect URL of http://localhost:33333 (the Cloud's default) OR a different port of your choice. Set the CallbackURL to the same value you just specified.
- For web applications, select the server type for the application type, and set the Redirect URL to the web page where users should return after they have granted permission to your application. Set the CallbackURL to the same value you just specified.
Save your changes.

Record the client Id, client secret, and callback URL for future use.

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.

Client SSL Certificates

The Yahoo Shopping Cloud also supports setting client certificates. Set the following to connect using a client certificate.

SSLClientCert: The name of the certificate store for the client certificate.
SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword: The password for the TLS/SSL client certificate.
SSLClientCertSubject: The subject of the TLS/SSL client certificate.

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.

Data Model

The CData Cloud models Yahoo Shopping objects as relational tables and views. A Yahoo Shopping 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 Yahoo Shopping APIs.

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

You may find the SellerId column in all tables, views and procedures. This is connected to the SellerId connection property. If not specified in a query, the request will include the value set in the connection property.

Tables

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

CData Cloud - Yahoo Shopping Tables


Name	Description
Inventory	Stock database of inventory data in Yahoo! Shopping.
OrderDetails	Returns data from a sample table.
OrderLineItems	Returns data from a sample table.
OrderPayments	Returns data from a sample table.
Orders	Returns data from a sample table.
OrderShippings	Returns data from a sample table.
ProductOptions	Return the list of options for the specified product.
Products	Return the list of registered products of your store.
ProductSubCodes	Return the list of options for the specified product.

Inventory

Stock database of inventory data in Yahoo! Shopping.

Select

The Cloud will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators, ItemCode is required. The rest of the filter is executed client side within the Cloud.

ItemCode and SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM Inventory WHERE ItemCode = 'CD001'

Insert

Insert is not supported by Inventory

Update

Yahoo Shopping allows updates for the AllowOverdraft, Quantity and StockClose columns.

UPDATE Inventory SET AllowOverdraft = 1, Quantity = '15', StockClose = 0 WHERE ItemCode = 'CD001'

Batch Update

Yahoo Shopping allows updates for the same columns.

INSERT INTO Inventory#TEMP (AllowOverdraft, ItemCode, Quantity, StockClose)  VALUES (1, 'CD0001', '12', 0)

INSERT INTO Inventory#TEMP (AllowOverdraft, ItemCode, Quantity, StockClose)  VALUES (1, 'CD0002', '32', 0)

UPDATE Inventory SET (AllowOverdraft, ItemCode, Quantity, StockClose) SELECT AllowOverdraft, ItemCode, Quantity, StockClose FROM [Inventory#TEMP]

Delete

Delete is not supported by Inventory

Columns


Name	Type	ReadOnly	References	Description
ItemCode [KEY]	String	False	Products.ItemCode	Product code. In INSERT or UPDATE: For products that do not have individual product codes, please specify only the product code. For products with individual item codes, please connect the product code and individual product code with a colon ':'.
SellerId	String	False		Id of the store account. In UPDATE: If the number has a plus sign '+', the value will be added and it will be subtracted if minus sign '-' is attached. If only numeric value is written, the field will be updated with that value.
SubCode	String	True		Individual product code. If the product does not have individual product code, this will be empty.
Status	Integer	True		Stock acquisition status. 0: No stock information, 1: Stock information available. The allowed values are 0, 1.
Quantity	String	False		Quantity of inventory. If this value is empty, this means that the number of stock is infinite.
AllowOverdraft	Integer	False		The excess purchase setting. 0: Excessive purchase impossible, 1: Excess purchase possible. The allowed values are 0, 1.
IsPublished	Integer	True		The product reflection flag. 0: Product not reflected, 1: Product reflected. The allowed values are 0, 1.
UpdateTime	Datetime	True		Last update date.
StockClose	Integer	False		Stock Close Flag. 0: Normal State, 1: Stock Closed State The allowed values are 0, 1.

OrderDetails

Returns data from a sample table.

Select

The Cloud will use the Yahoo Shopping 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 AND SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDetails WHERE OrderId = 'store_000001'

SELECT * FROM OrderDetails WHERE OrderId = 'store_000001' AND SellerId = 'store'

Insert

Insert is not supported by OrderDetails

Update

Yahoo Shopping allows UPDATEs for the OrderStatus, IsPointFix, CancelReason, CancelReasonDetail, OperationUser, PrintSlipTime, PrintDeliveryTime, PrintBillTime, BuyerComments, SellerComments, Notes, PayCharge, ShipCharge, GiftWrapCharge, Discount columns.

UPDATE OrderDetails SET OrderStatus = 2, IsPointFix = 'true', CancelReason = 110, CancelReasonDetail = ' detail for canceling here ', OperationUser = 'API', PrintSlipTime = '2018-05-27T10:51:18.000+02:00', PrintDeliveryTime = '2018-06-27T10:51:18.000+02:00', PrintBillTime = '2018-07-27T10:51:18.000+02:00', BuyerComments = 'comments here', SellerComments = 'seller comments', Notes = 'some notes ', PayCharge = 1, ShipCharge = 2, GiftWrapCharge = 0, Discount = 4 WHERE OrderId = 'store-10000003'

Delete

Delete is not supported by OrderDetails

Columns


Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False	Orders.OrderId	Order Id.
SellerId	String	False		Store account.
OrderTime	Datetime	True		The date and time when the order was made.
OrderStatus	Integer	False		Status of the order. 1: During reservation, 2: In process, 3: Hold, 4: Cancel, 5: Completed. The allowed values are 0, 1, 2, 3, 4, 5, 8.
CancelReason	Integer	False		Cancellation reason: Order Cancellation - 100: Cancel, 110: Returned Item, 120: Not Received, 130: Address Unknown, 140: Receiving Refused, 150: No Connection, 160: Duplicate Order, 170: Payment Unavailable, 180: Other, 300: Mistakenly Ordered, 310: Customer Using Points They Forgot to Use, 320: Customer Using Coupon They Forgot to Use, 330: Customer Found Cheaper Price, 340: Shipping Cost Too High, 350: Change of Shipping Destination, 360: Change of Shipping Method, 370: Change of Payment Method, 380: Credit Card Not Available, \| Store convenience - 200: Settlement Method Convenience, 210: Missing Item, 220: Discontinued, 230: Other \| Other - 0: Cancel reason n/a System cancellation \| blank: Order not canceled.
CancelReasonDetail	String	False		The reason why the store has entered a cancellation reason when the reason is Store Convenience 230 (Other)
IsPointFix	Boolean	False		Required on an Update. True: Points are finalized. False: The point is not fixed.
OperationUser	String	False		The registered name of Yahoo! JAPAN business ID who carried out update work.
ParentOrderId	String	True		The splitting order ID when an order is split.
ChildOrderId	String	True		The second splitting order ID when an order is split.
MobileCarrierName	String	True		The type of mobile carrier.
NeedSnl	Boolean	True		Store newsletter opt-in flag.
LastUpdateTime	Datetime	True		The last modification date of order information.
SuspectMessage	String	True		A message when an order is judged as mischievous.0: Non-naughty order, 1: Mischievous order, 2: Mischievious canceled order.
SendConfirmTime	Datetime	True		The date and time of sending the order confirmation email sent when the order is newly entered.
SendPayTime	Datetime	True		The mail transmission date sent at the time of settlement.
PrintSlipTime	Datetime	False		The date and time when the order slip was output.
PrintDeliveryTime	Datetime	False		The date and time when we output the invoice.
PrintBillTime	Datetime	False		The date and time when the invoice was output.
BuyerComments	String	False		The comment string displayed by the buyer.
SellerComments	String	False		The comment string displayed by the store in the store.
Notes	String	False		A memo in the store when the store is entered with the order management tool.
Referer	String	True		Referrer information covering domain, search keywords, etc.
EntryPoint	String	True		The URL of the store page where the buyer entered the target store.
HistoryId	String	True		An ID that manages the update history of orders.
UsageId	String	True		The coupon usage ID.
UseCouponData	String	True		Detailed information on the coupon information.
TotalCouponDiscount	Integer	True		Of the amount discounted by the store coupon of all the products associated with one order, this becomes the discount total value other than the shipping fee.
ShippingCouponFlg	Integer	True		Free shipping availability. 0: None, 1: Present.
ShippingCouponDiscount	Integer	True		It is the discount amount of the carriage when applying free shipping coupons.
CampaignPoints	String	True		Comma separated list of breakdown points.
IsMultiShip	Boolean	True		Indicates if there is a multiple shipping order.
MultiShipId	String	True		ID that identifies multiple delivery orders.
PayCharge	Integer	False		The fee set by the store (cash on delivery commission etc.). The settlement fee of Yahoo! settlement is different.
ShipCharge	Integer	False		Shipping fee (postage free coupon discount after deduction).
GiftWrapCharge	Integer	False		Gift wrapping fee.
Discount	Integer	False		Discount. The value entered in the price discount column on the store creator Pro after the store side is entered.
Adjustments	Integer	False		Adjustment amount.
SettleAmount	Integer	True		The same value as the total amount (TotalPrice).
UsePoint	Integer	True		Number of points used.
TotalPrice	Integer	True		Subtotal - usage point + gift wrapping fee + fee - discount + postage + adjustment amount - mall coupon discount amount.
IsGetPointFixAll	Boolean	True		Indicates whether or not the process of finalizing the grant points of all lines (goods) has been completed.
TotalMallCouponDiscount	Integer	True		Indicates the total value of the amount discounted at the mall coupon.
SettlePayAmount	Integer	True		When the order is split, this will not reflect the split amount. The total amount will reflect this.
IsLogin	Boolean	True		Login order.
FspLicenseCode	String	True		For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
FspLicenseName	String	True		For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
GuestAuthId	String	True		Guest authorization Id for guest orders only.
YamatoCoopStatus	Integer	True		The allowed values are 0, 1, 2, 3, 4.
FraudHoldStatus	Integer	True		0 or null: Low risk of fraud, 1: Rule pending review, 2: Release rule hold, 3: Rule abuse confirmed. The allowed values are 0, 1, 2, 3.
PublicationTime	Datetime	True		The time that can be obtained from the orderList, such as when the illegal hold is released, is set.
UseGiftCardData	String	True		Gift Card Data.
GiftCardDiscount	Integer	True		Amount of gift voucher used
SocialGiftType	String	True		This column indicates whether the delivery address information for social gift orders is entered by sharing the URL or entered by the purchaser. For orders before the feature is released, it will be empty (null).
IsVip	Boolean	True		This column indicates whether the order is eligible for VIP benefits or not.
InsuranceStatus	Integer	True		Insurance enrollment status null or 0: No application 1: Application in process 2: Application successful 3: Application unsuccessful 4: Coverage started 5: Insurance canceled 6: Insurance ordered
ShipCompanyMethodCode	String	True		The name of the shipping method used by the shipping company. The code determined by the shipping company.
ShipCompanyReceivedDatetime	Datetime	True		The date and time the delivery company received the shipment
ShipContactlessDeliveryCode	String	True		Delivery company drop-off location code null: Item not eligible for drop-off delivery OR Drop-off delivery not selected 00: Item to be dropped off and picked up in person 01: Item to be dropped off and picked up without meeting the customer
ChannelGoodsPlanId	String	True		ID when signing up for PayPay Insurance via SHP
ChannelGoodsPlanName	String	True		PayPay Insurance Name via SHP

OrderLineItems

Returns data from a sample table.

Select

The Cloud will use the Yahoo Shopping 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 AND SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderLineItems WHERE OrderId = 'store_000001'

SELECT * FROM OrderLineItems WHERE OrderId = 'store_000001' AND SellerId = 'store'

Insert

To add a OrderLineItem specify the OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice columns.

INSERT INTO OrderLineItems (OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice) VALUES ('store-10000004', 'false', 'CD0012345', 22, 10, 'some new title test', 150)

Batch Insert

Yahoo Shopping allows batch inserts for the same columns. OrderId should be the same in all batch records.

INSERT INTO OrderLineItems (OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice) VALUES ('store-10000004', 'false', 'CD0012345', 22, 10, 'some new title test 1', 150)

INSERT INTO OrderLineItems (OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice) VALUES ('store-10000004', 'false', 'CD0012346', 22, 10, 'some new title test 2', 150)

INSERT INTO OrderLineItems (OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice) SELECT OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice FROM OrderLineItems#TEMP

Update

UPDATE is not supported by OrderDetails

Delete

Delete is not supported by OrderDetails

Columns


Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False	Orders.OrderId	Order ID.
LineId [KEY]	Integer	False		Product line ID.
OrderTime	Datetime	True		The date and time when the order was made.
SellerId	String	False		Store account ID.
ItemId	String	False		Product ID.
Title	String	False		Product title.
SubCode	String	False		The subcode of the product when this value has been set.
SubCodeOption	String	True		The subcode option when this value has been set. Both key & value.
IsUsed	Boolean	True		Indicates whether it is a used item.
ImageId	String	True		The product image ID.
IsTaxable	Boolean	True		Tax object flag.
Jan	String	True		Japanese Article Number code.
ProductId	String	True		The product code (product number/model number).
CategoryId	Integer	True		Category code.
AffiliateRatio	String	True		Store burden rate.
UnitPrice	Integer	False		Unit price of each item (amount after discount of store coupons) .
ItemTaxRatio	Integer	True		Unit price of each item (amount after discount of store coupons) .
Quantity	Integer	False		The quantity of each item.
PointAvailQuantity	Integer	True		Points to be granted quantity.
ReleaseDate	Date	True		Release date. This is only when there is input of release date. For release date bigger than order date, treat it as a pre-order.
HaveReview	Boolean	True		Product review absence flag.
PointFspCode	String	True		Point code by item. 10001 to 10015, 2001 to 20010.
PointRatioY	Integer	True		Granted Point Magnification (Yahoo! JAPAN Burden).
PointRatioSeller	Integer	True		Granted Point Magnification (Store Burden).
UnitGetPoint	Integer	True		Number of credit points granted.
IsGetPointFix	Boolean	True		Granted point determination flag.
GetPointFixDate	Date	True		Granulation point determination date. After 14 days of order date, we will set the pre-order to 14 days after release date.
CouponDiscount	Integer	True		Coupon discount amount.
CouponUseNum	Integer	True		Number of applicable coupons.
OriginalPrice	Integer	True		Unit price before discount.
OriginalNum	Integer	True		Quantity before line splitting.
LeadTimeStart	Date	True		Start of shipment date.
LeadTimeEnd	Date	True		Shipment day end.
LeadTimeText	String	True		Shipping date text.
CouponData	String	True		Store coupons.
IsQuotation	Boolean	False		Used only on UPDATE.
OperationUser	String	False		It is the registered name of Yahoo! JAPAN business ID who carried out update work.
YamatoCoopStatus	Integer	True		It is a status that shows the current status of the link to Yamato Transport. The allowed values are 0, 1, 2, 3, 4.
PickAndDeliveryCode	String	True		The bar code information required for delivery.
PickAndDeliveryTransportRuleType	Integer	True		It is an information on cargo handling. The allowed values are 0, 1, 2, 3, 4, 5.
YamatoUndeliverableReason	String	True		The reason why Yamato delivery is not possible.

OrderPayments

Returns data from a sample table.

Select

The Cloud will use the Yahoo Shopping 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 AND SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderPayments WHERE OrderId = 'store_000001'

SELECT * FROM OrderPayments WHERE OrderId = 'store_000001' AND SellerId = 'store'

Insert

Insert is not supported by OrderPayments

Update

Yahoo Shopping allows UPDATEs for the PayStatus, PayDate, OperationUser, PayType, PayKind, PayMethod, PayMethodName, PayNotes, NeedBillSlip, NeedDetailedSlip, NeedReceipt, BillAddressFrom, BillFirstName, BillFirstNameKana, BillLastName, BillLastNameKana, BillZipCode, BillPrefecture, BillPrefectureKana, BillCity, BillCityKana, BillAddress1, BillAddress1Kana, BillAddress2, BillAddress2Kana, BillPhoneNumber, BillEmgPhoneNumber, BillMailAddress, BillSection1Field, BillSection1Value, BillSection2Field, BillSection2Value columns.

UPDATE OrderPayments SET PayStatus = 0, PayDate = '2108-10-10', OperationUser = 'system', PayType = 0, PayKind = 7, PayMethod = 'payment_c1', PayMethodName = 'testname', PayNotes = ' payment notes here..', NeedBillSlip = 'false', NeedDetailedSlip = 'false', NeedReceipt = 'true', BillAddressFrom = 'from address', BillFirstName = 'first name', BillFirstNameKana = 'first name phonetic', BillLastName = 'last name', BillLastNameKana = 'last name phonetic', BillZipCode = '1423', BillPrefecture = 'prefecture ', BillPrefectureKana = 'prefecture phonetic', BillCity = 'city', BillCityKana = ' city phonetic', BillAddress1 = 'address 1', BillAddress1Kana = 'address 1 phonetic', BillAddress2 = 'address 2', BillAddress2Kana = 'address 2 phonetic', BillPhoneNumber = '050-5578-7397', BillEmgPhoneNumber = '050-5578-7397', BillMailAddress = 'mail address', BillSection1Field = 'field 1', BillSection1Value = 'value 1', BillSection2Field = 'field 2', BillSection2Value = 'value 2' WHERE OrderId = 'store-10000002'

Delete

Delete is not supported by OrderPayments

Columns


Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False	Orders.OrderId	Order ID.
SellerId	String	False		Store account ID.
OrderTime	Datetime	True		The date and time when the order was made.
PayStatus	Integer	False		Deposit status. 0: Waiting for payment, 1: Payment already made The allowed values are 0, 1.
SettleStatus	Integer	True		Settlement status. 1: Settlement application, 2: Waiting for payment, 3: Payment completion, 4: Waiting for payment, 5: Completion of settlement, 6: Cancel, 7: Refund, 8: Expired, 9: Payment application, 10: Authorization error, 11: Sales cancelled, 12: Suica address error. The allowed values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12.
PayType	Integer	False		Payment classification. 0: Postpay, 1: Prepay. The allowed values are 0, 1.
PayKind	Integer	False		Payment type. 0: Card, 1: Internet banking, 2: Carrier settlement, 3: Transfer, 4: Cash on delivery, 5: Convenience store, 6: Electronic money 7: Other. The allowed values are 0, 1, 2, 3, 4, 5, 6, 7.
PayMethod	String	False		Payment method number. payment_a 1: Credit card payment, payment_a 6: Convenience store payment (7-Eleven), payment_a 7: Convenience store payment (Others), payment_a 8: Mobile Suica payment, payment_a 9: Docomo Mobile payment, payment_a 10: au Easy settlement, payment_a 11: Soft bank collectively payment, payment_a 15: Payee, payment_a 16: Yahoo Money / deposit payment, payment_b [1-6]: bank transfer (name is free setting of store), payment_c1: Japan Post Bank (prepayment), payment_c2: Japan Post Bank (postpay), payment_c3: registered mail, payment_d1: cash on delivery goods, payment_e [1-15 ]: Free payment method name of the store, payment_z1: Full payment of points.
PayMethodName	String	False		Payment method name.
SellerHandlingCharge	Integer	True		A settlement fee for the store's burden.
PayActionTime	Datetime	True		Purchase history detail screen It contains the payment update date and time.
PayDate	Date	False		The deposit date entered in the order management tool.
PayNotes	String	False		The contents of the remarks column of the deposit entered by the order management tool.
SettleId	String	True		Settlement ID.
CardBrand	String	True		In case of credit card it is the card brand name (VISA etc).
CardNumber	String	True		Only store of original merchant store contract is available. Encrypted character string information can be acquired.
CardNumberLast4	String	True		The last four digits of the credit card.
CardExpireYear	String	True		The expiration year of the card.
CardExpireMonth	String	True		The expiration month of the card.
CardPayType	Integer	True		Card payment classification. 1: Lump sum payment, 2: Bonus lump sum payment, 3: Ribbon payment, 4: Installment payment The allowed values are 1, 2, 3, 4.
CardHolderName	String	True		The name of the cardholder
CardPayCount	Integer	True		The number of payments in installments.
CardBirthDay	String	True		Card date of birth.
UseYahooCard	Boolean	True		Yahoo! JAPAN JCB Card Availability.
UseWallet	Boolean	True		Wallet availability.
NeedBillSlip	Boolean	False		Whether or not you wish to have an invoice when ordering entered by the purchaser.
NeedDetailedSlip	Boolean	False		The presence or absence of the requested statement when ordering entered by the purchaser.
NeedReceipt	Boolean	False		Whether there is a receipt at the time of ordering entered by the purchaser.
AgeConfirmField	String	True		The field name set by the store in the age confirmation field.
AgeConfirmValue	Integer	True		Age confirmation field numeric input.
AgeConfirmCheck	Boolean	True		If the box has been checked when there is an age check check box.
BillAddressFrom	String	False		Billing address. P: UDB home address, B: UDB work address, ship: same as the addressee, O1: others, O2: other, O3: other 3 O4: other 4 O: other input.
BillFirstName	String	False		Billing Name.
BillFirstNameKana	String	False		Billing name (phonetic).
BillLastName	String	False		Billing surname.
BillLastNameKana	String	False		Billing last name (phonetic).
BillZipCode	String	False		Billing Postal Code.
BillPrefecture	String	False		Billing address Prefecture In case of overseas 'Other' is entered.
BillPrefectureKana	String	False		Billing prefecture phonetic.
BillCity	String	False		Billing city / county.
BillCityKana	String	False		Billing County District Phonetic.
BillAddress1	String	False		Billing address 1.
BillAddress1Kana	String	False		Billing address 1 phonetic.
BillAddress2	String	False		Billing address 2.
BillAddress2Kana	String	False		Billing address 2 phonetic.
BillPhoneNumber	String	False		Billing telephone number.
BillEmgPhoneNumber	String	False		Billing telephone number (urgent).
BillMailAddress	String	False		Billing E-mail address.
BillSection1Field	String	False		Billing address Affiliation 1 Field name.
BillSection1Value	String	False		Billing address Affiliation 1 Input information.
BillSection2Field	String	False		Billing address Affiliation 2 Field name.
BillSection2Value	String	False		Billing address Affiliation 2 Input information.
CombinedPayType	Integer	False		Billing address Affiliation 2 Input information.
CombinedPayKind	Integer	False		Billing address Affiliation 2 Input information.
CombinedPayMethod	String	False		Billing address Affiliation 2 Input information.
PayMethodAmount	Decimal	False		Billing address Affiliation 2 Input information.
CombinedPayMethodName	String	False		Billing address Affiliation 2 Input information.
CombinedPayMethodAmount	Decimal	False		Billing address Affiliation 2 Input information.
PayNo	String	True		Payment number.
PayNoIssueDate	Datetime	True		Payment number issue date / time.
ConfirmNumber	String	True		Authorization number.
PaymentTerm	Datetime	True		Payment due date for convenience store payment, mobile Suica settlement, and payment settlement.
IsApplePay	Boolean	True		Availability of ApplePay.
OperationUser	String	False		It is the registered name of Yahoo! JAPAN business ID who carried out update work.

Orders

Returns data from a sample table.

Select

The Cloud will use the Yahoo Shopping 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 support the = operator.
SellerId DeviceType IsSeen IsSplit IsRoyalty IsAffiliate Suspect OrderStatus and StoreStatus support the = operator.
OrderTime supports the following operators: =,<,<=,> AND >=.

For example, the following queries are processed server side:

SELECT * FROM Orders WHERE ReadOnlyMode = 2

SELECT * FROM Orders WHERE OrderId = 'store_000001'

SELECT * FROM Orders WHERE OrderId = 'store_000001' AND SellerId = 'store'

SELECT * FROM Orders WHERE OrderTime > '2010-07-07 00:00:00+01:00' AND OrderTime <= '2018-07-07 00:00:00+01:00' AND DeviceType = 1 AND IsSeen = 'true' AND IsSplit = 'false' AND IsRoyalty = 'true' AND IsAffiliate = 'false' AND Suspect = 0 AND OrderStatus = 2

Insert

Insert is not supported by Orders

Update

Yahoo Shopping allows updates for the IsSeen, Suspect and StoreStatus columns.

UPDATE Orders SET IsSeen = 'true', Suspect = 0, StoreStatus = '3' WHERE OrderId = 'store-10000001'

Delete

Delete is not supported by Orders

Columns


Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False		Order Id.
SellerId	String	False		Store account.
OrderTime	Datetime	True		The date and time when the order was made.
Version	Integer	True		Shopping cart and IF specification version of order API.
OriginalOrderId	String	True		It is the order ID when we processed the order.
ParentOrderId	String	True		This is the splitting order ID when order is split.
DeviceType	Integer	True		Device information 1: PC 2: Galaxy 3: Smartphone 4: Tablet. The allowed values are 1, 2, 3, 4.
IsSeen	Boolean	False		Viewed flag.
IsSplit	Boolean	True		Split flag.
IsRoyalty	Boolean	True		It judges whether it is a charge target or not. For example, for a test order, specify false.
IsSeller	Boolean	True		Administrator order flag. The seller ordered by Yahoo! ID registered. It displays in order management.
IsAffiliate	Boolean	True		It is judging whether it is an order via an affiliate.
IsRatingB2s	Boolean	True		Seller It is judged whether it has been evaluated or not.
ExistMultiReleaseDate	Boolean	True		Multiple release date available.
LastUpdateTime	Datetime	True		It is the last modification date of order information.
Suspect	Integer	False		Flag to judge mischief target, non target, and canceled. 0: non-mischievous order 1: mischievous order 2: mischievous canceled order. The allowed values are 0, 1, 2.
OrderStatus	Integer	True		0: Not entered 1: Reserved 2: In process 3: Hold 4: Cancel 5: Complete 8: Wait for consent. The allowed values are 0, 1, 2, 3, 4, 5, 8.
StoreStatus	String	False		It is a status that the store can set independently.
RoyaltyFixTime	Datetime	True		Charging decision date and time.
IsYahooAuctionOrder	Boolean	True		IsYahooAuctionOrder
YahooAuctionMerchantId	String	True		YahooAuctionMerchantId
YahooAuctionId	String	True		YahooAuctionId
IsReadOnly	Integer	True		Read only flag. 1: Read only (cancel acceptance order) 0: Readable / writable. The allowed values are 0, 1.
YamatoCoopStatus	Integer	True		This is a status that shows the current status of the link to Yamato Transport. The allowed values are 0, 1, 2, 3, 4.
ReadOnlyMode	Integer	True		Property to get data that the user can be able to cancel. Supports only value 2 The allowed values are 0, 1, 2. The default value is 2.
TotalCount	Integer	True		Total number of records available.
FraudHoldStatus	Integer	False		This is a status that shows the risk of Fraud.
PublicationTime	Datetime	False		Time that can be obtained from the Order List.
IsEazy	Boolean	True		It is an Order Flag.

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
Start	Integer	Search index where to start seraching records from.
FraudHoldDisplayType	Integer	A flag that determines whether to include fraudulently held orders. The allowed values are 0, 1.
PayStatus	Integer	Deposit status. 0: Waiting for payment, 1: Payment already made. The allowed values are 0, 1.

OrderShippings

Returns data from a sample table.

Select

The Cloud will use the Yahoo Shopping 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 AND SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderShippings WHERE OrderId = 'store_000001'

SELECT * FROM OrderShippings WHERE OrderId = 'store_000001' AND SellerId = 'store'

Insert

Insert is not supported by OrderShippings

Update

Yahoo Shopping allows updates for the IsPointFix, ShipStatus, ShipMethod, ShipMethodName, ShipRequestDate, ShipRequestTime, ShipNotes, ShipCompanyCode, ShipInvoiceNumber1, ShipInvoiceNumber2, ShipInvoiceNumberEmptyReason, ShipUrl, ArriveType, ShipDate, ArrivalDate, NeedGiftWrap, GiftWrapType, GiftWrapMessage, NeedGiftWrapPaper, GiftWrapPaperType, GiftWrapName, ShipFirstName, ShipFirstNameKana, ShipLastName, ShipLastNameKana, ShipPrefecture, ShipPrefectureKana, ShipZipCode, ShipCity, ShipCityKana, ShipAddress1, ShipAddress1Kana, ShipAddress2, ShipAddress2Kana, ShipPhoneNumber, ShipEmgPhoneNumber, ShipSection1Field, ShipSection1Value, ShipSection2Field, ShipSection2Value, OperationUser columns.

UPDATE OrderShippings SET IsPointFix = 'true', ShipStatus = 3, ShipMethod = '1', ShipMethodName = ' the ship method name', ShipRequestDate = '2017-04-04', ShipRequestTime = '01:01:01', ShipNotes = ' shipping notes', ShipCompanyCode = '1001', ShipInvoiceNumber1 = 'number 1', ShipInvoiceNumber2 = 'number 2', ShipInvoiceNumberEmptyReason = ' reason', ShipUrl = 'domain.com', ArriveType = 0, ShipDate = '2017-04-04', ArrivalDate = '2017-04-04', NeedGiftWrap = 'false', GiftWrapType = '', GiftWrapMessage = '', NeedGiftWrapPaper = 'false', GiftWrapPaperType = '4', GiftWrapName = 'wrap name', ShipFirstName = 'ship name', ShipFirstNameKana = ' ship name phonetic', ShipLastName = 'last name', ShipLastNameKana = 'last name phonetic', ShipPrefecture = 'prefecture', ShipPrefectureKana = ' prefecture phonetic', ShipZipCode = '980-0021', ShipCity = 'NJ', ShipCityKana = 'NJ phonetic', ShipAddress1 = ' the address', ShipAddress1Kana = 'the address phonetic', ShipAddress2 = ' address 2', ShipAddress2Kana = 'address 2 phonetic', ShipPhoneNumber = '050-5578-7397', ShipEmgPhoneNumber = '050-5578-7390', ShipSection1Field = 'test field 1', ShipSection1Value = 'test value 1', ShipSection2Field = 'test field 2', ShipSection2Value = 'test value 2', OperationUser = 'API' WHERE OrderId = 'store-10000002'

Delete

Delete is not supported by OrderShippings

Columns


Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False	Orders.OrderId	Order Id.
SellerId	String	False		Store account.
OrderTime	Datetime	True		The date and time when the order was made.
IsPointFix	Boolean	False		Used only on update.
ShipStatus	Integer	False		Delivery status 0: Can not be shipped 1: Can be shipped 2: Shipping in progress 3: Shipped completed 4: Receiving completed. The allowed values are 0, 1, 2, 3, 4.
ShipMethod	String	False		Delivery method number: any one of postage 1 - 14, 16.
ShipMethodName	String	False		Delivery method name.
ShipRequestDate	Date	False		Desired delivery day.
ShipRequestTime	String	False		Delivery time desired.
ShipNotes	String	False		Delivery note.
ShipCompanyCode	String	False		Delivery company code 1000: Other 1001: Yamato Transport 1002: Sagawa Express 1003: Japan Post 1004: Seino Transportation.
ShipInvoiceNumber1	String	False		Delivery slip number information of the shipping company that the store set with the tool or API.
ShipInvoiceNumber2	String	False		Delivery slip number information of the shipping company that the store set with the tool or API.
ShipInvoiceNumberEmptyReason	String	False		NULL: (Unregistered state) 101: For direct item from manufacturer's inventory 102: For goods that do not need shipping 103: For overseas receipt items 104: For direct contact from the delivery company 105: Document number Because it is not issued (can not be tracked) because of the delivery method.
ShipUrl	String	False		Tracking URL of the shipping company that the store set with tools and APIs.
ArriveType	Integer	False		Drinking 0: Normal 1 : School order 2: Matsutake order The allowed values are 0, 1, 2.
ShipDate	Date	False		Shipment date entered.
ArrivalDate	Date	False		It is the arrival date entered.
NeedGiftWrap	Boolean	False		Presence or absence of gift wrapping.
GiftWrapType	String	False		Gift wrapping type.
GiftWrapMessage	String	False		Gift message.
NeedGiftWrapPaper	Boolean	False		Whether or not.
GiftWrapPaperType	String	False		Works type.
GiftWrapName	String	False		Enter name (message).
Option1Field	String	True		Option field Key information (field name).
Option1Type	Integer	True		Option field Key information (setting).
Option1Value	String	True		Option field Input contents.
Option2Field	String	True		Option field Key information (field name).
Option2Type	Integer	True		Option field Key information (setting).
Option2Value	String	True		Option field Input contents.
ShipFirstName	String	False		Destination name.
ShipFirstNameKana	String	False		Destination name phonetic.
ShipLastName	String	False		Destination surname.
ShipLastNameKana	String	False		Destination surname phonetic.
ShipPrefecture	String	False		Delivery destination Prefecture In case of overseas 'Other' is entered.
ShipPrefectureKana	String	False		Destination prefecture phonetic.
ShipZipCode	String	False		Delivery addressee postal code.
ShipCity	String	False		Destination city / county.
ShipCityKana	String	False		Destination city / county phonetic.
ShipAddress1	String	False		Destination address 1.
ShipAddress1Kana	String	False		Destination address 1 phonetic.
ShipAddress2	String	False		Destination address 2.
ShipAddress2Kana	String	False		Destination address 2 phonetic.
ShipPhoneNumber	String	False		Destination telephone number.
ShipEmgPhoneNumber	String	False		Destination telephone number (urgent).
ShipSection1Field	String	False		Addressee affiliation 1 Field name.
ShipSection1Value	String	False		Addressee affiliation 1 input information.
ShipSection2Field	String	False		Addressee affiliation 2 Field name.
ShipSection2Value	String	False		Addressee affiliation 2 input information.
OperationUser	String	False		It is the registered name of Yahoo! JAPAN business ID who carried out update work.
YamatoCoopStatus	Integer	True		It is a status that shows the current status of the link to Yamato Transport. The allowed values are 0, 1, 2, 3, 4.
CollectionDate	Date	True		The date when Yamato Transport collected the cargo.
CashOnDeliveryTax	Integer	False		The tax amount for the delivery payments.
NumberUnitsShipped	Integer	True		The number of packages sent by Yamato Transport.
ShipRequestTimeZoneCode	Integer	True		Preferred delivery time zone number. Blank if not specified, 101: Morning (8:00 to 12:00), 102: 14:00 to 16:00, 103: 16:00 to 18:00, 104: 18:00 to 20:00, 105: 19:00 to 21:00. The allowed values are 101, 102, 103, 104, 105.
ShipInstructType	Integer	True		The used delivery service category. 1: Direct cooperation, 2: Via couriers, 101: Yamato P & D. The allowed values are 1, 2, 101.
ShipInstructStatus	Integer	True		The status of orders in Yamatopic & Delivery. 0: Not applicable, 100: Shipping instruction not yet accepted, 101: Waiting for shipping instruction, 102: Cancelled shipping, 103: Shipping instruction completed. 104: Shipping completed, 105: Delivery completed, 106: Undeliverable. The allowed values are 0, 101, 102, 103, 104, 105, 106.
IsEazy	Boolean	True		It is an Order Flag.

ProductOptions

Return the list of options for the specified product.

Select

The Cloud will use the Yahoo Shopping 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 and/or SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductOptions WHERE ItemCode = 'CD001'

SELECT * FROM ProductOptions WHERE ItemCode = 'CD001' AND SellerId = 'store'

Insert

ItemCode, Name, SpecName are required for an Insert

INSERT INTO ProductOptions (Name, SpecId, SpecName, SpecValue, ItemCode) VALUES ('optionName', '1234', 'optionSpecificationName', '3456', 'CD000001')

Update

Yahoo Shopping allows updates for the Name, SpecId, SpecValue, SpecName columns. OptionValueId is required. This is a composite key containing the option name and the option specification value.

UPDATE [ProductOptions] SET Name = 'SizeRename', SpecId = '123', SpecName = 'Medium', SpecValue = '234' WHERE OptionValueId = 'Size|Small' AND ItemCode = 'CD000001'

Delete

A product option can be deleted by providing the ItemCode and OptionValueId and issuing a DELETE statement

DELETE FROM ProductOptions WHERE ItemCode = 'CD000001' AND OptionValueId = 'SizeRename|Medium'

Columns


Name	Type	ReadOnly	References	Description
ItemCode [KEY]	String	False		Product code
SellerId	String	False		Id of the seller.
OptionValueId [KEY]	String	True		Id of the option value.
Type	Integer	True		Option type 1: Normal option (with inventory setting), 2: Normal option (no inventory setting). The allowed values are 1, 2.
Name	String	False		Option name.
SpecId	String	False		Option spec ID.
Length	String	True		Option length.
SpecValue	String	False		Specification value of option value.
SpecName	String	False		Specification name of option value.

Products

Return the list of registered products of your store.

Select

The Cloud will use the Yahoo Shopping 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.

StoreCategoryKey and/or SellerId support the = operator.
ItemCode supports the =, LIKE operator.
Name supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM Products WHERE StoreCategoryKey = 'category_key'

SELECT * FROM Products WHERE ItemCode = 'CD001' AND SellerId = 'store'

SELECT * FROM Products WHERE Name LIKE '%prod_name%'

Insert

To add a product you specify the ItemCode (required), Name, Path, ProductCategory, Price, SalePrice, OriginalPrice, MemberPrice, ReleaseDate, display, Headline, Caption ,Abstract, Explanation, Additional1, Additional2, Additional3, SpAdditional, ShipWeight, Taxable, PointCode, MetaDesc, HiddenPageFlag, TemplateName, SaleLimit, BrandCode, ProductCode, JanCode, Delivery, Condition, Options, Subcodes, PostageSet columns.

INSERT INTO Products (Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display )  VALUES ('productName1', 'CD0001', 5000, 4000, 3000, '2018-06-25T03:00:00.000+02:00', '2018-05-25T03:00:00.000+02:00', 0)

Update

Yahoo Shopping allows updates for the Name, Path, ProductCategory, Price, SalePrice, OriginalPrice, MemberPrice, ReleaseDate, display, Headline, Caption ,Abstract, Explanation, Additional1, Additional2, Additional3, SpAdditional, ShipWeight, Taxable, PointCode, MetaDesc, HiddenPageFlag, TemplateName, SaleLimit, BrandCode, ProductCode, JanCode, Delivery, Condition, Options, Subcodes, PostageSet columns.

Update Products SET Name = 'ProductName', Path = 'CategoryPage:SubCategory', ProductCategory = '12345', Price = 110 , SalePrice = 109, OiginalPrice = 111 , MemberPrice = 108 , ReleaseDate = '2013-06-25T03:00:00.000+02:00', display = 1 ,Headline = ' headline text', Caption = 'tset caption', Abstract = 'sample Abstract', Explanation = 'sample Explanation', Additional1 = 'sample Additional1', Additional2 = 'sample Additional2' , Additional3 = 'sample Additional3', SpAdditional = 'sample SpAdditional', ShipWeight = 234, Taxable = 0, PointCode = 'D05' , MetaDesc = 'sample MetaDesc', HiddenPageFlag = '0' , TemplateName = 'IT02', SaleLimit = 100, BrandCode = '12312', ProductCode ='04-7282' , JanCode = '4971275472819' , Delivery = 3, Condition= 0, PostageSet = 0 WHERE ItemCode = 'CD001'

Update Products SET Options = '<Options><Option type = \"2\" name = \"Color\" specId = \"123\"> <Value specValue = \"23\" name = \"Red\"/> <Value specValue = \"34\" name = \"Blue\"/> </Option><Option type = \"1\" name = \"Size\" specId = \"24181\"> <Value specValue = \"210764\" name = \"Large\"/> </Option></Options>', SubCodes = ' <SubCodes> <SubCode code = \"21342\" quantity = \"\" stockClose = \"0\"> <Option name = \"Size\" value = \"Large\"/> <Option name = \"Color\" value = \"Blue\"/> <LeadTimeInStock>4000</LeadTimeInStock> <LeadTimeOutStock>2000</LeadTimeOutStock> </SubCode> <SubCode code = \"211342\" quantity = \"\" stockClose = \"0\"> <Option name = \"Size\" value = \"Large\"/> <Option name = \"Color\" value = \"Red\"/> <LeadTimeInStock></LeadTimeInStock> <LeadTimeOutStock></LeadTimeOutStock> </SubCode> </SubCodes>' WHERE ItemCode = 'CD001'

Upsert

Yahoo Shopping allows upsert for the Name, Path, Price, SalePrice, OriginalPrice, MemberPrice, ReleaseDate, display, Headline, Caption ,Abstract, Explanation, Additional1, Additional2, Additional3, SpAdditional, ShipWeight, Taxable, PointCode, MetaDesc, HiddenPageFlag, TemplateName, SaleLimit, BrandCode, ProductCode, JanCode, Delivery, Condition columns.

UPSERT INTO Products (Name, ItemCode, Path, Price) VALUES ('someName', 'CD0001', 'CategoryPage:SubCategory', 110)

Batch Update

Yahoo Shopping allows batch updates for Name, OriginalPrice, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart and Display columns.

INSERT INTO Products#TEMP (Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display ) VALUES ('productName1', 'CD0001', 5000, 4000, 3000, '2018-06-25T03:00:00.000+02:00', '2018-05-25T03:00:00.000+02:00', 0)

INSERT INTO Products#TEMP (Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display ) VALUES ('productName2', 'CD0002', 6000, 5000, 2000, '2018-07-25T03:00:00.000+02:00', '2018-06-25T03:00:00.000+02:00', 1)

UPDATE Products SET (Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display ) SELECT Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display  FROM [Products#TEMP]

Delete

A product be deleted by providing the ItemCode and issuing a DELETE statement

DELETE FROM Products WHERE ItemCode = 'CD000001'

Batch Delete

Several products be deleted by providing the ItemCodes and issuing a DELETE statement

INSERT INTO DeleteProducts#TEMP (ItemCode) VALUES ('CD000001')

INSERT INTO DeleteProducts#TEMP (ItemCode) VALUES ('CD000002')

DELETE FROM Products WHERE EXISTS (SELECT ItemCode FROM DeleteProducts#TEMP)

Columns


Name	Type	ReadOnly	References	Description
ItemCode [KEY]	String	False		Product code.
HasSubcode	Integer	True		With subcode. 1: With subcode, 0: No subcode code The allowed values are 0, 1.
SellerId	String	False		ID of the store account.
Name	String	False		The name of the product.
ProductCategory	String	False		Product category ID.
StoreCategoryName	String	True		The page name of the store category.
Path	String	False		The path of the store category. (Category names separated by colon).
Price	Integer	False		Regular selling price.
SalePrice	Integer	False		Special price.
OriginalPrice	Integer	False		List price.
OriginalPriceEvidence	String	True		Evidence URL.
MemberPrice	Integer	False		Price for members.
SalePeriodStart	Datetime	False		Sales start date and time.
SalePeriodEnd	Datetime	False		End of sale date.
SortOrder	Integer	True		Product display order under store category.
SortPriority	Integer	True		Product display priority order under store category.
Quantity	Integer	True		Inventory (There are items only when stock = true request is specified.).
Display	Integer	False		Page release. 1: Public, 0: Not Disclosed. The allowed values are 0, 1.
EditingFlag	Integer	True		Edit flag. 1: A state that has not been reflected at the front since being edited, 0: Reflected. The allowed values are 0, 1.
Headline	String	False		Catch copy.
Caption	String	False		Product Description.
Abstract	String	False		One word comment.
Explanation	String	False		Product information.
Additional1	String	False		Free space 1.
Additional2	String	False		Free space 2.
Additional3	String	False		Free space 3.
SpAdditional	String	False		Free space for smartphone.
RelevantLinks	String	False		Recommended product information.
CartRelatedItems	String	False		Recommended related item information.
TaxRateType	Decimal	False		Recommended related item information. The allowed values are 0.1, 0.8.
ShipWeight	Integer	False		Product weight.
Taxable	Integer	False		Tax object. 1: Taxation , 0: Tax exemption. The allowed values are 0, 1.
TaxrateType	Decimal	False		Tax rate object. The allowed values are 0.1, 0.08.
ReleaseDate	Date	False		Release date.
PointCode	String	False		Point magnification code.
MetaKey	String	True		META keywords.
MetaDesc	String	False		META description .
HiddenPage	String	True		Hidden page information.
HiddenPageFlag	String	False		Hidden page flag. 0: Normal, 1: Hidden page. The allowed values are 0, 1.
HiddenPageId	String	True		Hidden page ID.
HiddenPagePassword	String	True		Password for hidden pages.
TemplateId	String	True		Design template ID.
TemplateName	String	False		Design template name.
SaleLimit	Integer	False		Purchase limit.
SpCode	String	False		Promotional code.
BrandCode	String	False		Brand code.
ProductCode	String	False		Product Code.
JanCode	String	False		Japanese Article Number Code.
Delivery	Integer	False		Free shipping set. 0: None, 1: Free shipping, 2: Including shipping fee ( Because shipping costs are treated as free shipping, it will be saved as 1 if 2 is specified), 3: Conditional shipping free. The allowed values are 0, 1, 2, 3.
Image	String	True		URL of product preview image.
LibImage1	String	True		Product details URL of preview image 1.
LibImage2	String	True		Product details URL of preview image 2.
LibImage3	String	True		Product details URL of preview image 3.
LibImage4	String	True		Product details URL of preview image 4.
LibImage5	String	True		Product details URL of preview image 5.
LibImage6	String	True		Product details URL of preview image 6.
LibImage7	String	True		Product details URL of preview image 7.
LibImage8	String	True		Product details URL of preview image 8.
LibImage9	String	True		Product details URL of preview image 9.
LibImage10	String	True		Product details URL of preview image 10.
LibImage11	String	True		Product details URL of preview image 11.
LibImage12	String	True		Product details URL of preview image 12.
LibImage13	String	True		Product details URL of preview image 13.
LibImage14	String	True		Product details URL of preview image 14.
LibImage15	String	True		Product details URL of preview image 15.
LibImage16	String	True		Product details URL of preview image 16.
LibImage17	String	True		Product details URL of preview image 17.
LibImage18	String	True		Product details URL of preview image 18.
LibImage19	String	True		Product details URL of preview image 19.
LibImage20	String	True		Product details URL of preview image 20.
AstkCode	Integer	False		Chiku/Misuzu code. 0: Non-compliant, 1: Matsuku, 2: Kokutsuku. The allowed values are 0, 1, 2.
Condition	Integer	False		State of goods. 0: New article, 1: Used. The allowed values are 0, 1.
Spec1Id	Integer	True		Specification 1: Spec ID.
Spec1Name	String	True		Specification 1: Display name of spec.
Spec1Value	String	True		Specification 1: Specification value ID.
Spec1ValueName	String	True		Specification 1: Display name of spec value.
Spec2Id	Integer	True		Specification 2: Spec ID.
Spec2Name	String	True		Specification 2: Display name of spec.
Spec2Value	String	True		Specification 2: Specification value ID.
Spec2ValueName	String	True		Specification 2: Display name of spec value.
Spec3Id	Integer	True		Specification 3: Spec ID.
Spec3Name	String	True		Specification 3: Display name of spec.
Spec3Value	String	True		Specification 3: Specification value ID.
Spec3ValueName	String	True		Specification 3: Display name of spec value.
Spec4Id	Integer	True		Specification 4: Spec ID.
Spec4Name	String	True		Specification 4: Display name of spec.
Spec4Value	String	True		Specification 4: Specification value ID.
Spec4ValueName	String	True		Specification 4: Display name of spec value.
Spec5Id	Integer	True		Specification 5: Spec ID.
Spec5Name	String	True		Specification 5: Display name of spec.
Spec5Value	String	True		Specification 5: Specification value ID.
Spec5ValueName	String	True		Specification 5: Display name of spec value.
Spec6Id	Integer	True		Specification 6: Spec ID.
Spec6Name	String	True		Specification 6: Display name of spec.
Spec6Value	String	True		Specification 6: Specification value ID.
Spec6ValueName	String	True		Specification 6: Display name of spec value.
Spec7Id	Integer	True		Specification 7: Spec ID.
Spec7Name	String	True		Specification 7: Display name of spec.
Spec7Value	String	True		Specification 7: Specification value ID.
Spec7ValueName	String	True		Specification 7: Display name of spec value.
Spec8Id	Integer	True		Specification 8: Spec ID.
Spec8Name	String	True		Specification 8: Display name of spec.
Spec8Value	String	True		Specification 8: Specification value ID.
Spec8ValueName	String	True		Specification 8: Display name of spec value.
Spec9Id	Integer	True		Specification 9: Spec ID.
Spec9Name	String	True		Specification 9: Display name of spec.
Spec9Value	String	True		Specification 9: Specification value ID.
Spec9ValueName	String	True		Specification 9: Display name of spec value.
Spec10Id	Integer	True		Specification 10: Spec ID.
Spec10Name	String	True		Specification 10: Display name of spec.
Spec10Value	String	True		Specification 10: Specification value ID.
Spec10ValueName	String	True		Specification 10: Display name of spec value.
Options	String	False		Option information .
Inscriptions	String	False		Inclusion information .
SubCodes	String	False		Individual product code information.
ShowStock	Integer	True		Inventory display setting (product individual setting). 1: Stock number display, 2: Stock display.
UpdateTime	Datetime	True		Update date.
LeadTimeInStock	Datetime	False		Shipping date information management number when stocked.
LeadTimeOutStock	Datetime	False		Shipment date information management number when out of stock.
KeepStock	Integer	False		Set at the time of cancellation from the orderer, set the stock back. 0: Do not take, stock at the time of cancellation, 1: Return stock at the time of cancellation (Initial value).
StockClose	Integer	True		Stock Close Flag. 0: Normal State, 1: Stock Closed State, Empty: Subcode Exists. The allowed values are 0, 1.
StoreCategoryKey	String	True	Categories.PageKey	The page key of the store category.
PostageSet	Integer	False		Delivery group management number tied to the product, values 1-20. The allowed values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20.
PickAndDeliveryCode	String	False		Barcode information.
PickAndDeliveryTransportRuleType	Integer	False		The allowed values are 0, 1, 2, 3, 4, 5.
EcoSettingId	String	False		This column indicates the environmental label name (1 to 100) or the eco keyword name (101 and above).
EcoSettingEvidenceUrl	String	False		This column indicates the environmental label/eco keyword evidence URL.
GroupingId	String	False		Grouping ID
Variation1SpecId	String	False		Variation 1 - Spec ID
Variation1Name	String	False		Variation 1 - Display name
Variation2SpecId	String	False		Variation 2 - Spec ID
Variation2Name	String	False		Variation 2 - Display name
Variation3SpecId	String	False		Variation 3 - Spec ID
Variation3Name	String	False		Variation 3 - Display name
Variation4SpecId	String	False		Variation 4 - Spec ID
Variation4Name	String	False		Variation 4 - Display name
Variation5SpecId	String	False		Variation 5 - Spec ID
Variation5Name	String	False		Variation 5 - Display name

ProductSubCodes

Return the list of options for the specified product.

Select

The Cloud will use the Yahoo Shopping 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 and/or SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductSubcodes WHERE ItemCode = 'CD001'

SELECT * FROM ProductSubcodes WHERE ItemCode = 'CD001' AND SellerId = 'store'

Insert

ItemCode, Code, OptionName, OptionValue are required for an Insert

INSERT INTO ProductSubcodes (Code, LeadTimeInStock, LeadTimeOutStock, OptionName, OptionValue, ItemCode) VALUES ('001', '1000', '4000', 'Color', 'Red', 'CD000001')

Update

Yahoo Shopping allows updates for the Code, OptionName, OptionValue, LeadTimeInStock, LeadTimeOutStock columns. CodeOptionId is required. This is a composite key containing the subcode code and the option name.

UPDATE [ProductSubcodes] SET Code = '002', LeadTimeInStock = '2000', LeadTimeOutStock = '4000', OptionName = 'Size', OptionValue = 'Small' WHERE CodeOptionId = '001|Color' AND ItemCode = 'CD000001'

Delete

A product subcode can be deleted by providing the ItemCode and CodeOptionId and issuing a DELETE statement

DELETE FROM ProductSubcodes WHERE ItemCode = 'CD000001' AND CodeOptionId = '002|Color'

Columns


Name	Type	ReadOnly	References	Description
ItemCode [KEY]	String	True		Product code
SellerId	String	True		Id of the seller.
CodeOptionId [KEY]	String	True		Id of the subcode option.
Code	String	False		Individual product code.
Quantity	Integer	True		Subcode quantity.
StockClose	Integer	True		Subcode stock close indicator.
OptionName	String	False		Option name.
OptionValue	String	False		Option value.
LeadTimeInStock	String	False		Inventory ship date value.
LeadTimeOutStock	String	False		Out of stock value of shipment date.

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 - Yahoo Shopping Views


Name	Description
Categories	Retrieve the list of store categories.
ItemImageList	List of the uploaded product images.
OrderChangeHistory	Provides update history information for a single order.
OrderCount	Acquire the number of new orders and new pre-order orders.
OrderLineItemDetails	Returns detailed data for each Order Line Item.
OrderLineItemInscriptions	Returns data from a sample table.
OrderLineItemOptions	Returns data from a sample table.

ItemImageList

List of the uploaded product images.

Select

The Cloud will use the Yahoo Shopping 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.

SearchTerm, StoreCategoryKey and SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM ItemImageList WHERE SearchTerm = 'img'

SELECT * FROM ItemImageList WHERE StoreCategoryKey = 'store_category'

Columns


Name	Type	References	Description
Id [KEY]	String		Product image identifier.
SellerId	String		Seller Id.
SearchTerm	String		Specify search word when performing character search on image name (Partial Match).If you specify more than one space, it will be an AND search.
StoreCategoryKey	String	Categories.PageKey	When acquiring the image list by store category unit, specify the page key of the store category.
Name	String		Image ID (store account _ character string excluding extension of image name)
UrlModeA	String		URL for A image display mode.
UrlModeB	String		URL for B image display mode.
UrlModeC	String		URL for C image display mode.
UrlModeD	String		URL for D image display mode.
UrlModeE	String		URL for E image display mode.
UrlModeF	String		URL for F image display mode.
UrlModeG	String		URL for G image display mode.
UrlModeH	String		URL for H image display mode.
UrlModeI	String		URL for I image display mode.
UrlModeJ	String		URL for J image display mode.
UrlModeK	String		URL for K image display mode.
UrlModeL	String		URL for L image display mode.
Size	String		Horizontal size of original image.
FileSize	Long		File size of original image (bytes).
UploadDate	Datetime		Update date.
PublishDate	Datetime		Reflection date.
EditingFlag	Integer		Edit flag 0: Reflected 1: State not reflected at the front after being edited.

OrderChangeHistory

Provides update history information for a single order.

Select

The Cloud will use the Yahoo Shopping 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 and SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderChangeHistory WHERE OrderID = 'store_00001'

Columns


Name	Type	References	Description
OrderId [KEY]	String	Orders.OrderId	Order ID.
SellerId	String		Store account
UpdateTime	Datetime		Update date and time.
UpdatePerson	String		Updater (one of the following will be included): Name of worker associated with Yahoo! JAPAN business ID, Yahoo! JAPAN Business ID, Yahoo! JAPAN ID, system.
ChangeField	String		Changed field.
ChangeValue	String		Changed value.
ChangeItemLineId	String		Changed Line Id.

OrderCount

Acquire the number of new orders and new pre-order orders.

Select

The Cloud will use the Yahoo Shopping 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.

SellerId supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderCount WHERE SellerId = 'store'

Columns


Name	Type	References	Description
SellerId [KEY]	String		Specify the store account.
NewOrder	Integer		New order number (order details unread number).
NewReserve	Integer		Number of new reservations.
WaitPayment	Integer		Number of queue waiting.
WaitShipping	Integer		Number of items waiting for shipment.
Shipping	Integer		Number of shipping processes.
Reserve	Integer		Number of reservations.
Holding	Integer		Number of holds.
WaitDone	Integer		Order completion wait count.
Suspect	Integer		Number of mischievous orders.
SettleError	Integer		Number of settlement errors.
Refund	Integer		Number of refundable items.
AutoDone	Integer		Auto orders completed.
AutoWorking	Integer		Automatic order hold cancel count.
Release	Integer		Number of scheduled release orders.
NoPayNumber	Integer		Payment number not issued.
StoreStatus1	Integer		Store status 1 number.
StoreStatus2	Integer		Store status 2 number.
StoreStatus3	Integer		Store status 3 number.
StoreStatus4	Integer		Store status 4 number.
StoreStatus5	Integer		Store status 5 number.
StoreStatus6	Integer		Store status 6 number.
StoreStatus7	Integer		Store status 7 number.
StoreStatus8	Integer		Store status 8 number.
StoreStatus9	Integer		Store status 9 number.
StoreStatus10	Integer		Store status 10 number.

OrderLineItemDetails

Returns detailed data for each Order Line Item.

Columns


Name	Type	References	Description
OrderId [KEY]	String	Orders.OrderId	Order ID.
Line_LineId [KEY]	Integer		Product line ID.
ItemId	String		Product ID.
SellerId	String		Store account ID.
OrderTime	Datetime		The date and time when the order was made.
OperationUser	String		It is the registered name of Yahoo! JAPAN business ID who carried out update work.
OrderStatus	Integer		Status of the order. 1: During reservation, 2: In process, 3: Hold, 4: Cancel, 5: Completed. The allowed values are 0, 1, 2, 3, 4, 5, 8.
CancelReason	Integer		Cancellation reason: Order Cancellation - 100: Cancel, 110: Returned Item, 120: Not Received, 130: Address Unknown, 140: Receiving Refused, 150: No Connection, 160: Duplicate Order, 170: Payment Unavailable, 180: Other, 300: Mistakenly Ordered, 310: Customer Using Points They Forgot to Use, 320: Customer Using Coupon They Forgot to Use, 330: Customer Found Cheaper Price, 340: Shipping Cost Too High, 350: Change of Shipping Destination, 360: Change of Shipping Method, 370: Change of Payment Method, 380: Credit Card Not Available, \| Store convenience - 200: Settlement Method Convenience, 210: Missing Item, 220: Discontinued, 230: Other \| Other - 0: Cancel reason n/a System cancellation \| blank: Order not canceled.
CancelReasonDetail	String		The reason why the store has entered a cancellation reason when the reason is Store Convenience 230 (Other)
ParentOrderId	String		The splitting order ID when an order is split.
ChildOrderId	String		The second splitting order ID when an order is split.
MobileCarrierName	String		The type of mobile carrier.
NeedSnl	Boolean		Store newsletter opt-in flag.
LastUpdateTime	Datetime		The last modification date of order information.
SuspectMessage	String		A message when an order is judged as mischievous.0: Non-naughty order, 1: Mischievous order, 2: Mischievious canceled order.
SendConfirmTime	Datetime		The date and time of sending the order confirmation email sent when the order is newly entered.
SendPayTime	Datetime		The mail transmission date sent at the time of settlement.
PrintSlipTime	Datetime		The date and time when the order slip was output.
PrintDeliveryTime	Datetime		The date and time when we output the invoice.
PrintBillTime	Datetime		The date and time when the invoice was output.
BuyerComments	String		The comment string displayed by the buyer.
SellerComments	String		The comment string displayed by the store in the store.
Notes	String		A memo in the store when the store is entered with the order management tool.
Referer	String		Referrer information covering domain, search keywords, etc.
EntryPoint	String		The URL of the store page where the buyer entered the target store.
HistoryId	String		An ID that manages the update history of orders.
UsageId	String		The coupon usage ID.
UseCouponData	String		Detailed information on the coupon information.
TotalCouponDiscount	Integer		Of the amount discounted by the store coupon of all the products associated with one order, this becomes the discount total value other than the shipping fee.
ShippingCouponFlg	Integer		Free shipping availability. 0: None, 1: Present.
ShippingCouponDiscount	Integer		It is the discount amount of the carriage when applying free shipping coupons.
CampaignPoints	String		Comma separated list of breakdown points.
IsMultiShip	Boolean		Indicates if there is a multiple shipping order.
MultiShipId	String		ID that identifies multiple delivery orders.
YamatoCoopStatus	Integer		Caution: Yamato Topic and Delivery Dedicated Item This status indicates the current state of cooperation with Yamato Transport. Only [3: Linked] will be the status that linked. The allowed values are 0, 1, 2, 3, 4.
FraudHoldStatus	Integer		0 or null: Low risk of fraud, 1: Rule pending review, 2: Release rule hold, 3: Rule abuse confirmed. The allowed values are 0, 1, 2, 3.
PublicationTime	Datetime		The time that can be obtained from the orderList, such as when the illegal hold is released, is set.
Shipping_CollectionDate	Date		The date when Yamato Transport collected the cargo.
Shipping_CashOnDeliveryTax	Integer		The tax amount for the delivery payments.
Shipping_NumberUnitsShipped	Integer		The number of packages sent by Yamato Transport.
Shipping_IsEazy	Boolean		It is an Order Flag.
Shipping_ShipRequestTimeZoneCode	Integer		Preferred delivery time zone number. Blank if not specified, 101: Morning (8:00 to 12:00), 102: 14:00 to 16:00, 103: 16:00 to 18:00, 104: 18:00 to 20:00, 105: 19:00 to 21:00. The allowed values are 101, 102, 103, 104, 105.
Shipping_ShipInstructType	Integer		The used delivery service category. 1: Direct cooperation, 2: Via couriers, 101: Yamato P & D. The allowed values are 1, 2, 101.
Shipping_ShipInstructStatus	Integer		The status of orders in Yamatopic & Delivery. 0: Not applicable, 100: Shipping instruction not yet accepted, 101: Waiting for shipping instruction, 102: Cancelled shipping, 103: Shipping instruction completed. 104: Shipping completed, 105: Delivery completed, 106: Undeliverable. The allowed values are 0, 101, 102, 103, 104, 105, 106.
Line_PickAndDeliveryCode	String		The bar code information required for delivery.
Line_PickAndDeliveryTransportRuleType	Integer		The allowed values are 0, 1, 2, 3, 4, 5.
Line_YamatoUndeliverableReason	String		The reason why Yamato delivery is not possible.
Detail_PayCharge	Integer		The fee set by the store (cash on delivery commission etc.). The settlement fee of Yahoo! settlement is different.
Detail_ShipCharge	Integer		Shipping fee (postage free coupon discount after deduction).
Detail_GiftWrapCharge	Integer		Gift wrapping fee.
Detail_Discount	Integer		Discount. The value entered in the price discount column on the store creator Pro after the store side is entered.
Detail_Adjustments	Integer		Adjustment amount.
Detail_SettleAmount	Integer		The same value as the total amount (TotalPrice).
Detail_UsePoint	Integer		Number of points used.
Detail_TotalPrice	Integer		Subtotal - usage point + gift wrapping fee + fee - discount + postage + adjustment amount - mall coupon discount amount.
Detail_IsGetPointFixAll	Boolean		Indicates whether or not the process of finalizing the grant points of all lines (goods) has been completed.
Detail_TotalMallCouponDiscount	Integer		Indicates the total value of the amount discounted at the mall coupon.
Detail_SettlePayAmount	Integer		When the order is split, this will not reflect the split amount. The total amount will reflect this.
Detail_PayMethodAmount	Decimal		Billing address Affiliation 2 Input information.
Detail_CombinedPayMethodAmount	Decimal		Billing address Affiliation 2 Input information.
Detail_IsLogin	Boolean		Login order.
Detail_FspLicenseCode	String		For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
Detail_FspLicenseName	String		For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
Detail_GuestAuthId	String		Guest authorization Id for guest orders only.
Payment_PayStatus	Integer		Deposit status. 0: Waiting for payment, 1: Payment already made The allowed values are 0, 1.
Payment_SettleStatus	Integer		Settlement status. 1: Settlement application, 2: Waiting for payment, 3: Payment completion, 4: Waiting for payment, 5: Completion of settlement, 6: Cancel, 7: Refund, 8: Expired, 9: Payment application, 10: Authorization error, 11: Sales cancelled, 12: Suica address error. The allowed values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12.
Payment_PayType	Integer		Payment classification. 0: Postpay, 1: Prepay. The allowed values are 0, 1.
Payment_PayKind	Integer		Payment type. 0: Card, 1: Internet banking, 2: Carrier settlement, 3: Transfer, 4: Cash on delivery, 5: Convenience store, 6: Electronic money 7: Other. The allowed values are 0, 1, 2, 3, 4, 5, 6, 7.
Payment_PayMethod	String		Payment method number. payment_a 1: Credit card payment, payment_a 6: Convenience store payment (7-Eleven), payment_a 7: Convenience store payment (Others), payment_a 8: Mobile Suica payment, payment_a 9: Docomo Mobile payment, payment_a 10: au Easy settlement, payment_a 11: Soft bank collectively payment, payment_a 15: Payee, payment_a 16: Yahoo Money / deposit payment, payment_b [1-6]: bank transfer (name is free setting of store), payment_c1: Japan Post Bank (prepayment), payment_c2: Japan Post Bank (postpay), payment_c3: registered mail, payment_d1: cash on delivery goods, payment_e [1-15 ]: Free payment method name of the store, payment_z1: Full payment of points.
Payment_PayMethodName	String		Payment method name.
Payment_SellerHandlingCharge	Integer		A settlement fee for the store's burden.
Payment_PayActionTime	Datetime		Purchase history detail screen It contains the payment update date and time.
Payment_PayDate	Date		The deposit date entered in the order management tool.
Payment_PayNotes	String		The contents of the remarks column of the deposit entered by the order management tool.
Payment_SettleId	String		Settlement ID.
Payment_CardBrand	String		In case of credit card it is the card brand name (VISA etc).
Payment_CardNumber	String		Only store of original merchant store contract is available. Encrypted character string information can be acquired.
Payment_CardNumberLast4	String		The last four digits of the credit card.
Payment_CardExpireYear	String		The expiration year of the card.
Payment_CardExpireMonth	String		The expiration month of the card.
Payment_CardPayType	Integer		Card payment classification. 1: Lump sum payment, 2: Bonus lump sum payment, 3: Ribbon payment, 4: Installment payment The allowed values are 1, 2, 3, 4.
Payment_CardHolderName	String		The name of the cardholder
Payment_CardPayCount	Integer		The number of payments in installments.
Payment_CardBirthDay	String		Card date of birth.
Payment_UseYahooCard	Boolean		Yahoo! JAPAN JCB Card Availability.
Payment_UseWallet	Boolean		Wallet availability.
Payment_NeedBillSlip	Boolean		Whether or not you wish to have an invoice when ordering entered by the purchaser.
Payment_NeedDetailedSlip	Boolean		The presence or absence of the requested statement when ordering entered by the purchaser.
Payment_NeedReceipt	Boolean		Whether there is a receipt at the time of ordering entered by the purchaser.
Payment_AgeConfirmField	String		The field name set by the store in the age confirmation field.
Payment_AgeConfirmValue	Integer		Age confirmation field numeric input.
Payment_AgeConfirmCheck	Boolean		If the box has been checked when there is an age check check box.
Payment_BillAddressFrom	String		Billing address. P: UDB home address, B: UDB work address, ship: same as the addressee, O1: others, O2: other, O3: other 3 O4: other 4 O: other input.
Payment_BillFirstName	String		Billing Name.
Payment_BillFirstNameKana	String		Billing name (phonetic).
Payment_BillLastName	String		Billing surname.
Payment_BillLastNameKana	String		Billing last name (phonetic).
Payment_BillZipCode	String		Billing Postal Code.
Payment_BillPrefecture	String		Billing address Prefecture In case of overseas 'Other' is entered.
Payment_BillPrefectureKana	String		Billing prefecture phonetic.
Payment_BillCity	String		Billing city / county.
Payment_BillCityKana	String		Billing County District Phonetic.
Payment_BillAddress1	String		Billing address 1.
Payment_BillAddress1Kana	String		Billing address 1 phonetic.
Payment_BillAddress2	String		Billing address 2.
Payment_BillAddress2Kana	String		Billing address 2 phonetic.
Payment_BillPhoneNumber	String		Billing telephone number.
Payment_BillEmgPhoneNumber	String		Billing telephone number (urgent).
Payment_BillMailAddress	String		Billing E-mail address.
Payment_BillSection1Field	String		Billing address Affiliation 1 Field name.
Payment_BillSection1Value	String		Billing address Affiliation 1 Input information.
Payment_BillSection2Field	String		Billing address Affiliation 2 Field name.
Payment_BillSection2Value	String		Billing address Affiliation 2 Input information.
Payment_CombinedPayType	Integer		Billing address Affiliation 2 Input information.
Payment_CombinedPayKind	Integer		Billing address Affiliation 2 Input information.
Payment_CombinedPayMethod	String		Billing address Affiliation 2 Input information.
Payment_CombinedPayMethodName	String		Billing address Affiliation 2 Input information.
Payment_PayNo	String		Payment number.
Payment_PayNoIssueDate	Datetime		Payment number issue date / time.
Payment_ConfirmNumber	String		Authorization number.
Payment_PaymentTerm	Datetime		Payment due date for convenience store payment, mobile Suica settlement, and payment settlement.
Payment_IsApplePay	Boolean		Availability of ApplePay.
Shipping_ShipStatus	Integer		Delivery status 0: Can not be shipped 1: Can be shipped 2: Shipping in progress 3: Shipped completed 4: Receiving completed. The allowed values are 0, 1, 2, 3, 4.
Shipping_ShipMethod	String		Delivery method number: any one of postage 1 - 14, 16.
Shipping_ShipMethodName	String		Delivery method name.
Shipping_ShipRequestDate	Date		Desired delivery day.
Shipping_ShipRequestTime	String		Delivery time desired.
Shipping_ShipNotes	String		Delivery note.
Shipping_ShipCompanyCode	String		Delivery company code 1000: Other 1001: Yamato Transport 1002: Sagawa Express 1003: Japan Post 1004: Seino Transportation.
Shipping_ShipInvoiceNumber1	String		Delivery slip number information of the shipping company that the store set with the tool or API.
Shipping_ShipInvoiceNumber2	String		Delivery slip number information of the shipping company that the store set with the tool or API.
Shipping_ShipInvoiceNumberEmptyReason	String		NULL: (Unregistered state) 101: For direct item from manufacturer's inventory 102: For goods that do not need shipping 103: For overseas receipt items 104: For direct contact from the delivery company 105: Document number Because it is not issued (can not be tracked) because of the delivery method.
Shipping_ShipUrl	String		Tracking URL of the shipping company that the store set with tools and APIs.
Shipping_ArriveType	Integer		Drinking 0: Normal 1 : School order 2: Matsutake order The allowed values are 0, 1, 2.
Shipping_ShipDate	Date		Shipment date entered.
Shipping_ArrivalDate	Date		It is the arrival date entered.
Shipping_NeedGiftWrap	Boolean		Presence or absence of gift wrapping.
Shipping_GiftWrapType	String		Gift wrapping type.
Shipping_GiftWrapMessage	String		Gift message.
Shipping_NeedGiftWrapPaper	Boolean		Whether or not.
Shipping_GiftWrapPaperType	String		Works type.
Shipping_GiftWrapName	String		Enter name (message).
Shipping_Option1Field	String		Option field Key information (field name).
Shipping_Option1Type	Integer		Option field Key information (setting).
Shipping_Option1Value	String		Option field Input contents.
Shipping_Option2Field	String		Option field Key information (field name).
Shipping_Option2Type	Integer		Option field Key information (setting).
Shipping_Option2Value	String		Option field Input contents.
Shipping_ShipFirstName	String		Destination name.
Shipping_ShipFirstNameKana	String		Destination name phonetic.
Shipping_ShipLastName	String		Destination surname.
Shipping_ShipLastNameKana	String		Destination surname phonetic.
Shipping_ShipPrefecture	String		Delivery destination Prefecture In case of overseas 'Other' is entered.
Shipping_ShipPrefectureKana	String		Destination prefecture phonetic.
Shipping_ShipZipCode	String		Delivery addressee postal code.
Shipping_ShipCity	String		Destination city / county.
Shipping_ShipCityKana	String		Destination city / county phonetic.
Shipping_ShipAddress1	String		Destination address 1.
Shipping_ShipAddress1Kana	String		Destination address 1 phonetic.
Shipping_ShipAddress2	String		Destination address 2.
Shipping_ShipAddress2Kana	String		Destination address 2 phonetic.
Shipping_ShipPhoneNumber	String		Destination telephone number.
Shipping_ShipEmgPhoneNumber	String		Destination telephone number (urgent).
Shipping_ShipSection1Field	String		Addressee affiliation 1 Field name.
Shipping_ShipSection1Value	String		Addressee affiliation 1 input information.
Shipping_ShipSection2Field	String		Addressee affiliation 2 Field name.
Shipping_ShipSection2Value	String		Addressee affiliation 2 input information.
Line_Title	String		Product title.
Line_SubCode	String		The subcode of the product when this value has been set.
Line_SubCodeOption	String		The subcode option when this value has been set. Both key & value.
Line_IsUsed	Boolean		Indicates whether it is a used item.
Line_ImageId	String		The product image ID.
Line_IsTaxable	Boolean		Tax object flag.
Line_Jan	String		Japanese Article Number code.
Line_ProductId	String		The product code (product number/model number).
Line_CategoryId	Integer		Category code.
Line_AffiliateRatio	String		Store burden rate.
Line_UnitPrice	Integer		Unit price of each item (amount after discount of store coupons) .
Line_ItemTaxRatio	Integer		Unit price of each item (amount after discount of store coupons) .
Line_Quantity	Integer		The quantity of each item.
Line_PointAvailQuantity	Integer		Points to be granted quantity.
Line_ReleaseDate	Date		Release date. This is only when there is input of release date. For release date bigger than order date, treat it as a pre-order.
Line_HaveReview	Boolean		Product review absence flag.
Line_PointFspCode	String		Point code by item. 10001 to 10015, 2001 to 20010.
Line_PointRatioY	Integer		Granted Point Magnification (Yahoo! JAPAN Burden).
Line_PointRatioSeller	Integer		Granted Point Magnification (Store Burden).
Line_UnitGetPoint	Integer		Number of credit points granted.
Line_IsGetPointFix	Boolean		Granted point determination flag.
Line_GetPointFixDate	Date		Granulation point determination date. After 14 days of order date, we will set the pre-order to 14 days after release date.
Line_CouponDiscount	Integer		Coupon discount amount.
Line_CouponUseNum	Integer		Number of applicable coupons.
Line_OriginalPrice	Integer		Unit price before discount.
Line_OriginalNum	Integer		Quantity before line splitting.
Line_LeadTimeStart	Date		Start of shipment date.
Line_LeadTimeEnd	Date		Shipment day end.
Line_LeadTimeText	String		Shipping date text.
Line_CouponData	String		Store coupons.
Line_ItemOption	String		Product options.
Line_Inscription	String		Inspections.
UseGiftCardData	String		Gift Card Data.
Detail_GiftCardDiscount	Integer		Amount of gift voucher used

OrderLineItemInscriptions

Returns data from a sample table.

Columns


Name	Type	References	Description
OrderId [KEY]	String	Orders.OrderId	Order ID.
LineId [KEY]	Integer		Product line ID.
OrderTime	Datetime		The date and time when the order was made.
SellerId	String		Store account ID.
ItemId	String		Product ID.
InscriptionIndex	Integer		It is only when an item is set up for the item. Item Inscription Index.
InscriptionName	String		It is only when an item is set up for the item. Item Inscription Name.
InscriptionValue	String		It is only when an item is set up for the item. Item Inscription Value.

OrderLineItemOptions

Returns data from a sample table.

Columns


Name	Type	References	Description
OrderId [KEY]	String	Orders.OrderId	Order ID.
LineId [KEY]	Integer		Product line ID.
OrderTime	Datetime		The date and time when the order was made.
SellerId	String		Store account ID.
ItemId	String		Product ID.
ItemOptionIndex	Integer		Item Option Index. This is only shown when product option is set.
ItemOptionName	String		Item Option Name. This is only shown when product option is set.
ItemOptionValue	String		Item Option Value. This is only shown when product option is set.

Stored Procedures

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

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

CData Cloud - Yahoo Shopping Stored Procedures


Name	Description
CancelOrderCoupon	Cancels the coupon adaptation of the specified order information.
ChangeOrderStatus	Change the order status of the specified order.
ChangePaymentStatus	Renewal status update function for managing payment status of orders.
ChangeShipmentStatus	Shipment status update function for managing order delivery status.
DeleteItemImage	Leave the product image in a state of waiting to be deleted.
GetAuthorizationStatus	Gets the authorization status of public key authentication.
IssuePaymentNumber	Issue payment number for payment by buyer for mobile Suica, convenience store settlement (Seven Eleven), convenience store settlement (other), payment order at Paisy.
MoveItems	Move multiple items in one batch to another category. (It does not reflect the front).
ReservePublish	Process or make reservations to reflect the saved content in a way that is visible to customers
SetItemDisplayPriority	Change display priorities of products under one store category at once. (It does not reflect the front).
SplitOrder	It provides the function of dividing one order into two orders.
SubmitItem	Individual product reflection

CancelOrderCoupon

Cancels the coupon adaptation of the specified order information.

Input


Name	Type	Required	Description
OrderId	String	True	Order ID.
SellerId	String	False	Store account.
OperationUser	String	False	Name of updater (Business ID registered name).

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

ChangeOrderStatus

Change the order status of the specified order.

Input


Name	Type	Required	Description
OrderId	String	True	Order ID
SellerId	String	False	Store account
IsPointFix	Boolean	True	Point determination necessity. When changing the order status to 'Complete', please be sure to set the point determination necessity to true. true: Points are finalized , false: The point is not fixed.
OperationUser	String	False	Name of updater (Business ID registered name)
OrderStatus	Integer	True	Order status. 1: In reservation, 2: Processing, 3: Hold, 4: Cancel, 5: Complete The allowed values are 1, 2, 3, 4, 5.
CancelReason	Integer	False	Cancellation reason code. Order Cancellation - 100: Cancel, 110: Returned, 120: Not Received, 130: Address Unknown, 140: Refuse Receipt, 150 Unsuccessful, 160 Duplicate Order, 170 Settlement Unavailable, 180 Others; Store Concerned, 200: Payment Method Concerned, 210: Missing Item, 220: Discontinued, 230: Other The allowed values are 100, 110, 120, 130, 140, 150, 160, 170, 180, 200, 210, 220, 230.
CancelReasonDetail	String	False	Reason for cancellation. If details are more than 10 characters, within 200 characters

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

ChangePaymentStatus

Renewal status update function for managing payment status of orders.

Input


Name	Type	Required	Description
OrderId	String	True	Order ID.
SellerId	String	False	Store account.
OperationUser	String	False	Name of updater (Business ID registered name).
PayStatus	Integer	True	Deposit status : 0: Waiting for payment, 1: Payment already made. The allowed values are 0, 1.
PayDate	Date	False	Deposit date.

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

ChangeShipmentStatus

Shipment status update function for managing order delivery status.

Input


Name	Type	Required	Description
OrderId	String	True	Order ID.
SellerId	String	False	Store account.
IsPointFix	Boolean	True	Point determination necessity. When changing the order status to 'Complete', please be sure to set the point determination necessity to true. true: Points are finalized, false: The point is not fixed.
OperationUser	String	False	Name of updater (Business ID registered name).
ShipStatus	Integer	True	Delivery status - 0: Can not be shipped, 1: Can be shipped, 2: Shipment in process, 3: Shipment complete, 4: Receipt complete The allowed values are 0, 1, 2, 3, 4.
ShipMethod	String	False	Delivery method: any one of postage 1 - 14, 16 (postage 15 is missing number) Store creator Pro order of delivery setting.
ShipNotes	String	False	Delivery memo.
ShipCompanyCode	String	False	Delivery company code - 1000: Other, 1001: Yamato Transport, 1002: Sagawa Express, etc.
ShipInvoiceNumber1	String	False	Shipping slip number 1.
ShipInvoiceNumber2	String	False	Delivery order number 2.
ShipInvoiceNumberEmptyReason	String	False	No slip number - No. Reason NULL: (Unregistered state) 101: For direct sending items from manufacturer's inventory, 102: For goods for which shipping is unnecessary, 103: For store receipt items, 104: For direct contact from a delivery company, 105: The slip number is not issued (it can not be tracked) Because of the delivery method.
ShipUrl	String	False	Shipping company URL. Maximum 100 single-byte characters.
ShipDate	Date	False	Shipment date.
ArrivalDate	Date	False	Date of arrival.
ShipInstructStatus	Integer	False	Shipping instruction status. 100: Shipping instruction not yet accepted, 101: Waiting for shipping instruction, 102: Cancelled shipping, 103: Shipping instruction completed. 104: Shipping completed, 105: Delivery completed, 106: Undeliverable.
CollectionDate	Date	False	The date when Yamato Transport collected the cargo.
CashOnDeliveryTax	Integer	False	The tax amount for the delivery payments.

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

DeleteItemImage

Leave the product image in a state of waiting to be deleted.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.

Input


Name	Type	Required	Description
SellerId	String	True	Specify your store account.
ImageId	String	True	Specify the image ID to be deleted.You can delete multiple images with a comma

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

GetAuthorizationStatus

Gets the authorization status of public key authentication.

Result Set Columns


Name	Type	Description
Status	String	The authorization status of public key authentication

IssuePaymentNumber

Issue payment number for payment by buyer for mobile Suica, convenience store settlement (Seven Eleven), convenience store settlement (other), payment order at Paisy.

Input


Name	Type	Required	Description
OrderId	String	True	Order ID.
SellerId	String	False	Store account.
OperationUser	String	False	Name of updater (Business ID registered name).

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

MoveItems

Move multiple items in one batch to another category. (It does not reflect the front).

Input


Name	Type	Required	Description
SellerId	String	False	Store account.
ItemCodes	String	False	Comma seperated list of item codes.
FromStoreCategoryKey	String	True	Specify the page ID of the store category of the move source.
ToStoreCategoryKey	String	True	Specify the page ID of the store category to be moved or linked.

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

ReservePublish

Process or make reservations to reflect the saved content in a way that is visible to customers

Input


Name	Type	Required	Description
SellerId	String	True	Specify your store account.
Mode	Integer	True	Specify the mode of making a reflection reservation or canceling a reservation.1 : Reflected reservation / Reservation date and time change,2 : Reflected reservation cancellation,3 : Reservation confirmation
ReserveTime	Datetime	True	Specify the date and time to be reflected.

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

SetItemDisplayPriority

Change display priorities of products under one store category at once. (It does not reflect the front).

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.

Input


Name	Type	Required	Description
SellerId	String	False	Store account.
StoreCategoryKey	String	False	The page ID of the target store category.
ItemCode#	String	True	Item code to change the order of priority.
SortPriority#	Integer	True	The order of priority, minimum value 1, maximum value 9, 999, 999.

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

SplitOrder

It provides the function of dividing one order into two orders.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.

Input


Name	Type	Required	Description
OrderId	String	True	Order ID.
SellerId	String	False	Store account.
OperationUser	String	True	Name of updater (Business ID registered name).
Order1LineId#	Integer	True	Order1 Product line IDs (as many LineIds as you will keep in the first order).
Order1Quantity#	Integer	True	Order1 Quantities (Corresponding quantities for the LineIds).
Order1PayCharge	Integer	True	Order1 Fee.
Order1ShipCharge	Integer	True	Order1 Shipping cost.
Order1GiftWrapCharge	Integer	True	Order1 Gift wrapping fee.
Order1Discount	Integer	True	Order1 Discount.
Order1UsePoint	Integer	True	Order1 Usage points.
Order2LineId#	Integer	True	Order2 Product line IDs (as many LineIds as you will keep in the second order).
Order2Quantity#	Integer	True	Order2 Quantities (Corresponding quantities for the LineIds).
Order2PayCharge	Integer	True	Order2 Fee.
Order2ShipCharge	Integer	True	Order2 Shipping cost.
Order2GiftWrapCharge	Integer	True	Order2 Gift wrapping fee.
Order2Discount	Integer	True	Order2 Discount.
Order2UsePoint	Integer	True	Order2 Usage points.

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.
Order1Id	String	First Order Id.
Order2Id	String	Second Order Id.

SubmitItem

Individual product reflection

Input


Name	Type	Required	Description
SellerId	String	False	Seller ID.
ItemCode	String	False	Item Code of the product to be reflected.

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

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 Yahoo Shopping:

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.

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.

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.

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.

sys_tablecolumns

Describes the columns of the available tables and views.

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

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

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.

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.

sys_procedureparameters

Describes stored procedure parameters.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' 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 = 'SampleProcedure' 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 Yahoo Shopping 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.

sys_keycolumns

Describes the primary and foreign keys.

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

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

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.

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.

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.

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.

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.

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.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported 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_FUNCTIONS	Supported 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_FUNCTIONS	Supported 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_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A 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_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All 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_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates 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.

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.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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.

OAuth

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
SellerId	Store account ID.
UseSandbox	Specify if you are connecting to a test environment or a production account. Defaults to FALSE.
PublicKey	Set this to the public key shared by Yahoo Shopping.
PublicKeyVersion	Specify the version of the obtained public key from Yahoo Shopping.
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

SSL

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

Logging

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

Schema

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

Miscellaneous

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PageSize	The number of results to return per page of data retrieved from the server.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

OAuth

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

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
SellerId	Store account ID.
UseSandbox	Specify if you are connecting to a test environment or a production account. Defaults to FALSE.
PublicKey	Set this to the public key shared by Yahoo Shopping.
PublicKeyVersion	Specify the version of the obtained public key from Yahoo Shopping.
Scope	Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

SSL

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

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

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.

Logging

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

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

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.

Schema

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

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

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.

Miscellaneous

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

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PageSize	The number of results to return per page of data retrieved from the server.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

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:

*=*

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.

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.

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

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.

Cloud

Yahoo Shopping - CData Cloud

Overview

Key Features

Getting Started

Connecting to Yahoo Shopping

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to Yahoo Shopping

Creating a Custom OAuth Application

Creating a Custom OAuth Application

Procedure

SSL Configuration

Customizing the SSL Configuration

Client SSL Certificates

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

CData Cloud - Yahoo Shopping Tables

Inventory

Select

Insert

Update

Batch Update

Delete

Columns

OrderDetails

Select

Insert

Update

Delete

Columns

OrderLineItems

Select

Insert

Batch Insert

Update

Delete

Columns

OrderPayments

Select

Insert

Update

Delete

Columns

Orders

Select

Insert

Update

Delete

Columns

Pseudo-Columns

OrderShippings

Select

Insert

Update

Delete

Columns

ProductOptions

Select

Insert

Update

Delete

Columns

Products

Select

Insert

Update

Upsert

Batch Update

Delete

Batch Delete

Columns

ProductSubCodes

Select

Insert

Update