Exibir origem

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)
codigoAcesso	Códigos de acessos associados ao produto (GTIN, Interno, Fornecedor)	string	Quando 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).
descricaoProduto	Descrição cadastrada para o produto	string	Não há
familia	Descrição da família do produto	string	Não há
dataAtualizacao	Data da ultima atualização Formato: YYYY-MM-DDThh:mm:ss	string	Não há
idFamilia	Código sequencial do cadastro de família do produto	Integer	Não há
idProduto	Código sequencial do cadastro do produto	Integer	Não há
idFornecedor	Código sequencial do cadastro de fornecedor	Integer	Quando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F).
_pageNo		Integer	Não há
_pageSize		Integer	Nã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)
ProdutosSimilares	Lista de Produtos	Array of objects (ProdutosSimilaresPorProdutosRespostaDTO)	Não há
IdProdutoSimilar	Código sequencial do cadastro do produto similar	Integer	Pertence ao array ProdutosSimilares
DescricaoSimilar	Descrição cadastrada para o produto similar	String	Pertence ao array ProdutosSimilares
Similaridade	Descrição da similaridade	String	Pertence ao array ProdutosSimilares
CodigoAcessoPrincipal	Código de acesso principal	String	Não há
IdProduto	Código sequencial do cadastro do produto	Integer	Não há
IdFamilia	Código sequencial do cadastro da família do produto	Integer	Não há
IdProdutoBase	Código sequencial do cadastro do produto base	Integer	Não há
DataUltimaAtualizacao	Data da ultima atualização	String	Nã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"
}