Sign in
Order Controller

Create order

Create a new order with all order details.

post/orders

Request body

titleNumberstring

Title number

instrumentCopyNumberstring

Instrument copy number

customerEmailstring

Customer email

customerIdnumber required

Customer ID

tenurestring

Tenure type

address1string

Address line 1

flatUnitstring

Flat/Unit

municipalitystring

Municipality

registrystring

Registry

cruIdufirstring

CRU / IDUFIR

identificationType'None' | 'NIE' | 'NIF'

Identification type

identificationNumberstring

Identification number (required when identification type is NIE or NIF)

nameAsPerIdentificationstring

Name as per identification (required when identification type is NIE or NIF)

citystring

City

suburbstring

Suburb

countystring

County

postCodestring

Post code

countrystring

Country

statestring

State

currencystring

Currency code

totalAmountnumber

Total order amount

orderStatusIdnumber

Order status ID

shippingAddress1string

Shipping address line 1

shippingAddress2string

Shipping address line 2

shippingCitystring

Shipping city

shippingPostcodestring

Shipping postcode

shippingCountystring

Shipping county

shippingPhonestring

Shipping phone number

shippingFirstNamestring

Shipping first name

shippingLastNamestring

Shipping last name

updateItWithAllLinkedOrdersboolean

Update shipping address for all linked orders

isExpressDeliveryboolean

Is express delivery

isRequestedPaperCopyboolean

Customer requested paper copy (overrides product-derived flag)

utmCampaignstring

UTM Campaign

utmTermstring

UTM Term

utmContentstring

UTM Content

utmSourcestring

UTM Source

utmMediumstring

UTM Medium

hasSwimmingPoolboolean

Whether the property has a swimming pool

orderLng'en' | 'fr' | 'es'

Order language

Example request

{
  "titleNumber": "TN123456",
  "instrumentCopyNumber": "IC123456",
  "customerEmail": "customer@example.com",
  "customerId": 1,
  "tenure": "Freehold",
  "address1": "123 Main Street",
  "flatUnit": "Flat 5B",
  "municipality": "Madrid",
  "registry": "Registro de la Propiedad",
  "cruIdufir": "1234567890",
  "identificationType": "None",
  "identificationNumber": "X1234567L",
  "nameAsPerIdentification": "John Doe",
  "city": "London",
  "suburb": "Ponsonby",
  "county": "Greater London",
  "postCode": "SW1A 1AA",
  "country": "United Kingdom",
  "state": "England",
  "currency": "GBP",
  "totalAmount": 199.99,
  "orderStatusId": 1,
  "products": [
    {
      "productId": 1
    },
    {
      "productId": 2
    }
  ],
  "shippingAddress1": "456 Delivery Street",
  "shippingAddress2": "Apartment 5B",
  "shippingCity": "Manchester",
  "shippingPostcode": "M1 1AA",
  "shippingCounty": "Greater Manchester",
  "shippingPhone": "+44 123 456 7890",
  "shippingFirstName": "John",
  "shippingLastName": "Doe",
  "utmCampaign": "summer_sale",
  "utmTerm": "land_registry",
  "utmContent": "banner_ad",
  "utmSource": "google",
  "utmMedium": "cpc",
  "orderLng": "en"
}

Response

Order created successfully

orderIdnumber required

Order ID

customerEmailstring required

Customer email

emailValidboolean required

Email valid

emailValidationStatusstring

Email validation status (UNKNOWN, VALID, INVALID)

isNewCustomerboolean

True if customer was auto-created during this order

documentAccessLinkstring

Permanent document access link

Example response

{
  "orderId": 1,
  "customerEmail": "customer@example.com",
  "emailValid": true,
  "emailValidationStatus": "UNKNOWN",
  "isNewCustomer": true,
  "documentAccessLink": "https://api.example.com/orders/track/abc-123-xyz"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.