Metadados

Os metadados acrescentam dados customizados às entidades da plataforma e alimentam métricas customizadas. A API recebe os metadados em 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

Cada entidade tem um limite de metadados. Consulte Limites e parâmetros antes de planejar configurações extensas.