Conceitos
Cliente, loja, produto, item de estoque e módulo. Os identificadores que você usa em toda chamada.
Cliente
O cliente é a empresa que usa o BIX (a rede de lojas, a indústria). Um ambiente pode ter mais de um cliente, e cada chave pertence a um só: todas as respostas são do cliente da chave.
Loja
A loja é qualquer unidade onde a operação acontece: loja, centro de distribuição, fábrica. Nas chamadas, ela aparece assim:
| Campo | O que é | Use para |
|---|---|---|
store.code / filtro store_code |
O código de integração da loja, o mesmo do seu ERP | Identificar a loja do seu lado. É o recomendado |
store.id / filtro store_id |
O id da loja no BIX | Referência; estável, mas só faz sentido dentro do BIX |
store.name |
O nome no cadastro | Exibição |
Cadastre o código de integração
Se a loja não tem código de integração no BIX, store.code vem vazio e o filtro
store_code não a encontra. Peça ao administrador para preencher o mesmo código do ERP no
cadastro da loja.
Produto e item de estoque
No cadastro do BIX, cada código de barras é uma linha. O mesmo código interno pode ter várias: a unidade, a caixa com 12, um EAN alternativo.
| Campo | O que é |
|---|---|
product.internal_code / filtro product_code |
O código interno do produto no ERP |
product.ean / filtro ean |
O código de barras |
product.id |
O id da linha no BIX |
product.unit |
A unidade de medida |
Para controlar saldo, o BIX elege um item de estoque entre essas linhas. Em geral é a linha
de unidade mais antiga do código interno: bipar uma caixa de 12 lança 12 unidades nesse item.
Por isso, ao filtrar por qualquer código da caixa ou por um EAN alternativo, a resposta traz o
item de estoque, que pode ter outro EAN. Compare pelo internal_code.
Módulo
Cada recurso da API pertence a um módulo do BIX (Contagem, Ruptura, Validade, WMS). O cliente
precisa ter o módulo contratado: sem ele, a chamada recebe 403 module_disabled, mesmo com a
chave certa.
Datas e números
- Datas e horas em ISO 8601 com fuso, no horário de Brasília:
2026-11-09T10:15:00-03:00. Nos filtros, data sem hora vale a partir de 00:00 de Brasília. - Quantidades são números com até 4 casas decimais, na unidade do item. Saldo negativo existe onde o depósito aceita.
- Campos de texto ausentes vêm como
"". Datas ausentes vêm comonull.