FIfindmydocument
Order Controller

Get orders with filters for admin

Changed on

Retrieve orders with optional search by order ID, title number, customer email, application number, instrument copy number, billing email, post code, address, city, or manually added order notes. Filter by status, customer ID, UTM source, payment method, date range. Latest orders appear first.

get/orders

Request

Query parameters

searchstring

Search by order ID, title number, customer email, application number, instrument copy number, billing email, post code, address, city, or manually added order notes

orderStatusIdnumber[]

Filter by one or more order status IDs (supports comma-separated or repeated query params)

[
  1,
  2
]
customerIdnumber

Filter by customer ID

customerEmailstring

Filter by customer email

postCodestring

Filter by post code

countryIdnumber

Filter by country ID

stateIdnumber

Filter by state ID

isExpressDeliveryboolean

Filter by express delivery status

isRequestedPaperCopyboolean

Filter by paper copy requested

paymentMethodstring

Filter by payment method

utmSourcestring
Example:google

Filter by UTM source (exact match). Use "notSet" for orders with no UTM source.

orderStatusstring[]

Filter by order status (can be comma-separated)

isCertifiedboolean

Filter by certified orders (only orders with physical products)

hasInstrumentCopyboolean

Filter orders containing Instrument Copy product

hasLimReportboolean

Filter orders containing LIM Report product

isAbandonmentRecoveredboolean

Filter orders recovered after an abandonment email was sent.

hasExtraDocumentsboolean

Filter orders whose customer was sent more documents than the order has document products.

upSellSource'ORDER' | 'EMAIL' | 'ADMIN' | 'ALL'

Filter by upsell source. ALL = any order with an upsell source set.

upSellEntryChannel'PAYMENT_SUCCESS' | 'DOCUMENT_DELIVERY_EMAIL' | 'DOCUMENT_REMINDER_EMAIL' | 'ORDER_CONFIRMATION_EMAIL' | 'TRANSIT_EMAIL' | 'ADMIN_PANEL' | 'TRACKING_DIRECT' | 'UNKNOWN'

Filter by tracking-entry channel for Document Link upsells (e.g. DOCUMENT_REMINDER_EMAIL)

fromDatestring

Filter orders created from this date (ISO 8601 format)

toDatestring

Filter orders created until this date (ISO 8601 format)

sortBy'createdAt' | 'updatedAt' | 'totalAmount' | 'customerEmail' | 'postCode' | 'titleNumber'

Field to sort by

sortType'ASC' | 'DESC'
Example:DESC

Sort direction

pagenumber required

Page number for pagination

sizenumber required
Example:10

Number of items per page

Response

Orders retrieved successfully

totalItemsnumber required

Total number of orders

pagenumber required

Current page number

sizenumber required

Number of items per page

Example response

{
  "items": [
    {
      "id": 1,
      "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",
      "cadastralRef": "1234567VK4700N0001AA",
      "propertyType": "house",
      "ownerName": "Juan García",
      "floor": "3",
      "door": "B",
      "requestReason": "Purchase due diligence",
      "identificationType": "NIE",
      "identificationNumber": "X1234567L",
      "nameAsPerIdentification": "John Doe",
      "city": "London",
      "suburb": "Ponsonby",
      "county": "Greater London",
      "country": "United Kingdom",
      "countryId": 1,
      "stateId": 1,
      "currency": "GBP",
      "currencySymbol": "£",
      "totalAmount": 199.99,
      "orderStatus": {
        "id": 1,
        "status": "Processing",
        "backgroundColor": "#FF5733",
        "textColor": "#FFFFFF",
        "borderColor": "#000000"
      },
      "customerOrderCount": 5,
      "postCode": "SW1A 1AA",
      "shippingAddress1": "456 Delivery Street",
      "shippingAddress2": "Apartment 5B",
      "shippingCity": "Manchester",
      "shippingPostcode": "M1 1AA",
      "shippingCounty": "Greater Manchester",
      "shippingPhone": "+44 123 456 7890",
      "shippingFirstName": "John",
      "shippingLastName": "Doe",
      "postCodeOrderCount": 3,
      "paymentMethod": "card",
      "latestEmailStatus": "delivered",
      "customerIsVerified": true,
      "customerEmailValidationStatus": "UNKNOWN",
      "orderLng": "en",
      "productType": "pf",
      "ghostOrderId": 2,
      "isCertified": true,
      "applicationNumber": "APP-12345",
      "upSellSource": "EMAIL",
      "upSellEntryChannel": "DOCUMENT_REMINDER_EMAIL",
      "utmSource": "google",
      "refundedAmount": 50,
      "applicantFirstName": "John",
      "applicantLastName": "Smith"
    }
  ]
}

Changes

  • 804e7fc0c5ddRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • f22d46acf0aeRevision changes
    • info

      added the new optional query request parameter hasExtraDocuments

    • info

      added the required property // to the response with the status