Hey! These docs are for version 5, which is no longer officially supported. Click here for the latest version, 2-Main-Docs!

Saiba o que declarar nas páginas de produto

Ao acessar a página de um produto, o cliente está deixando uma pista importante sobre seu interesse no momento. Essa informação é essencial para a Linx+Neemu+Chaordic. Na página de produto você nos passa as informações do cliente, da página e também do produto que está sendo visitado.

1. Informações da página (chaordic_meta.page)

Os campos da propriedade page neste tipo de página recebe algumas informações adicionais:

name:
obrigatório
String

Nome da página. Na página de produto o valor deve ser "product".

categories:
obrigatório

Conjunto de categorias relacionadas à página. Geralmente o mesmo que aparece no "breadcrumb" da navegação.

 

Array de Strings – Método simplificado

Utilize esse método caso sua loja não possua mais de uma categoria/sub com o mesmo nome. Declare-as na ordem em que aparecem na navegação (Cat, Sub, Subsub, ...)

Ex: ["Móveis", "Sala", "Cadeiras"]

 

Array de Objects – Método alternativo

Utilize esse método caso sua loja possua mais de uma categoria/sub com o mesmo nome. Para cada categoria/sub da lista, declare um objeto com as seguintes informações:

 

id:
obrigatório
String

Identificador da categoria/subcategoria. Pode ser um numeral ou o próprio nome da categoria/sub, desde que seja único no site.

Ex: "015"
name:
obrigatório
String

Título da categoria/sub.

Ex: "Cadeiras"
parents:
obrigatório para subcategorias.
Array de Strings

Identificador da categoria/sub a qual esta subcategoria pertence.

Ex: "014"
tags:
opcional
Array de Strings

Conjunto de tags relacionadas à página.

partner:
opcional
String

Identifica que a visita foi gerada através de um site de parceiro e que o produto pode ter sofrido redução de preço em decorrência disso. Nesses casos, não atualizamos as informações do produto em nossa plataforma.

Ex: "Buscapé"

2. Informações do cliente (chaordic_meta.user)

Os campos da propriedade user devem ser declarados quando o cliente estiver logado, conforme especificado anteriormente.

3. Informações do produto (chaordic_meta.product)

Os campos declarados no objeto product variam de acordo com o tipo do produto em questão. Confira exemplos de produtos suportados pela nossa integração:

1280

Modelo único (sem variantes):
Quando o produto não possui nenhuma variação de especificação. 1 produto ⟶ 1 SKU.

Produtos com variantes:
Quando o produto tiver ao menos uma característica variável que possa ser escolhida pelo cliente (ex: cor, voltagem, tamanho, sabor ou tipo de mídia). Utilizamos essas especificações para melhorar a qualidade e relevância das nossas recomendações. Quando você especifica as variantes podemos recomendar, por exemplo, camisetas de cores similares as que o cliente demonstrou interesse. 1 produto ⟶ múltiplos SKUs.

Kit de produtos:
Quando um conjunto de diferentes produtos é comercializado no formato kit. 1 Kit ⟶ múltiplos produtos.

id:
obrigatório
String

Identificador único do produto. Quando um produto possui uma lista de SKUs, este campo funciona como seu agrupador.

name:
obrigatório
String

Título do produto.

description:
obrigatório
String

Breve descrição do produto em texto plano, sem tags HTML e quebras de linhas.

url:
obrigatório
String

URL da página de detalhes do produto.

Ex: "//www.chaosnorder.com/product/P123.html"
images:
obrigatório
Object

Caminho da imagem do produto em um tamanho ideal para a apresentação nas vitrines, busca e mail. Valores: URL da imagem. Informar URL relativa.

Ex: "default": "/product/P1234-90x90.jpg"
status:
obrigatório
String

Disponibilidade do produto em estoque.

available | unavailable
categories:
obrigatório

Conjunto de categorias relacionadas ao produto.

 

Array de Strings – Método simplificado

Utilize esse método caso sua loja não possua mais de uma categoria/sub de produto com o mesmo nome.

Ex: ["Móveis", "Sala", "Cadeiras"]

 

Array de Objects – Método alternativo

Utilize esse método caso sua loja possua mais de uma categoria/sub com o mesmo nome. Para cada categoria/sub da lista, declare um objeto com as seguintes informações:

 

