ショッピング

ストアカテゴリ参照API

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

変更履歴(2019年08月26日)
レスポンスフィールドに以下の項目を追加します。
・/ResultSet/Result/PayPayMallFreeSpace(PayPayモール用フリースペース)
・/ResultSet/Result/PayPayMallSpFreeSpace(SP版PayPayモール用フリースペース)
リリース日:2019年08月19日(月)

リクエストURL

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

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



リクエストパラメータ

RESTリクエストの構築(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 
/ResultSet/Result/TitleImage タイトル画像 
/ResultSet/Result/TitleImage/Name タイトル画像ファイル名 
/ResultSet/Result/TitleImage/Url タイトル画像プレビュー用URL 
/ResultSet/Result/CategoryImage カテゴリイメージ画像
/ResultSet/Result/CategoryImage/Name カテゴリイメージ画像ファイル名
/ResultSet/Result/CategoryImage/Url カテゴリイメージ画像プレビュー用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モール用フリースペース
/ResultSet/Result/PayPayMallSpFreeSpace SP版PayPayモール用フリースペース



サンプルレスポンス

<?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>



エラー

ストアカテゴリ参照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 ストアアカウントの指定が不正です。


・エラーコード

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




利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。(無料)
申請受付は停止中です。
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。

利用約款

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