Yahoo Shopping Connector for CData Sync

Build 25.0.9539
  • Yahoo Shopping
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Inventory
        • OrderDetails
        • OrderLineItems
        • OrderPayments
        • Orders
        • OrderShippings
        • ProductOptions
        • Products
        • ProductSubCodes
      • Views
        • Categories
        • ItemImageList
        • OrderChangeHistory
        • OrderCount
        • OrderLineItemDetails
        • OrderLineItemInscriptions
        • OrderLineItemOptions
      • Stored Procedures
        • CancelOrderCoupon
        • ChangeOrderStatus
        • ChangePaymentStatus
        • ChangeShipmentStatus
        • DeleteItemImage
        • GetAuthorizationStatus
        • GetOAuthAccessToken
        • GetOAuthAuthorizationURL
        • IssuePaymentNumber
        • MoveItems
        • RefreshOAuthAccessToken
        • ReservePublish
        • SetItemDisplayPriority
        • SplitOrder
        • SubmitItem
        • UploadItemImage
    • Connection String Options
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • SellerId
        • UseSandbox
        • PublicKey
        • PublicKeyVersion
        • PublicKeyType
        • Scope
      • SSL
        • SSLClientCert
        • SSLClientCertType
        • SSLClientCertPassword
        • SSLClientCertSubject
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • PageSize
        • PseudoColumns
        • Timeout
        • UserDefinedViews
    • Third Party Copyrights

Yahoo Shopping Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Yahoo Shopping data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Yahoo Shopping connector can be used from the CData Sync application to pull data from Yahoo Shopping and move it to any of the supported destinations.

Yahoo Shopping Version Support

The Sync App leverages the Yahoo Shopping API to enable bidirectional access to Yahoo Shopping.

Yahoo Shopping Connector for CData Sync

Establishing a Connection

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.

Yahoo Shopping Connector for CData Sync

Advanced Features

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

User Defined Views

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

SSL Configuration

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

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Yahoo Shopping Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Client SSL Certificates

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

Yahoo Shopping Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Yahoo Shopping Connector for CData Sync

Data Model

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.

Yahoo Shopping Connector for CData Sync

Tables

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.

Yahoo Shopping Connector for CData Sync

Inventory

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.

Yahoo Shopping Connector for CData Sync

OrderDetails

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

SocialGiftType String True

This column indicates whether the delivery address information for social gift orders is entered by sharing the URL or entered by the purchaser. For orders before the feature is released, it will be empty (null).

IsVip Boolean True

This column indicates whether the order is eligible for VIP benefits or not.

InsuranceStatus Integer True

Insurance enrollment status null or 0: No application 1: Application in process 2: Application successful 3: Application unsuccessful 4: Coverage started 5: Insurance canceled 6: Insurance ordered

ShipCompanyMethodCode String True

The name of the shipping method used by the shipping company. The code determined by the shipping company.

ShipCompanyReceivedDatetime Datetime True

The date and time the delivery company received the shipment

ShipContactlessDeliveryCode String True

Delivery company drop-off location code null: Item not eligible for drop-off delivery OR Drop-off delivery not selected 00: Item to be dropped off and picked up in person 01: Item to be dropped off and picked up without meeting the customer

ChannelGoodsPlanId String True

ID when signing up for PayPay Insurance via SHP

ChannelGoodsPlanName String True

PayPay Insurance Name via SHP

Yahoo Shopping Connector for CData Sync

OrderLineItems

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.

Yahoo Shopping Connector for CData Sync

OrderPayments

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 'Other' is entered.

BillPrefectureKana String False

Billing prefecture phonetic.

BillCity String False

Billing city / county.

BillCityKana String False

Billing County District Phonetic.

BillAddress1 String False

Billing address 1.

BillAddress1Kana String False

Billing address 1 phonetic.

BillAddress2 String False

Billing address 2.

BillAddress2Kana String False

Billing address 2 phonetic.

BillPhoneNumber String False

Billing telephone number.

BillEmgPhoneNumber String False

Billing telephone number (urgent).

BillMailAddress String False

Billing E-mail address.

BillSection1Field String False

Billing address Affiliation 1 Field name.

BillSection1Value String False

Billing address Affiliation 1 Input information.

BillSection2Field String False

Billing address Affiliation 2 Field name.

BillSection2Value String False

Billing address Affiliation 2 Input information.

CombinedPayType Integer False

Billing address Affiliation 2 Input information.

CombinedPayKind Integer False

Billing address Affiliation 2 Input information.

CombinedPayMethod String False

Billing address Affiliation 2 Input information.

PayMethodAmount Decimal False

Billing address Affiliation 2 Input information.

CombinedPayMethodName String False

Billing address Affiliation 2 Input information.

CombinedPayMethodAmount Decimal False

Billing address Affiliation 2 Input information.

PayNo String True

Payment number.

PayNoIssueDate Datetime True

Payment number issue date / time.

ConfirmNumber String True

Authorization number.

PaymentTerm Datetime True

Payment due date for convenience store payment, mobile Suica settlement, and payment settlement.

IsApplePay Boolean True

Availability of ApplePay.

OperationUser String False

It is the registered name of Yahoo! JAPAN business ID who carried out update work.

Yahoo Shopping Connector for CData Sync

Orders

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.

Yahoo Shopping Connector for CData Sync

OrderShippings

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.

Yahoo Shopping Connector for CData Sync

ProductOptions

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.

