Cloud

Build 25.0.9540
  • Yahoo Shopping
    • はじめに
      • 接続の確立
      • カスタムOAuth アプリケーションの作成
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • Inventory
        • OrderDetails
        • OrderLineItems
        • OrderPayments
        • Orders
        • OrderShippings
        • ProductOptions
        • Products
        • ProductSubCodes
      • ビュー
        • Categories
        • ItemImageList
        • OrderChangeHistory
        • OrderCount
        • OrderLineItemDetails
        • OrderLineItemInscriptions
        • OrderLineItemOptions
      • ストアドプロシージャ
        • CancelOrderCoupon
        • ChangeOrderStatus
        • ChangePaymentStatus
        • ChangeShipmentStatus
        • DeleteItemImage
        • GetAuthorizationStatus
        • IssuePaymentNumber
        • MoveItems
        • ReservePublish
        • SetItemDisplayPriority
        • SplitOrder
        • SubmitItem
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • SellerId
        • UseSandbox
        • PublicKey
        • PublicKeyVersion
        • Scope
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • PageSize
        • PseudoColumns
        • ThrowsKeyNotFound
        • Timeout
    • Third Party Copyrights

Yahoo Shopping - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるYahoo Shopping へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してYahoo Shopping に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Yahoo Shopping への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:Yahoo Shopping は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのYahoo Shopping への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Yahoo Shopping への接続

接続の確立 は、CData Cloud にデータベースを作成するためのYahoo Shopping への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してYahoo Shopping からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、Yahoo Shopping に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Yahoo Shopping への接続

Yahoo Shopping は埋め込みOAuth クレデンシャルを提供しており、デスクトップアプリケーションまたはヘッドレスマシンからの接続を簡単にします。Web アプリケーションから接続するには、カスタムOAuth アプリケーションの作成 で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

すべての認証フローで、OAuth 経由で接続するにはAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、Yahoo Shopping への認証について詳しく説明します。

  • デスクトップ:ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
  • Web:共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
  • ヘッドレスサーバー:他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

Yahoo Shopping で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

アクセストークンの期限が切れたときは、Cloud は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ:

Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

  1. はじめてデータに接続する際、次の接続プロパティを設定します。
    • InitiateOAuth: REFRESH。
    • OAuthClientId:カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーション設定のクライアントシークレット。
    • OAuthAccessToken:GetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation:Cloud がOAuth 値を保存する場所のパス。これは接続間で維持されます。
  2. その後のデータ接続では、以下を設定します。
    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ:

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。
    • OAuthClientId:カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーション設定のクライアントシークレット。

  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

CData Cloud

カスタムOAuth アプリケーションの作成

カスタムOAuth アプリケーションの作成

CData はOAuth アプリケーション認証情報を製品に組み込んでおり、デスクトップアプリケーションまたはヘッドレスマシン経由でYahoo Shopping に接続する際に使用できます。埋め込みOAuth アプリケーションを使用する場合、接続するために必要なことは以下のみです。

  • AuthScheme をOAuth に設定し、
  • OAuthAccessToken を取得して設定し、
  • 必要な設定パラメータを設定します。

(OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「Yahoo Shopping への接続」のデスクトップ認証セクションを参照してください。)

ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成(独自のOAuth アプリケーションクレデンシャルを使用)することもできます。

カスタムOAuth アプリケーションは、次のような場合に有用です。

  • 認証ダイアログのブランディングをコントロールしたいとき
  • ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
  • ユーザーからのリクエストに対する許可をカスタマイズしたいとき

プロシージャ

この手順では、カスタムOAuth アプリケーションを作成し、アプリケーションのOAuth 値であるOAuthClientId およびOAuthClientSecret を取得する方法を説明します。

  1. Yahoo!デベロッパーネットワークにログインします。
  2. https://e.developer.yahoo.co.jp/ の[アプリケーションの管理]サイトにアクセスします。
  3. [新規アプリケーションの作成]をクリックします。
  4. 新しいアプリケーションの名前を指定します。
  5. 新しいアプリケーションのリダイレクトURL を設定します。
    • デスクトップアプリケーションの場合は、アプリケーションの種類でクライアントタイプを選択します。リダイレクトURL をhttp://localhost:33333(Cloud のデフォルト)、または任意の異なるポートに設定します。 CallbackURL を指定したのと同じ値に設定します。
    • Web アプリケーションの場合は、アプリケーションの種類でサーバータイプを選択し、リダイレクトURL を、ユーザーがアプリケーションにアクセス許可を付与した後に戻るWeb ページに設定します。CallbackURL を指定したのと同じ値に設定します。
  6. 変更を保存します。

