ブロックの詳細

GET /blocks/{BLOCK_ID}

指定されたブロックの詳細情報を取得するには、/api/blocks/{BLOCK_ID}に対してGETを送信します。 {BLOCK_ID}は、ブロックのIDです。

PATH パラメータ

Name

Type

説明

BLOCK_ID

integer

ブロックのID

リクエスト：ヘッダー

Name

Value

Content-Type

application/json

Authorization

Basic <認証情報>

認証情報について

認証情報は、ユーザーのEメールアドレスとAPIキーをコロンで連結したものをBase64エンコードしたものです。

レスポンス

{
  "block_id": "33",
  "type": "lite_checkout_customer_sign_in",
  "properties": {
    "template": "blocks/lite_checkout/customer_sign_in.tpl"
  },
  "company_id": "1",
  "lang_code": "ja",
  "name": " ",
  "content": "",
  "availability": {
    "phone": true,
    "tablet": true,
    "desktop": true
  }
}

レスポンスの詳細

フィールド

値

説明

block_id

integer

type

string

ブロックのタイプ。ここで可能な値を以下のとおりです。 menu, my_account, our_brands, cart_content, breadcrumbs, template, main, html_block, smarty_block, checkout, products, categories, pages, payment_methods, shipping_methods, currencies, languages, product_filters ECモール版は、次のタイプをサポートしています：vendor_information, vendor_logo, vendor_categories, vendor_search 注意：アドオンによってこれらの他にbanners, blog, rss_feed, tagsといった独自のタイプを追加することができます。

properties

object

ブロックのさまざまなプロパティ。ブロックのタイプによってプロパティは異なります。

company_id

integer

関連するストアID（通常版）または出品者ID（マーケットプレイス版）

lang_code

string

言語コード例）en

name

string

ブロックの名称

content

object

前へブロックの一覧次へブロックの作成

最終更新 1 年前