getBlocks

Getting all block objects.

Blocks?.getBlocks( type?, langCode?, offset?, limit? );

Minimal example

const value = await Blocks.getBlocks('forTextBlock')

Schema

type(required): BlockType
Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none"
example: 'product'

langCode: string
Language code. Default: "en_US"
example: "en_US"

offset: number
Parameter for pagination. Default: 0
example: 0

limit: number
Parameter for pagination. Default: 30
example: 30

This method return array of all blocks object and total.

Example response

{
  "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": 8,
      "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
}

Schema

total: number
Total number of found records.
example: 100

items: IBlockEntity[]
Array of block entities.
example:

[
  {
    "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"
      }
    ]
  }
]

---