ショッピング

カスタムページ一覧API

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


こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/getCustomPageList
テスト用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/getCustomPageList?seller_id=6hills

サンプルリクエスト

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



レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。(必ずtotalResultsAvailableと同じ値になります)
  • firstResultPosition : 最初のデータが何個目に当たるかです。(必ず1になります)

/ResultSet/Result 結果
/ResultSet/Result/Page ページ
/ResultSet/Result/Page/PageKey ページID
/ResultSet/Result/Page/Name ページタイトル(HTML不可)

※表示順は、カスタムページを登録した古い順となります。




サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="59" totalResultsReturned="2" firstResultPosition="1">
    <Result>
        <Page>
            <PageKey>custom01</PageKey>
            <Name>カスタムページタイトル1</Name>
        </Page>
        <Page>
            <PageKey>custom02</PageKey>
            <Name>カスタムページタイトル2</Name>
        </Page>
        <Page>
            <PageKey>notags</PageKey>
            <Name>&amp;lt;エンティティ変換されます&amp;gt;aaa&amp;lt;</Name>
        </Page>
    </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に関する利用約款はこちら