Referência

Encomendas a fornecedores

A reposição de stock: a sugestão do que está abaixo do mínimo e as notas de encomenda, uma por fornecedor.

Operação	O que faz
GET `/api/estoque/encomendas/sugestao`	A sugestão de encomenda: os artigos abaixo do stock mínimo, com o fornecedor habitual e a quantidade que repõe o dobro do mínimo.
POST `/api/estoque/encomendas/notas`	Cria as notas de encomenda (uma por fornecedor) a partir dos artigos escolhidos.
GET `/api/estoque/encomendas/notas`	Lista as notas de encomenda.
GET `/api/estoque/encomendas/notas/{id}`	Uma nota de encomenda, com as linhas.
POST `/api/estoque/encomendas/notas/{id}/recebida`	Marca uma nota de encomenda como recebida.
POST `/api/estoque/encomendas/notas/{id}/cancelar`	Cancela uma nota de encomenda, com o motivo.

GET/api/estoque/encomendas/sugestao#

A sugestão de encomenda: os artigos abaixo do stock mínimo, com o fornecedor habitual e a quantidade que repõe o dobro do mínimo.

Permissão Estoque.EncomendasLer

lojaId limita a um estabelecimento.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`lojaId`	na pesquisa	identificador (UUID)

Pedido

curl

curl 'https://<endereço-da-API>/api/estoque/encomendas/sugestao' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/estoque/encomendas/notas#

Cria as notas de encomenda (uma por fornecedor) a partir dos artigos escolhidos.

Permissão Estoque.EncomendasGerir
Idempotência aceita Idempotency-Key

Corpo do pedido (JSON · CriarNotasDeEncomendaCommand)

Campo	Tipo	Obrigatório	Significado
`itens`	lista de objectos	sim
`itens[].produtoId`	identificador (UUID)	sim	O artigo.
`itens[].quantidade`	número	sim	A quantidade.
`itens[].fornecedorId`	identificador (UUID) ou nulo
`lojaId`	identificador (UUID) ou nulo		O estabelecimento.
`observacao`	texto ou nulo		O texto livre.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/estoque/encomendas/notas' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "itens": [
    {
      "produtoId": "00000000-0000-0000-0000-000000000000",
      "quantidade": 0
    }
  ]
}'

GET/api/estoque/encomendas/notas#

Lista as notas de encomenda.

Permissão Estoque.EncomendasLer

estado e fornecedorId filtram; tamanho (por omissão 100).

Parâmetros

Nome	Onde	Tipo
`estado`	na pesquisa	texto
`fornecedorId`	na pesquisa	identificador (UUID)
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/estoque/encomendas/notas' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/estoque/encomendas/notas/{id}#

Uma nota de encomenda, com as linhas.

Permissão Estoque.EncomendasLer

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/estoque/encomendas/notas/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/estoque/encomendas/notas/{id}/recebida#

Marca uma nota de encomenda como recebida.

Permissão Estoque.EncomendasGerir

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/estoque/encomendas/notas/<id>/recebida' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/estoque/encomendas/notas/{id}/cancelar#

Cancela uma nota de encomenda, com o motivo.

Permissão Estoque.EncomendasGerir
Idempotência aceita Idempotency-Key

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · CancelarNotaEncomendaRequest)

Campo	Tipo	Obrigatório
`motivo`	texto	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/estoque/encomendas/notas/<id>/cancelar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'