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 informações de estoques dos produtos.

Chamada

GET /api/v4/produtos/estoque-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: 00000000000000 Atenção! É recomendado utilizar o filtro de CNPJ ao realizar requisições para esta API.stringObrigatório
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á
familiaDescrição da família do 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)
NroEmpresaNúmero da empresaIntegerNão há
DataUltimaEntradaData da última movimentação de entradastringNão há
DataUltimaCompraData da última movimentação de comprastringNão há
DataMovimentacaoData da última movimentação de estoquestringNão há
EstoqueMinimoQuantidade de estoque mínimo na lojanumberNão há
EstoqueMaximoQuantidade de estoque máximo na lojanumberNão há
EstoqueDisponivelQuantidade disponível de estoquenumberNão há
QtdPendComprasQuantidade pendente de pedidos de compra a recebernumberNão há
QtdReservaRecebQuantidade reservada de recebimentos pendentesnumberNão há
QtdReservaVendasQuantidade reservada para VendasnumberNão há
QtdReservaVendaWebQuantidade reservada para Vendas da WebnumberNão há
QtdPendExpedicaoQuantidade pendente de pedidos de transferência a expedirnumberNão há
EstoqueDepositoQuantidade de estoque em locais do tipo DepósitonumberNão há
EstoqueLojaQuantidade de estoque em locais do tipo lojanumberNão há
EstoqueTrocaAvariaQuantidade de estoque em locais do tipo TrocanumberNão há
EstoqueOutrosQuantidade de estoque em locais do tipo OutrosnumberNão há
EstoqueAlmoxarifadoQuantidade de estoque em locais do tipo almoxarifadonumberNão há
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):

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