Lojas

As lojas são cadastradas no BIX. Pela API você as lista e confere o código de integração que liga cada uma ao seu ERP.

A loja (ou centro de distribuição, ou fábrica) é cadastrada pelo cliente dentro do BIX. A API não cria lojas: ela lista as que existem, para você casar com as do ERP.

Listar

GET/stores

curl "https://demonstracao.appbix.com.br/external-api/v1/stores?page_size=100" \
  -H "Authorization: Bearer $BIX_API_KEY"

{
  "id": 12,
  "code": "0012",
  "name": "Loja Centro",
  "cnpj": "12345678000190",
  "number": "12",
  "kind": "store",
  "active": true,
  "updated_at": "2026-11-10T08:30:00-03:00"
}

O código de integração

O code é o código de integração da loja no BIX, e é por ele que todos os outros recursos identificam a loja (store_code). Ele precisa ser igual ao código da loja no seu ERP.

Loja com code vazio

A loja não tem código de integração no BIX. Nenhum envio por store_code vai encontrá-la. Peça ao administrador do BIX do cliente para preencher o código no cadastro da loja. Enquanto isso, dá para usar o store_id, mas ele só existe no BIX.

Chave restrita a lojas

Se a chave foi criada para algumas lojas, a listagem traz só essas, e os envios para outras lojas são recusados item a item com store_not_allowed.

Grupos de lojas

Grupos (regional, bandeira, cluster) servem para agendar tarefas e filtrar relatórios por um conjunto de lojas. Diferente das lojas, os grupos podem ser enviados pela API.

POST/store-groups

{"items": [{"name": "REGIONAL SUL", "description": "Lojas do RS e SC", "stores": ["0012", "0020"]}]}

A chave é o nome do grupo (sem diferenciar maiúsculas).
stores substitui as lojas do grupo: mande sempre a lista completa, pelos códigos de integração.

Para ler: GET/store-groups.