Componente Sankhya - Itens do Pedido – Sankhya Gestão de Negócios

O componente Itens do Pedido é utilizado para consultar os produtos de um pedido de venda registrado na base Sankhya, retornando informações detalhadas sobre quantidade, preço, controle de estoque, logística e informações comerciais.

bot-server: versão 1.4.0

bot-component-service: versão 1.0.0

Doc Sankhya: https://developer.sankhya.com.br/docs/operacoes-comerciais#tgfite

Captura de Tela 2026-02-11 às 16.41.23.png

Permite ações como:

Apresentar os produtos comprados pelo cliente
Validar pendências de entrega e conferência
Apoiar processos de pós-venda, reenvio ou SAC
Criar automações baseadas em produtos adquiridos

Interface do componente (tela)
Estrutura do retorno
Mapeamento técnico
Tratamento de erros
Boas práticas
Segurança
Retorno de erro

Interface do componente (tela)

Parâmetros

Campo	Descrição
Código do pedido* (`{{numPedido}}`)	Número único do pedido no Sankhya. Obrigatório para buscar os itens relacionados.

Observação: o valor desta variável normalmente vem da consulta anterior no componente de Obter Pedidos.

Armazenamento

Campo	Descrição
Variável de armazenamento	Nome da variável onde o retorno será salvo. Exemplo: `itensPedido`
Variável de escopo global	Quando ativada, a variável estará disponível em todo o fluxo. Ideal para reutilização em etapas posteriores.

Estrutura do retorno

Exemplo de resposta

{
  "hasMore": false,
  "size": 1,
  "content": [
    {
      "orderCode": 3721165,
      "sequence": 1,
      "pending": true,
      "unitPrice": 4.7,
      "total": 235,
      "discount": {
        "value": 0,
        "percent": 0
      },
      "company": {
        "code": 1,
        "tradeName": "EMPRESA EXEMPLO"
      },
      "quantities": {
        "ordered": 50,
        "delivered": 0,
        "checked": 0
      },
      "product": {
        "code": 1185,
        "reference": "9XXXX",
        "control": "VARIANTE_EXEMPLO",
        "description": "PRODUTO EXEMPLO",
        "group": {
          "code": 0
        },
        "brand": {
          "code": 242,
          "name": "MARCA EXEMPLO"
        }
      },
      "logistics": {
        "unit": {
          "code": "UN",
          "description": "Unidade"
        },
        "originLocation": {
          "code": 8000,
          "description": "LOCAL EXEMPLO"
        }
      },
      "commercial": {
        "seller": {
          "code": 0,
          "nickname": ""
        },
        "notes": null
      }
    }
  ],
  "error": null
}

Mapeamento técnico

JSON	Campo Sankhya	Tabela
orderCode	NUNOTA	TGFITE
sequence	SEQUENCIA	TGFITE
pending	PENDENTE	TGFITE
unitPrice	VLRUNIT	TGFITE
total	VLRTOT	TGFITE
discount.value	VLRDESC	TGFITE
discount.percent	PERCDESC	TGFITE
company.code	CODEMP	TGFITE
company.tradeName	NOMEFANTASIA (via CODEMP)	TSIEMP
quantities.ordered	QTDNEG	TGFITE
quantities.delivered	QTDENTREGUE	TGFITE
quantities.checked	QTDCONFERIDA	TGFITE
product.code	CODPROD	TGFITE
product.reference	REFERENCIA	TGFPRO
product.control	CONTROLE	TGFITE
product.description	DESCRPROD	TGFPRO
product.group.code	CODGRUPOPROD	TGFPRO
product.brand.code	CODMARCA	TGFPRO
product.brand.name	MARCA	TGFPRO
logistics.unit.code	CODVOL	TGFITE
logistics.unit.description	DESCRVOL (via CODVOL)	TGFVOL
originLocation.code	CODLOCALORIG	TGFITE
originLocation.description	DESCRLOCAL	TGFLOC
seller.code	CODVEND	TGFITE
seller.nickname	APELIDO	TGFVEN
commercial.notes	OBSERVACAO	TGFITE

Tratamento de erros

Situação	Comportamento Esperado
Pedido não existe ou inválido	content = [], ac:local-id="8fa3020a-533e-4751-ba89-a572664b035f">	Falha na requisição	error preenchido
Pedido sem itens	content vazio

Boas práticas

Validar o número do pedido antes da chamada
Iterar sobre content para múltiplos itens
Utilizar escopo global quando itens forem reutilizados em diferentes blocos
Tratar pending, quantities, discounts e notes para controle mais preciso

Segurança

Requisições autenticadas
Acesso condicionado às permissões da API
Utilização segura em fluxos de atendimento e automação

Retorno de erro

Itens do pedido com número do pedido inválido
Quando o número do pedido é informado em formato inválido (não numérico), a integração falha na conversão e a API retorna content e size como null, com o objeto error detalhando o motivo.

{
  "scenario": "Itens do Pedido com número do pedido inválido",
  "input": {
    "orderCode": "aaaaa"
  },
  "response": {
    "hasMore": false,
    "size": null,
    "content": null,
    "error": {
      "code": "SANKHYA_INTEGRATION_FAILED",
      "message": "Erro de conversão para número: aaaaa"
    }
  }
}

Esse artigo foi útil?

Usuários que acharam isso útil: 0 de 0

Pesquisa

Componente Sankhya - Itens do Pedido