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 a dados cadastrais básicos de produtos por empresas.

Chamada

GET /api/v4/produtos/produtos-empresa

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á
descricaoFamiliaDescriçã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)
NumeroEmpresaNúmero da empresaIntegerNão há
UFEmpresaUF da empresaStringNão há
NumeroDivisaoNúmero da divisão da empresaIntegerNão há
EmbalagemVendaEmbalagem padrão de venda (caixa fechada)StringNão há
QtdeEmbVendaQuantidade da embalagem padrão de compra

number <double>

Não há
EmbalagemCompraEmbalagem padrão de compra (caixa fechada)StringNão há
QtdeEmbCompraQuantidade da embalagem padrão de compra

number <double>

Não há
StatusCompraStatus de compra do produto na empresa (ativo, inativo ou suspenso)StringNão há
StatusVendaStatus de venda do produto na empresa (ativo, inativo)StringNão há
CompradorApelido do compradorStringNã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):

{
  "NumeroEmpresa": 0,
  "UFEmpresa": "string",
  "NumeroDivisao": 0,
  "EmbalagemVenda": "string",
  "QtdeEmbVenda": 0,
  "EmbalagemCompra": "string",
  "QtdeEmbCompra": 0,
  "StatusCompra": "string",
  "StatusVenda": "string",
  "Comprador": "string",
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}