GET v1/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
Returns in below JSON format
OrderPagingViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalNumber | integer |
None. |
|
| TotalPages | integer |
None. |
|
| CurrntlyViewing | string |
None. |
|
| NextUrl | string |
None. |
|
| PreviousUrl | string |
None. |
|
| OrderModel | Collection of OrderViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"totalNumber": 1,
"totalPages": 2,
"currntlyViewing": "sample string 3",
"nextUrl": "sample string 4",
"previousUrl": "sample string 5",
"orderModel": [
{
"rowVersion": 1,
"orderNumber": 2,
"size": 64,
"bedrooms": 3,
"propertyValue": 4.0,
"dateCreated": "2025-04-24T12:37:13.9243187+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
}
]
},
{
"rowVersion": 1,
"orderNumber": 2,
"size": 64,
"bedrooms": 3,
"propertyValue": 4.0,
"dateCreated": "2025-04-24T12:37:13.9243187+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
}
]
}
]
}