Pular para o conteúdo principal

Dicionário de dados

Abaixo estão os schemas das cinco entidades aceitas. Todos os arquivos devem ser enviados no formato CSV com encoding UTF-8 e separador vírgula.

Os nomes das colunas são combinados no onboarding

A ingestão usa nomes canônicos próprios e aceita um mapeamento de colunas por parceiro. Confirme com o time quais nomes valem para você antes da primeira carga — você não precisa mudar o seu export, mas o mapeamento precisa existir.

Lojas​

CampoTipoObrig.DescriçãoExemplo
location_nameTextoSimNome/descrição da lojaLoja Shopping SP
location_codeTextoSimCódigo único (CNPJ ou ID comercial)S74
is_activeBooleanoSimStatus da loja (true / false)true
categoryTextoNãoRamo de atuaçãoAlimentação
cepNuméricoNãoCEP da loja81000-000
ufTextoNãoUF do estadoSP
cityTextoNãoCidadeSão Paulo
segmentTextoNãoSegmento da lojaAlimentação
channelTextoNãoCanal de vendas (varejo, atacado)Varejo

Produtos​

CampoTipoObrig.DescriçãoExemplo
product_nameTextoSimNome/descrição do produtoBateria p/Celular
product_codeTextoSimCódigo único (SKU)P123
is_activeBooleanoSimStatus do produto (true / false)true
categoryTextoSimCategoriaSmartphones
sub_categoryTextoNãoSubcategoriaAndroid
master_productTextoNãoProduto principal/agrupadorGalaxy
multipleNuméricoNãoMúltiplos de venda (padrão: 1)5.0
ean_codeTextoNãoCódigo de barras internacional (GTIN/EAN)7891000001234
ncm_codeTextoNãoNomenclatura Comum do Mercosul (8 dígitos)2523.29.10
base_priceDecimalNãoPreço base líquido unitário do produto — referência única para todas as lojas58.90

Preços​

CampoTipoObrig.DescriçãoExemplo
location_codeTextoSimCódigo da loja (deve existir em Lojas)L01
product_codeTextoSimCódigo do produto (deve existir em Produtos)P123
price_nameTextoSimNome da condição comercial. Identifica a linha e é referenciado em OrdersATACADO
unit_cost_priceDecimalSimCusto unitário do produto (CMV) associado a esta condição25.00
unit_sale_priceDecimalSimValor líquido unitário de venda desta condição47.90

Inventory​

Posição de estoque. Idealmente o fechamento de D-1.

CampoTipoObrig.DescriçãoExemplo
location_codeTextoSimCódigo da loja (deve existir em Lojas)L01
product_codeTextoSimCódigo do produto (deve existir em Produtos)P123
dateDataSimData de fechamento do estoque (YYYY-MM-DD)2026-04-14
quantityNuméricoSimQuantidade em estoque na data60.0

Orders​

Cada item do pedido é um registro individual.

CampoTipoObrig.DescriçãoExemplo
order_codeTextoSimCódigo único do pedidoPED-20260414-001
location_codeTextoSimCódigo da loja (deve existir em Lojas)L01
product_codeTextoSimCódigo do produto (deve existir em Produtos)P123
dateDataSimData do pedido (YYYY-MM-DD)2026-04-14
quantityNuméricoSimQuantidade solicitada no pedido15.0
unit_sale_priceDecimalSimValor líquido unitário de venda do item (já deduzidos descontos do item e impostos de saída)40.00
unit_cost_priceDecimalSimCusto unitário do produto em estoque (CMV) associado a este pedido25.00
order_statusTextoSimStatus do pedido (pending / confirmed / shipped / delivered / cancelled)confirmed
price_nameTextoNãoCondição comercial aplicada no item (deve existir em Preços)ATACADO
customer_codeTextoNãoCódigo do cliente que fez o pedidoCLI-0472
delivery_dateDataNãoData prevista de entrega (YYYY-MM-DD)2026-04-21
freight_priceDecimalNãoValor total do frete cobrado ou atribuído ao pedido150.00
discount_priceDecimalNãoDesconto global aplicado no fechamento do carrinho (valor rateado entre os itens)50.00
notesTextoNãoObservações adicionais do pedidoEntrega urgente