Consultar Classificação 1 de almoxarifados

Retorna o catálogo (paginado) de Classificação 1 de almoxarifados habilitadas da empresa do caller, com filtro opcional por id.

Add-on necessário

Uso geral — sem add-on específico.

GET https://app.fracttal.com/api/warehouses_groups_1

Parâmetros de entrada — Obrigatórios

Nenhum.

Parâmetros de entrada — Opcionais

Enviados como query params.

ParâmetroTipoObrigatórioDescrição
idbigintNãoFiltra pelo id de uma classificação específica.
only_enabledbooleanNãoSe enviado como false, também inclui as classificações desabilitadas. Por padrão, só traz enabled = true.
startinteiroNãoOffset de paginação. Padrão 0.
limitinteiroNãoTamanho da página. Padrão 100, limite máximo 100 por página.

Parâmetros de saída

ParâmetroTipoDescrição
successbooleanotrue se a consulta foi bem-sucedida.
messagetexto"200" em sucesso; código/mensagem de erro caso contrário.
dataarrayLista de classificações { id, id_company, description, enabled }.
totalinteiroQuantidade total de classificações que correspondem ao filtro na empresa — não o tamanho da página retornada. Usar para calcular o número de páginas.

Erros

CódigoCausa
401Token inválido ou ausente.
500Erro interno não tratado.

Ausência de resultados não é erro

Se a empresa não possui classificações (ou o filtro não corresponde a nada), a resposta é success=true, total=0, data=null — não é um erro.


Exemplo

Request

GET https://app.fracttal.com/api/warehouses_groups_1?id=744

Response 200

{
  "success": true,
  "message": "200",
  "data": [
    { "id": 744, "id_company": 4344, "description": "Acessórios", "enabled": true }
  ],
  "total": 1
}

Response — catálogo completo, sem filtros (200)

{
  "success": true,
  "message": "200",
  "data": [
    { "id": 744, "id_company": 4344, "description": "Acessórios", "enabled": true },
    { "id": 745, "id_company": 4344, "description": "Consumíveis", "enabled": true }
  ],
  "total": 7
}
Response
200
Language
LoadingLoading…