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": 1764247728106,
"to": 1727202975688,
"dateFilter": "dateFilter",
"origin": [
"origin"
],
"status": [
"status"
],
"billingStatus": [
"billingStatus"
],
"shippingStatus": [
"shippingStatus"
],
"paymentMethods": [
"paymentMethods"
],
"itemRef": "5ae1d86254acd02ccadfc7ad",
"buyerRef": "a6eda2bbecf22fe776f2cb51",
"couponRef": "f303775ece1f18629ccbc582",
"giftCardRef": "ab00f7f03ae8b3850d2932dc",
"term": "term"
}
}

Response

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

Arguments

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

Returns

OrdersStatistics!