Yahoo Shopping Connector for CData Sync

Products

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.

EcoSettingId String False

This column indicates the environmental label name (1 to 100) or the eco keyword name (101 and above).

EcoSettingEvidenceUrl String False

This column indicates the environmental label/eco keyword evidence URL.

GroupingId String False

Grouping ID

Variation1SpecId String False

Variation 1 - Spec ID

Variation1Name String False

Variation 1 - Display name

Variation2SpecId String False

Variation 2 - Spec ID

Variation2Name String False

Variation 2 - Display name

Variation3SpecId String False

Variation 3 - Spec ID

Variation3Name String False

Variation 3 - Display name

Variation4SpecId String False

Variation 4 - Spec ID

Variation4Name String False

Variation 4 - Display name

Variation5SpecId String False

Variation 5 - Spec ID

Variation5Name String False

Variation 5 - Display name

Yahoo Shopping Connector for CData Sync

ProductSubCodes

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.

Yahoo Shopping Connector for CData Sync

Views

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

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

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.

Yahoo Shopping Connector for CData Sync

Categories

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.

Yahoo Shopping Connector for CData Sync

ItemImageList

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.

Yahoo Shopping Connector for CData Sync

OrderChangeHistory

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.

Yahoo Shopping Connector for CData Sync

OrderCount

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.

Yahoo Shopping Connector for CData Sync

OrderLineItemDetails

Returns detailed data for each Order Line Item.

Columns

Name Type References Description
OrderId [KEY] String

Orders.OrderId

Order ID.
Line_LineId [KEY] Integer Product line ID.
ItemId String Product ID.
SellerId String Store account ID.
OrderTime Datetime The date and time when the order was made.
OperationUser String It is the registered name of Yahoo! JAPAN business ID who carried out update work.
OrderStatus Integer Status of the order. 1: During reservation, 2: In process, 3: Hold, 4: Cancel, 5: Completed.

The allowed values are 0, 1, 2, 3, 4, 5, 8.

CancelReason Integer Cancellation reason: Order Cancellation - 100: Cancel, 110: Returned Item, 120: Not Received, 130: Address Unknown, 140: Receiving Refused, 150: No Connection, 160: Duplicate Order, 170: Payment Unavailable, 180: Other, 300: Mistakenly Ordered, 310: Customer Using Points They Forgot to Use, 320: Customer Using Coupon They Forgot to Use, 330: Customer Found Cheaper Price, 340: Shipping Cost Too High, 350: Change of Shipping Destination, 360: Change of Shipping Method, 370: Change of Payment Method, 380: Credit Card Not Available, | Store convenience - 200: Settlement Method Convenience, 210: Missing Item, 220: Discontinued, 230: Other | Other - 0: Cancel reason n/a System cancellation | blank: Order not canceled.
CancelReasonDetail String The reason why the store has entered a cancellation reason when the reason is Store Convenience 230 (Other)
ParentOrderId String The splitting order ID when an order is split.
ChildOrderId String The second splitting order ID when an order is split.
MobileCarrierName String The type of mobile carrier.
NeedSnl Boolean Store newsletter opt-in flag.
LastUpdateTime Datetime The last modification date of order information.
SuspectMessage String A message when an order is judged as mischievous.0: Non-naughty order, 1: Mischievous order, 2: Mischievious canceled order.
SendConfirmTime Datetime The date and time of sending the order confirmation email sent when the order is newly entered.
SendPayTime Datetime The mail transmission date sent at the time of settlement.
PrintSlipTime Datetime The date and time when the order slip was output.
PrintDeliveryTime Datetime The date and time when we output the invoice.
PrintBillTime Datetime The date and time when the invoice was output.
BuyerComments String The comment string displayed by the buyer.
SellerComments String The comment string displayed by the store in the store.
Notes String A memo in the store when the store is entered with the order management tool.
Referer String Referrer information covering domain, search keywords, etc.
EntryPoint String The URL of the store page where the buyer entered the target store.
HistoryId String An ID that manages the update history of orders.
UsageId String The coupon usage ID.
UseCouponData String Detailed information on the coupon information.
TotalCouponDiscount Integer Of the amount discounted by the store coupon of all the products associated with one order, this becomes the discount total value other than the shipping fee.
ShippingCouponFlg Integer Free shipping availability. 0: None, 1: Present.
ShippingCouponDiscount Integer It is the discount amount of the carriage when applying free shipping coupons.
CampaignPoints String Comma separated list of breakdown points.
IsMultiShip Boolean Indicates if there is a multiple shipping order.
MultiShipId String ID that identifies multiple delivery orders.
YamatoCoopStatus Integer Caution: Yamato Topic and Delivery Dedicated Item This status indicates the current state of cooperation with Yamato Transport. Only [3: Linked] will be the status that linked.

The allowed values are 0, 1, 2, 3, 4.

FraudHoldStatus Integer 0 or null: Low risk of fraud, 1: Rule pending review, 2: Release rule hold, 3: Rule abuse confirmed.

The allowed values are 0, 1, 2, 3.

PublicationTime Datetime The time that can be obtained from the orderList, such as when the illegal hold is released, is set.
Shipping_CollectionDate Date The date when Yamato Transport collected the cargo.
Shipping_CashOnDeliveryTax Integer The tax amount for the delivery payments.
Shipping_NumberUnitsShipped Integer The number of packages sent by Yamato Transport.
Shipping_IsEazy Boolean It is an Order Flag.
Shipping_ShipRequestTimeZoneCode Integer Preferred delivery time zone number. Blank if not specified, 101: Morning (8:00 to 12:00), 102: 14:00 to 16:00, 103: 16:00 to 18:00, 104: 18:00 to 20:00, 105: 19:00 to 21:00.

