POST /orders
Creates a new order for one or more report products at a given site location.
Base URL: https://api.geocerta.io
Authentication required. Include your API key in the
api-keyheader. See Authentication.
Endpoint
POST /orders
Content-Type: application/json
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
reference | string | Yes | Your internal reference for this order. Min 6, max 100 characters. |
products | array | Yes | One or more products to order. See Products below. |
address | string | Yes | The site address as a human-readable string. Min 3, max 1000 characters. |
wkt | string | Yes | The site geometry in WKT format. Must be a POLYGON, MULTIPOLYGON, or POINT. |
Products
Each item in the products array:
| Field | Type | Required | Description |
|---|---|---|---|
code | string | Yes | The product code. See Product Codes. |
reference | string | No | Optional per-product reference. Min 8, max 50 characters. |
Product Codes
| Code | Description |
|---|---|
resi_core | GeoCerta CORE |
resi_pro | GeoCerta PRO |
resi_ultra | GeoCerta ULTRA |
Response
201 Created — returns the created order object.
Errors
| Status | Message | Cause |
|---|---|---|
400 | Bad Request | Validation failed — check required fields and constraints |
401 | Unauthorized | Missing or invalid API key |
Example
curl -X POST https://api.geocerta.io/orders \
-H "Content-Type: application/json" \
-H "api-key: YOUR_API_KEY" \
-d '{
"reference": "ORD-2024-001",
"address": "10 Downing Street, London, SW1A 2AA",
"wkt": "POLYGON((-0.1280 51.5030, -0.1270 51.5030, -0.1270 51.5036, -0.1280 51.5036, -0.1280 51.5030))",
"products": [
{ "code": "resi_core" }
]
}'