v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Sugestões de Vendas

Consulta por Perfil do cliente

Recebe o código do parceiro via query param e retorna recomendações de produtos baseadas no perfil de compra do agrupador ao qual o parceiro pertence. Quando não há agrupador vigente ou não há ranking calculado, retorna temRecomendacao false com o motivo da ausência.

Versão mínima do SankhyaOm: 4.36

get/v1/vendas/recomendacoes/perfil-cliente

Query parameters

codigoParceirointeger required

Código do parceiro (TGFPAR.CODPARC)

Response

Operação bem sucedida

codigoParceirointeger

Código do parceiro consultado

nivelAgrupadorstring nullable

Nível do agrupador vigente do parceiro (ex. 'CNAE', 'SEGMENTO')

valorAgrupadorstring nullable

Valor do agrupador vigente (ex. o código CNAE do parceiro)

identificadorExecucaointeger nullable

Identificador da execução de pré-processamento que originou o ranking utilizado

temRecomendacaoboolean

Indica se há recomendações disponíveis para o parceiro

motivoAusenciastring nullable

Motivo pelo qual não há recomendações. Presente apenas quando temRecomendacao é false. Valores possíveis: PARCEIRO_SEM_AGRUPADOR, SEM_RANKING_VIGENTE.

Example response

{
  "codigoParceiro": 123,
  "nivelAgrupador": "CNAE",
  "valorAgrupador": "4711-3/02",
  "identificadorExecucao": 42,
  "temRecomendacao": true,
  "itensRecomendados": [
    {
      "codigoProduto": 2001,
      "controle": " ",
      "descricaoProduto": "PRODUTO RECOMENDADO",
      "rank": 1,
      "frequencia": 0.85,
      "cobertura": 0.6,
      "volume": 120
    }
  ]
}