Pular para o conteúdo principal

getBlocks

Obtendo todos os objetos de bloco.

Descrição​

Este método retorna um array de todos os objetos de bloco e o total. Ele retorna uma Promise que resolve para um objeto IBlocksResponse.

Blocks.getBlocks(

type*, langCode, offset, limit

);

Esquema de parâmetros​

Esquema

type(obrigatório): BlockType
Valores disponíveis: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none"
exemplo: 'product'

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro para paginação. Padrão: 30
exemplo: 30

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar Permissões do módulo de acordo com suas necessidades na seção correspondente.

Exemplos​

Exemplo mínimo​

const response = await Blocks.getBlocks('forTextBlock');

Exemplo com atributos​

const response = await Blocks.getBlocks('forTextBlock', 'en_US', 0, 30);

Exemplo de resposta​

{
  "items": [
    {
      "id": 3,
      "localizeInfos": {
        "title": "Bloco"
      },
      "version": 0,
      "position": 1,
      "identifier": "block",
      "type": "common_block",
      "templateIdentifier": null,
      "isVisible": true,
      "attributeValues": {}
    },
    {
      "id": 4,
      "localizeInfos": {
        "title": "teste"
      },
      "version": 31,
      "position": 2,
      "identifier": "test",
      "type": "common_block",
      "templateIdentifier": null,
      "isVisible": true,
      "attributeValues": {
        "block-text": {
          "type": "string",
          "value": "algum texto",
          "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
}

Esquema de resposta​

Esquema: IBlocksResponse

total: number
Total de registros encontrados.
exemplo: 100

items: IBlockEntity[]
Array de entidades de bloco.
exemplo:

[
  {
    "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": "Produto 1"
      },
      {
        "id": 2,
        "name": "Produto 2"
      }
    ]
  }
]

items.attributeValues: AttributeType
Tipo de atributos usados no bloco.
exemplo:

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

items.id: number
Identificador único do bloco.
exemplo: 1234

items.localizeInfos: ILocalizeInfo
Informações de localização para o bloco.
exemplo:

{
  "key": "value"
}

items.version: number
Versão da entidade de bloco.
exemplo: 1

items.identifier: string
Identificador único em string para o bloco.
exemplo: "block1"

items.type: string
Tipo do bloco, como 'product', 'error_page', etc.
exemplo: "product"

items.templateIdentifier: string | null
Identificador para o template usado pelo bloco, ou null se não aplicável.
exemplo: "template1"

items.isVisible: boolean
Indica se o bloco é visível.
exemplo: true

items.countElementsPerRow: number
Número de elementos exibidos por linha no bloco, se aplicável.
exemplo: 3

items.quantity: number
Quantidade de itens no bloco, se aplicável.
exemplo: 5

items.similarProducts: IProductsResponse
Resposta contendo produtos similares associados ao bloco.
exemplo:

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

items.products: IProductsEntity[]
Array de entidades de produtos associados ao bloco.
exemplo:

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