ストアカテゴリ参照API

ストアカテゴリの詳細を取得します。

変更履歴

2022年04月20日

下記レスポンスフィールドの「説明」を更新しました。
・/ResultSet/Result/PayPayMallFreeSpace(PayPayモール用フリースペース)
・/ResultSet/Result/PayPayMallSpFreeSpace(SP版PayPayモール用フリースペース)

2022年04月08日

下記レスポンスフィールドの「説明」を更新しました。

  • /ResultSet/Result/SideNaviImage/Url
  • /ResultSet/Result/TitleImage/Url
  • /ResultSet/Result/CategoryImage/Url

※赤字部分を更新しています。

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getStCategory
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/getStCategory

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

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
page_key
(必須)
string ストアカテゴリのページキーを指定します。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getStCategory?seller_id=teststore&page_key=c3e6b8c5a5

サンプルリクエスト

GET /ShoppingWebService/V1/getStCategory?seller_id=teststore&page_key=c3e6b8c5a5 HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

フィールド 説明
/ResultSet レスポンスのすべてを含みます。
/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/PageKey ページキー
/ResultSet/Result/Name ストアカテゴリ名
/ResultSet/Result/TemplateId テンプレートID
※新ストアデザインを適用後、templateの指定は無効となります。
/ResultSet/Result/TemplateName テンプレート名
※新ストアデザインを適用後、templateの指定は無効となります。
/ResultSet/Result/MetaKey META keywords 
/ResultSet/Result/MetaDesc META description 
/ResultSet/Result/Display 公開フラグ
0 : 非公開
1 : 公開
/ResultSet/Result/FreeSpace1 フリースペース1
/ResultSet/Result/FreeSpace2 フリースペース2 
/ResultSet/Result/SideNaviImage サイドナビ画像 
/ResultSet/Result/SideNaviImage/Name サイドナビ画像ファイル名 
/ResultSet/Result/SideNaviImage/Url サイドナビ画像プレビュー用URL
※2022年5月以降、本番URLとなり、ドメインが変更になります。
出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/TitleImage タイトル画像 
/ResultSet/Result/TitleImage/Name タイトル画像ファイル名 
/ResultSet/Result/TitleImage/Url タイトル画像プレビュー用URL
※2022年5月以降、本番URLとなり、ドメインが変更になります。
出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/CategoryImage カテゴリイメージ画像
/ResultSet/Result/CategoryImage/Name カテゴリイメージ画像ファイル名
/ResultSet/Result/CategoryImage/Url カテゴリイメージ画像プレビュー用URL
※2022年5月以降、本番URLとなり、ドメインが変更になります。
出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/RelatedItems 各おすすめ商品の情報を含みます。
/ResultSet/Result/RelatedItems/ItemCode 商品コード 
/ResultSet/Result/HiddenPage 隠しページ情報 
/ResultSet/Result/HiddenPage/HiddenFlag 隠しページフラグ
0 : 通常ページ
1 : 隠しページ
/ResultSet/Result/HiddenPage/Id 隠しページ用ID
/ResultSet/Result/HiddenPage/Password 隠しページ用パスワード
/ResultSet/Result/EditingFlag 編集フラグ
1 : 編集されてからフロント反映されていない状態
0 : 反映済み
/ResultSet/Result/PayPayMallFreeSpace ※元PayPayモール専用項目
PayPayモール用フリースペース
2023/6/7以降こちらの項目は参照されなくなります。
期限までにフリースペース1~2へ入稿内容の移行をお願いします。
/ResultSet/Result/PayPayMallSpFreeSpace ※元PayPayモール専用項目
SP版PayPayモール用フリースペース
2023/6/7以降こちらの項目は参照されなくなります。
期限までにフリースペース(SP用)へ入稿内容の移行をお願いします。

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Result>
        <PageKey>a5c6a5b9a5</PageKey>
        <Name>カテゴリ1</Name>
        <TemplateId>1001</TemplateId>
        <TemplageName>カテゴリページ1</TemplageName>
        <MetaKey>レディースファッション</MetaKey>
        <MetaDesc>ダブルガーゼのリバーシブルワンピース</MetaDesc>
        <Display>1</Display>
        <MetaKeywords>カテゴリ1,tyafuu</MetaKeywords>
        <MetaDescription>ここはカテゴリページ1です</MetaDescription>
        <FreeSpace1>ここはカテゴリページ1です</FreeSpace1>
        <FreeSpace2></FreeSpace2>
        <SideNaviImage></SideNaviImage>
        <TitleImage></TitleImage>
        <CategoryImage></CategoryImage>
        <RelatedItems>
            <Code>newitem1</Code>
            <Code>newitem2</Code>
        </RelatedItems>
        <HiddenPage>
            <HiddenFlag>1</HiddenFlag>
            <Id>hiddenuser</Id>
            <Password>kakushi9121</Password>
        </HiddenPage>
        <EditingFlag>1</EditingFlag>
    </Result>
</ResultSet>

エラー

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

商品系API、およびストアカテゴリ参照APIで固有に返すエラーコードは以下をご覧ください。

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

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

エラーコード

コード HTTPステータスコード 説明
sc-02001 400 ページキーが指定されていません。
sc-02002 400 指定されたページキーは存在しません。
sc-02003 400 ページキーの指定が不正です。

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント