VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Blocos

Detalhes do bloco

Referência dos campos de um objeto de bloco: os campos, as propriedades comuns a vários tipos e o formato do objeto de conteúdo.

A referência de detalhes do bloco descreve a estrutura e as propriedades dos blocos da sua loja. Os campos abaixo são os que você lê pelos endpoints de Blocks, usando o block_id, e os que você envia ao criar ou atualizar um bloco. Esta página é uma referência: para as chamadas em si veja Obter um bloco, Criar um bloco e Atualizar um bloco.

Referência dos campos do bloco

Campos do bloco

block_idinteger
Identificador único do bloco.
typestring
O tipo do bloco, que determina a funcionalidade e as propriedades disponíveis.
propertiesobject
Configurações específicas do tipo de bloco, que controlam o comportamento e a aparência.
company_idinteger
Id do lojista (vendor) associado a este bloco.
lang_codestring
Código de idioma de duas letras (por exemplo, en, es, fr) que indica de qual idioma é esta versão do bloco.
namestring
O nome de exibição do bloco, como aparece na interface de administração.
contentobject
Dados de conteúdo específicos do tipo de bloco. Disponível em certos tipos, como banners, html_block e outros.

Tipos de bloco e propriedades

Cada tipo de bloco tem propriedades e requisitos de conteúdo próprios. Estes são alguns tipos comuns e suas propriedades específicas.

Bloco HTML (html_block)

json
{
  "block_id": 42,
  "type": "html_block",
  "properties": {
    "template": "blocks/html_block.tpl"
  },
  "company_id": 1,
  "lang_code": "en",
  "name": "Special Offer Banner",
  "content": {
    "content": "<div class=\"offer-banner\">Limited Time Offer: 20% Off All Orders</div>"
  }
}

Bloco de lista de produtos (products)

json
{
  "block_id": 43,
  "type": "products",
  "properties": {
    "template": "blocks/products/grid_list.tpl",
    "item_number": 8,
    "hide_options": false,
    "show_price": true,
    "show_rating": true
  },
  "company_id": 1,
  "lang_code": "en",
  "name": "Featured Products",
  "content": {
    "items": {
      "filling": "bestsellers",
      "limit": 8
    }
  }
}

Bloco de menu (menu)

json
{
  "block_id": 44,
  "type": "menu",
  "properties": {
    "template": "blocks/menu/dropdown_horizontal.tpl"
  },
  "company_id": 1,
  "lang_code": "en",
  "name": "Main Navigation Menu",
  "content": {
    "items": {
      "menu_id": 12
    }
  }
}

Propriedades comuns dos blocos

Embora cada tipo de bloco tenha propriedades próprias, várias são compartilhadas entre muitos tipos.

Propriedades comuns

templatestring
O arquivo de template usado para renderizar o bloco na loja.
widthstring
full_widthcontent_width
Largura do bloco: full_width, content_width ou um valor específico em pixels.
wrapperstring
Classe CSS do invólucro do bloco, para estilização personalizada.
user_classstring
Classes CSS adicionais a aplicar no bloco.
animationobject
Configurações de animação visual quando o bloco entra na área visível da tela.
Dica

Ao criar ou atualizar blocos pela API, inclua só as propriedades que você precisa mudar. O sistema mantém os valores padrão das propriedades que você não informar.

Estrutura do objeto de conteúdo

O objeto content varia bastante conforme o tipo do bloco.

Em blocos HTML

  • content: uma string com o conteúdo HTML a exibir.

Em blocos de produtos

  • items.filling: o método de seleção dos produtos. As opções são manually, newest, bestsellers, rating e on_sale.
  • items.item_ids: no preenchimento manual, uma lista de ids de produto separados por vírgula.
  • items.limit: o número máximo de produtos a exibir.

Em blocos de categorias

  • items.filling: o método de seleção das categorias. As opções são manually, dynamic_tree e full_tree.
  • items.item_ids: no preenchimento manual, uma lista de ids de categoria separados por vírgula.
Atenção

Ao atualizar um bloco, cuidado para não sobrescrever o objeto content inteiro se você só quer mudar campos específicos. Primeiro obtenha os detalhes atuais do bloco e depois altere apenas as propriedades de conteúdo que precisa mudar.

Anterior
Obter um bloco
Próxima
Criar um bloco
Nesta página
  • Referência dos campos do bloco
  • Tipos de bloco e propriedades
  • Bloco HTML (htmlblock)
  • Bloco de lista de produtos (products)
  • Bloco de menu (menu)
  • Propriedades comuns dos blocos
  • Estrutura do objeto de conteúdo
  • Em blocos HTML
  • Em blocos de produtos
  • Em blocos de categorias