ショッピング

ストアカテゴリ編集API

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


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

ストアカテゴリを登録・編集します。(フロント反映はしません)

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
page_key string 更新の場合にページキーを指定します。指定がない場合は新規となります。(空白=新規、指定=更新)
新規作成時はシステムでページキーを割り振るため、任意のページキーを指定することはできません。
parent_page_key string 新規の場合に親カテゴリのページキーを指定します。指定がない場合は第1階層のカテゴリとして登録されます。8階層目にある親カテゴリを指定した場合、エラーとなります。 ※カテゴリを移動したい場合は、ストアカテゴリ移動APIをご利用ください。
name
(必須)
string ストアカテゴリ名(全角20文字以内)
template_id string
(デフォルト : CT01)
テンプレートID
meta_desc string META description(全角80文字以内)
display integer
(デフォルト : 1)
公開ステータス
0 : 非公開
1 : 公開
freespace1 string フリースペース1(HTML可、全角5000文字以内)
freespace2 string フリースペース2(HTML可、全角5000文字以内)
side_navi_image string サイドナビ画像に使用する登録済みの追加画像ファイル名を指定します。
title_image string タイトル画像に使用する登録済みの追加画像ファイル名を指定します。
category_image string カテゴリイメージ画像に使用する登録済みの追加画像ファイル名を指定します。
relevant_links string おすすめ商品コード(カンマ区切りで最大20件まで指定可能)
hidden_flag integer
(デフォルト : 0)
隠しページフラグ
0 : 通常ページ
1 : 隠しページ
hidden_id string 隠しページ用ID(半角英数字、半角20文字以内)
hidden_password string 隠しページ用パスワード(半角英数字、半角20文字以内)

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

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


サンプルリクエストURL

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

サンプルリクエスト

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

seller_id=teststore&parent_page_key=b6afa5eaa6&name=%e3%82%ab%e3%83%86%e3%82%b4%e3%83%aa1



レスポンスフィールド

フィールド 説明
/ResultSet レスポンスのすべてを含みます。
/ResultSet/Status 成功時に「OK」と表示します。
失敗時は別フォーマットでエラーレスポンスを表示します。



サンプルレスポンス

<!--・サンプルレスポンス(成功時)-->

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



<!--・サンプルレスポンス(エラー時)-->

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Status>NG</Status>
    <Error>
        <Target>name</Target>
        <Code>sc-01003</Code>
        <Message>ストアカテゴリ名が指定されていません。</Message>
    </Error>
    <Error>
        <Target>display</Target>
        <Code>sc-01008</Code>
        <Message>公開ステータスは0か1を入力してください。</Message>
    </Error>
    <Warning>
        <Target>freespace1</Target>
        <Code>sc-01101</Code>
        <Message>フリースペースはタグ閉じされていません。</Message>
    </Warning>
</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-01001 400 指定されたページキーは存在しません。
sc-01002 400 指定された親カテゴリページキーは存在しません。
sc-01005 400 同じカテゴリ階層に同名のストアカテゴリ名が存在します。
sc-01006 400 9階層以降にはカテゴリは作成できません。
sc-01007 400 テンプレートIDが不正です。 
sc-01020 400 登録可能なカテゴリ数の上限に達しています。
sc-01027 400 このカテゴリ名は使用できません。
sc-01030 400 ページキーの指定が不正です。
sc-01031 400 親カテゴリページキーの指定が不正です。
sc-01032 400 カテゴリ名の指定が不正です。
sc-01034 400 META descriptionの指定が不正です。
sc-01035 400 公開ステータスの指定が不正です。
sc-01036 400 フリースペース1の指定が不正です。
sc-01037 400 フリースペース2の指定が不正です。
sc-01038 400 サイドナビ画像の指定が不正です。
sc-01039 400 タイトル画像の指定が不正です。
sc-01040 400 カテゴリイメージ画像の指定が不正です。
sc-01041 400 おすすめ商品の指定が不正です。
sc-01042 400 隠しページフラグの指定が不正です。
sc-01043 400 隠しページ用IDの指定が不正です。
sc-01044 400 隠しページ用パスワードの指定が不正です。
sc-01045 400 テンプレートIDの指定が不正です。


・エラーコード(入力値エラー系)

コード HTTPステータスコード 説明
sc-01003 200 ストアカテゴリ名が指定されていません。
sc-01004 200 カテゴリ名は20文字(40バイト)以内で入力してください。
sc-01008 200 公開ステータスは0か1を入力してください。
sc-01009 200 フリースペース1は全角5000文字(半角10000文字)以内で入力してください。
sc-01010 200 フリースペース2は全角5000文字(半角10000文字)以内で入力してください。
sc-01011 200 サイドナビ画像に指定した画像IDが存在しません。
sc-01012 200 タイトル画像に指定した画像IDが存在しません。
sc-01013 200 カテゴリイメージ画像に指定した画像IDが存在しません。
sc-01014 200 おすすめ商品のフォーマットが無効です。
sc-01015 200 隠しページフラグは0か1を入力してください。
sc-01016 200 隠しページ用IDは必須です。
sc-01017 200 隠しページ用パスワードは必須です。
sc-01019 200 META descriptionは全角80文字(半角160文字)以内で入力してください。
sc-01021 200 おすすめ商品数は最大20個です。
sc-01022 200 おすすめ商品は半角99文字以内で入力してください。
sc-01023 200 隠しページ用IDは半角英数20文字以内で入力してください。
sc-01024 200 隠しページ用パスワードは半角英数20文字以内で入力してください。
sc-01025 200 親カテゴリページキーは半角英数99文字以内で入力してください。
sc-01026 200 カテゴリページキーは半角英数99文字以内で入力してください。
sc-01101 200 フリースペースはタグ閉じされていません。
sc-01102 200 外部リンクを削除しました。




利用制限

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

利用約款

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