For the complete documentation index, see llms.txt. This page is also available as Markdown.

Listar Departamentos

Retorna a listagem de departamentos da loja, com suporte a filtro por status e paginação.

GET /departamentos/

🔎 Filtros disponíveis

Os filtros são enviados na Query da requisição. Todos são opcionais e podem ser combinados.

Parâmetro
Tipo
Descrição

Status

texto

Filtra pelo status: A (Ativado) ou D (Desativado)

Pagina

inteiro

Página desejada (paginação)

QtdPorPagina

inteiro

Registros por página (máx. 100)

📥 Exemplo de requisição

Buscando departamentos ativos, 50 por página:

curl -X GET "https://api.toplojas.com.br/departamentos/?Status=A&QtdPorPagina=50" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"

📤 Exemplo de resposta

A resposta segue o padrão de paginação (Dados + Paginacao):

{
  "Dados": [
    {
      "Codigo": 41360,
      "Status": "A",
      "Nome": "Livros 2",
      "Pai": {
        "Codigo": 0,
        "Nome": ""
      }
    }
  ],
  "Paginacao": {
    "PaginaAtual": 1,
    "QtdPaginas": 1,
    "QtdRegistros": 6
  }
}

📋 Campos retornados

Campo
Tipo
Descrição

Codigo

inteiro

Código do departamento

Status

texto

Status do departamento: A (Ativado) ou D (Desativado)

Nome

texto

Nome do departamento

Pai.Codigo

inteiro

Código do departamento pai (0 = departamento raiz)

Pai.Nome

texto

Nome do departamento pai (vazio quando não há pai)

Consulte a descrição de cada campo na referência:

Para entender o funcionamento da paginação, veja:

Paginação

Last updated