Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método de consulta de preços por embalagens

Chamada

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

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

Parâmetros URI (URI Parameters)

NomeDescriçãoTipoExigência
CNPJ EmpresaCNPJ da empresa utilizada como filtro de informações dos preços de vendaintegerOpcional
Número EmpresaNúmero de Empresa para filtrar os preços de vendastringOpcional
SegmentoNúmero do segmento de venda para filtrar os preços de venda. Quando não informado,
considera-se o segmento principal da empresa.		longOpcional
Status de VendaFiltro de retorno dos produtos: A = ativo (retorna apenas produtos ativos para venda), I = inativo
(retorna apenas produtos inativos para venda), S = suspenso (retorna apenas produtos suspensos
para venda), T = todos (Retorna todos os produtos). Padrão: A		stringOpcional
Código de AcessoCódigos de acessos associados ao produto (GTIN, Interno, Fornecedor)stringOpcional
Data AtualizaçãoData da última atualização do preço de venda (data de validação de preço)stringOpcional
Sequencial FamíliaCódigo sequencial do cadastro de família do produtolongOpcional
Sequencial ProdutoCódigo sequencial do cadastro do produtolongOpcional
Sequencial FornecedorCódigo sequencial do cadastro de fornecedorlongOpcional
_pageNoPáginaintegerNão há
_pageSizeTamanho da PáginaintegerNão há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

NomeDescriçãoOrigem
Código AcessoCódigo de acesso utilizado para vendaCadastro de Produtos > aba Códigos > Código (quando
indicador “Util p/ Venda” selecionado)
Sequencial ProdutoCódigo sequencial do cadastro do produtoCadastro de Produtos > aba Geral > Codigo
Sequencial FamíliaCódigo sequencial do cadastro da família do produtoCadastro de Produtos > aba Geral > Família
Sequencial Prod. BaseCódigo sequencial do cadastro do produto baseCadastro de Produtos > aba Geral > Produto Base
Número EmpresaNúmero da empresaCadastro de Produtos > aba Empresa/Segmento >
Empresa (número que corresponde ao nome reduzido
exibido)
SegmentoNúmero do segmento de vendaCadastro de Produtos > aba Empresa/Segmento >
Segmento (número que corresponde à descrição do
segmento exibido)
EmbalagemEmbalagem do preço de vendaCadastro de Produtos > aba Empresa/Segmento > Emb
Preço de VendaPreço de venda correspondente à embalagemCadastro de Produtos > aba Empresa/Segmento > Preço
Venda
StatusStatus de venda da embalagem do produtoCadastro de Produtos > aba Empresa/Segmento > Ativo
Venda
Data AtualizaçãoData da última atualização do preço (data de validação)Interno banco dados
[
  {
    "CodigoAcesso": "string",
    "IdProduto": 0,
    "DescricaoProduto": "string",
    "IdFamilia": 0,
    "IdProdutoBase": 0,
    "NumeroEmpresa": 0,
    "NumeroSegmento": 0,
    "Embalagem": 0,
    "PrecoVenda": 0,
    "StatusVenda": "string",
    "DataUltimaAtualizacao": "2022-01-17T18:53:53.843Z"
  }
]