今後使用するために、クライアントId、クライアントシークレット、およびコールバックURL を控えておきます。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

Yahoo Shopping Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

  • SSLClientCert:クライアント証明書のための証明書ストア名。
  • SSLClientCertType:TLS / SSL クライアント証明書を格納するキーストアの種類。
  • SSLClientCertPassword:TLS / SSL クライアント証明書のパスワード。
  • SSLClientCertSubject:TLS / SSL クライアント証明書のサブジェクト。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

CData Cloud は、Yahoo Shopping オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Yahoo Shopping オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、Yahoo Shopping API へのSQL の実行について詳しく説明します。

ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。

SellerId カラムは、すべてのテーブル、ビュー、およびプロシージャにあります。これはSellerId 接続プロパティに接続されています。クエリで指定されていない場合、リクエストには接続プロパティに設定されている値が含まれます。

CData Cloud

テーブル

Cloud はYahoo Shopping のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Yahoo Shopping テーブル

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.

CData Cloud

Inventory

Stock database of inventory data in Yahoo! Shopping.

Select

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

  • ItemCode and SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM Inventory WHERE ItemCode = 'CD001' 

Insert

Insert is not supported by Inventory

Update

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

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

Batch Update

Yahoo Shopping allows updates for the same columns.

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

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

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

Delete

Delete is not supported by Inventory

Columns

Name Type ReadOnly References Description
ItemCode [KEY] String False

Products.ItemCode

Product code. In INSERT or UPDATE: For products that do not have individual product codes, please specify only the product code. For products with individual item codes, please connect the product code and individual product code with a colon ':'.

SellerId String False

Id of the store account. In UPDATE: If the number has a plus sign '+', the value will be added and it will be subtracted if minus sign '-' is attached. If only numeric value is written, the field will be updated with that value.

SubCode String True

Individual product code. If the product does not have individual product code, this will be empty.

Status Integer True

Stock acquisition status. 0: No stock information, 1: Stock information available.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0, 1

IsPublished Integer True

The product reflection flag. 0: Product not reflected, 1: Product reflected.

使用できる値は次のとおりです。0, 1

UpdateTime Datetime True

Last update date.

StockClose Integer False

Stock Close Flag. 0: Normal State, 1: Stock Closed State

使用できる値は次のとおりです。0, 1

CData Cloud

OrderDetails

Returns data from a sample table.

Select

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

  • OrderId AND SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM OrderDetails WHERE OrderId = 'store_000001'

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

Insert

Insert is not supported by OrderDetails

Update

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

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

Delete

Delete is not supported by OrderDetails

Columns

Name Type ReadOnly References Description
OrderId [KEY] String False

Orders.OrderId

Order Id.

SellerId String False

Store account.

OrderTime Datetime True

The date and time when the order was made.

OrderStatus Integer False

Status of the order. 1: During reservation, 2: In process, 3: Hold, 4: Cancel, 5: Completed.

使用できる値は次のとおりです。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

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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

CData Cloud

OrderLineItems

Returns data from a sample table.

Select

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

  • OrderId AND SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM OrderLineItems WHERE OrderId = 'store_000001'

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

Insert

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

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

Batch Insert

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

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

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

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

Update

UPDATE is not supported by OrderDetails

Delete

Delete is not supported by OrderDetails

Columns

Name Type ReadOnly References Description
OrderId [KEY] String False

Orders.OrderId

Order ID.

LineId [KEY] Integer False

Product line ID.

OrderTime Datetime True

The date and time when the order was made.

SellerId String False

Store account ID.

ItemId String False

Product ID.

Title String False

Product title.

SubCode String False

The subcode of the product when this value has been set.

SubCodeOption String True

The subcode option when this value has been set. Both key & value.

IsUsed Boolean True

