POST v2/Orders ehouse API documentation

POST v2/Orders

Place a new order

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
KeyInvoiceItems	Collection of KeyInvoiceItemDataBindingModelV2	Required
BrochureInformation	BrochurePostDataBindingBaseModel	None.
LinkedOrders	Collection of integer	None.
BuildingNumber	string	String length: inclusive between 0 and 50
BuildingName	string	String length: inclusive between 0 and 50
SubBuilding	string	String length: inclusive between 0 and 50
StreetAddress	string	Required String length: inclusive between 0 and 100
Town	string	Required String length: inclusive between 0 and 50
County	string	String length: inclusive between 0 and 50
Postcode	string	Required String length: inclusive between 0 and 15
SqftIndex	integer	Range: inclusive between 0 and 17
Bedrooms	integer	Range: inclusive between 0 and 10
PropertyValue	decimal number	None.
Reference	string	String length: inclusive between 0 and 50
SendVendorBookingSms	boolean	Required
SendVendorBookingEmail	boolean	Required
VendorName	string	Required String length: inclusive between 0 and 50
VendorTelephone	string	String length: inclusive between 0 and 30
VendorMobile	string	String length: inclusive between 0 and 30
VendorEmail	string	Required String length: inclusive between 0 and 50
Directions	string	String length: inclusive between 0 and 4000
Instructions	string	String length: inclusive between 0 and 4000

Request Formats

application/json, text/json

Sample:

{
  "keyInvoiceItems": [
    {
      "id": 1,
      "quantity": 2
    },
    {
      "id": 1,
      "quantity": 2
    }
  ],
  "brochureInformation": {
    "templateId": 1,
    "sendBrochureUrlEmail": true,
    "brochureContent": {
      "brochureText": {
        "houseNumber": "sample string 1",
        "houseName": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "address3": "sample string 5",
        "address4": "sample string 6",
        "postcode": "sample string 7",
        "displayAddress": "sample string 8",
        "description": "sample string 9",
        "longDescription": "sample string 10",
        "outside": "sample string 11",
        "situation": "sample string 12",
        "directions": "sample string 13",
        "price": "sample string 14",
        "branchPhone": "sample string 15",
        "branchEmail": "sample string 16",
        "branchAddress": "sample string 17",
        "viewing": "sample string 18",
        "openingHours": "sample string 19",
        "website": "sample string 20",
        "vatNumber": "sample string 21",
        "companyNumber": "sample string 22",
        "companyDetails": "sample string 23",
        "franchiseStatement": "sample string 24",
        "tradingName": "sample string 25",
        "formattedPriceString": "sample string 26",
        "targetRent": "sample string 27",
        "rentQualifier": "sample string 28",
        "propertyFeeMessageUrl": "sample string 29",
        "features": "sample string 30",
        "tenure": "sample string 31",
        "roomsList": [
          {
            "name": "sample string 1",
            "dimensions": "sample string 2",
            "description": "sample string 3"
          },
          {
            "name": "sample string 1",
            "dimensions": "sample string 2",
            "description": "sample string 3"
          }
        ]
      },
      "advertsList": [
        {
          "description": "sample string 1",
          "tag": "sample string 2"
        },
        {
          "description": "sample string 1",
          "tag": "sample string 2"
        }
      ],
      "imagesUrlList": [
        {
          "url": "sample string 1",
          "thumbnailUrl": "sample string 2",
          "name": "sample string 3"
        },
        {
          "url": "sample string 1",
          "thumbnailUrl": "sample string 2",
          "name": "sample string 3"
        }
      ],
      "floorplansUrlList": [
        {
          "url": "sample string 1",
          "thumbnailUrl": "sample string 2",
          "name": "sample string 3"
        },
        {
          "url": "sample string 1",
          "thumbnailUrl": "sample string 2",
          "name": "sample string 3"
        }
      ],
      "epcsUrlList": [
        {
          "url": "sample string 1",
          "thumbnailUrl": "sample string 2",
          "name": "sample string 3"
        },
        {
          "url": "sample string 1",
          "thumbnailUrl": "sample string 2",
          "name": "sample string 3"
        }
      ],
      "otherFilesUrlList": [
        {
          "url": "sample string 1",
          "thumbnailUrl": "sample string 2",
          "name": "sample string 3"
        },
        {
          "url": "sample string 1",
          "thumbnailUrl": "sample string 2",
          "name": "sample string 3"
        }
      ]
    }
  },
  "linkedOrders": [
    1,
    2
  ],
  "buildingNumber": "sample string 1",
  "buildingName": "sample string 2",
  "subBuilding": "sample string 3",
  "streetAddress": "sample string 4",
  "town": "sample string 5",
  "county": "sample string 6",
  "postcode": "sample string 7",
  "sqftIndex": 8,
  "bedrooms": 9,
  "propertyValue": 1.0,
  "reference": "sample string 10",
  "sendVendorBookingSms": true,
  "sendVendorBookingEmail": true,
  "vendorName": "sample string 13",
  "vendorTelephone": "sample string 14",
  "vendorMobile": "sample string 15",
  "vendorEmail": "sample string 16",
  "directions": "sample string 17",
  "instructions": "sample string 18"
}

