YSAPI_SELLING (出品に関するAPI)

  1. newコンストラクタ

  2. dataCheckHistorySummaryデータチェック履歴一覧API

  3. dataCheckHistoryDetailデータチェック履歴詳細API

  4. publishHistorySummary反映履歴/未反映項目一覧API

  5. publishHistoryDetail反映履歴/未反映項目詳細API

  6. reservePublish全反映予約API

  7. downloadRequestダウンロード要求API

  8. downloadListダウンロード準備完了通知API

  9. downloadSubmitダウンロード実行API

  10. YSAPI_DATA_CHECK_HISTORY_SUMMARY_RESPONSEdataCheckHistorySummary取得情報クラス

  11. YSAPI_DATA_CHECK_HISTORY_DETAIL_RESPONSEdataCheckHistoryDetail取得情報クラス

  12. YSAPI_PUBLISH_HISTORY_SUMMARY_RESPONSEpublishHistorySummary取得情報クラス

  13. YSAPI_PUBLISH_HISTORY_DETAIL_RESPONSEpublishHistoryDetail取得情報クラス

  14. YSAPI_DOWNLOAD_LIST_RESPONSEdownloadList取得情報クラス

__construct($auth,$seller_id="")

出品に関するAPIクラスの新規インスタンスを作成します。$api = new YSAPI_SELLING($auth,'seller_id');

IN/OUT   説明 必須 備考
in $auth YSAPI_AUTHオブジェクト  
$seller_id ストアアカウントを指定します  
out YSAPI_SELLING YSAPI_SELLINGオブジェクト    

dataCheckHistorySummary($check_id="", $file_type=0, $check_user="", $start=1, $results=25)

データチェック履歴一覧API$xml = $api->dataCheckHistorySummary();

IN/OUT   説明 必須 備考
in $check_id データチェックID(int)   単一のデータチェック履歴だけ参照する場合にデータチェックIDを指定します。
指定しない場合、全データチェック履歴が対象となります。
$file_type 絞り込むデータの種類を指定します(int)   0 : すべて
1 : ストアカテゴリ
2 : 商品
3 : 商品画像
4 : 追加画像
5 : 在庫
6 : カート内関連商品
デフォルト : 0
$check_user チェックユーザー名(string)    
$start 何件目からデータの取得をはじめるかを指定します(int)   デフォルト : 1
$results データの取得件数を指定します(int)   デフォルト : 25
最大値100
out $xml 実行結果(XMLデータ)    

dataCheckHistoryDetail($check_id, $error_type=0, $start=1, $results=25)

データチェック履歴一覧API$xml = $api->dataCheckHistoryDetail(12345678);

IN/OUT   説明 必須 備考
in $check_id 参照するデータチェックIDを指定します(int)  
$error_type 絞り込むエラー種別を指定します(int)   0 : すべて
1 : エラー
2 : 警告
(デフォルト : 1)
$start 何件目からデータの取得をはじめるかを指定します(int)   デフォルト : 1
$results データの取得件数を指定します(int)   デフォルト : 25
最大値100
out $xml 実行結果(XMLデータ)    

publishHistorySummary($publish_id="", $start=1, $results=25, $sort="-publish_time")

反映履歴/未反映項目一覧API$xml = $api->publishHistorySummary(0);

IN/OUT   説明 必須 備考
in $publish_id 反映履歴ID(int)   単一の反映履歴だけ参照する場合に反映履歴IDを指定します。
0を指定した場合、未反映項目を取得します。
指定しない場合、0(未反映項目)以外の全反映履歴が対象となります。
$start 何件目からデータの取得をはじめるかを指定します(int)   デフォルト : 1
$results データの取得件数を指定します(int)   デフォルト : 25
最大値100
$sort 一覧のソート項目を指定します(string)   指定のない場合は反映日時の降順になります。
publish_time : 反映日時
publish_user : 反映者
項目の前に以下の記号を付与することで、昇順降順を変更可能です。
+(昇順)/-(降順) ※UTF-8でURLエンコードされている必要があります。
out $xml 実行結果(XMLデータ)    

publishHistoryDetail($publish_id, $start=1, $results=25, $sort="-modify_time")

反映履歴/未反映項目詳細API$xml = $api->publishHistoryDetail(12345678);

IN/OUT   説明 必須 備考
in $publish_id 取得する反映履歴IDを指定します(int)   0を指定した場合、未反映項目詳細を取得します。
$start 何件目からデータの取得をはじめるかを指定します(int)   デフォルト : 1
$results データの取得件数を指定します(int)   デフォルト : 25
最大値100
$sort 一覧のソート項目を指定します(string)   指定のない場合は反映日時の降順になります。
modify_time : 更新日時
modify_user : 編集者
項目の前に以下の記号を付与することで、昇順降順を変更可能です。
+(昇順)/-(降順) ※UTF-8でURLエンコードされている必要があります。
out $xml 実行結果(XMLデータ)    

reservePublish($mode, $reserve_time="")

全反映予約API $xml = $api->reservePublish(1, '201707151305');

IN/OUT   説明 必須 備考
in $mode 反映予約を行うか予約取り消しを行うかのモードを指定します(int) 1 : 反映予約・予約日時変更
2 : 反映予約取り消し
3 : 予約確認
$reserve_time mode=1のとき、反映する日時を指定します(string)   YYYYMMDDHHmm形式
予約は最大7日後まで可能です。(7日後の現在時刻まで)
空の場合は現在の時刻で予約を行います。
システム全体で反映処理が空いている場合は即反映となりますが、混んでいる場合は反映まで時間がかかります。
(デフォルト : 現在の時刻)
out $xml 実行結果(XMLデータ)    

downloadRequest($type, $page_key="")

ダウンロード要求API$xml = $api->downloadRequest();

IN/OUT   説明 必須 備考
in $type ダウンロード用ファイルを生成する対象のファイルタイプを指定します(int) 1 : 商品
2 : 在庫
3 : ストアカテゴリ
$page_key ストアカテゴリのページキー(string)   type=1(商品データ)の場合のみ、ストアカテゴリをダウンロード対象に絞ることができます。
ダウンロードしたい対象のストアカテゴリのページキーを指定します。
※指定しない場合はすべての商品を対象にダウンロード要求をします。
out $xml 実行結果(XMLデータ)    

downloadList($type=0)

ダウンロード準備完了通知API$xml = $api->downloadList(1);

IN/OUT   説明 必須 備考
in $type 取得したいダウンロード用ファイルのファイルタイプを指定します(int) 0 : すべて
1 : 商品データ
2 : 在庫データ
3 : ストアカテゴリ
(デフォルト : 0)
out $xml 実行結果(XMLデータ)    

downloadSubmit($type=0)

ダウンロード実行API$csv = $api->downloadSubmit(1);

IN/OUT   説明 必須 備考
in $type ダウンロードするファイルタイプを指定します(int) 1 : 商品データ
2 : 在庫データ
3 : ストアカテゴリ
out $csv 実行結果(CSVデータ)   商品:data.csv
在庫:quantity.csv
ストアカテゴリ:category.csv

2017/07/26