Produto | Estoque Produtos (Consultar) - GET

Objetivo

A finalidade deste método é possibilitar a consulta informações de estoques dos produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/estoque-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 Atenção! É recomendado utilizar o filtro de CNPJ ao realizar requisições para esta API.	string	Obrigatório
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.indicaUsaAFV	Indica se usa AFV	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	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)
NroEmpresa	Número da empresa	Integer	Não há
DataUltimaEntrada	Data da última movimentação de entrada	string	Não há
DataUltimaCompra	Data da última movimentação de compra	string	Não há
DataMovimentacao	Data da última movimentação de estoque	string	Não há
EstoqueMinimo	Quantidade de estoque mínimo na loja	number	Não há
EstoqueMaximo	Quantidade de estoque máximo na loja	number	Não há
EstoqueDisponivel	Quantidade disponível de estoque	number	Não há
QtdPendCompras	Quantidade pendente de pedidos de compra a receber	number	Não há
QtdReservaReceb	Quantidade reservada de recebimentos pendentes	number	Não há
QtdReservaVendas	Quantidade reservada para Vendas	number	Não há
QtdReservaVendaWeb	Quantidade reservada para Vendas da Web	number	Não há
QtdPendExpedicao	Quantidade pendente de pedidos de transferência a expedir	number	Não há
EstoqueDeposito	Quantidade de estoque em locais do tipo Depósito	number	Não há
EstoqueLoja	Quantidade de estoque em locais do tipo loja	number	Não há
EstoqueTrocaAvaria	Quantidade de estoque em locais do tipo Troca	number	Não há
EstoqueOutros	Quantidade de estoque em locais do tipo Outros	number	Não há
EstoqueAlmoxarifado	Quantidade de estoque em locais do tipo almoxarifado	number	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á

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
  "NroEmpresa": 0,
  "DataUltimaEntrada": "2020-06-30T11:53:05Z",
  "DataUltimaCompra": "2020-06-30T11:53:05Z",
  "DataMovimentacao": "2020-06-30T11:53:05Z",
  "EstoqueMinimo": 0,
  "EstoqueMaximo": 0,
  "EstoqueDisponivel": 0,
  "QtdPendCompras": 0,
  "QtdReservaReceb": 0,
  "QtdReservaVendas": 0,
  "QtdReservaVendaWeb": 0,
  "QtdPendExpedicao": 0,
  "EstoqueDeposito": 0,
  "EstoqueLoja": 0,
  "EstoqueTrocaAvaria": 0,
  "EstoqueOutros": 0,
  "EstoqueAlmoxarifado": 0,
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}

Árvore de páginas