Developers
Guias · Cadastros base

O que integrar

Os cadastros base são a fundação de todos os módulos. O que enviar, em que ordem e com que frequência.

Antes de qualquer módulo funcionar, o BIX precisa conhecer as lojas, os produtos, a estrutura mercadológica e o preço e saldo de cada produto em cada loja. Contagem, Ruptura e Validade leem esses mesmos cadastros.

flowchart LR
    E["1. Estrutura mercadológica"] --> P["2. Produtos"]
    L["Lojas (cadastradas no BIX)"] --> S["3. Preço e saldo por loja"]
    P --> S
    S --> M["Módulos: Contagem, Ruptura, Validade"]

A ordem

Passo Recurso Por quê
0 GET/stores Confira que toda loja tem o código de integração do seu ERP. As lojas são cadastradas no BIX, não pela API
1 POST/categories Os produtos apontam para a estrutura pelos códigos dela
2 POST/suppliers e POST/buyers Opcional: completa os nomes que o produto não traz
3 POST/products O preço e saldo apontam para o produto
4 POST/stock-prices Por loja, pelo código de integração
— POST/store-groups Opcional: grupos de lojas para agendar e filtrar

Frequência

Recurso Carga inicial Depois
Estrutura Completa Quando mudar
Produtos Completa Só os alterados no ERP, várias vezes ao dia
Preço e saldo Completa, por loja Só os alterados; o saldo, o mais perto possível do tempo real

O BIX não apaga cadastro que deixou de vir. Produto que saiu de linha vai com active: false.

Guias

Pronto para produção

  • [ ] Todas as lojas têm código de integração igual ao do ERP.
  • [ ] A estrutura foi enviada antes dos produtos.
  • [ ] Os envios usam lotes de até 500 itens e Idempotency-Key.
  • [ ] Os itens com status: error ficam registrados do seu lado para correção.
  • [ ] A carga incremental manda só o que mudou no ERP.
  • [ ] A chave tem só os escopos *.write de que o envio precisa.