Skip to main content

List orders

Returns the paginated list of your integration's orders, newest first.

Request

ENDPOINT
/v1/insurance/order
METHOD
GET

Query params

ParameterTypeRequiredDescription
pageintegeroptionalPage number. Default: 1.
page_sizeintegeroptionalRecords per page. Default: 50. Maximum: 200.
statusstringoptionalFilters by order status (e.g. awaiting_payment).
customer_document_numberstringoptionalFilters by the insured person's document.
request_control_keystringoptionalFilters by your idempotency key.
distribution_typestringoptionalFilters by the distribution model (e.g. direct).
created_fromstringoptionalMinimum creation date/time (ISO 8601).
created_tostringoptionalMaximum creation date/time (ISO 8601).
Example call
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
}

Response attributes

FieldTypeDescription
itemsarrayList of order summaries.
pageintegerCurrent page.
page_sizeintegerRequested page size.
totalintegerTotal number of orders matching the filters.

Object in items

FieldTypeDescription
order_keystringUnique order key.
statusstringCurrent status. See the lifecycle.
product_keysarrayKeys of the products sold in the order.
customer_document_numberstringInsured person's document.
total_order_amountnumberTotal order amount (sum of the products' gross premiums).
created_atstringSubmission date/time.

Possible errors

Every error (non-2xx) returns the standard body { "title", "description", "translation", "code" } — programmatically handle only the code field.

StatusCodeDescription
400QIT000010Invalid pagination parameter.
400QIT000001Malformed filter parameter.
401 / 403Authentication or authorization failure.
429Rate limit exceeded — retry with backoff.
500 / 503QIT000500Internal error or service unavailable — safe to retry.