Componente Sankhya - Locais de Estoque

O componente Locais de Estoque permite consultar no ERP Sankhya os locais de armazenamento vinculados a um produto, retornando os locais configurados no cadastro do produto por empresa.

Essa consulta utiliza as informações definidas na tela Produtos → aba “Impostos / Informações por empresa”, especificamente o campo Local Padrão.

O resultado indica em quais locais o produto pode ser armazenado ou movimentado, permitindo que o bot determine corretamente de qual local o estoque será considerado durante o processo de venda.

Índice:

• Objetivo do componente
• Interface do componente (leitura da tela)
• Armazenamento
• Integração técnica
• Exemplo de requisição
• Estrutura do retorno (componente)
• Descrição dos campos retornados
• Mapeamento técnico dos campos
• Comportamento da consulta
• Exemplos de uso no bot
• Tratamento de erros
• Boas práticas

• Dados do Cliente

• Obter pedidos

• Itens do Pedido

• Criar Pedido

• Preço do Produto

• Estoque do Produto

• Locais de Estoque

• Volumes Alternativos

• Obter Preferência

• Tabela de Preço

• Tipo de Operação

• Tipos de Negociação

• Detalhe do Produto

• Busca de Produto

• Adicionar ao Carrinho

• Alterar Quantidade no Carrinho

• Obter Itens do Carrinho

---

Objetivo do componente

Permitir que o fluxo do bot identifique os locais de estoque válidos para um produto, garantindo que consultas de estoque e criação de pedidos utilizem locais compatíveis com o cadastro do ERP.

---

Interface do componente (leitura da tela)

Configuração de consulta

Definição dos parâmetros da busca

Campo	Descrição	Origem Sankhya
Código do Produto*	Código único do produto no sistema	TGFPRO.CODPROD
Empresa (opcional)	Código da empresa associada ao produto	TSIEMP.CODEMP
Continuar Listagem (opcional)	Página da listagem para paginação	offsetPage

Código do produto

Exemplo:

PROD001

ou usando variável do fluxo:

{{codigoProduto}}

---

Empresa (opcional)

Permite restringir a consulta a uma empresa específica.

Exemplo:

01

ou

{{codigoEmpresa}}

Quando não informado, a consulta pode retornar locais cadastrados para o produto em diferentes empresas.

---

Continuar listagem (opcional)

Utilizado para paginação dos resultados.

Valor	Comportamento
0	Retorna a primeira página
1	Retorna os próximos registros
2+	Continua avançando na listagem

Exemplo:

0

---

Armazenamento

Campo	Descrição
Variável de armazenamento	Nome da variável que receberá o resultado da consulta
Variável de escopo global	Permite acessar os dados em qualquer fluxo

Exemplo:

locaisEstoque

---

Integração técnica

A consulta utiliza o serviço da API Sankhya:

CRUDServiceProvider.loadRecords

Entidade consultada:

EmpresaProdutoImpostos

Essa entidade contém as configurações de informações do produto por empresa, incluindo o Local Padrão de estoque.

---

Exemplo de requisição

curl --location 'https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecords&outputType=json' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"serviceName": "CRUDServiceProvider.loadRecords",
"requestBody": {
"dataSet": {
"rootEntity": "EmpresaProdutoImpostos",
"includePresentationFields": "S",
"offsetPage": "0",
"criteria": {
"expression": {
"$": "this.CODPROD = ? AND this.CODLOCALPAD != ? AND this.CODEMP = ?"
},
"parameter": [
{ "$": "1236", "type": "I" },
{ "$": "0", "type": "I" },
{ "$": "1", "type": "I" }
]
},
"entity": {
"fieldset": {
"list": "CODLOCALPAD"
}
}
}
}
}'

---

Estrutura do retorno (componente)

Exemplo de resposta

{
  "hasMore": false,
  "size": 1,
  "content": [
    {
      "location": {
        "code": 8000,
        "description": "Almoxarifado"
      },
      "product": {
        "code": 1236,
        "description": "GUARANÁ SANTANA"
      },
      "company": {
        "code": 1,
        "tradeName": "AUDAZ ATACADO/DISTRIBUIDOR"
      }
    }
  ],
  "error": null
}

---

Descrição dos campos retornados

Campo	Descrição
hasMore	Indica se existem mais registros disponíveis para paginação
size	Quantidade de registros retornados na consulta
content[]	Lista de locais de estoque retornados
content[].location.code	Código do local de estoque
content[].location.description	Descrição do local de estoque
content[].product.code	Código do produto
content[].product.description	Descrição do produto
content[].company.code	Código da empresa
content[].company.tradeName	Nome fantasia da empresa
error	Informações de erro quando a consulta falha

---

Mapeamento técnico dos campos

Campo	Origem Sankhya	Tabela
location.code	CODLOCALPAD	EmpresaProdutoImpostos
location.description	LocalFinanceiro_DESCRLOCAL	TGFLOC
product.code	CODPROD	EmpresaProdutoImpostos
product.description	Produto_DESCRPROD	TGFPRO
company.code	CODEMP	EmpresaProdutoImpostos
company.tradeName	Empresa_NOMEFANTASIA	TSIEMP

---

Comportamento da consulta

O componente retorna os locais de estoque configurados no cadastro do produto por empresa.

Se um produto estiver configurado em múltiplas empresas, cada empresa poderá possuir um local padrão diferente.

Exemplo:

Empresa	Produto	Local
1	Guaraná Santana	Almoxarifado
2	Guaraná Santana	Depósito Central

---

Exemplos de uso no bot

Selecionar local automaticamente

Local de estoque utilizado:
{{locaisEstoque.content[0].location.description}}

---

Usar local para consulta de estoque

{{locaisEstoque.content[0].location.code}}

Esse valor pode ser utilizado em:

• Estoque do Produto

• Criação do Pedido

• Consulta de preço

---

Tratamento de erros

Situação	Comportamento
Produto inexistente	lista vazia
Produto sem local configurado	size = 0
Falha de integração	campo error preenchido

---

Boas práticas

• Sempre consultar o Local de Estoque antes de consultar estoque

• Utilizar o local retornado para consultas posteriores

• Validar size > 0 antes de continuar o fluxo

• Evitar assumir um local fixo sem consulta

• Dados do Cliente

• Obter pedidos

• Itens do Pedido

• Criar Pedido

• Preço do Produto

• Estoque do Produto

• Locais de Estoque

• Volumes Alternativos

• Obter Preferência

• Tabela de Preço

• Tipo de Operação

• Tipos de Negociação

• Detalhe do Produto

• Busca de Produto

• Adicionar ao Carrinho

• Alterar Quantidade no Carrinho

• Obter Itens do Carrinho