ショッピング

ストア設定フリースペース参照API

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


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

ストア設定情報のフリースペースの値を取得します。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。

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

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


サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getStoreinfoFreespace?seller_id=6hills

サンプルリクエスト

GET /ShoppingWebService/V1/getStoreinfoFreespace?seller_id=6hills HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>



レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含みます。
/ResultSet/Result 結果 
/ResultSet/Result/Info 会社概要
/ResultSet/Result/Info/FreeSpace1 ストア情報補足用フリースペース(HTML可)
/ResultSet/Result/Info/FreeSpace2 お問い合わせ情報補足用フリースペース(HTML可)
/ResultSet/Result/PrivacyPolicy プライバシーポリシー
/ResultSet/Result/PrivacyPolicy/FreeSpace1 プライバシーポリシー補足用フリースペース(HTML可)
/ResultSet/Result/Guide お買い物ガイド
/ResultSet/Result/Guide/FreeSpace1 お支払い補足用フリースペース(HTML可)
/ResultSet/Result/Guide/FreeSpace2 お届け補足用フリースペース(HTML可)
/ResultSet/Result/Guide/FreeSpace3 販売条件補足用フリースペース(HTML可)
/ResultSet/Result/Guide/FreeSpace4 返品、交換、保証補足用フリースペース(HTML可)



サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Result>
        <Info>
            <FreeSpace1><![CDATA[<h4>会社概要ストア情報補足フリースペース1</h4>]]></FreeSpace1>
            <FreeSpace2><![CDATA[<h4>会社概要お問い合せ情報補足フリースペース2</h4>]]></FreeSpace2>
        </Info>
        <PrivacyPolicy>
            <FreeSpace1><![CDATA[<h4>プライバシーポリシー補足フリースペース1</h4>]]></FreeSpace1>
        </PrivacyPolicy>
        <Guide>
            <FreeSpace1><![CDATA[<h4>お支払い補足フリースペース1</h4>]]></FreeSpace1>
            <FreeSpace2><![CDATA[<h4>お届け補足フリースペース1</h4>]]></FreeSpace2>
            <FreeSpace3><![CDATA[<h4>販売条件補足フリースペース1</h4>]]></FreeSpace3>
            <FreeSpace4><![CDATA[<h4>返品、交換、保証補足フリースペース1</h4>]]></FreeSpace4>
        </Guide>
    </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 ストアアカウントの指定が不正です。




利用制限

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

利用約款

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