POST /orders

Creates a new order for one or more report products at a given site location.

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

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 as a WKT string in British National Grid (EPSG:27700), with coordinates as `easting northing`. Must be a `POLYGON`, `MULTIPOLYGON`, or `POINT`. Use `POST /geometry/data` to convert a WGS84 GeoJSON geometry into a ready-to-submit BNG WKT string.

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.

Site fields

Field	Type	Description
`site.is_valid`	boolean	Whether the submitted geometry parsed successfully.
`site.address`	string	The site address as supplied.
`site.wkt`	string	Site geometry as WKT in British National Grid (EPSG:27700).
`site.area`	number	Site area in square metres. `0` for points.
`site.x`	number	Centroid Easting (British National Grid).
`site.y`	number	Centroid Northing (British National Grid).
`site.centroid`	GeoJSON Point	Centroid in WGS84 (`[longitude, latitude]`).
`site.geometry`	GeoJSON geometry	Site geometry in WGS84.
`site.urban_type`	string	Urbanisation classification (e.g. `urban`, `rural`).

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((529968 179968, 530033 179968, 530033 180033, 529968 180033, 529968 179968))",
    "products": [
      { "code": "resi_core" }
    ]
  }'