The allowed values are 101, 102, 103, 104, 105.

Shipping_ShipInstructType Integer The used delivery service category. 1: Direct cooperation, 2: Via couriers, 101: Yamato P & D.

The allowed values are 1, 2, 101.

Shipping_ShipInstructStatus Integer The status of orders in Yamatopic & Delivery. 0: Not applicable, 100: Shipping instruction not yet accepted, 101: Waiting for shipping instruction, 102: Cancelled shipping, 103: Shipping instruction completed. 104: Shipping completed, 105: Delivery completed, 106: Undeliverable.

The allowed values are 0, 101, 102, 103, 104, 105, 106.

Line_PickAndDeliveryCode String The bar code information required for delivery.
Line_PickAndDeliveryTransportRuleType Integer

The allowed values are 0, 1, 2, 3, 4, 5.

Line_YamatoUndeliverableReason String The reason why Yamato delivery is not possible.
Detail_PayCharge Integer The fee set by the store (cash on delivery commission etc.). The settlement fee of Yahoo! settlement is different.
Detail_ShipCharge Integer Shipping fee (postage free coupon discount after deduction).
Detail_GiftWrapCharge Integer Gift wrapping fee.
Detail_Discount Integer Discount. The value entered in the price discount column on the store creator Pro after the store side is entered.
Detail_Adjustments Integer Adjustment amount.
Detail_SettleAmount Integer The same value as the total amount (TotalPrice).
Detail_UsePoint Integer Number of points used.
Detail_TotalPrice Integer Subtotal - usage point + gift wrapping fee + fee - discount + postage + adjustment amount - mall coupon discount amount.
Detail_IsGetPointFixAll Boolean Indicates whether or not the process of finalizing the grant points of all lines (goods) has been completed.
Detail_TotalMallCouponDiscount Integer Indicates the total value of the amount discounted at the mall coupon.
Detail_SettlePayAmount Integer When the order is split, this will not reflect the split amount. The total amount will reflect this.
Detail_PayMethodAmount Decimal Billing address Affiliation 2 Input information.
Detail_CombinedPayMethodAmount Decimal Billing address Affiliation 2 Input information.
Detail_IsLogin Boolean Login order.
Detail_FspLicenseCode String For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
Detail_FspLicenseName String For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
Detail_GuestAuthId String Guest authorization Id for guest orders only.
Payment_PayStatus Integer Deposit status. 0: Waiting for payment, 1: Payment already made

The allowed values are 0, 1.

Payment_SettleStatus Integer Settlement status. 1: Settlement application, 2: Waiting for payment, 3: Payment completion, 4: Waiting for payment, 5: Completion of settlement, 6: Cancel, 7: Refund, 8: Expired, 9: Payment application, 10: Authorization error, 11: Sales cancelled, 12: Suica address error.

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

Payment_PayType Integer Payment classification. 0: Postpay, 1: Prepay.

The allowed values are 0, 1.

Payment_PayKind Integer Payment type. 0: Card, 1: Internet banking, 2: Carrier settlement, 3: Transfer, 4: Cash on delivery, 5: Convenience store, 6: Electronic money 7: Other.

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

Payment_PayMethod String Payment method number. payment_a 1: Credit card payment, payment_a 6: Convenience store payment (7-Eleven), payment_a 7: Convenience store payment (Others), payment_a 8: Mobile Suica payment, payment_a 9: Docomo Mobile payment, payment_a 10: au Easy settlement, payment_a 11: Soft bank collectively payment, payment_a 15: Payee, payment_a 16: Yahoo Money / deposit payment, payment_b [1-6]: bank transfer (name is free setting of store), payment_c1: Japan Post Bank (prepayment), payment_c2: Japan Post Bank (postpay), payment_c3: registered mail, payment_d1: cash on delivery goods, payment_e [1-15 ]: Free payment method name of the store, payment_z1: Full payment of points.
Payment_PayMethodName String Payment method name.
Payment_SellerHandlingCharge Integer A settlement fee for the store's burden.
Payment_PayActionTime Datetime Purchase history detail screen It contains the payment update date and time.
Payment_PayDate Date The deposit date entered in the order management tool.
Payment_PayNotes String The contents of the remarks column of the deposit entered by the order management tool.
Payment_SettleId String Settlement ID.
Payment_CardBrand String In case of credit card it is the card brand name (VISA etc).
Payment_CardNumber String Only store of original merchant store contract is available. Encrypted character string information can be acquired.
Payment_CardNumberLast4 String The last four digits of the credit card.
Payment_CardExpireYear String The expiration year of the card.
Payment_CardExpireMonth String The expiration month of the card.
Payment_CardPayType Integer Card payment classification. 1: Lump sum payment, 2: Bonus lump sum payment, 3: Ribbon payment, 4: Installment payment

The allowed values are 1, 2, 3, 4.

