Estrutura e produtos

Envie a estrutura mercadológica e o cadastro de produtos, e leia de volta o que está no BIX.

Estrutura mercadológica

A estrutura tem até cinco níveis, n0 a n4 (por exemplo Empresa › Departamento › Seção › Grupo › Subgrupo). Cada item é um ramo: o conjunto de códigos de cima até onde o seu ERP vai.

POST/categories

{
  "items": [
    {"n1": {"code": "01", "name": "MERCEARIA"}, "n2": {"code": "0105", "name": "ARROZ E FEIJÃO"}},
    {"n1": {"code": "01", "name": "MERCEARIA"}, "n2": {"code": "0106", "name": "MASSAS"}}
  ]
}

A chave é a combinação dos códigos dos cinco níveis. O mesmo ramo enviado de novo só atualiza os nomes.
Nível que o seu ERP não tem pode ser omitido.
Mudou um código no ERP? Para o BIX é outro ramo: envie o novo. O antigo continua, até ser desativado no BIX.

Para ler: GET/categories.

Produtos

POST/products

A chave do produto é (internal_code, ean). No BIX, cada código de barras é um item: a unidade, a caixa e um EAN alternativo do mesmo produto são três itens com o mesmo internal_code.

{
  "items": [
    {"internal_code": "1001", "ean": "7891234567890", "description": "ARROZ TIPO 1 5KG",
     "unit": "UN", "multiplier": 1, "price": 27.9,
     "category": {"n1": "01", "n2": "0105"},
     "supplier": {"code": "12345678000190", "name": "Fornecedor Exemplo"}},
    {"internal_code": "1001", "ean": "17891234567897", "description": "ARROZ TIPO 1 5KG CX 6",
     "unit": "CX", "multiplier": 6}
  ]
}

Regra	Detalhe
Atualização parcial	Produto que já existe recebe só os campos enviados. Mandar só `price` não apaga a descrição
`category`	Os códigos da estrutura, nível a nível, iguais aos de POST`/categories`
`multiplier`	Quantas unidades o código de barras representa. A caixa com 6 é `6`
`price`	Preço de cadastro. O preço praticado em cada loja vai em Preço e saldo
`supplier` / `buyer`	Criados se não existirem, pelo `code`. O `name` só preenche cadastro que está sem nome: nome digitado no BIX não é sobrescrito
Sair de linha	`active: false`. O BIX não apaga produto que deixou de vir

Envie todos os EANs

No app, o operador bipa o que está na mão: a unidade, a caixa, o fardo. Cada código de barras que pode ser bipado precisa estar cadastrado, com o multiplier certo.

Para ler: GET/products. Na sincronização incremental, use updated_since com include_inactive=true para receber também os que saíram de linha.

Fornecedores e compradores

O produto já cria o fornecedor e o comprador pelo code, mas só preenche o nome quando ele está vazio. Para manter os cadastros completos (razão social, nome fantasia) e o ERP como fonte dos nomes, envie-os também pelos recursos próprios:

Recurso	Chave	Campos
POST`/suppliers`	`code` (em geral o CNPJ)	`legal_name`, `trade_name`, `active`
POST`/buyers`	`code`	`name`, `active`

Aqui o nome enviado substitui o que está no BIX. Use o mesmo code que vai em supplier.code e buyer.code do produto.

Para ler: GET/suppliers e GET/buyers.