Skip to main content

ordersStatistics Query

Description​

Retrieves aggregate statistics for filtered orders, including total revenue and order count. Only accessible to admin users.

query ordersStatistics($ordersFiltersInput: OrdersFiltersInput!) {
ordersStatistics(ordersFiltersInput: $ordersFiltersInput) {
total
count
}
}

Variables​

{
"ordersFiltersInput": {
"page": 1,
"limit": 20,
"sort": "sort",
"order": -1,
"from": 1770940000228,
"to": 1773414366582,
"dateFilter": "dateFilter",
"origin": [
"origin"
],
"status": [
"status"
],
"billingStatus": [
"billingStatus"
],
"shippingStatus": [
"shippingStatus"
],
"shippingMethod": [
"shippingMethod"
],
"paymentMethods": [
"paymentMethods"
],
"itemRef": "6a31b415275c188a90ea2db6",
"preOrder": true,
"buyerRef": "dcb5329acca219cab54becdb",
"couponRef": "6f0c377fc0c7f3a8fe53e298",
"giftCardRef": "cce973f909b67dace35c932b",
"term": "term"
}
}

Response​

{
"ordersStatistics": {
"total": 29.99,
"count": 10
}
}

Arguments​

NameTypeDescription
ordersFiltersInputOrdersFiltersInput!Input type. See the `OrdersFiltersInput` type for field details.

Returns​

OrdersStatistics!