getBlockByMarker

Mengambil objek blok tunggal berdasarkan marker.

Deskripsi

Metode ini mengembalikan satu objek blok berdasarkan marker. Ini mengembalikan Promise yang menyelesaikan menjadi objek IBlockEntity.

Blocks.getBlockByMarker(

marker*, langCode, offset, limit

);

Skema parameter

Skema

marker(diperlukan): string
Marker dari Blok
contoh: "product_block"

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

offset: number
Parameter untuk pagination. Default: 0
contoh: 0

limit: number
Parameter untuk pagination. Default: 30
contoh: 30

Secara default, Anda dapat mengambil 10 objek. Ini disebabkan oleh batasan catatan dalam pengaturan izin modul.
Agar pagination berfungsi dengan benar, Anda perlu mengonfigurasi Izin modul sesuai kebutuhan Anda di bagian yang sesuai.

Contoh

Contoh minimal

const response = await Blocks.getBlockByMarker('my-marker');

Contoh dengan atribut

const response = await Blocks.getBlockByMarker('my-marker', 'en_US', 0, 30);

Contoh respons

{
  "id": 3,
  "localizeInfos": {
    "title": "Block"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

Skema respons

Skema: IBlockEntity

attributeValues: IAttributeValues
Peta nilai atribut yang dikunci oleh marker; objek kosong jika tidak ada.
contoh:

{
  "block-text": {
    "type": "string",
    "value": "some text",
    "isIcon": false,
    "position": 0,
    "additionalFields": [],
    "isProductPreview": false
  }
}

id: number
Pengidentifikasi unik dari blok.
contoh: 1234

localizeInfos: ILocalizeInfo
Informasi lokalisasi untuk blok.
contoh:

{
  "key": "value"
}

version: number
Versi dari entitas blok.
contoh: 1

identifier: string
Pengidentifikasi string unik untuk blok.
contoh: "block1"

type: BlockType
Jenis blok.
contoh: "product"

position: number
Posisi blok untuk pengurutan.
contoh: 1

templateIdentifier: string | null
Pengidentifikasi untuk template yang digunakan oleh blok, atau null jika tidak berlaku.
contoh: "template1"

isVisible: boolean
Menunjukkan apakah blok terlihat.
contoh: true

countElementsPerRow: number
Jumlah elemen yang ditampilkan per baris dalam blok, jika berlaku.
contoh: 3

quantity: number
Jumlah item dalam blok, jika berlaku.
contoh: 5

similarProducts: IProductsResponse
Respons yang berisi produk serupa yang terkait dengan blok.
contoh:

{
  "total": 10,
  "items": []
}

similarProducts.total: number
Jumlah total produk yang ditemukan.
contoh: 100

similarProducts.items: IProductsEntity[]
Array dari entitas produk.
contoh:

[
  {
    "id": 12345,
    "title": "Product 1"
  },
  {
    "id": 67890,
    "title": "Product 2"
  }
]

products: IProductsEntity[]
Array dari entitas produk yang terkait dengan blok.
contoh:

[
  {
    "id": 1,
    "name": "Product 1"
  },
  {
    "id": 2,
    "name": "Product 2"
  }
]

products.id: number
Pengidentifikasi unik.
contoh: 12345

products.localizeInfos: ILocalizeInfo
Nama produk, dengan mempertimbangkan lokalisasi.
contoh:

{}

products.statusIdentifier: string | null
Pengidentifikasi status halaman produk (bisa null).
contoh: "in_stock"

products.statusLocalizeInfos: ILocalizeInfo
Nama status yang dilokalisasi untuk produk.
contoh:

{ "title": "Sale" }

products.attributeSetIdentifier: string | null
ID set atribut.
contoh: "set_12345"

products.position: number
Nomor item (untuk pengurutan).
contoh: 1

products.price: number | null
Nilai harga halaman produk yang diambil dari indeks.
contoh: 150.00

products.additional: object
Nilai tambahan dari indeks.
contoh:

{
  "prices": {
    "min": 5,
    "max": 150
  }
}

products.sku: string | null
SKU produk (Stock Keeping Unit), bisa null.
contoh: "SKU_12345"

products.isSync: boolean
Indikasi pengindeksan halaman.
contoh: true

products.attributeValues: IAttributeValues
Array nilai atribut dari indeks, yang direpresentasikan.
contoh:

[
  {
    "id": "color",
    "value": "red"
  }
]

products.categories: string[]
Kategori produk.
contoh:

[
  1,
  2,
  3
]

products.isVisible: boolean
Tanda visibilitas halaman.
contoh: true

products.moduleFormConfigs: Array<IFormConfig>
Konfigurasi formulir modul (opsional).

products.rating: IRating
Data penilaian.

products.isPositionLocked: boolean
Indikator kunci posisi pengurutan (opsional).
contoh: false

products.relatedIds: number[]
ID halaman produk terkait.
contoh:

[
  12345,
  67890
]

products.paymentStages: unknown
Data tahap pembayaran (bisa null).
contoh: null

products.distance: number
Jarak relevansi pencarian vektor (semantik). Hanya ada dalam hasil pencarian vektor.
contoh: 0.42

products.discountConfig: Record<string, unknown>
Objek konfigurasi diskon.
contoh:

{}

products.templateIdentifier: string | null
ID pengguna dari template yang terhubung.
contoh: "template_12345"

products.shortDescTemplateIdentifier: string | null
ID pengguna dari template yang terhubung untuk deskripsi singkat.
contoh: "short_desc_template_12345"

products.signedPrice: string
Harga yang ditandatangani dari produk diperoleh bersama dengan data produk ketika signPrice diatur.
contoh: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

products.productPages: IProductPageRef[]
Array referensi halaman produk yang menghubungkan produk ke halamannya.
contoh:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

products.blocks: string[]
Array pengidentifikasi blok.
contoh:

[
  "block_12345",
  "block_67890"
]

🔒 signedPrice adalah token yang ditandatangani yang membawa harga terkunci — kirimkan kembali saat Anda membuat pesanan. Lihat Harga produk tetap (signedPrice).

---