getProductBlockById

Obter objetos ContentPageBlock pelo identificador do produto.

Descrição

Este método obtém um objeto de bloco de produto pelo id do produto. Ele retorna uma Promise que resolve para um array de objetos de bloco de produto IProductBlock.

Produtos.getProductBlockById(

id*

);

Esquema de parâmetros

Esquema

id(obrigatório): número
Id do produto
exemplo: 12345

Exemplos

Exemplo mínimo

const response = await Products.getProductBlockById(1764);

Exemplo de resposta

[
  {
    "id": 1,
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Product Block"
    },
    "version": 0,
    "position": 1,
    "identifier": "product_block",
    "type": "product_block",
    "customSettings": {
      "productConfig": {
        "quantity": "1",
        "sortType": 0,
        "sortOrder": 0,
        "countElementsPerRow": "1"
      },
      "similarProductRules": [],
      "condition": {
        "name": "cost",
        "costTo": 130,
        "costFrom": 0
      },
      "sliderDelay": null,
      "sliderDelayType": null
    },
    "templateIdentifier": null,
    "isVisible": true,
    "isSync": false,
    "attributeValues": {}
  }
]

Esquema de resposta

Esquema: IProductBlock

id: número
Identificador único do bloco de produto.
exemplo: 3289

attributeSetIdentifier: string | null
Identificador do conjunto de atributos usado no bloco de produto, ou null se não aplicável.
exemplo: "product_block"

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

{
  "title": "Box"
}

version: número
Versão da entidade de bloco de produto.
exemplo: 1

position: número
Posição do bloco de produto em uma lista ou layout.
exemplo: 1

identifier: string
Identificador único em string para o bloco de produto.
exemplo: "product_block_12345"

type: Types
Tipo do bloco de produto, como "produto", "pagina_de_erro", etc.
exemplo: "produto"

customSettings: objeto
Configurações personalizadas para o bloco de produto, incluindo atraso do slider, configuração do produto, regras de produtos semelhantes e condições.
exemplo:

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

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

isSync: boolean
Indica se o bloco de produto está sincronizado.
exemplo: false

attributeValues: AttributeType
Array de valores de atributos do índice, representados como um par de id de atributo do usuário e valor de atributo.
exemplo:

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

sliderDelay: número | null
Atraso de avanço automático do slider.
exemplo: 5000

sliderDelayType: string | null
Unidade de sliderDelay (por exemplo, "ms", "s").
exemplo: "ms"

productConfig: IProductBlockProductConfig
Configuração de layout para produtos dentro do bloco.

productConfig.quantity: string | número
Número de produtos a serem renderizados.
exemplo: 9

productConfig.countElementsPerRow: string | número
Produtos por linha.
exemplo: 3

productConfig.sortType: string | número
Campo de ordenação.
exemplo: "preço"

productConfig.sortOrder: string | número
Direção de ordenação.
exemplo: "ASC"

similarProductRules: IProductBlockSimilarRule[]
Regras usadas para encontrar produtos semelhantes.

similarProductRules.property: string
Propriedade do produto para correspondência.
exemplo: "categorias"

similarProductRules.includes: string
Estratégia de correspondência (por exemplo, "qualquer", "todos").
exemplo: "qualquer"

similarProductRules.keywords: string
Palavras-chave usadas para a correspondência.
exemplo: "foo,bar"

similarProductRules.strict: string
Flag de rigor ("true"/"false") da correspondência.
exemplo: "false"

condition: Record<string, unknown>
Condição de filtro aplicada aos produtos no bloco; o conjunto de campos varia de acordo com o tipo de condição (por exemplo, { name: "custo", costFrom: 0, costTo: 130 }).

frequentlyOrderedConfig: Record<string, unknown> | null
Configuração para o recurso de produtos frequentemente pedidos, ou null quando não configurado.

quantity: string | número
Número de produtos a serem renderizados.
exemplo: 9

countElementsPerRow: string | número
Produtos por linha.
exemplo: 3

sortType: string | número
Campo de ordenação.
exemplo: "preço"

sortOrder: string | número
Direção de ordenação.
exemplo: "ASC"

property: string
Propriedade do produto para correspondência.
exemplo: "categorias"

includes: string
Estratégia de correspondência (por exemplo, "qualquer", "todos").
exemplo: "qualquer"

keywords: string
Palavras-chave usadas para a correspondência.
exemplo: "foo,bar"

strict: string
Flag de rigor ("true"/"false") da correspondência.
exemplo: "false"

---