POST v1/Orders ehouse API documentation

POST v1/Orders

Place a new order

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceItemCodes	Collection of InvoiceItemByCodeDataBindingModel	Required
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.
Address	string	Required String length: inclusive between 0 and 100
BuildingName	string	String length: inclusive between 0 and 50
BuildingNumber	string	String length: inclusive between 0 and 10
SubBuilding	string	String length: inclusive between 0 and 50
Town	string	Required String length: inclusive between 0 and 50
County	string	String length: inclusive between 0 and 50
Reference	string	String length: inclusive between 0 and 50
CollectKeys	boolean	Required
SendVendorBookingSms	boolean	None.
OwnerName	string	Required String length: inclusive between 0 and 50
HomeTelephone	string	String length: inclusive between 0 and 30
Mobile	string	String length: inclusive between 0 and 30
Email	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:

{
  "invoiceItemCodes": [
    {
      "keyInvoiceItemCode": 1,
      "quantity": 2
    },
    {
      "keyInvoiceItemCode": 1,
      "quantity": 2
    }
  ],
  "postCode": "sample string 1",
  "sqftIndex": 1,
  "bedrooms": 2,
  "propertyValue": 1.0,
  "address": "sample string 3",
  "buildingName": "sample string 4",
  "buildingNumber": "sample string 5",
  "subBuilding": "sample string 6",
  "town": "sample string 7",
  "county": "sample string 8",
  "reference": "sample string 9",
  "collectKeys": true,
  "sendVendorBookingSms": true,
  "ownerName": "sample string 12",
  "homeTelephone": "sample string 13",
  "mobile": "sample string 14",
  "email": "sample string 15",
  "directions": "sample string 16",
  "instructions": "sample string 17"
}

Response Information

Resource Description

Returns HTTP 200 status code upon success

OrderViewModel

Name	Type	Additional information
RowVersion	unsigned integer	None.
OrderNumber	integer	None.
Size	byte	None.
Bedrooms	integer	None.
PropertyValue	decimal number	None.
DateCreated	date	None.
CreatedBy	integer	None.
Postcode	string	None.
Address	string	None.
Town	string	None.
County	string	None.
Reference	string	None.
CollectKeys	boolean	None.
OwnersName	string	None.
HomeTelephone	string	None.
Mobile	string	None.
Email	string	None.
Directions	string	None.
Instructions	string	None.
PhotographerBooked	byte	None.
InvoiceItemsQuantity	integer	None.
OrderType	integer	None.
InvoiceIssued	boolean	None.
InvoiceItems	Collection of InvoiceItemViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "rowVersion": 1,
  "orderNumber": 2,
  "size": 64,
  "bedrooms": 3,
  "propertyValue": 4.0,
  "dateCreated": "2025-04-24T12:20:23.2123047+01:00",
  "createdBy": 1,
  "postcode": "sample string 5",
  "address": "sample string 6",
  "town": "sample string 7",
  "county": "sample string 8",
  "reference": "sample string 9",
  "collectKeys": true,
  "ownersName": "sample string 10",
  "homeTelephone": "sample string 11",
  "mobile": "sample string 12",
  "email": "sample string 13",
  "directions": "sample string 14",
  "instructions": "sample string 15",
  "photographerBooked": 64,
  "invoiceItemsQuantity": 16,
  "orderType": 1,
  "invoiceIssued": true,
  "invoiceItems": [
    {
      "url": "sample string 1",
      "order": 1,
      "invoiceItemId": 2,
      "keyInvoiceItemCode": 3,
      "description": "sample string 4",
      "stills": true,
      "droneStills": true,
      "droneVideos": true,
      "retrofitAssessment": true,
      "elevatedStills": true,
      "floorplans": true,
      "virtualTours": true,
      "epc": true,
      "videos": true,
      "valuation": true,
      "viewing": true,
      "brochure": {
        "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
      },
      "cost": 1.1,
      "quantity": 1
    },
    {
      "url": "sample string 1",
      "order": 1,
      "invoiceItemId": 2,
      "keyInvoiceItemCode": 3,
      "description": "sample string 4",
      "stills": true,
      "droneStills": true,
      "droneVideos": true,
      "retrofitAssessment": true,
      "elevatedStills": true,
      "floorplans": true,
      "virtualTours": true,
      "epc": true,
      "videos": true,
      "valuation": true,
      "viewing": true,
      "brochure": {
        "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
      },
      "cost": 1.1,
      "quantity": 1
    }
  ]
}