ITEM (商品管理)
ITEM yItemApi
商品管理API(ItemAPI)の機能を利用するためのクラスです。
メソッド
- ySellingApi New( ref yAuth auth, string seller_id = "" )
- コンストラクタ
- auth
- YConnect認証クラス (参照渡し)
- seller_id
- Yahoo!ショッピング sellerId
- XmlDocument editItem(yItemInfo info)
- 商品登録API
- info
- 商品更新情報
- Return
- XMLデータ
- XmlDocument updateItems(List<yItemInfo> infos)
- 商品一括更新API
- infos
- 商品更新情報リスト (最大100まで)
- Return
- XMLデータ
- XmlDocument moveItems(string item_code,string from_stcat_key,string to_stcat_key,string mode="move")
- 商品移動API
- item_code
- 商品コードを指定します。「,」区切りで複数指定可能。（最大100個）
- from_stcat_key
- 移動元のストアカテゴリのページIDを指定します
- to_stcat_key
- 移動先、またはリンク先とするストアカテゴリのページIDを指定します
- mode
- move : 商品の移動を行います
link : 商品のリンクを作成します - Return
- XMLデータ
- XmlDocument sortItems(string stcat_key,string sort_order)
- 商品表示順序変更API ※廃止されました
- XmlDocument setItemDisplayPriority(string stcat_key,string sort_priority_list)
- 商品表示優先順変更API
- stcat_key
- 対象となるストアカテゴリのページIDを指定します。
- sort_priority_list
- item_code（優先順を変更する商品コード）
sort_priority（優先順の値を指定する。最小値1、最大値9,999,999。空文字許容）
item_code:sort_priority,item_code:sort_priority
商品コードと優先順の区切りは「:（コロン）」、セット毎の区切りは「,（コンマ）」
sort_priorityの値を空で指定した場合、おすすめ順または新着順に並びます。 - Return
- XMLデータ
- XmlDocument getItem(string item_code,int expand_spec=0)
- 商品参照API
- item_code
- 参照する商品コードを指定します。
- expand_spec
- 0:spec_value_idを単数返し、spec[1-10]のレスポンスの形式。
1:spec_value_idを復数返し。
パラメータを付与しない場合は0をつけた際と同じレスポンスとする。 - Return
- XMLデータ
- XmlDocument deleteItem(string item_code)
- 商品削除API
- item_code
- 削除する商品コードを指定します。
- Return
- XMLデータ
- XmlDocument submitItem(string item_code)
- 商品個別反映API
- item_code
- 商品コードを指定します。
- Return
- XMLデータ
- XmlDocument myItemList(bool stock=false,int start=1,int results=25,string query="",string type= "item_code",string sort= "+sort_order",string stcat_key="")
- 商品リストAPI
- stock
- 在庫数を取得するかどうか指定します
- start
- 何件目からデータの取得をはじめるかを指定します
- results
- データの取得件数（最大値100）を指定します
- query
- 検索ワードを指定します スペース区切りで複数指定した場合は、AND検索となります
- type
- item_code ： 商品コード（前方一致）
name ： 商品名 （部分一致） - sort
- 一覧のソート項目を指定します
item_code : 商品コード
name : 商品名
stcat_key : 親カテゴリのページキー
sort_priority : 商品表示優先順
項目の前に以下の記号を付与することで、昇順降順を変更可能です。 - stcat_key
- 絞り込むストアカテゴリのページキーを指定します
- Return
- XMLデータ
- XmlDocument myItemListAll(bool stock=false,string query="",string type= "item_code",string sort= "+sort_order",string stcat_key="")
- 商品リストAPI (全件取得)
- stock
- 在庫数を取得するかどうか指定します
- query
- 検索ワードを指定します スペース区切りで複数指定した場合は、AND検索となります
- type
- item_code ： 商品コード（前方一致）
name ： 商品名 （部分一致） - sort
- 一覧のソート項目を指定します
item_code : 商品コード
name : 商品名
stcat_key : 親カテゴリのページキー
sort_priority : 商品表示優先順
項目の前に以下の記号を付与することで、昇順降順を変更可能です。 - stcat_key
- 絞り込むストアカテゴリのページキーを指定します
- Return
- XMLデータ
- XmlDocument uploadItemFile(string filePath, int type)
- 商品アップロードAPI
- filePath
- CSVファイルパスを指定します
- type
- アップロードタイプを指定します 1: 追加, 2: 上書き, 3: 削除, 4: 項目指定
- Return
- XMLデータ
イベント
- void MyItemListStartEventHandler(object sender, yListStartEventArgs e)
- 商品リストAPI開始イベントハンドラ
- sender
- e
- yListStartEventArgs (カスタムイベントオブジェクト)
- void MyItemListRowEventHandler(object sender, yListRowEventArgs e)
- 商品リストAPI行取得イベントハンドラ
- sender
- e
- yListRowEventArgs (カスタムイベントオブジェクト)
- void MyItemListCompleteEventHandler(object sender, yListCompleteEventArgs e)
- 商品リストAPI終了イベントハンドラ
- sender
- e
- yListCompleteEventArgs (カスタムイベントオブジェクト)
yItemInfo
商品更新情報クラス
メソッド
- New()
- コンストラクタ
- New(XmlElement xml)
- コンストラクタ
- xml
- getItemで取得したXML(/ResultSet/Result)
プロパティ
- string item_code
- 商品コード（半角英数字、ハイフンのみ。99文字以内）※必須
- List<string> path
- ストアカテゴリのパス（カテゴリ名のコロン区切り）を指定します（カテゴリ名は全角20文字以内、カテゴリ階層は8階層以内）
複数指定する場合は改行コード（%0D%0A）で区切ってください ※必須 - string name
- 商品名（全角75文字以内）※必須
- Nullable<int> product_category
- YahooショッピングカテゴリID（半角数字のみ。10文字以内）
- Nullable<int> original_price
- 定価（半角数字のみ。8文字以内）
- int price
- 通常販売価格（半角数字のみ。8文字以内）※必須
- Nullable<int> sale_price
- 特価（半角数字のみ。8文字以内）
- string headline
- キャッチコピー（全角30文字以内、HTML不可）
- string caption
- 商品説明（全角5,000文字以内、HTML可）
- string @abstract
- ひと言コメント（全角500文字以内、HTML可）
- string explanation
- 商品情報（全角500文字以内、HTML不可）。改行可。
- string additional1
- フリースペース1（全角5,000文字以内、HTML可）
- string additional2
- フリースペース2（全角5,000文字以内、HTML可）
- string additional3
- フリースペース3（全角5,000文字以内、HTML可）
- string sp_additional
- スマートフォン用フリースペース（全角5,000文字以内、画像込みの総容量2000KB以内、HTML可）
- List<string> relevant_links
- おすすめ商品の商品コード（最大20個）
- List<string> cart_related_items
- カート内関連商品コード（最大3個）
- Nullable<int> ship_weight
- 重量（半角数字のみ。7文字以内）
- int taxable
- 課税対象 1 : 課税, 0 : 非課税
- Nullable<DateTime> release_date
- 発売日
- bool release_date_delete
- 発売日削除フラグ(更新時使用) ※発売日をnullにしても変更されないだけで削除されません
- Nullable<DateTime> sale_period_start
- 販売開始日時
- Nullable<DateTime> sale_period_end
- 販売終了日時
- bool sale_period_delete
- 販売期間削除フラグ(更新時使用) ※販売開始、販売終了日時をnullにしても変更されないだけで削除されません
- Nullable<int> sale_limit
- 購入数制限（半角数字のみ。1～999を入力）
- Nullable<int> sp_code
- 販促コード（半角数字のみ。10文字）
- string point_code
- ポイント倍率コード 1～15,X15,X10,X07,Z15,Z10,X03,Y05,Y03,D05
- string meta_key
- META Keyword
- string meta_desc
- META description（全角80文字以内）
- int display
- ページ公開 1 : 公開, 0 : 非公開
- string hidden_page
- 隠しページ設定 hidden_flag（1 : 隠しページ、0 : 通常）
hidden_flag:hidden_id:hidden_password - string template
- デザインテンプレート（IT01～IT12）
- string template_name
- テンプレート名
- Nullable<int> brand_code
- ブランドコード（半角数字のみ。10文字以内）
- string yahoo_product_code
- Yahoo!ショッピング製品コード（半角英数字のみ。32文字）
- string product_code
- 製品コード（半角文字のみ。50文字以内）
- Nullable<int> jan
- JAN / ISBN コード（半角英数字、ハイフンのみ。17文字以内）
- int delivery
- 送料無料設定 0 : なし, 1 : 無料, 2 : 送料込み, 3 : 条件付送料無料
- int astk_code
- きょうつく／あすつくコード 0 : 非対応, 1 : あすつく, 2 : きょうつく
- int condition
- 商品の状態 0 : 新品, 1 : 中古 （※古物免許を登録していないと中古に設定することはできません）
- List<string> spec
- スペック [0]=spec1,[1]=spec2,...[9]=spec10
項目と値をコロン(:)で区切る,
複数の値がある場合はその後にパイプ(|)で区切る,
項目は半角数字10文字、値は半角数字9文字以内 - Hashtable options
- オプションはインスクリプションと合わせて最大20個
option_name（オプション名。全角28文字以内）
option_spec（オプションに指定するスペックID。半角数字10文字以内）
option_value（オプション値。全角28文字以内）
option_value_spec（オプション値に指定するスペック値ID。半角数字9文字以内）
options[オプション名]["SpecId"] = スペックID
options[オプション名]["Value"][オプション値] = スペック値ID - Dictionary<string,int> inscriptions
- オプションとして、購入時に文字入力させたい場合に利用します
name（インスクリプション名。全角28文字以内）
length (インスクリプションの文字数制限。1～60を指定)
inscriptions[インスクリプション名] = 文字数制限 - Hashtable subcodes
- option（オプション名。全角28文字以内）
option_value（オプション値。全角28文字以内）
subcode（個別商品コード 半角英数字、ハイフンのみ 99文字以内）
subcodes["サブコード"]["Quantity"] = 個別在庫数
subcodes["サブコード"]["Option"][オプション名] = オプション値 - string original_price_evidence
- エビデンスURL（URL形式）
- Nullable<int> lead_time_instock
- 発送日情報管理番号（在庫があり時に表示したい発送日表示文言の設定）
- Nullable<int> lead_time_outstock
- 発送日情報管理番号（在庫が切れ時に表示したい発送日表示文言の設定）
- Nullable<int> quantity
- 在庫数
- string[] image
- 商品プレビュー画像（bサイズ） [0]=商品プレビュー画像 [1]～[5]商品詳細プレビュー画像
- Nullable<int> show_stock
- 在庫表示設定（商品個別設定） 1 : 在庫数表示, 2 : 在庫有無表示
- Nullable<DateTime> update_time
- 更新日時
- Nullable<int> editing_flag
- 編集フラグ 1 : 編集されてからフロント反映されていない状態, 0 : 反映済み
※送料込みは送料無料として扱うことになったため、2を指定した場合1として保存されます
2017/06/17