GET v1/Shops/{shopId}/Orders
Get a list with all available Orders, for given shop.
Request Information
Requires Authorization!
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| shopId |
The id of the shop. |
integer |
Required. |
| fromDateChanged |
Optionally specify a from date for changed orders. |
date |
Is Optional. Default value is (null). |
| untilDateChanged |
Optionally specify a until date for changed orders. |
date |
Is Optional. Default value is (null). |
| mainStatusId |
Optionally specify a status Id to filter on. |
integer |
Is Optional. Default value is (null). |
| mainStatusBaseStatusId |
Optionally specify a base status Id to filter on. |
integer |
Is Optional. Default value is (null). |
| emailAddress |
Optionally specify an email address. If specified only Orders with given email address in the Bill To info will be returned. |
string |
Is Optional. Default value is (null). |
| pageSize |
The max number of items returned. Default this value is 100. |
integer |
Is Optional. Default value is 100. |
| pageNumber |
The page to return. Default page 1 will be returned. |
integer |
Is Optional. Default value is 1. |
Body Parameters
None.
Response Information
Resource Description
A list of the OrderBasicInfo objects.
Collection of OrderBasicInfo
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyName |
Gets or sets the name of the company. |
string |
None. |
| FullName |
Gets or sets the full name. |
string |
None. |
| Id |
Gets or sets the identifier. |
integer |
Required |
| OrderCode |
Gets or sets the order code. |
string |
Required Max length: 50 |
| Date |
Gets or sets the date. |
date |
Required |
| OrderTotalIncVat |
Gets or sets the order total with the 'VAT'. |
decimal number |
None. |
| OrderTotalExVat |
Gets or sets the order total without the 'VAT'. |
decimal number |
Required |
| CurrencyId |
Gets or sets the currency identifier. |
integer |
None. |
| CurrencyCode |
Gets or sets the currency code. |
string |
None. |
| Deleted |
Gets or sets a value indicating whether this is deleted. |
boolean |
Required |
| ChangeTimestamp |
Gets or sets the change timestamp. |
date |
None. |
| MainStatusId |
Gets or sets the main status identifier. |
integer |
None. |
Response Formats
application/json, text/json
[
{
"CompanyName": "sample string 1",
"FullName": "sample string 2",
"Id": 3,
"OrderCode": "sample string 4",
"Date": "2026-04-03T18:31:02.1813677+02:00",
"OrderTotalIncVat": 6.0,
"OrderTotalExVat": 7.0,
"CurrencyId": 8,
"CurrencyCode": "sample string 9",
"Deleted": true,
"ChangeTimestamp": "2026-04-03T18:31:02.1813677+02:00",
"MainStatusId": 1
},
{
"CompanyName": "sample string 1",
"FullName": "sample string 2",
"Id": 3,
"OrderCode": "sample string 4",
"Date": "2026-04-03T18:31:02.1813677+02:00",
"OrderTotalIncVat": 6.0,
"OrderTotalExVat": 7.0,
"CurrencyId": 8,
"CurrencyCode": "sample string 9",
"Deleted": true,
"ChangeTimestamp": "2026-04-03T18:31:02.1813677+02:00",
"MainStatusId": 1
}
]
application/xml, text/xml
<ArrayOfOrderBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<OrderBasicInfo>
<Id>3</Id>
<OrderCode>sample string 4</OrderCode>
<Date>2026-04-03T18:31:02.1813677+02:00</Date>
<OrderTotalIncVat>6</OrderTotalIncVat>
<OrderTotalExVat>7</OrderTotalExVat>
<CurrencyId>8</CurrencyId>
<CurrencyCode>sample string 9</CurrencyCode>
<Deleted>true</Deleted>
<ChangeTimestamp>2026-04-03T18:31:02.1813677+02:00</ChangeTimestamp>
<MainStatusId>1</MainStatusId>
<CompanyName>sample string 1</CompanyName>
<FullName>sample string 2</FullName>
</OrderBasicInfo>
<OrderBasicInfo>
<Id>3</Id>
<OrderCode>sample string 4</OrderCode>
<Date>2026-04-03T18:31:02.1813677+02:00</Date>
<OrderTotalIncVat>6</OrderTotalIncVat>
<OrderTotalExVat>7</OrderTotalExVat>
<CurrencyId>8</CurrencyId>
<CurrencyCode>sample string 9</CurrencyCode>
<Deleted>true</Deleted>
<ChangeTimestamp>2026-04-03T18:31:02.1813677+02:00</ChangeTimestamp>
<MainStatusId>1</MainStatusId>
<CompanyName>sample string 1</CompanyName>
<FullName>sample string 2</FullName>
</OrderBasicInfo>
</ArrayOfOrderBasicInfo>