Skip to main content
GET
Listar pedidos

Authorizations

Authorization
string
header
required

Token gerado através do sistema do SULTS. Deve ser enviado no cabeçalho Authorization de todas as requisições.

Query Parameters

start
integer
default:0

Número da página da listagem, começando em 0. Incremente até a resposta vir vazia ou até atingir totalPage.

Required range: x >= 0
limit
integer
default:100

Quantidade de registros por página. O máximo aceito pela API é 100.

Required range: 1 <= x <= 100
id
integer

Código do pedido

situacao
enum<integer>

Situação do pedido.

Available options:
2,
3,
4,
5
unidadeId
integer

Código da unidade do pedido

fornecedorId
integer

Código do fornecedor do pedido

compradorId
integer

Código da pessoa que efetuou o pedido

dtPedidoStart
string<date-time>

Busca os pedidos realizados a partir da data informada (UTC ISO 8601).

dtPedidoEnd
string<date-time>

Busca os pedidos realizados antes da data informada (UTC ISO 8601).

cancelado
boolean
default:false

Pedidos cancelados (por padrão false). true: somente cancelados; false: somente ativos.

canceladoEmStart
string<date-time>

Busca os pedidos cancelados a partir da data informada (UTC ISO 8601). Necessita do parâmetro cancelado igual a true.

canceladoEmEnd
string<date-time>

Busca os pedidos cancelados antes da data informada (UTC ISO 8601). Necessita do parâmetro cancelado igual a true.

Response

Lista paginada de pedidos

data
object[]
start
integer

Página retornada

limit
integer

Registros por página

totalPage
integer

Quantidade de páginas disponíveis

size
integer

Quantidade de registros na página