Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta das embalagens cadastradas dos produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/embalagens-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.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.descricaoProdutoDescrição cadastrada para o 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.somenteInativosTraz somente os códigos de acesso inativos. Se não informado, traz somente os código de acesso ativos. Valores: S – Traz somente os inativos; N – Traz somente os ativosStringAtenção! Se informado ‘S’ o unico outro parametro aceito será [DataAtualizacao].
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)
EmbalagensLista de principios ativosArray of objects (EmbalagensProdPorProdutosRespostaDTO)Não há
EmbalagemDescrição da embalagemStringPertence ao array Embalagens
QtdEmbalagemQuantidade da embalagemNumberPertence ao array Embalagens
StatusStatus da embalagem. A = Ativo; I = Inativo.StringPertence ao array Embalagens
PesoBrutoPeso bruto da embalagem, em quilos (3 casas dec.)NumberPertence ao array Embalagens
PesoLiquidoPeso líquido da embalagem, em quilos (3 casas dec.)NumberPertence ao array Embalagens
AlturaAltura da embalagem, em centímetrosNumberPertence ao array Embalagens
LarguraLargura da embalagem, em centímetrosNumberPertence ao array Embalagens
ProfundidadeProfundidade da embalagem, em centímetrosNumberPertence ao array Embalagens
CodigoAcessoCodigo de acesso cadastrado para essa embalagem no produtoStringPertence ao array Embalagens
DataExclusaoData da exclusão da embalagem na familiaStringPertence 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):

{
  "Embalagens": [
    {
      "Embalagem": "string",
      "QtdEmbalagem": 0,
      "Status": "string",
      "PesoBruto": 0,
      "PesoLiquido": 0,
      "Altura": 0,
      "Largura": 0,
      "Profundidade": 0,
      "CodigoAcesso": "string",
      "DataExclusao": "2020-06-30T11:53:05Z"
    }
  ],
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}