Payment_CardHolderName String The name of the cardholder
Payment_CardPayCount Integer The number of payments in installments.
Payment_CardBirthDay String Card date of birth.
Payment_UseYahooCard Boolean Yahoo! JAPAN JCB Card Availability.
Payment_UseWallet Boolean Wallet availability.
Payment_NeedBillSlip Boolean Whether or not you wish to have an invoice when ordering entered by the purchaser.
Payment_NeedDetailedSlip Boolean The presence or absence of the requested statement when ordering entered by the purchaser.
Payment_NeedReceipt Boolean Whether there is a receipt at the time of ordering entered by the purchaser.
Payment_AgeConfirmField String The field name set by the store in the age confirmation field.
Payment_AgeConfirmValue Integer Age confirmation field numeric input.
Payment_AgeConfirmCheck Boolean If the box has been checked when there is an age check check box.
Payment_BillAddressFrom String Billing address. P: UDB home address, B: UDB work address, ship: same as the addressee, O1: others, O2: other, O3: other 3 O4: other 4 O: other input.
Payment_BillFirstName String Billing Name.
Payment_BillFirstNameKana String Billing name (phonetic).
Payment_BillLastName String Billing surname.
Payment_BillLastNameKana String Billing last name (phonetic).
Payment_BillZipCode String Billing Postal Code.
Payment_BillPrefecture String Billing address Prefecture In case of overseas 'Other' is entered.
Payment_BillPrefectureKana String Billing prefecture phonetic.
Payment_BillCity String Billing city / county.
Payment_BillCityKana String Billing County District Phonetic.
Payment_BillAddress1 String Billing address 1.
Payment_BillAddress1Kana String Billing address 1 phonetic.
Payment_BillAddress2 String Billing address 2.
Payment_BillAddress2Kana String Billing address 2 phonetic.
Payment_BillPhoneNumber String Billing telephone number.
Payment_BillEmgPhoneNumber String Billing telephone number (urgent).
Payment_BillMailAddress String Billing E-mail address.
Payment_BillSection1Field String Billing address Affiliation 1 Field name.
Payment_BillSection1Value String Billing address Affiliation 1 Input information.
Payment_BillSection2Field String Billing address Affiliation 2 Field name.
Payment_BillSection2Value String Billing address Affiliation 2 Input information.
Payment_CombinedPayType Integer Billing address Affiliation 2 Input information.
Payment_CombinedPayKind Integer Billing address Affiliation 2 Input information.
Payment_CombinedPayMethod String Billing address Affiliation 2 Input information.
Payment_CombinedPayMethodName String Billing address Affiliation 2 Input information.
Payment_PayNo String Payment number.
Payment_PayNoIssueDate Datetime Payment number issue date / time.
Payment_ConfirmNumber String Authorization number.
Payment_PaymentTerm Datetime Payment due date for convenience store payment, mobile Suica settlement, and payment settlement.
Payment_IsApplePay Boolean Availability of ApplePay.
Shipping_ShipStatus Integer Delivery status 0: Can not be shipped 1: Can be shipped 2: Shipping in progress 3: Shipped completed 4: Receiving completed.

The allowed values are 0, 1, 2, 3, 4.

Shipping_ShipMethod String Delivery method number: any one of postage 1 - 14, 16.
Shipping_ShipMethodName String Delivery method name.
Shipping_ShipRequestDate Date Desired delivery day.
Shipping_ShipRequestTime String Delivery time desired.
Shipping_ShipNotes String Delivery note.
Shipping_ShipCompanyCode String Delivery company code 1000: Other 1001: Yamato Transport 1002: Sagawa Express 1003: Japan Post 1004: Seino Transportation.
Shipping_ShipInvoiceNumber1 String Delivery slip number information of the shipping company that the store set with the tool or API.
Shipping_ShipInvoiceNumber2 String Delivery slip number information of the shipping company that the store set with the tool or API.
Shipping_ShipInvoiceNumberEmptyReason String NULL: (Unregistered state) 101: For direct item from manufacturer's inventory 102: For goods that do not need shipping 103: For overseas receipt items 104: For direct contact from the delivery company 105: Document number Because it is not issued (can not be tracked) because of the delivery method.
Shipping_ShipUrl String Tracking URL of the shipping company that the store set with tools and APIs.
Shipping_ArriveType Integer Drinking 0: Normal 1 : School order 2: Matsutake order

The allowed values are 0, 1, 2.

