ストア設定フリースペース編集API

ストア設定情報のフリースペースの値を編集します。（フロント反映はしません）

変更履歴

2022年04月08日

リクエストパラメータの下記注意文言を修正しました。
修正前）
　「※2021年8月以降、HTML入力欄に商品画像・商品詳細画像のURLは入力不可となります。追加画像をご利用ください。
修正後）
　本件、仕様変更対応は不要となりました。

リクエストURL

本番環境

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

テスト環境

https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/setStoreinfoFreespace

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

リクエストパラメータ

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

※2021年8月以降、今後、HTML入力欄に商品画像・商品詳細画像のURLは入力不可となります。追加画像をご利用ください。
実施時期については現在調整中のため、改めてご案内いたします。
本件、仕様変更対応は不要となりました。

パラメータ	値	説明
seller_id （必須）	string	ストアアカウントを指定します。
info_free_space1	string	ストア情報補足用フリースペース（HTML可）全角5000文字（10000バイト）以内（使用可能なタグは下記参照 ※1 ※2）
info_free_space2	string	お問い合わせ情報補足用フリースペース（HTML可）全角5000文字（10000バイト）以内（使用可能なタグは下記参照 ※1 ※2）
privacypolicy_free_space1	string	プライバシーポリシー補足用フリースペース（HTML可）全角5000文字（10000バイト）以内（使用可能なタグは下記参照 ※1 ※2）
guide_free_space1	string	お支払い補足用フリースペース（HTML可）全角10000文字（20000バイト）以内（使用可能なタグは下記参照 ※1 ※2）
guide_free_space2	string	お届け補足用フリースペース（HTML可）全角10000文字（20000バイト）以内（使用可能なタグは下記参照 ※1 ※2）
guide_free_space3	string	販売条件補足用フリースペース（HTML可）全角10000文字（20000バイト）以内（使用可能なタグは下記参照 ※1 ※2）
guide_free_space4	string	返品、交換、保証補足用フリースペース（HTML可）全角10000文字（20000バイト）以内（使用可能なタグは下記参照 ※1 ※2）

※注意事項

seller_id以外の値はパーセントエンコードしてください。パーセントエンコードは RFC3986 に基づきます。
HTML中に含まれる外部リンクについては、許可URLリストに入っているURL以外は、バウンサページを挟むリンクに置換されます。
非必須項目は、指定のない場合現在の値を変更しません。項目に空を指定した場合、値を空に更新します。

※1. PC用使用可能HTMLタグ一覧

<A>	<ABBR>	<ACRONYM>	<ADDRESS>	<AREA>
<B>	<BDO>	<BIG>	<BLOCKQUOTE>	<BR>
<CAPTION>	<CENTER>	<CITE>	<CODE>	<COL>
<COLGROUP>	<DD>	<DEL>	<DFN>	<DIR>
<DIV>	<DL>	<DT>	<EM>	<FONT>
<HR>	<h4>	<h5>	<h6>	<I>
<IFRAME>	<IMG>	<INS>	<KBD>	<LI>
<LINK>	<MAP>	<MENU>	<OL>	<P>
<Q>	<S>	<SAMP>	<SMALL>	<SPAN>
<STRIKE>	<STRONG>	<SUB>	<SUP>	<TABLE>
<TBODY>	<TD>	<TFOOT>	<TH>	<THEAD>
<TR>	<TT>	<U>	<UL>	<VAR>

※2. スマホ用使用可能HTMLタグ一覧

<A>	<ABBR>	<ADDRESS>	<AREA>	<ARTICLE>
<ASIDE>	<B>	<BDO>	<BLOCKQUOTE>	<BR>
<CAPTION>	<CITE>	<CODE>	<COL>	<COLGROUP>
<DD>	<DEL>	<DETAILS>	<DFN>	<DIV>
<DL>	<DT>	<EM>	<FIGCAPTION>	<FIGURE>
<FOOTER>	<HEADER>	<HGROUP>	<HR>	<Hx>（H1～）
<I>	<IMG>	<INS>	<KBD>	<LI>
<MARK>	<MAP>	<MENU>	<METER>	<NAV>
<OL>	<P>	<PROGRESS>	<Q>	<S>
<SAMP>	<SECTION>	<SMALL>	<SPAN>	<STRONG>
<SUB>	<SUMMARY>	<SUP>	<TABLE>	<TBODY>
<TD>	<TFOOT>	<TH>	<THEAD>	<TIME>
<TR>	<UL>	<VAR>

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

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

サンプルリクエストURL

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

サンプルリクエスト

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

