Home TOTVS Varejo Supermercados

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Dayanne da Silva Paulleti

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Dayanne da Silva Paulleti

Gravado em

Chave

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

Objetivo

A finalidade deste método é possibilitar a consulta das embalagens de vendas dos produtos, por empresa e segmento.

Chamada

GET /api/v4/produtos/embalagens-venda-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)
CNPJEmpresaCNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000stringNão há
segmentoNú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á
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: AstringNão há
idCategoriaCódigo sequencial do cadastro de categoria.IntegerNão há
codigoAcessoCódigos de acessos associados ao produto (GTIN, Interno, Fornecedor)stringNão há
descricaoProdutoDescrição cadastrada para o 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)
NumeroEmpresaNúmero da empresaIntegerNão há
EmbalagensLista de EmbalagensArray
of 
of objects (EmbVendaPorProdutosRespostaDTO)Não há
NumeroSegmentoNúmero do segmento da empresaIntegerPertence ao array Embalagens
EmbalagemDescrição de EmbalagemStringPertence ao array Embalagens
QtdEmbalagem

Quantidade da embalagem

NumberPertence ao array Embalagens
StatusStatus da embalagem.A = Ativo; I = Inativo.StringPertence ao array Embalagens
CodigoAcessoCódigo de acesso cadastrado para embalagem no produtoStringPertence ao array Embalagens
PrecoVendaNormalPreço de venda normal atualNumberPertence ao array Embalagens
PrecoVendaPromocaoPreço de venda promocionalNumberPertence ao array Embalagens
QtdMaxVendaQuantidade máxima de venda AFV. Converter quantidade unitária para a embalagem em questão.NumberPertence ao array Embalagens
DataInicioPromocaoData inicial da promoção vinculada ao produtoStringPertence ao array Embalagens
DataFimPromocaoData final da promoção vinculada ao produtoStringPertence ao array Embalagens
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,
  "Embalagens": [
    {
      "NumeroSegmento": 0,
      "Embalagem": "string",
      "QtdEmbalagem": 0,
      "Status": "string",
      "CodigoAcesso": "string",
      "PrecoVendaNormal": 0,
      "PrecoVendaPromocao": 0,
      "QtdMaxVenda": 0,
      "DataInicioPromocao": "2020-06-30T11:53:05Z",
      "DataFimPromocao": "2020-06-30T11:53:05Z"
    }
  ],
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}