POST Stats/Customers
Statistics about Customers with Finished Orders inside Period (Amount, #Orders, DaysSinceLastOrder...)
Request Information
URI Parameters
None.
Body Parameters
GetStatsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DateFrom | date |
None. |
|
| DateUntil | date |
None. |
|
| Filter | Filter |
None. |
|
| Range | AdminFilterRange |
None. |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetCustomersResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| DateFrom | date |
None. |
|
| DateUntil | date |
None. |
|
| ItemsCount | integer |
None. |
|
| Items | Collection of CustomerItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"DateFrom": "2025-12-06T05:40:38.5562546+01:00",
"DateUntil": "2025-12-06T05:40:38.5562546+01:00",
"ItemsCount": 3,
"Items": [
{
"CustomerID": "sample string 1",
"FullName": "sample string 2",
"Email": "sample string 3",
"Gender": "sample string 4",
"PostalCode": "sample string 5",
"Region": "sample string 6",
"CustomerTypeID": 7,
"TariffID": 8,
"IsNewsletterSuscriber": true,
"OrdersAmount": 10.0,
"OrderAmountAverage": 11.0,
"OrderAmountMin": 12.0,
"OrderAmountMax": 13.0,
"OrdersCount": 14,
"OrderItemsQty": 15.0,
"DaysSinceLastOrder": 16
},
{
"CustomerID": "sample string 1",
"FullName": "sample string 2",
"Email": "sample string 3",
"Gender": "sample string 4",
"PostalCode": "sample string 5",
"Region": "sample string 6",
"CustomerTypeID": 7,
"TariffID": 8,
"IsNewsletterSuscriber": true,
"OrdersAmount": 10.0,
"OrderAmountAverage": 11.0,
"OrderAmountMin": 12.0,
"OrderAmountMax": 13.0,
"OrdersCount": 14,
"OrderItemsQty": 15.0,
"DaysSinceLastOrder": 16
}
]
}
application/xml, text/xml
Sample:
<GetCustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Stats">
<DateFrom>2025-12-06T05:40:38.5562546+01:00</DateFrom>
<DateUntil>2025-12-06T05:40:38.5562546+01:00</DateUntil>
<Items>
<CustomerItem>
<CustomerID>sample string 1</CustomerID>
<CustomerTypeID>7</CustomerTypeID>
<DaysSinceLastOrder>16</DaysSinceLastOrder>
<Email>sample string 3</Email>
<FullName>sample string 2</FullName>
<Gender>sample string 4</Gender>
<IsNewsletterSuscriber>true</IsNewsletterSuscriber>
<OrderAmountAverage>11</OrderAmountAverage>
<OrderAmountMax>13</OrderAmountMax>
<OrderAmountMin>12</OrderAmountMin>
<OrderItemsQty>15</OrderItemsQty>
<OrdersAmount>10</OrdersAmount>
<OrdersCount>14</OrdersCount>
<PostalCode>sample string 5</PostalCode>
<Region>sample string 6</Region>
<TariffID>8</TariffID>
</CustomerItem>
<CustomerItem>
<CustomerID>sample string 1</CustomerID>
<CustomerTypeID>7</CustomerTypeID>
<DaysSinceLastOrder>16</DaysSinceLastOrder>
<Email>sample string 3</Email>
<FullName>sample string 2</FullName>
<Gender>sample string 4</Gender>
<IsNewsletterSuscriber>true</IsNewsletterSuscriber>
<OrderAmountAverage>11</OrderAmountAverage>
<OrderAmountMax>13</OrderAmountMax>
<OrderAmountMin>12</OrderAmountMin>
<OrderItemsQty>15</OrderItemsQty>
<OrdersAmount>10</OrdersAmount>
<OrdersCount>14</OrdersCount>
<PostalCode>sample string 5</PostalCode>
<Region>sample string 6</Region>
<TariffID>8</TariffID>
</CustomerItem>
</Items>
<ItemsCount>3</ItemsCount>
</GetCustomersResponse>