GET v2/Orders?page={page}&pageSize={pageSize}
Returns list of orders belongs to the branch
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| page |
Page number ( default 0) |
integer |
Default value is 0 |
| pageSize |
Number of items in one page( default 100) |
integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
Ret/urns in below JSON format
OrderPagingViewModelV2| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalOrders | integer |
None. |
|
| TotalPages | integer |
None. |
|
| CurrntlyViewing | string |
None. |
|
| OrderList | Collection of OrderViewModelV2 |
None. |
Response Formats
application/json, text/json
Sample:
{
"totalOrders": 1,
"totalPages": 2,
"currntlyViewing": "sample string 3",
"orderList": [
{
"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:35:18.5040219+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:35:18.5040219+01:00",
"bookingEndTime": "2025-04-24T12:35:18.5040219+01:00",
"bookingPlacedOnTime": "2025-04-24T12:35:18.5040219+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:35:18.5040219+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:35:18.5040219+01:00",
"receivedDate": "2025-04-24T12:35:18.5040219+01:00"
},
{
"mobileNumber": "sample string 1",
"smsBody": "sample string 2",
"sentDate": "2025-04-24T12:35:18.5040219+01:00",
"receivedDate": "2025-04-24T12:35:18.5040219+01:00"
}
],
"brochure": {
"webeditUrl": "sample string 1",
"createdDate": "2025-04-24T12:35:18.5040219+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:35:18.5040219+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:35:18.5040219+01:00",
"bookingEndTime": "2025-04-24T12:35:18.5040219+01:00",
"bookingPlacedOnTime": "2025-04-24T12:35:18.5040219+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:35:18.5040219+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:35:18.5040219+01:00",
"receivedDate": "2025-04-24T12:35:18.5040219+01:00"
},
{
"mobileNumber": "sample string 1",
"smsBody": "sample string 2",
"sentDate": "2025-04-24T12:35:18.5040219+01:00",
"receivedDate": "2025-04-24T12:35:18.5040219+01:00"
}
],
"brochure": {
"webeditUrl": "sample string 1",
"createdDate": "2025-04-24T12:35:18.5040219+01:00"
}
}
]
}