getAllTemplates

Obtendo todos os objetos de template de um tipo específico

Templates.getAllTemplates(langCode)

const value = await Templates.getAllTemplates()

Esquema

langCode: string
Parâmetro opcional do código de idioma
exemplo: en_US

Este método recupera todos os objetos de template agrupados por tipos da API. Ele retorna uma Promise que se resolve em um objeto GroupedTemplatesObject, que contém um array de objetos de template.

Exemplo de retorno:

{
  "forTextBlock": [
    {
      "id": 1,
      "version": 0,
      "identifier": "for-block",
      "title": "Para blocos",
      "generalTypeName": "forTextBlock",
      "generalTypeId": 18,
      "position": 1,
      "attributeValues": {
        "en_US": {
          "marker": {
            "value": "",
            "type": "string",
            "position": 1,
            "isProductPreview": false,
            "isIcon": false,
            "attributeFields": {
              "marker": {
                "type": "string",
                "value": "teste"
              }
            }
          }
        }
      },
      "attributeIdentifier": "meu-conjunto"
    }
  ]
}

Esquema

id: number
identificador do objeto
exemplo: 1764

version number
número da versão do objeto de modificação
exemplo: 10

identifier: string
identificador textual para um campo no registro
exemplo: catalog

generalTypeId: number
identificador do tipo
exemplo: 4

title: string
nome do template
exemplo: template de página

position object
número da posição
exemplo: 0

generalTypeName string
exemplo: forProductPreview
nome do tipo geral