getBlockByMarker
Obtendo um único objeto de bloco pelo marcador.
Blocos?.getBlockByMarker( marker?, langCode?, offset?, limit? );
Exemplo mínimo
const value = await Blocks.getBlockByMarker('my-marker')
Esquema
marker(required): string
Marcador do Bloco
exemplo: "product_block"
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
Este método retorna um objeto de blocos pelo marcador.
Exemplo de resposta
{
"id": 3,
"localizeInfos": {
"title": "Bloco"
},
"version": 0,
"position": 1,
"identifier": "block",
"type": "common_block",
"templateIdentifier": null,
"isVisible": true,
"attributeValues": {}
}
Esquema
attributeValues: AttributeType
Tipo de atributos usados no bloco.
exemplo:
{
"block-text": {
"type": "string",
"value": "algum texto",
"isIcon": false,
"position": 0,
"additionalFields": [],
"isProductPreview": false
}
}
id: number
Identificador único do bloco.
exemplo: 1234
localizeInfos: ILocalizeInfo
Informações de localização para o bloco.
exemplo:
{
"key": "value"
}
version: number
Versão da entidade do bloco.
exemplo: 1
identifier: string
Identificador único em string para o bloco.
exemplo: "block1"
type: string
Tipo do bloco, como 'produto', 'pagina_de_erro', etc.
exemplo: "produto"
templateIdentifier: string | null
Identificador para o template usado pelo bloco, ou null se não aplicável.
exemplo: "template1"
isVisible: boolean
Indica se o bloco é visível.
exemplo: true
countElementsPerRow: number
Número de elementos exibidos por linha no bloco, se aplicável.
exemplo: 3
quantity: number
Quantidade de itens no bloco, se aplicável.
exemplo: 5
similarProducts: IProductsResponse
Resposta contendo produtos similares associados ao bloco.
exemplo:
{
"total": 10,
"items": []
}
products: IProductsEntity[]
Array de entidades de produtos associadas ao bloco.
exemplo:
[
{
"id": 1,
"name": "Produto 1"
},
{
"id": 2,
"name": "Produto 2"
}
]