Metadados

Metadados permitem adicionar dados customizados às entidades da plataforma e são utilizados na criação de regras e métricas customizadas. Podem ser informados na API através de uma estrutura chave-valor:

"metadata": {
  "categoria_estabelecimento": "vestuario",
  "regional": "SP01"
}

Requisitos

Chaves

• Apenas texto.
• Devem possuir até 32 caracteres.
• Permitem apenas letras minúsculas não acentuadas, números e sublinhado (_).
• Exemplo: categoria_produto

Valores

• Apenas texto.
• Devem possuir até 64 caracteres.
• Permitem qualquer letra não acentuada, números, hífen (-) e sublinhado (_), diferenciando maiúsculas e minúsculas nas consolidações de métricas.
• Exemplo: P01-Xyz_

Limitações

Há um limite para a quantidade máxima de metadados por entidade. Consulte Limites e parâmetros antes de planejar configurações extensas.