Listar pedidos

Retorna a lista paginada dos pedidos da sua integração, do mais recente para o mais antigo.

Request

ENDPOINT

/v1/insurance/order

MÉTODO

GET

Query params

Parâmetro	Tipo	Obrigatoriedade	Descrição
page	integer	opcional	Número da página. Padrão: 1.
page_size	integer	opcional	Registros por página. Padrão: 50. Máximo: 200.
status	string	opcional	Filtra pelo status do pedido (ex.: awaiting_payment).
customer_document_number	string	opcional	Filtra pelo documento do segurado.
request_control_key	string	opcional	Filtra pela sua chave de idempotência.
distribution_type	string	opcional	Filtra pelo modelo de distribuição (ex.: direct).
created_from	string	opcional	Data/hora mínima de criação (ISO 8601).
created_to	string	opcional	Data/hora máxima de criação (ISO 8601).

Exemplo de chamada

GET /v1/insurance/order?page=1&page_size=50&status=awaiting_payment&created_from=2026-07-01T00:00:00Z

Response

STATUS

200

Response Body

{
  "items": [
    {
      "order_key": "5e2b3f60-7c4b-4c8e-9f1a-6d2e8b4a7c90",
      "status": "awaiting_payment",
      "product_keys": ["9d1f8c7a-3b21-4e60-8a2f-1c5d7e9b0a44"],
      "customer_document_number": "96969879003",
      "total_order_amount": 617.28,
      "created_at": "2026-07-14T12:00:00Z"
    }
  ],
  "page": 1,
  "page_size": 50,
  "total": 137
}

Atributos da resposta

Campo	Tipo	Descrição
items	array	Lista de resumos de pedido.
page	integer	Página atual.
page_size	integer	Tamanho da página solicitado.
total	integer	Total de pedidos que atendem aos filtros.

Objeto em items

Campo	Tipo	Descrição
order_key	string	Chave única do pedido.
status	string	Status atual. Veja o ciclo de vida.
product_keys	array	Chaves dos produtos vendidos no pedido.
customer_document_number	string	Documento do segurado.
total_order_amount	number	Valor total do pedido (soma dos prêmios brutos dos produtos).
created_at	string	Data/hora da submissão.

Possíveis erros

Todo erro (non-2xx) retorna o corpo padrão { "title", "description", "translation", "code" } — trate programaticamente apenas o campo code.

Status	Código	Descrição
400	QIT000010	Parâmetro de paginação inválido.
400	QIT000001	Parâmetro de filtro malformado.
401 / 403	—	Falha de autenticação ou autorização.
429	—	Limite de requisições excedido — repita com backoff.
500 / 503	QIT000500	Erro interno ou serviço indisponível — seguro repetir a chamada.