Sign in
Order Controller

Get order by ID

Get complete order details by ID. When called with a valid Bearer token, also returns draftEmailAttachments.

get/orders/{id}

Path parameters

idnumber required

Response

idnumber required

Order ID

titleNumberstring

Title number

instrumentCopyNumberstring

Instrument copy number

customerEmailstring

Customer email

customerIdnumber required

Customer ID

emailValidboolean

Email valid

tenurestring

Tenure type

refundReasonstring

Refund reason

refundedAmountnumber required

Total refunded amount

refundDateTimestring date-time

Refund date time

address1string

Address line 1

flatUnitstring

Flat/Unit

municipalitystring

Municipality

registrystring

Registry

cruIdufirstring

CRU / IDUFIR

identificationTypestring

Identification type

identificationNumberstring

Identification number

nameAsPerIdentificationstring

Name as per identification

citystring

City

suburbstring

Suburb

countystring

County

postCodestring

Post code

countrystring

Country

countryIdnumber

Country ID

stateIdnumber

State ID

stateNamestring

State Name

currencystring

Currency code

currencySymbolstring

Currency symbol

totalAmountnumber required

Total order amount

orderDateTimestring date-time

Order date time

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

isExpressDeliveryboolean required

Is express delivery

isRequestedPaperCopyboolean required

Customer requested paper copy

utmCampaignstring

UTM Campaign

utmTermstring

UTM Term

utmContentstring

UTM Content

utmSourcestring

UTM Source

utmMediumstring

UTM Medium

orderLngstring

Order language

paymentMethodstring

Payment method used

ghostOrderIdnumber

Ghost order ID associated with this order

childOrderIdsnumber[]

All descendant order IDs (full subtree, including nested upsells), excluding orders in System Generated status

createdAtstring date-time required

Created at timestamp

updatedAtstring date-time required

Updated at timestamp

documentAccessLinkstring

Permanent document access link

isCertifiedboolean

Whether the order contains certified products

applicationNumberstring nullable

Land registry application number (set via send-email when certified; not shown in email body)

upSellSource'ORDER' | 'EMAIL'

Source of upsell order (ORDER=from order page, EMAIL=from email)

upSellEntryChannelstring

How the customer reached the tracking page before buying (Document Link upsells)

upSellAttributionobject

Extra attribution detail for Document Link upsells (reminder day/time/tz, email type, etc.)

parentOrderIdnumber

Parent order ID if this is an upsell

stopAbandonmentEmailsboolean required

Whether abandonment emails are stopped for this order

isAbandonmentRecoveredboolean required

Whether this order was successfully paid after an abandonment email was sent

hasSwimmingPoolboolean required

Whether the property has a swimming pool

trackingLinkstring

Tracking link for the order

documentLinkValidUntilstring date-time

Extended document link validity (UTC). Null when only the default tracking expiry window applies.

billingEmailstring

Billing email for root summary: latest attempt for Stripe/PayPal; for Revolut, earliest successful attempt when multiple rows exist.

transactionPaymentIdstring

Gateway transaction id for root summary: latest attempt for Stripe/PayPal; for Revolut, earliest successful attempt.

transactionDashboardUrlstring

Dashboard URL for root summary: latest attempt for Stripe/PayPal; for Revolut, earliest successful attempt.

Example response

{
  "id": 1,
  "titleNumber": "TN123456",
  "instrumentCopyNumber": "IC123456",
  "customerEmail": "customer@example.com",
  "customerId": 1,
  "emailValid": true,
  "tenure": "Freehold",
  "refundReason": "Customer requested refund",
  "refundedAmount": 50,
  "address1": "123 Main Street",
  "flatUnit": "Flat 5B",
  "municipality": "Madrid",
  "registry": "Registro de la Propiedad",
  "cruIdufir": "1234567890",
  "identificationType": "NIE",
  "identificationNumber": "X1234567L",
  "nameAsPerIdentification": "John Doe",
  "city": "London",
  "suburb": "Ponsonby",
  "county": "Greater London",
  "postCode": "SW1A 1AA",
  "country": "United Kingdom",
  "countryId": 1,
  "stateId": 1,
  "stateName": "England",
  "currency": "GBP",
  "currencySymbol": "£",
  "totalAmount": 199.99,
  "orderStatus": {
    "id": 1,
    "status": "Processing",
    "backgroundColor": "#FF5733",
    "textColor": "#FFFFFF",
    "borderColor": "#000000"
  },
  "products": [
    {
      "productId": 1,
      "productName": "Land Registry Document",
      "price": 99.99
    }
  ],
  "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",
  "paymentMethod": "Credit Card",
  "ghostOrderId": 2,
  "childOrderIds": [
    11,
    15
  ],
  "documentAccessLink": "https://api.example.com/orders/track/abc-123-xyz",
  "isCertified": true,
  "applicationNumber": "APP-12345",
  "upSellSource": "EMAIL",
  "upSellEntryChannel": "DOCUMENT_REMINDER_EMAIL",
  "parentOrderId": 1,
  "trackingLink": "https://api.example.com/orders/track/abc-123-xyz",
  "documentLinkValidUntil": "2027-07-20T10:00:00.000Z",
  "billingEmail": "customer@example.com",
  "transactionPaymentId": "pi_1234567890",
  "transactionDashboardUrl": "https://dashboard.stripe.com/test/payments/pi_1234567890",
  "payments": [
    {
      "billingEmail": "customer@example.com",
      "transactionPaymentId": "pi_1234567890",
      "transactionDashboardUrl": "https://dashboard.stripe.com/test/payments/pi_1234567890",
      "paymentMethod": "Credit Card"
    }
  ],
  "refundHistory": [
    {
      "amount": 25,
      "method": "manual",
      "source": "admin_panel",
      "totalRefundedAfter": 50,
      "remainingAfter": 50,
      "currency": "GBP"
    }
  ]
}

Changes

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