Indicates whether it is a used item.

ImageId String True

The product image ID.

IsTaxable Boolean True

Tax object flag.

Jan String True

Japanese Article Number code.

ProductId String True

The product code (product number/model number).

CategoryId Integer True

Category code.

AffiliateRatio String True

Store burden rate.

UnitPrice Integer False

Unit price of each item (amount after discount of store coupons) .

ItemTaxRatio Integer True

Unit price of each item (amount after discount of store coupons) .

Quantity Integer False

The quantity of each item.

PointAvailQuantity Integer True

Points to be granted quantity.

ReleaseDate Date True

Release date. This is only when there is input of release date. For release date bigger than order date, treat it as a pre-order.

HaveReview Boolean True

Product review absence flag.

PointFspCode String True

Point code by item. 10001 to 10015, 2001 to 20010.

PointRatioY Integer True

Granted Point Magnification (Yahoo! JAPAN Burden).

PointRatioSeller Integer True

Granted Point Magnification (Store Burden).

UnitGetPoint Integer True

Number of credit points granted.

IsGetPointFix Boolean True

Granted point determination flag.

GetPointFixDate Date True

Granulation point determination date. After 14 days of order date, we will set the pre-order to 14 days after release date.

CouponDiscount Integer True

Coupon discount amount.

CouponUseNum Integer True

Number of applicable coupons.

OriginalPrice Integer True

Unit price before discount.

OriginalNum Integer True

Quantity before line splitting.

LeadTimeStart Date True

Start of shipment date.

LeadTimeEnd Date True

Shipment day end.

LeadTimeText String True

Shipping date text.

CouponData String True

Store coupons.

IsQuotation Boolean False

Used only on UPDATE.

OperationUser String False

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

YamatoCoopStatus Integer True

It is a status that shows the current status of the link to Yamato Transport.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0, 1, 2, 3, 4, 5

YamatoUndeliverableReason String True

The reason why Yamato delivery is not possible.

CData Cloud

OrderPayments

Returns data from a sample table.

Select

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

  • OrderId AND SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM OrderPayments WHERE OrderId = 'store_000001'

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

Insert

Insert is not supported by OrderPayments

Update

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

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

Delete

Delete is not supported by OrderPayments

Columns

Name Type ReadOnly References Description
OrderId [KEY] String False

Orders.OrderId

Order ID.

SellerId String False

Store account ID.

OrderTime Datetime True

The date and time when the order was made.

PayStatus Integer False

Deposit status. 0: Waiting for payment, 1: Payment already made

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

PayType Integer False

Payment classification. 0: Postpay, 1: Prepay.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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

使用できる値は次のとおりです。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.

CData Cloud

Orders

Returns data from a sample table.

Select

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

  • OrderId support the = operator.
  • SellerId DeviceType IsSeen IsSplit IsRoyalty IsAffiliate Suspect OrderStatus and StoreStatus support the = operator.
  • OrderTime supports the following operators: =,<,<=,> AND >=.
For example, the following queries are processed server side:
SELECT * FROM Orders WHERE ReadOnlyMode = 2

SELECT * FROM Orders WHERE OrderId = 'store_000001'

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

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

Insert

Insert is not supported by Orders

Update

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

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

Delete

Delete is not supported by Orders

Columns

Name Type ReadOnly References Description
OrderId [KEY] String False

Order Id.

SellerId String False

Store account.

OrderTime Datetime True

The date and time when the order was made.

Version Integer True

Shopping cart and IF specification version of order API.

OriginalOrderId String True

It is the order ID when we processed the order.

ParentOrderId String True

This is the splitting order ID when order is split.

DeviceType Integer True

Device information 1: PC 2: Galaxy 3: Smartphone 4: Tablet.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0, 1, 2

OrderStatus Integer True

0: Not entered 1: Reserved 2: In process 3: Hold 4: Cancel 5: Complete 8: Wait for consent.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0, 1

YamatoCoopStatus Integer True

This is a status that shows the current status of the link to Yamato Transport.

使用できる値は次のとおりです。0, 1, 2, 3, 4

ReadOnlyMode Integer True

Property to get data that the user can be able to cancel. Supports only value 2