Shipping_ShipDate Date Shipment date entered.
Shipping_ArrivalDate Date It is the arrival date entered.
Shipping_NeedGiftWrap Boolean Presence or absence of gift wrapping.
Shipping_GiftWrapType String Gift wrapping type.
Shipping_GiftWrapMessage String Gift message.
Shipping_NeedGiftWrapPaper Boolean Whether or not.
Shipping_GiftWrapPaperType String Works type.
Shipping_GiftWrapName String Enter name (message).
Shipping_Option1Field String Option field Key information (field name).
Shipping_Option1Type Integer Option field Key information (setting).
Shipping_Option1Value String Option field Input contents.
Shipping_Option2Field String Option field Key information (field name).
Shipping_Option2Type Integer Option field Key information (setting).
Shipping_Option2Value String Option field Input contents.
Shipping_ShipFirstName String Destination name.
Shipping_ShipFirstNameKana String Destination name phonetic.
Shipping_ShipLastName String Destination surname.
Shipping_ShipLastNameKana String Destination surname phonetic.
Shipping_ShipPrefecture String Delivery destination Prefecture In case of overseas 'Other' is entered.
Shipping_ShipPrefectureKana String Destination prefecture phonetic.
Shipping_ShipZipCode String Delivery addressee postal code.
Shipping_ShipCity String Destination city / county.
Shipping_ShipCityKana String Destination city / county phonetic.
Shipping_ShipAddress1 String Destination address 1.
Shipping_ShipAddress1Kana String Destination address 1 phonetic.
Shipping_ShipAddress2 String Destination address 2.
Shipping_ShipAddress2Kana String Destination address 2 phonetic.
Shipping_ShipPhoneNumber String Destination telephone number.
Shipping_ShipEmgPhoneNumber String Destination telephone number (urgent).
Shipping_ShipSection1Field String Addressee affiliation 1 Field name.
Shipping_ShipSection1Value String Addressee affiliation 1 input information.
Shipping_ShipSection2Field String Addressee affiliation 2 Field name.
Shipping_ShipSection2Value String Addressee affiliation 2 input information.
Line_Title String Product title.
Line_SubCode String The subcode of the product when this value has been set.
Line_SubCodeOption String The subcode option when this value has been set. Both key & value.
Line_IsUsed Boolean Indicates whether it is a used item.
Line_ImageId String The product image ID.
Line_IsTaxable Boolean Tax object flag.
Line_Jan String Japanese Article Number code.
Line_ProductId String The product code (product number/model number).
Line_CategoryId Integer Category code.
Line_AffiliateRatio String Store burden rate.
Line_UnitPrice Integer Unit price of each item (amount after discount of store coupons) .
Line_ItemTaxRatio Integer Unit price of each item (amount after discount of store coupons) .
Line_Quantity Integer The quantity of each item.
Line_PointAvailQuantity Integer Points to be granted quantity.
Line_ReleaseDate Date Release date. This is only when there is input of release date. For release date bigger than order date, treat it as a pre-order.
Line_HaveReview Boolean Product review absence flag.
Line_PointFspCode String Point code by item. 10001 to 10015, 2001 to 20010.
Line_PointRatioY Integer Granted Point Magnification (Yahoo! JAPAN Burden).
Line_PointRatioSeller Integer Granted Point Magnification (Store Burden).
Line_UnitGetPoint Integer Number of credit points granted.
Line_IsGetPointFix Boolean Granted point determination flag.
Line_GetPointFixDate Date Granulation point determination date. After 14 days of order date, we will set the pre-order to 14 days after release date.
Line_CouponDiscount Integer Coupon discount amount.
Line_CouponUseNum Integer Number of applicable coupons.
Line_OriginalPrice Integer Unit price before discount.
Line_OriginalNum Integer Quantity before line splitting.
Line_LeadTimeStart Date Start of shipment date.
Line_LeadTimeEnd Date Shipment day end.
Line_LeadTimeText String Shipping date text.
Line_CouponData String Store coupons.
Line_ItemOption String Product options.
Line_Inscription String Inspections.
UseGiftCardData String Gift Card Data.
Detail_GiftCardDiscount Integer Amount of gift voucher used

Yahoo Shopping Connector for CData Sync

OrderLineItemInscriptions

Returns data from a sample table.

Columns

Name Type References Description
OrderId [KEY] String

Orders.OrderId

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

Yahoo Shopping Connector for CData Sync

OrderLineItemOptions

Returns data from a sample table.

Columns

Name Type References Description
OrderId [KEY] String

Orders.OrderId

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

Yahoo Shopping Connector for CData Sync

Stored Procedures

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

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

Yahoo Shopping Connector for CData Sync Stored Procedures

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

Yahoo Shopping Connector for CData Sync

CancelOrderCoupon

Cancels the coupon adaptation of the specified order information.

Input

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

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

ChangeOrderStatus

Change the order status of the specified order.

Input

Name Type Required Description
OrderId String True Order ID
SellerId String False Store account
IsPointFix Boolean True Point determination necessity. When changing the order status to 'Complete', please be sure to set the point determination necessity to true. true: Points are finalized , false: The point is not fixed.
OperationUser String False Name of updater (Business ID registered name)
OrderStatus Integer True Order status. 1: In reservation, 2: Processing, 3: Hold, 4: Cancel, 5: Complete

The allowed values are 1, 2, 3, 4, 5.

CancelReason Integer False Cancellation reason code. Order Cancellation - 100: Cancel, 110: Returned, 120: Not Received, 130: Address Unknown, 140: Refuse Receipt, 150 Unsuccessful, 160 Duplicate Order, 170 Settlement Unavailable, 180 Others; Store Concerned, 200: Payment Method Concerned, 210: Missing Item, 220: Discontinued, 230: Other

The allowed values are 100, 110, 120, 130, 140, 150, 160, 170, 180, 200, 210, 220, 230.

CancelReasonDetail String False Reason for cancellation. If details are more than 10 characters, within 200 characters

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

ChangePaymentStatus

Renewal status update function for managing payment status of orders.

Input

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

The allowed values are 0, 1.

PayDate Date False Deposit date.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

ChangeShipmentStatus

Shipment status update function for managing order delivery status.

Input

Name Type Required Description
OrderId String True Order ID.
SellerId String False Store account.
IsPointFix Boolean True Point determination necessity. When changing the order status to 'Complete', please be sure to set the point determination necessity to true. true: Points are finalized, false: The point is not fixed.
OperationUser String False Name of updater (Business ID registered name).
ShipStatus Integer True Delivery status - 0: Can not be shipped, 1: Can be shipped, 2: Shipment in process, 3: Shipment complete, 4: Receipt complete

