Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta de preços dos produtos.

Chamada

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

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.nroEmpresaParâmetro para filtrar o número da empresa.IntegerNão há
modelo.CNPJEmpresaCNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000stringNão há
modelo.numeroSegmentoNúmero do segmento de venda específico para busca de algumas informações. Quando não informado, considera-se o segmento principal da empresa.IntegerNão há
modelo.statusVendaFiltro de retorno dos produtos: A = ativo (devolve apenas produtos ativos para venda), I = inativo (devolve apenas produtos inativos para venda), S = suspenso (devolve apenas produtos suspensos para venda), T = todos (Retorna todos os produtos). Padrão: A.stringNão há
modelo.idCategoriaCódigo sequencial do cadastro de categoria.IntegerNão há
modelo.codigoAcessoCó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).

modelo.indicaUsaAFVIndica se a empresa utiliza AFV: S - Utiliza AFV, N - Não utiliza AFVstringNão há
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)
NroEmpresaNúmero da empresaIntegerNão há
DescCompletaDescrição completa do produtostringNão há
NumeroSegmentoNúmero do segmento de vendaIntegerNão há
PrecoVendaPreço de venda da embalagem padrãoNumberNão há
EmbalagemEmbalagem do preço de vendaNumberNão há
PrecoVendaCaixaPreço de venda da caixaNumberNão há
QuantidadeCaixaQuantidade de produto na caixaNumberNão há
DataInicioPromocaoData inicial da promoção vinculada ao produtoStringNão há
DataFimPromocaoData final da promoção vinculada ao produtoStringNão há
PrecoPromocaoPreço promocional do produtoNumberNão há
PromocaoAPartirLista de promoções de quantidade a partir de valor x.Array of objects (PromocaoProdutosRespostaDTO)Não há
QuantidadeAPartirDeQuantidade necessária para aplicar preço especialNumberNão há
PrecoAPartirDePreço aplicado quando se vende uma quantidade necessária para aplicar preço especialNumber
DataAtualizacaoData da atualização do preçoStringNão há
StatusVendaStatus de venda do produto na empresa/segmento (A = ativo,I = inativo)StringNão há
ClassificacaoComercialClassificação ComercialStringNão há
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):

[
  {
    "NumeroEmpresa": 0,
    "DescCompleta": "string",
    "NumeroSegmento": 0,
    "PrecoVenda": 0,
    "Embalagem": 0,
    "PrecoVendaCaixa": 0,
    "QuantidadeCaixa": 0,
    "DataInicioPromocao": "2021-05-17T12:02:52.145Z",
    "DataFimPromocao": "2021-05-17T12:02:52.145Z",
    "PrecoPromocao": 0,
    "PromocaoAPartir": [
      {
        "QuantidadeAPartirDe": 0,
        "PrecoAPartirDe": 0
      }
    ],
    "DataAtualizacao": "2021-05-17T12:02:52.145Z",
    "StatusVenda": "string",
    "ClassificacaoComercial": "string",
    "CodigoAcessoPrincipal": "string",
    "IdProduto": 0,
    "IdFamilia": 0,
    "IdProdutoBase": 0,
    "DataUltimaAtualizacao": "2021-05-17T12:02:52.145Z"
  }
]