getBlockByMarker

Obtendo um único objeto de bloco pelo marcador.

Descrição

Este método retorna um objeto de bloco pelo marcador. Ele retorna uma Promise que resolve para um objeto IBlockEntity.

.getBlockByMarker(

, , ,

);

Esquema de parâmetros

Esquema

marker(obrigatório): 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

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 (abre em uma nova aba) de acordo com suas necessidades na seção correspondente.

Exemplos

Exemplo mínimo

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

Exemplo com atributos

const response = await Blocks.getBlockByMarker('my-marker', 'en_US', 0, 30);

Exemplo de resposta

{
  "id": 3,
  "attributeSetIdentifier": null,
  "localizeInfos": {
    "title": "Block"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

Esquema de resposta

Esquema: IBlockEntity

attributeValues: IAttributeValues
Mapa de valores de atributos indexados pelo marcador; objeto vazio quando não houver.
exemplo:

{
  "block-text": {
    "type": "string",
    "value": "some text",
    "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 de bloco.
exemplo: 1

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

type: BlockType
Tipo do bloco.
exemplo: "product"

position: number
Posição do bloco para ordenação.
exemplo: 1

templateIdentifier: string | null
Identificador do 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": []
}

similarProducts.total: number
O número total de produtos encontrados.
exemplo: 100

similarProducts.items: IProductsEntity[]
Um array de entidades de produtos.
exemplo:

[
  {
    "id": 12345,
    "title": "Product 1"
  },
  {
    "id": 67890,
    "title": "Product 2"
  }
]

similarProducts.totalFound: number
Número de produtos correspondentes antes que os limites sejam aplicados; retornado pelos endpoints de produtos do bloco (similarProducts, recomendações de carrinho/lista de desejos, pedidos frequentes). Opcional.
exemplo: 2

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

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

products.id: number
O identificador único.
exemplo: 12345

products.localizeInfos: ILocalizeInfo
O nome dos produtos, levando em conta a localização.
exemplo:

{}

products.statusIdentifier: string | null
Identificadores de status da página do produto (podem ser null).
exemplo: "in_stock"

products.statusLocalizeInfos: ILocalizeInfo
Nome de status localizado para o produto.
exemplo:

{ "title": "Sale" }

products.attributeSetIdentifier: string | null
ID do conjunto de atributos.
exemplo: "set_12345"

products.position: number
Número do item (para ordenação).
exemplo: 1

products.price: number | null
O valor do preço da página do produto obtido do índice.
exemplo: 150.00

products.additional: object
Valor adicional do índice.
exemplo:

{
  "prices": {
    "min": 5,
    "max": 150
  }
}

products.sku: string | null
SKU do produto (Unidade de Manutenção de Estoque), pode ser null.
exemplo: "SKU_12345"

products.isSync: boolean
Indicação de indexação da página.
exemplo: true

products.attributeValues: IAttributeValues
Array de valores de atributos do índice, representados.
exemplo:

[
  {
    "id": "color",
    "value": "red"
  }
]

products.categories: string[]
Categorias de produtos.
exemplo:

[
  1,
  2,
  3
]

products.isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true

products.moduleFormConfigs: Array<IFormConfig>
Configurações de formulário do módulo (opcional).

products.rating: IRating
Dados de avaliação.

products.isPositionLocked: boolean
Indicador de bloqueio da posição de ordenação (opcional).
exemplo: false

products.relatedIds: number[]
IDs de páginas de produtos relacionados.
exemplo:

[
  12345,
  67890
]

products.paymentStages: unknown
Dados das etapas de pagamento (podem ser null).
exemplo: null

products.distance: number
Distância de relevância da busca vetorial (semântica). Presente apenas nos resultados da busca vetorial.
exemplo: 0.42

products.discountConfig: Record<string, unknown>
Objeto de configuração de desconto.
exemplo:

{}

products.templateIdentifier: string | null
ID do usuário do template vinculado.
exemplo: "template_12345"

products.shortDescTemplateIdentifier: string | null
ID do usuário do template vinculado para uma descrição curta.
exemplo: "short_desc_template_12345"

products.signedPrice: string
O preço assinado do produto é obtido junto com os dados do produto quando signPrice está definido.
veja: Preço fixo do produto
exemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

products.productPages: IProductPageRef[]
Array de referências de páginas de produtos vinculando o produto às suas páginas.
exemplo:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

products.blocks: string[]
Array de identificadores de blocos.
exemplo:

[
  "block_12345",
  "block_67890"
]

🔒 signedPrice é o token assinado que carrega o preço bloqueado — passe-o de volta quando você criar um pedido. Veja Preço fixo do produto (signedPrice).

---