GET /orders

Returns a paginated list of orders for the authenticated account.

Base URL: https://api.geocerta.io

Sandbox URL: https://api-staging.geocerta.io

Authentication required. Include your API key in the api-key header. See Authentication.

Endpoint

GET /orders

Query Parameters

Field Type Required Description
page number No Page number. Default: 1.
per_page number No Results per page. Default: 20, max 500.
reference string No Filter by order reference (exact match).
status string No Filter by order status. See Order Statuses.
product_code string No Filter by product code (e.g. resi_core).
product_status string No Filter by the status of a product within the order.
product_reference string No Filter by per-product reference.
date_from string No Return orders created on or after this date (ISO 8601).
date_to string No Return orders created on or before this date (ISO 8601).
centrepoint string No Filter by site centrepoint.

Order Statuses

Value Description
pending Order is awaiting a quote or confirmation
progress Order is being processed
completed All products have been delivered
ready_for_delivery Reports are ready and queued for delivery
delivery_failed Delivery attempt failed
cancelled Order was cancelled
quarantine Order is under review

Response

200 OK — returns a paginated list of orders.

Errors

Status Message Cause
400 Bad Request Invalid query parameters
401 Unauthorized Missing or invalid API key

Example

curl "https://api.geocerta.io/orders?page=1&per_page=20&status=completed" \
  -H "api-key: YOUR_API_KEY"