A finalidade deste método é possibilitar a consulta das categorias dos produtos.
GET [URLAPI]/SMProdutosAPI/api/v4/produtos/categorias-produtos
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
Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.
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 | string | Não há |
modelo.idCategoria | Código sequencial do cadastro de categoria. | Integer | Não há |
modelo.tipoCategoria | Tipo de classificação categoria (M – Mix de loja, L – Lista Preço ou C – Consumidor). Padrão: M – Mix. | string | Não há |
modelo.somenteAceitaFamilia | Filtro para retornar somente categorias do último nível (S – Sim ou N – Não) | string | 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.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 | stringNão há | 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.nivelHierarquia | Nível da hierarquia. | Long | Não há |
modelo._pageNo | Integer | Não há | |
modelo._pageSize | Integer | Não há | |
modelo.StatusCategoria | A = Somente ativas, I = Somente Inativas e T = Todos | string | Não há |
Não há.
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
NroDivisao | Número da Divisão da categoria | Integer | Não há |
IdCategoria | Código sequencial do cadastro de categoria | Integer | Não há |
DescricaoCategoria | Descrição da categoria | String | Não há |
NivelHierarquia | Número do nível de hierarquia da categoria | Integer | Não há |
SomenteAceitaFamilia | Indicada se é categoria do último nível (S – Sim, N – Não) | String | Não há |
IdCategoriaPai | Código sequencial do cadastro de categoria pai | Integer | Não há |
CaminhoCompleto | Caminho completo da categoria retornada | String | Não há |
Status | Status da categoria (A – Ativa, I – Inativa) | String | 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á |
application/json, text/json
...