The allowed values are 0, 1, 2, 3, 4.

ShipMethod String False Delivery method: any one of postage 1 - 14, 16 (postage 15 is missing number) Store creator Pro order of delivery setting.
ShipNotes String False Delivery memo.
ShipCompanyCode String False Delivery company code - 1000: Other, 1001: Yamato Transport, 1002: Sagawa Express, etc.
ShipInvoiceNumber1 String False Shipping slip number 1.
ShipInvoiceNumber2 String False Delivery order number 2.
ShipInvoiceNumberEmptyReason String False No slip number - No. Reason NULL: (Unregistered state) 101: For direct sending items from manufacturer's inventory, 102: For goods for which shipping is unnecessary, 103: For store receipt items, 104: For direct contact from a delivery company, 105: The slip number is not issued (it can not be tracked) Because of the delivery method.
ShipUrl String False Shipping company URL. Maximum 100 single-byte characters.
ShipDate Date False Shipment date.
ArrivalDate Date False Date of arrival.
ShipInstructStatus Integer False Shipping instruction status. 100: Shipping instruction not yet accepted, 101: Waiting for shipping instruction, 102: Cancelled shipping, 103: Shipping instruction completed. 104: Shipping completed, 105: Delivery completed, 106: Undeliverable.
CollectionDate Date False The date when Yamato Transport collected the cargo.
CashOnDeliveryTax Integer False The tax amount for the delivery payments.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

DeleteItemImage

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

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

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

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

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

Input

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

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

GetAuthorizationStatus

Gets the authorization status of public key authentication.

Result Set Columns

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

Yahoo Shopping Connector for CData Sync

GetOAuthAccessToken

Gets an authentication token from Yahoo Shopping.

Input

Name Type Required Description
AuthMode String False The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.

The allowed values are APP, WEB.

The default value is APP.

Scope String False A space-separated list of permissions to request from the user. Available values include: openid, profile, email, address.

The default value is openid profile email address.

CallbackURL String False Determines where the response is sent. The value of this parameter must exactly match one of the values registered in the settings for the app (including the HTTP or HTTPS schemes, capitalization, and trailing '/').
Verifier String False The verifier returned from Yahoo Shopping after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL in GetOAuthAuthorizationURL.
State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the YahooShopping authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Nonce String False A parameter used for replay attack countermeasure. For each request, specify a random character string of sufficient length. The specified nonce value is included in the ID Token and returned. In order to prevent reuse of ID Token, verify the nonce value and confirm that the same ID Token is not used more than once.
Display String False The type of page to be displayed on the login screen and consent screen. If it is not specified, page is the default value.

The allowed values are page, touch, popup, inapp.

The default value is page.

Prompt String False The action you want the user to take. To specify more than one, separate it with a space. Available values include: consent,login,select_account,none

The default value is select_account.

MaxAge String False Specify the maximum authentication elapsed time. Reauthentication is required if the time since authentication has passed the number of specified seconds.

The default value is 3600.

Result Set Columns

Name Type Description
OAuthAccessToken String The access token used for communication with Yahoo Shopping.
OAuthRefreshToken String The refresh token used for RefreshOAuthAccessToken procedure.

Yahoo Shopping Connector for CData Sync

GetOAuthAuthorizationURL

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.

Input

Name Type Required Description
CallbackUrl String False The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Yahoo Shopping app settings.
Scope String False A space-separated list of permissions to request from the user. Available values include: openid, profile, email, address

The default value is openid profile email address.

State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Yahoo Shopping authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Nonce String False A parameter used for replay attack countermeasure. For each request, specify a random character string of sufficient length. The specified nonce value is included in the ID Token and returned. In order to prevent reuse of ID Token, verify the nonce value and confirm that the same ID Token is not used more than once.
Display String False The type of page to be displayed on the login screen and consent screen. If it is not specified, page is the default value.

The allowed values are page, touch, popup, inapp.

The default value is page.

Prompt String False The action you want the user to take. To specify more than one, separate it with a space. Available values include: consent,login,select_account,none

The default value is select_account.

MaxAge String False Specify the maximum authentication elapsed time. Reauthentication is required if the time since authentication has passed the number of specified seconds.

The default value is 3600.

Result Set Columns

Name Type Description
URL String The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

Yahoo Shopping Connector for CData Sync

IssuePaymentNumber

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

Input

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

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

MoveItems

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

Input

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

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with Yahoo Shopping.

Input

Name Type Required Description
OAuthRefreshToken String True The refresh token returned from the original authorization code exchange.

Result Set Columns

Name Type Description
OAuthAccessToken String The authentication token returned from Yahoo Shopping. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

Yahoo Shopping Connector for CData Sync

ReservePublish

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

Input

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

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

SetItemDisplayPriority

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

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

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

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

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

Input

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

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

SplitOrder

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

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

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

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

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

Input

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

Result Set Columns

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

Yahoo Shopping Connector for CData Sync

SubmitItem

Individual product reflection

Input

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

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

Yahoo Shopping Connector for CData Sync

UploadItemImage

Upload your product images.

Input

