Produto | Embalagens Venda Produtos (Consultar) - GET

Objetivo

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

Chamada

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

Permissionamento

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

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

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.CNPJEmpresa	CNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000	string	Não há
modelo.segmento	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.indicaUsaAFV	Indica se usa AFV	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.descricaoProduto	Descrição cadastrada para o produto	string	Não há
modelo.dataAtualizacao	Data da ultima atualização Formato: YYYY-MM-DDThh:mm:ss	string	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	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á

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)
NumeroEmpresa	Número da empresa	Integer	Não há
Embalagens	Lista de Embalagens	Array of objects (EmbVendaPorProdutosRespostaDTO)	Não há
NumeroSegmento	Número do segmento da empresa	Integer	Pertence ao array Embalagens
Embalagem	Descrição de Embalagem	String	Pertence ao array Embalagens
QtdEmbalagem	Quantidade da embalagem	Number	Pertence ao array Embalagens
Status	Status da embalagem.A = Ativo; I = Inativo.	String	Pertence ao array Embalagens
CodigoAcesso	Código de acesso cadastrado para embalagem no produto	String	Pertence ao array Embalagens
PrecoVendaNormal	Preço de venda normal atual	Number	Pertence ao array Embalagens
PrecoVendaPromocao	Preço de venda promocional	Number	Pertence ao array Embalagens
QtdMaxVenda	Quantidade máxima de venda AFV. Converter quantidade unitária para a embalagem em questão.	Number	Pertence ao array Embalagens
DataInicioPromocao	Data inicial da promoção vinculada ao produto	String	Pertence ao array Embalagens
DataFimPromocao	Data final da promoção vinculada ao produto	String	Pertence ao array Embalagens
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):

{
  "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"
}

Árvore de páginas