ショッピング

商品表示順序変更API

リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/sortItems


こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/sortItems
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

1つのストアカテゴリ下にある商品の表示順序を一括で変更します。(フロント反映はしません)

2016年3月9日以降はスマホ版ストアカテゴリページに続き、パソコン版ストアカテゴリページでも「sort_priority : 商品表示優先順」が適用されるようになります。
今後は商品表示順序変更APIで変更された内容はパソコン版、スマートフォン版いずれのページでも使われなくなります。また、こちらのAPIは2016年4月6日以降に削除を予定しております。
今後、商品表示順を変更される場合は「商品表示優先順変更API(setItemDisplayPriority)」を使用していただくようお願いいたします。

リクエストパラメータ

RESTリクエストの構築(POST)」をご参照ください。

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
stcat_key
(必須)
string 対象となるストアカテゴリのページIDを指定します。
sort_order
(必須)
string item_code(並び順を変更する商品コード)
order(並び順の値を指定する)

item_code:order,item_code:order
商品コードと並び順の区切りは「:(コロン)」、セット毎の区切りは「,(コンマ)」
orderの値を0で指定した場合、先頭になるように更新されます。
orderの値を空で指定した場合、最後尾になるように更新されます。
指定しなかった商品コードの並び順に関しては、既存のままになります。
orderの値は、(指定した値そのままではなく)連番に整列されて更新されます。

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
Yahoo! ID連携
Yahoo! ID連携によるAPIアクセス実装方法

※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。


サンプルリクエストURL

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

サンプルリクエスト

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

seller_id=teststore&stcat_key=a5aba5c6a53&sort_order=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_order</Target>
            <Code>it-04004</Code>
            <Message>商品順序は数値を入力してください。</Message>
        </Error>
    </Result>
    <Result>
        <ItemCode>abc2</ItemCode>
        <Error>
            <Target>sort_order</Target>
            <Code>it-04004</Code>
            <Message>商品順序は数値を入力してください。</Message>
        </Error>
    </Result>
</ResultSet>    



エラー

商品表示順序変更APIはYahoo! JAPAN Web 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-04001 400 stcat_keyが指定されていません。
it-04002 400 sort_orderが指定されていません。
it-04003 400 指定されたストアカテゴリは存在しません。
it-04004 400 商品順序は数値を入力してください。
it-04005 400 指定された商品は存在しません。
it-04006 400 商品コードが指定されていません。
it-04008  400 sort_orderの値が不正です。
it-04009 400 商品コードが重複しています。




利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。

利用約款

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