使用できる値は次のとおりです。0, 1, 2

デフォルト値は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

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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.

使用できる値は次のとおりです。0, 1

PayStatus Integer

Deposit status. 0: Waiting for payment, 1: Payment already made.

使用できる値は次のとおりです。0, 1

CData Cloud

OrderShippings

Returns data from a sample table.

Select

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

  • OrderId AND SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM OrderShippings WHERE OrderId = 'store_000001'

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

Insert

Insert is not supported by OrderShippings

Update

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

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

Delete

Delete is not supported by OrderShippings

Columns

Name Type ReadOnly References Description
OrderId [KEY] String False

Orders.OrderId

Order Id.

SellerId String False

Store account.

OrderTime Datetime True

The date and time when the order was made.

IsPointFix Boolean False

Used only on update.

ShipStatus Integer False

Delivery status 0: Can not be shipped 1: Can be shipped 2: Shipping in progress 3: Shipped completed 4: Receiving completed.

使用できる値は次のとおりです。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

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。101, 102, 103, 104, 105

ShipInstructType Integer True

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

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0, 101, 102, 103, 104, 105, 106

IsEazy Boolean True

It is an Order Flag.

CData Cloud

ProductOptions

Return the list of options for the specified product.

Select

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

  • ItemCode and/or SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM ProductOptions WHERE ItemCode = 'CD001'

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

Insert

ItemCode, Name, SpecName are required for an Insert

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

Update

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

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

Delete

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

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

Columns

Name Type ReadOnly References Description
ItemCode [KEY] String False

Product code

SellerId String False

Id of the seller.

OptionValueId [KEY] String True

Id of the option value.

Type Integer True

Option type 1: Normal option (with inventory setting), 2: Normal option (no inventory setting).

使用できる値は次のとおりです。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.

CData Cloud

Products

Return the list of registered products of your store.

Select

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

  • StoreCategoryKey and/or SellerId support the = operator.
  • ItemCode supports the =, LIKE operator.
  • Name supports the LIKE operator.
For example, the following queries are processed server side:
SELECT * FROM Products WHERE StoreCategoryKey = 'category_key'

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

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

Insert

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

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

Update

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

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

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

Upsert

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

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

Batch Update

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

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

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

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

Delete

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

DELETE FROM Products WHERE ItemCode = 'CD000001'

Batch Delete

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

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

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

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

Columns

Name Type ReadOnly References Description
ItemCode [KEY] String False

Product code.

HasSubcode Integer True

With subcode. 1: With subcode, 0: No subcode code

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0, 1

EditingFlag Integer True

Edit flag. 1: A state that has not been reflected at the front since being edited, 0: Reflected.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0.1, 0.8

ShipWeight Integer False

Product weight.

Taxable Integer False

Tax object. 1: Taxation , 0: Tax exemption.

使用できる値は次のとおりです。0, 1

TaxrateType Decimal False

Tax rate object.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0, 1, 2

Condition Integer False

State of goods. 0: New article, 1: Used.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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

使用できる値は次のとおりです。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

CData Cloud

ProductSubCodes

Return the list of options for the specified product.

Select

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

  • ItemCode and/or SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM ProductSubcodes WHERE ItemCode = 'CD001'

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

Insert

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

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

Update

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

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

Delete

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

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

Columns

Name Type ReadOnly References Description
ItemCode [KEY] String True

Product code

SellerId String True

Id of the seller.

CodeOptionId [KEY] String True

Id of the subcode option.

Code String False

Individual product code.

Quantity Integer True

Subcode quantity.

StockClose Integer True

Subcode stock close indicator.

OptionName String False

Option name.

OptionValue String False

Option value.

LeadTimeInStock String False

Inventory ship date value.

LeadTimeOutStock String False

Out of stock value of shipment date.

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Yahoo Shopping ビュー

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.

CData Cloud

Categories

Retrieve the list of store categories.

Select

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

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

CData Cloud

ItemImageList

List of the uploaded product images.

Select

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

  • SearchTerm, StoreCategoryKey and SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM ItemImageList WHERE SearchTerm = 'img' 

SELECT * FROM ItemImageList WHERE StoreCategoryKey = 'store_category' 

Columns

