Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta da similaridade dos produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/produtos-similares

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
modelo.codigoAcessoCódigos de acessos associados ao produto (GTIN, Interno, Fornecedor)stringQuando não informado o IdFornecedor, a busca irá se basear apenas nos tipos de códigos de acesso: EAN, DUN e Interno (E, D e B).
modelo.descricaoProdutoDescrição cadastrada para o produtostringNão há
modelo.familiaDescrição da família do produtostringNão há
modelo.dataAtualizacaoData da ultima atualização Formato: YYYY-MM-DDThh:mm:ssstringQuando informada a dataAtualizacao serão filtrados os registros que tiveram alteração a partir desta data.
modelo.idFamiliaCódigo sequencial do cadastro de família do produtoIntegerNão há
modelo.idProdutoCódigo sequencial do cadastro do produtoIntegerNão há
modelo.idFornecedorCódigo sequencial do cadastro de fornecedorIntegerQuando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F).
modelo._pageNo
IntegerNão há
modelo._pageSize
IntegerNão há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
ProdutosSimilaresLista de ProdutosArray of objects (ProdutosSimilaresPorProdutosRespostaDTO)Não há
IdProdutoSimilarCódigo sequencial do cadastro do produto similarIntegerPertence ao array ProdutosSimilares
DescricaoSimilarDescrição cadastrada para o produto similarStringPertence ao array ProdutosSimilares
SimilaridadeDescrição da similaridadeStringPertence ao array ProdutosSimilares
CodigoAcessoPrincipalCódigo de acesso principalStringNão há
IdProdutoCódigo sequencial do cadastro do produtoIntegerNão há
IdFamiliaCódigo sequencial do cadastro da família do produtoIntegerNão há
IdProdutoBaseCódigo sequencial do cadastro do produto baseIntegerNão há
DataUltimaAtualizacaoData da ultima atualizaçãoStringNão há

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
  "ProdutosSimilares": [
    {
      "IdProdutoSimilar": 0,
      "DescricaoSimilar": "string",
      "Similaridade": "string"
    }
  ],
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}