A finalidade deste método é possibilitar a consulta de preços dos produtos.
GET [URLAPI]/SMProdutosAPI/api/v4/produtos/precos-produtos
Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.
Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Produtos > API Produtos
Imagem 01 - Configurações de Sistemas/Módulos/Aplicações
Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) | |
modelo.nroEmpresa | Parâmetro para filtrar o número da empresa. | Integer | Não há | |
modelo.CNPJEmpresa | CNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000 | string | Não há | |
modelo.numeroSegmento | Número do segmento de venda específico para busca de algumas informações. Quando não informado, considera-se o segmento principal da empresa. | Integer | Não há | |
modelo.statusVenda | Filtro 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. | string | Não há | |
modelo.idCategoria | Código sequencial do cadastro de categoria. | Integer | Não há | |
modelo.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). | |
modelo.indicaUsaAFV | Indica se a empresa utiliza AFV: S - Utiliza AFV, N - Não utiliza AFV | string | Não há | |
modelo.descricaoProduto | Descrição cadastrada para o produto | string | Não há | |
modelo.familia | Descrição da família do produto | string | Não há | |
modelo.dataAtualizacao | Data da ultima atualização Formato: YYYY-MM-DDThh:mm:ss | string | Não há | Quando informada a dataAtualizacao serão filtrados os registros que tiveram alteração a partir desta data. |
modelo.idFamilia | Código sequencial do cadastro de família do produto | Integer | Não há | |
modelo.idProduto | Código sequencial do cadastro do produto | Integer | Não há | |
modelo.idFornecedor | Código sequencial do cadastro de fornecedor | Integer | Não há | Quando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F). |
modelo._pageNo | Integer | Não há | ||
modelo._pageSize | Integer | Não há |
Não há.
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
NroEmpresa | Número da empresa | Integer | Não há |
DescCompleta | Descrição completa do produto | string | Não há |
NumeroSegmento | Número do segmento de venda | Integer | Não há |
PrecoVenda | Preço de venda da embalagem padrão | Number | Não há |
Embalagem | Embalagem do preço de venda | Number | Não há |
PrecoVendaCaixa | Preço de venda da caixa | Number | Não há |
QuantidadeCaixa | Quantidade de produto na caixa | Number | Não há |
DataInicioPromocao | Data inicial da promoção vinculada ao produto | String | Não há |
DataFimPromocao | Data final da promoção vinculada ao produto | String | Não há |
PrecoPromocao | Preço promocional do produto | Number | Não há |
PromocaoAPartir | Lista de promoções de quantidade a partir de valor x. | Array of objects (PromocaoProdutosRespostaDTO) | Não há |
QuantidadeAPartirDe | Quantidade necessária para aplicar preço especial | Number | Não há |
PrecoAPartirDe | Preço aplicado quando se vende uma quantidade necessária para aplicar preço especial | Number | |
DataAtualizacao | Data da atualização do preço | String | Não há |
StatusVenda | Status de venda do produto na empresa/segmento (A = ativo,I = inativo) | String | Não há |
ClassificacaoComercial | Classificação Comercial | String | Não há |
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á |
application/json, text/json
Exemplo (Sample):
Bloco de código | ||
---|---|---|
| ||
[ { "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" } ] |