seller_id=test-store&info_free_space1=%3ch4%3e%b2%f1%bc%d2%b3%b5%cd%d7%a5%b9%a5%c8%a5%a2%be%f0%ca%f3%ca%e4%c2%ad%a5%d5%a5%ea%a1%bc%a5%b9%a5%da%a1%bc%a5%b91%3c%2fh4%3e&info_free_space2=%3ch4%3e%b2%f1%bc%d2%b3%b5%cd%d7%a4%aa%cc%e4%a4%a4%b9%e7%a4%bb%be%f0%ca%f3%ca%e4%c2%ad%a5%d5%a5%ea%a1%bc%a5%b9%a5%da%a1%bc%a5%b92%3c%2fh4%3e&privacypolicy_free_space1=%3ch4%3e%a5%d7%a5%e9%a5%a4%a5%d0%a5%b7%a1%bc%a5%dd%a5%ea%a5%b7%a1%bc%ca%e4%c2%ad%a5%d5%a5%ea%a1%bc%a5%b9%a5%da%a1%bc%a5%b91%3c%2fh4%3e&guide_free_space1=%3ch4%3e%a4%aa%bb%d9%ca%a7%a4%a4%ca%e4%c2%ad%a5%d5%a5%ea%a1%bc%a5%b9%a5%da%a1%bc%a5%b91%3c%2fh4%3e&guide_free_space2=%3ch4%3e%a4%aa%c6%cf%a4%b1%ca%e4%c2%ad%a5%d5%a5%ea%a1%bc%a5%b9%a5%da%a1%bc%a5%b91%3c%2fh4%3e&guide_free_space3=%3ch4%3e%c8%ce%c7%e4%be%f2%b7%ef%ca%e4%c2%ad%a5%d5%a5%ea%a1%bc%a5%b9%a5%da%a1%bc%a5%b91%3c%2fh4%3e&guide_free_space4=%3ch4%3e%ca%d6%c9%ca%a1%a2%b8%f2%b4%b9%a1%a2%ca%dd%be%da%ca%e4%c2%ad%a5%d5%a5%ea%a1%bc%a5%b9%a5%da%a1%bc%a5%b91%3c%2fh4%3e

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含みます。
/ResultSet/Result/Status	成功時に「OK」と表示します。失敗時は別フォーマットでエラーレスポンスを表示します。（ひとつでも不正値があると、全項目更新されません）
/ResultSet/Result/Warning	警告情報
/ResultSet/Result/Warning/Target	どの項目で警告が生じたかです。
/ResultSet/Result/Warning/Code	エラーコード
/ResultSet/Result/Warning/Message	警告メッセージ

サンプルレスポンス

<!--・サンプルレスポンス（警告なし）-->

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


<!--・サンプルレスポンス（警告あり ※この場合でも保存処理は実行されます）-->

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Result>
        <Status>OK</Status>
        <Warning>
            <Target>info_free_space1</Target>
            <Code>ds-09004</Code>
            <Message>外部リンクを削除しました。</Message>
        </Warning>
        <Warning>
            <Target>info_free_space2</Target>
            <Code>ds-09007</Code>
            <Message>外部リンクを削除しました。</Message>
        </Warning>
    </Result>
</ResultSet>


<!--・サンプルレスポンス（エラーあり ※この場合、保存処理は実行されません）-->

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Result>
        <Status>NG</Status>
        <Error>
            <Target>info_free_space1</Target>
            <Code>ds-09005</Code>
            <Message>info_free_space1は5000文字（10000バイト）以内で入力してください。</Message>
        </Error>
        <Error>
            <Target>info_free_space2</Target>
            <Code>ds-09008</Code>
            <Message>info_free_space2は5000文字（10000バイト）以内で入力してください。</Message>
        </Error>
    </Result>
</ResultSet>

エラー

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

Yahoo! ショッピングAPI共通エラーコード一覧

商品系API、およびストア設定フリースペース編集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ステータスコード	説明
ds-09001	400	ページが存在しません。
ds-09002	500	システムエラーです。
ds-09003	200	info_free_space1はタグ閉じされていません。
ds-09004	200	info_free_space1の外部リンクを削除しました。
ds-09005	200	info_free_space1は5000文字（10000バイト）以内で入力してください。
ds-09006	200	info_free_space2はタグ閉じされていません。
ds-09007	200	info_free_space2の外部リンクを削除しました。
ds-09008	200	info_free_space2は5000文字（10000バイト）以内で入力してください。
ds-09009	200	privacypolicy_free_space1はタグ閉じされていません。
ds-09010	200	privacypolicy_free_space1の外部リンクを削除しました。
ds-09011	200	privacypolicy_free_space1は5000文字（10000バイト）以内で入力してください。
ds-09012	200	guide_free_space1はタグ閉じされていません。
ds-09013	200	guide_free_space1の外部リンクを削除しました。
ds-09014	200	guide_free_space1は10000文字（20000バイト）以内で入力してください。
ds-09015	200	guide_free_space2はタグ閉じされていません。
ds-09016	200	guide_free_space2の外部リンクを削除しました。
ds-09017	200	guide_free_space2は10000文字（20000バイト）以内で入力してください。
ds-09018	200	guide_free_space3はタグ閉じされていません。
ds-09019	200	guide_free_space3の外部リンクを削除しました。
ds-09020	200	guide_free_space3は10000文字（20000バイト）以内で入力してください。
ds-09021	200	guide_free_space4はタグ閉じされていません。
ds-09022	200	guide_free_space4の外部リンクを削除しました。
ds-09023	200	guide_free_space4は10000文字（20000バイト）以内で入力してください。
ds-09024	200	2018/03/05 追記 "info_free_space1"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-09025	200	2018/03/05 追記 "info_free_space2"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-09026	200	2018/03/05 追記 "privacypolicy_free_space1"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-09027	200	2018/03/05 追記 "guide_free_space1"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-09028	200	2018/03/05 追記 "guide_free_space2"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-09029	200	2018/03/05 追記 "guide_free_space3"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-09030	200	2018/03/05 追記 "guide_free_space4"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。

利用制限

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

ストア設定フリースペース編集API

リクエストURL

リクエストパラメータ

レスポンスフィールド

サンプルレスポンス

エラー

利用制限

利用約款

目次

利用のルール

開発のヒント

サービス一覧