SELLING (出品管理)
- YSAPI
-
SELLING 出品管理
- ySellingApi 出品に関するAPI
- yDataCheckHistorySummary データチェック履歴詳細情報クラス
- yDataCheckHistoryDetailInfo データチェック履歴詳細情報クラス
- yPublishHistorySummaryInfo 反映履歴/未反映項目情報クラス
- yPublishHistoryDetailInfo 反映履歴/未反映項目詳細情報クラス
ySellingApi
出品管理API(SellingAPI)の機能を利用するためのクラスです。
メソッド
- ySellingApi New( ref yAuth auth, string seller_id = "" )
- コンストラクタ
- auth
- YConnect認証クラス (参照渡し)
- seller_id
- Yahoo!ショッピング sellerId
- XmlDocument dataCheckHistorySummary(string check_id="",int file_type=0,string check_user="", int start=1,int results=25)
- データチェック履歴一覧API
- check_id
- 単一のデータチェック履歴だけ参照する場合にデータチェックIDを指定します
- file_type
- 絞り込むデータの種類を指定します 0 : すべて,1 : ストアカテゴリ,2 : 商品,3 : 商品画像,4 : 追加画像,5 : 在庫,6 : カート内関連商品
- check_user
- 単一のデータチェック履歴だけ参照する場合にチェックユーザーを指定します
- start
- 何件目からデータの取得をはじめるかを指定します
- results
- データの取得件数を指定します。（最大値100）
- Return
- XMLデータ
- XmlDocument dataCheckHistorySummaryAll(string check_id="",int file_type=0,string check_user="")
- データチェック履歴一覧API (全件取得)
- check_id
- 単一のデータチェック履歴だけ参照する場合にデータチェックIDを指定します
- file_type
- 絞り込むデータの種類を指定します 0 : すべて,1 : ストアカテゴリ,2 : 商品,3 : 商品画像,4 : 追加画像,5 : 在庫,6 : カート内関連商品
- check_user
- 単一のデータチェック履歴だけ参照する場合にチェックユーザーを指定します
- Return
- XMLデータ
- XmlDocument dataCheckHistoryDetail(string check_id="",int error_type=0, int start=1,int results=25)
- データチェック履歴詳細API
- check_id
- 参照するデータチェックIDを指定します
- error_type
- 絞り込むエラー種別を指定します 0 : すべて, 1 : エラー, 2 : 警告
- start
- 何件目からデータの取得をはじめるかを指定します
- results
- データの取得件数を指定します。（最大値100）
- Return
- XMLデータ
- XmlDocument dataCheckHistoryDetailAll(string check_id="",int error_type=0)
- データチェック履歴詳細API (全件取得)
- check_id
- 参照するデータチェックIDを指定します
- error_type
- 絞り込むエラー種別を指定します 0 : すべて, 1 : エラー, 2 : 警告
- Return
- XMLデータ
- XmlDocument publishHistorySummary(Nullable<int> publish_id=null,int start=1,int results=25,string sort= "-publish_time")
- 反映履歴/未反映項目一覧API
- publish_id
- 単一の反映履歴だけ参照する場合に反映履歴IDを指定します 0を指定した場合、未反映項目を取得します
- start
- 何件目からデータの取得をはじめるかを指定します
- results
- データの取得件数を指定します。（最大値100）
- sort
- 一覧のソート項目を指定します。指定のない場合は反映日時の降順になります。publish_time : 反映日時, publish_user : 反映者
- Return
- XMLデータ
- XmlDocument publishHistorySummaryAll(Nullable<int> publish_id=null,string sort= "-publish_time")
- 反映履歴/未反映項目一覧API (全件取得)
- publish_id
- 単一の反映履歴だけ参照する場合に反映履歴IDを指定します 0を指定した場合、未反映項目を取得します
- sort
- 一覧のソート項目を指定します。指定のない場合は反映日時の降順になります。publish_time : 反映日時, publish_user : 反映者
- Return
- XMLデータ
- XmlDocument publishHistoryDetail(Nullable<int> publish_id=null,int start=1,int results=25,string sort= "-modify_time")
- 反映履歴/未反映項目詳細API
- publish_id
- 単一の反映履歴だけ参照する場合に反映履歴IDを指定します 0を指定した場合、未反映項目を取得します
- start
- 何件目からデータの取得をはじめるかを指定します
- results
- データの取得件数を指定します。（最大値100）
- sort
- 一覧のソート項目を指定します。指定のない場合は反映日時の降順になります。publish_time : 反映日時, publish_user : 反映者
- Return
- XMLデータ
- XmlDocument publishHistoryDetailAll(Nullable<int> publish_id=null,string sort= "-modify_time")
- 反映履歴/未反映項目詳細API (全件取得)
- publish_id
- 単一の反映履歴だけ参照する場合に反映履歴IDを指定します 0を指定した場合、未反映項目を取得します
- sort
- 一覧のソート項目を指定します。指定のない場合は反映日時の降順になります。publish_time : 反映日時, publish_user : 反映者
- Return
- XMLデータ
- XmlDocument reservePublish(int mode,Nullble<DateTime> reserve_time= null)
- 全反映予約API
- mode
- 反映予約を行うか予約取り消しを行うかのモードを指定します。
1 : 反映予約・予約日時変更
2 : 反映予約取り消し
3 : 予約確認 - reserve_time
- mode=1のとき、反映する日時を指定します。（YYYYMMDDHHmm形式）
予約は最大7日後まで可能です。（7日後の現在時刻まで）
空の場合は現在の時刻で予約を行います。
システム全体で反映処理が空いている場合は即反映となりますが、混んでいる場合は反映まで時間がかかります。 - Return
- XMLデータ
- XmlDocument downloadRequest(int type,string page_key= "")
- ダウンロード要求API
- type
- 1 : 商品, 2 : 在庫, 3 : ストアカテゴリ
- page_key
- ページキー
- Return
- XMLデータ
- XmlDocument downloadList(int type)
- ダウンロード準備完了通知API
- type
- 1 : 商品, 2 : 在庫, 3 : ストアカテゴリ
- Return
- XMLデータ
- string downloadSubmit(int type)
- ダウンロード実行API
- type
- 1 : 商品, 2 : 在庫, 3 : ストアカテゴリ
- Return
- CSVデータ
イベント
- void DataCheckHistorySummaryStartEventHandler(object sender, yListStartEventArgs e)
- データチェック履歴一覧API開始イベントハンドラ
- sender
- e
- yListStartEventArgs (カスタムイベントクラス)
- void DataCheckHistorySummaryRowEventHandler(object sender, yListRowEventArgs e)
- データチェック履歴一覧API行取得イベントハンドラ
- sender
- e
- yListRowEventArgs (カスタムイベントクラス)
- void DataCheckHistorySummaryCompleteEventHandler(object sender, yListCompleteEventArgs e)
- データチェック履歴一覧API終了イベントハンドラ
- sender
- e
- yListCompleteEventArgs (カスタムイベントクラス)
- void DataCheckHistoryDetailStartEventHandler(object sender, yListStartEventArgs e)
- データチェック履歴詳細一覧API開始イベントハンドラ
- sender
- e
- yListStartEventArgs (カスタムイベントクラス)
- void DataCheckHistoryDetailRowEventHandler(object sender, yListRowEventArgs e)
- データチェック履歴詳細一覧API行取得イベントハンドラ
- sender
- e
- yListRowEventArgs (カスタムイベントクラス)
- void DataCheckHistoryDetailCompleteEventHandler(object sender, yListCompleteEventArgs e)
- データチェック履歴詳細一覧API終了イベントハンドラ
- sender
- e
- yListCompleteEventArgs (カスタムイベントクラス)
- void PublishHistorySummaryStartEventHandler(object sender, yListStartEventArgs e)
- 反映履歴/未反映項目一覧API開始イベントハンドラ
- sender
- e
- yListStartEventArgs (カスタムイベントクラス)
- void PublishHistorySummaryRowEventHandler(object sender, yListRowEventArgs e)
- 反映履歴/未反映項目一覧API行取得イベントハンドラ
- sender
- e
- yListRowEventArgs (カスタムイベントクラス)
- void PublishHistorySummaryCompleteEventHandler(object sender, yListCompleteEventArgs e)
- 反映履歴/未反映項目一覧API終了イベントハンドラ
- sender
- e
- yListCompleteEventArgs (カスタムイベントクラス)
- void PublishHistoryDetailStartEventHandler(object sender, yListStartEventArgs e)
- 反映履歴/未反映項目詳細一覧API開始イベントハンドラ
- sender
- e
- yListStartEventArgs (カスタムイベントクラス)
- void PublishHistoryDetailRowEventHandler(object sender, yListRowEventArgs e)
- 反映履歴/未反映項目詳細一覧API行取得イベントハンドラ
- sender
- e
- yListRowEventArgs (カスタムイベントクラス)
- void PublishHistoryDetailCompleteEventHandler(object sender, yListCompleteEventArgs e)
- 反映履歴/未反映項目詳細一覧API終了イベントハンドラ
- sender
- e
- yListCompleteEventArgs (カスタムイベントクラス)
yDataCheckHistorySummary
データチェック履歴情報クラス
メソッド
- New()
- コンストラクタ
- New(XmlElement xml)
- コンストラクタ
- xml
- dataCheckHistorySummaryで取得したXML
プロパティ
- int CheckId
- データチェックID
- Nullable<DateTime> CheckTime
- データチェック日時
- string CheckUser
- 編集者（APIで編集した場合、編集者は記録されず「-」となります）
- int UploadType
- アップロードタイプ 1 : 追加, 2 : 上書き, 3 : 削除, 4 : 項目指定
- int FileType
- データの種類 1 : ストアカテゴリ, 2 : 商品, 3 : 商品画像 ,4 : 追加画像 ,5 : 在庫 ,6 : カート内関連商品
- int CheckStatus
- ステータス 0 : チェック中, 1 : チェック済み, 2 : 読込中, 3 : 読込済み, 9 : エラー
- int DataNum
- アップロード総件
- int ErrorNum
- エラー総件数
yDataCheckHistoryDetailInfo
データチェック履歴詳細情報クラス
メソッド
- New()
- コンストラクタ
- New(XmlElement xml)
- コンストラクタ
- xml
- dataCheckHistoryDetailで取得したXML
プロパティ
- int ErrorLine
- エラー行番号
- int ErrorCode
- エラーコード
- string ErrorMsg
- エラーメッセージ
- string DataKey
- データの種類によって下記の内容となります
ストアカテゴリ : カテゴリパス
商品 : 商品コード
商品画像 : ファイル名
追加画像 : ファイル名
在庫 : 商品コード
カート内関連商品 : 購入商品の商品コード - string FieldName
- アップロードされたファイルがCSVの場合、フィールド名となります 画像の場合、「name」という文字列が固定で入ります
- int ErrorType
- エラー種別 1:エラー, 2:警告
yPublishHistorySummaryInfo
反映履歴/未反映項目情報クラス
メソッド
- New()
- コンストラクタ
- New(XmlElement xml)
- コンストラクタ
- xml
- publishHistorySummaryで取得したXML
プロパティ
- int PublishId
- 反映履歴ID
- string PublishUser
- 反映者（APIで反映した場合、反映者は記録されず「-」となります）
- Nullable<DateTime> PublishTime
- 反映日時
- int ItemPageNum
- 商品ページの反映数
- int ItemPageNum
- 商品ページの反映数
- int CategoryPageNum
- カテゴリページの反映数
- int TopPageNum
- トップページその他の反映数
- int CustomPageNum
- カスタムページの反映数
- int StoreDesignNum
- ストアデザインの反映数
- int ItemImageNum
- 商品画像の反映数
- int LibImageNum
- 追加画像の反映数
yPublishHistoryDetailInfo
反映履歴/未反映項目詳細情報クラス
メソッド
- New()
- コンストラクタ
- New(XmlElement xml)
- コンストラクタ
- xml
- publishHistoryDetailで取得したXML
プロパティ
- int ModifyType
- 更新タイプ 1 : 新規, 2 : 編集, 3 : 削除
- int PageType
- ページ種類 1 : トップページ、その他, 2 : カテゴリページ, 3 : 商品ページ, 4 : カスタムページ, 5 : ストアデザイン, 6 : 商品画像, 7 : 追加画像
- string TargetKey
- データの種類によって下記の内容となります
ページ系 : ページキー
ストアデザイン : モジュールID
商品画像 : 画像ID
追加画像 : ファイル名 - string Name
- データの種類によって下記の内容となります
トップページ、その他 : ページタイトル
カテゴリページ : カテゴリ名
商品ページ : 商品名
カスタムページ : ページタイトル
ストアデザイン : ヘッダ、サイドナビ、フッタ、ボディ（トップ）、ボディ（カテゴリ）、ボディ（商品）、ボディ（カスタム）、全体の設定
商品画像 : ファイル名
追加画像 : ファイル名 - string ModifyUser
- 編集者（APIで編集した場合、編集者は記録されず「-」となります）
- Nullable<DateTime> ModifyTime
- 更新日時
2017/06/17