Pular para o conteúdo principal

Grupos

Grupos organizam os insumos em categorias. Cada insumo pertence a um grupo. Corresponde à tela Grupos, do módulo Almoxarifado.

Endpoints​

MétodoCaminhoDescrição
GET/warehouse/groupsLista os grupos
POST/warehouse/groupsCadastra um grupo
PUT/warehouse/groups/{id}Altera um grupo
DELETE/warehouse/groups/{id}Apaga um grupo

GET /warehouse/groups​

Lista os grupos da empresa cliente, ordenados pelo nome.

Parâmetros de URL

ParâmetroDescrição
searchTexto para buscar pelo nome do grupo
per_pageQuantidade de registros por página. Com ele, a resposta é paginada
pageNúmero da página, quando per_page é informado

Resposta (200): lista de grupos com id, group, type, updated_at e os nomes de quem criou e de quem alterou por último.

POST /warehouse/groups​

Cadastra um grupo.

Corpo

CampoObrigatórioTipoDescrição
groupSimTextoNome do grupo

Resposta (201): o grupo criado, com id e group.

curl -X POST https://api.pedagogo.app/warehouse/groups \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"group": "Materiais de limpeza"}'

PUT /warehouse/groups/{id}​

Altera o nome do grupo.

Corpo

CampoObrigatórioTipoDescrição
groupSimTextoNome do grupo

Resposta (200): o grupo alterado.

DELETE /warehouse/groups/{id}​

Apaga o grupo (exclusão lógica). Resposta (200): lista de grupos da empresa cliente.