apiDocumentaçãoOperaçõesapiDocumentaçãoOperaçõesListarProdutosResumidoconsultaLista os produtos cadastrados
| Operação | geral/produtos:ListarProdutosResumido |
|---|---|
| Serviço | ProdutosCadastro |
| Módulo | Geral |
| Endpoint | /api/v1/geral/produtos/ |
listar produtos resumidos
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | string | Exibir apenas os registros gerados pela API. Preenchimento Opcional. Preencher com "S" ou "N". |
caracteristicas | lista de object | Filtro por caracteristicas. Preenchimento Opcional. |
ean | string | Código EAN (GTIN - Global Trade Item Number). Preenchimento Opcional. |
exibir_caracteristicas | string | Exibir as características do produto (S/N). Preenchimento Opcional. Preencher com "S" ou "N". |
exibir_info_variacoes | lista de string | Opcional. Indica se deve retornar informações sobre as variações de produto. Preencher com S/N. Disponível apenas para o método ListarProdutos. |
exibir_kit | string | Exibir os componentes do KIT (S/N). Preenchimento Opcional. Preencher com "S" ou "N". |
exibir_obs | string | Exibir as observações do produto (S/N). Preenchimento Opcional. Preencher com "S" ou "N". |
exibir_tabelas_preco | string | Exibir as tabelas de preço do produto (S/N). Preenchimento Opcional. Preencher com "S" ou "N". |
filtrar_apenas_alteracao | string | Filtrar apenas os registros alterados (S/N). Preenchimento Opcional. Preencher com "S" ou "N". |
filtrar_apenas_descricao | string | Filtro pela descrição do produto. Preenchimento Opcional. Para filtrar utilize: "TEXTO" - Para pesquisa exata. "TEXTO%" - Para pesquisa começando com. "%TEXTO" - Para pesquisa terminando com. "%TEXTO%" - Para pesquisa contendo. |
filtrar_apenas_familia | string | Filtrar por ID da Familia de Produto. Preenchimento Opcional. |
filtrar_apenas_inclusao | string | Filtrar apenas os registros incluídos (S/N). Preenchimento Opcional. Preencher com "S" ou "N". |
filtrar_apenas_marketplace | string | Filtrar apenas produtos marcados para venda via Market Place ou e-Commerce. Preenchimento Opcional. Preencher com "S" ou "N". |
filtrar_apenas_omiepdv obrigatório | string | Filtrar apenas produtos marcados para venda via PDV. ATENÇÃO: Todos os PDVs integrados devem preencher esse campo com "S". O preenchimento desse campo é obrigatório e o seu padrão é "S". Quando preenchido como "S" filtra apenas o produtos que tenham configuração de impostos definidas para o PDV. Preenchimento Obrigatório. Preencher com "S" ou "N". |
filtrar_apenas_pdv | string | Filtrar apenas produtos marcados para venda via Ponto de Venda (PDV). Preenchimento Opcional. Preencher com "S" ou "N". |
filtrar_apenas_tipo | string | Código do Tipo do Item para o SPED. Preenchimento Opcional. Pode ser: 00 - Mercadoria para Revenda 01 - Matéria Prima 02 - Embalagem 03 - Produto em Processo 04 - Produto Acabado 05 - Subproduto 06 - Produto Intermediário 07 - Material de Uso e Consumo 08 - Ativo Imobilizado 09 - Serviços 10 - Outros Insumos 99 - Outras |
filtrar_por_data_ate | string | Filtrar os registros até uma data. Preenchimento Opcional. Formato: "dd/mm/aaaa" |
filtrar_por_data_de | string | Filtrar os registros a partir de uma data. Preenchimento Opcional. Formato: "dd/mm/aaaa" |
filtrar_por_hora_ate | string | Filtrar até a hora. Preenchimento Opcional. Formato: "hh:mm:ss" |
filtrar_por_hora_de | string | Filtrar a partir da hora. Preenchimento Opcional. Formato: "hh:mm:ss" |
inativo | string | Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração. |
ncm | string | Código da Nomenclatura Comum do Mercosul (NCM). Preenchimento Obrigatório na Inclusão. |
ordem_decrescente | string | Se a lista será apresentada em ordem decrescente (S/N). Preenchimento Opcional. Preencher com "S" ou "N". |
ordem_descrescente | string | DEPRECATED. |
ordenar_por | string | Ordem de exibição dos dados. Padrão: Código. |
pagina | integer | Número da página para resgatar os dados. Default 1. |
produtosPorCodigo | lista de object | Filtro por código do produto. Preenchimento Opcional. |
registros_por_pagina | integer | Número de registros a serem exibidos por página. Máximo 500. Default 50. |
{
"pagina": 1,
"registros_por_pagina": 50,
"apenas_importado_api": "N",
"filtrar_apenas_omiepdv": "N"
}