getBlocks
Tüm blok nesnelerini alma.
Açıklama
Bu yöntem, tüm blok nesnelerinin ve toplamının bir dizisini döndürür. Bir IBlocksResponse nesnesine çözülmekte olan bir Promise döndürür.
Blocks.getBlocks(
type*,
langCode,
offset,
limit
);
Parametreler şeması
Şema
type(zorunlu): BlockType
Mevcut değerler: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none"
örnek: 'product'
langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"
offset: number
Sayfalandırma için parametre. Varsayılan: 0
örnek: 0
limit: number
Sayfalandırma 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.
Sayfalandırmanı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.getBlocks('forTextBlock');
Özelliklerle örnek
const response = await Blocks.getBlocks('forTextBlock', 'en_US', 0, 30);
Örnek yanıt
{
"items": [
{
"id": 3,
"localizeInfos": {
"title": "Block"
},
"version": 0,
"position": 1,
"identifier": "block",
"type": "common_block",
"templateIdentifier": null,
"isVisible": true,
"attributeValues": {}
},
{
"id": 4,
"localizeInfos": {
"title": "test"
},
"version": 31,
"position": 2,
"identifier": "test",
"type": "common_block",
"templateIdentifier": null,
"isVisible": true,
"attributeValues": {
"block-text": {
"type": "string",
"value": "some text",
"isIcon": false,
"position": 0,
"additionalFields": {},
"isProductPreview": false
},
"interval": {
"type": "timeInterval",
"value": [
{
"values": [
{
"id": "bbc82c9f-1bc4-4c86-b83c-c062016eb7cb",
"dates": [
"2025-04-14T00:00:00.000Z",
"2025-04-14T00:00:00.000Z"
],
"times": [
[
{
"hours": 9,
"minutes": 0
},
{
"hours": 10,
"minutes": 0
}
],
[
{
"hours": 10,
"minutes": 0
},
{
"hours": 11,
"minutes": 0
}
],
[
{
"hours": 11,
"minutes": 0
},
{
"hours": 12,
"minutes": 0
}
],
"..."
],
"intervals": [],
"exceptions": [],
"intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12",
"inEveryWeek": true,
"inEveryMonth": true,
"timeIntervals": [
[
"2025-04-07T09:00:00.000Z",
"2025-04-07T10:00:00.000Z"
],
[
"2025-04-07T10:00:00.000Z",
"2025-04-07T11:00:00.000Z"
],
[
"2025-04-07T11:00:00.000Z",
"2025-04-07T12:00:00.000Z"
],
"..."
]
}
],
"intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12"
}
],
"isIcon": false,
"position": 1,
"additionalFields": {},
"isProductPreview": false
}
}
}
],
"total": 2
}
Yanıt şeması
Şema: IBlocksResponse
total: number
Bulunan kayıtların toplam sayısı.
örnek: 100
items: IBlockEntity[]
Blok varlıklarının dizisi.
örnek:
[
{
"attributeValues": [],
"id": 1,
"identifier": "block1",
"isVisible": true,
"localizeInfos": {
"key": "value"
},
"position": 1,
"templateIdentifier": null,
"type": "product",
"version": 1,
"countElementsPerRow": 3,
"quantity": 9,
"similarProducts": {
"total": 0,
"items": []
},
"products": [
{
"id": 1,
"name": "Product 1"
},
{
"id": 2,
"name": "Product 2"
}
]
}
]
items.attributeValues: IAttributeValues
Anahtarları işaretleyici olan özellik değerleri haritası; yoksa boş nesne.
örnek:
{
"block-text": {
"type": "string",
"value": "some text",
"isIcon": false,
"position": 0,
"additionalFields": [],
"isProductPreview": false
}
}
items.id: number
Blokun benzersiz tanımlayıcısı.
örnek: 1234
items.localizeInfos: ILocalizeInfo
Blok için yerelleştirme bilgileri.
örnek:
{
"key": "value"
}
items.version: number
Blok varlığının versiyonu.
örnek: 1
items.identifier: string
Blok için benzersiz dize tanımlayıcısı.
örnek: "block1"
items.type: BlockType
Blokun türü.
örnek: "product"
items.position: number
Sıralama için blokun pozisyonu.
örnek: 1
items.templateIdentifier: string | null
Blok tarafından kullanılan şablonun tanımlayıcısı veya geçerli değilse null.
örnek: "template1"
items.isVisible: boolean
Blokun görünür olup olmadığını gösterir.
örnek: true
items.countElementsPerRow: number
Blokta her satırda görüntülenen eleman sayısı, geçerliyse.
örnek: 3
items.quantity: number
Blokta bulunan öğelerin miktarı, geçerliyse.
örnek: 5
items.similarProducts: IProductsResponse
Blok ile ilişkili benzer ürünleri içeren yanıt.
örnek:
{
"total": 10,
"items": []
}
similarProducts.total: number
Bulunan ürünlerin toplam sayısı.
örnek: 100
similarProducts.items: IProductsEntity[]
Ürün varlıklarının 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
Özellikler setinin 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 alınan özellik değerlerinin dizisi, temsil edilmiştir.
örnek:
[
{
"id": "color",
"value": "red"
}
]
items.categories: string[]
Ürün kategorileri.
örnek:
[
1,
2,
3
]
items.isVisible: boolean
Sayfa görünürlüğü işareti.
ö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 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"
]
items.products: IProductsEntity[]
Blok ile ilişkili ürün varlıklarının dizisi.
örnek:
[
{
"id": 1,
"name": "Product 1"
},
{
"id": 2,
"name": "Product 2"
}
]