getBlockByMarker

Bir blok nesnesini işaretçi ile almak.

Açıklama

Bu yöntem, bir işaretçi ile bir blok nesnesi döndürür. Bir IBlockEntity nesnesine çözülmekte olan bir Promise döndürür.

Blocks.getBlockByMarker(

marker*, langCode, offset, limit

);

Parametreler şeması

Şema

marker(zorunlu): string
Blokun işaretçisi
örnek: "product_block"

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Sayfalama için parametre. Varsayılan: 0
örnek: 0

limit: number
Sayfalama için parametre. Varsayılan: 30
örnek: 30

Varsayılan olarak, 10 nesne alabilirsiniz. Bu, modülün izin ayarlarındaki kayıt limitinden kaynaklanmaktadır.
Sayfalamanın doğru çalışması için, ilgili bölümde ihtiyaçlarınıza göre Modül izinleri yapılandırmanız gerekmektedir.

Örnekler

Minimal örnek

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

Özelliklerle örnek

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

Örnek yanıt

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

Yanıt şeması

Şema: IBlockEntity

attributeValues: IAttributeValues
İşaretçi ile anahtarlanan özellik değerlerinin haritası; yoksa boş nesne.
örnek:

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

id: number
Blokun benzersiz tanımlayıcısı.
örnek: 1234

localizeInfos: ILocalizeInfo
Blok için yerelleştirme bilgileri.
örnek:

{
  "key": "value"
}

version: number
Blok varlığının versiyonu.
örnek: 1

identifier: string
Blok için benzersiz dize tanımlayıcısı.
örnek: "block1"

type: BlockType
Blokun türü.
örnek: "product"

position: number
Sıralama için blokun pozisyonu.
örnek: 1

templateIdentifier: string | null
Blok tarafından kullanılan şablonun tanımlayıcısı veya geçerli değilse null.
örnek: "template1"

isVisible: boolean
Blokun görünür olup olmadığını gösterir.
örnek: true

countElementsPerRow: number
Blokta her satırda görüntülenen eleman sayısı, geçerliyse.
örnek: 3

quantity: number
Blokta bulunan öğelerin miktarı, geçerliyse.
örnek: 5

similarProducts: IProductsResponse
Blok ile ilişkili benzer ürünleri içeren yanıt.
örnek:

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

similarProducts.total: number
Bulunan toplam ürün sayısı.
örnek: 100

similarProducts.items: IProductsEntity[]
Ürün varlıklarının bir dizisi.
örnek:

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

items.id: number
Benzersiz tanımlayıcı.
örnek: 12345

items.localizeInfos: ILocalizeInfo
Ürünlerin isimleri, yerelleştirme dikkate alınarak.
örnek:

items.statusIdentifier: string | null
Ürün sayfası durum tanımlayıcıları (null olabilir).
örnek: "in_stock"

items.statusLocalizeInfos: ILocalizeInfo
Ürün için yerelleştirilmiş durum adı.
örnek: { "title": "İndirim" }

items.attributeSetIdentifier: string | null
Özellik seti kimliği.
örnek: "set_12345"

items.position: number
Öğe numarası (sıralama için).
örnek: 1

items.price: number | null
İndeksten alınan ürün sayfası fiyatının değeri.
örnek: 150.00

items.additional: object
İndeksten alınan ek değer.
örnek: { prices: { min: 5 max: 150 } }

items.sku: string | null
Ürün SKU'su (Stok Tutma Birimi), null olabilir.
örnek: "SKU_12345"

items.isSync: boolean
Sayfa indeksleme durumu.
örnek: true

items.attributeValues: AttributeType
İndeksten temsil edilen özellik değerlerinin dizisi.
örnek:

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

items.categories: string[]
Ürün kategorileri.
örnek:

[
  1,
  2,
  3
]

items.isVisible: boolean
Sayfanın görünürlük durumu.
örnek: true

items.moduleFormConfigs: Array<IFormConfig>
Modül form yapılandırmaları (isteğe bağlı).

items.rating: IRating
Değerlendirme verileri.

items.isPositionLocked: boolean
Sıralama pozisyonu kilit durumu göstergesi (isteğe bağlı).
örnek: false

items.relatedIds: number[]
İlişkili ürün sayfalarının kimlikleri.
örnek:

[
  12345,
  67890
]

items.paymentStages: unknown
Ödeme aşamaları verileri (null olabilir).
örnek: null

items.discountConfig: Record<string, unknown>
İndirim yapılandırma nesnesi.
örnek:

items.templateIdentifier: string | null
Bağlı şablonun kullanıcı kimliği.
örnek: "template_12345"

items.shortDescTemplateIdentifier: string | null
Kısa açıklama için bağlı şablonun kullanıcı kimliği.
örnek: "short_desc_template_12345"

items.signedPrice: string
Fiyat işareti.

items.productPages: IProductPageRef[]
Ürünü sayfalarına bağlayan ürün sayfası referanslarının dizisi.
örnek:

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

productPages.id: number
Ürün-sayfa bağlantı kaydının benzersiz tanımlayıcısı.
örnek: 16

productPages.pageId: number
Ürünün bağlı olduğu sayfanın tanımlayıcısı.
örnek: 4

productPages.productId: number
Ürünün tanımlayıcısı.
örnek: 15

productPages.positionId: number
Sayfa içindeki sıralama pozisyonu tanımlayıcısı.
örnek: 244

productPages.categoryPath: string
Ürünün ait olduğu sayfanın kategori yolu.
örnek: "products"

items.blocks: string[]
Blok tanımlayıcılarının dizisi.
örnek:

[
  "block_12345",
  "block_67890"
]

products: IProductsEntity[]
Blok ile ilişkili ürün varlıklarının dizisi.
örnek:

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

---