カスタムページ参照API

カスタムページの詳細を取得します。

リクエストURL

XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getCustomPageDesign

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

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
page_key
(必須)
string ページキー。半角英数字と半角ハイフン99文字以内。

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

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

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getCustomPageDesign?seller_id=test-store&page_key=custom01

サンプルリクエスト

GET /ShoppingWebService/V1/getCustomPageDesign?seller_id=test-store&page_key=custom01
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/FreeText1 フリースペース1(HTMLを含みます)
/ResultSet/Result/FreeText2 フリースペース2(HTMLを含みます)
/ResultSet/Result/FreeText3 フリースペース3(HTMLを含みます)
/ResultSet/Result/SpFreeText1 スマホ用フリースペース(HTMLを含みます)

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Result>
        <PageKey>custom01</PageKey>
        <Name>カスタムページタイトル1</Name>
        <TemplateID>CS01</TemplateID>
        <FreeText1><![CDATA[<h4>カスタムページフリースペース1</h4>]]></FreeText1>
        <FreeText2><![CDATA[<h4>カスタムページフリースペース2</h4>]]></FreeText2>
        <FreeText3><![CDATA[<h4>カスタムページフリースペース3</h4>]]></FreeText3>
        <SpFreeText1><![CDATA[<h4>スマホ用カスタムページフリースペース1</h4>]]></SpFreeText1>
    </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ステータスコード 説明
ds-05001 400 ページキーが未指定です。
ds-05002 400 指定されたページキーは存在しません。

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント