v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB
Sugestões de Vendas

Consulta por Itens da cesta

Recebe a cesta de produtos do cliente via query params e retorna recomendações de produtos complementares ordenadas por relevância (score DESC, codigoProduto ASC). Produtos já presentes na cesta e produtos inativos são excluídos automaticamente dos resultados. O parâmetro codigoProduto pode ser repetido para informar múltiplos produtos; controle é alinhado por posição com codigoProduto.

Versão mínima do SankhyaOm: 4.36

get/v1/vendas/recomendacoes/market-basket

Query parameters

codigoProdutointeger[] required

Código(s) de produto presentes na cesta (TGFPRO.CODPROD). Repita o parâmetro para informar múltiplos produtos. Mínimo: 1. Máximo: 200.

controlestring[]

Controle de grade/lote (TGFPRO.CONTROLE), alinhado por posição com codigoProduto. Omita o parâmetro ou envie vazio para produtos sem controle de grade.

maxSuggestionsinteger

Número máximo de sugestões a retornar no total (limite global, aplicado antes da paginação). Padrão configurável via Dynamic Config; máximo: 50.

pageSizeinteger

Quantidade de itens por página. Padrão: 20. Máximo: 100.

pageNumberinteger

Número da página desejada (1-indexed). Padrão: 1.

codigoTipoOperacaointeger

Código do Tipo de Operação (TGFTOP.CODTOP). Quando informado, produtos sem estoque compatível com o TOP são despriorizados nos resultados.

codigoNotainteger

Código da nota (TGFCAB.NUNOTA). Quando informado, os itens já presentes na nota são excluídos das recomendações.

Response

Operação bem sucedida

requestIdstring uuid

Identificador único da requisição (para rastreabilidade em logs)

identificadorExecucaointeger

Identificador da execução de pré-processamento que originou as regras utilizadas

Example response

{
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "identificadorExecucao": 42,
  "itensRecomendados": [
    {
      "codigoProduto": 2001,
      "controle": " ",
      "descricaoProduto": "PRODUTO RECOMENDADO A",
      "tituloControle": "Grade",
      "textoSugestao": "Frequentemente comprado junto",
      "score": 3.8,
      "rank": 1,
      "produtosBase": [
        {
          "codigoProdutoBase": 1001,
          "controleBase": " ",
          "descricaoProdutoBase": "PRODUTO BASE X",
          "score": 1.5
        }
      ]
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 20,
    "totalItems": 2,
    "totalPages": 1
  }
}