Name Type Required Description
SellerId String True Specify your store account.
FileName String False Specify the name for the image file.GIF or JPEG format only.
FilePath String True Specify the location for the image file.GIF or JPEG.The size of one image should be 2MB or less.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.
ResultId String ResultId for the Uploaded file.
ResultName String ResultName for the Uploaded file.
ResultURLModeA String ResultURLModeA for the Uploaded file.
ResultURLModeB String ResultURLModeB for the Uploaded file.
ResultURLModeC String ResultURLModeC for the Uploaded file.
ResultURLModeD String ResultURLModeD for the Uploaded file.
ResultURLModeE String ResultURLModeE for the Uploaded file.
ResultURLModeF String ResultURLModeF for the Uploaded file.
ResultURLModeG String ResultURLModeG for the Uploaded file.
ResultURLModeH String ResultURLModeH for the Uploaded file.
ResultURLModeI String ResultURLModeI for the Uploaded file.
ResultURLModeJ String ResultURLModeJ for the Uploaded file.
ResultURLModeK String ResultURLModeK for the Uploaded file.
ResultURLModeL String ResultURLModeL for the Uploaded file.
ResultURLModeM String ResultURLModeM for the Uploaded file.

Yahoo Shopping Connector for CData Sync

Connection String Options

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

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

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
SellerIdStore account ID.
UseSandboxSpecify if you are connecting to a test environment or a production account. Defaults to FALSE.
PublicKeySet this to the public key shared by Yahoo Shopping.
PublicKeyVersionSpecify the version of the obtained public key from Yahoo Shopping.
PublicKeyTypeThe type of certificate store for this certificate.
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

SSL


PropertyDescription
SSLClientCertSpecifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
SSLClientCertTypeSpecifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
SSLClientCertPasswordSpecifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLClientCertSubjectSpecifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PageSizeThe number of results to return per page of data retrieved from the server.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
Yahoo Shopping Connector for CData Sync

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
SellerIdStore account ID.
UseSandboxSpecify if you are connecting to a test environment or a production account. Defaults to FALSE.
PublicKeySet this to the public key shared by Yahoo Shopping.
PublicKeyVersionSpecify the version of the obtained public key from Yahoo Shopping.
PublicKeyTypeThe type of certificate store for this certificate.
ScopeSpecifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
Yahoo Shopping Connector for CData Sync

OAuthClientId

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

Remarks

This property is required in two cases:

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

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

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

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

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

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

Yahoo Shopping Connector for CData Sync

OAuthClientSecret

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

Remarks

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

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

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

Notes:

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

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

Yahoo Shopping Connector for CData Sync

SellerId

Store account ID.

Remarks

Store account ID.

Yahoo Shopping Connector for CData Sync

UseSandbox

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.

Yahoo Shopping Connector for CData Sync

PublicKey

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

Yahoo Shopping Connector for CData Sync

PublicKeyVersion

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

Remarks

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

Yahoo Shopping Connector for CData Sync

PublicKeyType

The type of certificate store for this certificate.

Remarks

This property can take one of the following values:

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

Yahoo Shopping Connector for CData Sync

Scope

Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.

Remarks

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

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

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

Yahoo Shopping Connector for CData Sync

SSL

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


PropertyDescription
SSLClientCertSpecifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
SSLClientCertTypeSpecifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
SSLClientCertPasswordSpecifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
SSLClientCertSubjectSpecifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Yahoo Shopping Connector for CData Sync

SSLClientCert

Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.

Remarks

This property specifies the client certificate store for SSL Client Authentication. Use this property alongside SSLClientCertType, which defines the type of the certificate store, and SSLClientCertPassword, which specifies the password for password-protected stores. When SSLClientCert is set and SSLClientCertSubject is configured, the driver searches for a certificate matching the specified subject.

Certificate store designations vary by platform. On Windows, certificate stores are identified by names such as MY (personal certificates), while in Java, the certificate store is typically a file containing certificates and optional private keys.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

For PFXFile types, set this property to the filename. For PFXBlob types, set this property to the binary contents of the file in PKCS12 format.

Yahoo Shopping Connector for CData Sync

SSLClientCertType

Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.

Remarks

This property determines the format and location of the key store used to provide the client certificate. Supported values include platform-specific and universal key store formats. The available values and their usage are:

USER - defaultFor 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.
MACHINEFor Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILEThe certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOBThe certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILEThe certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOBThe 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_FILEThe certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOBThe certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILEThe certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILEThe certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOBThe certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILEThe certificate store is the name of a PKCS7 file containing certificates.
PPKFILEThe certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILEThe certificate store is the name of a file that contains a certificate in XML format.
XMLBLOBThe certificate store is a string that contains a certificate in XML format.
BCFKSFILEThe certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOBThe certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

Yahoo Shopping Connector for CData Sync

SSLClientCertPassword

Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.

Remarks

This property provides the password needed to open a password-protected certificate store. This property is necessary when using certificate stores that require a password for decryption, as is often recommended for PFX or JKS type stores.

If the certificate store type does not require a password, for example USER or MACHINE on Windows, this property can be left blank. Ensure that the password matches the one associated with the specified certificate store to avoid authentication errors.

Yahoo Shopping Connector for CData Sync

SSLClientCertSubject

Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.

Remarks

This property determines which client certificate to load based on its subject. The Sync App searches for a certificate that exactly matches the specified subject. If no exact match is found, the Sync App looks for certificates containing the value of the subject. If no match is found, no certificate is selected.

The subject should follow the standard format of a comma-separated list of distinguished name fields and values. For example, CN=www.server.com, OU=Test, C=US. Common fields include the following:

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

Note: If any field contains special characters, such as commas, the value must be quoted. For example: CN="Example, Inc.", C=US.

