getBlockByMarker

Obtendo um único objeto de bloco pelo marcador

Blocks.getBlockByMarker(marker, langCode, offset, limit)

const value = await Blocks.getBlockByMarker('my-marker')

Esquema

marker:* string
Marcador do Bloco
exemplo: my-marker

langCode: string
Códigos de idioma
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

Este método retorna um objeto de blocos pelo marcador.

Exemplo de retorno:

{
  "id": 1764,
  "localizeInfos": {
    "en_US": {
      "title": "Meu bloco"
    }
  },
  "customSettings": {
    "sliderDelay": 0,
    "sliderDelayType": "",
    "productConfig": {
      "quantity": 2,
      "sortType": "By_ID",
      "sortOrder": "DESC",
      "countElementsPerRow": 10
    },
    "similarProductRules": [
      {
        "property": "Descending",
        "includes": "",
        "keywords": "",
        "strict": ""
      }
    ],
    "condition": {
      "name": "title"
    }
  },
  "version": 10,
  "identifier": "catalog",
  "position": 192,
  "productPageUrls": [
    "23-laminat-floorwood-maxima"
  ],
  "isVisible": true,
  "attributeValues": {
    "en_US": {
      "marker": {
        "value": "",
        "type": "string",
        "position": 1,
        "isProductPreview": false,
        "isIcon": false,
        "attributeFields": {
          "marker": {
            "type": "string",
            "value": "teste"
          }
        }
      }
    }
  },
  "type": "forNewsPage",
  "templateIdentifier": null,
  "attributeSetIdentifier": "meus-conjuntos-de-atributos"
}

Esquema

id: number
identificador do objeto
exemplo: 1764

localizeInfos: CommonLocalizeInfos
nome do bloco considerando a localização
exemplo:

{
  "en_US": {
    "title": "Meu bloco"
  }
}

customSettings: BlockCustomSettings
configurações individuais para diferentes tipos de blocos
BlockCustomSettings exemplo:

{
  "sliderDelay": 0,
  "sliderDelayType": "",
  "productConfig": {
    "quantity": 2,
    "sortType": "By_ID",
    "sortOrder": "DESC",
    "countElementsPerRow": 10
  },
  "similarProductRules": [
    {
      "property": "Descending",
      "includes": "",
      "keywords": "",
      "strict": ""
    }
  ],
  "condition": {
    "name": "title"
  }
}

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

identifier: string
identificador textual para o campo de gravação
exemplo: catalog
padrão: marker

position: number
número da posição (para ordenação)
exemplo: 192

productPageUrls: any
array de partes únicas da URL da página (após a última "/") - categorias de onde os produtos podem ser retirados (opcional)
exemplo:

[ "23-laminat-floorwood-maxima" ]

isVisible: boolean
indicador de visibilidade (disponibilidade) do bloco
exemplo: true

attributeValues: Record<string, string>
Array de valores de atributos do índice (tipo, valor, array de campos adicionais para o atributo)
exemplo:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string",
      "position": 1,
      "isProductPreview": false,
      "isIcon": false,
      "attributeFields": {
        "marker": {
          "type": "string",
          "value": "teste"
        }
      }
    }
  }
}

type: string
tipo de bloco
exemplo: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service ]

attributeSetId: number
identificador para o conjunto de atributos utilizado
exemplo: 7

position: number
número da posição (para ordenação)
exemplo: 192

templateIdentifier: string
Marcador de template utilizado pelo bloco (pode ser nulo)
exemplo: null

.