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

Conheça os dados comuns para tagueamento em todas as páginas

Comece tagueando as propriedades comuns a todas as páginas do ecommerce. São elas page (dados da página que está sendo visitada), salesChannel (opcional, o canal de compras atual) e user (dados do cliente que está visitando-a).

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

Os campos da propriedade page devem ser declarados conforme especificação abaixo:

name:
obrigatório
String

Nome da página, conforme tabela abaixo.

 
Página name
Home home
Categoria ou departamento (1° nível) category
Subcategoria subcategory
Produto product
Carrinho cart
Checkout checkout
Confirmação de compra confirmation
Busca search
Busca vazia emptysearch
Landing page landing_page
Perfil do cliente userprofile
Erro 404 not_found
Outras other
variation:
opcional
String

Caso esteja passando por um teste A/B, identifica o grupo em que a página está sendo exibida.

Ex: Versão B - Redesign

2. Sales Channel (chaordic_meta.page.salesChannel) (opcional)

Indica o canal de compras (sales channel) atual do usuário. Esse campo só deve ser preenchido se a loja utilizar canais de compra, em caso de dúvida, verifique com o gerente de projetos se há necessidade de preencher esse campo.

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

A propriedade user deve ser omitida caso o cliente esteja deslogado. Os campos devem ser declarados conforme especificação abaixo:

id:
obrigatório
String

Identificador único do cliente.

Ex: 2481632
name:
obrigatório
String

Nome completo.

Ex: Ross Geller
email:
obrigatório
String

Email válido.

allow_mail_marketing:
obrigatório
Boolean

Informa se o cliente autoriza recebimento de campanhas de email.

true | false
birthday:
opcional
String

Data de nascimento no formato YYYY-MM-DD.

Ex: 1967-10-18
gender:
opcional
String

Gênero do cliente. Utilize M para masculino e F para feminino.

M | F
tags:
opcional
String

Informações eventuais em formato linear (não hierarquizado).

Ex: vip, high_clv
extra_info:
opcional
Object

Informações eventuais em formato hierarquizado.

Ex: esp_id: 2361842
auth_token:
opcional
String

Token de autenticação para recuperar a sessão de um cliente e adicionar produtos deixados anteriormente no carrinho.

Ex: 8a9dav313b0ha492p
remote_url:
opcional
String

URL que disponibiliza ou sobrescreve todas as informações anteriores no formato JSON. Esse campo é descrito logo abaixo.

Ex: //www.nomedosite.com/user

Exemplo do chaordic_meta na home

window.chaordic_meta = {

  /* page info */
  "page": { 
    "name": "Home",
    
    /* sales channel (apenas se utilizar sales channel) */
    "salesChannel": "5"
  },

  /* logged user info */
  "user": {
    "id": "2481632",
    "name": "Ross Geller",
    "email": "[email protected]",
    "language": "pt-BR",
    "allow_mail_marketing": true,
    "birthday": "1967-10-18",
    "gender": "M",
    "tags": ["vip", "high_clv"],
    "extra_info": {
    	"esp_id": "2361842"
    }
  }

}

Informações do cliente via acesso remoto

Se preferir, utilize um serviço que disponibilize os dados de cliente de forma remota. Este método é útil caso você prefira manter a estrutura do HTML sempre igual e também para corrigir mecanismos de cache existentes em muitos ecommerces.

Para usar um serviço remoto de acesso aos dados do cliente indique apenas a propriedade remote_url, tendo como valor a URL onde a informação do cliente poderá ser consultada pela Chaordic. Exemplo:

window.chaordic_meta = {
    "page": { ... },
    "user": {
        "remote_url": "//www.nomedosite.com/user"
    }
}

O serviço consultado (em nosso exemplo: //www.nomedosite.com/user) deverá retornar os mesmos dados do objeto user no formato JSON:

{
        "uid": "U1234",
        "name": "Ross Geller",
        "email": "[email protected]",
        "allow_mail_marketing": true
}

Finalizado o tagueamento das informações comuns a todas as páginas, passe a adicionar os dados específicos de cada página. Que tal começar pela Home? ➝