Yahoo Shopping Connector for CData Sync

SSLServerCert

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

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

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

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

Yahoo Shopping Connector for CData Sync

Firewall

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


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Yahoo Shopping Connector for CData Sync

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

The following table provides port number information for each of the supported protocols.

Protocol Default Port Description
TUNNEL 80 The port where the Sync App opens a connection to Yahoo Shopping. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Yahoo Shopping. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the Sync App sends data to Yahoo Shopping. If the SOCKS 5 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.

Yahoo Shopping Connector for CData Sync

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Yahoo Shopping Connector for CData Sync

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Yahoo Shopping Connector for CData Sync

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Yahoo Shopping Connector for CData Sync

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Yahoo Shopping Connector for CData Sync

Proxy

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


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerIdentifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPortIdentifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserProvides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordSpecifies the password of the user specified in the ProxyUser connection property.
ProxySSLTypeSpecifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsSpecifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Yahoo Shopping Connector for CData Sync

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

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

Yahoo Shopping Connector for CData Sync

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Yahoo Shopping Connector for CData Sync

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Yahoo Shopping Connector for CData Sync

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

Supported authentication types :

  • BASIC: The Sync App performs HTTP basic authentication.
  • DIGEST: The Sync App performs HTTP digest authentication.
  • NTLM: The Sync App retrieves an NTLM token.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

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

Yahoo Shopping Connector for CData Sync

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The username of a user registered with the proxy server.
DIGEST The username of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.

Yahoo Shopping Connector for CData Sync

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.

Yahoo Shopping Connector for CData Sync

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Yahoo Shopping Connector for CData Sync

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note: 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, set ProxyAutoDetect to False.

Yahoo Shopping Connector for CData Sync

Logging

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


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Yahoo Shopping Connector for CData Sync

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name Module Description Submodules
INFO General Information. Includes the connection string, product version (build number), and initial connection messages.
  • Connec – Information related to creating or destroying connections.
  • Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.
  • Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance.
  • Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user).
  • Page – Messages related to query paging.
  • Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.
  • KERB – HTTP requests related to Kerberos.
  • Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product.
  • Res – Messages containing HTTP responses.
  • Req – Messages containing HTTP requests.
WSDL Messages pertaining to the generation of WSDL/XSD files. —
SSL SSL certificate messages.
  • Certif – Messages pertaining to SSL certificates.
AUTH Authentication related failure/success messages.
  • Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • OAuth – Messages related to OAuth authentication.
  • Krbros – Kerberos-related authentication messages.
SQL Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.
  • Bulk – Messages pertaining to bulk query execution.
  • Cache – Messages related to reading row data from and writing row data to the product's cache for better performance.
  • Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
  • ResSet – Query resultsets.
  • Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META Metadata cache and schema messages.
  • Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance.
  • Schema – Messages related to retrieving metadata from or modifying the service schema.
  • MemSto – Messages related to writing to or reading from in-memory metadata cache.
  • Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC Information related to executing SQL functions.
  • Errmsg – Error messages related to executing SQL functions.
TCP Incoming and outgoing raw bytes on TCP transport layer messages.
  • Send – Raw data sent via the TCP protocol.
  • Receiv – Raw data received via the TCP protocol.
FTP Messages pertaining to the File Transfer Protocol.
  • Info – Status messages related to communication in the FTP protocol.
  • Client – Messages related to actions taken by the FTP client (the product) during FTP communication.
  • Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP Messages pertaining to the Secure File Transfer Protocol.
  • Info – Status messages related to communication in the SFTP protocol.
  • To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication.
  • From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP Messages pertaining to data transferred via the Post Office Protocol.
  • Client – Messages related to actions taken by the POP client (the product) during POP communication.
  • Server – Messages related to actions taken by the POP server during POP communication.
  • Status – Status messages related to communication in the POP protocol.
SMTP Messages pertaining to data transferred via the Simple Mail Transfer Protocol.
  • Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication.
  • Server – Messages related to actions taken by the SMTP server during SMTP communication.
  • Status – Status messages related to communication in the SMTP protocol.
CORE Messages relating to various internal product operations not covered by other modules. —
DEMN Messages related to SQL remoting. —
CLJB Messages about bulk data uploads (cloud job).
  • Commit – Submissions for bulk data uploads.
SRCE Miscellaneous messages produced by the product that don't belong in any other module. —
TRANCE Advanced messages concerning low-level product operations. —

Yahoo Shopping Connector for CData Sync

Schema

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


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Yahoo Shopping Connector for CData Sync

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:

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

Yahoo Shopping Connector for CData Sync

BrowsableSchemas

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

Remarks

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

Yahoo Shopping Connector for CData Sync

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Yahoo Shopping Connector for CData Sync

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Yahoo Shopping Connector for CData Sync

Miscellaneous

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


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PageSizeThe number of results to return per page of data retrieved from the server.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
Yahoo Shopping Connector for CData Sync

MaxRows

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

Remarks

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

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

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

Yahoo Shopping Connector for CData Sync

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting

PropertyDescription
DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=TrueConverts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Yahoo Shopping Connector for CData Sync

PageSize

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.

Yahoo Shopping Connector for CData Sync

PseudoColumns

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

Remarks

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

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Yahoo Shopping Connector for CData Sync

Timeout

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

Remarks

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

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

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

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

Yahoo Shopping Connector for CData Sync

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json
When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Yahoo Shopping Connector for CData Sync

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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

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