Pular para o conteúdo principal

Tipos de inventário

Tipos de movimentação usados no Inventário. Cada tipo é de entrada ou de saída, e esse sentido define como a movimentação altera o estoque. Corresponde à tela Tipos de inventário, do módulo Almoxarifado.

Endpoints​

MétodoCaminhoDescrição
GET/warehouse/inventory-typesLista os tipos de inventário
POST/warehouse/inventory-typesCadastra um tipo de inventário
GET/warehouse/inventory-types/{id}Consulta um tipo de inventário
PUT/warehouse/inventory-types/{id}Altera um tipo de inventário
DELETE/warehouse/inventory-types/{id}Apaga um tipo de inventário
GET/warehouse/inventory/typesLista os tipos, para o campo Tipo de inventário

GET /warehouse/inventory-types​

Lista os tipos de inventário da empresa cliente, ordenados pelo nome.

Parâmetros de URL

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

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

POST /warehouse/inventory-types​

Cadastra um tipo de inventário.

Corpo

CampoObrigatórioTipoDescrição
inventory_typeSimTextoNome do tipo, por exemplo "Compra" ou "Consumo na obra"
in_outSimNúmero inteiroSentido da movimentação. O saldo de Estoque multiplica a quantidade da movimentação por este valor

Resposta (201): o tipo criado, com id, inventory_type e in_out.

curl -X POST https://api.pedagogo.app/warehouse/inventory-types \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"inventory_type": "Compra", "in_out": 1}'

Consultar, alterar e apagar​

  • GET /warehouse/inventory-types/{id}: devolve o tipo.
  • PUT /warehouse/inventory-types/{id}: altera o tipo. Corpo: inventory_type (Sim, texto) e in_out (Sim, número inteiro). Resposta (200): o tipo alterado.
  • DELETE /warehouse/inventory-types/{id}: apaga o tipo (exclusão lógica). Resposta (200): lista de tipos de inventário da empresa cliente.

GET /warehouse/inventory/types​

Lista os tipos de inventário, para o campo Tipo de inventário da movimentação. A resposta e os parâmetros são os de GET /warehouse/inventory-types.