テンプレート (v1/templates) 関連のエンドポイントを公開しました

テンプレート (HTML テーマ) の一覧取得、ページ単位での取得・更新、プレビュー URL 取得ができるエンドポイントを公開しました。

提供開始日時

2026年4月9日(木)

公開したエンドポイント

• テンプレート一覧を取得するエンドポイント
• ページ単位でテンプレートを取得するエンドポイント
• ページ単位でテンプレートを更新するエンドポイント
• テンプレートのプレビュー URL を取得するエンドポイント

テンプレート一覧を取得するエンドポイント

ショップが保有するテンプレートの一覧を取得できるエンドポイントです。

• メソッド・パス: GET /v1/templates
• 必要スコープ: read_templates

ページ単位でテンプレートを取得するエンドポイント

テンプレート ID とページ種別を指定して、該当ページの HTML / CSS を取得できるエンドポイントです。

• メソッド・パス: GET /v1/templates/{template_id}/pages/{page_type}
• 必要スコープ: read_templates

パスパラメータ

キー名	説明	型
template_id	テンプレート ID	整数
page_type	ページ種別 (index, top, product_list, product, shopkeeper, product_srh, option_stock, privacy)	文字列

ページ単位でテンプレートを更新するエンドポイント

テンプレート ID とページ種別を指定して、該当ページの HTML / CSS を更新できるエンドポイントです。

• メソッド・パス: PUT /v1/templates/{template_id}/pages/{page_type}
• 必要スコープ: write_templates

リクエストボディ

キー名	説明	型
template_page.html	ページの HTML	文字列
template_page.css	ページの CSS	文字列

テンプレートのプレビュー URL を取得するエンドポイント

テンプレート ID を指定して、そのテンプレートをプレビュー表示するための URL を取得できるエンドポイントです。取得した URL の有効期限は発行から 1 時間です。

• メソッド・パス: GET /v1/templates/{template_id}/preview_url
• 必要スコープ: read_templates

レスポンス

キー名	説明	型
preview_url	プレビュー表示用の URL (有効期限 1 時間)	文字列

テンプレートページのレスポンス (取得・更新共通)

キー名	説明	型
template_id	テンプレート ID	整数
page_type	ページ種別	文字列
html	ページの HTML	文字列
css	ページの CSS	文字列
make_date	作成日時	文字列
update_date	更新日時	文字列

詳細は、カラーミーショップ API ドキュメントを確認ください。