商品表示優先順変更API

1つのストアカテゴリ下にある商品の表示優先順を一括で変更します。
※ フロント反映はしません。別途反映処理が必要です。

リクエストURL

テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

「Web APIの使い方#POSTとは」をご参照ください。

パラメータ	値	説明
seller_id （必須）	string	ストアアカウントを指定します。
stcat_key （必須）	string	対象となるストアカテゴリのページIDを指定します。
sort_priority_list （必須）	string	item_code（優先順を変更する商品コード） sort_priority（優先順の値を指定する。最小値1、最大値9,999,999。空文字許容） item_code:sort_priority,item_code:sort_priority 商品コードと優先順の区切りは「:（コロン）」、セット毎の区切りは「,（コンマ）」 sort_priorityの値を空で指定した場合、おすすめ順または新着順に並びます。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/setItemDisplayPriority

サンプルリクエスト

POST /ShoppingWebService/V1/setItemDisplayPriority HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

seller_id=teststore&stcat_key=a5aba5c6a53&sort_priority_list=item1%3A10%2Citem2%3A20

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含みます。
/ResultSet/Status	全体としての更新結果（ひとつでも不正値があると、全商品更新されません。） OK : 更新OK NG : 更新NG
/ResultSet/Result	各個別レスポンスを含みます。（StatusがNGのときのみ返されます。）
/ResultSet/Result/ItemCode	商品コード（エラーがあった商品のみ返されます。）
/ResultSet/Result/Error	商品コードごとのエラー情報
/ResultSet/Result/Error/Target	エラーが発生した項目
/ResultSet/Result/Error/Code	エラーコード
/ResultSet/Result/Error/Message	エラーメッセージ

サンプルレスポンス

<!--・サンプルレスポンス（更新OKの場合）-->

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Status>OK</Status>
</ResultSet>


<!--・サンプルレスポンス（商品別のエラーがあった場合）-->

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Status>NG</Status>
    <Result>
        <ItemCode>abc1</ItemCode>
        <Error>
            <Target>sort_priority</Target>
            <Code>it-14004</Code>
            <Message>指定された商品は存在しません。</Message>
        </Error>
    </Result>
</ResultSet>

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

• Yahoo! ショッピングAPI共通エラーコード一覧

商品系API、および商品表示優先順変更APIで固有に返すエラーコードは以下をご覧ください。

商品系API共通エラーコード

コード	HTTPステータスコード	説明
ed-00000	404	ページが見つかりません。
ed-00001	500	システムエラーが発生しました。
ed-00002	503	サーバがメンテナンス中です。
ed-00003	400	ストアアカウントが指定されていません。
ed-00004	400	ストアアカウントが存在しません。
ed-00005	400	ストアアカウントの指定が不正です。
ed-00006	400	反映またはアップロード中のため更新ができません。

エラーコード

コード	HTTPステータスコード	説明
it-14001	400	stcat_keyが指定されていません。
it-14002	400	sort_priority_listが指定されていません。
it-14003	400	stcat_keyの値が不正です。
it-14004	400	指定された商品は存在しません。
it-14005	400	商品コードが指定されていません。
it-14007	400	商品表示優先順は空、もしくは1～9999999(7桁)までの半角数字を入力してください。
it-14008	400	商品コード(item_code)は半角英数字とハイフンで入力して下さい。
it-14009	400	商品コードが重複しています。
it-14010	400	指定されたカテゴリには商品が存在しません。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

このAPIに関する利用約款はこちら。