Name Type References Description
Id [KEY] String Product image identifier.
SellerId String Seller Id.
SearchTerm String Specify search word when performing character search on image name (Partial Match).If you specify more than one space, it will be an AND search.
StoreCategoryKey String

Categories.PageKey

When acquiring the image list by store category unit, specify the page key of the store category.
Name String Image ID (store account _ character string excluding extension of image name)
UrlModeA String URL for A image display mode.
UrlModeB String URL for B image display mode.
UrlModeC String URL for C image display mode.
UrlModeD String URL for D image display mode.
UrlModeE String URL for E image display mode.
UrlModeF String URL for F image display mode.
UrlModeG String URL for G image display mode.
UrlModeH String URL for H image display mode.
UrlModeI String URL for I image display mode.
UrlModeJ String URL for J image display mode.
UrlModeK String URL for K image display mode.
UrlModeL String URL for L image display mode.
Size String Horizontal size of original image.
FileSize Long File size of original image (bytes).
UploadDate Datetime Update date.
PublishDate Datetime Reflection date.
EditingFlag Integer Edit flag 0: Reflected 1: State not reflected at the front after being edited.

CData Cloud

OrderChangeHistory

Provides update history information for a single order.

Select

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

  • OrderID and SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM OrderChangeHistory WHERE OrderID = 'store_00001' 

Columns

Name Type References Description
OrderId [KEY] String

Orders.OrderId

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

CData Cloud

OrderCount

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

Select

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

  • SellerId supports the = operator.
For example, the following queries are processed server side:
SELECT * FROM OrderCount WHERE SellerId = 'store' 

Columns

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

CData Cloud

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.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。101, 102, 103, 104, 105

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

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。0, 101, 102, 103, 104, 105, 106

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

使用できる値は次のとおりです。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

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

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

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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

使用できる値は次のとおりです。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.

使用できる値は次のとおりです。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

使用できる値は次のとおりです。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

CData Cloud

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.

CData Cloud

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.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、Yahoo Shopping の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにYahoo Shopping から関連するレスポンスデータを返します。

CData Cloud - Yahoo Shopping ストアドプロシージャ

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

CData Cloud

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.

CData Cloud

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

使用できる値は次のとおりです。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

使用できる値は次のとおりです。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.

CData Cloud

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.

使用できる値は次のとおりです。0, 1

PayDate Date False Deposit date.

Result Set Columns

Name Type Description
Status String Stored procedure execution status.

CData Cloud

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

使用できる値は次のとおりです。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.

CData Cloud

DeleteItemImage

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

Note:このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。

Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。

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

以下のInput テーブルでは、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。

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.

CData Cloud

GetAuthorizationStatus

Gets the authorization status of public key authentication.

Result Set Columns

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

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

SetItemDisplayPriority

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

Note:このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。

Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。

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

以下のInput テーブルでは、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。

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.

CData Cloud

SplitOrder

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

Note:このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。

Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。

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

以下のInput テーブルでは、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。

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.

CData Cloud

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.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Yahoo Shopping のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、SampleTable_1 テーブルのカラムとデータ型を返します。

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

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、SampleProcedure ストアドプロシージャのすべての入力パラメータについての情報を返します。

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

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

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

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのYahoo Shopping プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、SampleTable_1 テーブルの主キーを取得します。

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

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
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.
Scopeデータへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PageSizeThe number of results to return per page of data retrieved from the server.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
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.
Scopeデータへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

SellerId

Store account ID.

データ型

string

デフォルト値

""

解説

Store account ID.

CData Cloud

UseSandbox

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

データ型

bool

デフォルト値

false

解説

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

CData Cloud

PublicKey

Set this to the public key shared by Yahoo Shopping.

データ型

string

デフォルト値

""

解説

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

CData Cloud

PublicKeyVersion

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

データ型

int

デフォルト値

1

解説

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

CData Cloud

Scope

データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

データ型

string

デフォルト値

""

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PageSizeThe number of results to return per page of data retrieved from the server.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

PageSize

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

ThrowsKeyNotFound

更新された行がない場合に例外をスローするかどうかを指定します。

データ型

bool

デフォルト値

false

解説

更新された行がない場合に例外をスローするかどうかを指定します。

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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

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