Response Information

Resource Description

Returns HTTP 200 status code upon success

OrderViewModelWithAssetsV2

Name	Type	Additional information
Assets	AssetsViewModel	None.
Logs	Collection of OrderLogsViewmodel	None.
RowVersion	unsigned integer	None.
OrderNumber	integer	None.
Size	byte	None.
Bedrooms	integer	Required
PropertyValue	decimal number	None.
BuildingNumber	string	None.
BuildingName	string	None.
SubBuilding	string	None.
StreetAddress	string	None.
Town	string	None.
County	string	None.
Postcode	string	None.
VendorName	string	None.
VendorHomeTelephone	string	None.
VendorMobile	string	None.
VendorEmail	string	None.
OrderReference	string	None.
DateCreated	date	None.
CreatedByUser	string	None.
Directions	string	None.
Instructions	string	None.
PhotographerBooking	PhotographerBookingViewModel	None.
InvoiceItems	Collection of InvoiceItemViewModelV2	None.
OrderInvoice	OrderInvoiceViewModel	None.
LinkedOrders	LinkedOrdersViewModel	None.
ConfirmationSmsHistory	Collection of ConfirmationSms	None.
Brochure	BrochureViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "assets": {
    "stillsInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "floorplansInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ],
      "floorplanSizeSqft": 2
    },
    "virtualToursInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "epcInformation": {
      "reportReferenceNumber": "sample string 1",
      "url": "sample string 2",
      "currentRating": 1,
      "potentialRating": 1,
      "certificateDate": "2025-04-24T12:20:23.4310392+01:00"
    },
    "videosInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "brochureInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "inventoryInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "gasSafetyCertificateInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "checkInInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "checkOutInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "midTermInspectionInformation": {
      "total": 1,
      "urlList": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "logs": [
    {
      "message": "sample string 1",
      "type": "sample string 2",
      "dateTime": "2025-04-24T12:20:23.4310392+01:00"
    },
    {
      "message": "sample string 1",
      "type": "sample string 2",
      "dateTime": "2025-04-24T12:20:23.4310392+01:00"
    }
  ],
  "rowVersion": 1,
  "orderNumber": 2,
  "size": 64,
  "bedrooms": 3,
  "propertyValue": 4.0,
  "buildingNumber": "sample string 5",
  "buildingName": "sample string 6",
  "subBuilding": "sample string 7",
  "streetAddress": "sample string 8",
  "town": "sample string 9",
  "county": "sample string 10",
  "postcode": "sample string 11",
  "vendorName": "sample string 12",
  "vendorHomeTelephone": "sample string 13",
  "vendorMobile": "sample string 14",
  "vendorEmail": "sample string 15",
  "orderReference": "sample string 16",
  "dateCreated": "2025-04-24T12:20:23.4310392+01:00",
  "createdByUser": "sample string 18",
  "directions": "sample string 19",
  "instructions": "sample string 20",
  "photographerBooking": {
    "webBookingUrl": "sample string 1",
    "bookingInformation": {
      "photographerId": 1,
      "photographerName": "sample string 2",
      "bookingAppUrl": "sample string 3",
      "bookingStartTime": "2025-04-24T12:20:23.4310392+01:00",
      "bookingEndTime": "2025-04-24T12:20:23.4310392+01:00",
      "bookingPlacedOnTime": "2025-04-24T12:20:23.4310392+01:00",
      "bookingPlacedByUser": "sample string 7"
    }
  },
  "invoiceItems": [
    {
      "invoiceItemId": 1,
      "keyInvoiceItemId": 2,
      "description": "sample string 3",
      "stills": true,
      "droneStills": true,
      "droneVideos": true,
      "retrofitAssessment": true,
      "elevatedStills": true,
      "floorplans": true,
      "virtualTours": true,
      "epc": true,
      "videos": true,
      "viewing": true,
      "cost": 14.0,
      "quantity": 15,
      "verification": true,
      "inventory": true,
      "gasSafetyCertificate": true,
      "checkIn": true,
      "checkOut": true,
      "midTermInspection": true,
      "brochureInformation": {
        "brochureStyleId": 1,
        "brochureStyleDescription": "sample string 2",
        "finishId": 3,
        "finishDescription": "sample string 4",
        "foldId": 5,
        "foldDescription": "sample string 6",
        "orientation": "sample string 7",
        "pageSizeId": 8,
        "pageSizeDescription": "sample string 9",
        "pages": 10,
        "printQuantity": 11
      }
    },
    {
      "invoiceItemId": 1,
      "keyInvoiceItemId": 2,
      "description": "sample string 3",
      "stills": true,
      "droneStills": true,
      "droneVideos": true,
      "retrofitAssessment": true,
      "elevatedStills": true,
      "floorplans": true,
      "virtualTours": true,
      "epc": true,
      "videos": true,
      "viewing": true,
      "cost": 14.0,
      "quantity": 15,
      "verification": true,
      "inventory": true,
      "gasSafetyCertificate": true,
      "checkIn": true,
      "checkOut": true,
      "midTermInspection": true,
      "brochureInformation": {
        "brochureStyleId": 1,
        "brochureStyleDescription": "sample string 2",
        "finishId": 3,
        "finishDescription": "sample string 4",
        "foldId": 5,
        "foldDescription": "sample string 6",
        "orientation": "sample string 7",
        "pageSizeId": 8,
        "pageSizeDescription": "sample string 9",
        "pages": 10,
        "printQuantity": 11
      }
    }
  ],
  "orderInvoice": {
    "invoiceIssuedDate": "2025-04-24T12:20:23.4310392+01:00",
    "invoiceReference": "sample string 1"
  },
  "linkedOrders": {
    "immediateLinkedOrders": [
      1,
      2
    ],
    "extendedLinkedOrders": [
      1,
      2
    ]
  },
  "confirmationSmsHistory": [
    {
      "mobileNumber": "sample string 1",
      "smsBody": "sample string 2",
      "sentDate": "2025-04-24T12:20:23.4310392+01:00",
      "receivedDate": "2025-04-24T12:20:23.4310392+01:00"
    },
    {
      "mobileNumber": "sample string 1",
      "smsBody": "sample string 2",
      "sentDate": "2025-04-24T12:20:23.4310392+01:00",
      "receivedDate": "2025-04-24T12:20:23.4310392+01:00"
    }
  ],
  "brochure": {
    "webeditUrl": "sample string 1",
    "createdDate": "2025-04-24T12:20:23.4310392+01:00"
  }
}