Ana içeriğe geç

getTemplateByType

Tüm şablon nesnelerini, türlerine göre gruplandırarak alma.

Açıklama​

Bu yöntem, API'den bir tanımlayıcı (id) temelinde tek bir şablon nesnesini alır. Bir Promise döner ve bu Promise, dizinlenmiş Şablon nesnelerinden oluşan bir diziye çözülür ITemplateEntity.

Şablonlar.getTemplateByType(

type*, langCode

);

Parametreler şeması​

Şema

type(required): Türler
Alınacak şablonların türü. Bu parametre, talep edilen şablonların kategorisini veya sınıflandırmasını belirtir.
örnek: "product"

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

Örnekler​

Minimal örnek​

const response = await Templates.getTemplateByType('forCatalogProducts');

Özelliklerle örnek​

const response = await Templates.getTemplateByType('forCatalogProducts', 'en_US');

Örnek yanıt​

[
  {
    "id": 4,
    "attributeSetIdentifier": null,
    "title": "Şablon",
    "generalTypeId": 4,
    "identifier": "template",
    "version": 0,
    "generalTypeName": "catalog_page",
    "attributeValues": {},
    "position": 1
  }
]

Yanıt şeması​

Şema: ITemplateEntity[]

id: number
Pozisyonun benzersiz tanımlayıcısı.
örnek: 12345

attributeSetIdentifier: string | null
Öznitelik seti id'si.
örnek: "attribute_set_1"

title: string
Şablonun adı.
örnek: "Ürün Şablonu"

generalTypeId: number
Genel tür Varlık id'si.
örnek: 67890

identifier: string
Kayıt alanı için metinsel tanımlayıcı.
örnek: "template_12345"

version: number
Nesnenin sürüm numarası.
örnek: 1

generalTypeName: Türler
Genel tür adı.
örnek: "product"

attributeValues: AttributeType
İndeksten alınan öznitelik değerleri (kullanıcı öznitelik id'si: öznitelik değeri çifti olarak temsil edilir).
örnek:

{
  "id": 1,
  "value": "some"
}

position: number
Nesnenin pozisyonu.
örnek: 1