Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

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

Chamada

GET /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)
codigoAcessoCódigos de acessos associados ao produto (GTIN, Interno, Fornecedor)stringNão há
descricaoProdutoDescrição cadastrada para o produtostringNão há
familiaDescrição da família do produtostringNão há
dataAtualizacaoData da ultima atualização Formato: YYYY-MM-DDThh:mm:ssstringNão há
idFamiliaCódigo sequencial do cadastro de família do produtoIntegerNão há
idProdutoCódigo sequencial do cadastro do produtoIntegerNão há
idFornecedorCódigo sequencial do cadastro de fornecedorIntegerNão há
_pageNo
IntegerNão há
_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 
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"
}