Adding a Connection to Yahoo Shopping

To add a connection to Yahoo Shopping:

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

For required properties, see the Settings tab.

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

Connecting to 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 Sync App refreshes it automatically.

Automatic refresh of the OAuth access token:

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

1. 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 Sync App to save the OAuth values, which persist across connections.
2. 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.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your custom OAuth application settings.
   • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. 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.

This section details a selection of advanced features of the Yahoo Shopping Sync App.

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

See Query Processing for more information.

Logging

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

Customizing the SSL Configuration

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

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

Client SSL Certificates

The Yahoo Shopping Sync App 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

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

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

Other Proxies

Set the following properties:

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

The CData Sync App models 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.

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

Yahoo Shopping Connector for CData Sync 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.

Stock database of inventory data in Yahoo! Shopping.

Select

The Sync App 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 Sync App.

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

Returns data from a sample table.

Select

The Sync App 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 Sync App.

• 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

Returns data from a sample table.

Select

The Sync App 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 Sync App.

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

Returns data from a sample table.

Select

The Sync App 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 Sync App.

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

Returns data from a sample table.

Select

The Sync App 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 Sync App.

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

Returns data from a sample table.

Select

The Sync App 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 Sync App.

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

Return the list of options for the specified product.

Select

The Sync App 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 Sync App.

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

Return the list of registered products of your store.

Select

The Sync App 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 Sync App.

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

Return the list of options for the specified product.

Select

The Sync App 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 Sync App.

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

Yahoo Shopping Connector for CData Sync 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.

Retrieve the list of store categories.

Select

The Sync App 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 Sync App.

• PageKey and SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM Categories WHERE PageKey = 'key' 

Columns

Name	Type	References	Description
PageKey [KEY]	String		Product code.
SellerId	String		Seller ID.
Name	String		The name of the product.
HiddenPageFlag	Integer		Hidden page flag. 0: normal page, 1: hidden page.
SortOrder	String		Child store category display order within designated store category.
EditingFlag	Integer		Edit flag. 0: Reflected, 1: State not reflected at the front after being edited.
UpdateTime	Datetime		Update date.

List of the uploaded product images.

Select

The Sync App 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 Sync App.

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

Provides update history information for a single order.

Select

The Sync App 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 Sync App.

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

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

Select

The Sync App 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 Sync App.

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

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

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.

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.

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	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
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.
PublicKeyType	The type of certificate store for this certificate.

SSL

---

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
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.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

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

Proxy

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

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

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

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
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.
PublicKeyType	The type of certificate store for this certificate.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

Store account ID.

Remarks

Store account ID.

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

Remarks

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

Set this to the public key shared by Yahoo Shopping.

Remarks

Either BLOB or key file can be set and the type of the key should be set in PublicKeyType. Please check the following page for the pubblic key details. Store Creator Pro > Settings > Encryption Key Management

Specify the version of the obtained public key from Yahoo Shopping.

Remarks

Specify the version of the obtained public key from Yahoo Shopping.

The type of certificate store for this certificate.

Remarks

This property can take one of the following values:

PUBLIC_KEY_FILE	The Public Key is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The Public Key is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.

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

---

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
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.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

The type of key store containing the TLS/SSL client certificate.

Remarks

This property can take one of the following values:

USER - default	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

The password for the TLS/SSL client certificate.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

The subject of the TLS/SSL client certificate.

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, [email protected]". The common fields and their meanings are shown below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

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

Remarks

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

This property can take the following forms:

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

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

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

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

---

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

The protocol used by a proxy-based firewall.

Remarks

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

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

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

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

Remarks

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

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

The TCP port for a proxy-based firewall.

Remarks

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

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

Remarks

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

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

Remarks

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

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

---

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

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

Remarks

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

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

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

Remarks

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

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

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

The TCP port the ProxyServer proxy is running on.

Remarks

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

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

Remarks

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

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

The authentication type can be one of the following:

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

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

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

Remarks

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

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

user@domain
domain\user

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

Core modules to be included in the log file.

Remarks

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

See the Logging page for an overview.

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

---

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

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

Remarks

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

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

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

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

Remarks

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

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

Remarks

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

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

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

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

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

Remarks

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

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

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

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

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

---

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

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

Remarks

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

These hidden properties are used only in specific use cases.

Remarks

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

The number of results to return per page of data retrieved from the server.

Remarks

The number of results to return per page of data retrieved from the server.

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

Remarks

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

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

Remarks

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

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

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

Remarks

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

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

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

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

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