カスタムページ編集API

カスタムページを登録・編集します。
※ストアエディタでは、フリースペース１～３のうち初期状態で表示される項目はフリースペース１のみです。
このため、このAPIでフリースペース２と３に値を設定しても、ストアエディタではこれらを表示状態にしないと表示されません。

変更履歴

2021年08月10日

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

2018年03月05日

以下のエラーコードを追加します。

ds-04021, s-04022, ds-04023, ds-04024
内容：Iframeにて他法人のトリプル上のファイルを呼び出しております。
2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。

リクエストURL

XML

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

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

リクエストパラメータ

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

※2021年8月以降、HTML入力欄に商品画像・商品詳細画像のURLは入力不可となります。
追加画像をご利用ください。

パラメータ	値	説明
seller_id （必須）	string	ストアアカウントを指定します。
page_key	string	ページキー。半角英数字と半角ハイフン99文字以内。存在しないページキーの場合、新規作成（既存のページのnameを変更したい場合は必須です）
name （必須）	string	ページタイトル。全角75文字以内。HTML不可 ※ HTMLが入力された場合はエンティティに変換されます。
template_id	string	テンプレートid 省略の場合、以下のとおりです。カスタムページ登録の場合 : デフォルトテンプレートの"CS01"を設定します。カスタムページ更新の場合 : テンプレートの更新はしません。デフォルトのテンプレート名の場合、 CS01 : カスタムページ1、CS02 : カスタムページ2、CS03 : カスタムページ3となります。テンプレート名を変更している場合、カスタムページテンプレート設定の左側から CS01、CS02、CS03となります。 ※新ストアデザインを適用後、templateの指定は無効となります。
freetext1	string	フリースペース1。全角5000文字以内。HTML可（使用可能なタグは下記参照 ※1 ※2）
freetext2	string	フリースペース2。全角5000文字以内。HTML可（使用可能なタグは下記参照 ※1 ※2）
freetext3	string	フリースペース3。全角5000文字以内。HTML可（使用可能なタグは下記参照 ※1 ※2）
spfreetext1	string	スマホ用フリースペース。全角25000文字。HTML可（使用可能なタグは下記参照 ※1 ※2）

※注意事項

seller_id、page_key、template_id以外の値はパーセントエンコードしてください。パーセントエンコードは RFC3986 に基づきます。
非必須項目は、指定のない場合現在の値を変更しません。項目に空を指定した場合、値を空に更新します。
作成済みページのnameを変更したい場合はpage_keyが必須となります。

※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/editCustomPageDesign

サンプルリクエスト

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

seller_id=test-store&page_key=custom01&name=%83J%83X%83%5E%83%80%83y%81%5B%83W%83%5E%83C%83g%83%8B%82P&freetext1=%3Ch4%3E%83J%83X%83%5E%83%80%83y%81%5B%83W%83t%83%8A%81%5B%83X%83y%81%5B%83X%82P%3C%2Fh4%3E&freetext2=%3Ch4%3E%83J%83X%83%5E%83%80%83y%81%5B%83W%83t%83%8A%81%5B%83X%83y%81%5B%83X%82Q%3C%2Fh4%3E&freetext3=%3Ch4%3E%83J%83X%83%5E%83%80%83y%81%5B%83W%83t%83%8A%81%5B%83X%83y%81%5B%83X%82R%3C%2Fh4%3E&spfreetext1=%3Ch4%3E%83J%83X%83%5E%83%80%83y%81%5B%83W%83t%83%8A%81%5B%83X%83y%81%5B%83X%82R%3C%2Fh4%3E

レスポンスフィールド

フィールド	説明
/ResultSet/Result	クエリーレスポンスのすべてを含みます。
/ResultSet/Result/Status	成功時に「OK」と表示します。失敗時は別フォーマットでエラーレスポンスを表示します。（ひとつでも不正値があると、全項目更新されません）
/ResultSet/Result/PageKey	登録・更新に成功したページのページキー
/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>
      <PageKey>abc</PageKey>
  </Result>
</ResultSet>


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

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
  <Result>
      <Status>OK</Status>
      <PageKey>abc</PageKey>
      <Warning>
          <Target>freetext1</Target>
          <Code>ds-04004</Code>
          <Message>外部リンクを削除しました。</Message>
      </Warning>
      <Warning>
          <Target>freetext2</Target>
          <Code>ds-04011</Code>
          <Message>外部リンクを削除しました。</Message>
      </Warning>
  </Result>
</ResultSet>


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

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
  <Result>
      <Status>NG</Status>
      <PageKey>abc</PageKey>
      <Error>
          <Target>freetext1</Target>
          <Code>ds-04009</Code>
          <Message>freetext1は全角5000文字（半角10000文字）以内で入力してください。</Message>
      </Error>
      <Error>
          <Target>freetext2</Target>
          <Code>ds-04012</Code>
          <Message>freetext2は全角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-04001	200	nameは必須項目です。
ds-04002	200	指定されたページキーは予約されているため、使用できません。
ds-04003	200	指定されたタイトルは既に利用されています。
ds-04004	200	nameは全角75文字（半角150文字）以内で入力してください。
ds-04005	200	page_keyは半角99文字以内で入力してください。
ds-04006	200	page_keyのフォーマットが無効です（英数字およびハイフンのみ有効）
ds-04007	200	freetext1はタグ閉じされていません。
ds-04008	200	freetext1の外部リンクを削除しました。
ds-04009	200	freetext1は全角5000文字（半角10000文字）以内で入力してください。
ds-04010	200	freetext2はタグ閉じされていません。
ds-04011	200	freetext2の外部リンクを削除しました。
ds-04012	200	freetext2は全角5000文字（半角10000文字）以内で入力してください。
ds-04013	200	freetext3はタグ閉じされていません。
ds-04014	200	freetext3の外部リンクを削除しました。
ds-04015	200	freetext3は全角5000文字（半角10000文字）以内で入力してください。
ds-04016	200	spfreetext1はタグ閉じされていません。
ds-04017	200	spfreetext1の外部リンクを削除しました。
ds-04018	200	spfreetext1は全角25000文字（半角50000文字）以内で入力してください。
ds-04019	200	登録可能なカスタムページの最大数は999ページです。
ds-04020	200	指定されたtemplate_idは存在しません。CS01、CS02、CS03のいずれかを指定してください。
ds-04021	200	2018/03/05 追記 "freetext1"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-04022	200	2018/03/05 追記 "freetext2"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-04023	200	2018/03/05 追記 "freetext3"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。
ds-04024	200	2018/03/05 追記 "spfreetext1"のIframeにて他法人のトリプル上のファイルを呼び出しております。 2018年4月以降(予定)になりますと、更新時に該当タグのsrc属性を削除いたしますので、ご注意ください。

利用制限

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

カスタムページ編集API

リクエストURL

リクエストパラメータ

レスポンスフィールド

サンプルレスポンス

エラー

利用制限

利用約款

目次

利用のルール

開発のヒント

サービス一覧