ショッピング

ストアカテゴリ表示順序変更API

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


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

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

リクエストパラメータ

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

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

page_key:order,page_key:order
ページキーと並び順の区切りは「:(コロン)」、セット毎の区切りは「,(コンマ)」です。
orderの値を空で指定した場合、最後尾になるように更新されます。
指定しなかったストアカテゴリの並び順に関しては、既存のままになります。
orderの値は、(指定した値そのままではなく)連番に整列されて更新されます。

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

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

サンプルリクエストURL

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

サンプルリクエスト

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

seller_id=teststore&stcat_key=a5aba5c6a53&sort_order=cat1%3A10%2Ccat2%3A20

補足:1つのストアカテゴリ下にある子ストアカテゴリの表示順序を一括で変更する場合
→カテゴリすべて指定しなくても変更可能です。
 例:現在の並び順:「A:1,B:2,C:3,D:4,E:5」 リクエストパラメータ: 「A:5,B:1,C:2」
   →更新OK
   →並び順は「A:4,B:1,C:2,D:3,E:5」 で登録され、AとEは「5」で被っているので自動調整されます。
※自動調整・・・複数カテゴリが同じsort値を指定された場合、ページキー順に整列し直されます。




レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含みます。
/ResultSet/Status 全体としての更新結果(ひとつでも不正値があると、全カテゴリ更新されません)
OK : 更新OK
NG : 更新NG
/ResultSet/Result 各個別レスポンスを含みます(StatusがNGのときのみ返されます。)
/ResultSet/Result/PageKey カテゴリページキー(エラーがあったカテゴリのみ返されます)
/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>
        <PageKey>abc1</PageKey>
        <Error>
            <Target>sort_order</Target>
            <Code>sc-07101</Code>
            <Message>カテゴリ順序は数値を入力してください。</Message>
        </Error>
    </Result>
    <Result>
        <PageKey>abc2</PageKey>
        <Error>
            <Target>sort_order</Target>
            <Code>sc-07101</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ステータスコード 説明
sc-07001 400 stcat_keyが指定されていません。
sc-07002 400 sort_orderが指定されていません。
sc-07003 400 stcat_keyで指定されたストアカテゴリは存在しません。
sc-07004 400 sort_orderのフォーマットが不正です。
sc-07005 400 カテゴリ順序は数値を入力してください。
sc-07006 400 指定された並び順変更対象カテゴリページキーは存在しません。
sc-07007 400 指定されたカテゴリページは親カテゴリに含まれていません。




利用制限

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

利用約款

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