Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta das categorias dos produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/categorias-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.CNPJEmpresaCNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000stringNão há
modelo.idCategoriaCódigo sequencial do cadastro de categoria.IntegerNão há
modelo.tipoCategoriaTipo de classificação categoria (M – Mix de loja, L – Lista Preço ou C – Consumidor). Padrão: M – Mix.stringNão há
modelo.somenteAceitaFamiliaFiltro para retornar somente categorias do último nível (S – Sim ou N – Não)stringNão há
modelo.codigoAcessoCó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.descricaoProdutoDescrição cadastrada para o produtostringNão há
modelo.familiaDescrição da família do produtostringNão há
modelo.dataAtualizacaoData da ultima atualização Formato: YYYY-MM-DDThh:mm:ssstringQuando informada a dataAtualizacao serão filtrados os registros que tiveram alteração a partir desta data.
modelo.idFamiliaCódigo sequencial do cadastro de família do produtoIntegerNão há
modelo.idProdutoCódigo sequencial do cadastro do produtoIntegerNão há
modelo.idFornecedorCódigo sequencial do cadastro de fornecedorIntegerQuando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F).
modelo.nivelHierarquiaNível da hierarquia.LongNão há
modelo._pageNo
IntegerNão há
modelo._pageSize
IntegerNão há
modelo.StatusCategoriaA = Somente ativas, I = Somente Inativas e T = TodosstringNã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)
NroDivisaoNúmero da Divisão da categoriaIntegerNão há
IdCategoriaCódigo sequencial do cadastro de categoriaIntegerNão há
DescricaoCategoriaDescrição da categoriaStringNão há
NivelHierarquiaNúmero do nível de hierarquia da categoriaIntegerNão há
SomenteAceitaFamiliaIndicada se é categoria do último nível (S – Sim, N – Não)StringNão há
IdCategoriaPaiCódigo sequencial do cadastro de categoria paiIntegerNão há
CaminhoCompletoCaminho completo da categoria retornadaStringNão há
StatusStatus da categoria (A – Ativa, I – Inativa)StringNã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):

{
  "NroDivisao": 0,
  "IdCategoria": 0,
  "DescricaoCategoria": "string",
  "NivelHierarquia": 0,
  "SomenteAceitaFamilia": "string",
  "IdCategoriaPai": 0,
  "CaminhoCompleto": "string",
  "Status": "string",
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}