id:
obrigatório
String

Identificador da categoria/subcategoria. Pode ser um numeral ou o próprio nome da categoria/sub, desde que seja único no site.

Ex: "015"
name:
obrigatório
String

Título da categoria/sub.

Ex: "Cadeiras"
parents:
obrigatório para subcategorias.
Array de Strings

Identificador da categoria/sub a qual esta subcategoria pertence.

Ex: "014"
price:
obrigatório
Number

Preço de comercialização do produto. Se houver casas decimais, separe-as por ponto.

Ex: 1000.23
specs:
obrigatório para produtos com variantes
Object

Caso o produto possua variantes, declare todas as características e valores possíveis. O nome das chaves e o conjunto de valores é livre. Algumas variantes comuns:

color:
opcional
Array de Strings

Possíveis cores do produto.

Ex: "color": ["amarelo", "azul", "branco", "verde", "vermelho"]
size:
opcional
Array de Strings

Possíveis tamanhos do produto.

Ex: "size": ["PP", "P", "M", "G", "GG"]
flavor:
opcional
Array de Strings

Possíveis sabores do SKU.

Ex: "flavor": ["baunilha", "chocolate", "morango"]
voltage:
opcional
Array de Strings

Possíveis voltagens do produto.

Ex: "voltage": ["110V", "220V"]
media_type:
opcional
Array de Strings

Possíveis tipos de mídia.

Ex: "media_type": ["Paper", "Ebook", "Audiobook", "DVD", "Blu-ray"].

Os campos name, url, description, images, images_ssl, old_price, price, base_price e installment quando declarados dentro de specs sobrescrevem o que foi especificado na raíz do produto.

skus:
obrigatório para produtos com variantes
Array de Objects

Cada variante possível do produto vira um objeto dentro de skus.

sku:
obrigatório
String

Identificador único do SKU.

specs:
obrigatório
Object

Características do SKU.

Ex: { "size": "P", "color": "verde"}
status:
obrigatório
String

Disponibilidade do SKU em estoque.

available | unavailable

Os campos name, url, description, images, images_ssl, old_price, price, base_price, installment, stock e status quando declarados dentro de skus sobrescrevem o que foi especificado na raíz do produto.

kit_products:
obrigatório para kits
Object

Caso o produto seja comercializado como kit, crie um objeto para cada produto e informe no mínimo os campos obrigatórios para cada um deles individualmente: id, name, description, url, images, status, categories, price.

details:
obrigatório para o Chaordic Search
Object

Detalhes de especificação do produto. As chaves e valores são livres.

installment:
opcional
Object

Informação de parcelamento do produto. Objeto contendo count (total de parcelas) e price (valor da parcela).

old_price:
opcional
Number

Preço anterior do produto. Se houver casas decimais, separe-as por ponto.

Ex: 1200.23
base_price:
opcional
Number

Preço de custo do produto. Se houver casas decimais, separe-as por ponto.

Ex: 900.23
images_ssl:
opcional
Object

Caminho das URLs seguras das imagens, caso sejam diferentes das comuns. Chaves: largura-x-altura. Valores: URL da imagem

tags:
opcional
Array de Strings

Conjunto de tags relacionadas ao produto.

published:
opcional
String

Data de adição do produto ao catálogo. Formato YYYY-MM-DD.

Ex: 2015-02-04
unit:
opcional
String

Unidade de medida utilizada na comercialização do produto. Informe somente para produtos que possuem quantidades fracionárias.

Ex: "M", "M(2)", "KG"
stock:
opcional
Number

Quantidade de itens disponíveis em estoque.

Ex: 9

Exemplos

window.chaordic_meta = {
  /* page info */
  "page": {...},

  /* product info */
  "product": {
    "id": "Camiseta2",
    "name": "Camiseta Estampada",
    "url": "//www.nomedaloja.com/product/Camiseta2.htm",
    "images": {
      "default": "/product/P1236.jpg"
    },
    "categories": [
      "Masculino",
      "Camisetas"
    ],
    "price": 29.9,
    "specs": {
      "color": [
        {
          "label": "Branca",
          "images": {
            "default": "//nomedaloja.com/camiseta-branca.jpg"
          },
          "url": "//www.nomedaloja.com/product/camiseta-branca.htm"
        },
        {
          "label": "Amarela",
          "images": {
            "default": "//nomedaloja.com/camiseta-amarela.jpg"
          },
          "url": "//www.nomedaloja.com/product/camiseta-amarela.htm"
        }
      ],
      "size": [
        "P",
        "M",
        "G"
      ]
    },
    "skus": [
      {
        "sku": "P1236BP",
        "specs": {
          "color": "Branca",
          "size": "P"
        },
        "stock": 3,
        "status": "available"
      },
      {
        "sku": "P1236BM",
        "specs": {
          "color": "Branca",
          "size": "M"
        },
        "stock": 1,
        "status": "available"
      },
      {
        "sku": "P1236BG",
        "specs": {
          "color": "Branca",
          "size": "G"
        },
        "price": 32.9,
        "stock": 0,
        "status": "unavailable"
      },
      {
        "sku": "P1236PP",
        "specs": {
          "color": "Amarela",
          "size": "P"
        },
        "price": 30.9,
        "stock": 3,
        "status": "available"
      },
      {
        "sku": "P1236PM",
        "specs": {
          "color": "Amarela",
          "size": "M"
        },
        "price": 28.9,
        "stock": 4,
        "status": "available"
      },
      {
        "sku": "P1236PG",
        "specs": {
          "color": "Amarela",
          "size": "G"
        },
        "price": 34.9,
        "stock": 7,
        "status": "available"
      }
    ]
  },

  /* user info */
  "user": {...}
};
window.chaordic_meta = {
  /* page info */
  "page": {...},

  /* product info */
  "product": {
    "id": "P1234",
    "name": "O Guia do Mochileiro das Galáxias",
    "url": "//www.nomedaloja.com/product/P1234.htm",
    "description": "Considerado um dos maiores clássicos da literatura de ficção científica, O guia do mochileiro das galáxias vem encantando gerações de leitores ao redor do mundo com seu humor afiado.",
    "images": {
      "90x90": "/product/P1234-90x90.jpg",
      "120x120": "/product/P1234-120x120.jpg",
      "1000x1000": "/product/P1234-1000x1000.jpg"
    },
    "images_ssl": {
      "default": "/product/P1234.jpg"
    },
    "categories": [
      "Livros",
      "Importados",
      "Ficção Científica"
    ],
    "tags": [
      "Promoções",
      "Frete_Gratis"
    ],
    "installment": {
      "count": 3,
      "price": 6.63
    },
    "details": {
      "autor": "Douglas Adams, Eoin Colfer",
      "personagens": "Marvin the Paranoid Android, Arthur Dent"
    },
    "old_price": 24.9,
    "price": 19.9,
    "status": "available"
  },

  /* user info */
  "user": {...}
};
window.chaordic_meta = {
  /* page info */
  "page": {...},

  /* product info */
  "product": {
    "id": "K1234",
    "name": "Notebook + Impressora",
    "url": "//www.nomedaloja.com/product/K1234.htm",
    "images": {
      "180x180": "/product/K1234.jpg"
    },
    "old_price": 1590,
    "price": 1427.7,
    "stock": 15,
    "status": "available",
    "kit_products": [
      {
        "id": "P1237",
        "name": "Notebook",
        "url": "//www.loja.com/product/P1237.htm",
        "description": "Notebook 14\" Core i3 4Gb de RAM e 500Gb de HD",
        "images": {
          "180x180": "/product/P1237.jpg"
        },
        "categories": [
          "Informática",
          "Laptops"
        ],
        "installment": {
          "count": 12,
          "price": 109.9
        },
        "price": 1308,
        "status": "available"
      },
      {
        "id": "P1238",
        "name": "Impressora",
        "url": "//www.loja.com/product/P1238.htm",
        "description": "Impressora Jato de Tinta",
        "images": {
          "180x180": "/product/P1238.jpg"
        },
        "categories": [
          "Informática",
          "Periféricos"
        ],
        "installment": {
          "count": 3,
          "price": 39.9
        },
        "price": 119.7,
        "status": "available"
      }
    ]
  },

  /* user info */
  "user": {...}
};

📘

Importante!

Visualizações em produtos realizadas fora desta página devem ser informadas através do método viewProduct da API Javascript da Chaordic.

Ufa! Hora de pegar um refill de café e validar a integração da página de produto.

Feito isso, passe para a página de busca